GET v1/Portfolios/{id}/BankAccounts/{portfolioBankAccountId}/Udfs/{name}

Description

Retrieve a udf with name of {name} for PortfolioBankAccount with WSO ID of {id}.

Base Url

https://api-mgi.uat.wsohosting.com/


Rest Call Syntax


GET Reference/v1/Portfolios/{id}/BankAccounts/{portfolioBankAccountId}/Udfs/{name}

GET Reference/v1/Portfolios/{id}/BankAccounts/{portfolioBankAccountId}/Udfs/{name}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of Portfolio

integer

Required

name

The name of the udf

string

Required

portfolioBankAccountId

WSO ID of PortfolioBankAccounts

integer

Required




Response Information



Udf

Name

Description

Type

Additional Information

DisplayName

The display name of the UDF

string

ExtractionName

The extraction name of the UDF (this value will be the type of PickList defined in PickListItem)

string

FieldDataType

The data type of the UDF

Links

A list of hateoas links

Collection of Link

Name

The name of the UDF

string

Value

The value of the UDF (Boolean value used True/False)

string




Response Body Formats



application/json, text/json

Sample:
{
  "links": [
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    },
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    }
  ],
  "value": "sample string 1",
  "name": "sample string 2",
  "displayName": "sample string 3",
  "fieldDataType": "Long",
  "extractionName": "sample string 4"
}

application/xml, text/xml

Sample:
<Udf xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DisplayName>sample string 3</DisplayName>
  <ExtractionName>sample string 4</ExtractionName>
  <FieldDataType>Long</FieldDataType>
  <Links>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
  <Name>sample string 2</Name>
  <Value>sample string 1</Value>
</Udf>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.