API Reference

Service Desk API

Versus Service Desk — incidents, changes, problems, requests, the service catalog, and CMDB import. Auto-generated from the platform OpenAPI schema so it matches the running API.

REST API for this feature — 176 operations across 94 resource paths, auto-generated from the platform's live OpenAPI schema (drf-spectacular).

Base URL https://<your-versus-host>/api · Auth Authorization: Bearer <JWT> (from POST /api/auth/token/) · 📄 Download the OpenAPI spec for Postman/Insomnia/Swagger · see the API overview for pagination, filtering, and errors.

Approval rules

GET /api/itsm/approval-rules/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedApprovalRuleList

POST /api/itsm/approval-rules/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): ApprovalRuleRequest

Responses: 201 → ApprovalRule

GET /api/itsm/approval-rules/preview/

Which rule would apply to a change with this change_type and

Responses: 200 → ApprovalRule

GET /api/itsm/approval-rules/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this approval rule.

Responses: 200 → ApprovalRule

PUT /api/itsm/approval-rules/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this approval rule.

Request body (application/json): ApprovalRuleRequest

Responses: 200 → ApprovalRule

PATCH /api/itsm/approval-rules/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this approval rule.

Request body (application/json): PatchedApprovalRuleRequest

Responses: 200 → ApprovalRule

DELETE /api/itsm/approval-rules/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this approval rule.

Responses: 204


Assignment groups

GET /api/itsm/assignment-groups/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedAssignmentGroupList

POST /api/itsm/assignment-groups/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): AssignmentGroupRequest

Responses: 201 → AssignmentGroup

GET /api/itsm/assignment-groups/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this assignment group.

Responses: 200 → AssignmentGroup

PUT /api/itsm/assignment-groups/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this assignment group.

Request body (application/json): AssignmentGroupRequest

Responses: 200 → AssignmentGroup

PATCH /api/itsm/assignment-groups/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this assignment group.

Request body (application/json): PatchedAssignmentGroupRequest

Responses: 200 → AssignmentGroup

DELETE /api/itsm/assignment-groups/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this assignment group.

Responses: 204

POST /api/itsm/assignment-groups/{id}/members/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this assignment group.

Request body (application/json): AssignmentGroupRequest

Responses: 200 → AssignmentGroup

DELETE /api/itsm/assignment-groups/{id}/members/{user_id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this assignment group.
user_idpathyesstring

Responses: 204

GET /api/itsm/assignment-groups/{id}/users/

The users who belong to this assignment group — feeds the

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this assignment group.

Responses: 200 → AssignmentGroup


Audit

GET /api/itsm/audit/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
event_typequerynostring
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.
ticketquerynostring

Responses: 200 → PaginatedItsmAuditEventList

GET /api/itsm/audit/verify/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Responses: 200 → ItsmAuditEvent

GET /api/itsm/audit/{seq}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
seqpathyesintegerA unique integer value identifying this itsm audit event.

Responses: 200 → ItsmAuditEvent


Blackout windows

GET /api/itsm/blackout-windows/

Enhancement spec §4 — blackout/freeze windows. Managing when

ParameterInRequiredTypeDescription
activequerynoboolean
kindquerynostring* blackout - Blackout
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedBlackoutWindowList

POST /api/itsm/blackout-windows/

Enhancement spec §4 — blackout/freeze windows. Managing when

Request body (application/json): BlackoutWindowRequest

Responses: 201 → BlackoutWindow

GET /api/itsm/blackout-windows/{id}/

Enhancement spec §4 — blackout/freeze windows. Managing when

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this blackout window.

Responses: 200 → BlackoutWindow

PUT /api/itsm/blackout-windows/{id}/

Enhancement spec §4 — blackout/freeze windows. Managing when

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this blackout window.

Request body (application/json): BlackoutWindowRequest

Responses: 200 → BlackoutWindow

PATCH /api/itsm/blackout-windows/{id}/

Enhancement spec §4 — blackout/freeze windows. Managing when

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this blackout window.

Request body (application/json): PatchedBlackoutWindowRequest

Responses: 200 → BlackoutWindow

DELETE /api/itsm/blackout-windows/{id}/

Enhancement spec §4 — blackout/freeze windows. Managing when

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this blackout window.

Responses: 204


Cab

GET /api/itsm/cab/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedCabMeetingList

POST /api/itsm/cab/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): CabMeetingRequest

