Akamai · Example Payload
Akamai Get Reporting Groups Example

CDNCloudEdge ComputingNetworksPlatformSecurity
Akamai Get Reporting Groups 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": "get-reporting-groups",
  "method": "GET",
  "path": "/reporting-groups",
  "summary": "List reporting groups",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "groups": [
          {
            "reportingGroupId": 101010,
            "reportingGroupName": "Region XYZ",
            "accessGroup": {
              "contractId": "K-0N7RAK7",
              "groupId": 15225
            },
            "contracts": [
              {
                "contractId": "K-0N7RAK71",
                "cpcodes": [
                  {
                    "cpcodeId": 1234567,
                    "cpcodeName": "Digital Company CP Code"
                  }
                ]
              }
            ]
          },
          {
            "reportingGroupId": 101011,
            "reportingGroupName": "Region gLobal XYZ",
            "accessGroup": {
              "contractId": "C-0N7RAC71",
              "groupId": 15225
            },
            "contracts": [
              {
                "contractId": "K-0N7RAK71",
                "cpcodes": [
                  {
                    "cpcodeId": 1234567,
                    "cpcodeName": "Internet Company CP Code"
                  },
                  {
                    "cpcodeId": 1234567,
                    "cpcodeName": "High Street Company CP Code"
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    {
      "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"
          }
        ]
      }
    }
  ]
}