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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AbandonedUploads: False,
	ClaimedLicenses: False,
	TerminalAnonymization: False,
	SecurityArtifacts: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Reports: 
	[
		{
			JobName: String,
			RunId: String,
			StartedAtUtc: 0001-01-01,
			FinishedAtUtc: 0001-01-01,
			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
}