Responses: 201 → CabMeeting

GET /api/itsm/cab/pending-changes/

Recent changes offered as CAB agenda candidates, flagging the ones

Responses: 200 → CabMeeting

GET /api/itsm/cab/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this cab meeting.

Responses: 200 → CabMeeting

PUT /api/itsm/cab/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this cab meeting.

Request body (application/json): CabMeetingRequest

Responses: 200 → CabMeeting

PATCH /api/itsm/cab/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this cab meeting.

Request body (application/json): PatchedCabMeetingRequest

Responses: 200 → CabMeeting

DELETE /api/itsm/cab/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this cab meeting.

Responses: 204


Calendars

GET /api/itsm/calendars/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedBusinessCalendarList

POST /api/itsm/calendars/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): BusinessCalendarRequest

Responses: 201 → BusinessCalendar

GET /api/itsm/calendars/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this business calendar.

Responses: 200 → BusinessCalendar

PUT /api/itsm/calendars/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this business calendar.

Request body (application/json): BusinessCalendarRequest

Responses: 200 → BusinessCalendar

PATCH /api/itsm/calendars/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this business calendar.

Request body (application/json): PatchedBusinessCalendarRequest

Responses: 200 → BusinessCalendar

DELETE /api/itsm/calendars/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this business calendar.

Responses: 204


Catalog

GET /api/catalog/request-types/

List request types

Responses: 200

GET /api/catalog/request-types/{key}/

Retrieve request type

ParameterInRequiredTypeDescription
keypathyesstring

Responses: 200

GET /api/itsm/catalog/categories/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedCatalogCategoryList

POST /api/itsm/catalog/categories/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): CatalogCategoryRequest

Responses: 201 → CatalogCategory

GET /api/itsm/catalog/categories/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this catalog category.

Responses: 200 → CatalogCategory

PUT /api/itsm/catalog/categories/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this catalog category.

Request body (application/json): CatalogCategoryRequest

Responses: 200 → CatalogCategory

PATCH /api/itsm/catalog/categories/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this catalog category.

Request body (application/json): PatchedCatalogCategoryRequest

Responses: 200 → CatalogCategory

DELETE /api/itsm/catalog/categories/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this catalog category.

Responses: 204

GET /api/itsm/catalog/items/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedCatalogItemList

POST /api/itsm/catalog/items/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): CatalogItemRequest

Responses: 201 → CatalogItem

GET /api/itsm/catalog/items/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this catalog item.

Responses: 200 → CatalogItem

PUT /api/itsm/catalog/items/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this catalog item.

Request body (application/json): CatalogItemRequest

Responses: 200 → CatalogItem

PATCH /api/itsm/catalog/items/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this catalog item.

Request body (application/json): PatchedCatalogItemRequest

Responses: 200 → CatalogItem

DELETE /api/itsm/catalog/items/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this catalog item.

Responses: 204

POST /api/itsm/catalog/items/{id}/requests/

Spec §6: turns a submitted App Builder catalog form into a Versus Desk

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this catalog item.

Request body (application/json): CatalogItemRequest

Responses: 200 → CatalogItem


Catalog actions

GET /api/catalog-actions/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedCatalogActionList

POST /api/catalog-actions/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): CatalogActionRequest

Responses: 201 → CatalogAction

GET /api/catalog-actions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this catalog action.

Responses: 200 → CatalogAction

PUT /api/catalog-actions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this catalog action.

Request body (application/json): CatalogActionRequest

Responses: 200 → CatalogAction

PATCH /api/catalog-actions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this catalog action.

