Cdn API - CPG Source

<back to all web services

CdnxRetentionRunRequest

Cdn.Api

The following routes are available for this service:
POST/admin/cdnx-retention/run
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /admin/cdnx-retention/run HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AbandonedUploads":false,"ClaimedLicenses":false,"TerminalAnonymization":false,"SecurityArtifacts":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Reports":[{"JobName":"String","RunId":"String","StartedAtUtc":"\/Date(-62135596800000-0000)\/","FinishedAtUtc":"\/Date(-62135596800000-0000)\/","Outcome":"Completed","CandidateCount":0,"MutatedCount":0,"SkippedOnHoldCount":0,"VerifiedCount":0,"VerificationFailures":["String"],"Notes":["String"],"ErrorText":"String"}],"DestructiveStepsEnabled":false,"DisabledReason":"String","Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false}