![]() ![]() In the following example, an issue's content is being retrieved, along with the expanded details of its fields property, which excludes details about comments or attachments. For instance, if all we want to know about an issue from a REST API call is its key, then there is no need to retrieve additional information about the issue in the response, such as a potentially extensive list of comments.Įxpandable properties give you some control over the data you get back. If responses provide too much information, then the network bandwidth, memory usage and processing load of a JIRA server could be severely impacted if the server receives multiple simultaneous REST API calls.Overloading a JIRA site with this volume of REST API calls could generate network latency, which in turn could severely impact JIRA's performance. ![]() If responses provide too little information, you may require many more HTTP GET REST API calls to collect all the information you require.To find out what properties are expandable, look at the expand field in the JSON response to see what other information is available.Įxpandable properties allow the generation of optimal REST API responses, which avoid the following problems associated with offering 'too much' or 'too little' information: In order to see this information, you must explicitly expand it by including the expand query parameter in your REST API call. In the JIRA REST API, some of the response information is 'hidden' within expandable properties. "self": " "description": "The issue is open and ready for the assignee to start work on it.",Īs you can see from the example above, the very first entry is something called expand. "description": "A problem which impairs or prevents the functions of the product.", "expand": "renderedFields,names,schema,transitions,editmeta,changelog", A value of AUTHENTICATION_DENIED means the application rejected the login without even checking the password, which most commonly indicates that JIRA's CAPTCHA feature has been triggered. When you get an error response from JIRA, you can check for the presence of an X-Seraph-LoginReason header in the response, which will contain more information. This feature is 'triggered' after several consecutive failed log in attempts, after which the user is required to interpret a distorted picture of a word and type that word into a text field with each subsequent log in attempt.īe aware that you cannot use JIRA's REST API to authenticate with a JIRA site, once JIRA's CAPTCHA upon login feature has been triggered. CAPTCHAsĬAPTCHA upon login was a security feature incorporated into JIRA 4.1. For OAuth authentication refer to JIRA REST API Example - OAuth authentication. On production systems you will want to use HTTPS/SSL, or use one of the alternative authentication methods that does not suffer from this drawback.įor more information about using Basic Authentication with the JIRA REST API, refer to JIRA REST API Example - Basic Authentication. It is not recommended to use BASIC Authentication over plain HTTP, since passwords are transmitted in plain text on every request. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |