Versions Compared

Old Version 4

changes.mady.by.user Franklin Gabito

Saved on

compared with

New Version 5

changes.mady.by.user Franklin Gabito

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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




Anchor
2
2

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

Enable a project in Requirements.

Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
POST
/rest/com.easesolutions.jira.plugins.requirements/1.0/projects/enable/prjKey


PARAMETERS
parametertypedescription
prjKey*stringThe project key of the project to be enabled.


RESPONSES

Status
colourGreen
titleSTATUS 200
- Returned if the project is successfully enabled

Code Block
languagejava
titleExample response
{ 
	"prjKey": "SC", 
	"prjName": "Sand Castle", 
	"issueCount": 34, 
	"success": true 
}

Status
colourRed
titleSTATUS 400
- Returned if the project is invalid or an error occurs while activating the project

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/projects/disable/prjKey

Disable a project in Requirements.

Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
POST
/rest/com.easesolutions.jira.plugins.requirements/1.0/projects/disable/prjKey


PARAMETERS
parametertypedescription
prjKey*stringThe project key of the project to be disabled.


RESPONSES

Status
colourGreen
titleSTATUS 200
- Returned if the project is sucessfully disabled

Code Block
languagejava
titleExample Response
{
  "prjKey": "SC",
  "prjName": "Sand Castle",
  "issueCount": 34,
  "success": true
}

Status
colourRed
titleSTATUS 400
- Returned if the project is invalid or an error occurs while disabling the project

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/prjKey/suspectconfiguration

Trigger saving a suspect configuration.

Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
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
parametertypedescription
prjKey*stringThe project key to be configured.
fieldListstringThe list of fields. For custom fields, the custom field id must be provided.
useAllLinkTypesbooleantrue if all link types will be configured. Link type id param is ignored if set to true.
linkTypeIdsstringThe list of link type ids, separated by comma. Possible values are: -1 (ALL), 10000 (blocks), 10001 (clones), 10002 (duplicate) and/or 10003 (relates)
scopestringThe scope of the configuration (Valid values are either "down" or "both")
notifyAssigneeboolean
true if assignee should be notified, false or leave blank if otherwise
notifyReporterbooleantrue if reporter should be notified, false or leave blank if otherwise
notifyProjectLeadbooleantrue if project lead should be notified, false or leave blank if otherwise
notifyUserListstringThe list of users to be notified, separated by comma.


RESPONSES

Status
colourGreen
titleSTATUS 200
- Returned if suspect configuration is successfully udpated.

Code Block
languagejava
titleExample Response
Suspect Configuration saved for SC

Status
colourRed
titleSTATUS 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
colourRed
titleSTATUS 401
- Returned if invalid user credentials, or the user has no permission to use the Requirements for JIRA plugin

Status
colourRed
titleSTATUS 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
colourRed
titleSTATUS 404
- Returned if the project is not found

Status
colourRed
titleSTATUS 500
- Returned if an error occurs while creating suspect configuration


...