Insight REST-API
This is the reference document for the REST-API and resources provided by Insight. The REST-APIs are for developers who want to integrate Insight with other standalone or web applications, and administrators who want to script interactions with Insight on the JIRA server. Because the REST API is based on open standards, you can use any web development language to access the API.
Structure of the REST URIs
Insight REST-API provides access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The Insight REST API uses JSON as its communication format, and the standard HTTP methods like GET, PUT, POST and DELETE (see API descriptions below for which methods are available for each resource). URIs for Insight REST API resource have the following structure:
http://host:port/context/rest/insight/api-version/resource-name
The API version is 1.0
Authentication
Any authentication that works against JIRA will work against the Insight REST API.
Content Type
Don't forget to use "Content-Type: application/json" in http header when sending data to the Insight REST-API's.
The api calls: https://insight-javadoc.riada.io/insight-javadoc-8.6/insight-rest/#objectattribute
Jira api with Insight
Create Issue
URI: /rest/api/2/issue
As you can see below, you will have to use the key attribute to define the Insight object keys, when creating Issues with Insight custom field values.
{
"fields": {
"project":
{
"key": "TEST"
},
"summary": "REST ye merry gentlemen.",
"description": "Creating of an issue using project keys and issue type names using the REST API",
"issuetype": {
"name": "Task"
},
"customfield_10100" : [{"key" : "TEST-1"}],
"customfield_10200" : [{"key" : "TEST-1"}, {"key" : "TEST-2"}]
}
}
Update issue
URI: /rest/api/2/issue/[issueKey]
This is an example of setting an Insight object to a specific Insight custom field. Use the attribute set to define the Insight object keys
{
"update" : {
"customfield_10200" : [{"set": [{"key" : "TEST-1"}]}]
}
}
This is an example of adding an Insight object to the existing connected ones. Use the attribute add to define the Insight object keys
{
"update" : {
"customfield_10200" : [{"add": [{"key" : "TEST-2"},{"key" : "TEST-3"}]}]
}
}
This is an example of removing an Insight object from the existing connected ones. Use the attribute remove to define the Insight object keys
{
"update" : {
"customfield_10200" : [{"remove": [{"key" : "TEST-2"}]}]
}
}
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.