Request body (application/json): PatchedCatalogActionRequest

Responses: 200 → CatalogAction

DELETE /api/catalog-actions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this catalog action.

Responses: 204

POST /api/catalog-actions/{id}/execute/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this catalog action.

Request body (application/json): CatalogActionRequest

Responses: 200 → CatalogAction


Change gates

GET /api/itsm/change-gates/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedChangeGateBindingList

POST /api/itsm/change-gates/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): ChangeGateBindingRequest

Responses: 201 → ChangeGateBinding

GET /api/itsm/change-gates/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this change gate binding.

Responses: 200 → ChangeGateBinding

PUT /api/itsm/change-gates/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this change gate binding.

Request body (application/json): ChangeGateBindingRequest

Responses: 200 → ChangeGateBinding

PATCH /api/itsm/change-gates/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this change gate binding.

Request body (application/json): PatchedChangeGateBindingRequest

Responses: 200 → ChangeGateBinding

DELETE /api/itsm/change-gates/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this change gate binding.

Responses: 204


Change tasks

GET /api/itsm/change-tasks/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.
statequerynostring* open - Open
ticketquerynostring

Responses: 200 → PaginatedChangeTaskList

POST /api/itsm/change-tasks/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): ChangeTaskRequest

Responses: 201 → ChangeTask

GET /api/itsm/change-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this change task.

Responses: 200 → ChangeTask

PUT /api/itsm/change-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this change task.

Request body (application/json): ChangeTaskRequest

Responses: 200 → ChangeTask

PATCH /api/itsm/change-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this change task.

Request body (application/json): PatchedChangeTaskRequest

Responses: 200 → ChangeTask

DELETE /api/itsm/change-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this change task.

Responses: 204


Changes

POST /api/itsm/changes/{number}/approvals/{stage}/decision/

Spec §11: POST /itsm/changes/{number}/approvals/{stage}/decision

ParameterInRequiredTypeDescription
numberpathyesstring
stagepathyesstring

Responses: 200


Ci options

GET /api/itsm/ci-options/

Dropdown options for the "Configuration Items" picker on the Versus

Responses: 200


Cmdb import jobs

GET /api/cmdb-import-jobs/

List cmdb import jobs

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedCmdbImportJobList

GET /api/cmdb-import-jobs/{id}/

Retrieve cmdb import job

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cmdb import job.

Responses: 200 → CmdbImportJob

POST /api/cmdb-import-jobs/{id}/commit/

Apply the reviewed decisions: create/merge ManagedDevice rows for

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cmdb import job.

Request body (application/json): CmdbImportJobRequest

Responses: 200 → CmdbImportJob


Companies

GET /api/itsm/companies/

Enhancement spec §1.2 — MSP-style client scoping for changes.

ParameterInRequiredTypeDescription
kindquerynostring* self - Self
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedCompanyList

POST /api/itsm/companies/

Enhancement spec §1.2 — MSP-style client scoping for changes.

Request body (application/json): CompanyRequest

Responses: 201 → Company

GET /api/itsm/companies/{id}/

Enhancement spec §1.2 — MSP-style client scoping for changes.

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this company.

Responses: 200 → Company

PUT /api/itsm/companies/{id}/

Enhancement spec §1.2 — MSP-style client scoping for changes.

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this company.

Request body (application/json): CompanyRequest

Responses: 200 → Company

PATCH /api/itsm/companies/{id}/

Enhancement spec §1.2 — MSP-style client scoping for changes.

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this company.

Request body (application/json): PatchedCompanyRequest

Responses: 200 → Company

DELETE /api/itsm/companies/{id}/

Enhancement spec §1.2 — MSP-style client scoping for changes.

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this company.

Responses: 204


Conflicts

GET /api/itsm/conflicts/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
conflict_typequerynostring* window_overlap - Window Overlap
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.
severityquerynostring* warning - Warning
statusquerynostring* open - Open
ticketquerynostring

