Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: R4J 4.6.1: Added "status" property in baseline object responses


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

Status
title4.2.0
 
Get signatures from a baseline.
DELETEcom.easesolutions.jira.plugins.requirements/1.0/baseline/delete/baselineId
Status
title4.2.0
 
Delete a single baseline.

...

Panel
titleColor#FFFFFF
titleBGColor#6c809a
titlecom.easesolutions.jira.plugins.requirements/1.0/baseline/id

Get detailed information for a given baseline.

Note

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. 


Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
GET

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



PARAMETERS
parametertypedescription
id*stringthe ID of the baseline



RESPONSES

Status
colourGreen
titleSTATUS 200
- Returned if the baseline is found

Code Block
languagejava
titleExample 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
colourRed
titleSTATUS 400
- Returned if the baseline is invalid or a general baseline operation failure occurs

Status
colourRed
titleSTATUS 401
- Returned if invalid user credentials, or the user has no permission

Status
colourRed
titleSTATUS 403
- Returned if the license is invalid or has expired, or incompatible JIRA version


...

Panel
titleColor#FFFFFF
titleBGColor#6c809a
titlecom.easesolutions.jira.plugins.requirements/1.0/baselines

Get all existing baselines.

Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
GET

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



RESPONSES

Status
colourGreen
titleSTATUS 200
- Returned if a baseline is found

Code Block
languagejava
titleExample 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
colourRed
titleSTATUS 400
- Returned if a general baseline operation failure occurs

Status
colourRed
titleSTATUS 401
- Returned if invalid user credentials, or the user has no permission

Status
colourRed
titleSTATUS 403
- Returned if the license is invalid or has expired, or incompatible JIRA version


...

Panel
titleColor#FFFFFF
titleBGColor#6c809a
titlecom.easesolutions.jira.plugins.requirements/1.0/baselines/project/prjKey

Get all baselines for a given project.

Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
GET

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



PARAMETERS
parametertypedescription
prjKey*stringthe project key



RESPONSES

Status
colourGreen
titleSTATUS 200
- Returned if a baseline is found

Code Block
languagejava
titleExample 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
colourRed
titleSTATUS 400
 - Returned if a general baseline operation failure occurs

Status
colourRed
titleSTATUS 401
- Returned if the project is invalid, invalid user credentials, or the user has no permission

Status
colourRed
titleSTATUS 403
- Returned if the license is invalid or has expired, or incompatible JIRA version


...

Panel
titleColor#FFFFFF
titleBGColor#6c809a
titlecom.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/baseline

Create a new baseline on the projects root folder. 

Info

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


Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
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
colourGreen
titleSTATUS 200
- Returned if a baseline is created

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

Status
colourRed
titleSTATUS 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
colourRed
titleSTATUS 401
- Returned if invalid user credentials, or the user has no permission

Status
colourRed
titleSTATUS 403
- Returned if the license is invalid or has expired, or incompatible JIRA version


...

Panel
titleColor#FFFFFF
titleBGColor#6c809a
titlecom.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/baseline/id

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

Info

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


Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
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
colourGreen
titleSTATUS 200
- Returned if a baseline is created

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

Status
colourRed
titleSTATUS 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
colourRed
titleSTATUS 401
- Returned if invalid user credentials, or the user has no permission

Status
colourRed
titleSTATUS 403
- Returned if the license is invalid or has expired, or incompatible JIRA version


...

Panel
titleColor#FFFFFF
titleBGColor#6c809a
titlecom.easesolutions.jira.plugins.requirements/1.0/baseline/prjKey

Create a baseline using a valid JQL query string.

Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
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
colourGreen
titleSTATUS 200
- Returned if a baseline is created

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

Status
colourRed
titleSTATUS 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
colourRed
titleSTATUS 401
- Returned if invalid user credentials, or the user has no permission

Status
colourRed
titleSTATUS 403
- Returned if the license is invalid or has expired, or incompatible JIRA version


...

Panel
titleColor#FFFFFF
titleBGColor#6c809a
titlecom.easesolutions.jira.plugins.requirements/1.0/baseline/id/signatures

Get signatures from a baseline.

Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
GET

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



PARAMETERS
parametertypedescription
id*stringthe ID of the baseline



RESPONSES

Status
colourGreen
titleSTATUS 200
- Returned if the baseline id is valid

Code Block
languagejava
titleExample 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
colourRed
titleSTATUS 400
- Returned if the baseline is invalid or a general baseline operation failure occurs

Status
colourRed
titleSTATUS 401
- Returned if invalid user credentials, or the user has no permission

Status
colourRed
titleSTATUS 403
- Returned if the license is invalid or has expired, or incompatible JIRA version


...

Panel
titleColor#FFFFFF
titleBGColor#6c809a
titlecom.easesolutions.jira.plugins.requirements/1.0/baseline/delete/baselineId

Delete a single baseline.

Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
DELETE

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



PARAMETERS
parametertypedescription
baselineId*longthe ID of the baseline



RESPONSES

Status
colourGreen
titleSTATUS 200
- Returned if the baseline is deleted

Code Block
languagejava
titleExample Response
Baseline <baseline_name> with id <baseline_id> has been deleted!

Status
colourRed
titleSTATUS 400
- Returned if the baseline is invalid or a general baseline operation failure occurs

Status
colourRed
titleSTATUS 401
- Returned if invalid user credentials, or the user has no permission

Status
colourRed
titleSTATUS 403
- Returned if the license is invalid or has expired, or incompatible JIRA version


...