Get early access

Ticket layouts

Ticket layouts: 5 operations of the ChaosDesk REST API.

Retrieves the collection of TicketLayout resources.

GET/api/ticket_layouts

Responses

  • 200TicketLayout collection
  • 403Forbidden

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/ticket_layouts" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Creates a TicketLayout resource.

POST/api/ticket_layouts

Request body application/json

namestringrequired
descriptionstring | null
definitionobject[]
see App\Layout\LayoutDefinition
defaultboolean
ticket_formsstring (iri-reference)[]
workspacesstring (iri-reference)[]

Responses

  • 201TicketLayout resource created
  • 400Invalid input
  • 403Forbidden
  • 422An error occurred

Example request

curl -X POST "https://yourcompany.chaosdesk.io/api/ticket_layouts" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

Retrieves a TicketLayout resource.

GET/api/ticket_layouts/{id}

Parameters

idstringpathrequired
TicketLayout identifier

Responses

  • 200TicketLayout resource
  • 403Forbidden
  • 404Not found

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/ticket_layouts/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Updates the TicketLayout resource.

PATCH/api/ticket_layouts/{id}

Parameters

idstringpathrequired
TicketLayout identifier

Request body application/merge-patch+json

namestring
descriptionstring | null
definitionobject[]
see App\Layout\LayoutDefinition
defaultboolean
ticket_formsstring (iri-reference)[]
workspacesstring (iri-reference)[]

Responses

  • 200TicketLayout resource updated
  • 400Invalid input
  • 403Forbidden
  • 404Not found
  • 422An error occurred

Example request

curl -X PATCH "https://yourcompany.chaosdesk.io/api/ticket_layouts/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{"name":"string","description":"string"}'

Removes the TicketLayout resource.

DELETE/api/ticket_layouts/{id}

Parameters

idstringpathrequired
TicketLayout identifier

Responses

  • 204TicketLayout resource deleted
  • 403Forbidden
  • 404Not found

Example request

curl -X DELETE "https://yourcompany.chaosdesk.io/api/ticket_layouts/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"