DATA CENTER AND SERVER | CLOUD

REST API: Baselines

Owned by Support Advocate (ease solutions)
Last updated: Jan 07, 2022 by Angelica SalazarVersion comment
5 min read
GETcom.easesolutions.jira.plugins.requirements/1.0/baseline/idGet detailed information for a given baseline.
GETcom.easesolutions.jira.plugins.requirements/1.0/baselinesGet all existing baselines.
GETcom.easesolutions.jira.plugins.requirements/1.0/baselines/project/prjKey

Get all baselines for a given project.

POSTcom.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/baselineCreate a new baseline on the project's root folder.
POSTcom.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/baseline/idCreate a new baseline on a given folder of a project.
POSTcom.easesolutions.jira.plugins.requirements/1.0/baseline/prjKey

Create a baseline using a valid JQL query string.

GET

com.easesolutions.jira.plugins.requirements/1.0/baseline/id/signatures

4.2.0 Get signatures from a baseline.
DELETEcom.easesolutions.jira.plugins.requirements/1.0/baseline/delete/baselineId4.2.0 Delete a single baseline.


com.easesolutions.jira.plugins.requirements/1.0/baseline/id

Get detailed information for a given baseline.

The "prjKey" object may not be part of the result if the corresponding project was deleted.
Also the "id" value may not be available for some issues. 

 Click here for details...
REQUEST
GET
/rest/com.easesolutions.jira.plugins.requirements/1.0/baseline/id


PARAMETERS
parametertypedescription
id*stringthe ID of the baseline


RESPONSES

STATUS 200 - Returned if the baseline is found

Example Response
{
  "id": 1,
  "name": "test",
  "description": "Lorem Ipsum",
  "prjKey": "TEST",
  "created": 1552367261283,
  "userId": "admin",
  "issues": [
    {
      "id": 10000,
      "key": "TEST-1",
      "fields": [
        { "id": "summary", "name": "Summary", "values": ["test"] },
        { "id": "issuetype", "name": "Issue Type", "values": ["Customer Requirement"] },
        { "id": "priority", "name": "Priority", "values": ["Medium"] },
        { "id": "reporter", "name": "Reporter", "values": ["admin"] },
        { "id": "description", "name": "Description", "values": ["ttest"] },
        { "id": "created", "name": "Created", "values": ["2019-03-12 13:04:30"] },
        { "id": "issuekey", "name": "Key", "values": ["TEST-1"] },
        { "id": "path", "name": "Path", "values": ["test/test"] },
        { "id": "project", "name": "Project", "values": ["test"] },
        { "id": "status", "name": "Status", "values": ["Open"] }
      ]
    }
  ],
  "status": "CREATED | CREATING | CREATION_FAILED"
}

STATUS 400 - Returned if the baseline is invalid or a general baseline operation failure occurs

STATUS 401 - Returned if invalid user credentials, or the user has no permission

STATUS 403 - Returned if the license is invalid or has expired, or incompatible JIRA version


com.easesolutions.jira.plugins.requirements/1.0/baselines

Get all existing baselines.

 Click here for details...
REQUEST
GET
/rest/com.easesolutions.jira.plugins.requirements/1.0/baselines


RESPONSES

STATUS 200 - Returned if a baseline is found

Example Response
[
  	{
    	"id": 17,
    	"name": "Test_BL",
    	"description": "My_Description",
    	"prjKey": "AN",
    	"created": 1444820108730,
    	"userId": "admin",
  		"status": "CREATED"
  	},
  	{
    	"id": 16,
    	"name": "another one",
    	"description": "",
		"created": 1444742408837,
    	"userId": "admin",
  		"status": "CREATING"
  	},
  	{
    	"id": 15,
    	"name": "via rest",
    	"description": "via rest desc",
    	"prjKey": "AN",
    	"created": 1444735257980,
    	"userId": "admin",
  		"status": "CREATION_FAILED"
	},
]

STATUS 400 - Returned if a general baseline operation failure occurs

STATUS 401 - Returned if invalid user credentials, or the user has no permission

STATUS 403 - Returned if the license is invalid or has expired, or incompatible JIRA version



com.easesolutions.jira.plugins.requirements/1.0/baselines/project/prjKey

Get all baselines for a given project.

 Click here for details...
REQUEST
GET
/rest/com.easesolutions.jira.plugins.requirements/1.0/baselines/project/prjKey


PARAMETERS
parametertypedescription
prjKey*stringthe project key


RESPONSES

STATUS 200 - Returned if a baseline is found

Example Response
[
  	{
    	"id": 17,
    	"name": "Test_BL",
    	"description": "My_Description",
    	"prjKey": "AN",
    	"created": 1444820108730,
    	"userId": "admin",
 		 "status": "CREATED | CREATING | CREATION_FAILED"
  	},
  	{
    	"id": 15,
    	"name": "via rest",
    	"description": "via rest desc",
    	"prjKey": "AN",
    	"created": 1444735257980,
    	"userId": "admin",
  		"status": "CREATED | CREATING | CREATION_FAILED"
	},
]

STATUS 400 - Returned if a general baseline operation failure occurs

