ChangeGear REST API

Introduction

REST APIs provide resource oriented URL's that leverages HTTP verbs and response codes.
This is a JSON-only API.
PUT and POST operations must supply a Content-Type: application/json header on the request.

It is strongly recommended that the site is configured to use SSL.

Authentication

All users must be authenticated to make API requests.
Users can be authenticated using either windows or forms authentication based on how the site is configured to be used.
Upon Login, the user will receive a sessionId that has to be included in the header of all API requests.

Requests

All requests should include the sessionid of the user in the header.
For eg: request.Headers.Add("sessionid", sessionid));

Pagination

The maximum number of records that can be returned per page is 100.

eTags (Resource versioning)

eTags ensure that multiple clients don't inadvertently overwrite one another's changes.
The APIs that do the updates will fail if the client specifies an old version identifier(eTag) for an entity. The API handles this using eTags.
An eTag is an identifier that specifies a particular version of a particular entity. attaches an eTag to every entity that is sent to the clients.
The eTag is an integer value.
An API call to update needs to include the eTag as part of the request. If the eTag sent does not match the eTag on for that entity, the update fails.
This makes sure the update is always done against the most recent version of the entity.

Entity

Generic API for all common entity types

API	Description
GET api/entity/{entitytype}?columns[0]={columns[0]}&columns[1]={columns[1]}&relations[0]={relations[0]}&relations[1]={relations[1]}&filter={filter}&sort={sort}&metadata={metadata}&pagesize={pagesize}&page={page}	No documentation available.
GET api/entity/{entitytype}/{viewname}?columns[0]={columns[0]}&columns[1]={columns[1]}&relations[0]={relations[0]}&relations[1]={relations[1]}&filter={filter}&sort={sort}&optionalParams[0].key={optionalParams[0].key}&optionalParams[0].value={optionalParams[0].value}&optionalParams[1].key={optionalParams[1].key}&optionalParams[1].value={optionalParams[1].value}&metadata={metadata}&pagesize={pagesize}&page={page}	No documentation available.
GET api/entity/{entitytype}/{id}?columns[0]={columns[0]}&columns[1]={columns[1]}&loadForEdit={loadForEdit}	No documentation available.
GET api/entity/{entitytype}/{parentid}/attachments/{attachmentid}	Returns the attachment data for the specified id and type
POST api/{entitytype}	No documentation available.
GET api/{entitytype}/unmask/{id}?fields[0]={fields[0]}&fields[1]={fields[1]}	No documentation available.
POST api/copy/{entitytype}/{id}	No documentation available.
PUT api/{entitytype}/{id}	No documentation available.
DELETE api/entity/{entitytype}/{id}	Deletes an item with the given id and type (eg: IncidentRequest, ChangeManagementTicket etc)

Login API. All subsequent requests after authentication are associated with the logged in user, their role and privileges within ChangeGear

API	Description
POST api/authenticate/user	Authenticates user
POST api/user/logout	No documentation available.
POST api/session/logout/{sessionid}	No documentation available.

Integration

API for integrating ChangeGear with TFS and JIRA (Bi-directional)

API	Description
POST api/integration/{toolId}/{entitytype}	Inbound call to create or update an item inside ChangeGear
POST api/integration/jiraproxy/{entitytype}	Required for Jira integration only. Serves as Proxy before the Jira item can be processed by ChangeGear. Jira does not support sending credentials via webhooks. So Jira requests calls into this proxy which then sets the authorization headers based on the credentials availabe in the web config and forwards the request.
POST api/Integration	No documentation available.

Search

Search API is a unified search API that returns tickets of all types. Search can be narrowed to a specific ticket type.

API	Description
GET api/{entitytype}/search?searchtext={searchtext}&autocomplete={autocomplete}&pagesize={pagesize}&page={page}	Returns the match for the specified entity type or across all types if entitytype is "all"
GET api/types/search?entitytypes[0]={entitytypes[0]}&entitytypes[1]={entitytypes[1]}&searchtext={searchtext}&autocomplete={autocomplete}&pagesize={pagesize}&page={page}	Returns the match for the specified entity types