|
IHS Markit API |
GET v1/Equities/Udfs/{name}
Description
Retrieve a specific udf type with name of {name} for equity.
Base Url
https://api-mgi.uat.wsohosting.com/
Rest Call Syntax
GET SecurityMaster/v1/Equities/Udfs/{name}
GET SecurityMaster/v1/Equities/Udfs/{name}
Limitations
There are no limitations specified.
Request Information
Parameters
Name
Description
Type
Additional Information
name
Name of udf
string
Required
Response Information
UdfType
Name
Description
Type
Additional Information
AllowNewPickListItem
A flag indicating whether a new pick list item can be added via this API
boolean
DisplayName
The display name of the UDF
string
ExtractionName
Gets the extraction name of the UDF (this value will be the type of PickList defined in PickListItem)
string
Format
Gets the format of the UDF
string
HasPickList
A flag indicating whether or not the possible values of the UDF are from a PickList
boolean
LimitToList
A flag indicating no new pick list items can be added via this API
boolean
MaxLength
The maximum length of the value
integer
MaxValue
Gets the maximum value that can be assigned to the UDF
Object
MinValue
Gets the minimum value that can be assigned to the UDF
Object
Name
The name of the UDF
string
PickList
A list of items displaying potential values for the UDF
Collection of string
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"
}
],
"maxLength": 1,
"name": "sample string 2",
"displayName": "sample string 3",
"fieldDataType": "Long",
"ownerObjectType": "Portfolio",
"extractionName": "sample string 4",
"hasPickList": true,
"minValue": {},
"maxValue": {},
"format": "sample string 8",
"allowNewPickListItem": true,
"limitToList": true,
"pickList": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
<UdfType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AllowNewPickListItem>true</AllowNewPickListItem>
<DisplayName>sample string 3</DisplayName>
<ExtractionName>sample string 4</ExtractionName>
<FieldDataType>Long</FieldDataType>
<Format>sample string 8</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>1</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>
</UdfType>