Cloud
Jira Service Management ops / Reference / REST API

Sync action groups

Postman Collection
OpenAPI

This resource represents Sync Action Groups in Jira Service Management. Use it to get, list, create, update, delete or reorder of action groups of a sync.

Operations
GET/v1/syncs/{syncId}/action-groupsPOST/v1/syncs/{syncId}/action-groupsGET/v1/syncs/{syncId}/action-groups/{id}DEL/v1/syncs/{syncId}/action-groups/{id}PATCH/v1/syncs/{syncId}/action-groups/{id}PATCH/v1/syncs/{syncId}/action-groups/{id}/order
GET

List sync action groupsExperimental

Lists sync action groups of a sync

OAuth 2.0 scopes required:
read:ops-config:jira-service-management

Request

Path parameters

syncId

string

Required

Query parameters

type

string

Responses

Returned if the request is successful

application/json

SyncActions
GET/v1/syncs/{syncId}/action-groups
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{syncId}/action-groups' \ --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 [ { "id": "9fb515a9-a902-444a-aa77-ff8b942cd250", "type": "forwarding", "name": "Create alert", "order": 2.2864804, "enabled": false }, { "id": "f9447ae4-5138-4cee-983c-a0b4f1492963", "type": "updating", "name": "alert updating rules", "order": 1, "enabled": true } ]
POST

Create sync action groupExperimental

Creates a sync action group

OAuth 2.0 scopes required:
read:ops-config:jira-service-management
,
write:ops-config:jira-service-management

Request

Path parameters

syncId

string

Required

Request bodyapplication/json

type

string

Required
name

string

Required
order

number

enabled

boolean

rootAction

AddedActionDto

updateActions

array<AddedActionDto>

Responses

Returned if the request is successful

application/json

SyncActionGroupMetadataDto
POST/v1/syncs/{syncId}/action-groups
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 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{syncId}/action-groups' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "type": "forwarding", "name": "<string>", "order": 26, "enabled": true, "rootAction": { "type": "<string>", "name": "<string>", "enabled": true, "filter": { "conditionsEmpty": true, "conditionMatchType": "match-all", "conditions": [ { "field": "<string>", "operation": "matches" } ] }, "typeSpecificProperties": {}, "fieldMappings": {}, "actionMapping": { "type": "<string>", "parameter": {} } }, "updateActions": [ { "type": "<string>", "name": "<string>", "enabled": true, "filter": { "conditionsEmpty": true, "conditionMatchType": "match-all", "conditions": [ { "field": "<string>", "operation": "matches" } ] }, "typeSpecificProperties": {}, "fieldMappings": {}, "actionMapping": { "type": "<string>", "parameter": {} } } ] }'
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": "f9447ae4-5138-4cee-983c-a0b4f1492963", "type": "updating", "name": "alert updating rules", "order": 1, "enabled": true, "updateActions": [ { "id": "95c5fe2d-dad9-470e-a9af-e7fcdb692058", "name": "Comment Issue", "type": "commentIssue", "enabled": true, "order": 2.1411576, "direction": "outgoing", "actionGroupId": "f9447ae4-5138-4cee-983c-a0b4f1492963", "actionMapping": { "type": "acknowledge" }, "filter": { "conditionsEmpty": false, "conditionMatchType": "match-all", "conditions": [] }, "fieldMappings": {}, "typeSpecificProperties": {} }, { "id": "597f3162-4d33-4ecc-ae99-f70fc06b86f6", "name": "Comment Issue", "type": "commentIssue", "enabled": true, "order": 3.1722643, "direction": "outgoing", "actionGroupId": "f9447ae4-5138-4cee-983c-a0b4f1492963", "actionMapping": { "type": "close" }, "filter": { "conditionsEmpty": false, "conditionMatchType": "match-all", "conditions": [] }, "fieldMappings": {}, "typeSpecificProperties": {} } ] }
GET

Get sync action groupExperimental

Gets a sync action group.

OAuth 2.0 scopes required:
read:ops-config:jira-service-management

Request

Path parameters

syncId

string

Required
actionGroupId

string

Required

Responses

Returned if the request is successful

application/json