STATUS 401 - Returned if the project is invalid, invalid user credentials, or the user has no permission

STATUS 403 - Returned if the license is invalid or has expired, or incompatible JIRA version


com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/baseline

Create a new baseline on the projects root folder. 

It is possible to generate an empty baseline with this endpoint.


 Click here for details...
REQUEST
POST
/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/baseline?name&description


PARAMETERS
parametertypedescription
prjKey*stringthe project key
name*stringname of the new baseline
descriptionstringoptional description of the new baseline


RESPONSES

STATUS 200 - Returned if a baseline is created

Example Response
{
  	"id": 17,
  	"name": "Test_BL",
  	"description":
	"My_Description",
  	"prjKey": "AN",
  	"created": 1444820108731,
  	"userId": "admin",
  	"status": "CREATED | CREATING | CREATION_FAILED"
}

STATUS 400 - Returned if the project is invalid, the name has invalid length or already exists, the description has invalid length, the baseline has no items, or a general baseline operation failure occurs

STATUS 401 - Returned if invalid user credentials, or the user has no permission

STATUS 403 - Returned if the license is invalid or has expired, or incompatible JIRA version


com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/baseline/id

Create a new baseline on a given folder of a project.

It is possible to generate an empty baseline with this endpoint.

 Click here for details...
REQUEST
POST
/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/baseline/id?name&description


PARAMETERS
parametertypedescription
prjKey*stringthe project key
id*stringthe ID of the folder to create the baseline on
name*stringname of the new baseline
descriptionstringoptional description of the new baseline


RESPONSES

STATUS 200 - Returned if a baseline is created

Example Response
{
  	"id": 17,
  	"name": "Test_BL",
  	"description": "My_Description",
  	"prjKey": "AN",
  	"created": 1444820108731,
  	"userId": "admin",
  	"status": "CREATED | CREATING | CREATION_FAILED"
} 

STATUS 400 - Returned if the project is invalid, the folder is invalid, the name has invalid length or already exists, the description has invalid length, the baseline has no items, or a general baseline operation failure occurs

STATUS 401 - Returned if invalid user credentials, or the user has no permission

STATUS 403 - Returned if the license is invalid or has expired, or incompatible JIRA version

com.easesolutions.jira.plugins.requirements/1.0/baseline/prjKey

Create a baseline using a valid JQL query string.

 Click here for details...
REQUEST
POST
/rest/com.easesolutions.jira.plugins.requirements/1.0/baseline/prjKey?name&description&jqlQuery


PARAMETERS
parametertypedescription
prjKey*stringthe project key
name*stringname of the baseline to be created
descriptionstringoptional description of the baseline to be created
jqlQuery*stringjqlQuery string for the baseline to be created


RESPONSES

STATUS 200 - Returned if a baseline is created

Example Response
{
  	"id": 1,
  	"name": "Test_Filtered_BL",
  	"description": "My_Description",
  	"prjKey": "AN",
  	"created": 1444820108731,
  	"userId": "admin",
  	"status": "CREATED | CREATING | CREATION_FAILED"
} 

STATUS 400 - Returned if the project is invalid, the folder is invalid, the name has invalid length or already exists, the description has invalid length, the baseline has no items, the jql query is invalid or a general baseline operation failure occurs

STATUS 401 - Returned if invalid user credentials, or the user has no permission

STATUS 403 - Returned if the license is invalid or has expired, or incompatible JIRA version

com.easesolutions.jira.plugins.requirements/1.0/baseline/id/signatures

Get signatures from a baseline.

 Click here for details...
REQUEST
GET
/rest/com.easesolutions.jira.plugins.requirements/1.0/baseline/id/signatures


PARAMETERS
parametertypedescription
id*stringthe ID of the baseline


RESPONSES

STATUS 200 - Returned if the baseline id is valid

Example Response
[
  {
    "id": 1,
    "userKey": "user",
    "userUrl": "https://devdc.easesolutions.com/jira/secure/ViewProfile.jspa?name=user",
    "userName": "user",
    "comment": "Approved.",
    "signDate": "2019-11-04 11:02"
  }
]

STATUS 400 - Returned if the baseline is invalid or a general baseline operation failure occurs

STATUS 401 - Returned if invalid user credentials, or the user has no permission

STATUS 403 - Returned if the license is invalid or has expired, or incompatible JIRA version

com.easesolutions.jira.plugins.requirements/1.0/baseline/delete/baselineId

Delete a single baseline.

 Click here for details...
REQUEST
DELETE
/rest/com.easesolutions.jira.plugins.requirements/1.0/baseline/delete/baselineId


PARAMETERS
parametertypedescription
baselineId*longthe ID of the baseline


RESPONSES

STATUS 200 - Returned if the baseline is deleted

Example Response
Baseline <baseline_name> with id <baseline_id> has been deleted!

STATUS 400 - Returned if the baseline is invalid or a general baseline operation failure occurs

STATUS 401 - Returned if invalid user credentials, or the user has no permission

STATUS 403 - Returned if the license is invalid or has expired, or incompatible JIRA version