Page Comparison

GET	com.easesolutions.jira.plugins.requirements/1.0/projects	Get all projects enabled in Requirements
POST	com.easesolutions.jira.plugins.requirements/1.0/projects/enable/prjKey	Enable a project in Requirements
POST	com.easesolutions.jira.plugins.requirements/1.0/projects/disable/prjKey	Disable a project in Requirements
POST	com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfiguration	Trigger saving a suspect configuration.
GET	com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfigurations	Returns all suspect configuration in project.
PUT	com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfiguration

Trigger saving

/id	Trigger editing a suspect configuration.
DELETE	com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfiguration/id	Trigger deleting a suspect configuration.

Anchor

	1
	1

Panel

titleColor	#FFFFFF
titleBGColor	#6c809a
title	com.easesolutions.jira.plugins.requirements/1.0/projects

Get all projects enabled in Requirements.

Expand

title	Click here for details...

REQUEST

Panel

bgColor	#f6f5f5

POST

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

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if the project is successfully enabled

Code Block

language	java
title	Example response

[
  {
    "prjID": 10000,
    "prjKey": "TP",
    "prjName": "Test Project"
  }
]

Status


colour	Red
title	STATUS 400

- Returned if an error occurs while retrieving all enabled projects in Requirements

Status

colour	Red
title	STATUS 401

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

Status

colour	Red
title	STATUS 403

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

Anchor

	2
	2

Panel

titleColor	#FFFFFF
titleBGColor	#6c809a
title	com.easesolutions.jira.plugins.requirements/1.0/projects/enable/prjKey

Enable a project in Requirements.

Expand

title	Click here for details...

REQUEST

Panel

bgColor	#f6f5f5

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/projects/enable/prjKey

PARAMETERS

parameter	type	description
prjKey*	string	The project key of the project to be enabled.

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if the project is successfully enabled

Code Block

language	java
title	Example response

{ 
	"prjKey": "SC", 
	"prjName": "Sand Castle", 
	"issueCount": 34, 
	"success": true 
}

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid or an error occurs while activating the project

Status

colour	Red
title	STATUS 401

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

Status

colour	Red
title	STATUS 403

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

...

Panel

titleColor	#FFFFFF
titleBGColor	#6c809a
title	com.easesolutions.jira.plugins.requirements/1.0/projects/disable/prjKey

Disable a project in Requirements.

Expand

title	Click here for details...

REQUEST

Panel

bgColor	#f6f5f5

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/projects/disable/prjKey

PARAMETERS

parameter	type	description
prjKey*	string	The project key of the project to be disabled.

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if the project is sucessfully disabled

Code Block

language	java
title	Example Response

{
  "prjKey": "SC",
  "prjName": "Sand Castle",
  "issueCount": 34,
  "success": true
}

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid or an error occurs while disabling the project

Status

colour	Red
title	STATUS 401

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

Status

colour	Red
title	STATUS 403

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

...

Panel

titleColor	#FFFFFF
titleBGColor	#6c809a
title	com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfiguration

Trigger saving a suspect configuration.

Expand

title	Click here for details...

REQUEST

Panel

bgColor	#f6f5f5

PUT

All link type

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfiguration?fieldList&useAllLinkTypes&scope&notifyAssignee&notifyReporter&notifyProjectLead&notifyUserList

By link type id

Sample request data JSON:
{
"configName": "testName",
"notifyAssignee": false,
"notifyReporter": false,
"notifyProjectLead": false,
"userKeys": ["admin", "user1"],
"linkTypeIds":["10002", "10003"],
"useAllLinktypes":false,
"suspectConfigItems":[
{
"field": "assignee",
"stream":"up"
},
{
"field": "customfield_10003",
"stream": "up"
}],
"scope":"up"
}


configName (string): The suspect configuration name
notifyAssignee (boolean): True to notify assignee, otherwise false
notifyReporter (boolean): True to notify reporter, otherwise false
notifyProjectLead (boolean): True to notify project lead, otherwise false
userKeys (string array): The list of user ids to be notified
linkTypeIds (string array): The list of link type ids. Possible values are: -1(All), 10000(Blocks), 10001(Clones), 10002(Duplicate) and/or 10003(Relates)
useAllLinktypes (boolean): True if use all link types, otherwise false
suspectConfigItems (object array): The list of fields that trigger a suspect
     field (string): The field id
     stream (string): The scope of the configuration. It must have the same value with "scope"
scope (string): The scope of the configuration. Possible values are: "up", "down" or "both"

PARAMETERS

parameter	type	description
prjKey*	string	The project key to be configured.
data	object	The JSON object of suspect configuration data. Please refer above for the example and properties definition.

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if suspect configuration is successfully saved.

Code Block

language	java
title	Example Response

Suspect Configuration saved for SC

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, scope is invalid, link type id is invalid, list of users is invalid or contains an invalid user key, or list of fields is invalid or contains an invalid field

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use the Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create suspect configuration

Status


colour	Red
title	STATUS 404

- Returned if the project is not found

Status

colour	Red
title	STATUS 500

- Returned if an error occurs while creating suspect configuration

Anchor

	8
	8

Panel

