|
IHS Markit API |
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://services.wsoweb.com/
Rest Call Syntax
PUT Reference/v1/Portfolios/{id}/Udfs/{name}
PUT Reference/v1/Portfolios/{id}/Udfs/{name}
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
{
"value": "sample string 1"
}
application/xml, text/xml
<UdfValueUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Value>sample string 1</Value> </UdfValueUpdate>
application/x-www-form-urlencoded
Sample not available.
Response Information
UdfListItem
Name
Description
Type
Additional Information
AllowNewPickListItem
Gets a value indicating whether the caller is allowed to add new pick list items.
boolean
DisplayName
Gets the user-friendly display name of the UDF.
string
ExtractionName
Gets the extraction name of the UDF. This is primarily used for UDFs which are driven off of PickLists. This value will be the type of PickList defined in the PickListItem table.
string
Format
Gets the format of the UDF.
string
HasPickList
Gets a value indicating whether or not the possible values of the UDF are from a PickList.
boolean
LimitToList
Gets a value indicating whether the value of the UDF should be limited to the items in a list.
boolean
MaxLength
Gets the length of the max.
integer
MaxValue
Gets the max value that can be assigned to the UDF. This value is optional, and may not be set for all UDFs.
Object
MinValue
Gets the min value that can be assigned to the UDF. This value is optional, and may not be set for all UDFs.
Object
Name
The name of the UDF
string
OwnerObjectType
Gets the type of the object which contains this UDF. Ultimately this indicates which table the UDF is stored in.
PickList
Gets or sets the value of the UDF.
Collection of string
Value
The value of the UDF
Object
Response Body Formats
application/json, text/json
{
"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
<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>