KronoDesk: REST Web Service

Resources

This table provides a list of all the resources exposed by this REST web service:

ResourceMethodsDescription
Product GET This resource lets you retrieve the list of products in the system
User POST , GET , PUT , DELETE This resource lets you create users and retrieve a user by its id, email address or login
Ticket POST , PUT , GET , DELETE This resource lets you create tickets, add notes, update notes and update tickets
Ticket Note POST , PUT , DELETE , GET This resource lets you add, delete, update and view the notes attached to help desk tickets.
Ticket Type GET This resource lets you retrieve the list of ticket types in the system
Ticket Status GET This resource lets you retrieve the list of ticket statuses in the system
Ticket Resolution GET This resource lets you retrieve the list of ticket resolutions in the system
Ticket Priority GET This resource lets you retrieve the list of ticket priorities in the system
Article GET This resource lets you retrieve the list of articles in the system
System GET This resource contains information on the overall product instance, including version and settings information
Document POST , GET This resource lets you upload file attachments and retrieve attachments

Accessing Services

To access these REST web services, you need to use the following base URL:

http://api.inflectra.com/KronoDesk/Services/v2_0/RestService.svc/

You can specify the format of data that will be returned (XML or JSON) by passing the following HTTP Headers:

To authenticate with the web service there are three methods:

Finally if you need to call one of the GET methods from a web page in another domain you need to use the special JSONP (JSON with Padding) syntax. This tells the web service to return the data in the form of a JavaScript <script> tag so that it be can be called across web site domains safely. To request the data in JSONP format, just add the following extra querystring parameter:

                    ?callback=[name of callback function]
                

Product

URI Method Description
products GET Retrieves a list of all products in the system
products/active GET Retrieves a list of all active products in the system
> Export to Rapise .REST File

User

URI Method Description
users POST Creates a new user (with profile) in the system and adds them to the specified roles
users PUT Updates a specific user in the system
users/{user_id} GET Retrieves a single user in the system
users/{user_id} DELETE Deletes the specified user
users/email-address/{email_address} GET Retrieves the user that has a specific email address
users/login/{login} GET Retrieves a single user in the system bh its login
users?start_row={start_row}&number_rows={number_rows} GET Retrieves a paginated list of users in the system
> Export to Rapise .REST File

Ticket

URI Method Description
tickets POST Creates a new ticket in the system
tickets/{ticket_id} PUT Updates a ticket in the system.
tickets/{ticket_id} GET Retrieves a single ticket by its ID
tickets/{ticket_id} DELETE Deletes a single ticket by its ID
tickets/search?start_row={start_row}&number_rows={number_rows}&sort_field={sort_field}&sort_direction={sort_direction} POST Retrieves a list of tickets, sorted and filtered
> Export to Rapise .REST File

Ticket Note

URI Method Description
tickets/{ticket_id}/notes POST Adds a new note to an existing ticket
tickets/{ticket_id}/notes PUT Updates an existing note in the system
tickets/{ticket_id}/notes GET Retrieves all the notes for a specific ticket
tickets/{ticket_id}/notes/{note_id} DELETE Deletes a note from a ticket
tickets/{ticket_id}/notes/{note_id} GET Retrieves a single ticket note
> Export to Rapise .REST File

Ticket Type

URI Method Description
ticket-types GET Retrieves the list of ticket types
> Export to Rapise .REST File

Ticket Status

URI Method Description
ticket-statuses GET Retrieves the list of ticket statuses
> Export to Rapise .REST File

Ticket Resolution

URI Method Description
ticket-resolutions GET Retrieves the list of ticket resolutions
> Export to Rapise .REST File

Ticket Priority

URI Method Description
ticket-priorities GET Retrieves the list of ticket priorities
> Export to Rapise .REST File

Article

URI Method Description
articles/popular GET Retrieves a list of most popular articles
articles/recent GET Retrieves a list of recent articles
articles/subscribed GET Retrieves a list of your user's subscribed articles
> Export to Rapise .REST File

System

URI Method Description
system/file-extension/{mime_type} GET Returns the extension for a mime-type (e.g. "image/gif")
system/mime-type/{extension} GET Returns the mime type for a file extension
system/settings GET Returns the current configuration settings for the installation.
system/sitemap-entries GET Retrieves a list of publicly accessible web page urls, used in SEO sitemaps
system/version GET Retrieves the version number of the current installation.
> Export to Rapise .REST File

Document

URI Method Description
artifacts/{artifact_type_id}/{artifact_id}/documents GET Gets a list of attached documents to an artifact
documents POST Adds a new document or URL link into the system and associates it with the provided artifact
documents/{attachment_id} GET Retrieves a single attachment by its ID
> Export to Rapise .REST File