POST api/ECMDashboard/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

Name	Description	Type	Additional information
Item1		ECMGetRelatedDocumentsResponse	None.
Item2		Collection of CoveoSearchResult	None.

Response Formats

application/json, text/json

Sample:

{
  "item1": {
    "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"
  },
  "item2": [
    {
      "title": "sample string 1",
      "printableUri": "sample string 2",
      "clickUri": "sample string 3"
    },
    {
      "title": "sample string 1",
      "printableUri": "sample string 2",
      "clickUri": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

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