Skip to main content

Get Request Schema And Example By Ticket Code

Request

Retrieves the request payload schema and a sample request for the specified ticket code. The response defines the fields, required values, data types, and validation constraints applicable to creating a case with the selected ticket code.

The available fields, required fields, validation rules, and example values may vary depending on the ticket code. The sample request is illustrative and intended as a reference; it may differ for other ticket codes.

Security
BearerAuth
Path
codestringrequired

The ticket code to retrieve the request payload schema and sample request payload. See GET /support/v2/tickets/codes for the list of available ticket codes.

Example:0000-0000
Payload
// No request payload

Responses

OK

Bodyapplication/json
codestringrequired

Ticket code, e.g. "0000-0000".

Example:"0000-0000"
schemaobjectrequired

Provides the request payload schema for the ticket code, including available fields, required flags, and any applicable constraints. The fields and their requirements vary by ticket code. The returned value is the source of truth.

exampleobjectrequired

Illustrative sample request payload for the ticket code. The fields and values vary by ticket code and are provided as a guide only.

Response
{ "code": "0000-0000", "schema": { "code": { … }, "description": { … }, "attachments": { … }, "customerReferenceId": { … }, "primaryId": { … }, "occurredDateTime": { … }, "callMeFromCage": { … }, "details": { … }, "contacts": { … } }, "example": { "code": "0000-0000", "description": "The equipment in cabinet 0101 is intermittently disconnecting and affecting service availability.", "attachments": [ … ], "customerReferenceId": "PO-123456789", "primaryId": "4-123456789", "occurredDateTime": "2026-08-17T07:23:00Z", "callMeFromCage": true, "details": { … }, "contacts": [ … ] } }
Was this page helpful?