View Source

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
PUT	com.easesolutions.jira.plugins.requirements/1.0/prjKey/suspectconfiguration	Trigger saving a suspect configuration.

Enable a project in Requirements.

REQUEST

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

- Returned if the project is successfully enabled

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

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

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

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

Disable a project in Requirements.

REQUEST

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

- Returned if the project is sucessfully disabled

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

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

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

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

Trigger saving a suspect configuration.

REQUEST

PUT

All link type

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

By link type id

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

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	The list of users to be notified, separated by comma.

RESPONSES

- Returned if suspect configuration is successfully udpated.

Suspect Configuration saved for SC

- 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

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

- 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

- Returned if the project is not found

- Returned if an error occurs while creating suspect configuration