POST api/UMS/GetRelatedDocuments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PageUrl	string	None.
SiteUrl	string	None.
ListId	string	None.
ListItemId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "pageUrl": "sample string 1",
  "siteUrl": "sample string 2",
  "listId": "sample string 3",
  "listItemId": "sample string 4"
}

application/xml, text/xml

Sample:

<ECMGetRelatedDocumentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GTI.DW.PeopleProfile.Domain.Models.ECM">
  <ListId>sample string 3</ListId>
  <ListItemId>sample string 4</ListItemId>
  <PageUrl>sample string 1</PageUrl>
  <SiteUrl>sample string 2</SiteUrl>
</ECMGetRelatedDocumentsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ECMGetRelatedDocumentsResponse

Name	Type	Additional information
RelatedDocuments	Collection of ECMDocument	None.
SiteUrl	string	None.
FolderName	string	None.
IsSuccess	boolean	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "relatedDocuments": [
    {
      "listId": "sample string 1",
      "listItemId": "sample string 2",
      "siteUrl": "sample string 3",
      "title": "sample string 4",
      "url": "sample string 5",
      "fileName": "sample string 6"
    },
    {
      "listId": "sample string 1",
      "listItemId": "sample string 2",
      "siteUrl": "sample string 3",
      "title": "sample string 4",
      "url": "sample string 5",
      "fileName": "sample string 6"
    }
  ],
  "siteUrl": "sample string 1",
  "folderName": "sample string 2",
  "isSuccess": true,
  "errorMessage": "sample string 4"
}

application/xml, text/xml

Sample:

<ECMGetRelatedDocumentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GTI.DW.PeopleProfile.Domain.Models.ECM">
  <ErrorMessage>sample string 4</ErrorMessage>
  <FolderName>sample string 2</FolderName>
  <IsSuccess>true</IsSuccess>
  <RelatedDocuments>
    <ECMDocument>
      <FileName>sample string 6</FileName>
      <ListId>sample string 1</ListId>
      <ListItemId>sample string 2</ListItemId>
      <SiteUrl>sample string 3</SiteUrl>
      <Title>sample string 4</Title>
      <Url>sample string 5</Url>
    </ECMDocument>
    <ECMDocument>
      <FileName>sample string 6</FileName>
      <ListId>sample string 1</ListId>
      <ListItemId>sample string 2</ListItemId>
      <SiteUrl>sample string 3</SiteUrl>
      <Title>sample string 4</Title>
      <Url>sample string 5</Url>
    </ECMDocument>
  </RelatedDocuments>
  <SiteUrl>sample string 1</SiteUrl>
</ECMGetRelatedDocumentsResponse>