PUT v1/Portfolios/{id}/Udfs/{name}

Description

Update the udf with name of {name} for the Portfolio with WSO ID of {id}.

Base Url

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


Rest Call Syntax


PUT Reference/v1/Portfolios/{id}/Udfs/{name}

PUT Reference/v1/Portfolios/{id}/Udfs/{name}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



UdfValueUpdate

Name

Description

Type

Additional Information

Value

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

string

Required




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of Portfolio

integer

Required

name

Name of udf

string

Required



Request body formats


application/json, text/json

Sample:
{
  "value": "sample string 1"
}

application/xml, text/xml

Sample:
<UdfValueUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Value>sample string 1</Value>
</UdfValueUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



UdfListItem

Name

Description

Type

Additional Information

DisplayName

Gets the user-friendly display name of the UDF.

string

FieldDataType

Gets the data type of the UDF.

Links

A list of hateoas links

Collection of Link

MaxLength

Gets the length of the max.

integer

Name

The name of the UDF

string

Value

The value of the UDF

Object




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": {},
  "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"
  ]
}

application/xml, text/xml

Sample:
<UdfListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PickList>
  <Value />
</UdfListItem>



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.