|
IHS Markit API |
GET v1/Composites
Description
Retrieve list of Composites satisfying the input search criteria.
Base Url
https://api-ppc.wsohosting.com/
Rest Call Syntax
GET Reference/v1/Composites
GET Reference/v1/Composites
Limitations
There are no limitations specified.
Request Information
Parameters
Name
Description
Type
Additional Information
CompositeNameStartsWith
This value will allow a Composite search by Composite Name Starts With
string
PageNumber
Specified Page number to search
integer
PageSize
Specified Page size to search
integer
Response Information
PagedList Of CompositeListItem
Name
Description
Type
Additional Information
Response Body Formats
application/json, text/json
Sample:
{
"items": [
{
"id": 1,
"isDeleted": true,
"compositeName": "sample string 3"
},
{
"id": 1,
"isDeleted": true,
"compositeName": "sample string 3"
}
],
"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:
<PagedListOfCompositeListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Items>
<CompositeListItem>
<CompositeName>sample string 3</CompositeName>
<Id>1</Id>
<IsDeleted>true</IsDeleted>
</CompositeListItem>
<CompositeListItem>
<CompositeName>sample string 3</CompositeName>
<Id>1</Id>
<IsDeleted>true</IsDeleted>
</CompositeListItem>
</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>
</PagedListOfCompositeListItem>
Feedback
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.