Cdn API - CPG Source

<back to all web services

CdnxRetentionHoldListRequest

Cdn.Api

The following routes are available for this service:
GET/admin/cdnx-retention/holds
CdnxRetentionHoldListResponse Parameters:
NameParameterData TypeRequiredDescription
HoldsformList<CdnxRetentionHoldItem>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
CdnxRetentionHoldItem Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ApplicationIdformlong?No
ObjectKeyformstringNo
ReasonformstringNo
PlacedByUserIdformlongNo
PlacedAtformDateTimeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /admin/cdnx-retention/holds HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CdnxRetentionHoldListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <Holds>
    <CdnxRetentionHoldItem>
      <ApplicationId>0</ApplicationId>
      <Id>0</Id>
      <ObjectKey>String</ObjectKey>
      <PlacedAt>0001-01-01T00:00:00</PlacedAt>
      <PlacedByUserId>0</PlacedByUserId>
      <Reason>String</Reason>
    </CdnxRetentionHoldItem>
  </Holds>
</CdnxRetentionHoldListResponse>