Insight Objects are the asset that you want to control in Insight and is stored in Object Types - REST

Create Object

Resource to create object in Insight.

/rest/insight/1.0/object/create

Methods: POST

Parameter
Type
Description
objectTypeIdintThe ID of the Object Type
attributesListList of Object Attribute

Object Attribute

Field
Type
Description
objectTypeAttributeIdintThe id of the Object Type Attribute
objectAttributeValuesListList of Object Attribute Value

Object Attribute Value

Field
Type
Description
valueStringThe value that correspond to the specific Object Type Attribute


Example JSON:

{
    "objectTypeId": 1,
    "attributes": [{
        "objectTypeAttributeId": 1,
        "objectAttributeValues": [{
            "value": "Hello"
        }]
    }]
}

Example on setting a name to "Hello" where Name attribute has id: 1 and object type id: 1


Depending on the Object Type Attribute corresponding to this Object Attribute, the value differs.

TypeDescription
DefaultThe value must validate on the additional type, like Text, Integer, URL, Email etc.
ObjectThe value is the Object Key to set
UserThe value is the JIRA User key to set
ConfluenceThe value is the Page ID in confluence.
VersionThe value is the Version ID in JIRA
ProjectThe value is the Project ID in JIRA
StatusThe value is the Status ID in Insight

Update Object

Resource to update an object in Insight.

/rest/insight/1.0/object/{id}

PathParam
Type
Description
idintThe id of the object to update


Methods: PUT

Parameter
Type
Description
attributesListList of Object Attribute

Object Attribute

Field
Type
Description
objectTypeAttributeIdintThe id of the Object Type Attribute
objectAttributeValuesListList of Object Attribute Value

Object Attribute Value

Field
Type
Description
valueStringThe value that correspond to the specific Object Type Attribute


Example JSON:

{
    "attributes": [{
        "objectTypeAttributeId": 1,
        "objectAttributeValues": [{
            "value": "Hello"
        }]
    }]
}

Example on setting a name to "Hello" where Name attribute has id: 1 and object type id: 1


{
    "objectTypeId": 1,
    "attributes": [{
        "objectTypeAttributeId": 1,
        "objectAttributeValues": [{
            "value": "userKey1"
        },{
            "value": "userKey2"
        }]
    }]
}

Example on setting a User attribute to 2 users (cardinality multiple) where the User attribute has id: 1 and object type id: 1


Depending on the Object Type Attribute corresponding to this Object Attribute, the value differs.

TypeDescription
DefaultThe value must validate on the additional type, like Text, Integer, URL, Email etc.
ObjectThe value is the Object Key to set
UserThe value is the JIRA User key to set
ConfluenceThe value is the Page ID in confluence.
VersionThe value is the Version ID in JIRA
ProjectThe value is the Project ID in JIRA
StatusThe value is the Status ID in Insight


Load

Resource to load an object in Insight.

/rest/insight/1.0/object/{id}

Method: GET

Output: Object

Object

Field
Type
Description
idintThe id
nameStringThe name
objectKeyintThe object key
avatarAvatarThe avatar
objectTypeObjectTypeThe Object Type
objectSchemaObjectSchemaThe Object Schema
createdStringThe created date
updatedStringThe updated date
hasAvatarbooleanIf avatar is set

attributes

List<ObjectAttribute>

The attributes of the object.


Find objects

Resource to find objects in Insight.

/rest/insight/1.0/objecttype/{id}/objects

Methods: GET

Parameter
Type
Description

query

StringThe query string is a simple text match against the start of the name string.

start

intThe start index (0..N)
limitintThe number of objects to fetch
includeChildrenBooleanIf children objects should be included

Find objects (Advanced)

Resource to find objects in Insight filtering on any attribute

/rest/insight/1.0/object/navlist/iql

Methods: POST

Parameter
Type
Description
Mandatory
pageintThe page to fetch. (1..N)
No
ascintAscending or descending, asc = 1, desc = 0No
objectTypeIdintThe id of the Object Type to search objects from.Yes
objectIdintSet the page to the page where this object is shownNo
objectSchemaIdintThe id of the Object Schema to search fromYes
iqlStringAn valid IQL string to filter the returned objectsNo
resultsPerPageintThe number of objects to fetchYes
orderByTypeAttrIdintThe id of the attribute to sort the Objects fromNo
includeAttributesbooleanIf object attributes should be includedNo


Example JSON:

{
  	"objectTypeId": "9158",
	"page": 1,
	"asc": "1",
	"orderByTypeAttrId": "71947",
	"resultsPerPage": 25,
	"includeAttributes": true,
	"iql": "Name is not empty",
	"objectSchemaId": "2667"
}

Advanced Filtering

You may filter on referenced values from another object type. Let say, you have a "Company" and an "Employee" object type. You have an attribute type "Company" in the object type "Employee" and "Continent" on the "Company" object type. 

If you now want to filter on employees that works in a company within Europe. This is an example:

Example JSON:

{
	"objectTypeId": "9158",
	"page": 1,
	"asc": "1",
	"orderByTypeAttrId": "71947",
	"resultsPerPage": 25,
	"includeAttributes": true,
	"iql": "Company.Continent = Europe",
	"objectSchemaId": "2667"
}
 


Output:

ObjectListResultEntry

Field
Type
Description
objectEntriesListList of Object
objectTypeAttributesListList of ObjectTypeAttribute

objectTypeId

itnThe Object Type id
objectTypeIsInheritedbooleanIs the object type in an inheritance structure
totalFilterCountintTotal number of objects in filter
totalCountintTotal number of objects
startIndexintStart index
toIndexintTo index
pageObjectSizeintNumber of returned objects

orderByTypeAttrId

Integerorder by ObjectTypeAttribute id

orderWay

String"asc" or "desc"
filtersListList of ObjectFilterValueEntry
iqlStringThe IQL used for the search
iqlSearchResultbooleanWas IQL used for searching
conversionPossiblebooleanIndicates of the IQL can be converted to an Filter and vice versa
matchedFilterValuesListList of ObjectAttributeEntry
inheritanceTreeListList of ObjectFilterValuesEntry

Delete

Resource to delete an object in Insight.

/rest/insight/1.0/object/{id}

Method: DELETE


Object history

Resource to find all history for an object in Insight.

/rest/insight/1.0/object/{id}/history

Method: GET

Output: List of History

History

Field
Type
Description
idintThe id
affectedAttributeStringThe afffected attribute name
newValueStringThe new value
actorUserKeyStringThe JIRA User key of actor
typeintThe type
createdStringThe created date
updatedStringThe updated date
objectIdintThe object id


Object Inbound References

Resource to find all history for an object in Insight.

/rest/insight/1.0/object/{id}/references

Method: GET

Optional query params:

Field
Type
Description
startIntegerThe start index to fetch
limitIntegerThis number of references to fetch
orderTypeIntegerThe order type (0, 1, 2)
orderWayString"desc" or "asc"


Example:

/rest/insight/1.0/object/{id}/references?start=0&limit=25


Output: List of References

Reference

Field
Type
Description
objectObjectThis is the Object referenced
objectTypeAttributeObjectTypeAttributeThis is the object type attribute for the referenced object


Connected JIRA issues

Resource to find all connected JIRA issues for an object in Insight.

/rest/insight/1.0/object/{id}/jiraissues

Method: GET

Output: JIRAIssueDetail

JIRAIssueDetails

Field
Type
Description
jiraIssuesListList of JIRAIssue
allIssuesQueryStringThe URL to get all Issues in JIRA

JIRAIssue

Field
Type
Description
jiraIssueKeyStringThe JIRA Issue key