GET v1/Bonds/{id}/Udfs

Description

Retrieve list of udfs for bond with WSO ID of {id}.

Base Url

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

Rest Call Syntax


GET SecurityMaster/v1/Bonds/{id}/Udfs

Execute API

GET SecurityMaster/v1/Bonds/{id}/Udfs

Verb

Base Url

URI parameters

 = 
 = 
 = 
 = 

Authentication



Response Format


Headers

Add header



Limitations

There are no limitations specified.



Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of bond

integer

Required

pageNumber

Page number of the list

integer

Default value is 1

pageSize

Page size of the list

integer

Default value is 50

udfNameStartsWith

Name to filter udfs on

string

Default value is



Response Information



PagedList Of UdfListItem

Name

Description

Type

Additional Information

Items

Collection of UdfListItem

Links

Collection of Link

PagingInformation



Response Body Formats



application/json, text/json

Sample: 
{
  "items": [
    {
      "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": {},
      "name": "sample string 2",
      "maxLength": 4,
      "displayName": "sample string 5",
      "fieldDataType": "Long",
      "ownerObjectType": "Portfolio",
      "extractionName": "sample string 6",
      "hasPickList": true,
      "minValue": {},
      "maxValue": {},
      "format": "sample string 10",
      "allowNewPickListItem": true,
      "limitToList": true,
      "pickList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "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": {},
      "name": "sample string 2",
      "maxLength": 4,
      "displayName": "sample string 5",
      "fieldDataType": "Long",
      "ownerObjectType": "Portfolio",
      "extractionName": "sample string 6",
      "hasPickList": true,
      "minValue": {},
      "maxValue": {},
      "format": "sample string 10",
      "allowNewPickListItem": true,
      "limitToList": true,
      "pickList": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "pagingInformation": {
    "totalItems": 1,
    "totalPages": 2,
    "itemsPerPage": 3,
    "currentPage": 4,
    "startRow": 5,
    "endRow": 6
  },
  "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"
    }
  ]
}

application/xml, text/xml

Sample: 
<PagedListOfUdfListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <UdfListItem>
      <AllowNewPickListItem>true</AllowNewPickListItem>
      <DisplayName>sample string 5</DisplayName>
      <ExtractionName>sample string 6</ExtractionName>
      <FieldDataType>Long</FieldDataType>
      <Format>sample string 10</Format>
      <HasPickList>true</HasPickList>
      <LimitToList>true</LimitToList>
      <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>
      <MaxLength>4</MaxLength>
      <MaxValue />
      <MinValue />
      <Name>sample string 2</Name>
      <OwnerObjectType>Portfolio</OwnerObjectType>
      <PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </PickList>
      <Value />
    </UdfListItem>
    <UdfListItem>
      <AllowNewPickListItem>true</AllowNewPickListItem>
      <DisplayName>sample string 5</DisplayName>
      <ExtractionName>sample string 6</ExtractionName>
      <FieldDataType>Long</FieldDataType>
      <Format>sample string 10</Format>
      <HasPickList>true</HasPickList>
      <LimitToList>true</LimitToList>
      <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>
      <MaxLength>4</MaxLength>
      <MaxValue />
      <MinValue />
      <Name>sample string 2</Name>
      <OwnerObjectType>Portfolio</OwnerObjectType>
      <PickList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </PickList>
      <Value />
    </UdfListItem>
  </Items>
  <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>
  <PagingInformation>
    <CurrentPage>4</CurrentPage>
    <EndRow>6</EndRow>
    <ItemsPerPage>3</ItemsPerPage>
    <StartRow>5</StartRow>
    <TotalItems>1</TotalItems>
    <TotalPages>2</TotalPages>
  </PagingInformation>
</PagedListOfUdfListItem>


Feedback