Responses: 200 → PaginatedChangeConflictList

GET /api/itsm/conflicts/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this change conflict.

Responses: 200 → ChangeConflict

POST /api/itsm/conflicts/{id}/override/

RBAC-gated conflict override with a required, audited reason

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this change conflict.

Responses: 200 → ChangeConflict


Csat

PATCH /api/itsm/csat/{token}/

Token-based public respond endpoint — no auth, matched by an

ParameterInRequiredTypeDescription
tokenpathyesstring

Responses: 200


Imported cis

GET /api/imported-cis/

List imported cis

ParameterInRequiredTypeDescription
decisionquerynostring* pending - Pending
jobquerynointeger
orderingquerynostringWhich field to use when ordering the results.
searchquerynostringA search term.

Responses: 200 → ImportedCI[]

POST /api/imported-cis/bulk_decision/

Create bulk decision

Request body (application/json): ImportedCIRequest

Responses: 200 → ImportedCI

GET /api/imported-cis/{id}/

Retrieve imported ci

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this imported ci.

Responses: 200 → ImportedCI

POST /api/imported-cis/{id}/set_decision/

Set decision: imported ci

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this imported ci.

Request body (application/json): ImportedCIRequest

Responses: 200 → ImportedCI


Kb

GET /api/itsm/kb/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedKbArticleList

POST /api/itsm/kb/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): KbArticleRequest

Responses: 201 → KbArticle

GET /api/itsm/kb/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this kb article.

Responses: 200 → KbArticle

PUT /api/itsm/kb/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this kb article.

Request body (application/json): KbArticleRequest

Responses: 200 → KbArticle

PATCH /api/itsm/kb/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this kb article.

Request body (application/json): PatchedKbArticleRequest

Responses: 200 → KbArticle

DELETE /api/itsm/kb/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this kb article.

Responses: 204

POST /api/itsm/kb/{id}/feedback/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this kb article.

Request body (application/json): KbArticleRequest

Responses: 200 → KbArticle

POST /api/itsm/kb/{id}/publish/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this kb article.

Request body (application/json): KbArticleRequest

Responses: 200 → KbArticle


Parity matrix

GET /api/itsm/parity-matrix/

ServiceNow → Versus field-parity coverage matrix (parity spec §8) — the

Responses: 200


Problem tasks

GET /api/itsm/problem-tasks/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.
statequerynostring* open - Open
ticketquerynostring

Responses: 200 → PaginatedProblemTaskList

POST /api/itsm/problem-tasks/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): ProblemTaskRequest

Responses: 201 → ProblemTask

GET /api/itsm/problem-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this problem task.

Responses: 200 → ProblemTask

PUT /api/itsm/problem-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this problem task.

Request body (application/json): ProblemTaskRequest

Responses: 200 → ProblemTask

PATCH /api/itsm/problem-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this problem task.

Request body (application/json): PatchedProblemTaskRequest

Responses: 200 → ProblemTask

DELETE /api/itsm/problem-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this problem task.

Responses: 204


Request tasks

GET /api/itsm/request-tasks/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.
statequerynostring* open - Open
ticketquerynostring

Responses: 200 → PaginatedRequestTaskList

POST /api/itsm/request-tasks/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): RequestTaskRequest

Responses: 201 → RequestTask

GET /api/itsm/request-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this request task.

Responses: 200 → RequestTask

PUT /api/itsm/request-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this request task.

Request body (application/json): RequestTaskRequest

Responses: 200 → RequestTask

PATCH /api/itsm/request-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this request task.

Request body (application/json): PatchedRequestTaskRequest

Responses: 200 → RequestTask

DELETE /api/itsm/request-tasks/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this request task.

Responses: 204


Sla definitions

GET /api/itsm/sla-definitions/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedSlaDefinitionList

POST /api/itsm/sla-definitions/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): SlaDefinitionRequest

Responses: 201 → SlaDefinition

GET /api/itsm/sla-definitions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this sla definition.

