Cloud
Jira Service Management ops / Reference / REST API

Sync actions

Postman Collection
OpenAPI

This resource represents Sync Actions in Jira Service Management. Use it to get, list, create, update, delete or reorder of actions of a sync.

GET

List sync actionsExperimental

Lists sync actions of a sync

Request

Query parameters

type

string

direction

string

groupId

string

name

string

offset

string

size

string

Responses

Returned if the request is successful

application/json

SyncActions
GET/v1/syncs/{syncId}/actions
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{syncId}/actions' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/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 { "links": { "next": "/v1/integrations/12fa0a15-1288-414d-b0cc-e725ba3331f7/actions?offset=1&size=1" }, "values": [ { "id": "2da91c9a-0d77-42fd-bb83-41e2849c0538", "name": "Create Alert", "type": "create", "direction": "incoming", "order": 2.1779103, "enabled": true, "actionGroupId": "" }, { "id": "f28e8e7f-b944-41ff-bc6f-ea5d24d55569", "name": "Create Issue", "type": "createIssue", "direction": "outgoing", "order": 3.1779103, "enabled": true, "actionGroupId": "9fb515a9-a902-444a-aa77-ff8b942cd250" } ] }
POST

Create sync actionExperimental

Creates a sync action

Request

Path parameters

syncId

string

Required

Request bodyapplication/json

type

string

Required
name

string

Required
direction

string

Required
actionGroupType

string

actionMapping

ActionMappingDto

enabled

boolean

filter

FilterDto

Required
properties

object

fieldMappings

object

Responses

Returned if the request is successful

application/json

SyncAction

Update actions of the action group.

POST/v1/syncs/{syncId}/actions
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 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{syncId}/actions' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "type": "<string>", "name": "<string>", "direction": "incoming", "actionGroupType": "forwarding", "actionMapping": { "type": "<string>", "parameter": {} }, "enabled": true, "filter": { "conditionsEmpty": true, "conditionMatchType": "match-all", "conditions": [ { "order": 2154, "field": "<string>", "expectedValue": "<string>", "not": true, "operation": "matches", "key": "<string>", "systemCondition": true } ] }, "properties": {}, "fieldMappings": {} }'
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 { "id": "2da91c9a-0d77-42fd-bb83-41e2849c0538", "name": "Create Alert", "type": "create", "direction": "incoming", "order": 2.1779103, "enabled": true, "filter": { "conditionMatchType": "match-all-conditions", "conditions": [ { "order": 0, "field": "eventType", "expectedValue": "issue_created", "not": false, "operation": "equals", "systemCondition": false } ] }, "fieldMappings": { "alias": "{{key}}", "description": "{{description}}", "source": "", "message": "{{summary}}", "priority": "{{priority}}", "note": "", "responders": [ { "type": "team", "id": "8ae8a0a2-1122-5566-8899-11b82bbd85c9" } ], "tags": [ "{{labels}}" ], "details": { "issueKey": "{{key}}", "priority": "{{priority}}", "status": "{{status}}" }, "user": "Jira", "actions": [], "entity": "" }, "typeSpecificProperties": {} }
GET

Get sync actionExperimental

Gets a sync action.

Request

Path parameters

syncId

string

Required
id

string

Required

Responses

Returned if the request is successful

application/json

SyncAction

Update actions of the action group.

GET/v1/syncs/{syncId}/actions/{id}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{syncId}/actions/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/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 { "id": "2da91c9a-0d77-42fd-bb83-41e2849c0538", "name": "Create Alert", "type": "create", "direction": "incoming", "order": 2.1779103, "enabled": true, "filter": { "conditionMatchType": "match-all-conditions", "conditions": [ { "order": 0, "field": "eventType", "expectedValue": "issue_created", "not": false, "operation": "equals", "systemCondition": false } ] }, "fieldMappings": { "alias": "{{key}}", "description": "{{description}}", "source": "", "message": "{{summary}}", "priority": "{{priority}}", "note": "", "responders": [ { "type": "team", "id": "8ae8a0a2-1122-5566-8899-11b82bbd85c9" } ], "tags": [ "{{labels}}" ], "details": { "issueKey": "{{key}}", "priority": "{{priority}}", "status": "{{status}}" }, "user": "Jira", "actions": [], "entity": "" }, "typeSpecificProperties": {} }
DEL

Delete sync actionExperimental

Deletes a sync action.

Request

Path parameters

syncId

string

Required
id

string

Required

Responses

Returned if the request is successful

DEL/v1/syncs/{syncId}/actions/{id}
1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{syncId}/actions/{id}' \ --user 'email@example.com:<api_token>'
PATCH

Update sync actionExperimental

Updates a sync action.

Request

Path parameters

syncId

string

Required
id

string

Required

Request bodyapplication/json

type

string

Required
name

string

Required
direction

string

Required
actionGroupType

string

actionMapping

ActionMappingDto

enabled

boolean

filter

FilterDto

Required
properties

object

fieldMappings

object

Responses

Returned if the request is successful

application/json

SyncAction

Update actions of the action group.

PATCH/v1/syncs/{syncId}/actions/{id}
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 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{syncId}/actions/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "type": "<string>", "name": "<string>", "direction": "incoming", "actionGroupType": "forwarding", "actionMapping": { "type": "<string>", "parameter": {} }, "enabled": true, "filter": { "conditionsEmpty": true, "conditionMatchType": "match-all", "conditions": [ { "order": 2154, "field": "<string>", "expectedValue": "<string>", "not": true, "operation": "matches", "key": "<string>", "systemCondition": true } ] }, "properties": {}, "fieldMappings": {} }'
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 { "id": "2da91c9a-0d77-42fd-bb83-41e2849c0538", "name": "Create Alert", "type": "create", "direction": "incoming", "order": 2.1779103, "enabled": true, "filter": { "conditionMatchType": "match-all-conditions", "conditions": [ { "order": 0, "field": "eventType", "expectedValue": "issue_created", "not": false, "operation": "equals", "systemCondition": false } ] }, "fieldMappings": { "alias": "{{key}}", "description": "{{description}}", "source": "", "message": "{{summary}}", "priority": "{{priority}}", "note": "", "responders": [ { "type": "team", "id": "8ae8a0a2-1122-5566-8899-11b82bbd85c9" } ], "tags": [ "{{labels}}" ], "details": { "issueKey": "{{key}}", "priority": "{{priority}}", "status": "{{status}}" }, "user": "Jira", "actions": [], "entity": "" }, "typeSpecificProperties": {} }
PATCH

Reorder sync actionExperimental

Reorders a sync action.

Request

Path parameters

syncId

string

Required
id

string

Required

Request bodyapplication/json

successorId

string

Responses

Returned if the request is successful

PATCH/v1/syncs/{syncId}/actions/{id}/order
1 2 3 4 5 6 7 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{syncId}/actions/{id}/order' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "successorId": "<string>" }'

Rate this page: