Summary
Get Automations
Description
Search the Automation collection.
Route
GET /operations-manager/automations
Roles
admin
engineering
apiread
operations
Parameters
Details Example Schema
Name
Type
Required
Description
queryParameters
object
yes
The query parameters available for this method. HTTP queries take the form of '?contains=myTitle&containsField=name&sort=name&order=1. An equivalent task configuration would be '{`contains`: `myTitle`, `containsField`: `name`, `sort`: `name`, `order`: 1}'
Copied to Clipboard
{
"queryParameters": {
"contains": "event",
"containsField": "name",
"equals": "my event trigger",
"equalsField": "name",
"startsWith": "my",
"startsWithField": "name",
"limit": 25,
"skip": 1,
"order": 1,
"sort": "name"
}
}
Return
Details Example Schema
Name
Type
Description
result
object
The Automations that matched the search query.
Copied to Clipboard
{
"message": "Successfully created the requested item",
"data": [
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "ucm_compliance_plans",
"createdBy": null,
"created": "2022-12-06T02:53:06.495Z",
"lastUpdatedBy": "fugiat sunt mollit",
"lastUpdated": "1993-12-21T18:49:53.173Z",
"_id": "14edbd43cfa3134a9cde45c2",
"gbac": {
"write": [
"ffdf2103afa2249a003c4bd6",
"630fae1c8eaabb775afec95e",
"a8cf24a0a66b3fac34e31995",
"18b17ba0d00d737d95bb9880"
],
"read": [
"950276515973885f38726406",
"6db0cced94a4dbd3f45276dd",
"3e1308a9607e6772bf591c5d",
"4c31e9408f6a18b3bf474e2e"
]
},
"componentName": null
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "ucm_compliance_plans",
"createdBy": null,
"created": "2016-12-11T08:33:03.239Z",
"lastUpdatedBy": "fugiat qui tempor deserunt ut",
"lastUpdated": "1948-06-26T11:34:49.502Z",
"_id": "5afb43883f3a7d9ae8c5b929",
"gbac": {
"write": [
"bf686b0900173de684e3ae8a",
"14eeac8f21b04b63a745de0d",
"8cc42982f1fcb760f99c46f7",
"4569fc15f6ed82d0f24ca882",
"2359f0691c399d883fb5cb0a"
],
"read": [
"e3ec310651407072c4d47013",
"1d78326e938893a65e50b196"
]
},
"componentId": null,
"componentName": null
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "workflows",
"createdBy": "Lorem fugiat irure eu",
"created": "1975-04-19T03:33:38.233Z",
"lastUpdatedBy": "adipisicing Excepteur sunt",
"lastUpdated": "2020-02-04T08:50:21.539Z",
"_id": "88accad2e6cd1983e00f1a87",
"gbac": {
"write": [
"c49ff2a2f0560182d949fdef",
"3fce63202bdcd722e89dea14",
"e58c89b78d398b8eea228236",
"d9c35da2334020c9edc008a1",
"d05399c6cd7d3e5011c28453"
],
"read": [
"28a4810166bb72b1e5d93422",
"99041c6435429c22db590e13"
]
},
"componentId": "bd949269329a9e5eb5d915dd"
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "ucm_compliance_plans",
"createdBy": null,
"created": "1985-12-23T07:49:31.998Z",
"lastUpdatedBy": "Excepteur aliqua incididunt",
"lastUpdated": "1962-11-01T20:30:13.094Z",
"_id": "6910d27f4b28d9826168f195",
"gbac": {
"write": [
"180e01f2edbf7d380f7d1388",
"30bce4578e65c2798a7bc9eb",
"daf6c6daed1b151373fd2bc9",
"894efc3c69c039684759a60b"
],
"read": [
"bab66856485c3ec6a5903ea4",
"ce330da12591fbea48e04576",
"62e369bb302d370f2e1df48a"
]
},
"componentName": "est dolor Lorem minim consectetur"
}
],
"metadata": {
"skip": -52837642,
"limit": 46922370,
"total": 70452359,
"nextPageSkip": 82303741,
"previousPageSkip": -77660201,
"currentPageSize": -10163241
}
}