Atlassian: Field schemes schemas
38 Atlassian schemas with complete fields and constraints.
← Field schemes operations · All schemas
Associate projects to field schemes — request body — body value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request for associating field schemes to projects. write Only: true Additional keys: not allowed |
projectIds | array | Required within parent | List of project IDs to associate with field schemes |
projectIds[] | integer | Each item | List of project IDs to associate with field schemes Format: int64 |
Associate projects to field schemes — response body — value results
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for updating field scheme to projects associations. |
results | JSON | Optional | |
results (anyOf 1) | array | Alternative | Unique items: true |
results (anyOf 1)[] | Model | Each item | Expand Associate projects to field schemes — response body — value results results array item |
results (anyOf 2) | null | Alternative |
Referenced models: Associate projects to field schemes — response body — value results results array item
Associate projects to field schemes — response body — value results results array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Partial failure result when updating field scheme to projects associations. |
error | JSON | Optional | |
error (anyOf 1) | string | Alternative | |
error (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | JSON | Alternative | |
projectId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
projectId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projectId (anyOf 2) | null | Alternative | |
schemeId | JSON | Optional | |
schemeId (anyOf 1) | JSON | Alternative | |
schemeId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
schemeId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
schemeId (anyOf 2) | null | Alternative | |
success | JSON | Optional | |
success (anyOf 1) | boolean | Alternative | |
success (anyOf 2) | null | Alternative |
Clone field scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request object for creating a new field association scheme. write Only: true Additional keys: not allowed |
description | string | Optional | Description of the scheme to be created |
name | string | Required within parent | The name of the scheme to be created |
Clone field scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response object after successfully creating a new field association scheme. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
links | JSON | Optional | |
links (anyOf 1) | Model | Alternative | Expand Get field scheme — response body — links associations, projects |
links (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative |
Referenced models: Get field scheme — response body — links associations, projects
Delete a field scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response object after successfully deleting a field association scheme. |
deleted | JSON | Optional | |
deleted (anyOf 1) | boolean | Alternative | |
deleted (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | |
id (anyOf 2) | null | Alternative |
Get field parameters — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response object for getting field association parameters. |
fieldId | JSON | Optional | |
fieldId (anyOf 1) | string | Alternative | |
fieldId (anyOf 2) | null | Alternative | |
parameters | JSON | Optional | |
parameters (anyOf 1) | Model | Alternative | Expand Get field parameters — response body — parameters description, is Required, renderer Type |
parameters (anyOf 2) | null | Alternative | |
workTypeParameters | JSON | Optional | |
workTypeParameters (anyOf 1) | array | Alternative | |
workTypeParameters (anyOf 1)[] | Model | Each item | Expand Get field parameters — response body — work Type Parameters array item |
workTypeParameters (anyOf 2) | null | Alternative |
Referenced models: Get field parameters — response body — parameters description, is Required, renderer Type, Get field parameters — response body — work Type Parameters array item
Get field parameters — response body — parameters description, is Required, renderer Type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
isRequired | JSON | Optional | |
isRequired (anyOf 1) | boolean | Alternative | |
isRequired (anyOf 2) | null | Alternative | |
rendererType | JSON | Optional | |
rendererType (anyOf 1) | string | Alternative | |
rendererType (anyOf 2) | null | Alternative |
Get field parameters — response body — work Type Parameters array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
isRequired | JSON | Optional | |
isRequired (anyOf 1) | boolean | Alternative | |
isRequired (anyOf 2) | null | Alternative | |
rendererType | JSON | Optional | |
rendererType (anyOf 1) | string | Alternative | |
rendererType (anyOf 2) | null | Alternative | |
workTypeId | JSON | Optional | |
workTypeId (anyOf 1) | JSON | Alternative | |
workTypeId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
workTypeId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workTypeId (anyOf 2) | null | Alternative |
Get field scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response object for getting a field association scheme by ID. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
fieldsCount | JSON | Optional | |
fieldsCount (anyOf 1) | JSON | Alternative | |
fieldsCount (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
fieldsCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fieldsCount (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | |
id (anyOf 2) | null | Alternative | |
isDefault | JSON | Optional | |
isDefault (anyOf 1) | boolean | Alternative | |
isDefault (anyOf 2) | null | Alternative | |
links | JSON | Optional | |
links (anyOf 1) | Model | Alternative | Expand Get field scheme — response body — links associations, projects |
links (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative |
Referenced models: Get field scheme — response body — links associations, projects
Get field scheme — response body — links associations, projects
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
associations | JSON | Optional | |
associations (anyOf 1) | string | Alternative | |
associations (anyOf 2) | null | Alternative | |
projects | JSON | Optional | |
projects (anyOf 1) | string | Alternative | |
projects (anyOf 2) | null | Alternative |
Get field schemes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get field schemes — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get field schemes — response body — values The list of items item
Get field schemes — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response object for getting a field association scheme. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
fieldsCount | JSON | Optional | |
fieldsCount (anyOf 1) | JSON | Alternative | |
fieldsCount (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
fieldsCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fieldsCount (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
isDefault | JSON | Optional | |
isDefault (anyOf 1) | boolean | Alternative | |
isDefault (anyOf 2) | null | Alternative | |
links | JSON | Optional | |
links (anyOf 1) | Model | Alternative | Expand Get field scheme — response body — links associations, projects |
links (anyOf 2) | null | Alternative | |
matchedFilters | JSON | Optional | |
matchedFilters (anyOf 1) | Model | Alternative | Expand Get field schemes — response body — values The list of items item matched Filters project Ids, query |
matchedFilters (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative |
Referenced models: Get field scheme — response body — links associations, projects, Get field schemes — response body — values The list of items item matched Filters project Ids, query
Get field schemes — response body — values The list of items item matched Filters project Ids, query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Matched filters for field association scheme search. |
projectIds | JSON | Optional | |
projectIds (anyOf 1) | array | Alternative | Unique items: true |
projectIds (anyOf 1)[] | JSON | Each item | |
projectIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
projectIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projectIds (anyOf 2) | null | Alternative | |
query | JSON | Optional | |
query (anyOf 1) | string | Alternative | |
query (anyOf 2) | null | Alternative |
Get projects with field schemes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get projects with field schemes — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get projects with field schemes — response body — values The list of items item
Get projects with field schemes — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response item returned from get projects with field schemes. |
projectId | JSON | Optional | |
projectId (anyOf 1) | JSON | Alternative | |
projectId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
projectId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projectId (anyOf 2) | null | Alternative | |
schemeId | JSON | Optional | |
schemeId (anyOf 1) | JSON | Alternative | |
schemeId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
schemeId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
schemeId (anyOf 2) | null | Alternative |
Remove field parameters — request body — body value item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
parameters | array | Optional | Set of parameter names to remove Unique items: true |
parameters[] | string | Each item | Set of parameter names to remove |
schemeId | integer | Optional | ID of the field scheme Format: int64 |
workTypeIds | array | Optional | Set of work type (issue type) IDs Unique items: true |
workTypeIds[] | integer | Each item | Set of work type (issue type) IDs Format: int64 |
Remove field parameters — response body — Result of remove field parameters operation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Result of remove field parameters operation. |
results | JSON | Optional | |
results (anyOf 1) | array | Alternative | |
results (anyOf 1)[] | Model | Each item | Expand Remove field parameters — response body — Result of remove field parameters operation results array item |
results (anyOf 2) | null | Alternative |
Referenced models: Remove field parameters — response body — Result of remove field parameters operation results array item
Remove field parameters — response body — Result of remove field parameters operation results array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | JSON | Optional | |
error (anyOf 1) | Model | Alternative | Expand Remove field parameters — response body — Result of remove field parameters operation results array item error Error during remove field parameters operation |
error (anyOf 2) | null | Alternative | |
fieldId | JSON | Optional | |
fieldId (anyOf 1) | string | Alternative | |
fieldId (anyOf 2) | null | Alternative | |
schemeId | JSON | Optional | |
schemeId (anyOf 1) | JSON | Alternative | |
schemeId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
schemeId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
schemeId (anyOf 2) | null | Alternative | |
success | JSON | Optional | |
success (anyOf 1) | boolean | Alternative | |
success (anyOf 2) | null | Alternative | |
workTypeIds | JSON | Optional | |
workTypeIds (anyOf 1) | array | Alternative | Unique items: true |
workTypeIds (anyOf 1)[] | JSON | Each item | |
workTypeIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
workTypeIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workTypeIds (anyOf 2) | null | Alternative |
Referenced models: Remove field parameters — response body — Result of remove field parameters operation results array item error Error during remove field parameters operation
Remove field parameters — response body — Result of remove field parameters operation results array item error Error during remove field parameters operation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Error during remove field parameters operation. |
code | JSON | Optional | |
code (anyOf 1) | string | Alternative | |
code (anyOf 2) | null | Alternative | |
message | JSON | Optional | |
message (anyOf 1) | string | Alternative | |
message (anyOf 2) | null | Alternative |
Remove fields associated with field schemes — request body — body value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request item for removing field associations. write Only: true Additional keys: not allowed |
schemeIds | array | Required within parent | Set of scheme IDs from which to remove field associations Unique items: true |
schemeIds[] | integer | Each item | Set of scheme IDs from which to remove field associations Format: int64 |
Remove fields associated with field schemes — response body — value results
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Minimal response for updating field scheme to fields associations. |
results | JSON | Optional | |
results (anyOf 1) | array | Alternative | Unique items: true |
results (anyOf 1)[] | Model | Each item | Expand Remove fields associated with field schemes — response body — value results results array item |
results (anyOf 2) | null | Alternative |
Referenced models: Remove fields associated with field schemes — response body — value results results array item
Remove fields associated with field schemes — response body — value results results array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Minimal partial failure result when updating field scheme to fields associations. |
error | JSON | Optional | |
error (anyOf 1) | string | Alternative | |
error (anyOf 2) | null | Alternative | |
fieldId | JSON | Optional | |
fieldId (anyOf 1) | string | Alternative | |
fieldId (anyOf 2) | null | Alternative | |
schemeId | JSON | Optional | |
schemeId (anyOf 1) | JSON | Alternative | |
schemeId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
schemeId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
schemeId (anyOf 2) | null | Alternative | |
success | JSON | Optional | |
success (anyOf 1) | boolean | Alternative | |
success (anyOf 2) | null | Alternative |
Search field scheme fields — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Search field scheme fields — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Search field scheme fields — response body — values The list of items item
Search field scheme fields — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Field association scheme field search results. |
allowedOperations | JSON | Optional | |
allowedOperations (anyOf 1) | array | Alternative | |
allowedOperations (anyOf 1)[] | string | Each item | |
allowedOperations (anyOf 2) | null | Alternative | |
fieldId | JSON | Optional | |
fieldId (anyOf 1) | string | Alternative | |
fieldId (anyOf 2) | null | Alternative | |
parameters | JSON | Optional | |
parameters (anyOf 1) | Model | Alternative | Expand Get field parameters — response body — parameters description, is Required, renderer Type |
parameters (anyOf 2) | null | Alternative | |
restrictedToWorkTypes | JSON | Optional | |
restrictedToWorkTypes (anyOf 1) | array | Alternative | |
restrictedToWorkTypes (anyOf 1)[] | string | Each item | |
restrictedToWorkTypes (anyOf 2) | null | Alternative | |
workTypeParameters | JSON | Optional | |
workTypeParameters (anyOf 1) | array | Alternative | |
workTypeParameters (anyOf 1)[] | Model | Each item | Expand Search field scheme fields — response body — values The list of items item work Type Parameters array item |
workTypeParameters (anyOf 2) | null | Alternative |
Referenced models: Get field parameters — response body — parameters description, is Required, renderer Type, Search field scheme fields — response body — values The list of items item work Type Parameters array item
Search field scheme fields — response body — values The list of items item work Type Parameters array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
isRequired | JSON | Optional | |
isRequired (anyOf 1) | boolean | Alternative | |
isRequired (anyOf 2) | null | Alternative | |
rendererType | JSON | Optional | |
rendererType (anyOf 1) | string | Alternative | |
rendererType (anyOf 2) | null | Alternative | |
workTypeId | JSON | Optional | |
workTypeId (anyOf 1) | string | Alternative | |
workTypeId (anyOf 2) | null | Alternative |
Search field scheme projects — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Search field scheme projects — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Search field scheme projects — response body — values The list of items item
Search field scheme projects — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Project search results for field association scheme. |
avatarUrls | JSON | Optional | |
avatarUrls (anyOf 1) | object | Alternative | Additional keys: see wildcard field |
avatarUrls (anyOf 1).* | string | Additional keys | |
avatarUrls (anyOf 2) | null | Alternative | |
deleted | JSON | Optional | |
deleted (anyOf 1) | boolean | Alternative | |
deleted (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | |
id (anyOf 2) | null | Alternative | |
key | JSON | Optional | |
key (anyOf 1) | string | Alternative | |
key (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative |
Update field parameters — request body — body value item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request bean for updating field scheme parameters across multiple schemes and work types. write Only: true Additional keys: not allowed |
parameters | Model | Optional | Expand Update field parameters — request body — body value item parameters |
schemeIds | array | Optional | The list of field scheme IDs to update |
schemeIds[] | integer | Each item | The list of field scheme IDs to update Format: int64 |
workTypeParameters | array | Optional | The list of work type-specific parameter overrides, may be empty if only default parameters are being updated |
workTypeParameters[] | Model | Each item | Expand Update field parameters — request body — body value item work Type Parameters item |
Referenced models: Update field parameters — request body — body value item parameters, Update field parameters — request body — body value item work Type Parameters item
Update field parameters — request body — body value item parameters
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default parameters to apply to the field across all work types in the specified schemes, may be null if only work type-specific updates are needed Additional keys: not allowed |
description | string | Optional | The custom description for the field, null to preserve current description |
isRequired | boolean | Optional | Whether the field is required, null to preserve current requirement setting |
rendererType | string | Optional | The renderer type for the field, null to preserve current renderer type One of: jira-text-renderer, atlassian-wiki-renderer |
Update field parameters — request body — body value item work Type Parameters item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The list of work type-specific parameter overrides, may be empty if only default parameters are being updated Additional keys: not allowed |
description | string | Optional | The custom description for the field for this work type, null to use default or preserve current |
isRequired | boolean | Optional | Whether the field is required for this work type, null to use default or preserve current |
rendererType | string | Optional | The renderer type for the field for this work type, null to use default or preserve current One of: jira-text-renderer, atlassian-wiki-renderer |
workTypeId | integer | Optional | The ID of the work type (issue type) for which these parameters apply Format: int64 |
Update field parameters — response body — value results
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response bean for field scheme parameter update operations. |
results | JSON | Optional | |
results (anyOf 1) | array | Alternative | Unique items: true |
results (anyOf 1)[] | Model | Each item | Expand Update field parameters — response body — value results results array item |
results (anyOf 2) | null | Alternative |
Referenced models: Update field parameters — response body — value results results array item
Update field parameters — response body — value results results array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Result of updating field scheme parameters for a specific field, scheme, and optional work type. |
error | JSON | Optional | |
error (anyOf 1) | string | Alternative | |
error (anyOf 2) | null | Alternative | |
fieldId | JSON | Optional | |
fieldId (anyOf 1) | string | Alternative | |
fieldId (anyOf 2) | null | Alternative | |
schemeId | JSON | Optional | |
schemeId (anyOf 1) | JSON | Alternative | |
schemeId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
schemeId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
schemeId (anyOf 2) | null | Alternative | |
success | JSON | Optional | |
success (anyOf 1) | boolean | Alternative | |
success (anyOf 2) | null | Alternative | |
workTypeId | JSON | Optional | |
workTypeId (anyOf 1) | JSON | Alternative | |
workTypeId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
workTypeId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workTypeId (anyOf 2) | null | Alternative |
Update field scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request object for updating an existing field association scheme. write Only: true Additional keys: not allowed |
description | string | Optional | The description value to update |
name | string | Optional | The name value to update |
Update field scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response object after successfully updating an existing field association scheme. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
links | JSON | Optional | |
links (anyOf 1) | Model | Alternative | Expand Get field scheme — response body — links associations, projects |
links (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative |
Referenced models: Get field scheme — response body — links associations, projects
Update fields associated with field schemes — request body — body value item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an association between a field and its operations. write Only: true Additional keys: not allowed |
restrictedToWorkTypes | array | Optional | (optional) Work types to restrict field to. Replaces any existing work type associations for the field. If not provided, the field is associated to any work types. Unique items: true |
restrictedToWorkTypes[] | integer | Each item | (optional) Work types to restrict field to. Replaces any existing work type associations for the field. If not provided, the field is associated to any work types. Format: int64 |
schemeIds | array | Required within parent | Scheme IDs to associate field with Unique items: true |
schemeIds[] | integer | Each item | Scheme IDs to associate field with Format: int64 |
Update fields associated with field schemes — response body — value Response for updating field associations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for updating field associations. |
results | JSON | Optional | |
results (anyOf 1) | array | Alternative | Unique items: true |
results (anyOf 1)[] | Model | Each item | Expand Update fields associated with field schemes — response body — value Response for updating field associations results array item |
results (anyOf 2) | null | Alternative |
Referenced models: Update fields associated with field schemes — response body — value Response for updating field associations results array item
Update fields associated with field schemes — response body — value Response for updating field associations results array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Partial failure result when updating field scheme to fields associations. |
error | JSON | Optional | |
error (anyOf 1) | string | Alternative | |
error (anyOf 2) | null | Alternative | |
fieldId | JSON | Optional | |
fieldId (anyOf 1) | string | Alternative | |
fieldId (anyOf 2) | null | Alternative | |
schemeId | JSON | Optional | |
schemeId (anyOf 1) | JSON | Alternative | |
schemeId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
schemeId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
schemeId (anyOf 2) | null | Alternative | |
success | JSON | Optional | |
success (anyOf 1) | boolean | Alternative | |
success (anyOf 2) | null | Alternative | |
workTypeIds | JSON | Optional | |
workTypeIds (anyOf 1) | array | Alternative | Unique items: true |
workTypeIds (anyOf 1)[] | JSON | Each item | |
workTypeIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
workTypeIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workTypeIds (anyOf 2) | null | Alternative |