Rate this page:
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"
}