GET v1/Institutions/Udfs/{name}

Description

Retrieves a specific udf type for institution

Base Url

https://api-ppc.wsohosting.com/

Rest Call Syntax


GET Reference/v1/Institutions/Udfs/{name}

Execute API

GET Reference/v1/Institutions/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

name

The name of the udf

string

Required



Response Information



UdfType

Name

Description

Type

Additional Information

DisplayName

string

FieldDataType

FieldName

string

MaxLength

integer

PickList

Collection of string

UdfName

string



Response Body Formats



application/json, text/json

Sample: 
{
  "maxLength": 1,
  "pickList": [
    "sample string 1",
    "sample string 2"
  ],
  "udfName": "sample string 2",
  "fieldName": "sample string 3",
  "displayName": "sample string 4",
  "fieldDataType": "Long",
  "ownerObjectType": "Portfolio",
  "extractionName": "sample string 5",
  "hasPickList": true,
  "minValue": {},
  "maxValue": {},
  "format": "sample string 9",
  "allowNewPickListItem": true,
  "limitToList": true,
  "parentId": 12
}

application/xml, text/xml

Sample: 
<UdfType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WSO.SDK.Common.DataModels">
  <AllowNewPickListItem>true</AllowNewPickListItem>
  <DisplayName>sample string 4</DisplayName>
  <ExtractionName>sample string 5</ExtractionName>
  <FieldDataType>Long</FieldDataType>
  <FieldName>sample string 3</FieldName>
  <Format>sample string 9</Format>
  <HasPickList>true</HasPickList>
  <LimitToList>true</LimitToList>
  <MaxLength>1</MaxLength>
  <MaxValue />
  <MinValue />
  <OwnerObjectType>Portfolio</OwnerObjectType>
  <ParentId>12</ParentId>
  <PickList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PickList>
  <UdfName>sample string 2</UdfName>
</UdfType>


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.