Akamai Put Cpcode Example is an example object payload from Akamai, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "put-cpcode",
"method": "PUT",
"path": "/cpcodes/{cpcodeId}",
"summary": "Update a CP code",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"accountId": "A-CCT9012",
"cpcodeId": 1234567,
"cpcodeName": "Digital Company CP Code new",
"defaultTimezone": "GMT 0 (Greenwich Mean Time)",
"purgeable": true,
"type": "Regular",
"accessGroup": {
"contractId": "K-0N7RAK7",
"groupId": 15225
},
"overrideTimezone": {
"timezoneId": "0",
"timezoneValue": "GMT 0 (Greenwich Mean Time)"
},
"contracts": [
{
"contractId": "C-0N7RAC7",
"status": "ongoing"
}
],
"products": [
{
"productId": "AdvSite::Reporter",
"productName": "Monitor site advance"
}
]
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"accountId": "A-CCT9012",
"cpcodeId": 1234567,
"cpcodeName": "Digital Company CP Code new",
"defaultTimezone": "GMT 0 (Greenwich Mean Time)",
"purgeable": true,
"type": "Regular",
"accessGroup": {
"contractId": "K-0N7RAK71",
"groupId": 15225
},
"overrideTimezone": {
"timezoneId": "0",
"timezoneValue": "GMT 0 (Greenwich Mean Time)"
},
"contracts": [
{
"contractId": "K-0N7RAK71",
"status": "ongoing"
}
],
"products": [
{
"productId": "AdvSite::Reporter",
"productName": "Monitor site advance"
}
]
}
},
{
"status": "400",
"contentType": "application/problem+json",
"example": {
"code": "bad.request",
"incidentId": "dc2f405e-29d3-4845-a4ac-2f6b4a732aca",
"title": "Bad Request",
"details": [
{
"code": "invalid.data",
"message": "Group name is mandatory"
}
]
}
},
{
"status": "401",
"contentType": "application/problem+json",
"example": {
"code": "unauthorized",
"incidentId": "dc2f405e-29d3-4845-a4ac-2f6b4a732aca",
"title": "Unauthorized",
"details": [
{
"code": "invalid.data",
"message": "The request requires authentication"
}
]
}
},
{
"status": "403",
"contentType": "application/problem+json",
"example": {
"code": "forbidden",
"incidentId": "dc2f405e-29d3-4845-a4ac-2f6b4a732aca",
"title": "Forbidden",
"details": [
{
"code": "invalid.role",
"message": "User is not authorized"
}
]
}
},
{
"status": "404",
"contentType": "application/problem+json",
"example": {
"code": "not.found",
"incidentId": "dc2f405e-29d3-4845-a4ac-2f6b4a732aca",
"title": "Not Found",
"details": [
{
"code": "invalid.data",
"message": "The reporting group with id 000 is already deleted"
}
]
}
},
{
"status": "405",
"contentType": "application/problem+json",
"example": {
"code": "method.not.allowed",
"incidentId": "3714936a-07a6-4991-939f-c201adbf35f3",
"title": "Method Not Allowed",
"details": [
{
"code": "method.not.supported",
"message": "method.not.supported"
}
]
}
},
{
"status": "415",
"contentType": "application/problem+json",
"example": {
"detail": "Our system does not support requests in the format you're sending.",
"instance": "/papi/v1/properties?contractId=K-0N7RAK7&groupId=123456#abc12345abcc02a7",
"status": 415,
"title": "Unsupported Media Type",
"type": "https://problems.luna.akamaiapis.net/papi/v1/http/unsupported-media-type"
}
}
]
}