{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Issue Custom Field Contexts API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Issue Custom Field Contexts",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Get Custom Field Contexts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
},
{
"name": "isAnyIssueType",
"value": "",
"type": "query",
"description": "Whether to return contexts that apply to all issue types."
},
{
"name": "isGlobalContext",
"value": "",
"type": "query",
"description": "Whether to return contexts that apply to all projects."
},
{
"name": "contextId",
"value": "",
"type": "query",
"description": "The list of context IDs. To include multiple contexts, separate IDs with ampersand: `contextId=10000&contextId=10001`."
},
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
}
]
},
"docs": "Returns a [paginated](#pagination) list of [ contexts](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html) for a custom field. Contexts can be returned as follows:
* With no other parameters set, all contexts.
* By defining `id` only, all contexts from the list of IDs.
* By defining `isAnyIssueType`, limit the list of contexts returned to either those that apply to all issue types (true) or those that apply to only a subset of issue t"
},
{
"info": {
"name": "Atlassian Create Custom Field Context",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a custom field context.
If `projectIds` is empty, a global context is created. A global context is one that applies to all project. If `issueTypeIds` is empty, the context applies to all issue types.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get Custom Field Contexts Default Values",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context/defaultValue",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field, for example `customfield\\_10000`."
},
{
"name": "contextId",
"value": "",
"type": "query",
"description": "The IDs of the contexts."
},
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
}
]
},
"docs": "Returns a [paginated](#pagination) list of defaults for a custom field. The results can be filtered by `contextId`, otherwise all values are returned. If no defaults are set for a context, nothing is returned.
The returned object depends on type of the custom field:
* `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.
* `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for date-time fields.
* `CustomFieldContextDefaultValueSingleOptio"
},
{
"info": {
"name": "Atlassian Set Custom Field Contexts Default Values",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context/defaultValue",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Sets default for contexts of a custom field. Default are defined using these objects:
* `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.
* `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for date-time fields.
* `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for single choice select lists and radio buttons.
* `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for multiple choice select list"
},
{
"info": {
"name": "Atlassian Get Issue Types For Custom Field Context",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context/issuetypemapping",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
},
{
"name": "contextId",
"value": "",
"type": "query",
"description": "The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example, `contextId=10001&contextId=10002`."
},
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
}
]
},
"docs": "Returns a [paginated](#pagination) list of context to issue type mappings for a custom field. Mappings are returned for all contexts or a list of contexts. Mappings are ordered first by context ID and then by issue type ID.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get Custom Field Contexts For Projects And Issue Types",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context/mapping",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
},
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns a [paginated](#pagination) list of project and issue type mappings and, for each mapping, the ID of a [custom field context](https://confluence.atlassian.com/x/k44fOw) that applies to the project and issue type.
If there is no custom field context assigned to the project then, if present, the custom field context that applies to all projects is returned if it also applies to the issue type or all issue types. If a custom field context is not found, the returned custom field contex"
},
{
"info": {
"name": "Atlassian Get Project Mappings For Custom Field Context",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context/projectmapping",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field, for example `customfield\\_10000`."
},
{
"name": "contextId",
"value": "",
"type": "query",
"description": "The list of context IDs. To include multiple context, separate IDs with ampersand: `contextId=10000&contextId=10001`."
},
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
}
]
},
"docs": "Returns a [paginated](#pagination) list of context to project mappings for a custom field. The result can be filtered by `contextId`. Otherwise, all mappings are returned. Invalid IDs are ignored.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Update Custom Field Context",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context/:contextId",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
},
{
"name": "contextId",
"value": "",
"type": "path",
"description": "The ID of the context."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Delete Custom Field Context",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context/:contextId",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
},
{
"name": "contextId",
"value": "",
"type": "path",
"description": "The ID of the context."
}
]
},
"docs": "Deletes a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Add Issue Types To Context",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context/:contextId/issuetype",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
},
{
"name": "contextId",
"value": "",
"type": "path",
"description": "The ID of the context."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds issue types to a custom field context, appending the issue types to the issue types list.
A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types.
If any of the issue types exists in the custom field context, the operation fails and no issue types are added.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https:/"
},
{
"info": {
"name": "Atlassian Remove Issue Types From Context",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context/:contextId/issuetype/remove",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
},
{
"name": "contextId",
"value": "",
"type": "path",
"description": "The ID of the context."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Removes issue types from a custom field context.
A custom field context without any issue types applies to all issue types.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Assign Custom Field Context To Projects",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context/:contextId/project",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
},
{
"name": "contextId",
"value": "",
"type": "path",
"description": "The ID of the context."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assigns a custom field context to projects.
If any project in the request is assigned to any context of the custom field, the operation fails.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Remove Custom Field Context From Projects",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/context/:contextId/project/remove",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
},
{
"name": "contextId",
"value": "",
"type": "path",
"description": "The ID of the context."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Removes a custom field context from projects.
A custom field context without any projects applies to all projects. Removing all projects from a custom field context would result in it applying to all projects.
If any project in the request is not assigned to the context, or the operation would result in two global contexts for the field, the operation fails.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4d"
}
]
}
],
"bundled": true
}