titleColor	#FFFFFF
titleBGColor	#6c809a
title	com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfigurations

Returns all suspect configuration in project.

The list of users to be notified, separated by comma

Expand

REQUEST

Panel

GET

/rest/com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfiguration?fieldList&linkTypeIds&scope&notifyAssignee&notifyReporter&notifyProjectLead&notifyUserListsuspectconfigurations

PARAMETERS

parameter	type	description
prjKey*	string	The project key to be configured.

fieldList string The list of fields. For custom fields, the custom field id must be provided.

useAllLinkTypes boolean true if all link types will be configured. Link type id param is ignored if set to true.

linkTypeIds string The list of link type ids, separated by comma. Possible values are: -1 (ALL), 10000 (blocks), 10001 (clones), 10002 (duplicate) and/or 10003 (relates)

scope string The scope of the configuration (Valid values are either "down" or "both")

notifyAssignee boolean true if assignee should be notified, false or leave blank if otherwise

notifyReporter boolean true if reporter should be notified, false or leave blank if otherwise

notifyProjectLead boolean true if project lead should be notified, false or leave blank if otherwise

notifyUserList string

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if suspect configuration is successfully deleted.

Code Block

language	java
title	Example Response

[
  {
    "configId": 1,
    "configName": "name 1",
    "projectId": 10001,
    "notifyAssignee": true,
    "notifyReporter": true,
    "notifyProjectLead": true,
    "userKeys": [],
    "linkTypeIds": [],
    "useAllLinktypes": true,
    "suspectConfigItems": [
      {
        "stream": "both",
        "field": "  <all fields>"
      }
    ],
    "scope": "both"
  }
]

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid.

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use the Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create suspect configuration

Status


colour	Red
title	STATUS 404

- Returned if the project is not found

Status

colour	Red
title	STATUS 500

- Returned if an error occurs while retrieving all suspect configuration

Anchor

	6
	6

Panel

titleColor	#FFFFFF
titleBGColor	#6c809a
title	com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfiguration/id

Trigger editing a suspect configuration.

Expand

REQUEST

Panel

PUT

/rest/com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfiguration/id

Sample request data JSON:
{
"configName": "testName",
"notifyAssignee": false,
"notifyReporter": false,
"notifyProjectLead": false,
"userKeys": ["admin", "user1"],
"linkTypeIds":["10002", "10003"],
"useAllLinktypes":false,
"suspectConfigItems":[
{
"field": "assignee",
"stream":"up"
},
{
"field": "customfield_10003",
"stream": "up"
}],
"scope":"up"
}


configName (string): The suspect configuration name
notifyAssignee (boolean): True to notify assignee, otherwise false
notifyReporter (boolean): True to notify reporter, otherwise false
notifyProjectLead (boolean): True to notify project lead, otherwise false
userKeys (string array): The list of user ids to be notified
linkTypeIds (string array): The list of link type ids. Possible values are: -1(All), 10000(Blocks), 10001(Clones), 10002(Duplicate) and/or 10003(Relates)
useAllLinktypes (boolean): True if use all link types, otherwise false
suspectConfigItems (object array): The list of fields that trigger a suspect
     field (string): The field id
     stream (string): The scope of the configuration. It must have the same value with "scope"
scope (string): The scope of the configuration. Possible values are: "up", "down" or "both"

PARAMETERS

parameter	type	description
prjKey*	string	The project key to be configured.
id*	string	The suspect configuration id.
data	object	The JSON object of suspect configuration data. Please refer above for the example and properties definition.

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if suspect configuration is successfully udpated.

Code Block

language	java
title	Example Response

Suspect Configuration saved for SC

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, scope is invalid, link type id is invalid, list of users is invalid or contains an invalid user key, or list of fields is invalid or contains an invalid field

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use the Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create suspect configuration

Status


colour	Red
title	STATUS 404

- Returned if the project is not found

Status

colour	Red
title	STATUS 500

- Returned if an error occurs while editing configuration

Anchor

	7
	7

Panel

titleColor	#FFFFFF
titleBGColor	#6c809a
title	com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfiguration/id

Trigger delete a suspect configuration.

Expand

REQUEST

Panel

DELETE

/rest/com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfiguration/id

PARAMETERS

parameter	type	description
prjKey*	string	The project key to be configured.
id*	string	The suspect configuration id.

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if suspect configuration is successfully deleted.

Code Block

language	java
title	Example Response

Suspect Configuration deleted for SC

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid or id is invalid

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use the Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create suspect configuration

Status


colour	Red
title	STATUS 404

- Returned if the project is not found

Status

colour	Red
title	STATUS 500

- Returned if an error occurs while creating deleting suspect configuration

Versions Compared

Old Version 5

New Version 6

Key

REQUEST

POST

RESPONSES

REQUEST

POST

PARAMETERS

RESPONSES

REQUEST

POST

PARAMETERS

RESPONSES

REQUEST

PUT

POST

PARAMETERS

RESPONSES

REQUEST

GET

PARAMETERS

RESPONSES

REQUEST

PUT

PARAMETERS

RESPONSES

REQUEST

DELETE

PARAMETERS

RESPONSES