Summary
Get Automations
Description
Search the Automation collection.
Route
GET /operations-manager/automations
Roles
admin
engineering
apiread
viewer
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": 1,
"skip": 10,
"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 imported 3 of 4 documents",
"data": [
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "workflows",
"createdBy": "non officia ad mollit ullamco",
"created": "1993-07-06T17:53:25.454Z",
"lastUpdatedBy": "ipsum consequat",
"lastUpdated": "2010-03-17T02:55:58.658Z",
"_id": "c2e0f8308c2f6cf62f7a3afd",
"gbac": {
"write": [
"fcdfa2c917b8c466f3d3f214",
"3f08f2c81be3c356d05e6223",
"853c7fad1740d2a95eb2fad4"
],
"read": [
"21f0fe32a44ae513d14032d9",
"f21fb72dd4798554c8e1409c",
"e8dc4f81e89b7c55eb411042",
"460034cb80c5856a3b61a9e7"
]
},
"componentId": "d403606E-07D4-B4F0-C3E3-85e72eb9B1d2"
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": null,
"createdBy": "ullamco ea",
"created": "1969-11-01T04:22:42.243Z",
"lastUpdatedBy": "anim nostrud eiusmod",
"lastUpdated": "2003-12-30T21:44:28.771Z",
"_id": "be596948a20c631034a0039f",
"gbac": {
"write": [
"aede70d84c74f873d6717b6a",
"103040714818f1c5cd9e5df1",
"732acf71dfe688ab8039cba8",
"df03dbc7d4ee1dcb17bfade7",
"b4982e33abd60a1aa95492ce"
],
"read": [
"550fc56ee94110bd1e998173",
"bb78d713f3e49074ba326dcc"
]
},
"componentId": "242CbD74-cebC-2072-05Cd-Bf0f137CABcB"
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "workflows",
"createdBy": null,
"created": "1987-03-09T15:59:39.691Z",
"lastUpdatedBy": "anim ipsum ut exercitation consectetur",
"lastUpdated": "1967-09-17T08:49:45.856Z",
"_id": "64623e2983eac70ef5ed7b5e",
"gbac": {
"write": [
"781810fb92b564415a9ee8ab",
"e3af81c4a2f41b83e3bd93d2",
"8b1e950ccdd0ca8a8d4314c0"
],
"read": [
"742619da10a1113e9567480a"
]
},
"componentName": "ullamco occaecat cupidatat aliqua in"
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": null,
"createdBy": "nostrud",
"created": "2006-07-14T09:29:32.936Z",
"lastUpdatedBy": "in fugiat magna aute",
"lastUpdated": "1960-06-29T04:09:28.666Z",
"_id": "94c6169191f40da59e8180ea",
"gbac": {
"write": [
"a19d768f9fcdcf7be6bf55d4",
"686d86e43ed7f0f1efc1ef82",
"794a809e2a9c13b76a653d76",
"5e41405427a1477136f8fe11"
],
"read": [
"c2d2601d2ad91b8093c90d62",
"88b83e4609a8227c3451c0ad"
]
},
"componentId": null
}
],
"metadata": {
"skip": 49052620,
"limit": 61858390,
"total": 8771360,
"nextPageSkip": null,
"previousPageSkip": null,
"currentPageSize": 57388113
}
}