Cdn API - CPG Source

<back to all web services

CdnxRetentionRunRequest

Cdn.Api

CdnxRetentionRunRequest Parameters:
NameParameterData TypeRequiredDescription
AbandonedUploadsbodybool?No
ClaimedLicensesbodybool?No
TerminalAnonymizationbodybool?No
SecurityArtifactsbodybool?No
CdnxRetentionRunResponse Parameters:
NameParameterData TypeRequiredDescription
ReportsformList<CdnxRetentionJobReport>No
DestructiveStepsEnabledformboolNo
DisabledReasonformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
CdnxRetentionJobReport Parameters:
NameParameterData TypeRequiredDescription
JobNameformstringNo
RunIdformstringNo
StartedAtUtcformDateTimeNo
FinishedAtUtcformDateTimeNo
OutcomeformCdnxRetentionJobOutcomeNo
CandidateCountformintNo
MutatedCountformintNo
SkippedOnHoldCountformintNo
VerifiedCountformintNo
VerificationFailuresformList<string>No
NotesformList<string>No
ErrorTextformstringNo

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

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: cdnapidev.greysheet.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: CdnxRetentionRunRequest

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<CdnxRetentionRunRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <AbandonedUploads>false</AbandonedUploads>
  <ClaimedLicenses>false</ClaimedLicenses>
  <SecurityArtifacts>false</SecurityArtifacts>
  <TerminalAnonymization>false</TerminalAnonymization>
</CdnxRetentionRunRequest>

    </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<CdnxRetentionRunResponse 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>
  <DestructiveStepsEnabled>false</DestructiveStepsEnabled>
  <DisabledReason>String</DisabledReason>
  <Reports xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.CdnxApplicants">
    <d2p1:CdnxRetentionJobReport>
      <d2p1:CandidateCount>0</d2p1:CandidateCount>
      <d2p1:ErrorText>String</d2p1:ErrorText>
      <d2p1:FinishedAtUtc>0001-01-01T00:00:00</d2p1:FinishedAtUtc>
      <d2p1:JobName>String</d2p1:JobName>
      <d2p1:MutatedCount>0</d2p1:MutatedCount>
      <d2p1:Notes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Notes>
      <d2p1:Outcome>Completed</d2p1:Outcome>
      <d2p1:RunId>String</d2p1:RunId>
      <d2p1:SkippedOnHoldCount>0</d2p1:SkippedOnHoldCount>
      <d2p1:StartedAtUtc>0001-01-01T00:00:00</d2p1:StartedAtUtc>
      <d2p1:VerificationFailures xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:VerificationFailures>
      <d2p1:VerifiedCount>0</d2p1:VerifiedCount>
    </d2p1:CdnxRetentionJobReport>
  </Reports>
</CdnxRetentionRunResponse>

    </soap:Body>
</soap:Envelope>