{"type":"doc","content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"panel","parameters":{"macroParams":{"title":{"value":"Contents"}},"macroMetadata":{"macroId":{"value":"bb417095-5194-4f91-b44c-5f5940b30b32"},"schemaVersion":{"value":"1"},"title":"Panel"}}},"content":[{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"505b195d-6dbe-4646-8aca-e26d9c4760aa"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"The Requirements for JIRA REST API is an interface to access the plugin functionality programatically.","type":"text"},{"type":"hardBreak"},{"text":"This allows another application to interact with Requirements for JIRA.","type":"text"}]},{"type":"paragraph","content":[{"text":"The functions of Requirements for JIRA can be accessed through endpoints with a specific URI path.","type":"text"},{"type":"hardBreak"},{"text":"For almost every function of the plugin a corresponding endpoint exists.","type":"text"}]},{"type":"paragraph","content":[{"text":"In order to use the REST API your application simply needs to make HTTP requests to the endpoints and parse the corresponding JSON response.","type":"text"}]},{"type":"paragraph","content":[{"text":"After authenticating your application with the JIRA instance you can start making requests to the REST API endpoints.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following pages serve as reference for the individual endpoints.","type":"text"},{"type":"hardBreak"},{"text":"For each endpoint the following details are specified:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The corresponding URI to access the endpoint","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A short description of the resource","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The necessary parameters for a request to this endpoint","type":"text"},{"type":"hardBreak"},{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Required parameters are indicated by ","type":"text"},{"text":"*","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff0000"}},{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An example response to a successful request","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Authentication","type":"text"}]},{"type":"paragraph","content":[{"text":"To access the REST API the application needs to authenticate.","type":"text"},{"type":"hardBreak"},{"text":"The REST API supports the same authentication methods JIRA does.","type":"text"},{"type":"hardBreak"},{"text":"This includes basic HTTP authentication, cookie-based authentication and authentication via OAuth.","type":"text"},{"type":"hardBreak"},{"text":"Examples regarding the different authentication methods can be found within the JIRA REST API Tutorials.","type":"text"}]},{"type":"paragraph","content":[{"text":"Most Requirements for JIRA endpoints require proper Jira permissions and versions.","type":"text"}]}]},{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[109.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Response","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[560.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Errors","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":2,"colwidth":[109.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"STATUS 403","localId":"8a81adee-b8ee-4709-b374-0bfb04540880"}}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[560.0]},"content":[{"type":"paragraph","content":[{"text":"Your license is invalid or has expired","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[560.0]},"content":[{"type":"paragraph","content":[{"text":"Incompatible JIRA Version","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":2,"colwidth":[109.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"STATUS 401","localId":"16e83b1f-6b56-4c84-86a0-9aad422fab42"}}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[560.0]},"content":[{"type":"paragraph","content":[{"text":"Invalid user credentials","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[560.0]},"content":[{"type":"paragraph","content":[{"text":"The user hasn't got permission to use the Requirements for JIRA plugin","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"URI Structure","type":"text"}]},{"type":"paragraph","content":[{"text":"The REST API endpoints provided by Requirements for JIRA are accessible via HTTP. ","type":"text"},{"type":"hardBreak"},{"text":"The following standard HTTP methods can be used for requests:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"GET","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"POST","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"PUT","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DELETE","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Which methods are supported by the specific enpoint is stated in the corresponding reference.","type":"text"}]},{"type":"paragraph","content":[{"text":"All endpoints are located on your JIRA instance and can be accessed via URI paths.","type":"text"},{"type":"hardBreak"},{"text":"These URI paths have the following structure:","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

http://host:port/rest/com.easesolutions.jira.plugins.requirements/api-version/resource-name

","nestedContent":{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"http://host:port/rest/com.easesolutions.jira.plugins.requirements/","type":"text"},{"text":"api-version","type":"text","marks":[{"type":"strong"}]},{"text":"/","type":"text"},{"text":"resource-name","type":"text","marks":[{"type":"strong"}]}]}]}],"version":1}}}},{"type":"paragraph","content":[{"text":"The current ","type":"text"},{"text":"api-version","type":"text","marks":[{"type":"strong"}]},{"text":" is: \"1.0\".","type":"text"},{"type":"hardBreak"},{"text":"The full name or path of a resource can be found in the corresponding endpoint reference.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Response Format","type":"text"}]},{"type":"paragraph","content":[{"text":"The response to a Requirements for JIRA - REST API request is always a single JSON object.","type":"text"},{"type":"hardBreak"},{"text":"The structure of the JSON response is different for each endpoint. An example response can be found in the reference for each endpoint.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"REST API Browser","type":"text"}]},{"type":"paragraph","content":[{"text":"The Atlassian REST API Browser allows you to browse through the available REST APIs for your JIRA instance.","type":"text"},{"type":"hardBreak"},{"text":"This includes the REST API of the Requirements for JIRA plugin.","type":"text"}]},{"type":"paragraph","content":[{"text":"The REST API Browser provides detailed information for each endpoint similar to this reference.","type":"text"},{"type":"hardBreak"},{"text":"It also allows you to make test requests against each of the provided methods and displays the corresponding response.","type":"text"}]},{"type":"paragraph","content":[{"text":"If you are a developer and using the Atlassian Plugin SDK the REST API Browser is already part of your application instance.","type":"text"},{"type":"hardBreak"},{"text":"Otherwise the REST API Browser can be downloaded from the Atlassian Marketplace as JIRA Server plugin.","type":"text"}]},{"type":"paragraph","content":[{"text":"To access the REST API browser you have to be logged in as JIRA administrator.","type":"text"},{"type":"hardBreak"},{"text":"The REST API Browser can be found in the ","type":"text"},{"text":"Administration","type":"text","marks":[{"type":"strong"}]},{"text":" section","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"either on the ","type":"text"},{"text":"System","type":"text","marks":[{"type":"strong"}]},{"text":" page in the ","type":"text"},{"text":"Advanced","type":"text","marks":[{"type":"strong"}]},{"text":" section of the sidebar","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"or in the sidebar of the ","type":"text"},{"text":"Add-ons","type":"text","marks":[{"type":"strong"}]},{"text":" page","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}