Loading ...

REST API: Cases | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Cases
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 43

REST API: Cases

0 
 /5
0 (0votes)
Open API Guide

Create, update, and track support cases programmatically. Manage case assignments, configure priorities, statuses, and project milestones, and integrate case workflows with external helpdesk or ticketing systems.

Available Endpoints

Method Endpoint Description
POST Add Attachment to Case /api/cases/{IssueID}/attachments Add a file attachment to a case
POST Add Case Comment Attachment /api/cases/{CaseID}/comments/{CommentID}/attachments Adds an attachment to a case comment
POST Create Case /api/cases Create a new support case within a case management space. Cases are used to track issues, requests, and tasks that need to be assigned and resolved by your team.
POST Create Case Comment /api/case/comments Creates a case comment on a case
POST Create Case Project Categories /api/cases/projects/{ProjectID}/categories Create a list of categories for a particular case project
POST Create Case Projects /api/case/projects Create one or more projects within a case management space. Projects act as grouping categories for organizing and filtering related cases.
DELETE Delete Case /api/cases/{IssueID} Provides an automated mechanism for removing delete case data from the system.
DELETE Delete Case Comment /api/case/comments/{commentid} Provides an automated mechanism for removing delete case comment data from the system.
GET Get Case /api/cases/{IssueID} Enables administrators and developers to programmatically retrieves case information.
GET Get Case Comment /api/case/comments/{CommentID} Enables administrators and developers to programmatically retrieves case comment information.
GET Get Case Comments /api/case/comments Enables administrators and developers to programmatically retrieve a list of comments made on a specific case.
GET Get Case Priorities /api/spaces/{SpaceID}/cases/priorities Enables administrators and developers to programmatically retrieve case priorities for a space.
GET Get Case Project Categories /api/spaces/{SpaceID}/cases/projects/{ProjectID}/categories Enables administrators and developers to programmatically retrieve a list of categories for a particular case project.
GET Get Case Project Milestones /api/spaces/{SpaceID}/cases/projects/{ProjectID}/milestones Enables administrators and developers to programmatically retrieve a list of milestones for a particular case project.
GET Get Case Projects /api/spaces/{SpaceID}/cases/projects Enables administrators and developers to programmatically retrieve case projects for a space.
GET Get Case Status Statistics /api/cases/stats Enables administrators and developers to programmatically retrieve statistics for a case status in a space.
GET Get Case Statuses /api/spaces/{SpaceID}/cases/statuses Enables administrators and developers to programmatically retrieve case statuses for a space.
GET Get Cases /api/cases Enables administrators and developers to programmatically retrieve a list of cases.
GET Get Users in Additional Recipient Roles /api/cases/projects/{projectid}/recipients Returns a list of users who belong to the Additional Recipient Roles defined for a specific case project.
GET Get Users in Assign to Roles /api/cases/spaces/{SpaceID}/projects/{ProjectID}/assignto Returns a list of users who belong to the Assign-To Roles for the specified case project within a space, eligible to be assigned to cases and receive notifications for unassigned or updated cases.
PUT Update Case /api/cases/{CaseID} Supports the synchronization and modification of update case properties via the API.
PUT Update Case Comment /api/case/comments/{CommentID} Updates an existing case comment
PUT Update Case Status /api/cases/{IssueID}/status Supports the synchronization and modification of update case status properties via the API.

Wiki Index

Pages