Search for manually-triggered rules using the given query params.
Note: Currently only cursor is allowed as parameter for the GET operation.
Use the POST operation to perform the initial search.
string
Requirednumber
Return the manual rules that match the query AND the requesting user has permissions for.
Result of a manual rule search. Contains 0 or more results.
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/automation/public/{product}/{cloudid}/rest/v1/rule/manual/search?cursor=AAAABBBBCCCC' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"links": {
"self": "https://example.com?cursor=bbbbbb",
"next": "https://example.com?cursor=bbbbbb",
"prev": "https://example.com?cursor=bbbbbb"
},
"data": [
{
"inputA": {
"inputType": "TEXT",
"value": "Hello world!"
}
}
]
}Search for manually-triggered rules using the given criteria via POST.
Currently only issue and alert objects are supported.
Query parameters to search on
oneOf [SearchManualRuleInitialRequest, SearchManualRuleWithCursorRequest]
Params to use when fetching an initial page of manual rules.
Params to use when fetching a subsequent page of manual rules using a pagination cursor.
Return the manual rules that match the query AND the requesting user has permissions for.
Result of a manual rule search. Contains 0 or more results.
1
2
3
4
5
curl --request POST \
--url 'https://api.atlassian.com/automation/public/{product}/{cloudid}/rest/v1/rule/manual/search' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"links": {
"self": "https://example.com?cursor=bbbbbb",
"next": "https://example.com?cursor=bbbbbb",
"prev": "https://example.com?cursor=bbbbbb"
},
"data": [
{
"inputA": {
"inputType": "TEXT",
"value": "Hello world!"
}
}
]
}Invoke a manual rule with one or more target objects and optional inputs. A rule will be executed for each target object provided.
number
RequiredParameters to use when invoking the rule.
At least one target object is required. If the rule requires userInputs these are also required.
array<ARI>
Requiredobject
Succesfully issued the invoke request. Check the response body for individual execution results.
Invocation results, keyed by object ARI, indicating if the invocation was successful or not.
It is possible for an invocation to fail if, for example, the provided target object is not valid
for the rule being invoked.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request POST \
--url 'https://api.atlassian.com/automation/public/{product}/{cloudid}/rest/v1/rule/manual/{ruleId}/invocation' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"objects": [
"ari:cloud:jira:182b9218-d56a-453d-9659-3f29ea2aa7eb:issue/10001"
],
"userInputs": {
"inputA": {
"inputType": "TEXT",
"value": "Some value"
},
"inputB": {
"inputType": "NUMBER",
"value": 100
}
}
}'1
2
3
4
{
"ari:cloud:jira:182b9218-d56a-453d-9659-3f29ea2aa7eb:issue/10001": "SUCCESS",
"ari:cloud:jira:182b9218-d56a-453d-9659-3f29ea2aa7eb:issue/10002": "INVALID_TARGET_OBJECT"
}Performs a request to retrieve the metadata associated with the provided template ID. This includes any parameters the template has.
string
RequiredSuccesfully issued the get request.
Details of a single template, including what parameters are required to create a rule from the template.
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/automation/public/{product}/{cloudid}/rest/v1/template/{templateId}' \
--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
{
"id": "software_template_20",
"description": "When a task is near due -> send an email to the Assignee of the task",
"categories": [
{
"key": "jira-software.security",
"displayName": "Security"
}
],
"parameters": [
{
"type": "TEXT",
"key": "emailSubject",
"required": false
}
],
"displayMetadata": {
"triggerIcons": [
"CalendarIcon"
],
"actionIcons": [
"SmartValueIcon",
"IssuesIcon",
"EmailIcon"
]
}
}Search for templates rules using the given query params. Accepts either a combination of filter parameters, or a cursor, but not both.
string
number
array<string>
ARI
Return the templates that match the query AND the requesting user has permissions for.
Result of a templates search. Contains 0 or more entries.
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/automation/public/{product}/{cloudid}/rest/v1/template/search' \
--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
{
"links": {
"self": "https://example.com?cursor=bbbbbb",
"next": "https://example.com?cursor=bbbbbb",
"prev": "https://example.com?cursor=bbbbbb"
},
"data": [
{
"id": "software_template_20",
"description": "When a task is near due -> send an email to the Assignee of the task",
"categories": [
{
"key": "jira-software.security",
"displayName": "Security"
}
],
"parameters": [
{
"type": "TEXT",
"key": "emailSubject",
"required": false
}
],
"displayMetadata": {
"triggerIcons": [
"CalendarIcon"
],
"actionIcons": [
"SmartValueIcon",
"IssuesIcon",
"EmailIcon"
]
}
}
]
}Search for templates using the given criteria via POST.
Currently categories and ruleHome ARI filters are supported.
Query parameters to search on
oneOf [SearchTemplatesInitialRequest, SearchTemplatesWithCursorRequest]
Return the templates that match the query AND the requesting user has permissions for.
Result of a templates search. Contains 0 or more entries.
1
2
3
4
5
curl --request POST \
--url 'https://api.atlassian.com/automation/public/{product}/{cloudid}/rest/v1/template/search' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'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
{
"links": {
"self": "https://example.com?cursor=bbbbbb",
"next": "https://example.com?cursor=bbbbbb",
"prev": "https://example.com?cursor=bbbbbb"
},
"data": [
{
"id": "software_template_20",
"description": "When a task is near due -> send an email to the Assignee of the task",
"categories": [
{
"key": "jira-software.security",
"displayName": "Security"
}
],
"parameters": [
{
"type": "TEXT",
"key": "emailSubject",
"required": false
}
],
"displayMetadata": {
"triggerIcons": [
"CalendarIcon"
],
"actionIcons": [
"SmartValueIcon",
"IssuesIcon",
"EmailIcon"
]
}
}
]
}Create a rule from a template. This template may optionally accept parameters.
Parameters to use when creating the rule from the template.
If the rule has one or more parameters, values for these parameters are also required.
string
RequiredARI
Requiredobject
Succesfully created a rule from the provided template.
Result of a rule creation from a template.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
curl --request POST \
--url 'https://api.atlassian.com/automation/public/{product}/{cloudid}/rest/v1/template/create' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"templateId": "software_template_20",
"ruleHome": "ari:cloud:jira:182b9218-d56a-453d-9659-3f29ea2aa7eb:issue/10001",
"parameters": {
"emailSubject": {
"type": "TEXT",
"value": "An example email subject"
},
"emailBody": {
"type": "TEXT",
"value": "An example email body"
}
}
}'1
2
3
4
{
"ruleId": 1,
"ruleUuid": "0000660c-24e5-710d-bc7b-626fc6bb83ff"
}Rate this page: