KronoDesk: REST Web Service

Resources

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

Resource	Methods	Description
Product	GET	This resource lets you retrieve the list of products in the system
User	POST , GET	This resource lets you create users and retrieve a user by its id, email address or login
Ticket	POST , PUT	This resource lets you create tickets, add notes, update notes and update tickets
System	GET	This resource contains information on the overall product instance, including version and settings information
Document	POST	This resource lets you upload file attachments
Artifact	GET	This resource lets you retrieve artifact types and their associated information

Accessing Services

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

https://api.inflectra.com/KronoDesk/Services/v1_0/RestService.svc/

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

Content-Type: application/xml - Sends data in XML format
accept: application/xml - Returns data in XML format
Content-Type: application/json - Sends data in JSON format
accept: application/json - Returns data in JSON format

To authenticate with the web service there are three methods:

Pass in the username and api-key using the standard HTTP basic authentication header:

                            Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXX
                            where XXXXXXXXXXXXXXXXXXXXXXXXXX is username:api-key base64 encoded

Pass in the username application API-Key using the username and api-key HTTP headers:

                            username: fredbloggs
                            api-key: {XXXXXXXXXXXXXXXX}

Append the username and application API-Key as an extra querystring parameter:

                            ?username=fredbloggs&api-key={XXXXXXXXXXXXXXXX}

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/{user_id}	GET	Retrieves a single user in the system
users/login/{login}	GET	Retrieves a single user in the system bh its login
users/search/email-address/{email_address}	GET	Retrieves a list of users that have a specific email address
> 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}/notes	POST	Adds a new note to an existing ticket
tickets/{ticket_id}/notes	PUT	Updates an existing note in the system
> 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
documents	POST	Adds a new document or URL link into the system and associates it with the provided artifact
> Export to Rapise .REST File

Artifact

URI	Method	Description
artifacts/{artifact_type_id}/{artifact_id}/documents	GET	Gets a list of attached documents to an artifact
> Export to Rapise .REST File