Get early access

Assignment rules

Assignment rules: 5 operations of the ChaosDesk REST API.

Retrieves the collection of AssignmentRule resources.

GET/api/assignment_rules

Responses

  • 200AssignmentRule collection
  • 403Forbidden

Example request

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

Creates a AssignmentRule resource.

POST/api/assignment_rules

Request body application/json

conditionsobject
agentsstring (iri-reference)[]
viewsView[]
Views these agents may play; empty = every view they can see.
max_open_ticketsinteger | null
Capacity: open (new + open) tickets an agent may hold; null = unlimited.
auto_assignboolean
Assign new, unassigned matching tickets automatically.
strategy"round_robin" | "least_loaded"
only_onlineboolean
Auto-assign only to agents whose status is "online".
titlestringrequired
descriptionstring | null
activeboolean
positioninteger

Responses

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

Example request

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

Retrieves a AssignmentRule resource.

GET/api/assignment_rules/{id}

Parameters

idstringpathrequired
AssignmentRule identifier

Responses

  • 200AssignmentRule resource
  • 403Forbidden
  • 404Not found

Example request

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

Updates the AssignmentRule resource.

PATCH/api/assignment_rules/{id}

Parameters

idstringpathrequired
AssignmentRule identifier

Request body application/merge-patch+json

conditionsobject
agentsstring (iri-reference)[]
viewsView[]
Views these agents may play; empty = every view they can see.
max_open_ticketsinteger | null
Capacity: open (new + open) tickets an agent may hold; null = unlimited.
auto_assignboolean
Assign new, unassigned matching tickets automatically.
strategy"round_robin" | "least_loaded"
only_onlineboolean
Auto-assign only to agents whose status is "online".
titlestring
descriptionstring | null
activeboolean
positioninteger

Responses

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

Example request

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

Removes the AssignmentRule resource.

DELETE/api/assignment_rules/{id}

Parameters

idstringpathrequired
AssignmentRule identifier

Responses

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

Example request

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