Responses: 200 → SlaDefinition

PUT /api/itsm/sla-definitions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this sla definition.

Request body (application/json): SlaDefinitionRequest

Responses: 200 → SlaDefinition

PATCH /api/itsm/sla-definitions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this sla definition.

Request body (application/json): PatchedSlaDefinitionRequest

Responses: 200 → SlaDefinition

DELETE /api/itsm/sla-definitions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this sla definition.

Responses: 204


Snow migration

GET /api/itsm/snow-migration/

Read-only view of the SN→Versus import audit / reconciliation report.

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.
sn_tablequerynostring
statusquerynostring* imported - Imported

Responses: 200 → PaginatedSnowMigrationMapList

GET /api/itsm/snow-migration/{id}/

Read-only view of the SN→Versus import audit / reconciliation report.

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this snow migration map.

Responses: 200 → SnowMigrationMap


Standard templates

GET /api/itsm/standard-templates/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedStandardChangeTemplateList

POST /api/itsm/standard-templates/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): StandardChangeTemplateRequest

Responses: 201 → StandardChangeTemplate

GET /api/itsm/standard-templates/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this standard change template.

Responses: 200 → StandardChangeTemplate

PUT /api/itsm/standard-templates/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this standard change template.

Request body (application/json): StandardChangeTemplateRequest

Responses: 200 → StandardChangeTemplate

PATCH /api/itsm/standard-templates/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this standard change template.

Request body (application/json): PatchedStandardChangeTemplateRequest

Responses: 200 → StandardChangeTemplate

DELETE /api/itsm/standard-templates/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this standard change template.

Responses: 204

POST /api/itsm/standard-templates/{id}/approve/

Promoting a normal->standard template requires a distinct

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this standard change template.

Request body (application/json): StandardChangeTemplateRequest

Responses: 200 → StandardChangeTemplate


Submissions

GET /api/submissions/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedSubmissionList

POST /api/submissions/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): SubmissionRequest

Responses: 201 → Submission

GET /api/submissions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this submission.

Responses: 200 → Submission

PUT /api/submissions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this submission.

Request body (application/json): SubmissionRequest

Responses: 200 → Submission

PATCH /api/submissions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this submission.

Request body (application/json): PatchedSubmissionRequest

Responses: 200 → Submission

DELETE /api/submissions/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this submission.

Responses: 204

POST /api/submissions/{id}/advance/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this submission.

Request body (application/json): SubmissionRequest

Responses: 200 → Submission

POST /api/submissions/{id}/cancel/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this submission.

Request body (application/json): SubmissionRequest

Responses: 200 → Submission

GET /api/submissions/{id}/events/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this submission.

Responses: 200 → Submission

GET /api/submissions/{id}/tracker/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this submission.

Responses: 200 → Submission


Tickets

GET /api/itsm/tickets/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
assigneequerynointeger
assignment_groupquerynointeger
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
priorityquerynointeger
searchquerynostringA search term.
statequerynostring
ticket_typequerynostring* incident - Incident

Responses: 200 → PaginatedTicketListList

POST /api/itsm/tickets/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): TicketListRequest

Responses: 201 → TicketList

GET /api/itsm/tickets/change-plan-from-workflow/

Derive a Change's opening Basic-Info + Planning fields from a workflow

Responses: 200 → TicketList

POST /api/itsm/tickets/suggest-change/

AI-draft a full change (description, plans, tasks, type, risk) from a

Request body (application/json): TicketListRequest

Responses: 200 → TicketList

GET /api/itsm/tickets/{number}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Responses: 200 → TicketDetail

PATCH /api/itsm/tickets/{number}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): PatchedTicketListRequest

Responses: 200 → TicketList

POST /api/itsm/tickets/{number}/alert-check/

The reference form's "Alert Check" button — on-demand conflict

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): TicketListRequest

Responses: 200 → TicketList

GET /api/itsm/tickets/{number}/approval-email-log/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Responses: 200 → TicketList

