POST api/ECMDashboard/RetireContents

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Contents		Collection of ECMDashboardContent	None.

Request Formats

application/json, text/json

Sample:

{
  "contents": [
    {
      "title": "sample string 1",
      "listId": "sample string 2",
      "listItemId": "sample string 3",
      "siteUrl": "sample string 4",
      "pageUrl": "sample string 5"
    },
    {
      "title": "sample string 1",
      "listId": "sample string 2",
      "listItemId": "sample string 3",
      "siteUrl": "sample string 4",
      "pageUrl": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ECMDashboardContentResponse

Name	Type	Additional information
Action	string	None.
ServerRelativeUrl	string	None.
AssociatedDocuments	Collection of ECMDocument	None.
AssociatedDocumentFolder	string	None.
IsSuccess	boolean	None.
ErrorMessage	string	None.
Title	string	None.
ListId	string	None.
ListItemId	string	None.
SiteUrl	string	None.
PageUrl	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "action": "sample string 1",
    "serverRelativeUrl": "sample string 2",
    "associatedDocuments": [
      {
        "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"
      }
    ],
    "associatedDocumentFolder": "sample string 3",
    "isSuccess": true,
    "errorMessage": "sample string 5",
    "title": "sample string 6",
    "listId": "sample string 7",
    "listItemId": "sample string 8",
    "siteUrl": "sample string 9",
    "pageUrl": "sample string 10"
  },
  {
    "action": "sample string 1",
    "serverRelativeUrl": "sample string 2",
    "associatedDocuments": [
      {
        "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"
      }
    ],
    "associatedDocumentFolder": "sample string 3",
    "isSuccess": true,
    "errorMessage": "sample string 5",
    "title": "sample string 6",
    "listId": "sample string 7",
    "listItemId": "sample string 8",
    "siteUrl": "sample string 9",
    "pageUrl": "sample string 10"
  }
]

application/xml, text/xml

Sample:

<ArrayOfECMDashboardContentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GTI.DW.PeopleProfile.Domain.Models.ECM">
  <ECMDashboardContentResponse>
    <ListId>sample string 7</ListId>
    <ListItemId>sample string 8</ListItemId>
    <PageUrl>sample string 10</PageUrl>
    <SiteUrl>sample string 9</SiteUrl>
    <Title>sample string 6</Title>
    <Action>sample string 1</Action>
    <AssociatedDocumentFolder>sample string 3</AssociatedDocumentFolder>
    <AssociatedDocuments>
      <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>
    </AssociatedDocuments>
    <ErrorMessage>sample string 5</ErrorMessage>
    <IsSuccess>true</IsSuccess>
    <ServerRelativeUrl>sample string 2</ServerRelativeUrl>
  </ECMDashboardContentResponse>
  <ECMDashboardContentResponse>
    <ListId>sample string 7</ListId>
    <ListItemId>sample string 8</ListItemId>
    <PageUrl>sample string 10</PageUrl>
    <SiteUrl>sample string 9</SiteUrl>
    <Title>sample string 6</Title>
    <Action>sample string 1</Action>
    <AssociatedDocumentFolder>sample string 3</AssociatedDocumentFolder>
    <AssociatedDocuments>
      <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>
    </AssociatedDocuments>
    <ErrorMessage>sample string 5</ErrorMessage>
    <IsSuccess>true</IsSuccess>
    <ServerRelativeUrl>sample string 2</ServerRelativeUrl>
  </ECMDashboardContentResponse>
</ArrayOfECMDashboardContentResponse>