The following macros are not currently supported in the header:
  • style

Extensions

The following endpoints can be used to access and manipulate a given object's extension value. Extension values are essentially additional fields you can dynamically apply to different object types. These value structures can be configured from the module's configuration screen by clicking on Progressions & Fields menu item.

We currently support the following object types:

  1. Contracts
  2. Prospects
  3. Jobs
  4. Issues

Table of available extension endpoints.  

TYPERESOURCEDESCRIPTION
GET/:object_type/:object_id/extensions/values

Returns an array of extension values for the given object. For example, to get an Issue's extension values that has an id of 200 in XML format, you would call

GET /api/v0/issues/200/extensions/values.xml

More details about this endpoint can be found here.

PUT/:object_type/:object_id/extensions/values/:extension_value_idUpdate a given extension value and return its updated contents. For example, to update an Issue's extension value with extension value id 300 and Issue id 200, and to return the updated extension details in JSON, you would call

PUT /api/v0/issues/200/extensions/values/300.json

More details about this endpoint can be found here.

GET/:object_type/extensions/fields

Returns an array of extension fields for the given type of object. For example, to get an Issue's extension fields that has an id of 200 in XML format, you would call

GET /api/v0/issues/extensions/fields.xml

More details about this endpoint can be found here.

POST/:object_type/:object_id/extensions/fields/:extension_field_idCreate an extension value for a given object and return its updated contents. For example, to create an Issue's extension value with extension field id 300 and Issue id 200, and to return the updated extension details in JSON, you would call

POST /api/v0/issues/200/extensions/fields/300.json

More details about this endpoint can be found here.