PATCH /api/itsm/tickets/{number}/change-ext/

Edits the change's extension fields (header + Planning/Client

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): PatchedTicketListRequest

Responses: 200 → TicketList

GET /api/itsm/tickets/{number}/ci-links-rich/

Affected CIs with inventory columns (spec §6.1) — CiLink joined

ParameterInRequiredTypeDescription
numberpathyesstring

Responses: 200 → TicketList

POST /api/itsm/tickets/{number}/ci-links/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): TicketListRequest

Responses: 200 → TicketList

POST /api/itsm/tickets/{number}/comments/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): TicketListRequest

Responses: 200 → TicketList

GET /api/itsm/tickets/{number}/conflicts/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Responses: 200 → TicketList

GET /api/itsm/tickets/{number}/impacted-cis/

Topology-computed Impacted Services/CIs (spec §6.2) — cached;

ParameterInRequiredTypeDescription
numberpathyesstring

Responses: 200 → TicketList

GET /api/itsm/tickets/{number}/kb-links/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Responses: 200 → TicketList

POST /api/itsm/tickets/{number}/kb-links/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): TicketListRequest

Responses: 200 → TicketList

POST /api/itsm/tickets/{number}/links/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): TicketListRequest

Responses: 200 → TicketList

GET /api/itsm/tickets/{number}/outages/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Responses: 200 → TicketList

POST /api/itsm/tickets/{number}/outages/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): TicketListRequest

Responses: 200 → TicketList

POST /api/itsm/tickets/{number}/override-risk/

Spec §4.3: risk is machine-computed but human-overridable, with

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): TicketListRequest

Responses: 200 → TicketList

GET /api/itsm/tickets/{number}/predictions/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Responses: 200 → TicketList

GET /api/itsm/tickets/{number}/sla/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Responses: 200 → TicketList

GET /api/itsm/tickets/{number}/special-notes/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Responses: 200 → TicketList

POST /api/itsm/tickets/{number}/special-notes/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): TicketListRequest

Responses: 200 → TicketList

GET /api/itsm/tickets/{number}/time-entries/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Responses: 200 → TicketList

POST /api/itsm/tickets/{number}/time-entries/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): TicketListRequest

Responses: 200 → TicketList

POST /api/itsm/tickets/{number}/transition/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
numberpathyesstring

Request body (application/json): TicketListRequest

Responses: 200 → TicketList


Watchers

GET /api/itsm/watchers/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.
ticketquerynostring
userquerynointeger

Responses: 200 → PaginatedTicketWatcherList

POST /api/itsm/watchers/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): TicketWatcherRequest

Responses: 201 → TicketWatcher

GET /api/itsm/watchers/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this ticket watcher.

Responses: 200 → TicketWatcher

PUT /api/itsm/watchers/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this ticket watcher.

Request body (application/json): TicketWatcherRequest

Responses: 200 → TicketWatcher

PATCH /api/itsm/watchers/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this ticket watcher.

Request body (application/json): PatchedTicketWatcherRequest

Responses: 200 → TicketWatcher

DELETE /api/itsm/watchers/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesstringA UUID string identifying this ticket watcher.

Responses: 204


Windows

GET /api/itsm/windows/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedMaintenanceWindowList

POST /api/itsm/windows/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): MaintenanceWindowRequest

Responses: 201 → MaintenanceWindow

GET /api/itsm/windows/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this maintenance window.

Responses: 200 → MaintenanceWindow

PUT /api/itsm/windows/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this maintenance window.

Request body (application/json): MaintenanceWindowRequest

Responses: 200 → MaintenanceWindow

PATCH /api/itsm/windows/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this maintenance window.

Request body (application/json): PatchedMaintenanceWindowRequest

Responses: 200 → MaintenanceWindow

DELETE /api/itsm/windows/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this maintenance window.

Responses: 204


Auto-generated from drf-spectacular OpenAPI. Endpoint descriptions come from viewset docstrings/serializers; enriching those improves this page on the next generation.