Integration

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

APIDescription
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 API is a unified search API that returns tickets of all types. Search can be narrowed to a specific ticket type.

APIDescription
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

Entity

Generic API for all common entity types

APIDescription
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.

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

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

APIDescription
POST api/authenticate/user

Authenticates user

POST api/user/logout

No documentation available.

POST api/session/logout/{sessionid}

No documentation available.