SyncActionGroup
GET/v1/syncs/{syncId}/action-groups/{id}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{syncId}/action-groups/{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": "f9447ae4-5138-4cee-983c-a0b4f1492963", "type": "updating", "name": "alert updating rules", "order": 1, "enabled": true, "updateActions": [ { "id": "95c5fe2d-dad9-470e-a9af-e7fcdb692058", "name": "Comment Issue", "type": "commentIssue", "enabled": true, "order": 2.1411576, "direction": "outgoing", "actionGroupId": "f9447ae4-5138-4cee-983c-a0b4f1492963", "actionMapping": { "type": "acknowledge" }, "filter": { "conditionsEmpty": false, "conditionMatchType": "match-all", "conditions": [] }, "fieldMappings": {}, "typeSpecificProperties": {} }, { "id": "597f3162-4d33-4ecc-ae99-f70fc06b86f6", "name": "Comment Issue", "type": "commentIssue", "enabled": true, "order": 3.1722643, "direction": "outgoing", "actionGroupId": "f9447ae4-5138-4cee-983c-a0b4f1492963", "actionMapping": { "type": "close" }, "filter": { "conditionsEmpty": false, "conditionMatchType": "match-all", "conditions": [] }, "fieldMappings": {}, "typeSpecificProperties": {} } ] }
DEL

Delete sync action groupExperimental

Deletes a sync action group.

OAuth 2.0 scopes required:
read:ops-config:jira-service-management
,
delete:ops-config:jira-service-management

Request

Path parameters

syncId

string

Required
id

string

Required

Responses

Returned if the request is successful

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

Update sync action groupExperimental

Updates a sync action group.

OAuth 2.0 scopes required:
read:ops-config:jira-service-management
,
write:ops-config:jira-service-management

Request

Path parameters

syncId

string

Required
id

string

Required

Request bodyapplication/json

name

string

enabled

boolean

actions

ActionsDto

Responses

Returned if the request is successful

application/json

SyncAction

Update actions of the action group.

PATCH/v1/syncs/{syncId}/action-groups/{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 34 35 36 37 38 39 40 41 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{syncId}/action-groups/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "enabled": true, "actions": { "added": [ { "type": "<string>", "name": "<string>", "enabled": true, "filter": {}, "typeSpecificProperties": {}, "fieldMappings": {}, "actionMapping": { "type": "<string>" } } ], "updated": [ { "id": "<string>", "type": "<string>", "name": "<string>", "enabled": true, "filter": {}, "typeSpecificProperties": {}, "fieldMappings": {}, "actionMapping": { "type": "<string>" } } ], "deleted": [ "<string>" ] } }'
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": "f9447ae4-5138-4cee-983c-a0b4f1492963", "type": "updating", "name": "alert updating rules", "order": 1, "enabled": true, "updateActions": [ { "id": "95c5fe2d-dad9-470e-a9af-e7fcdb692058", "name": "Comment Issue", "type": "commentIssue", "enabled": true, "order": 2.1411576, "direction": "outgoing", "actionGroupId": "f9447ae4-5138-4cee-983c-a0b4f1492963", "actionMapping": { "type": "acknowledge" }, "filter": { "conditionsEmpty": false, "conditionMatchType": "match-all", "conditions": [] }, "fieldMappings": {}, "typeSpecificProperties": {} }, { "id": "597f3162-4d33-4ecc-ae99-f70fc06b86f6", "name": "Comment Issue", "type": "commentIssue", "enabled": true, "order": 3.1722643, "direction": "outgoing", "actionGroupId": "f9447ae4-5138-4cee-983c-a0b4f1492963", "actionMapping": { "type": "close" }, "filter": { "conditionsEmpty": false, "conditionMatchType": "match-all", "conditions": [] }, "fieldMappings": {}, "typeSpecificProperties": {} } ] }
PATCH

Reorder sync action groupExperimental

Reorders a sync action group.

OAuth 2.0 scopes required:
read:ops-config:jira-service-management
,
write:ops-config:jira-service-management

Request

Path parameters

syncId

string

Required
id

string

Required

Request bodyapplication/json

successorId

string

Required

Responses

Returned if the request is successful

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

Rate this page: