ChangeGear REST API

Introduction

ChangeGear 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 against the API using windows credentials or changegear credentials 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. ChangeGear 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 ChangeGear for that entity, the update fails.
This makes sure the update is always done against the most recent version of the entity.