GET v1/Composites/{id}/CompositeLinks

Description

Retrieve list of Composites links with Composite ID of {id}.

Base Url

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

Rest Call Syntax


GET Reference/v1/Composites/{id}/CompositeLinks

Execute API

GET Reference/v1/Composites/{id}/CompositeLinks

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



Limitations

There are no limitations specified.



Request Information


Parameters

Name

Description

Type

Additional Information

id

Composite ID

integer

Required

IsDeleted

This flag will allow the return of deleted Composites in the search results

IsMemberOfComposite

Check whether the composite link is linked with composite or not.

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer

PortfolioFilterType

This value will allow to filter portfolio based on supplied portfolio type.



Response Information



PagedList Of CompositeLink

Name

Description

Type

Additional Information

Items

Collection of CompositeLink

Links

Collection of Link

PagingInformation



Response Body Formats



application/json, text/json

Sample: 
{
  "items": [
    {
      "compositeId": 1,
      "compositeLinkObjectId": 2,
      "compositeLinkId": 3,
      "compositeLinkName": "sample string 4",
      "compositeLinkType": "Portfolio"
    },
    {
      "compositeId": 1,
      "compositeLinkObjectId": 2,
      "compositeLinkId": 3,
      "compositeLinkName": "sample string 4",
      "compositeLinkType": "Portfolio"
    }
  ],
  "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: 
<PagedListOfCompositeLink xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <CompositeLink>
      <CompositeId>1</CompositeId>
      <CompositeLinkId>3</CompositeLinkId>
      <CompositeLinkName>sample string 4</CompositeLinkName>
      <CompositeLinkObjectId>2</CompositeLinkObjectId>
      <CompositeLinkType>Portfolio</CompositeLinkType>
    </CompositeLink>
    <CompositeLink>
      <CompositeId>1</CompositeId>
      <CompositeLinkId>3</CompositeLinkId>
      <CompositeLinkName>sample string 4</CompositeLinkName>
      <CompositeLinkObjectId>2</CompositeLinkObjectId>
      <CompositeLinkType>Portfolio</CompositeLinkType>
    </CompositeLink>
  </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>
</PagedListOfCompositeLink>


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.