This resource represents Sync Actions in Compass. Use it to get, list, create, update, delete or reorder of actions of a sync.
Lists sync actions of a sync
Forge and OAuth2 apps cannot access this REST resource.
string
string
string
string
string
string
Returned if the request is successful
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/syncs/{syncId}/actions' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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"
}
]
}Creates a sync action
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
ActionMappingDto
boolean
FilterDto
Requiredobject
object
Returned if the request is successful
Update actions of the action group.
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/compass/cloud/{cloudId}/ops/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": {}
}'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": {}
}Gets a sync action.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredReturned if the request is successful
Update actions of the action group.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/syncs/{syncId}/actions/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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": {}
}Deletes a sync action.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredReturned if the request is successful
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/syncs/{syncId}/actions/{id}' \
--user 'email@example.com:<api_token>'Updates a sync action.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
Requiredstring
ActionMappingDto
boolean
FilterDto
Requiredobject
object
Returned if the request is successful
Update actions of the action group.
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/compass/cloud/{cloudId}/ops/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": {}
}'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": {}
}Reorders a sync action.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Returned if the request is successful
1
2
3
4
5
6
7
curl --request PATCH \
--url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/syncs/{syncId}/actions/{id}/order' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"successorId": "<string>"
}'Rate this page: