openapi: 3.2.0 info: contact: email: ecosystem@atlassian.com description: Jira Cloud platform REST API documentation license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/ title: Jira Cloud platform REST Issue field configurations API version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df servers: - url: https://your-domain.atlassian.net tags: - description: This resource represents issue field configurations. Use it to get, set, and delete field configurations and field configuration schemes. name: Issue Field Configurations paths: /rest/api/3/fieldconfiguration: get: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Returns a paginated list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria: * a list of field configuration item IDs. * whether the field configuration is a default. * whether the field configuration name or description contains a query string. Only field configurations used in company-managed (classic) projects are returned. **Permissions required:** *Administer Jira* global permission.' operationId: getAllFieldConfigurations parameters: - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer - description: The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. in: query name: id schema: items: format: int64 type: integer type: array uniqueItems: true - description: If *true* returns default field configurations only. in: query name: isDefault schema: default: false type: boolean - description: The query string used to match against field configuration names and descriptions. in: query name: query schema: default: '' type: string responses: '200': content: application/json: example: '{"isLast":true,"maxResults":50,"startAt":0,"total":2,"values":[{"id":10000,"name":"Default Field Configuration","description":"The default field configuration description","isDefault":true},{"id":10001,"name":"My Field Configuration","description":"My field configuration description"}]}' schema: $ref: '#/components/schemas/PageBeanFieldConfigurationDetails' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get all field configurations tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field-configuration:jira state: Beta x-atlassian-connect-scope: ADMIN post: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional. This operation can only create configurations for use in company-managed (classic) projects. **Permissions required:** *Administer Jira* global permission.' operationId: createFieldConfiguration parameters: [] requestBody: content: application/json: example: description: My field configuration description name: My Field Configuration schema: $ref: '#/components/schemas/FieldConfigurationDetails' required: true responses: '200': content: application/json: example: '{"description":"My field configuration description","id":10001,"name":"My Field Configuration"}' schema: $ref: '#/components/schemas/FieldConfiguration' description: Returned if the request is successful. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Create field configuration tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field-configuration:jira - write:field-configuration:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/fieldconfiguration/{id}: delete: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Deletes a field configuration. This operation can only delete configurations used in company-managed (classic) projects. **Permissions required:** *Administer Jira* global permission.' operationId: deleteFieldConfiguration parameters: - description: The ID of the field configuration. in: path name: id required: true schema: format: int64 type: integer responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the field configuration is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Delete field configuration tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - delete:field-configuration:jira state: Beta x-atlassian-connect-scope: ADMIN put: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Updates a field configuration. The name and the description provided in the request override the existing values. This operation can only update configurations used in company-managed (classic) projects. **Permissions required:** *Administer Jira* global permission.' operationId: updateFieldConfiguration parameters: - description: The ID of the field configuration. in: path name: id required: true schema: format: int64 type: integer requestBody: content: application/json: example: description: A brand new description name: My Modified Field Configuration schema: $ref: '#/components/schemas/FieldConfigurationDetails' required: true responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the field configuration is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Update field configuration tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field-configuration:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/fieldconfiguration/{id}/fields: get: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Returns a paginated list of all fields for a configuration. Only the fields from configurations used in company-managed (classic) projects are returned. **Permissions required:** *Administer Jira* global permission.' operationId: getFieldConfigurationItems parameters: - description: The ID of the field configuration. in: path name: id required: true schema: format: int64 type: integer - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer responses: '200': content: application/json: example: '{"isLast":true,"maxResults":50,"startAt":0,"total":2,"values":[{"description":"For example operating system, software platform and/or hardware specifications (include as appropriate for the issue).","id":"environment","isHidden":false,"isRequired":false},{"id":"description","isHidden":false,"isRequired":false}]}' schema: $ref: '#/components/schemas/PageBeanFieldConfigurationItem' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the field configuration is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get field configuration items tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field-configuration:jira state: Beta x-atlassian-connect-scope: ADMIN put: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values. This operation can only update field configurations used in company-managed (classic) projects. The operation can set the renderer for text fields to the default text renderer (`text-renderer`) or wiki style renderer (`wiki-renderer`). However, the renderer cannot be updated for fields using the autocomplete renderer (`autocomplete-renderer`). Hiding a field deletes it from the field configuration - deleting the required, description and renderer type values as well. As a result, hiding and unhiding will not restore the other values but use their default values. **Permissions required:** *Administer Jira* global permission.' operationId: updateFieldConfigurationItems parameters: - description: The ID of the field configuration. in: path name: id required: true schema: format: int64 type: integer requestBody: content: application/json: example: fieldConfigurationItems: - description: The new description of this item. id: customfield_10012 isHidden: false - id: customfield_10011 isRequired: true - description: Another new description. id: customfield_10010 isHidden: false isRequired: false renderer: wiki-renderer schema: $ref: '#/components/schemas/FieldConfigurationItemsDetails' required: true responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the field configuration is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Update field configuration items tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field-configuration:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/fieldconfigurationscheme: get: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Returns a paginated list of field configuration schemes. Only field configuration schemes used in classic projects are returned. **Permissions required:** *Administer Jira* global permission.' operationId: getAllFieldConfigurationSchemes parameters: - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer - description: The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. in: query name: id schema: items: format: int64 type: integer type: array uniqueItems: true responses: '200': content: application/json: example: '{"isLast":true,"maxResults":10,"startAt":0,"total":3,"values":[{"id":"10000","name":"Field Configuration Scheme for Bugs","description":"This field configuration scheme is for bugs only."},{"id":"10001","name":"Field Configuration Scheme for software related projects","description":"We can use this one for software projects."},{"id":"10002","name":"Field Configuration Scheme for Epics","description":"Use this one for Epic issue type."}]}' schema: $ref: '#/components/schemas/PageBeanFieldConfigurationScheme' description: Returned if the request is successful. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permissions. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get all field configuration schemes tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field-configuration-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN post: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Creates a field configuration scheme. This operation can only create field configuration schemes used in company-managed (classic) projects. **Permissions required:** *Administer Jira* global permission.' operationId: createFieldConfigurationScheme parameters: [] requestBody: content: application/json: example: description: We can use this one for software projects. name: Field Configuration Scheme for software related projects schema: $ref: '#/components/schemas/UpdateFieldConfigurationSchemeDetails' description: The details of the field configuration scheme. required: true responses: '201': content: application/json: example: '{"description":"We can use this one for software projects.","id":"10002","name":"Field Configuration Scheme for software related projects"}' schema: $ref: '#/components/schemas/FieldConfigurationScheme' description: Returned if the request is successful. '400': content: application/json: example: '{"errorMessages":["A field configuration scheme is using this name."],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access field configurations."],"errors":{}}' description: Returned if the user does not have the necessary permissions. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Create field configuration scheme tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field-configuration-scheme:jira - read:field-configuration-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/fieldconfigurationscheme/mapping: get: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Returns a paginated list of field configuration issue type items. Only items used in classic projects are returned. **Permissions required:** *Administer Jira* global permission.' operationId: getFieldConfigurationSchemeMappings parameters: - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer - description: 'The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: `fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001`.' in: query name: fieldConfigurationSchemeId schema: items: example: 10020 format: int64 type: integer maxItems: 50 minItems: 1 type: array uniqueItems: true responses: '200': content: application/json: example: '{"isLast":true,"maxResults":100,"startAt":0,"total":5,"values":[{"fieldConfigurationSchemeId":"10020","issueTypeId":"10000","fieldConfigurationId":"10010"},{"fieldConfigurationSchemeId":"10020","issueTypeId":"10001","fieldConfigurationId":"10010"},{"fieldConfigurationSchemeId":"10021","issueTypeId":"10002","fieldConfigurationId":"10000"},{"fieldConfigurationSchemeId":"10022","issueTypeId":"default","fieldConfigurationId":"10011"},{"fieldConfigurationSchemeId":"10023","issueTypeId":"default","fieldConfigurationId":"10000"}]}' schema: $ref: '#/components/schemas/PageBeanFieldConfigurationIssueTypeItem' description: Returned if the request is successful. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if no field configuration schemes are found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get field configuration issue type items tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field-configuration-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/fieldconfigurationscheme/project: get: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Returns a paginated list of field configuration schemes and, for each scheme, a list of the projects that use it. The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme. Only field configuration schemes used in classic projects are returned. **Permissions required:** *Administer Jira* global permission.' operationId: getFieldConfigurationSchemeProjectMapping parameters: - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer - description: 'The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`.' in: query name: projectId required: true schema: items: format: int64 type: integer type: array uniqueItems: true responses: '200': content: application/json: example: '{"isLast":true,"maxResults":50,"startAt":0,"total":5,"values":[{"projectIds":["10","11"]},{"fieldConfigurationScheme":{"id":"10002","name":"Field Configuration Scheme for software related projects","description":"We can use this one for software projects."},"projectIds":["12","13","14"]}]}' schema: $ref: '#/components/schemas/PageBeanFieldConfigurationSchemeProjects' description: Returned if the request is successful. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get field configuration schemes for projects tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field-configuration-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN put: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Assigns a field configuration scheme to a project. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme. Field configuration schemes can only be assigned to classic projects. **Permissions required:** *Administer Jira* global permission.' operationId: assignFieldConfigurationSchemeToProject parameters: [] requestBody: content: application/json: example: fieldConfigurationSchemeId: '10000' projectId: '10000' schema: $ref: '#/components/schemas/FieldConfigurationSchemeProjectAssociation' required: true responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '400': content: application/json: example: '{"errorMessages":["Only classic projects can have field configuration schemes assigned."],"errors":{}}' description: Returned if the project is not a classic project. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access field configurations."],"errors":{}}' description: Returned if the user does not have the necessary permissions. '404': content: application/json: example: '{"errorMessages":["The project was not found."],"errors":{}}' description: Returned if the project is missing. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Assign field configuration scheme to project tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field-configuration-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/fieldconfigurationscheme/{id}: delete: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Deletes a field configuration scheme. This operation can only delete field configuration schemes used in company-managed (classic) projects. **Permissions required:** *Administer Jira* global permission.' operationId: deleteFieldConfigurationScheme parameters: - description: The ID of the field configuration scheme. in: path name: id required: true schema: format: int64 type: integer responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the field configuration scheme is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Delete field configuration scheme tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - delete:field-configuration-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN put: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Updates a field configuration scheme. This operation can only update field configuration schemes used in company-managed (classic) projects. **Permissions required:** *Administer Jira* global permission.' operationId: updateFieldConfigurationScheme parameters: - description: The ID of the field configuration scheme. in: path name: id required: true schema: format: int64 type: integer requestBody: content: application/json: example: description: We can use this one for software projects. name: Field Configuration Scheme for software related projects schema: $ref: '#/components/schemas/UpdateFieldConfigurationSchemeDetails' description: The details of the field configuration scheme. required: true responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '400': content: application/json: example: '{"errorMessages":["A field configuration scheme is using this name."],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access field configurations."],"errors":{}}' description: Returned if the user does not have the necessary permissions. '404': content: application/json: example: '{"errorMessages":["The field configuration scheme was not found."],"errors":{}}' description: Returned if the field configuration scheme is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Update field configuration scheme tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field-configuration-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/fieldconfigurationscheme/{id}/mapping: put: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Assigns issue types to field configurations on field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic) projects. **Permissions required:** *Administer Jira* global permission.' operationId: setFieldConfigurationSchemeMapping parameters: - description: The ID of the field configuration scheme. in: path name: id required: true schema: format: int64 type: integer requestBody: content: application/json: example: mappings: - fieldConfigurationId: '10000' issueTypeId: default - fieldConfigurationId: '10002' issueTypeId: '10001' - fieldConfigurationId: '10001' issueTypeId: '10002' schema: $ref: '#/components/schemas/AssociateFieldConfigurationsWithIssueTypesRequest' required: true responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the field configuration scheme, the field configuration, or the issue type is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Assign issue types to field configurations tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field-configuration-scheme:jira - read:field-configuration-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/fieldconfigurationscheme/{id}/mapping/delete: post: deprecated: true description: 'Deprecated, use Field schemes which supports field association schemes. Removes issue types from the field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic) projects. **Permissions required:** *Administer Jira* global permission.' operationId: removeIssueTypesFromGlobalFieldConfigurationScheme parameters: - description: The ID of the field configuration scheme. in: path name: id required: true schema: format: int64 type: integer requestBody: content: application/json: example: issueTypeIds: - '10000' - '10001' - '10002' schema: $ref: '#/components/schemas/IssueTypeIdsToRemove' description: The issue type IDs to remove. required: true responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '400': content: application/json: example: '{"errorMessages":["The issueTypeIds must not contain duplicates."],"errors":{}}' schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the request is not valid. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access field configurations."],"errors":{}}' schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user does not have the necessary permission. '404': content: application/json: example: '{"errorMessages":["The field configuration scheme was not found."],"errors":{}}' schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the field configuration scheme or the issue types are not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Remove issue types from field configuration scheme tags: - Issue Field Configurations x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field-configuration-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN components: schemas: FieldConfigurationSchemeProjects: additionalProperties: false description: Project list with assigned field configuration schema. properties: fieldConfigurationScheme: $ref: '#/components/schemas/FieldConfigurationScheme' projectIds: description: The IDs of projects using the field configuration scheme. items: description: The IDs of projects using the field configuration scheme. type: string type: array required: - projectIds type: object PageBeanFieldConfigurationItem: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/FieldConfigurationItem' readOnly: true type: array type: object IssueTypeIdsToRemove: additionalProperties: false description: The list of issue type IDs to be removed from the field configuration scheme. properties: issueTypeIds: description: The list of issue type IDs. Must contain unique values not longer than 255 characters and not be empty. Maximum of 100 IDs. items: type: string type: array required: - issueTypeIds type: object PageBeanFieldConfigurationScheme: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/FieldConfigurationScheme' readOnly: true type: array type: object FieldConfigurationSchemeProjectAssociation: additionalProperties: false description: Associated field configuration scheme and project. properties: fieldConfigurationSchemeId: description: The ID of the field configuration scheme. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme. type: string writeOnly: true projectId: description: The ID of the project. type: string writeOnly: true required: - projectId type: object FieldConfigurationToIssueTypeMapping: additionalProperties: false description: The field configuration to issue type mapping. properties: fieldConfigurationId: description: The ID of the field configuration. type: string writeOnly: true issueTypeId: description: The ID of the issue type or *default*. When set to *default* this field configuration issue type item applies to all issue types without a field configuration. An issue type can be included only once in a request. type: string writeOnly: true required: - fieldConfigurationId - issueTypeId type: object writeOnly: true PageBeanFieldConfigurationSchemeProjects: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/FieldConfigurationSchemeProjects' readOnly: true type: array type: object FieldConfiguration: additionalProperties: false description: Details of a field configuration. properties: description: description: The description of the field configuration. type: string id: description: The ID of the field configuration. format: int64 type: integer isDefault: description: Whether the field configuration is the default. type: boolean name: description: The name of the field configuration. type: string required: - description - id - name type: object UpdateFieldConfigurationSchemeDetails: additionalProperties: false description: The details of the field configuration scheme. properties: description: description: The description of the field configuration scheme. maxLength: 1024 type: string writeOnly: true name: description: The name of the field configuration scheme. The name must be unique. maxLength: 255 type: string writeOnly: true required: - name type: object FieldConfigurationDetails: additionalProperties: false description: Details of a field configuration. properties: description: description: The description of the field configuration. maxLength: 255 type: string writeOnly: true name: description: The name of the field configuration. Must be unique. maxLength: 255 type: string writeOnly: true required: - name type: object FieldConfigurationItem: additionalProperties: false description: A field within a field configuration. properties: description: description: The description of the field within the field configuration. type: string id: description: The ID of the field within the field configuration. type: string isHidden: description: Whether the field is hidden in the field configuration. type: boolean isRequired: description: Whether the field is required in the field configuration. type: boolean renderer: description: The renderer type for the field within the field configuration. type: string required: - id type: object FieldConfigurationIssueTypeItem: additionalProperties: false description: The field configuration for an issue type. properties: fieldConfigurationId: description: The ID of the field configuration. type: string fieldConfigurationSchemeId: description: The ID of the field configuration scheme. type: string issueTypeId: description: The ID of the issue type or *default*. When set to *default* this field configuration issue type item applies to all issue types without a field configuration. type: string required: - fieldConfigurationId - fieldConfigurationSchemeId - issueTypeId type: object FieldConfigurationScheme: additionalProperties: false description: Details of a field configuration scheme. properties: description: description: The description of the field configuration scheme. type: string id: description: The ID of the field configuration scheme. type: string name: description: The name of the field configuration scheme. type: string required: - id - name type: object FieldConfigurationItemsDetails: additionalProperties: false description: Details of field configuration items. properties: fieldConfigurationItems: description: Details of fields in a field configuration. items: $ref: '#/components/schemas/FieldConfigurationItem' type: array writeOnly: true required: - fieldConfigurationItems type: object PageBeanFieldConfigurationDetails: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/FieldConfigurationDetails' readOnly: true type: array type: object AssociateFieldConfigurationsWithIssueTypesRequest: additionalProperties: false description: Details of a field configuration to issue type mappings. properties: mappings: description: Field configuration to issue type mappings. items: $ref: '#/components/schemas/FieldConfigurationToIssueTypeMapping' type: array uniqueItems: true writeOnly: true required: - mappings type: object ErrorCollection: additionalProperties: false description: Error messages from an operation. properties: errorMessages: description: The list of error messages produced by this operation. For example, "input parameter 'key' must be provided" items: type: string type: array errors: additionalProperties: type: string description: 'The list of errors by parameter returned by the operation. For example,"projectKey": "Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters."' type: object status: format: int32 type: integer type: object PageBeanFieldConfigurationIssueTypeItem: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/FieldConfigurationIssueTypeItem' readOnly: true type: array type: object securitySchemes: OAuth2: description: OAuth2 scopes for Jira flows: authorizationCode: authorizationUrl: https://auth.atlassian.com/authorize scopes: delete:async-task:jira: Delete asynchronous task. delete:attachment:jira: Delete issue attachments. delete:avatar:jira: Delete system and custom avatars. delete:comment.property:jira: Delete issue comment properties. delete:comment:jira: Delete issue comments. delete:dashboard.property:jira: Delete dashboard properties. delete:dashboard:jira: Delete dashboards. delete:field-configuration-scheme:jira: Delete field configuration schemes. delete:field-configuration:jira: Delete field configurations. delete:field.option:jira: Delete field options. delete:field:jira: Delete fields. delete:filter.column:jira: Delete filter columns. delete:filter:jira: Delete filters. delete:group:jira: Delete user groups. delete:issue-link-type:jira: Delete issue link types. delete:issue-link:jira: Delete issue links. delete:issue-type-scheme:jira: Delete issue type schemes. delete:issue-type-screen-scheme:jira: Delete issue type screen schemes. delete:issue-type.property:jira: Delete issue type properties. delete:issue-type:jira: Delete issue types. delete:issue-worklog.property:jira: Delete issue worklog properties. delete:issue-worklog:jira: Delete issue worklogs. delete:issue.property:jira: Delete issue properties. delete:issue.remote-link:jira: Delete issue remote links. delete:issue:jira: Delete issues. delete:permission-scheme:jira: Delete permission schemes. delete:permission:jira: Delete permissions. delete:project-category:jira: Delete project categories. delete:project-role:jira: Delete project roles. delete:project-version:jira: Delete project versions. delete:project.avatar:jira: Delete project avatars. delete:project.component:jira: Delete project components. delete:project.property:jira: Delete project properties. delete:project:jira: Delete projects and their details, such as issue types, project lead, and avatars. delete:screen-scheme:jira: Delete screen schemes. delete:screen-tab:jira: Delete screen tabs. delete:screen:jira: Delete screens. delete:screenable-field:jira: Delete screenable fields. delete:user-configuration:jira: Delete user configurations. delete:user.property:jira: Delete user properties. delete:webhook:jira: Delete webhooks. delete:workflow-scheme:jira: Delete workflow schemes. delete:workflow.property:jira: Delete workflow properties. delete:workflow:jira: Delete workflows. manage:jira-configuration: Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types. manage:jira-project: Create and edit project settings and create new project-level objects, for example, versions, components. manage:jira-webhook: Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks. read:app-data:jira: Read app data. read:application-role:jira: View application roles. read:attachment:jira: View issue attachments. read:audit-log:jira: View audit logs. read:avatar:jira: View system and custom avatars. read:comment.property:jira: View issue comment properties. read:comment:jira: View issue comments. read:custom-field-contextual-configuration:jira: Read custom field contextual configurations. read:dashboard.property:jira: View dashboard properties. read:dashboard:jira: View dashboards. read:email-address:jira: View email addresses of all users regardless of the user's profile visibility settings. read:field-configuration-scheme:jira: View field configuration schemes. read:field-configuration:jira: Read field configurations. read:field.default-value:jira: View field default values. read:field.option:jira: View field options. read:field.options:jira: Read field options. read:field:jira: View fields. read:filter.column:jira: View filter columns. read:filter.default-share-scope:jira: View filter default share scopes. read:filter:jira: View filters. read:group:jira: View user groups. read:instance-configuration:jira: View instance configurations. read:issue-details:jira: View issue details. read:issue-event:jira: Read issue events. read:issue-field-values:jira: View issue field valueses. read:issue-link-type:jira: View issue link types. read:issue-link:jira: View issue links. read:issue-meta:jira: View issue meta. read:issue-security-level:jira: View issue security levels. read:issue-security-scheme:jira: View issue security schemes. read:issue-status:jira: View issue statuses. read:issue-type-hierarchy:jira: Read issue type hierarchies. read:issue-type-scheme:jira: View issue type schemes. read:issue-type-screen-scheme:jira: View issue type screen schemes. read:issue-type.property:jira: View issue type properties. read:issue-type:jira: View issue types. read:issue-worklog.property:jira: View issue worklog properties. read:issue-worklog:jira: View issue worklogs. read:issue.changelog:jira: View issue changelogs. read:issue.property:jira: View issue properties. read:issue.remote-link:jira: View issue remote links. read:issue.time-tracking:jira: View issue time trackings. read:issue.transition:jira: View issue transitions. read:issue.vote:jira: View issue votes. read:issue.votes:jira: View issue voteses. read:issue.watcher:jira: View issue watchers. read:issue:jira: View issues. read:jira-expressions:jira: View jira expressions. read:jira-user: View user information in Jira that you have access to, including usernames, email addresses, and avatars. read:jira-work: Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs). read:jql:jira: View JQL. read:label:jira: View labels. read:license:jira: View licenses. read:notification-scheme:jira: View notification schemes. read:permission-scheme:jira: View permission schemes. read:permission:jira: View permissions. read:priority:jira: View priorities. read:project-category:jira: View project categories. read:project-role:jira: View project roles. read:project-type:jira: View project types. read:project-version:jira: View project versions. read:project.avatar:jira: Read project avatars. read:project.component:jira: View project components. read:project.email:jira: View project emails. read:project.feature:jira: Read project features. read:project.property:jira: View project properties. read:project:jira: View projects. read:resolution:jira: View resolutions. read:role:jira: View roles. read:screen-field:jira: View screen fields. read:screen-scheme:jira: View screen schemes. read:screen-tab:jira: View screen tabs. read:screen:jira: View screens. read:screenable-field:jira: View screenable fields. read:status:jira: View statuses. read:user-configuration:jira: View user configurations. read:user.columns:jira: View user columnses. read:user.property:jira: View user properties. read:user:jira: View users. read:webhook:jira: View webhooks. read:workflow-scheme:jira: View workflow schemes. read:workflow.property:jira: View workflow properties. read:workflow:jira: View workflows. send:notification:jira: Send notifications. validate:jql:jira: Validate JQL. write:app-data:jira: Write app data. write:attachment:jira: Create and update issue attachments. write:avatar:jira: Create and update system and custom avatars. write:comment.property:jira: Create and update issue comment properties. write:comment:jira: Create and update issue comments. write:custom-field-contextual-configuration:jira: Save custom field contextual configurations. write:dashboard.property:jira: Create and update dashboard properties. write:dashboard:jira: Create and update dashboards. write:field-configuration-scheme:jira: Create and update field configuration schemes. write:field-configuration:jira: Save field configurations. write:field.default-value:jira: Create and update field default values. write:field.option:jira: Create and update field options. write:field:jira: Create and update fields. write:filter.column:jira: Create and update filter columns. write:filter.default-share-scope:jira: Create and update filter default share scopes. write:filter:jira: Create and update filters. write:group:jira: Create and update user groups. write:instance-configuration:jira: Create and update instance configurations. write:issue-link-type:jira: Create and update issue link types. write:issue-link:jira: Create and update issue links. write:issue-type-scheme:jira: Create and update issue type schemes. write:issue-type-screen-scheme:jira: Create and update issue type screen schemes. write:issue-type.property:jira: Create and update issue type properties. write:issue-type:jira: Create and update issue types. write:issue-worklog.property:jira: Create and update issue worklog properties. write:issue-worklog:jira: Create and update issue worklogs. write:issue.property:jira: Create and update issue properties. write:issue.remote-link:jira: Create and update issue remote links. write:issue.time-tracking:jira: Create and update issue time trackings. write:issue.vote:jira: Create and update issue votes. write:issue.watcher:jira: Create and update issue watchers. write:issue:jira: Create and update issues. write:jira-work: Create and edit issues in Jira, post comments, create worklogs, and delete issues. write:permission-scheme:jira: Create and update permission schemes. write:permission:jira: Create and update permissions. write:project-category:jira: Create and update project categories. write:project-role:jira: Create and update project roles. write:project-version:jira: Create and update project versions. write:project.avatar:jira: Create and update project avatars. write:project.component:jira: Create and update project components. write:project.email:jira: Create and update project emails. write:project.feature:jira: Save project features. write:project.property:jira: Create and update project properties. write:project:jira: Create and update projects. write:screen-scheme:jira: Create and update screen schemes. write:screen-tab:jira: Create and update screen tabs. write:screen:jira: Create and update screens. write:screenable-field:jira: Create and update screenable fields. write:user-configuration:jira: Create and update user configurations. write:user.property:jira: Create and update user properties. write:webhook:jira: Create and update webhooks. write:workflow-scheme:jira: Create and update workflow schemes. write:workflow.property:jira: Create and update workflow properties. write:workflow:jira: Create and update workflows. tokenUrl: https://auth.atlassian.com/oauth/token type: oauth2 basicAuth: description: You can access this resource via basic auth. scheme: basic type: http externalDocs: description: Find out more about Atlassian products and services. url: http://www.atlassian.com x-atlassian-narrative: documents: - anchor: about body: "The Jira REST API enables you to interact with Jira programmatically. Use this API to \n[build apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/), script interactions with \nJira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including \nthe HTTP response codes and example requests and responses." title: About - anchor: version body: "This documentation is for **version 3** of the Jira Cloud platform REST API, which is the latest\nversion. [Version 2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) and\nversion 3 of the API offer the same collection of operations. However, version 3 provides support for\nthe [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)\n(ADF) in:\n- `body` in comments, including where comments are used in issue, issue link, and transition resources.\n- `comment` in worklogs.\n- `description` and `environment` fields in issues.\n- `textarea` type custom fields (multi-line text fields) in issues. Single line custom fields\n (`textfield`) accept a string and don't handle Atlassian Document Format content.\n" title: Version - anchor: authentication body: "### Forge apps\n\nFor Forge apps, [REST API scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/) \nare used when authenticating with Jira Cloud platform. See [Add scopes to call an Atlassian REST API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/) for more details.\n\nThe URIs for Forge app REST API calls have this structure:\n\n`/rest/api/3/`\n\nFor example, `/rest/api/3/issue/DEMO-1`\n\n### Connect apps\n\nFor Connect apps, authentication (JWT-based) is built into the Connect libraries. Authorization is implemented using either \nscopes (shown as _App scope required_ for operations on this page) or user impersonation. See \n[Security for Connect apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/) \nfor details.\n\nThe URIs for Connect app REST API calls have this structure:\n\n`https:///rest/api/3/`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n\n### Other integrations\n\nFor integrations that are not Forge or Connect apps, use OAuth 2.0 authorization code grants (3LO) for security \n(3LO scopes are shown as for operations _OAuth scopes required_). See \n[OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) \nfor details.\n\nThe URIs for OAuth 2.0 (3LO) app REST API calls have this structure:\n\n`https://api.atlassian.com/ex/jira//rest/api/3/`\n\nFor example, `https://api.atlassian.com/ex/jira/35273b54-3f06-40d2-880f-dd28cf8daafa/rest/api/3/issue/DEMO-1`\n\n### Ad-hoc API calls\n\nFor personal scripts, bots, and ad-hoc execution of the REST APIs use basic authentication. See [Basic auth for REST APIs](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/) for details. \n\nThe URIs for basic authentication REST API calls have this structure:\n\n`https:///rest/api/3/`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n" title: Authentication and authorization - anchor: permissions body: "### Operation permissions\n\nMost operations in this API require permissions. The calling user must have the required permissions for an operation to \nuse it. Note that for Connect apps, the app user must have the required permissions for the operation and the app must \nhave scopes that permit the operation.\n\nA permission can be granted to a group, project role, or issue role that the user is a member of, or granted directly to a user. \nSee [Permissions overview](https://confluence.atlassian.com/x/FQiiLQ) for details. The most common permissions are:\n\n- **Administer the Cloud site**: Users in the _site-admins_ group have this \npermission. See [Manage groups](https://confluence.atlassian.com/x/24xjL) for details.\n- **Administer Jira**: Granted by the _Jira Administrators_ global permission. There is a default group for this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and [Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n- **Administer a project in Jira**: Granted by the _Administer projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access a project in Jira**: Granted by the _Browse projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access Jira**: Granted by the _Jira Users_ global permission. Users in the default product access group (for example, \n_jira-software-users-acmesite_) have this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and \n[Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n\n### Anonymous access\n\nSome operations provide support for anonymous access. However, anonymous access is only available if \nthe Jira permission needed to access the object or records returned by the operation is granted to \nthe _Public_ group. See [Allowing anonymous access to your project](https://confluence.atlassian.com/x/GDxxLg) \nfor details.\n\nIf an operation is called anonymously and anonymous access is not available, the operation will return \nan error. Note that not all operations that correspond to objects that can be given public access \nprovide for anonymous access.\n" title: Permissions - anchor: expansion body: "### Expansion\n\nThe Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified \nin the request. This simplifies responses and minimizes network traffic.\n\nTo expand part of a resource in a request, use the expand query parameter and specify the object(s) to be expanded. \nIf you need to expand nested objects, use the `.` dot notation. If you need to expand multiple objects, use a \ncomma-separated list. \n\nFor example, the following request expands the `names` and `renderedFields` properties for the _JRACLOUD-34423_ issue:\n\n`GET issue/JRACLOUD-34423?expand=names,renderedFields`\n\nTo discover which object can be expanded, refer to the `expand` property in the object. \nIn the JSON example below, the resource declares `widgets` as expandable.\n\n```json\n{\n \"expand\": \"widgets\", \n \"self\": \"https://your-domain.atlassian.net/rest/api/3/resource/KEY-1\", \n \"widgets\": {\n \"widgets\": [],\n \"size\": 5\n }\n}\n```\n\n### Pagination\n\nThe Jira REST API uses pagination to improve performance. Pagination is enforced for operations that could return a large \ncollection of items. When you make a request to a paginated resource, the response wraps the returned array of values in \na JSON object with paging metadata. For example:\n\n```json\n{\n \"startAt\" : 0,\n \"maxResults\" : 10,\n \"total\": 200,\n \"isLast\": false,\n \"values\": [\n { /* result 0 */ },\n { /* result 1 */ },\n { /* result 2 */ }\n ]\n}\n```\n\n* `startAt` is the index of the first item returned in the page.\n* `maxResults` is the maximum number of items that a page can return. Each operation can have a different limit for\n the number of items returned, and these limits may change without notice. To find the maximum number of items \n that an operation could return, set `maxResults` to a large number—for example, over 1000—and if the returned value of `maxResults` is less than the requested value, the returned value is the maximum.\n* `total` is the total number of items contained in all pages. This number **_may change_** as the client \nrequests the subsequent pages, therefore the client should always assume that the requested page can be empty. Note \nthat this property is not returned for all operations.\n* `isLast` indicates whether the page returned is the last one. Note that this property is not returned for all operations.\n\n### Ordering\n\nSome operations support ordering the elements of a response by a field. Check the documentation for the operation to \nconfirm whether ordering of a response is supported and which fields can be used. Responses are listed in ascending order \nby default. You can change the order using the `orderby` query parameter with a `-` or `+` symbol. For example:\n\n* `?orderBy=name` to order by `name` field ascending.\n* `?orderBy=+name` to order by `name` field ascending.\n* `?orderBy=-name` to order by `name` field descending.\n\n\n" title: Expansion, pagination, and ordering - anchor: timestamps body: 'By default, top-level timestamps (e.g. updated and created) are returned in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, in the system default user time zone. To return date time data in the logged in user''s timezone, please refer to `renderedFields` property under the `expand` query parameter in relevant APIs. ' title: Timestamps - anchor: special-request-headers body: 'The following request and response headers define important metadata for the Jira Cloud REST API resources. - `X-Atlassian-Token` (request): Operations that accept multipart/form-data must include the `X-Atlassian-Token: no-check` header in requests. Otherwise the request is blocked by cross-site request forgery (CSRF/XSRF) protection. - `X-Force-Accept-Language` (request): controls how the standard HTTP `Accept-Language` header is processed. By default `Accept-Language` is ignored and the response is in the language configured in the user''s profile or, when no language is configured for the user, the default Jira instance language. For the response to recognize `Accept-Language` send `X-Force-Accept-Language = true` as well. If `Accept-Language` requests a language that Jira can return the response is in that language, otherwise Jira returns the response in the default language. If `Accept-Language` is not specified the response is in the default language. - `X-AAccountId` (response): This response header contains the Atlassian account ID of the authenticated user.' title: Special headers - anchor: anonymous-operations body: " Jira provides for all permissions, except the [global permission](https://confluence.atlassian.com/x/x4dKLg) Administer Jira, to be assigned to *Anyone*. Once a permission is assigned to *Anyone*, anyone knowing a project's URL is able to use the features in Jira enabled by the permission. However, the Jira REST API does not enable anonymous access for operations by default. This means that an anonymous user who may be able to perform an action through Jira, may not be able to perform the same action where it's enabled by the REST API. \n\n The operations that provide anonymous access are annotated \"This operation can be accessed anonymously.\"" title: Anonymous operations - anchor: async-operations body: "Some Jira REST API operations may trigger long-running or computationally expensive tasks. In these cases, the operation \nwill schedule an asynchronous task and return a `303 (See Other)` response, indicating the location of the queued task \nin the `Location` header. You can query this task to get progress updates.\n\nWhen the task finishes, the response object will contain the `result` field. The content of the field is specific to the \noperation that created the task. Refer to the operation’s documentation for more information.\n\nNote that asynchronous tasks are not guaranteed to be run in order. In other words, if you need your tasks to execute \nin a certain order, you should start a task only after the prerequisite task(s) have finished." title: Asynchronous operations - anchor: experimental body: "Features and methods marked as experimental may change without notice. Feedback on experimental functionality is welcome. \nReport issues to [Developer and Marketplace support](https://developer.atlassian.com/support) (preferred) or use the \n**Give docs feedback** link at the top of this page. \n" title: Experimental features - anchor: status-codes body: "The Jira Cloud platform REST API uses the [standard HTTP status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).\n\nOperations that return an error status code may also return a response body containing details of the error or errors. \nThe schema for the response body is shown below:\n\n\n```json\n{\n \"id\": \"https://docs.atlassian.com/jira/REST/schema/error-collection#\",\n \"title\": \"Error Collection\",\n \"type\": \"object\",\n \"properties\": {\n \"errorMessages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"errors\": {\n \"type\": \"object\",\n \"patternProperties\": {\n \".+\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": false\n },\n \"status\": { \n \"type\": \"integer\"\n }\n },\n \"additionalProperties\": false\n}\n```" title: Status codes