Akamai · Example Payload

Akamai Post Resource Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Post Resource 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

Raw ↑ 
{
  "operationId": "post-resource",
  "method": "POST",
  "path": "/endpoints/{apiEndPointId}/versions/{versionNumber}/resources",
  "summary": "Create a resource",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "apiResourceName": "magazine",
        "description": "A magazine item within the bookstore API.",
        "resourcePath": "/magazine/{magazineId}",
        "apiResourceMethods": [
          {
            "apiResourceMethod": "GET",
            "apiParameters": [
              {
                "apiParameterLocation": "path",
                "apiParameterName": "magazineId",
                "apiParameterNotes": null,
                "apiParameterRequired": true,
                "apiParameterRestriction": null,
                "apiParameterType": "string",
                "array": false
              }
            ]
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "201",
      "contentType": "application/json",
      "example": {
        "apiResourceClonedFromId": null,
        "apiResourceId": 2935139,
        "apiResourceLogicId": 126269,
        "apiResourceName": "magazine",
        "createDate": "2019-06-17T08:26:59+0000",
        "createdBy": "tyamada",
        "description": "A magazine item within the bookstore API.",
        "link": null,
        "lockVersion": 0,
        "private": false,
        "resourcePath": "/magazine/{magazineId}",
        "updateDate": "2019-06-17T08:26:59+0000",
        "updatedBy": "bookstore_admin",
        "apiResourceMethods": [
          {
            "apiResourceMethod": "GET",
            "apiResourceMethodId": 365559,
            "apiResourceMethodLogicId": 205820,
            "apiParameters": [
              {
                "apiParamLogicId": 588309,
                "apiParameterId": 1223250,
                "apiParameterLocation": "path",
                "apiParameterName": "magazineId",
                "apiParameterNotes": null,
                "apiParameterRequired": true,
                "apiParameterRestriction": null,
                "apiParameterType": "string",
                "apiResourceMethParamId": 500315,
                "array": false,
                "pathParamLocationId": null,
                "apiChildParameters": []
              }
            ]
          }
        ]
      }
    }
  ]
}