• Announcement banner
  • App data policies (EAP)
  • Application roles
  • Audit records
  • Avatars
  • Classification levels
  • Dashboards
  • Filters
  • Filter sharing
  • Group and user picker
  • Groups
  • Issues
  • UI modifications (apps)
  • Issue attachments
  • Issue comments
  • Issue comment properties
  • Issue fields
  • Issue field configurations
  • Issue custom field contexts
  • Issue custom field options
  • Issue custom field options (apps)
  • Issue custom field values (apps)
  • Issue custom field configuration (apps)
  • Issue navigator settings
  • Issue notification schemes
  • Issue priorities
  • Issue properties
  • Issue resolutions
  • Issue security level
  • Issue security schemes
  • Issue types
  • Issue type schemes
  • Issue type screen schemes
  • Issue type properties
  • Issue votes
  • Issue watchers
  • Issue worklogs
  • Issue worklog properties
  • Jira expressions
  • Jira settings
  • JQL
  • JQL functions (apps)
  • Labels
  • License metrics
  • Myself
  • Permissions
  • Permission schemes
  • Projects
  • Project avatars
  • Project categories
  • Project classification levels
  • Project components
  • Project email
  • Project features
  • Project key and name validation
  • Project permission schemes
  • Project properties
  • Project roles
  • Project role actors
  • Project types
  • Project versions
  • Screens
  • Screen tabs
  • Screen tab fields
  • Screen schemes
  • Server info
  • Status
  • Tasks
  • Time tracking
  • Users
  • User properties
  • Webhooks
  • Workflows
  • Workflow transition rules
  • Workflow schemes
  • Workflow scheme project associations
  • Workflow scheme drafts
  • Workflow statuses
  • Workflow status categories
  • Workflow transition properties
  • App properties
  • Dynamic modules
  • App migration
  • Service Registry
Cloud
Jira Cloud platform / Reference / REST API v3 (beta)

App migration

Postman Collection
OpenAPI
PUT

Bulk update custom field value

Updates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom fields can be updated.

Permissions required: Only Connect apps can make this request

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredNONE

Request

Header parameters

Atlassian-Transfer-Id

string

Required

Request bodyapplication/json

updateValueList

array<ConnectCustomFieldValue>

Responses

Returned if the request is successful.

application/json

any

PUT/rest/atlassian-connect/1/migration/field
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ // // This API resource doesn't support Oauth2 (3LO). See alternate authorization methods: // https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication import api, { route } from "@forge/api"; var bodyData = `{ "updateValueList": [ { "_type": "StringIssueField", "issueID": 10001, "fieldID": 10076, "string": "new string value" }, { "_type": "TextIssueField", "issueID": 10002, "fieldID": 10077, "text": "new text value" }, { "_type": "SingleSelectIssueField", "issueID": 10003, "fieldID": 10078, "optionID": "1" }, { "_type": "MultiSelectIssueField", "issueID": 10004, "fieldID": 10079, "optionID": "2" }, { "_type": "RichTextIssueField", "issueID": 10005, "fieldID": 10080, "richText": "new rich text value" }, { "_type": "NumberIssueField", "issueID": 10006, "fieldID": 10082, "number": 54 } ] }`; const response = await api.requestJira(route`/rest/atlassian-connect/1/migration/field`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
PUT

Bulk update entity properties

Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is for use by Connect apps during app migration.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredNONE

Request

Path parameters

entityType

string

Required

Header parameters

Atlassian-Transfer-Id

string

Required

Request bodyapplication/json

array<EntityPropertyDetails>

Min items: 1Max items: 50
entityId

number

Required
key

string

Required
value

string

Required

Responses

Returned if the request is successful.

PUT/rest/atlassian-connect/1/migration/properties/{entityType}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ // // This API resource doesn't support Oauth2 (3LO). See alternate authorization methods: // https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication import api, { route } from "@forge/api"; var bodyData = `[ { "entityId": 123, "key": "mykey", "value": "newValue" } ]`; const response = await api.requestJira(route`/rest/atlassian-connect/1/migration/properties/{entityType}`, { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
POST

Get workflow transition rule configurations

Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredNONE

Request

Header parameters

Atlassian-Transfer-Id

string

Required

Request bodyapplication/json

expand

string

ruleIds

array<string>

Required
workflowEntityId

string

Required

Responses

Returned if the request is successful.

application/json

WorkflowRulesSearchDetails

Details of workflow transition rules.

POST/rest/atlassian-connect/1/migration/workflow/rule/search
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ // // This API resource doesn't support Oauth2 (3LO). See alternate authorization methods: // https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication import api, { route } from "@forge/api"; var bodyData = `{ "expand": "transition", "ruleIds": [ "55d44f1d-c859-42e5-9c27-2c5ec3f340b1" ], "workflowEntityId": "a498d711-685d-428d-8c3e-bc03bb450ea7" }`; const response = await api.requestJira(route`/rest/atlassian-connect/1/migration/workflow/rule/search`, { method: 'POST', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 { "workflowEntityId": "a498d711-685d-428d-8c3e-bc03bb450ea7", "invalidRules": [ "55d44f1d-c859-42e5-9c27-2c5ec3f340b1" ], "validRules": [ { "workflowId": { "name": "Workflow name", "draft": true }, "postFunctions": [ { "id": "123", "key": "WorkflowKey", "configuration": { "value": "WorkflowValidator" }, "transition": { "name": "transition", "id": 123 } } ], "conditions": [ { "id": "123", "key": "WorkflowKey", "configuration": { "value": "WorkflowValidator" }, "transition": { "name": "transition", "id": 123 } } ], "validators": [ { "id": "123", "key": "WorkflowKey", "configuration": { "value": "WorkflowValidator" }, "transition": { "name": "transition", "id": 123 } } ] } ] }

Rate this page: