{ "components": { "parameters": { "customer-event-id-query": { "description": "A list of user-defined IDs to filter event data by.", "in": "query", "name": "customerEventId", "schema": { "example": "id1", "maxLength": 100, "type": "string" }, "x-akamai": { "file-path": "parameters/customer-event-id-query.yaml" } }, "event-id-path": { "description": "The identifier of the event.", "in": "path", "name": "eventId", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/event-id-path.yaml" } }, "max-end-query": { "description": "The inclusive upper bound of an end date.", "in": "query", "name": "maxEnd", "schema": { "example": "2021-02-28T16:41:41Z", "format": "date-time", "type": "string" }, "x-akamai": { "file-path": "parameters/max-end-query.yaml" } }, "max-start-query": { "description": "The exclusive upper bound of a start date.", "in": "query", "name": "maxStart", "schema": { "example": "2021-02-28T16:41:41Z", "format": "date-time", "type": "string" }, "x-akamai": { "file-path": "parameters/max-start-query.yaml" } }, "min-end-query": { "description": "The exclusive lower bound of an end date.", "in": "query", "name": "minEnd", "schema": { "example": "2021-02-28T16:41:41Z", "format": "date-time", "type": "string" }, "x-akamai": { "file-path": "parameters/min-end-query.yaml" } }, "min-start-query": { "description": "The inclusive lower bound of a start date.", "in": "query", "name": "minStart", "schema": { "example": "2021-02-28T16:41:41Z", "format": "date-time", "type": "string" }, "x-akamai": { "file-path": "parameters/min-start-query.yaml" } }, "page-query": { "description": "The number of the page. Page numbers start at 1.", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-query.yaml" } }, "page-size-query": { "description": "The number of records on a page. By default, a page has 25 records. The maximum value is 1000 records on a page.", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "maximum": 1000, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-size-query.yaml" } }, "sort-query": { "description": "The sorting property and the sorting direction for the result data. Use `name` to sort by name. Use `asc` for alphabetically ascending order or `desc` for alphabetically descending order.", "in": "query", "name": "sort", "schema": { "example": "name,asc", "type": "string" }, "x-akamai": { "file-path": "parameters/sort-query.yaml" } }, "tag-query": { "description": "A list of tags to filter event data by.", "explode": true, "in": "query", "name": "tag", "schema": { "example": "Tag 1", "maxLength": 100, "type": "string" }, "style": "form", "x-akamai": { "file-path": "parameters/tag-query.yaml" } } }, "responses": { "400": { "content": { "application/problem+json": { "example": { "errors": [ { "detail": "Invalid value: 'someProperty', parameter: sort", "parameter": "sort", "title": "Bad Request", "type": "about:blank", "value": "someProperty" } ], "status": 400, "title": "Bad Request", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/event-ctr/reference/400). Invalid request. Details may be available in the response body.", "x-akamai": { "file-path": "errors/400.yaml" } }, "400-constraint": { "content": { "application/problem+json": { "example": { "errors": [ { "detail": "end must not be null", "path": "end", "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation", "value": null }, { "detail": "start must not be null", "path": "start", "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation", "value": null }, { "detail": "name must not be blank", "path": "name", "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation", "value": null } ], "status": 400, "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/event-ctr/reference/400). Invalid request. Details may be available in the response body.", "x-akamai": { "file-path": "errors/400-constraint.yaml" } }, "403-cpcode": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions to access CpCode entity", "status": 403, "title": "Forbidden", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/event-ctr/reference/403). Insufficient permissions to access event or associated objects.", "x-akamai": { "file-path": "errors/403-cpcode.yaml" } }, "403-event": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions to modify Event entity", "status": 403, "title": "Forbidden", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/event-ctr/reference/403). Insufficient permissions to access event or associated objects.", "x-akamai": { "file-path": "errors/403-event.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Event entity with id 11 not found", "status": 404, "title": "Not Found", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/event-ctr/reference/404). The requested event wasn't found.", "x-akamai": { "file-path": "errors/404.yaml" } }, "409-concurrency": { "content": { "application/problem+json": { "example": { "detail": "Version mismatch for Event entity, expected version: 0, but got: 1", "status": 409, "title": "Concurrent modification", "type": "/event-center/error-types/concurrent-modification" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/event-ctr/reference/409). The event was modified after you retrieved it. Please refetch the event, reconcile possible differences and resubmit the request.", "x-akamai": { "file-path": "errors/409-concurrency.yaml" } }, "409-duplicate": { "content": { "application/problem+json": { "example": { "detail": "An Event entity with the same name: 2018 Winter Olympics, start: 2018-04-23T04:00:00Z and end: 2018-04-23T04:30:00Z already exists", "status": 409, "title": "Entity already exists", "type": "/event-center/error-types/duplicate" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/event-ctr/reference/409). An event with same name, start and end already exists.", "x-akamai": { "file-path": "errors/409-duplicate.yaml" } } }, "schemas": { "country": { "additionalProperties": false, "description": "Provides information about a country that matches the geographic area of an audience.", "properties": { "code": { "description": "A two-letter ISO 3166 country code.", "type": "string" }, "name": { "description": "Name of the country that corresponds to the country code.", "type": "string" } }, "required": [ "code", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/country.yaml" } }, "cp-code": { "additionalProperties": false, "description": "Contains information about a Content Provider (CP) code for the event.", "properties": { "id": { "description": "The identifier of the CP code.", "type": "integer" }, "name": { "description": "The name of the CP code.", "type": "string" } }, "required": [ "id", "name" ], "title": "CP code", "type": "object", "x-akamai": { "file-path": "schemas/cp-code.yaml" } }, "event": { "additionalProperties": false, "description": "Contains information about an event including a list of tags associated with this event.", "properties": { "customerEventId": { "description": "The user-specified ID for the event.", "type": "string" }, "end": { "description": "The end date of the event.", "format": "date-time", "type": "string" }, "id": { "description": "The identifier of the event.", "type": "integer" }, "name": { "description": "The name of the event.", "type": "string" }, "start": { "description": "The start date of the event.", "format": "date-time", "type": "string" }, "tags": { "description": "A collection of tags associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a tag.", "properties": { "id": { "description": "The identifier of the tag.", "type": "integer" }, "name": { "description": "The description of the tag.", "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/tag.yaml" } }, "type": "array" }, "version": { "description": "The version of the event.", "type": "integer" } }, "required": [ "id", "version", "name", "start", "end" ], "type": "object", "x-akamai": { "file-path": "schemas/event.yaml" } }, "event-200": { "additionalProperties": false, "description": "Contains detailed information about the event, including tags and objects associated with this event.", "properties": { "audienceLocations": { "description": "Countries that match the geographic locations of audiences.", "items": { "additionalProperties": false, "description": "Provides information about a country that matches the geographic area of an audience.", "properties": { "code": { "description": "A two-letter ISO 3166 country code.", "type": "string" }, "name": { "description": "Name of the country that corresponds to the country code.", "type": "string" } }, "required": [ "code", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/country.yaml" } }, "type": "array" }, "audienceSize": { "description": "The audience's size for the event.", "type": "integer" }, "coordinators": { "description": "Coordinators assigned to the event.", "items": { "additionalProperties": false, "description": "Contains information about the event's coordinator.", "properties": { "firstName": { "description": "The coordinator's first name.", "type": "string" }, "lastName": { "description": "The coordinator's last name.", "type": "string" }, "userName": { "description": "The coordinator's username as defined in Control Center.", "type": "string" } }, "required": [ "userName", "firstName", "lastName" ], "type": "object", "x-akamai": { "file-path": "schemas/user.yaml" } }, "type": "array" }, "createdBy": { "description": "The person who created the event.", "type": "string" }, "createdDate": { "description": "An ISO 8601 timestamp indicating the date and time when the event was created.", "format": "date-time", "type": "string" }, "customerEventId": { "description": "The user-specified ID for the event. See [Customer Event ID](https://techdocs.akamai.com/event-ctr/docs/concepts).", "type": "string" }, "description": { "description": "The description of the event.", "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating the end date of the event.", "format": "date-time", "type": "string" }, "id": { "description": "The identifier of the event.", "type": "integer" }, "modifiedBy": { "description": "The person who last modified the event.", "type": "string" }, "modifiedDate": { "description": "An ISO 8601 timestamp indicating the date and time when the event was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "The name of the event.", "type": "string" }, "objects": { "description": "Objects associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a Content Provider (CP) code for the event.", "properties": { "id": { "description": "The identifier of the CP code.", "type": "integer" }, "name": { "description": "The name of the CP code.", "type": "string" } }, "required": [ "id", "name" ], "title": "CP code", "type": "object", "x-akamai": { "file-path": "schemas/cp-code.yaml" } }, "type": "array" }, "start": { "description": "An ISO 8601 timestamp indicating the start date of the event.", "format": "date-time", "type": "string" }, "tags": { "description": "Tags associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a tag.", "properties": { "id": { "description": "The identifier of the tag.", "type": "integer" }, "name": { "description": "The description of the tag.", "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/tag.yaml" } }, "type": "array" }, "version": { "description": "The version of the event.", "type": "integer" } }, "required": [ "id", "end", "name", "start", "version", "createdDate", "createdBy", "modifiedDate", "modifiedBy" ], "type": "object", "x-akamai": { "file-path": "schemas/event-200.yaml" } }, "event-object-assign": { "additionalProperties": false, "description": "Contains information about the CP codes that you can associate with the event.", "properties": { "id": { "description": "The identifier of the CP code associated with the event.", "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/event-object-assign.yaml" } }, "event-page-200": { "additionalProperties": false, "description": "Contains a list of events for the current account and contract type. It also provides context about the requested data based on the request's parameters.", "properties": { "data": { "description": "A collection of events.", "items": { "additionalProperties": false, "description": "Contains information about an event including a list of tags associated with this event.", "properties": { "customerEventId": { "description": "The user-specified ID for the event.", "type": "string" }, "end": { "description": "The end date of the event.", "format": "date-time", "type": "string" }, "id": { "description": "The identifier of the event.", "type": "integer" }, "name": { "description": "The name of the event.", "type": "string" }, "start": { "description": "The start date of the event.", "format": "date-time", "type": "string" }, "tags": { "description": "A collection of tags associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a tag.", "properties": { "id": { "description": "The identifier of the tag.", "type": "integer" }, "name": { "description": "The description of the tag.", "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/tag.yaml" } }, "type": "array" }, "version": { "description": "The version of the event.", "type": "integer" } }, "required": [ "id", "version", "name", "start", "end" ], "type": "object", "x-akamai": { "file-path": "schemas/event.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": true, "description": "Collects context about the requested data based on the request's parameters.", "properties": { "page": { "description": "The number of the page.", "type": "integer" }, "pageSize": { "description": "The number of records per page.", "type": "integer" }, "sort": { "description": "The sorting property and the sorting direction for the result data.", "items": { "additionalProperties": false, "properties": { "direction": { "description": "The sorting direction for the result data. Either `asc` for alphabetically ascending order or `desc` for alphabetically descending order.", "enum": [ "asc", "desc" ], "type": "string" }, "property": { "description": "The sorting property for the result data.", "type": "string" } }, "required": [ "property", "direction" ], "type": "object" }, "type": "array" }, "totalPageCount": { "description": "The total number of pages.", "type": "integer" }, "totalResultsCount": { "description": "The total number of records.", "type": "integer" } }, "required": [ "page", "pageSize", "sort", "totalResultsCount", "totalPageCount" ], "type": "object", "x-akamai": { "file-path": "schemas/page-metadata.yaml" } } }, "required": [ "metadata", "data" ], "type": "object", "x-akamai": { "file-path": "schemas/event-page-200.yaml" } }, "event-post": { "additionalProperties": false, "description": "Contains information about the request body parameters that you can specify when creating an event. It also includes tags and objects that you can associate with a new event and the recurrence context for the event.", "properties": { "audienceLocations": { "description": "Up to 20 unique, two-letter ISO 3166 country codes that indicate geographic areas of audiences.", "items": { "maxLength": 2, "minLength": 2, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true }, "audienceSize": { "description": "The audience's size for the event. The minimum value is 1.", "type": "integer", "x-annotation-oas-minimum": 1 }, "coordinators": { "description": "Up to 20 Control Center usernames of those who serve as the event's coordinators.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true }, "customerEventId": { "description": "The user-specified ID for the event. This ID can be up to 100 characters long. [Customer Event ID](https://techdocs.akamai.com/event-ctr/docs/concepts).", "type": "string" }, "description": { "description": "The description of the event. This description can be up to 2000 characters long.", "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating the end date of the event.", "format": "date-time", "type": "string" }, "name": { "description": "The name of the event. This name can be up to 750 characters long.", "maxLength": 750, "minLength": 1, "type": "string" }, "objects": { "description": "Objects associated with the event. This array can include only unique items.", "items": { "additionalProperties": false, "description": "Contains information about the CP codes that you can associate with the event.", "properties": { "id": { "description": "The identifier of the CP code associated with the event.", "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/event-object-assign.yaml" } }, "type": "array", "uniqueItems": true }, "recurrence": { "additionalProperties": false, "description": "Contains information about the recurrence parameters that you can specify when creating the event.", "properties": { "count": { "description": "The number of times to repeat the event. Specify a value between 1 and 366.", "maximum": 366, "minimum": 1, "type": "integer" }, "frequency": { "description": "The periodicity of the recurring event. Use `HOURLY` to repeat the event once an hour, `DAILY` to repeat the event once a day, `WEEKLY` to repeat the event once a week, or `MONTHLY` to repeat the event once a month.", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY" ], "type": "string" } }, "required": [ "frequency", "count" ], "type": "object", "x-akamai": { "file-path": "schemas/event-recurrence.yaml" } }, "start": { "description": "An ISO 8601 timestamp indicating the start date of the event.", "format": "date-time", "type": "string" }, "tags": { "description": "Tags associated with the event. A tag can be up to 100 characters long. This array can be up to 20 unique items.", "items": { "maxLength": 100, "minLength": 1, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true } }, "required": [ "name", "start", "end" ], "type": "object", "x-akamai": { "file-path": "schemas/event-post.yaml" } }, "event-post-200": { "description": "Contains details of an event.", "items": { "additionalProperties": false, "description": "Details about an event.", "properties": { "audienceLocations": { "description": "Countries that match the geographic locations of audiences.", "items": { "additionalProperties": false, "description": "Provides information about a country that matches the geographic area of an audience.", "properties": { "code": { "description": "A two-letter ISO 3166 country code.", "type": "string" }, "name": { "description": "Name of the country that corresponds to the country code.", "type": "string" } }, "required": [ "code", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/country.yaml" } }, "type": "array" }, "audienceSize": { "description": "The audience's size for the event.", "type": "integer" }, "coordinators": { "description": "Coordinators assigned to the event.", "items": { "additionalProperties": false, "description": "Contains information about the event's coordinator.", "properties": { "firstName": { "description": "The coordinator's first name.", "type": "string" }, "lastName": { "description": "The coordinator's last name.", "type": "string" }, "userName": { "description": "The coordinator's username as defined in Control Center.", "type": "string" } }, "required": [ "userName", "firstName", "lastName" ], "type": "object", "x-akamai": { "file-path": "schemas/user.yaml" } }, "type": "array" }, "createdBy": { "description": "The person who created the event.", "type": "string" }, "createdDate": { "description": "An ISO 8601 timestamp indicating the date and time when the event was created.", "format": "date-time", "type": "string" }, "customerEventId": { "description": "The user-specified ID for the event. See [Customer Event ID](https://techdocs.akamai.com/event-ctr/docs/concepts).", "type": "string" }, "description": { "description": "The description of the event.", "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating the end date of the event.", "format": "date-time", "type": "string" }, "id": { "description": "The identifier of the event.", "type": "integer" }, "modifiedBy": { "description": "The person who last modified the event.", "type": "string" }, "modifiedDate": { "description": "An ISO 8601 timestamp indicating the date and time when the event was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "The name of the event.", "type": "string" }, "objects": { "description": "Objects associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a Content Provider (CP) code for the event.", "properties": { "id": { "description": "The identifier of the CP code.", "type": "integer" }, "name": { "description": "The name of the CP code.", "type": "string" } }, "required": [ "id", "name" ], "title": "CP code", "type": "object", "x-akamai": { "file-path": "schemas/cp-code.yaml" } }, "type": "array" }, "start": { "description": "An ISO 8601 timestamp indicating the start date of the event.", "format": "date-time", "type": "string" }, "tags": { "description": "Tags associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a tag.", "properties": { "id": { "description": "The identifier of the tag.", "type": "integer" }, "name": { "description": "The description of the tag.", "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/tag.yaml" } }, "type": "array" }, "version": { "description": "The version of the event.", "type": "integer" } }, "required": [ "id", "end", "name", "start", "version", "createdDate", "createdBy", "modifiedDate", "modifiedBy" ], "type": "object", "x-akamai": { "file-path": "schemas/event-200.yaml" } }, "type": "array", "x-akamai": { "file-path": "schemas/event-post-200.yaml" } }, "event-put": { "additionalProperties": false, "description": "Contains information about the request body parameters that you can specify when updating an event. It also includes tags and objects that you can associate with an event.", "properties": { "audienceLocations": { "description": "Two-letter ISO 3166 country codes that indicate geographic areas of audiences. This array can contain up to 20 unique items.", "items": { "maxLength": 2, "minLength": 2, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true }, "audienceSize": { "description": "The audience's size for the event. The minimum value is 1.", "type": "integer", "x-annotation-oas-minimum": 1 }, "coordinators": { "description": "Up to 20 Control Center usernames of those who serve as the event's coordinators.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true }, "customerEventId": { "description": "The user-specified ID for the event. This ID can be up to 100 characters long. [Customer Event ID](https://techdocs.akamai.com/event-ctr/docs/concepts).", "type": "string" }, "description": { "description": "The description of the event. This description can be up to 2000 characters long.", "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating the end date of the event.", "format": "date-time", "type": "string" }, "name": { "description": "The name of the event. This name can be up to 750 characters long.", "maxLength": 750, "minLength": 1, "type": "string" }, "objects": { "description": "Objects associated with the event. This array can include only unique items.", "items": { "additionalProperties": false, "description": "Contains information about the CP codes that you can associate with the event.", "properties": { "id": { "description": "The identifier of the CP code associated with the event.", "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/event-object-assign.yaml" } }, "type": "array", "uniqueItems": true }, "start": { "description": "An ISO 8601 timestamp indicating the start date of the event.", "format": "date-time", "type": "string" }, "tags": { "description": "Tags for the event. Each tag can be up to 100 characters long. This array can contain up to 20 unique items.", "items": { "maxLength": 100, "minLength": 1, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true }, "version": { "description": "The version of the event. Use the `version` of the event sent in the original server's response. See [Event Version](https://techdocs.akamai.com/event-ctr/docs/concepts).", "type": "integer" } }, "required": [ "name", "start", "end", "version" ], "type": "object", "x-akamai": { "file-path": "schemas/event-put.yaml" } }, "event-recurrence": { "additionalProperties": false, "description": "Contains information about the recurrence parameters that you can specify when creating the event.", "properties": { "count": { "description": "The number of times to repeat the event. Specify a value between 1 and 366.", "maximum": 366, "minimum": 1, "type": "integer" }, "frequency": { "description": "The periodicity of the recurring event. Use `HOURLY` to repeat the event once an hour, `DAILY` to repeat the event once a day, `WEEKLY` to repeat the event once a week, or `MONTHLY` to repeat the event once a month.", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY" ], "type": "string" } }, "required": [ "frequency", "count" ], "type": "object", "x-akamai": { "file-path": "schemas/event-recurrence.yaml" } }, "page-metadata": { "additionalProperties": true, "description": "Collects context about the requested data based on the request's parameters.", "properties": { "page": { "description": "The number of the page.", "type": "integer" }, "pageSize": { "description": "The number of records per page.", "type": "integer" }, "sort": { "description": "The sorting property and the sorting direction for the result data.", "items": { "additionalProperties": false, "properties": { "direction": { "description": "The sorting direction for the result data. Either `asc` for alphabetically ascending order or `desc` for alphabetically descending order.", "enum": [ "asc", "desc" ], "type": "string" }, "property": { "description": "The sorting property for the result data.", "type": "string" } }, "required": [ "property", "direction" ], "type": "object" }, "type": "array" }, "totalPageCount": { "description": "The total number of pages.", "type": "integer" }, "totalResultsCount": { "description": "The total number of records.", "type": "integer" } }, "required": [ "page", "pageSize", "sort", "totalResultsCount", "totalPageCount" ], "type": "object", "x-akamai": { "file-path": "schemas/page-metadata.yaml" } }, "problem": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } }, "problem-nested": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "tag": { "additionalProperties": false, "description": "Contains information about a tag.", "properties": { "id": { "description": "The identifier of the tag.", "type": "integer" }, "name": { "description": "The description of the tag.", "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/tag.yaml" } }, "user": { "additionalProperties": false, "description": "Contains information about the event's coordinator.", "properties": { "firstName": { "description": "The coordinator's first name.", "type": "string" }, "lastName": { "description": "The coordinator's last name.", "type": "string" }, "userName": { "description": "The coordinator's username as defined in Control Center.", "type": "string" } }, "required": [ "userName", "firstName", "lastName" ], "type": "object", "x-akamai": { "file-path": "schemas/user.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Event Center API", "url": "https://techdocs.akamai.com/event-ctr/reference" }, "info": { "description": "Configure events, reporting, and alerts in Event Center.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Event Center API", "version": "v3" }, "openapi": "3.0.0", "paths": { "/events": { "post": { "description": "Creates an event with the specified parameters.", "externalDocs": { "description": "See documentation for this operation in Akamai's Event Center API", "url": "https://techdocs.akamai.com/event-ctr/reference/post-events" }, "operationId": "post-events", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "audienceLocations": [ "PL", "DE" ], "audienceSize": 5000000, "coordinators": [ "vsnyder", "tyamada" ], "customerEventId": "mmxxiii-owg", "description": "MMXXIII Olympic Winter Games 2022", "end": "2022-02-08T20:00:00Z", "name": "2022 Winter Olympics", "objects": [ { "id": 87654 }, { "id": 12345 } ], "recurrence": { "count": 2, "frequency": "DAILY" }, "start": "2022-02-08T08:00:00Z", "tags": [ "winter", "olympics" ] }, "schema": { "additionalProperties": false, "description": "Contains information about the request body parameters that you can specify when creating an event. It also includes tags and objects that you can associate with a new event and the recurrence context for the event.", "properties": { "audienceLocations": { "description": "Up to 20 unique, two-letter ISO 3166 country codes that indicate geographic areas of audiences.", "items": { "maxLength": 2, "minLength": 2, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true }, "audienceSize": { "description": "The audience's size for the event. The minimum value is 1.", "example": "{{audienceSize}}", "type": "integer", "x-annotation-oas-minimum": 1 }, "coordinators": { "description": "Up to 20 Control Center usernames of those who serve as the event's coordinators.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true }, "customerEventId": { "description": "The user-specified ID for the event. This ID can be up to 100 characters long. [Customer Event ID](https://techdocs.akamai.com/event-ctr/docs/concepts).", "example": "{{customerEventId}}", "type": "string" }, "description": { "description": "The description of the event. This description can be up to 2000 characters long.", "example": "{{description}}", "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating the end date of the event.", "example": "{{end}}", "format": "date-time", "type": "string" }, "name": { "description": "The name of the event. This name can be up to 750 characters long.", "example": "{{name}}", "maxLength": 750, "minLength": 1, "type": "string" }, "objects": { "description": "Objects associated with the event. This array can include only unique items.", "items": { "additionalProperties": false, "description": "Contains information about the CP codes that you can associate with the event.", "properties": { "id": { "description": "The identifier of the CP code associated with the event.", "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/event-object-assign.yaml" } }, "type": "array", "uniqueItems": true }, "recurrence": { "additionalProperties": false, "description": "Contains information about the recurrence parameters that you can specify when creating the event.", "properties": { "count": { "description": "The number of times to repeat the event. Specify a value between 1 and 366.", "maximum": 366, "minimum": 1, "type": "integer" }, "frequency": { "description": "The periodicity of the recurring event. Use `HOURLY` to repeat the event once an hour, `DAILY` to repeat the event once a day, `WEEKLY` to repeat the event once a week, or `MONTHLY` to repeat the event once a month.", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY" ], "type": "string" } }, "required": [ "frequency", "count" ], "type": "object", "x-akamai": { "file-path": "schemas/event-recurrence.yaml" } }, "start": { "description": "An ISO 8601 timestamp indicating the start date of the event.", "example": "{{start}}", "format": "date-time", "type": "string" }, "tags": { "description": "Tags associated with the event. A tag can be up to 100 characters long. This array can be up to 20 unique items.", "items": { "maxLength": 100, "minLength": 1, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true } }, "required": [ "name", "start", "end" ], "type": "object", "x-akamai": { "file-path": "schemas/event-post.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "audienceLocations": [ { "code": "PL", "name": "Poland" }, { "code": "DE", "name": "Germany" } ], "audienceSize": 5000000, "coordinators": [ { "firstName": "Vigilant", "lastName": "Snyder", "userName": "mrossi" }, { "firstName": "Taro", "lastName": "Yamada", "userName": "tyamada" } ], "createdBy": "alfulani", "createdDate": "2021-11-28T16:41:41Z", "customerEventId": "mmxxiii-owg", "description": "MMXXII Olympic Winter Games 2022", "end": "2022-02-08T20:00:00Z", "id": 1, "modifiedBy": "hgildong", "modifiedDate": "2021-12-28T16:41:41Z", "name": "2022 Winter Olympics", "objects": [ { "id": 87654, "name": "olympics-open.com/winter" }, { "id": 12345, "name": "open-olympics.com/all" } ], "start": "2022-02-08T08:00:00Z", "tags": [ { "id": 1, "name": "winter" }, { "id": 2, "name": "olympics" } ], "version": 0 }, { "audienceLocations": [ { "code": "PL", "name": "Poland" }, { "code": "DE", "name": "Germany" } ], "audienceSize": 5000000, "coordinators": [ { "firstName": "Vigilant", "lastName": "Snyder", "userName": "jkowalski" }, { "firstName": "Taro", "lastName": "Yamada", "userName": "tyamada" } ], "createdBy": "mrossi", "createdDate": "2021-11-28T16:41:41Z", "customerEventId": "mmxxiii-owg", "description": "MMXXII Olympic Winter Games 2022", "end": "2022-02-09T20:00:00Z", "id": 2, "modifiedBy": "hgildong", "modifiedDate": "2021-12-28T16:41:41Z", "name": "2022 Winter Olympics", "objects": [ { "id": 87654, "name": "olympics-open.com/winter" }, { "id": 12345, "name": "open-olympics.com/all" } ], "start": "2022-02-09T08:00:00Z", "tags": [ { "id": 1, "name": "winter" }, { "id": 2, "name": "olympics" } ], "version": 0 } ], "schema": { "description": "Contains details of an event.", "items": { "additionalProperties": false, "description": "Details about an event.", "properties": { "audienceLocations": { "description": "Countries that match the geographic locations of audiences.", "items": { "additionalProperties": false, "description": "Provides information about a country that matches the geographic area of an audience.", "properties": { "code": { "description": "A two-letter ISO 3166 country code.", "type": "string" }, "name": { "description": "Name of the country that corresponds to the country code.", "type": "string" } }, "required": [ "code", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/country.yaml" } }, "type": "array" }, "audienceSize": { "description": "The audience's size for the event.", "type": "integer" }, "coordinators": { "description": "Coordinators assigned to the event.", "items": { "additionalProperties": false, "description": "Contains information about the event's coordinator.", "properties": { "firstName": { "description": "The coordinator's first name.", "type": "string" }, "lastName": { "description": "The coordinator's last name.", "type": "string" }, "userName": { "description": "The coordinator's username as defined in Control Center.", "type": "string" } }, "required": [ "userName", "firstName", "lastName" ], "type": "object", "x-akamai": { "file-path": "schemas/user.yaml" } }, "type": "array" }, "createdBy": { "description": "The person who created the event.", "type": "string" }, "createdDate": { "description": "An ISO 8601 timestamp indicating the date and time when the event was created.", "format": "date-time", "type": "string" }, "customerEventId": { "description": "The user-specified ID for the event. See [Customer Event ID](https://techdocs.akamai.com/event-ctr/docs/concepts).", "type": "string" }, "description": { "description": "The description of the event.", "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating the end date of the event.", "format": "date-time", "type": "string" }, "id": { "description": "The identifier of the event.", "type": "integer" }, "modifiedBy": { "description": "The person who last modified the event.", "type": "string" }, "modifiedDate": { "description": "An ISO 8601 timestamp indicating the date and time when the event was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "The name of the event.", "type": "string" }, "objects": { "description": "Objects associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a Content Provider (CP) code for the event.", "properties": { "id": { "description": "The identifier of the CP code.", "type": "integer" }, "name": { "description": "The name of the CP code.", "type": "string" } }, "required": [ "id", "name" ], "title": "CP code", "type": "object", "x-akamai": { "file-path": "schemas/cp-code.yaml" } }, "type": "array" }, "start": { "description": "An ISO 8601 timestamp indicating the start date of the event.", "format": "date-time", "type": "string" }, "tags": { "description": "Tags associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a tag.", "properties": { "id": { "description": "The identifier of the tag.", "type": "integer" }, "name": { "description": "The description of the tag.", "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/tag.yaml" } }, "type": "array" }, "version": { "description": "The version of the event.", "type": "integer" } }, "required": [ "id", "end", "name", "start", "version", "createdDate", "createdBy", "modifiedDate", "modifiedBy" ], "type": "object", "x-akamai": { "file-path": "schemas/event-200.yaml" } }, "type": "array", "x-akamai": { "file-path": "schemas/event-post-200.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "errors": [ { "detail": "end must not be null", "path": "end", "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation", "value": null }, { "detail": "start must not be null", "path": "start", "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation", "value": null }, { "detail": "name must not be blank", "path": "name", "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation", "value": null } ], "status": 400, "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/event-ctr/reference/400). Invalid request. Details may be available in the response body.", "x-akamai": { "file-path": "errors/400-constraint.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions to access CpCode entity", "status": 403, "title": "Forbidden", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/event-ctr/reference/403). Insufficient permissions to access event or associated objects.", "x-akamai": { "file-path": "errors/403-cpcode.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "An Event entity with the same name: 2018 Winter Olympics, start: 2018-04-23T04:00:00Z and end: 2018-04-23T04:30:00Z already exists", "status": 409, "title": "Entity already exists", "type": "/event-center/error-types/duplicate" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/event-ctr/reference/409). An event with same name, start and end already exists.", "x-akamai": { "file-path": "errors/409-duplicate.yaml" } } }, "summary": "Create an event", "tags": [ "Events" ] }, "get": { "description": "Returns a list of events for the current account and contract type. This call supports paging and sorting of the result data.", "externalDocs": { "description": "See documentation for this operation in Akamai's Event Center API", "url": "https://techdocs.akamai.com/event-ctr/reference/get-events" }, "operationId": "get-events", "parameters": [ { "description": "The inclusive lower bound of a start date.", "example": "{{minStart}}", "in": "query", "name": "minStart", "schema": { "example": "2021-02-28T16:41:41Z", "format": "date-time", "type": "string" }, "x-akamai": { "file-path": "parameters/min-start-query.yaml" } }, { "description": "The exclusive upper bound of a start date.", "example": "{{maxStart}}", "in": "query", "name": "maxStart", "schema": { "example": "2021-02-28T16:41:41Z", "format": "date-time", "type": "string" }, "x-akamai": { "file-path": "parameters/max-start-query.yaml" } }, { "description": "The exclusive lower bound of an end date.", "example": "{{minEnd}}", "in": "query", "name": "minEnd", "schema": { "example": "2021-02-28T16:41:41Z", "format": "date-time", "type": "string" }, "x-akamai": { "file-path": "parameters/min-end-query.yaml" } }, { "description": "The inclusive upper bound of an end date.", "example": "{{maxEnd}}", "in": "query", "name": "maxEnd", "schema": { "example": "2021-02-28T16:41:41Z", "format": "date-time", "type": "string" }, "x-akamai": { "file-path": "parameters/max-end-query.yaml" } }, { "description": "A list of tags to filter event data by.", "example": "{{tag}}", "explode": true, "in": "query", "name": "tag", "schema": { "example": "Tag 1", "maxLength": 100, "type": "string" }, "style": "form", "x-akamai": { "file-path": "parameters/tag-query.yaml" } }, { "description": "A list of user-defined IDs to filter event data by.", "example": "{{customerEventId}}", "in": "query", "name": "customerEventId", "schema": { "example": "id1", "maxLength": 100, "type": "string" }, "x-akamai": { "file-path": "parameters/customer-event-id-query.yaml" } }, { "description": "The number of the page. Page numbers start at 1.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-query.yaml" } }, { "description": "The number of records on a page. By default, a page has 25 records. The maximum value is 1000 records on a page.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "maximum": 1000, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-size-query.yaml" } }, { "description": "The sorting property and the sorting direction for the result data. Use `name` to sort by name. Use `asc` for alphabetically ascending order or `desc` for alphabetically descending order.", "example": "{{sort}}", "in": "query", "name": "sort", "schema": { "example": "name,asc", "type": "string" }, "x-akamai": { "file-path": "parameters/sort-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "customerEventId": "mmxxiii-owg", "end": "2022-02-28T16:41:41Z", "id": 1, "name": "2022 Winter Olympics", "start": "2022-02-08T11:00:00Z", "tags": [ { "id": 1, "name": "winter" }, { "id": 2, "name": "olympics" } ], "version": 1 } ], "metadata": { "page": 1, "pageSize": 25, "sort": [ { "direction": "asc", "property": "name" } ], "totalPageCount": 1, "totalResultsCount": 1 } }, "schema": { "additionalProperties": false, "description": "Contains a list of events for the current account and contract type. It also provides context about the requested data based on the request's parameters.", "properties": { "data": { "description": "A collection of events.", "items": { "additionalProperties": false, "description": "Contains information about an event including a list of tags associated with this event.", "properties": { "customerEventId": { "description": "The user-specified ID for the event.", "type": "string" }, "end": { "description": "The end date of the event.", "format": "date-time", "type": "string" }, "id": { "description": "The identifier of the event.", "type": "integer" }, "name": { "description": "The name of the event.", "type": "string" }, "start": { "description": "The start date of the event.", "format": "date-time", "type": "string" }, "tags": { "description": "A collection of tags associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a tag.", "properties": { "id": { "description": "The identifier of the tag.", "type": "integer" }, "name": { "description": "The description of the tag.", "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/tag.yaml" } }, "type": "array" }, "version": { "description": "The version of the event.", "type": "integer" } }, "required": [ "id", "version", "name", "start", "end" ], "type": "object", "x-akamai": { "file-path": "schemas/event.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": true, "description": "Collects context about the requested data based on the request's parameters.", "properties": { "page": { "description": "The number of the page.", "type": "integer" }, "pageSize": { "description": "The number of records per page.", "type": "integer" }, "sort": { "description": "The sorting property and the sorting direction for the result data.", "items": { "additionalProperties": false, "properties": { "direction": { "description": "The sorting direction for the result data. Either `asc` for alphabetically ascending order or `desc` for alphabetically descending order.", "enum": [ "asc", "desc" ], "type": "string" }, "property": { "description": "The sorting property for the result data.", "type": "string" } }, "required": [ "property", "direction" ], "type": "object" }, "type": "array" }, "totalPageCount": { "description": "The total number of pages.", "type": "integer" }, "totalResultsCount": { "description": "The total number of records.", "type": "integer" } }, "required": [ "page", "pageSize", "sort", "totalResultsCount", "totalPageCount" ], "type": "object", "x-akamai": { "file-path": "schemas/page-metadata.yaml" } } }, "required": [ "metadata", "data" ], "type": "object", "x-akamai": { "file-path": "schemas/event-page-200.yaml" } } } }, "description": "List events." }, "400": { "content": { "application/problem+json": { "example": { "errors": [ { "detail": "Invalid value: 'someProperty', parameter: sort", "parameter": "sort", "title": "Bad Request", "type": "about:blank", "value": "someProperty" } ], "status": 400, "title": "Bad Request", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/event-ctr/reference/400). Invalid request. Details may be available in the response body.", "x-akamai": { "file-path": "errors/400.yaml" } } }, "summary": "List events", "tags": [ "Events" ] }, "x-akamai": { "file-path": "paths/events.yaml", "path-info": "/events" } }, "/events/{eventId}": { "get": { "description": "Returns details of the specified event.", "externalDocs": { "description": "See documentation for this operation in Akamai's Event Center API", "url": "https://techdocs.akamai.com/event-ctr/reference/get-event" }, "operationId": "get-event", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "audienceLocations": [ { "code": "PL", "name": "Poland" }, { "code": "DE", "name": "Germany" } ], "audienceSize": 5000000, "coordinators": [ { "firstName": "Vigilant", "lastName": "Snyder", "userName": "mrossi" }, { "firstName": "Taro", "lastName": "Yamada", "userName": "tyamada" } ], "createdBy": "jsmith", "createdDate": "2021-11-28T16:41:41Z", "customerEventId": "mmxxiii-owg", "description": "MMXXIII Olympic Winter Games 2022", "end": "2022-02-08T20:00:00Z", "id": 1, "modifiedBy": "hgildong", "modifiedDate": "2021-12-28T16:41:41Z", "name": "2022 Winter Olympics", "objects": [ { "id": 87654, "name": "olympics-open.com/winter" }, { "id": 12345, "name": "open-olympics.com/all" } ], "start": "2022-02-08T08:00:00Z", "tags": [ { "id": 1, "name": "winter" }, { "id": 2, "name": "olympics" } ], "version": 0 }, "schema": { "additionalProperties": false, "description": "Contains detailed information about the event, including tags and objects associated with this event.", "properties": { "audienceLocations": { "description": "Countries that match the geographic locations of audiences.", "items": { "additionalProperties": false, "description": "Provides information about a country that matches the geographic area of an audience.", "properties": { "code": { "description": "A two-letter ISO 3166 country code.", "type": "string" }, "name": { "description": "Name of the country that corresponds to the country code.", "type": "string" } }, "required": [ "code", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/country.yaml" } }, "type": "array" }, "audienceSize": { "description": "The audience's size for the event.", "type": "integer" }, "coordinators": { "description": "Coordinators assigned to the event.", "items": { "additionalProperties": false, "description": "Contains information about the event's coordinator.", "properties": { "firstName": { "description": "The coordinator's first name.", "type": "string" }, "lastName": { "description": "The coordinator's last name.", "type": "string" }, "userName": { "description": "The coordinator's username as defined in Control Center.", "type": "string" } }, "required": [ "userName", "firstName", "lastName" ], "type": "object", "x-akamai": { "file-path": "schemas/user.yaml" } }, "type": "array" }, "createdBy": { "description": "The person who created the event.", "type": "string" }, "createdDate": { "description": "An ISO 8601 timestamp indicating the date and time when the event was created.", "format": "date-time", "type": "string" }, "customerEventId": { "description": "The user-specified ID for the event. See [Customer Event ID](https://techdocs.akamai.com/event-ctr/docs/concepts).", "type": "string" }, "description": { "description": "The description of the event.", "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating the end date of the event.", "format": "date-time", "type": "string" }, "id": { "description": "The identifier of the event.", "type": "integer" }, "modifiedBy": { "description": "The person who last modified the event.", "type": "string" }, "modifiedDate": { "description": "An ISO 8601 timestamp indicating the date and time when the event was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "The name of the event.", "type": "string" }, "objects": { "description": "Objects associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a Content Provider (CP) code for the event.", "properties": { "id": { "description": "The identifier of the CP code.", "type": "integer" }, "name": { "description": "The name of the CP code.", "type": "string" } }, "required": [ "id", "name" ], "title": "CP code", "type": "object", "x-akamai": { "file-path": "schemas/cp-code.yaml" } }, "type": "array" }, "start": { "description": "An ISO 8601 timestamp indicating the start date of the event.", "format": "date-time", "type": "string" }, "tags": { "description": "Tags associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a tag.", "properties": { "id": { "description": "The identifier of the tag.", "type": "integer" }, "name": { "description": "The description of the tag.", "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/tag.yaml" } }, "type": "array" }, "version": { "description": "The version of the event.", "type": "integer" } }, "required": [ "id", "end", "name", "start", "version", "createdDate", "createdBy", "modifiedDate", "modifiedBy" ], "type": "object", "x-akamai": { "file-path": "schemas/event-200.yaml" } } } }, "description": "Get an event." }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions to access CpCode entity", "status": 403, "title": "Forbidden", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/event-ctr/reference/403). Insufficient permissions to access event or associated objects.", "x-akamai": { "file-path": "errors/403-cpcode.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Event entity with id 11 not found", "status": 404, "title": "Not Found", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/event-ctr/reference/404). The requested event wasn't found.", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Get an event", "tags": [ "Events" ] }, "put": { "description": "Updates the specified event.", "externalDocs": { "description": "See documentation for this operation in Akamai's Event Center API", "url": "https://techdocs.akamai.com/event-ctr/reference/put-event" }, "operationId": "put-event", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "audienceLocations": [ "PL", "DE" ], "audienceSize": 5000000, "coordinators": [ "vsnyder", "tyamada" ], "customerEventId": "mmxxiii-owg", "description": "MMXXIII Olympic Winter Games 2022", "end": "2022-02-08T20:00:00Z", "name": "2022 Winter Olympics", "objects": [ { "id": 87654 }, { "id": 12345 } ], "start": "2022-02-08T08:00:00Z", "tags": [ "winter", "olympics" ], "version": 0 }, "schema": { "additionalProperties": false, "description": "Contains information about the request body parameters that you can specify when updating an event. It also includes tags and objects that you can associate with an event.", "properties": { "audienceLocations": { "description": "Two-letter ISO 3166 country codes that indicate geographic areas of audiences. This array can contain up to 20 unique items.", "items": { "maxLength": 2, "minLength": 2, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true }, "audienceSize": { "description": "The audience's size for the event. The minimum value is 1.", "example": "{{audienceSize}}", "type": "integer", "x-annotation-oas-minimum": 1 }, "coordinators": { "description": "Up to 20 Control Center usernames of those who serve as the event's coordinators.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true }, "customerEventId": { "description": "The user-specified ID for the event. This ID can be up to 100 characters long. [Customer Event ID](https://techdocs.akamai.com/event-ctr/docs/concepts).", "example": "{{customerEventId}}", "type": "string" }, "description": { "description": "The description of the event. This description can be up to 2000 characters long.", "example": "{{description}}", "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating the end date of the event.", "example": "{{end}}", "format": "date-time", "type": "string" }, "name": { "description": "The name of the event. This name can be up to 750 characters long.", "example": "{{name}}", "maxLength": 750, "minLength": 1, "type": "string" }, "objects": { "description": "Objects associated with the event. This array can include only unique items.", "items": { "additionalProperties": false, "description": "Contains information about the CP codes that you can associate with the event.", "properties": { "id": { "description": "The identifier of the CP code associated with the event.", "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/event-object-assign.yaml" } }, "type": "array", "uniqueItems": true }, "start": { "description": "An ISO 8601 timestamp indicating the start date of the event.", "example": "{{start}}", "format": "date-time", "type": "string" }, "tags": { "description": "Tags for the event. Each tag can be up to 100 characters long. This array can contain up to 20 unique items.", "items": { "maxLength": 100, "minLength": 1, "type": "string" }, "maxItems": 20, "type": "array", "uniqueItems": true }, "version": { "description": "The version of the event. Use the `version` of the event sent in the original server's response. See [Event Version](https://techdocs.akamai.com/event-ctr/docs/concepts).", "example": "{{version}}", "type": "integer" } }, "required": [ "name", "start", "end", "version" ], "type": "object", "x-akamai": { "file-path": "schemas/event-put.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "audienceLocations": [ { "code": "PL", "name": "Poland" }, { "code": "DE", "name": "Germany" } ], "audienceSize": 5000000, "coordinators": [ { "firstName": "Vigilant", "lastName": "Snyder", "userName": "mrossi" }, { "firstName": "Taro", "lastName": "Yamada", "userName": "tyamada" } ], "createdBy": "jsmith", "createdDate": "2021-11-28T16:41:41Z", "customerEventId": "mmxxiii-owg", "description": "MMXXIII Olympic Winter Games 2022", "end": "2022-02-08T20:00:00Z", "id": 1, "modifiedBy": "hgildong", "modifiedDate": "2021-12-28T16:41:41Z", "name": "2022 Winter Olympics", "objects": [ { "id": 87654, "name": "olympics-open.com/winter" }, { "id": 12345, "name": "open-olympics.com/all" } ], "start": "2022-02-08T08:00:00Z", "tags": [ { "id": 1, "name": "winter" }, { "id": 2, "name": "olympics" } ], "version": 0 }, "schema": { "additionalProperties": false, "description": "Contains detailed information about the event, including tags and objects associated with this event.", "properties": { "audienceLocations": { "description": "Countries that match the geographic locations of audiences.", "items": { "additionalProperties": false, "description": "Provides information about a country that matches the geographic area of an audience.", "properties": { "code": { "description": "A two-letter ISO 3166 country code.", "type": "string" }, "name": { "description": "Name of the country that corresponds to the country code.", "type": "string" } }, "required": [ "code", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/country.yaml" } }, "type": "array" }, "audienceSize": { "description": "The audience's size for the event.", "type": "integer" }, "coordinators": { "description": "Coordinators assigned to the event.", "items": { "additionalProperties": false, "description": "Contains information about the event's coordinator.", "properties": { "firstName": { "description": "The coordinator's first name.", "type": "string" }, "lastName": { "description": "The coordinator's last name.", "type": "string" }, "userName": { "description": "The coordinator's username as defined in Control Center.", "type": "string" } }, "required": [ "userName", "firstName", "lastName" ], "type": "object", "x-akamai": { "file-path": "schemas/user.yaml" } }, "type": "array" }, "createdBy": { "description": "The person who created the event.", "type": "string" }, "createdDate": { "description": "An ISO 8601 timestamp indicating the date and time when the event was created.", "format": "date-time", "type": "string" }, "customerEventId": { "description": "The user-specified ID for the event. See [Customer Event ID](https://techdocs.akamai.com/event-ctr/docs/concepts).", "type": "string" }, "description": { "description": "The description of the event.", "type": "string" }, "end": { "description": "An ISO 8601 timestamp indicating the end date of the event.", "format": "date-time", "type": "string" }, "id": { "description": "The identifier of the event.", "type": "integer" }, "modifiedBy": { "description": "The person who last modified the event.", "type": "string" }, "modifiedDate": { "description": "An ISO 8601 timestamp indicating the date and time when the event was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "The name of the event.", "type": "string" }, "objects": { "description": "Objects associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a Content Provider (CP) code for the event.", "properties": { "id": { "description": "The identifier of the CP code.", "type": "integer" }, "name": { "description": "The name of the CP code.", "type": "string" } }, "required": [ "id", "name" ], "title": "CP code", "type": "object", "x-akamai": { "file-path": "schemas/cp-code.yaml" } }, "type": "array" }, "start": { "description": "An ISO 8601 timestamp indicating the start date of the event.", "format": "date-time", "type": "string" }, "tags": { "description": "Tags associated with the event.", "items": { "additionalProperties": false, "description": "Contains information about a tag.", "properties": { "id": { "description": "The identifier of the tag.", "type": "integer" }, "name": { "description": "The description of the tag.", "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/tag.yaml" } }, "type": "array" }, "version": { "description": "The version of the event.", "type": "integer" } }, "required": [ "id", "end", "name", "start", "version", "createdDate", "createdBy", "modifiedDate", "modifiedBy" ], "type": "object", "x-akamai": { "file-path": "schemas/event-200.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "errors": [ { "detail": "end must not be null", "path": "end", "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation", "value": null }, { "detail": "start must not be null", "path": "start", "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation", "value": null }, { "detail": "name must not be blank", "path": "name", "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation", "value": null } ], "status": 400, "title": "Constraint violation", "type": "/event-center/error-types/constraint-violation" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/event-ctr/reference/400). Invalid request. Details may be available in the response body.", "x-akamai": { "file-path": "errors/400-constraint.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions to modify Event entity", "status": 403, "title": "Forbidden", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/event-ctr/reference/403). Insufficient permissions to access event or associated objects.", "x-akamai": { "file-path": "errors/403-event.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Event entity with id 11 not found", "status": 404, "title": "Not Found", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/event-ctr/reference/404). The requested event wasn't found.", "x-akamai": { "file-path": "errors/404.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "Version mismatch for Event entity, expected version: 0, but got: 1", "status": 409, "title": "Concurrent modification", "type": "/event-center/error-types/concurrent-modification" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/event-ctr/reference/409). The event was modified after you retrieved it. Please refetch the event, reconcile possible differences and resubmit the request.", "x-akamai": { "file-path": "errors/409-concurrency.yaml" } } }, "summary": "Update an event", "tags": [ "Events" ] }, "delete": { "description": "Deletes the specified event.", "externalDocs": { "description": "See documentation for this operation in Akamai's Event Center API", "url": "https://techdocs.akamai.com/event-ctr/reference/delete-event" }, "operationId": "delete-event", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Event was removed successfully." }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions to modify Event entity", "status": 403, "title": "Forbidden", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/event-ctr/reference/403). Insufficient permissions to access event or associated objects.", "x-akamai": { "file-path": "errors/403-event.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Event entity with id 11 not found", "status": 404, "title": "Not Found", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/event-ctr/reference/404). The requested event wasn't found.", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Remove an event", "tags": [ "Events" ] }, "parameters": [ { "description": "The identifier of the event.", "example": "{{eventId}}", "in": "path", "name": "eventId", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/event-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/event.yaml", "path-info": "/events/{eventId}" } }, "/tags": { "get": { "description": "Returns a list of all event tags for the current account and contract type. This call supports paging and sorting of the result data.", "externalDocs": { "description": "See documentation for this operation in Akamai's Event Center API", "url": "https://techdocs.akamai.com/event-ctr/reference/get-tags" }, "operationId": "get-tags", "parameters": [ { "description": "The number of the page. Page numbers start at 1.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-query.yaml" } }, { "description": "The number of records on a page. By default, a page has 25 records. The maximum value is 1000 records on a page.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "maximum": 1000, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-size-query.yaml" } }, { "description": "The sorting property and the sorting direction for the result data. Use `name` to sort by name. Use `asc` for alphabetically ascending order or `desc` for alphabetically descending order.", "example": "{{sort}}", "in": "query", "name": "sort", "schema": { "example": "name,asc", "type": "string" }, "x-akamai": { "file-path": "parameters/sort-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "id": 1, "name": "Tag 1" }, { "id": 2, "name": "Tag 2" } ], "metadata": { "page": 1, "pageSize": 25, "sort": [ { "direction": "asc", "property": "name" } ], "totalPageCount": 1, "totalResultsCount": 2 } }, "schema": { "additionalProperties": false, "description": "Contains a list of tags for the current account and contract type. It also provides context about the requested data based on the request's parameters.", "properties": { "data": { "description": "Tags for the current account and contract type.", "items": { "additionalProperties": false, "description": "Contains information about a tag.", "properties": { "id": { "description": "The identifier of the tag.", "type": "integer" }, "name": { "description": "The description of the tag.", "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/tag.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": true, "description": "Collects context about the requested data based on the request's parameters.", "properties": { "page": { "description": "The number of the page.", "type": "integer" }, "pageSize": { "description": "The number of records per page.", "type": "integer" }, "sort": { "description": "The sorting property and the sorting direction for the result data.", "items": { "additionalProperties": false, "properties": { "direction": { "description": "The sorting direction for the result data. Either `asc` for alphabetically ascending order or `desc` for alphabetically descending order.", "enum": [ "asc", "desc" ], "type": "string" }, "property": { "description": "The sorting property for the result data.", "type": "string" } }, "required": [ "property", "direction" ], "type": "object" }, "type": "array" }, "totalPageCount": { "description": "The total number of pages.", "type": "integer" }, "totalResultsCount": { "description": "The total number of records.", "type": "integer" } }, "required": [ "page", "pageSize", "sort", "totalResultsCount", "totalPageCount" ], "type": "object", "x-akamai": { "file-path": "schemas/page-metadata.yaml" } } }, "required": [ "metadata", "data" ], "type": "object", "x-akamai": { "file-path": "schemas/tag-page-200.yaml" } } } }, "description": "Successful operation." }, "400": { "content": { "application/problem+json": { "example": { "errors": [ { "detail": "Invalid value: 'someProperty', parameter: sort", "parameter": "sort", "title": "Bad Request", "type": "about:blank", "value": "someProperty" } ], "status": 400, "title": "Bad Request", "type": "about:blank" }, "schema": { "additionalProperties": true, "description": "Provides information about an error response.", "properties": { "problem": { "additionalProperties": true, "description": "The problem indicated by the error response.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "type": "string" }, "errors": { "description": "HTTP problem details. This field exists if there's more than one problem with a single request, and you want to consider each.", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "format": "uri", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/event-ctr/reference/400). Invalid request. Details may be available in the response body.", "x-akamai": { "file-path": "errors/400.yaml" } } }, "summary": "List tags", "tags": [ "Tags" ] }, "x-akamai": { "file-path": "paths/tags.yaml", "path-info": "/tags" } } }, "servers": [ { "url": "https://{hostname}/events/v3" } ], "tags": [], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }