The Ticket Web API is a programmatic option to access and modify ticket information stored in the INETAPP server. It is based up on a RESTful interface that can be accessed using custom implemented HTTP clients, or external programs designed to interact with the INETAPP ticket functionality. Requests have to be sent as HTTP requests with the scheme http(s)://[HOST]:[PORT]/api/ticket/[Command]
. The Verbs GET
and POST
can be used where applicable.
Using the Web API requires authenticated access. Permissions and roles available for the authenticated user will have impact on the actions the user can take with the web API. For example, creating tickets is available for most users, but ticket dispatching still requires the the dispatcher role.
Note: The Ticket Web API can be used only by users who have the Web API
and permission set.
The Ticket Web API exposes the following features:
The following commands are available for the Ticket Web API:
Command | Description |
---|---|
/create | Create a new ticket |
/<ticket-id> | Returns detailed information about a ticket |
/actions | List available actions that can be applied to the ticket |
/apply | Apply an action to a ticket |
/steps | List editing steps of a ticket |
/<step-id> | Returns detailed information about a given ticket step |
/search | Search for tickets |