REST API documentation version 1.0
https://jira/rest/insight/{version}
- version: required(1.0)
Attachments
Handle object attachements
get /attachments/object/{objectId}
URI Parameters
- objectId: required(integer)
The object id that has the attachment
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: Attachment
- id: required(string)
- author: (string)
- mimeType: (string)
- filename: required(string)
- filesize: (string)
- created: required(datetime)
- comment: (string)
- commentOutput: (string)
- url: required(string)
Example:
[
{
"id": 1,
"author": "admin",
"mimeType": "image/png",
"filename": "astronaut.png",
"filesize": "490 B",
"created": "2019-11-27T11:42:22.283Z",
"comment": "",
"commentOutput": "",
"url": "http://jira/rest/insight/1.0/attachments/1"
}
]
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 404
The object was not found
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
post /attachments/object/{objectId}
URI Parameters
- objectId: required(integer)
The object id that has the attachment
Body
Media type: multipart/form-data
Type: file
Example:
POST /rest/insight/1.0/attachments/object/1781801 HTTP/1.1
Host: JIRA-BASE
X-Atlassian-Token: no-check
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Authorization: Basic YWRtaW46YWRtaW4=
Cache-Control: no-cache
Postman-Token: ae680e26-1911-45b9-9d74-29b3cd143f68
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="DummyFile.txt"
Content-Type: text/plain
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="comment"
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="encodedComment"
------WebKitFormBoundary7MA4YWxkTrZu0gW--
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: Attachment
- id: required(string)
- author: (string)
- mimeType: (string)
- filename: required(string)
- filesize: (string)
- created: required(datetime)
- comment: (string)
- commentOutput: (string)
- url: required(string)
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 404
The object was not found
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
delete /attachments/{attachmentId}
Comment
Handle comments on objets
post /comment/create
Body
Media type: application/json
Type: object
Properties- comment: required(string)
- objectId: required(integer)
The object to attach the comment to
- role: required(integer)
Id Role description 0 Insight Users 1 Insight Managers 2 Insight Administrators 3 Insight Developers
Example:
{
"comment": "A comment to be added",
"objectId": 1,
"role": 0
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- created: required(datetime)
- updated: required(datetime)
- actor: required(object)
The Insight user type
- avatarUrl: (string)
- displayName: (string)
- name: (string)
- key: (string)
- emailAddress: (string)
- html: (string)
- renderedLink: (string)
- isDeleted: (boolean)
- lastSeenVersion: (string)
- self: (string)
- role: required(integer)
Id Role description 0 Insight Users 1 Insight Managers 2 Insight Administrators 3 Insight Developers - comment: required(string)
- commentOutput: required(string)
- objectId: required(integer)
- canEdit: required(boolean)
- canDelete: required(boolean)
Example:
{
"created": "2019-11-27T12:37:41.492Z",
"updated": "2019-11-27T12:37:41.492Z",
"id": 1,
"actor": {
"avatarUrl": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48",
"displayName": "admin",
"name": "admin",
"key": "admin",
"renderedLink": "<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",
"isDeleted": false
},
"role": 0,
"comment": "A comment to be added",
"commentOutput": "A comment to be added",
"objectId": 1,
"canEdit": true,
"canDelete": true
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
get /comment/object/{objectId}
URI Parameters
- objectId: required(integer)
The object id to fetch comments from
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: Comment
- id: required(integer)
- created: required(datetime)
- updated: required(datetime)
- actor: required(object)
The Insight user type
- avatarUrl: (string)
- displayName: (string)
- name: (string)
- key: (string)
- emailAddress: (string)
- html: (string)
- renderedLink: (string)
- isDeleted: (boolean)
- lastSeenVersion: (string)
- self: (string)
- role: required(integer)
Id Role description 0 Insight Users 1 Insight Managers 2 Insight Administrators 3 Insight Developers - comment: required(string)
- commentOutput: required(string)
- objectId: required(integer)
- canEdit: required(boolean)
- canDelete: required(boolean)
Example:
[
{
"created": "2019-11-27T12:37:41.492Z",
"updated": "2019-11-27T12:37:41.492Z",
"id": 1,
"actor": {
"avatarUrl": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48",
"displayName": "admin",
"name": "admin",
"key": "admin",
"renderedLink": "<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",
"isDeleted": false
},
"role": 0,
"comment": "A comment to be added",
"commentOutput": "A comment to be added",
"objectId": 1,
"canEdit": true,
"canDelete": true
}
]
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Icon
Resources dedicated to load and find icons
Load a single icon by id
get /icon/{id}
Load a single icon by id
URI Parameters
- id: required(integer)
HTTP status code 200
An icon
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
Example:
{
"id": 1,
"name": "Delete",
"url16": "http://jira/rest/insight/1.0/icon/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/icon/1/icon.png?size=48"
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 404
Icon can not be found
Body
Media type: application/json
Type: object
Properties- errorMessages: required(array of string)
- errors: required(object)
Example:
{
"errorMessages": [
"NotFoundInsightException: Could not find Icon with id: 999"
],
"errors": {}
}
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Return all global icons i.e. icons not associated with a particular object schema
get /icon/global
HTTP status code 200
All existing global icons
Body
Media type: application/json
Type: array of object
Items: Icon
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
Examples:
Icons:
[
{
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/icon/25/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/icon/25/icon.png?size=48"
},
{
"id": 56,
"name": "AV Receiver",
"url16": "http://jira/rest/insight/1.0/icon/56/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/icon/56/icon.png?size=48"
},
{
"id": 91,
"name": "Active Directory",
"url16": "http://jira/rest/insight/1.0/icon/91/icon.png?size=16",
"url48": "http://ljira/rest/insight/1.0/icon/91/icon.png?size=48"
}
]
No icons found:
[]
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
get /icon/objectschema/{objectSchemaId}
URI Parameters
- objectSchemaId: required(integer)
The id of the object schema to fetch all configured icons from.
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: Icon
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
Examples:
Icons:
[
{
"id": 143,
"name": "Insight",
"url16": "http://jira/rest/insight/1.0/icon/143/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/icon/143/icon.png?size=48"
}
]
No icons found:
[]
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Import
Start configured imports. To ser an ongoing import see the Progress resource
post /import/start/{id}
URI Parameters
- id: required(integer)
The id of the import configuration that should be started
Body
Media type: application/json
Type: object
Example:
An empty json object:
{}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- progressInPercent: (integer)
- resourceId: (string)
- category: (string)
- status: (string)
- stepDescription: (string)
- currentStep: (integer)
- numberOfSteps: (integer)
- currentWorkUnits: (integer)
- currentWorkDescription: (string)
- currentStepTotalWorkUnits: (integer)
- totalWorkUnits: (integer)
- result: (string)
- resultData: (object)
The result data is different depending on the type of process the category specifies
- resultMessage: (string)
- actor: (string)
The user key of the user that is running the process
- startDate: (datetime)
- finishedDate: (datetime)
- estimatedFinishDate: (datetime)
If it is possible to estimate the comletion of the task this field will be populated
Example:
{
"progressInPercent": 0,
"resourceId": "1",
"category": "imports",
"status": "IN_PROGRESS",
"stepDescription": "Placeholder",
"currentStep": 1,
"numberOfSteps": 6,
"currentWorkUnits": 0,
"currentWorkDescription": "rlabs-import-type-csvimport started...",
"currentStepTotalWorkUnits": 0,
"totalWorkUnits": 0,
"actor": "admin",
"startDate": "2019-11-27T12:52:39.475Z"
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Index
Handle the indexing of Insight
post /index/reindex/start
Query Parameters
- clean: required(boolean - default: false)
Should the reindex clean the index before doing the reindex
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- progressInPercent: (integer)
- resourceId: (string)
- category: (string)
- status: (string)
- stepDescription: (string)
- currentStep: (integer)
- numberOfSteps: (integer)
- currentWorkUnits: (integer)
- currentWorkDescription: (string)
- currentStepTotalWorkUnits: (integer)
- totalWorkUnits: (integer)
- result: (string)
- resultData: (object)
The result data is different depending on the type of process the category specifies
- resultMessage: (string)
- actor: (string)
The user key of the user that is running the process
- startDate: (datetime)
- finishedDate: (datetime)
- estimatedFinishDate: (datetime)
If it is possible to estimate the comletion of the task this field will be populated
Example:
{
"progressInPercent": 0,
"resourceId": "reindex",
"category": "insight-reindex",
"status": "IN_PROGRESS",
"stepDescription": "Re-index Insight",
"currentStep": 1,
"numberOfSteps": 1,
"currentWorkUnits": 0,
"currentStepTotalWorkUnits": 23,
"totalWorkUnits": 23,
"actor": "admin",
"startDate": "2019-11-27T12:23:54.891Z"
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Only applicable in a Data Center environment. Resource to start a re-index of the current node. This reindex will not clean the entire cluster just refresh the objects in cache on the current data center node
post /index/reindex/currentnode
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- progressInPercent: (integer)
- resourceId: (string)
- category: (string)
- status: (string)
- stepDescription: (string)
- currentStep: (integer)
- numberOfSteps: (integer)
- currentWorkUnits: (integer)
- currentWorkDescription: (string)
- currentStepTotalWorkUnits: (integer)
- totalWorkUnits: (integer)
- result: (string)
- resultData: (object)
The result data is different depending on the type of process the category specifies
- resultMessage: (string)
- actor: (string)
The user key of the user that is running the process
- startDate: (datetime)
- finishedDate: (datetime)
- estimatedFinishDate: (datetime)
If it is possible to estimate the comletion of the task this field will be populated
Example:
{
"progressInPercent": 0,
"resourceId": "reindex",
"category": "insight-reindex",
"status": "IN_PROGRESS",
"stepDescription": "Re-index Insight",
"currentStep": 1,
"numberOfSteps": 1,
"currentWorkUnits": 0,
"currentStepTotalWorkUnits": 23,
"totalWorkUnits": 23,
"actor": "admin",
"startDate": "2019-11-27T12:23:54.891Z"
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
IQL
Resource dedicated to finding objects based on the Insight Query Language (IQL)
get /iql/objects
Query Parameters
- iql: (string - default: "")
The query to determine which objects that should be fetched. E.g. objectType = "Computer". The empty IQL means all objects
- objectSchemaId: (integer)
Deprecated parameter, limit the scope of the objects to find based on this schema. This is a multi query parameter and multiple instances may be included to include multiple schemas. It is deprecated and should be replaced by adding objectSchemaId in the IQL instead
- page: (integer - default: 1)
Which page to fetch when paginating through the response
- orderByAttributeId: (integer)
Deprecated parameter use order by clause in IQL instead. The object type attribute id to be used for ordering the result. It is of importance when paginating through a response.
- orderAsc: (boolean - default: true)
Deprecated parameter use order by clause in IQL instead. Used in conjunction with the orderByAttributeId to determine the sorting direction, true means sort ascending.
- resultPerPage: (integer - default: 25)
The amount of objects returned per page
- includeAttributes: (boolean - default: true)
Should the objects attributes be included in the response. If this parameter is false only the information on the object will be returned and the object attributes will not be present
- includeAttributesDeep: (integer - default: 1)
How many levels of attributes should be included. E.g. consider an object A that has a reference to object B that has a reference to object C. If object A is included in the response and includeAttributesDeep=1 object A's reference to object B will be included in the attributes of object A but object B's reference to object C will not be included. However if the includeAttributesDeep=2 then object B's reference to object C will be included in object B's attributes
- includeTypeAttributes: (boolean - default: false)
Should the response include the object type attribute definition for each attribute that is returned with the objects
- includeExtendedInfo: (boolean - default: false)
Include information about open issues and attachments. Should each object have information if open tickets are connected to the object or if the object has attachments
- extended: (boolean)
Deprecated parameter is replaced by includeTypeAttributes
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- objectEntries: required(array of Object)
The actual objects
Items: Object
- id: required(integer)
- label: required(string)
The name of the object. This value is fetched from the attribute that is currently marked as label for the object type of this object
- objectKey: required(string)
The external identifier for this object
- avatar: required(object)
The object avatar is a custom image that represents an object. If the object has no avatar the icon for the object type will be used
- id: (integer)
- avatarUUID: (string)
- url16: required(string)
- url48: required(string)
- url72: required(string)
- url144: required(string)
- url288: required(string)
- objectId: required(integer)
A reference to the object that this avatar is associated with
- objectType: required(object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- created: required(datetime)
- updated: required(datetime)
- hasAvatar: required(boolean)
- timestamp: required(number)
- attributes: (array of ObjectAttribute)
Items: ObjectAttribute
- id: required(number)
- objectTypeAttribute: (object)
The definition of the attribute that is associated with an object type
- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
- objectTypeAttributeId: required(integer)
- objectAttributeValues: required(object)
The actual values of the object attribute. The size of the values array is determined by the cardinality constraints on the object type attribute as well as how many values are associated with the object attribute
- value: (union of string or datetime)
- displayValue: required(string)
The value as displayable text e.g. for a date time attribute this value will be formatted to the user settings
- searchValue: (string)
A value to use when searching for the specific object
- referencedObject: (object)
The same response body as an Insight object
- user: (object)
The Insight user type
- avatarUrl: (string)
- displayName: (string)
- name: (string)
- key: (string)
- emailAddress: (string)
- html: (string)
- renderedLink: (string)
- isDeleted: (boolean)
- lastSeenVersion: (string)
- self: (string)
- group: (object)
The Insight Group type
- avatarUrl: required(string)
- name: required(string)
- confluencePage: (object)
A value that describes a page in a Confluence
- id: required(string)
- title: required(string)
- url: required(string)
- version: (object)
Value describing a version in Jira
- avatarUrl: required(string)
- name: required(string)
- id: required(integer)
- url: required(string)
- project: (object)
Value that represents a Jira project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- status: (object)
An Insight status type that can be associated with objects
- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
- additionalValue: (string)
- objectTypeAttributes: (array of ObjectTypeAttribute)
The object type attributes that are present in the object entries
Items: ObjectTypeAttribute
- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
- objectTypeId: (integer)
Deprecated field that shows which object type id the result is for. Not applicable when using IQL
- objectTypeIsInherited: (boolean)
Deprecated field should not be used.
- abstractObjectType: (boolean)
Deprecated field should not be used.
- totalFilterCount: required(integer)
The total amount of objects that was matched in the search query. This number may be greater than the amount of objects currently shown
- startIndex: required(integer)
The offset of the first object in the search query that is present in the result, used for pagination
- toIndex: required(integer)
The index of the last object present in the result of the search query
- pageObjectSize: required(integer)
The amount of objects currently returned per page in the result set
- pageNumber: required(integer)
The current page of objects in the result set pagination
- orderByTypeAttrId: (integer)
Deprecated field - The object type attribute id used for sorting
- orderWay: (string)
Deprecated field - The sort order, used in conjunction with the orderByTypeAttrId
- filters: (object)
Deprecated field - The field is used for basic search
- iql: required(string)
The IQL that was used to find the object result set
- iqlSearchResult: (boolean)
Determines if the query was based on an IQL or by basic search
- conversionPossible: (boolean)
Is it possible to transform this IQL to basic search or vice versa
- matchedFilterValues: (object)
Deprecated field should not be used
- inheritanceTree: (object)
Deprecated field should not be used
Examples:
http://jira/rest/insight/1.0/iql/objects:
All query parameters set to default in an Insight installation with 2 objects in one object type
{
"objectEntries": [
{
"id": 1,
"label": "Example Object",
"objectKey": "TEST-1",
"avatar": {
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url72": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url144": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url288": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"objectId": 1
},
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"created": "2019-11-26T08:06:45.478Z",
"updated": "2019-11-26T08:07:08.063Z",
"hasAvatar": false,
"timestamp": 1574755628063,
"attributes": [
{
"id": 3,
"objectTypeAttributeId": 1,
"objectAttributeValues": [
{
"value": "TEST-1",
"searchValue": "TEST-1",
"displayValue": "TEST-1",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 6,
"objectTypeAttributeId": 2,
"objectAttributeValues": [
{
"value": "Example Object",
"searchValue": "Example Object",
"displayValue": "Example Object",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 4,
"objectTypeAttributeId": 3,
"objectAttributeValues": [
{
"value": "2019-11-26T08:06:45.478Z",
"searchValue": "2019-11-26T08:06:45.478Z",
"displayValue": "26/Nov/19 9:06 AM",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 5,
"objectTypeAttributeId": 4,
"objectAttributeValues": [
{
"value": "2019-11-26T08:07:08.063Z",
"searchValue": "2019-11-26T08:07:08.063Z",
"displayValue": "26/Nov/19 9:07 AM",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 1,
"objectTypeAttributeId": 5,
"objectAttributeValues": [
{
"value": "2019-11-29",
"searchValue": "2019-11-29",
"displayValue": "29/Nov/19",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 2,
"objectTypeAttributeId": 6,
"objectAttributeValues": [
{
"value": "2019-10-01T08:06:00.000Z",
"searchValue": "2019-10-01T08:06:00.000Z",
"displayValue": "01/Oct/19 10:06 AM",
"referencedType": false
}
],
"objectId": 1
}
],
"_links": {
"self": "http://jira/secure/ShowObject.jspa?id=1"
},
"name": "Example Object"
},
{
"id": 2,
"label": "Hello",
"objectKey": "TEST-2",
"avatar": {
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url72": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url144": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url288": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"objectId": 2
},
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"created": "2019-11-26T09:22:39.323Z",
"updated": "2019-11-26T09:22:39.323Z",
"hasAvatar": false,
"timestamp": 1574760159323,
"attributes": [
{
"id": 7,
"objectTypeAttributeId": 1,
"objectAttributeValues": [
{
"value": "TEST-2",
"searchValue": "TEST-2",
"displayValue": "TEST-2",
"referencedType": false
}
],
"objectId": 2
},
{
"id": 10,
"objectTypeAttributeId": 2,
"objectAttributeValues": [
{
"value": "Hello",
"searchValue": "Hello",
"displayValue": "Hello",
"referencedType": false
}
],
"objectId": 2
},
{
"id": 8,
"objectTypeAttributeId": 3,
"objectAttributeValues": [
{
"value": "2019-11-26T09:22:39.323Z",
"searchValue": "2019-11-26T09:22:39.323Z",
"displayValue": "26/Nov/19 10:22 AM",
"referencedType": false
}
],
"objectId": 2
},
{
"id": 9,
"objectTypeAttributeId": 4,
"objectAttributeValues": [
{
"value": "2019-11-26T09:22:39.323Z",
"searchValue": "2019-11-26T09:22:39.323Z",
"displayValue": "26/Nov/19 10:22 AM",
"referencedType": false
}
],
"objectId": 2
},
{
"objectTypeAttributeId": 5,
"objectAttributeValues": [],
"objectId": 2
},
{
"objectTypeAttributeId": 6,
"objectAttributeValues": [],
"objectId": 2
}
],
"_links": {
"self": "http://jira/secure/ShowObject.jspa?id=2"
},
"name": "Hello"
}
],
"objectTypeAttributes": [
{
"id": 1,
"name": "Key",
"label": false,
"type": 0,
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 0
},
{
"id": 2,
"name": "Name",
"label": true,
"type": 0,
"description": "The name of the object",
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 1
},
{
"id": 3,
"name": "Created",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 2
},
{
"id": 4,
"name": "Updated",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 3
},
{
"id": 5,
"name": "Date Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 4,
"name": "Date"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 4
},
{
"id": 6,
"name": "DateTime Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 5
}
],
"objectTypeId": 0,
"objectTypeIsInherited": false,
"abstractObjectType": false,
"totalFilterCount": 2,
"startIndex": 1,
"toIndex": 2,
"pageObjectSize": 25,
"pageNumber": 1,
"orderWay": "ascending",
"iql": "",
"iqlSearchResult": true,
"conversionPossible": false,
"pageSize": 1
}
http://jira/rest/insight/1.0/iql/objects?includeAttributes=false:
The reponse with includeAttributes to false meaning that no attributes are included for the objects
{
"objectEntries": [
{
"id": 1,
"label": "Example Object",
"objectKey": "TEST-1",
"avatar": {
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url72": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url144": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url288": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"objectId": 1
},
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"created": "2019-11-26T08:06:45.478Z",
"updated": "2019-11-26T08:07:08.063Z",
"hasAvatar": false,
"timestamp": 1574755628063,
"_links": {
"self": "http://jira/secure/ShowObject.jspa?id=1"
},
"name": "Example Object"
},
{
"id": 2,
"label": "Hello",
"objectKey": "TEST-2",
"avatar": {
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url72": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url144": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url288": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"objectId": 2
},
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"created": "2019-11-26T09:22:39.323Z",
"updated": "2019-11-26T09:22:39.323Z",
"hasAvatar": false,
"timestamp": 1574760159323,
"_links": {
"self": "http://jira/secure/ShowObject.jspa?id=2"
},
"name": "Hello"
}
],
"objectTypeAttributes": [
{
"id": 1,
"name": "Key",
"label": false,
"type": 0,
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 0
},
{
"id": 2,
"name": "Name",
"label": true,
"type": 0,
"description": "The name of the object",
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 1
},
{
"id": 3,
"name": "Created",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 2
},
{
"id": 4,
"name": "Updated",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 3
},
{
"id": 5,
"name": "Date Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 4,
"name": "Date"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 4
},
{
"id": 6,
"name": "DateTime Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 5
}
],
"objectTypeId": 0,
"objectTypeIsInherited": false,
"abstractObjectType": false,
"totalFilterCount": 2,
"startIndex": 1,
"toIndex": 2,
"pageObjectSize": 25,
"pageNumber": 1,
"orderWay": "ascending",
"iql": "",
"iqlSearchResult": true,
"conversionPossible": false,
"pageSize": 1
}
empty:
{
"objectEntries": [],
"objectTypeAttributes": [],
"objectTypeId": 0,
"objectTypeIsInherited": false,
"abstractObjectType": false,
"totalFilterCount": 0,
"startIndex": 1,
"toIndex": 0,
"pageObjectSize": 25,
"pageNumber": 1,
"orderWay": "ascending",
"iql": "objectTypeId=2",
"iqlSearchResult": true,
"conversionPossible": false,
"pageSize": 0
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Object
Resource dedicated to load and manipulate single objects. If multiple objects are to be found check out the IQL endpoint
Load one object
Update an existing object in Insight
Delete the referenced object
get /object/{id}
Load one object
URI Parameters
- id: required(string)
The object id to operate on
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- label: required(string)
The name of the object. This value is fetched from the attribute that is currently marked as label for the object type of this object
- objectKey: required(string)
The external identifier for this object
- avatar: required(object)
The object avatar is a custom image that represents an object. If the object has no avatar the icon for the object type will be used
- id: (integer)
- avatarUUID: (string)
- url16: required(string)
- url48: required(string)
- url72: required(string)
- url144: required(string)
- url288: required(string)
- objectId: required(integer)
A reference to the object that this avatar is associated with
- objectType: required(object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- created: required(datetime)
- updated: required(datetime)
- hasAvatar: required(boolean)
- timestamp: required(number)
- attributes: (array of ObjectAttribute)
Items: ObjectAttribute
- id: required(number)
- objectTypeAttribute: (object)
The definition of the attribute that is associated with an object type
- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
- objectTypeAttributeId: required(integer)
- objectAttributeValues: required(object)
The actual values of the object attribute. The size of the values array is determined by the cardinality constraints on the object type attribute as well as how many values are associated with the object attribute
- value: (union of string or datetime)
- displayValue: required(string)
The value as displayable text e.g. for a date time attribute this value will be formatted to the user settings
- searchValue: (string)
A value to use when searching for the specific object
- referencedObject: (object)
The same response body as an Insight object
- user: (object)
The Insight user type
- avatarUrl: (string)
- displayName: (string)
- name: (string)
- key: (string)
- emailAddress: (string)
- html: (string)
- renderedLink: (string)
- isDeleted: (boolean)
- lastSeenVersion: (string)
- self: (string)
- group: (object)
The Insight Group type
- avatarUrl: required(string)
- name: required(string)
- confluencePage: (object)
A value that describes a page in a Confluence
- id: required(string)
- title: required(string)
- url: required(string)
- version: (object)
Value describing a version in Jira
- avatarUrl: required(string)
- name: required(string)
- id: required(integer)
- url: required(string)
- project: (object)
Value that represents a Jira project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- status: (object)
An Insight status type that can be associated with objects
- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
- additionalValue: (string)
Example:
{
"id": 1,
"label": "IPhone",
"objectKey": "TEST-1",
"avatar": {
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url72": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url144": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url288": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"objectId": 1
},
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"created": "2019-11-26T08:06:45.478Z",
"updated": "2019-11-26T20:16:02.951Z",
"hasAvatar": false,
"timestamp": 1574799362951,
"attributes": [
{
"id": 3,
"objectTypeAttribute": {
"id": 1,
"name": "Key",
"label": false,
"type": 0,
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 0
},
"objectTypeAttributeId": 1,
"objectAttributeValues": [
{
"value": "TEST-1",
"searchValue": "TEST-1",
"displayValue": "TEST-1",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 6,
"objectTypeAttribute": {
"id": 2,
"name": "Name",
"label": true,
"type": 0,
"description": "The name of the object",
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 1
},
"objectTypeAttributeId": 2,
"objectAttributeValues": [
{
"value": "IPhone",
"searchValue": "IPhone",
"displayValue": "IPhone",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 4,
"objectTypeAttribute": {
"id": 3,
"name": "Created",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 2
},
"objectTypeAttributeId": 3,
"objectAttributeValues": [
{
"value": "2019-11-26T08:06:45.478Z",
"searchValue": "2019-11-26T08:06:45.478Z",
"displayValue": "26/Nov/19 9:06 AM",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 5,
"objectTypeAttribute": {
"id": 4,
"name": "Updated",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 3
},
"objectTypeAttributeId": 4,
"objectAttributeValues": [
{
"value": "2019-11-26T20:16:02.951Z",
"searchValue": "2019-11-26T20:16:02.951Z",
"displayValue": "26/Nov/19 9:16 PM",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 1,
"objectTypeAttribute": {
"id": 5,
"name": "Date Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 4,
"name": "Date"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 4
},
"objectTypeAttributeId": 5,
"objectAttributeValues": [
{
"value": "2019-11-29",
"searchValue": "2019-11-29",
"displayValue": "29/Nov/19",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 2,
"objectTypeAttribute": {
"id": 6,
"name": "DateTime Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 5
},
"objectTypeAttributeId": 6,
"objectAttributeValues": [
{
"value": "2019-10-01T08:06:00.000Z",
"searchValue": "2019-10-01T08:06:00.000Z",
"displayValue": "01/Oct/19 10:06 AM",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 11,
"objectTypeAttribute": {
"id": 7,
"name": "Reference",
"label": false,
"type": 1,
"referenceType": {
"id": 1,
"name": "Dependency",
"description": "Dependency",
"color": "e8f00e",
"url16": "http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16",
"removable": false
},
"referenceObjectTypeId": 1,
"referenceObjectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": -1,
"suffix": "",
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"regexValidation": "",
"iql": "",
"options": "",
"position": 6
},
"objectTypeAttributeId": 7,
"objectAttributeValues": [
{
"referencedObject": {
"id": 2,
"label": "Hello",
"objectKey": "TEST-2",
"avatar": {
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url72": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url144": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url288": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"objectId": 2
},
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"created": "2019-11-26T09:22:39.323Z",
"updated": "2019-11-27T07:12:36.215Z",
"hasAvatar": false,
"timestamp": 1574838756215,
"_links": {
"self": "http://jira/secure/ShowObject.jspa?id=2"
},
"name": "Hello"
},
"searchValue": "TEST-2",
"displayValue": "Hello",
"referencedType": true
}
],
"objectId": 1
}
],
"extendedInfo": {
"openIssuesExists": false,
"attachmentsExists": false
},
"_links": {
"self": "http://jira/secure/ShowObject.jspa?id=1"
},
"name": "IPhone"
}
put /object/{id}
Update an existing object in Insight
URI Parameters
- id: required(string)
The object id to operate on
Body
Media type: application/json
Type: object
Properties- objectTypeId: required(integer)
The object type determines where the object should be stored and which attributes are available
- attributes: required(array of ObjectAttributeIn)
Items: ObjectAttributeIn
- objectId: required(integer)
The object that this attribute should be associated with
- objectTypeAttributeId: required(integer)
The type of the attribute. The type decides how this value should be interpreted
- objectAttributeValues: required(array of ObjectAttributeValueIn)
The value(s)
Items: ObjectAttributeValueIn
- value: required(string)
Type (of the object type attribute) Description Default The value must be of a valid format based on the additional type of the object type attribute, like Text, Integer, URL, Email etc. for date and datetime the value should be in ISO8601 format Object The value is the Object Key to set User The value is the Jira User key to set Confluence The value is the Page ID in confluence. Version The value is the Version ID in Jira Project The value is the Project ID in Jira Status The value is the Status ID in Insight
- value: required(string)
- objectId: required(integer)
- hasAvatar: (boolean)
- avatarUUID: (string)
The UUID as retrieved by uploading an avatar.
Example:
Example on setting an object reference attribute to 2 objects (cardinality multiple) where the reference attribute has id 7 and object type id 1
{
"objectTypeId": 1,
"attributes": [
{
"objectTypeAttributeId": 7,
"objectAttributeValues": [
{
"value": "TEST-1"
},
{
"value": "TEST-2"
}
]
}
]
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- label: required(string)
The name of the object. This value is fetched from the attribute that is currently marked as label for the object type of this object
- objectKey: required(string)
The external identifier for this object
- avatar: required(object)
The object avatar is a custom image that represents an object. If the object has no avatar the icon for the object type will be used
- id: (integer)
- avatarUUID: (string)
- url16: required(string)
- url48: required(string)
- url72: required(string)
- url144: required(string)
- url288: required(string)
- objectId: required(integer)
A reference to the object that this avatar is associated with
- objectType: required(object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- created: required(datetime)
- updated: required(datetime)
- hasAvatar: required(boolean)
- timestamp: required(number)
- attributes: (array of ObjectAttribute)
Items: ObjectAttribute
- id: required(number)
- objectTypeAttribute: (object)
The definition of the attribute that is associated with an object type
- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
- objectTypeAttributeId: required(integer)
- objectAttributeValues: required(object)
The actual values of the object attribute. The size of the values array is determined by the cardinality constraints on the object type attribute as well as how many values are associated with the object attribute
- value: (union of string or datetime)
- displayValue: required(string)
The value as displayable text e.g. for a date time attribute this value will be formatted to the user settings
- searchValue: (string)
A value to use when searching for the specific object
- referencedObject: (object)
The same response body as an Insight object
- user: (object)
The Insight user type
- avatarUrl: (string)
- displayName: (string)
- name: (string)
- key: (string)
- emailAddress: (string)
- html: (string)
- renderedLink: (string)
- isDeleted: (boolean)
- lastSeenVersion: (string)
- self: (string)
- group: (object)
The Insight Group type
- avatarUrl: required(string)
- name: required(string)
- confluencePage: (object)
A value that describes a page in a Confluence
- id: required(string)
- title: required(string)
- url: required(string)
- version: (object)
Value describing a version in Jira
- avatarUrl: required(string)
- name: required(string)
- id: required(integer)
- url: required(string)
- project: (object)
Value that represents a Jira project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- status: (object)
An Insight status type that can be associated with objects
- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
- additionalValue: (string)
Example:
{
"id": 2,
"label": "Hello",
"objectKey": "TEST-2",
"avatar": {
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url72": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url144": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url288": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"objectId": 2
},
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"created": "2019-11-26T09:22:39.323Z",
"updated": "2019-11-27T07:12:36.215Z",
"hasAvatar": false,
"timestamp": 1574838756215,
"attributes": [
{
"id": 7,
"objectTypeAttribute": {
"id": 1,
"name": "Key",
"label": false,
"type": 0,
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 0
},
"objectTypeAttributeId": 1,
"objectAttributeValues": [
{
"value": "TEST-2",
"searchValue": "TEST-2",
"displayValue": "TEST-2",
"referencedType": false
}
],
"objectId": 2
},
{
"id": 10,
"objectTypeAttribute": {
"id": 2,
"name": "Name",
"label": true,
"type": 0,
"description": "The name of the object",
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 1
},
"objectTypeAttributeId": 2,
"objectAttributeValues": [
{
"value": "Hello",
"searchValue": "Hello",
"displayValue": "Hello",
"referencedType": false
}
],
"objectId": 2
},
{
"id": 8,
"objectTypeAttribute": {
"id": 3,
"name": "Created",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 2
},
"objectTypeAttributeId": 3,
"objectAttributeValues": [
{
"value": "2019-11-26T09:22:39.323Z",
"searchValue": "2019-11-26T09:22:39.323Z",
"displayValue": "26/Nov/19 10:22 AM",
"referencedType": false
}
],
"objectId": 2
},
{
"id": 9,
"objectTypeAttribute": {
"id": 4,
"name": "Updated",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 3
},
"objectTypeAttributeId": 4,
"objectAttributeValues": [
{
"value": "2019-11-27T07:12:36.215Z",
"searchValue": "2019-11-27T07:12:36.215Z",
"displayValue": "27/Nov/19 8:12 AM",
"referencedType": false
}
],
"objectId": 2
},
{
"objectTypeAttribute": {
"id": 5,
"name": "Date Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 4,
"name": "Date"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 4
},
"objectTypeAttributeId": 5,
"objectAttributeValues": [],
"objectId": 2
},
{
"objectTypeAttribute": {
"id": 6,
"name": "DateTime Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 5
},
"objectTypeAttributeId": 6,
"objectAttributeValues": [],
"objectId": 2
},
{
"id": 12,
"objectTypeAttribute": {
"id": 7,
"name": "Reference",
"label": false,
"type": 1,
"referenceType": {
"id": 1,
"name": "Dependency",
"description": "Dependency",
"color": "e8f00e",
"url16": "http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16",
"removable": false
},
"referenceObjectTypeId": 1,
"referenceObjectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": -1,
"suffix": "",
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"regexValidation": "",
"iql": "",
"options": "",
"position": 6
},
"objectTypeAttributeId": 7,
"objectAttributeValues": [
{
"referencedObject": {
"id": 1,
"label": "IPhone",
"objectKey": "TEST-1",
"avatar": {
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url72": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url144": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url288": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"objectId": 1
},
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"created": "2019-11-26T08:06:45.478Z",
"updated": "2019-11-26T20:16:02.951Z",
"hasAvatar": false,
"timestamp": 1574799362951,
"_links": {
"self": "http://jira/secure/ShowObject.jspa?id=1"
},
"name": "IPhone"
},
"searchValue": "TEST-1",
"displayValue": "IPhone",
"referencedType": true
},
{
"referencedObject": {
"id": 2,
"label": "Hello",
"objectKey": "TEST-2",
"avatar": {
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url72": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url144": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url288": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"objectId": 2
},
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"created": "2019-11-26T09:22:39.323Z",
"updated": "2019-11-27T07:12:36.215Z",
"hasAvatar": false,
"timestamp": 1574838756215,
"_links": {
"self": "http://jira/secure/ShowObject.jspa?id=2"
},
"name": "Hello"
},
"searchValue": "TEST-2",
"displayValue": "Hello",
"referencedType": true
}
],
"objectId": 2
}
],
"_links": {
"self": "http://jira/secure/ShowObject.jspa?id=2"
},
"name": "Hello"
}
delete /object/{id}
List all attributes for the given object
get /object/{id}/attributes
List all attributes for the given object
URI Parameters
- id: required(string)
The object id to operate on
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: ObjectAttribute
- id: required(number)
- objectTypeAttribute: (object)
The definition of the attribute that is associated with an object type
- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
- objectTypeAttributeId: required(integer)
- objectAttributeValues: required(object)
The actual values of the object attribute. The size of the values array is determined by the cardinality constraints on the object type attribute as well as how many values are associated with the object attribute
- value: (union of string or datetime)
- displayValue: required(string)
The value as displayable text e.g. for a date time attribute this value will be formatted to the user settings
- searchValue: (string)
A value to use when searching for the specific object
- referencedObject: (object)
The same response body as an Insight object
- user: (object)
The Insight user type
- avatarUrl: (string)
- displayName: (string)
- name: (string)
- key: (string)
- emailAddress: (string)
- html: (string)
- renderedLink: (string)
- isDeleted: (boolean)
- lastSeenVersion: (string)
- self: (string)
- group: (object)
The Insight Group type
- avatarUrl: required(string)
- name: required(string)
- confluencePage: (object)
A value that describes a page in a Confluence
- id: required(string)
- title: required(string)
- url: required(string)
- version: (object)
Value describing a version in Jira
- avatarUrl: required(string)
- name: required(string)
- id: required(integer)
- url: required(string)
- project: (object)
Value that represents a Jira project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- status: (object)
An Insight status type that can be associated with objects
- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
- additionalValue: (string)
Example:
[
{
"id": 3,
"objectTypeAttribute": {
"id": 1,
"name": "Key",
"label": false,
"type": 0,
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 0
},
"objectTypeAttributeId": 1,
"objectAttributeValues": [
{
"value": "TEST-1",
"searchValue": "TEST-1",
"displayValue": "TEST-1",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 6,
"objectTypeAttribute": {
"id": 2,
"name": "Name",
"label": true,
"type": 0,
"description": "The name of the object",
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 1
},
"objectTypeAttributeId": 2,
"objectAttributeValues": [
{
"value": "IPhone",
"searchValue": "IPhone",
"displayValue": "IPhone",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 4,
"objectTypeAttribute": {
"id": 3,
"name": "Created",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 2
},
"objectTypeAttributeId": 3,
"objectAttributeValues": [
{
"value": "2019-11-26T08:06:45.478Z",
"searchValue": "2019-11-26T08:06:45.478Z",
"displayValue": "26/Nov/19 9:06 AM",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 5,
"objectTypeAttribute": {
"id": 4,
"name": "Updated",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 3
},
"objectTypeAttributeId": 4,
"objectAttributeValues": [
{
"value": "2019-11-26T20:16:02.951Z",
"searchValue": "2019-11-26T20:16:02.951Z",
"displayValue": "26/Nov/19 9:16 PM",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 1,
"objectTypeAttribute": {
"id": 5,
"name": "Date Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 4,
"name": "Date"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 4
},
"objectTypeAttributeId": 5,
"objectAttributeValues": [
{
"value": "2019-11-29",
"searchValue": "2019-11-29",
"displayValue": "29/Nov/19",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 2,
"objectTypeAttribute": {
"id": 6,
"name": "DateTime Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 5
},
"objectTypeAttributeId": 6,
"objectAttributeValues": [
{
"value": "2019-10-01T08:06:00.000Z",
"searchValue": "2019-10-01T08:06:00.000Z",
"displayValue": "01/Oct/19 10:06 AM",
"referencedType": false
}
],
"objectId": 1
},
{
"id": 11,
"objectTypeAttribute": {
"id": 7,
"name": "Reference",
"label": false,
"type": 1,
"referenceType": {
"id": 1,
"name": "Dependency",
"description": "Dependency",
"color": "e8f00e",
"url16": "http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16",
"removable": false
},
"referenceObjectTypeId": 1,
"referenceObjectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 6
},
"objectTypeAttributeId": 7,
"objectAttributeValues": [
{
"referencedObject": {
"id": 2,
"label": "Hello",
"objectKey": "TEST-2",
"avatar": {
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url72": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url144": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url288": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"objectId": 2
},
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"created": "2019-11-26T09:22:39.323Z",
"updated": "2019-11-26T09:22:39.323Z",
"hasAvatar": false,
"timestamp": 1574760159323,
"_links": {
"self": "http://jira/secure/ShowObject.jspa?id=2"
},
"name": "Hello"
},
"searchValue": "TEST-2",
"displayValue": "Hello",
"referencedType": true
}
],
"objectId": 1
}
]
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Retrieve the history entries for this object
get /object/{id}/history
Retrieve the history entries for this object
URI Parameters
- id: required(string)
The object id to operate on
Query Parameters
- asc: (boolean - default: Uses the Jira setting for sort order)
Should the historiy be retrieved in ascending order
- abbreviate: (boolean - default: true)
Should the values returned in the history entriy be abbreviated
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- actor: required(object)
Who performed the operation
- avatarUrl: (string)
- displayName: (string)
- name: (string)
- key: (string)
- emailAddress: (string)
- html: (string)
- renderedLink: (string)
- isDeleted: (boolean)
- lastSeenVersion: (string)
- self: (string)
- id: required(integer)
- affectedAttribute: (string)
The name of the affected attribute
- oldValue: (string)
- newValue: (string)
- type: required(integer)
- created: required(datetime)
- objectId: required(integer)
Example:
[
{
"actor": {
"avatarUrl": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48",
"displayName": "admin",
"name": "admin",
"key": "admin",
"renderedLink": "<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",
"isDeleted": false
},
"id": 1,
"type": 0,
"created": "2019-11-26T08:06:45.520Z",
"objectId": 1
},
{
"actor": {
"avatarUrl": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48",
"displayName": "admin",
"name": "admin",
"key": "admin",
"renderedLink": "<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",
"isDeleted": false
},
"id": 2,
"affectedAttribute": "Date Attribute",
"oldValue": "Tue, 5 Nov 2019",
"newValue": "Sat, 30 Nov 2019",
"type": 2,
"created": "2019-11-26T08:06:56.131Z",
"objectId": 1
},
{
"actor": {
"avatarUrl": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48",
"displayName": "admin",
"name": "admin",
"key": "admin",
"renderedLink": "<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",
"isDeleted": false
},
"id": 3,
"affectedAttribute": "Date Attribute",
"oldValue": "Sat, 30 Nov 2019",
"newValue": "Fri, 29 Nov 2019",
"type": 2,
"created": "2019-11-26T08:07:08.072Z",
"objectId": 1
},
{
"actor": {
"avatarUrl": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48",
"displayName": "admin",
"name": "admin",
"key": "admin",
"renderedLink": "<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",
"isDeleted": false
},
"id": 5,
"affectedAttribute": "Name",
"oldValue": "Example Object",
"newValue": "IPhone",
"type": 2,
"created": "2019-11-26T19:52:09.971Z",
"objectId": 1
},
{
"actor": {
"avatarUrl": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48",
"displayName": "admin",
"name": "admin",
"key": "admin",
"renderedLink": "<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",
"isDeleted": false
},
"id": 6,
"affectedAttribute": "Reference",
"oldValue": "",
"newValue": "Hello",
"type": 4,
"created": "2019-11-26T20:16:02.956Z",
"objectId": 1
}
]
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Find all references for an object
get /object/{id}/referenceinfo
Find all references for an object
URI Parameters
- id: required(string)
The object id to operate on
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: ObjectReferenceTypeInfo
- referenceTypes: (array of ReferenceType)
Items: ReferenceType
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- numberOfReferencedObjects: required(integer)
- openIssuesExists: required(boolean)
Example:
[
{
"referenceTypes": [
{
"id": 1,
"name": "Dependency",
"description": "Dependency",
"color": "e8f00e",
"url16": "http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16",
"removable": false
}
],
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"numberOfReferencedObjects": 1,
"openIssuesExists": false
}
]
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Create a new object in Insight
post /object/create
Body
Media type: application/json
Type: object
Properties- objectTypeId: required(integer)
The object type determines where the object should be stored and which attributes are available
- attributes: required(array of ObjectAttributeIn)
Items: ObjectAttributeIn
- objectId: required(integer)
The object that this attribute should be associated with
- objectTypeAttributeId: required(integer)
The type of the attribute. The type decides how this value should be interpreted
- objectAttributeValues: required(array of ObjectAttributeValueIn)
The value(s)
Items: ObjectAttributeValueIn
- value: required(string)
Type (of the object type attribute) Description Default The value must be of a valid format based on the additional type of the object type attribute, like Text, Integer, URL, Email etc. for date and datetime the value should be in ISO8601 format Object The value is the Object Key to set User The value is the Jira User key to set Confluence The value is the Page ID in confluence. Version The value is the Version ID in Jira Project The value is the Project ID in Jira Status The value is the Status ID in Insight
- value: required(string)
- objectId: required(integer)
- hasAvatar: (boolean)
- avatarUUID: (string)
The UUID as retrieved by uploading an avatar.
Example:
Example on creating an object with name set to "Hello" where Name attribute has id 2 and object type id 1
{
"objectTypeId": 1,
"attributes": [
{
"objectTypeAttributeId": 2,
"objectAttributeValues": [
{
"value": "Hello"
}
]
}
]
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- label: required(string)
The name of the object. This value is fetched from the attribute that is currently marked as label for the object type of this object
- objectKey: required(string)
The external identifier for this object
- avatar: required(object)
The object avatar is a custom image that represents an object. If the object has no avatar the icon for the object type will be used
- id: (integer)
- avatarUUID: (string)
- url16: required(string)
- url48: required(string)
- url72: required(string)
- url144: required(string)
- url288: required(string)
- objectId: required(integer)
A reference to the object that this avatar is associated with
- objectType: required(object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- created: required(datetime)
- updated: required(datetime)
- hasAvatar: required(boolean)
- timestamp: required(number)
- attributes: (array of ObjectAttribute)
Items: ObjectAttribute
- id: required(number)
- objectTypeAttribute: (object)
The definition of the attribute that is associated with an object type
- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
- objectTypeAttributeId: required(integer)
- objectAttributeValues: required(object)
The actual values of the object attribute. The size of the values array is determined by the cardinality constraints on the object type attribute as well as how many values are associated with the object attribute
- value: (union of string or datetime)
- displayValue: required(string)
The value as displayable text e.g. for a date time attribute this value will be formatted to the user settings
- searchValue: (string)
A value to use when searching for the specific object
- referencedObject: (object)
The same response body as an Insight object
- user: (object)
The Insight user type
- avatarUrl: (string)
- displayName: (string)
- name: (string)
- key: (string)
- emailAddress: (string)
- html: (string)
- renderedLink: (string)
- isDeleted: (boolean)
- lastSeenVersion: (string)
- self: (string)
- group: (object)
The Insight Group type
- avatarUrl: required(string)
- name: required(string)
- confluencePage: (object)
A value that describes a page in a Confluence
- id: required(string)
- title: required(string)
- url: required(string)
- version: (object)
Value describing a version in Jira
- avatarUrl: required(string)
- name: required(string)
- id: required(integer)
- url: required(string)
- project: (object)
Value that represents a Jira project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- status: (object)
An Insight status type that can be associated with objects
- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
- additionalValue: (string)
Example:
{
"id": 2,
"label": "Hello",
"objectKey": "TEST-2",
"avatar": {
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url72": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url144": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"url288": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc",
"objectId": 2
},
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"created": "2019-11-26T09:22:39.323Z",
"updated": "2019-11-26T09:22:39.323Z",
"hasAvatar": false,
"timestamp": 1574760159323,
"_links": {
"self": "http://jira/secure/ShowObject.jspa?id=2"
},
"name": "Hello"
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Object Attribute
Resource dedicated manipulating single attributes for objects. Used when only a single attribute of an object needs to be manipulated.
Creates a new attribute for a given attribute.
post /objectattribute/create
Creates a new attribute for a given attribute.
Body
Media type: application/json
Type: object
Properties- objectId: required(integer)
The object that this attribute should be associated with
- objectTypeAttributeId: required(integer)
The type of the attribute. The type decides how this value should be interpreted
- objectAttributeValues: required(array of ObjectAttributeValueIn)
The value(s)
Items: ObjectAttributeValueIn
- value: required(string)
Type (of the object type attribute) Description Default The value must be of a valid format based on the additional type of the object type attribute, like Text, Integer, URL, Email etc. for date and datetime the value should be in ISO8601 format Object The value is the Object Key to set User The value is the Jira User key to set Confluence The value is the Page ID in confluence. Version The value is the Version ID in Jira Project The value is the Project ID in Jira Status The value is the Status ID in Insight
- value: required(string)
Example:
{
"objectAttributeValues": [
{
"value": "IPhone"
}
],
"objectId": 1,
"objectTypeAttributeId": 2
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- id: required(number)
- objectTypeAttribute: (object)
The definition of the attribute that is associated with an object type
- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
- objectTypeAttributeId: required(integer)
- objectAttributeValues: required(object)
The actual values of the object attribute. The size of the values array is determined by the cardinality constraints on the object type attribute as well as how many values are associated with the object attribute
- value: (union of string or datetime)
- displayValue: required(string)
The value as displayable text e.g. for a date time attribute this value will be formatted to the user settings
- searchValue: (string)
A value to use when searching for the specific object
- referencedObject: (object)
The same response body as an Insight object
- user: (object)
The Insight user type
- avatarUrl: (string)
- displayName: (string)
- name: (string)
- key: (string)
- emailAddress: (string)
- html: (string)
- renderedLink: (string)
- isDeleted: (boolean)
- lastSeenVersion: (string)
- self: (string)
- group: (object)
The Insight Group type
- avatarUrl: required(string)
- name: required(string)
- confluencePage: (object)
A value that describes a page in a Confluence
- id: required(string)
- title: required(string)
- url: required(string)
- version: (object)
Value describing a version in Jira
- avatarUrl: required(string)
- name: required(string)
- id: required(integer)
- url: required(string)
- project: (object)
Value that represents a Jira project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- status: (object)
An Insight status type that can be associated with objects
- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
- additionalValue: (string)
Example:
{
"id": 6,
"objectTypeAttributeId": 2,
"objectAttributeValues": [
{
"value": "IPhone",
"searchValue": "IPhone",
"displayValue": "IPhone",
"referencedType": false
}
],
"objectId": 1
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Update an already existing object attribute
Load a single object attribute
put /objectattribute/{id}
Update an already existing object attribute
URI Parameters
- id: required(string)
The object attribute id
Body
Media type: application/json
Type: object
Properties- objectId: required(integer)
The object that this attribute should be associated with
- objectTypeAttributeId: required(integer)
The type of the attribute. The type decides how this value should be interpreted
- objectAttributeValues: required(array of ObjectAttributeValueIn)
The value(s)
Items: ObjectAttributeValueIn
- value: required(string)
Type (of the object type attribute) Description Default The value must be of a valid format based on the additional type of the object type attribute, like Text, Integer, URL, Email etc. for date and datetime the value should be in ISO8601 format Object The value is the Object Key to set User The value is the Jira User key to set Confluence The value is the Page ID in confluence. Version The value is the Version ID in Jira Project The value is the Project ID in Jira Status The value is the Status ID in Insight
- value: required(string)
Example:
{
"objectAttributeValues": [
{
"value": "IPhone"
}
],
"objectId": 1,
"objectTypeAttributeId": 2
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(number)
- objectTypeAttribute: (object)
The definition of the attribute that is associated with an object type
- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
- objectTypeAttributeId: required(integer)
- objectAttributeValues: required(object)
The actual values of the object attribute. The size of the values array is determined by the cardinality constraints on the object type attribute as well as how many values are associated with the object attribute
- value: (union of string or datetime)
- displayValue: required(string)
The value as displayable text e.g. for a date time attribute this value will be formatted to the user settings
- searchValue: (string)
A value to use when searching for the specific object
- referencedObject: (object)
The same response body as an Insight object
- user: (object)
The Insight user type
- avatarUrl: (string)
- displayName: (string)
- name: (string)
- key: (string)
- emailAddress: (string)
- html: (string)
- renderedLink: (string)
- isDeleted: (boolean)
- lastSeenVersion: (string)
- self: (string)
- group: (object)
The Insight Group type
- avatarUrl: required(string)
- name: required(string)
- confluencePage: (object)
A value that describes a page in a Confluence
- id: required(string)
- title: required(string)
- url: required(string)
- version: (object)
Value describing a version in Jira
- avatarUrl: required(string)
- name: required(string)
- id: required(integer)
- url: required(string)
- project: (object)
Value that represents a Jira project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- status: (object)
An Insight status type that can be associated with objects
- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
- additionalValue: (string)
Example:
{
"id": 6,
"objectTypeAttributeId": 2,
"objectAttributeValues": [
{
"value": "IPhone",
"searchValue": "IPhone",
"displayValue": "IPhone",
"referencedType": false
}
],
"objectId": 1
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
get /objectattribute/{id}
Load a single object attribute
URI Parameters
- id: required(string)
The object attribute id
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(number)
- objectTypeAttribute: (object)
The definition of the attribute that is associated with an object type
- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
- objectTypeAttributeId: required(integer)
- objectAttributeValues: required(object)
The actual values of the object attribute. The size of the values array is determined by the cardinality constraints on the object type attribute as well as how many values are associated with the object attribute
- value: (union of string or datetime)
- displayValue: required(string)
The value as displayable text e.g. for a date time attribute this value will be formatted to the user settings
- searchValue: (string)
A value to use when searching for the specific object
- referencedObject: (object)
The same response body as an Insight object
- user: (object)
The Insight user type
- avatarUrl: (string)
- displayName: (string)
- name: (string)
- key: (string)
- emailAddress: (string)
- html: (string)
- renderedLink: (string)
- isDeleted: (boolean)
- lastSeenVersion: (string)
- self: (string)
- group: (object)
The Insight Group type
- avatarUrl: required(string)
- name: required(string)
- confluencePage: (object)
A value that describes a page in a Confluence
- id: required(string)
- title: required(string)
- url: required(string)
- version: (object)
Value describing a version in Jira
- avatarUrl: required(string)
- name: required(string)
- id: required(integer)
- url: required(string)
- project: (object)
Value that represents a Jira project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- status: (object)
An Insight status type that can be associated with objects
- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
- additionalValue: (string)
Example:
{
"id": 6,
"objectTypeAttributeId": 2,
"objectAttributeValues": [
{
"value": "IPhone",
"searchValue": "IPhone",
"displayValue": "IPhone",
"referencedType": false
}
],
"objectId": 1
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Object Connected Tickets
Relation between Jira issues and Insight objects
get /objectconnectedtickets/{objectId}
URI Parameters
- objectId: required(integer)
The id of the object to get connected tickets for
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- tickets: (array of Ticket)
Items: Ticket
- key: (string)
- id: required(number)
- reporter: required(string)
- created: required(datetime)
- updated: required(datetime)
- title: (string)
- status: (object)
- name: (string)
- description: (string)
- colorName: (string)
- type: required(object)
- name: (string)
- description: (string)
- iconUrl: (string)
- priority: required(object)
- name: (string)
- iconUrl: (string)
- allTicketsQuery: required(string)
A query to find all the connected issues
Example:
{
"tickets": [
{
"key": "PROJ-1",
"id": 10000,
"reporter": "admin",
"created": "2019-11-27T08:16:52.337Z",
"updated": "2019-11-27T08:16:52.337Z",
"title": "This is the Jira Summary of a Task in todo",
"status": {
"name": "To Do",
"colorName": "blue-gray"
},
"type": {
"name": "Task",
"description": "A task that needs to be done.",
"iconUrl": "http://jira/secure/viewavatar?size=xsmall&avatarId=10318&avatarType=issuetype"
},
"priority": {
"name": "Medium",
"iconUrl": "http://jira/images/icons/priorities/medium.svg"
}
}
],
"allTicketsQuery": "cf[10000] = TEST-1"
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Object Schema
Resource to handle manipulation and fetching for object schemas
Resource to find object schemas in Insight
get /objectschema/list
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- objectschemas: required(array of ObjectSchema)
Items: ObjectSchema
- id: required(integer)
- name: required(string)
- objectSchemaKey: required(string)
- description: (string)
- status: (string)
Always 'Ok'
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- objectTypeCount: required(integer)
Example:
{
"objectschemas": [
{
"id": 1,
"name": "Test",
"objectSchemaKey": "TEST",
"status": "Ok",
"created": "2019-11-26T08:05:46.894Z",
"updated": "2019-11-26T08:05:46.894Z",
"objectCount": 2,
"objectTypeCount": 3
}
]
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
post /objectschema/create
Body
Media type: application/json
Type: object
Properties- name: required(string)
- objectSchemaKey: required(string)
- description: (string)
Example:
{
"name": "Computers",
"objectSchemaKey": "COMP",
"description": "The IT department schema"
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- name: required(string)
- objectSchemaKey: required(string)
- description: (string)
- status: (string)
Always 'Ok'
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- objectTypeCount: required(integer)
Example:
{
"id": 2,
"name": "Computers",
"objectSchemaKey": "COMP",
"status": "Ok",
"description": "The IT department schema",
"created": "2019-11-27T11:30:40.810Z",
"updated": "2019-11-27T11:30:40.810Z",
"objectCount": 0,
"objectTypeCount": 0
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
put /objectschema/{id}
URI Parameters
- id: required(integer)
The object schema id
Body
Media type: application/json
Type: object
Properties- name: required(string)
- objectSchemaKey: required(string)
- description: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- name: required(string)
- objectSchemaKey: required(string)
- description: (string)
- status: (string)
Always 'Ok'
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- objectTypeCount: required(integer)
Example:
{
"id": 2,
"name": "Computers",
"objectSchemaKey": "COMP",
"status": "Ok",
"description": "The IT department schema",
"created": "2019-11-27T11:30:40.810Z",
"updated": "2019-11-27T11:30:40.810Z",
"objectCount": 0,
"objectTypeCount": 0
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
get /objectschema/{id}
URI Parameters
- id: required(integer)
The object schema id
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- name: required(string)
- objectSchemaKey: required(string)
- description: (string)
- status: (string)
Always 'Ok'
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- objectTypeCount: required(integer)
Example:
{
"id": 2,
"name": "Computers",
"objectSchemaKey": "COMP",
"status": "Ok",
"description": "The IT department schema",
"created": "2019-11-27T11:30:40.810Z",
"updated": "2019-11-27T11:30:40.810Z",
"objectCount": 0,
"objectTypeCount": 0
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 404
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
delete /objectschema/{id}
Find all object type attributes for this object schema
get /objectschema/{id}/attributes
URI Parameters
- id: required(integer)
The object schema id
Query Parameters
- onlyValueEditable: (boolean - default: false)
Return only values that are associated with values that can be edited
- extended: (boolean - default: false)
Include the object type with each object type attribute
- query: (string - default: "")
A query that will be used to filter object type attributes by their name
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: ObjectTypeAttribute
- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
Example:
[
{
"id": 5,
"name": "Date Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 4,
"name": "Date"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 4
},
{
"id": 6,
"name": "DateTime Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 5
},
{
"id": 7,
"name": "Reference",
"label": false,
"type": 1,
"referenceType": {
"id": 1,
"name": "Dependency",
"description": "Dependency",
"color": "e8f00e",
"url16": "http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16",
"removable": false
},
"referenceObjectTypeId": 1,
"referenceObjectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": -1,
"suffix": "",
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"regexValidation": "",
"iql": "",
"options": "",
"position": 6
},
{
"id": 2,
"name": "Name",
"label": true,
"type": 0,
"description": "The name of the object",
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 1
},
{
"id": 1,
"name": "Key",
"label": false,
"type": 0,
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 0
},
{
"id": 3,
"name": "Created",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 2
},
{
"id": 4,
"name": "Updated",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 3
}
]
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Find all object types for this object schema
get /objectschema/{id}/objecttypes/flat
URI Parameters
- id: required(integer)
The object schema id
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: ObjectType
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
Example:
[
{
"id": 2,
"name": "Computer",
"type": 0,
"icon": {
"id": 71,
"name": "Astronaut",
"url16": "http://jira/rest/insight/1.0/objecttype/2/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/2/icon.png?size=48"
},
"position": 0,
"created": "2019-11-27T11:13:22.889Z",
"updated": "2019-11-27T11:13:22.889Z",
"objectCount": 0,
"parentObjectTypeId": 1,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
{
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
}
]
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Object Type
Resource to handle manipulation and fetching for object types
Update the object type
get /objecttype/{id}
URI Parameters
- id: required(integer)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
Example:
{
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 2,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
}
put /objecttype/{id}
Update the object type
URI Parameters
- id: required(integer)
Body
Media type: application/json
Type: object
Properties- name: required(string)
- description: (string)
- iconId: required(integer)
- objectSchemaId: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- inherited: (boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: (boolean)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
Example:
{
"id": 3,
"name": "Computers",
"type": 0,
"description": "The IT department computers",
"icon": {
"id": 1,
"name": "Delete",
"url16": "http://jira/rest/insight/1.0/objecttype/3/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/3/icon.png?size=48"
},
"position": 1,
"created": "2019-11-27T11:15:00.078Z",
"updated": "2019-11-27T11:17:44.360Z",
"objectCount": 0,
"parentObjectTypeId": 1,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
}
Find all object type attribute for this object type
get /objecttype/{id}/attributes
URI Parameters
- id: required(integer)
Query Parameters
- onlyValueEditable: (boolean - default: false)
- orderByName: (boolean - default: false)
- query: (string - default: "")
- includeValuesExist: (boolean - default: false)
- excludeParentAttributes: (boolean - default: false)
- includeChildren: (boolean - default: false)
- orderByRequired: (boolean - default: false)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: ObjectTypeAttribute
- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
Example:
[
{
"id": 1,
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"name": "Key",
"label": false,
"type": 0,
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 0
},
{
"id": 2,
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"name": "Name",
"label": true,
"type": 0,
"description": "The name of the object",
"defaultType": {
"id": 0,
"name": "Text"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 1
},
{
"id": 3,
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"name": "Created",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 2
},
{
"id": 4,
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"name": "Updated",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": false,
"system": true,
"sortable": true,
"summable": false,
"minimumCardinality": 1,
"maximumCardinality": 1,
"removable": false,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 3
},
{
"id": 5,
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"name": "Date Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 4,
"name": "Date"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 4
},
{
"id": 6,
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"name": "DateTime Attribute",
"label": false,
"type": 0,
"defaultType": {
"id": 6,
"name": "DateTime"
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": 1,
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"options": "",
"position": 5
},
{
"id": 7,
"objectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"name": "Reference",
"label": false,
"type": 1,
"referenceType": {
"id": 1,
"name": "Dependency",
"description": "Dependency",
"color": "e8f00e",
"url16": "http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16",
"removable": false
},
"referenceObjectTypeId": 1,
"referenceObjectType": {
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 0,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
},
"editable": true,
"system": false,
"sortable": true,
"summable": false,
"minimumCardinality": 0,
"maximumCardinality": -1,
"suffix": "",
"removable": true,
"hidden": false,
"includeChildObjectTypes": false,
"uniqueAttribute": false,
"regexValidation": "",
"iql": "",
"options": "",
"position": 6
}
]
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Change position of this object type
post /objecttype/{id}/position
Change position of this object type
URI Parameters
- id: required(integer)
Body
Media type: application/json
Type: object
Properties- toObjectTypeId: (integer)
The desired new parent of the object type
- position: required(integer)
The preffered position
Example:
{
"toObjectTypeId": 2,
"position": 0
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
Example:
{
"id": 1,
"name": "ObjectType",
"type": 0,
"icon": {
"id": 25,
"name": "3D Printer",
"url16": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"
},
"position": 0,
"created": "2019-11-26T08:06:02.891Z",
"updated": "2019-11-26T08:06:02.891Z",
"objectCount": 2,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
post /objecttype/create
Body
Media type: application/json
Type: object
Properties- name: required(string)
- description: (string)
- iconId: required(integer)
- objectSchemaId: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- inherited: (boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: (boolean)
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
Example:
{
"id": 3,
"name": "Computers",
"type": 0,
"description": "The IT department computers",
"icon": {
"id": 1,
"name": "Delete",
"url16": "http://jira/rest/insight/1.0/objecttype/3/icon.png?size=16",
"url48": "http://jira/rest/insight/1.0/objecttype/3/icon.png?size=48"
},
"position": 1,
"created": "2019-11-27T11:15:00.078Z",
"updated": "2019-11-27T11:15:00.078Z",
"objectCount": 0,
"parentObjectTypeId": 1,
"objectSchemaId": 1,
"inherited": false,
"abstractObjectType": false,
"parentObjectTypeInherited": false
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
Object Type Attribute
Resource to handle manipulation and fetching of object type attributes
post /objecttypeattribute/{objectTypeId}
URI Parameters
- objectTypeId: required(integer)
The object type id that has this object type attribute associated with it
Body
Media type: application/json
Type: object
Properties- name: required(string)
- label: (boolean)
- description: (string)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - defaultTypeId: (integer)
Id Description (mandatory if type = Default) -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - typeValue: (string)
It is mandatory for Type = Object reference and should point to the referenced object type id
- typeValueMulti: (array of string)
Valid for Type User. The Jira groups to restrict selection to
- additionalValue: (string)
Valid for Type Url, User, Object and Confluence. For Url (DISABLED, ENABLED), for Object (ReferenceTypeId), for User (SHOW_PROFILE, HIDE_PROFILE), for Confluence (Confluence Space Id). It is mandatory for Type = Object reference
- minimumCardinality: (integer - default: 0)
Valid for Type Email, Select, Object, User, Group, Version and Project
- maximumCardinality: (integer - default: 1)
Valid for Type Email, Select, Object, User, Group, Version and Project
- suffix: (string)
Valid for Integer and Double object type attributes
- includeChildObjectTypes: (boolean)
Valid for Type = Object reference and describes if children object types should be included in the selectable objects as well
- hidden: (boolean)
Hide the object type attributes for Insight Users
- uniqueAttribute: (boolean)
Should the values be unique for object attributes associated with this object type attribute
- summable: (boolean)
Valid for Type Integer and Double. Should a sum be included in the view
- regexValidation: (string)
Valid for Type Text and Email
- iql: (string)
Valid for Type object reference
- options: (string)
Valid for Type Select. A comma separated list of all chosable options
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
put /objecttypeattribute/{objectTypeId}/{id}
URI Parameters
- objectTypeId: required(integer)
The object type id that has this object type attribute associated with it
- id: required(integer)
The object type attribute to manipulate
Body
Media type: application/json
Type: object
Properties- name: (string)
- label: (boolean)
- description: (string)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - defaultTypeId: (integer)
Id Description (mandatory if type = Default) -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - typeValue: (string)
It is mandatory for Type = Object reference and should point to the referenced object type id
- typeValueMulti: (array of string)
Valid for Type User. The Jira groups to restrict selection to
- additionalValue: (string)
Valid for Type Url, User, Object and Confluence. For Url (DISABLED, ENABLED), for Object (ReferenceTypeId), for User (SHOW_PROFILE, HIDE_PROFILE), for Confluence (Confluence Space Id). It is mandatory for Type = Object reference
- minimumCardinality: (integer - default: 0)
Valid for Type Email, Select, Object, User, Group, Version and Project
- maximumCardinality: (integer - default: 1)
Valid for Type Email, Select, Object, User, Group, Version and Project
- suffix: (string)
Valid for Integer and Double object type attributes
- includeChildObjectTypes: (boolean)
Valid for Type = Object reference and describes if children object types should be included in the selectable objects as well
- hidden: (boolean)
Hide the object type attributes for Insight Users
- uniqueAttribute: (boolean)
Should the values be unique for object attributes associated with this object type attribute
- summable: (boolean)
Valid for Type Integer and Double. Should a sum be included in the view
- regexValidation: (string)
Valid for Type Text and Email
- iql: (string)
Valid for Type object reference
- options: (string)
Valid for Type Select. A comma separated list of all chosable options
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- objectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- name: (string)
- label: required(boolean)
- type: required(integer)
Value Description 0 Default 1 Object reference 2 User 3 Confluence 4 Group 5 Version 6 Project 7 Status - description: (string)
- defaultType: required(object)
Id Description -1 None 0 Text 1 Integer 2 Boolean 3 Double 4 Date 5 Time 6 DateTime 7 Url 8 Email 9 Textarea 10 Select 11 IP Address - id: required(integer)
- name: required(string)
- typeValue: (string)
- typeValueMulti: (array of string)
- additionalValue: (string)
- referenceType: (object)
- id: (integer)
- name: required(string)
- description: (string)
- color: (string)
- url16: (string)
- removable: (boolean)
- objectSchemaId: (integer)
- referenceObjectTypeId: (integer)
- referenceObjectType: (object)
The Insight object type
- id: required(integer)
- name: required(string)
- description: (string)
- icon: required(object)
A visual representation of something, usually associated as the icon of an object type
- id: required(integer)
- name: required(string)
- url16: required(string)
A url to the icon to display with small resolution
- url48: required(string)
A url to the icon to display with large resolution
- position: required(integer)
- created: required(datetime)
- updated: required(datetime)
- objectCount: required(integer)
- parentObjectTypeId: (integer)
The id of the parent object type
- objectSchemaId: required(integer)
- inherited: required(boolean)
Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
- abstractObjectType: required(boolean)
- parentObjectTypeInherited: required(boolean)
Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
- confluenceTypeValue: (object)
- id: (string)
- name: (string)
- url: (string)
- error: (boolean)
- confluenceAddValue: (object)
- key: (string)
- name: (string)
- error: (boolean)
- versionTypeValues: (array of Project)
Items: Project
- avatarUrl: required(string)
- id: required(integer)
- name: required(string)
- key: required(string)
- url: required(string)
- editable: (boolean)
- system: (boolean)
- indexed: required(boolean)
Describes if this object type attribute is indexed. For an indexed attribute the IQL search will be faster, but this will affect memory consumption.
- sortable: (boolean)
- summable: (boolean)
- minimumCardinality: (integer)
- maximumCardinality: (integer)
- suffix: required(string)
- removable: (boolean)
- objectAttributeExists: (boolean)
- hidden: (boolean)
- includeChildObjectTypes: (boolean)
- uniqueAttribute: (boolean)
- regexValidation: (boolean)
- iql: required(string)
- options: required(string)
- position: required(integer)
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
delete /objecttypeattribute/{id}
URI Parameters
- id: required(integer)
The object type attribute id to be manipulated
Progress
Show ongoing insight processes
get /progress/category/insight-reindex/reindex
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- progressInPercent: (integer)
- resourceId: (string)
- category: (string)
- status: (string)
- stepDescription: (string)
- currentStep: (integer)
- numberOfSteps: (integer)
- currentWorkUnits: (integer)
- currentWorkDescription: (string)
- currentStepTotalWorkUnits: (integer)
- totalWorkUnits: (integer)
- result: (string)
- resultData: (object)
The result data is different depending on the type of process the category specifies
- resultMessage: (string)
- actor: (string)
The user key of the user that is running the process
- startDate: (datetime)
- finishedDate: (datetime)
- estimatedFinishDate: (datetime)
If it is possible to estimate the comletion of the task this field will be populated
Example:
{
"progressInPercent": 100,
"resourceId": "reindex",
"category": "insight-reindex",
"status": "FINISHED",
"stepDescription": "Re-index Insight",
"currentStep": 1,
"numberOfSteps": 1,
"currentWorkUnits": 23,
"currentStepTotalWorkUnits": 23,
"totalWorkUnits": 23,
"result": "OK",
"resultMessage": "Re-Indexing was successful",
"actor": "admin",
"startDate": "2019-11-27T12:23:54.891Z",
"finishedDate": "2019-11-27T12:23:54.946Z"
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
get /progress/category/imports/{id}
URI Parameters
- id: required(integer)
The id of the import source configuration that the progress should be fetched for
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- progressInPercent: (integer)
- resourceId: (string)
- category: (string)
- status: (string)
- stepDescription: (string)
- currentStep: (integer)
- numberOfSteps: (integer)
- currentWorkUnits: (integer)
- currentWorkDescription: (string)
- currentStepTotalWorkUnits: (integer)
- totalWorkUnits: (integer)
- result: (string)
- resultData: (object)
The result data is different depending on the type of process the category specifies
- resultMessage: (string)
- actor: (string)
The user key of the user that is running the process
- startDate: (datetime)
- finishedDate: (datetime)
- estimatedFinishDate: (datetime)
If it is possible to estimate the comletion of the task this field will be populated
Example:
{
"progressInPercent": 100,
"resourceId": "1",
"category": "imports",
"status": "FINISHED",
"stepDescription": "Updating references on objects",
"currentStep": 6,
"numberOfSteps": 6,
"currentWorkUnits": 0,
"currentStepTotalWorkUnits": 0,
"totalWorkUnits": 0,
"result": "OK",
"resultData": {
"type": "IMPORT",
"started": "2019-11-27T12:52:39.483Z",
"ended": "2019-11-27T12:52:40.092Z",
"executedType": "MANUAL",
"executedAsUser": {
"avatarUrl": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48",
"displayName": "admin",
"name": "admin",
"key": "admin",
"renderedLink": "<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",
"isDeleted": false
},
"objectSchemaId": 1,
"numberOfWorkers": 8,
"executionTimeInMs": "609",
"result": "OK",
"status": "FINISHED",
"importSourceId": 1,
"populatedObjectTypes": [
"CSV Import",
"CSV Import"
],
"moduleKey": "rlabs-import-type-csv",
"moduleVersion": 1,
"onlyExecutedForObjectTypes": [],
"objectTypeResultMap": {
"4": {
"objectTypeName": "CSV Import",
"objectTypeId": 4,
"objectsUpdated": 0,
"objectsCreated": 2,
"objectsCreatedIQL": "Key IN (\"TEST-3\",\"TEST-4\")",
"objectsIdentical": 0,
"objectsMissingUpdated": 0,
"objectsMissingDeleted": 0,
"entriesInSource": 2,
"duplicateEnries": 0,
"emptyLabelEntries": 0,
"emptyExternalIdEntries": 0,
"objectsFilteredWithIQL": 0,
"readExternalDataTimeInMs": 13,
"writeInsightDataTimeInMs": 70,
"postFunctionTimeInMs": 2,
"mapExternalDataTimeInMs": 0,
"iqlFilteringTimeInMs": 0,
"decidingActionsTimeInMs": 4,
"executionTimeInMs": 89,
"objectsWithUpdatedReferences": 0,
"errorCount": 0
}
},
"updateReferencesTimeInMs": 0,
"errorCount": 0
},
"resultMessage": "Import finished ok.",
"actor": "admin",
"startDate": "2019-11-27T12:52:39.475Z",
"finishedDate": "2019-11-27T12:52:40.116Z"
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
QR Code
get /qrcode/object/{objectId}/code.png
URI Parameters
- objectId: required(string)
Query Parameters
- size: (integer - default: 200)
Status
Handle the Insight statuses
get /config/statustype
Query Parameters
- objectSchemaId: (integer)
Include statuses for the object schema id. If supplied statuses for the object schema will be returned otherwise all global will be returned
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: Status
- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
Example:
[
{
"id": 5,
"name": "Action Needed",
"category": 2
},
{
"id": 1,
"name": "Active",
"category": 1
},
{
"id": 7,
"name": "Closed",
"category": 0
},
{
"id": 3,
"name": "In Service",
"category": 2
},
{
"id": 2,
"name": "Running",
"category": 1
},
{
"id": 6,
"name": "Stopped",
"category": 0
},
{
"id": 4,
"name": "Support Requested",
"category": 2
}
]
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
post /config/statustype
Body
Media type: application/json
Type: object
Properties- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
Example:
{
"name": "My action",
"category": 2
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
Example:
{
"id": 5,
"name": "Action Needed",
"category": 2
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
get /config/statustype/{id}
URI Parameters
- id: required(integer)
Status type id
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
Example:
{
"id": 5,
"name": "Action Needed",
"category": 2
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.
put /config/statustype/{id}
URI Parameters
- id: required(integer)
Status type id
Body
Media type: application/json
Type: object
Properties- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
Example:
{
"name": "My action",
"category": 2
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(integer)
- name: required(string)
- description: (string)
- category: required(integer)
Name Value Color ACTIVE 1 Green INACTIVE 0 Red PENDING 2 Yellow - objectSchemaId: required(integer)
Example:
{
"id": 5,
"name": "Action Needed",
"category": 2
}
HTTP status code 401
Client must be authenticated to access this resource.
HTTP status code 404
The icon was not found
HTTP status code 500
Something went wrong. Please try again later. If the error persists, contact our support team.