Summary
Get Automations
Description
Search the Automation collection.
Route
GET /operations-manager/automations
Roles
admin
engineering
apiread
operations
viewer
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": 50,
"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 retrieved search results",
"data": [
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "workflows",
"createdBy": null,
"created": "2007-11-09T18:23:38.708Z",
"lastUpdatedBy": "elit proident",
"lastUpdated": "1994-03-07T16:04:33.515Z",
"_id": "d38399415301d079dfc1748b",
"gbac": {
"write": [
"518b9af42123d18e0919974c",
"a7acadc23976dae842cd8ee4"
],
"read": [
"5496b0933d707e54dcd907fc"
]
},
"componentName": "esse cupidatat"
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "workflows",
"createdBy": null,
"created": "2024-12-02T11:31:37.484Z",
"lastUpdatedBy": "in elit commodo aute",
"lastUpdated": "2009-01-03T00:02:42.773Z",
"_id": "3af99908c49c3c03ca256bab",
"gbac": {
"write": [
"7d8732e90dde19e153013a77",
"4cd6542b47a6a3c2a9333cc0"
],
"read": [
"339bff3e8d31c20ca7964a67",
"0e0f32d8d7a9c70c949428ed"
]
},
"componentId": ""
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "workflows",
"createdBy": null,
"created": "2019-12-13T09:58:04.398Z",
"lastUpdatedBy": "dolore culpa cupidatat in",
"lastUpdated": "2020-01-08T10:25:50.829Z",
"_id": "e1e1997d451e1d0309c807a1",
"gbac": {
"write": [
"a19d74fa75babbf4ab2c1912",
"6b0ee40e95bfa67b75658848",
"bab1794361bcb33ac9618641",
"8cf4b46736359a25930c296d",
"3e4769b9ad0e5a9947e0faff"
],
"read": [
"66d17f191a0cfebf4d17aa25",
"945cb6dfb88e53ebd01ac273"
]
},
"componentId": "a0c2b2f31a8892b4405f5823"
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": null,
"createdBy": null,
"created": "2006-07-31T10:51:45.056Z",
"lastUpdatedBy": "ullamco laboris pariatur",
"lastUpdated": "1959-06-30T16:57:36.963Z",
"_id": "a5bea0c7370e4691f15e58aa",
"gbac": {
"write": [
"cc652c788a85d2348ff8e2bd",
"1cebe36b172291f0d538a4c2",
"653ce7797382b812ce9bd836"
],
"read": [
"fedaa66ef03b3d3c81caefe6",
"234ed1fcd5b401830ff606b9",
"b894972af3919088c9dd8b23",
"2a9a0124ac0f65da886d7c33"
]
},
"componentName": null
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "workflows",
"createdBy": "nulla consectetur exercitation esse ea",
"created": "1954-10-29T19:36:48.863Z",
"lastUpdatedBy": "consequat ea est labore",
"lastUpdated": "2015-04-18T06:44:33.304Z",
"_id": "9a2f30d735b706b044814093",
"gbac": {
"write": [
"ffc43ac96b0cff1d91102aa0",
"e676db0b9e26fc53ba4dc0cf",
"6c548db8a26ba3a02b4a7cf6",
"1c86bc4e39721404f889cce7"
],
"read": [
"a525242b72f50931c96ae16a",
"cb18037f82fdbac3f100f0af",
"8f9a71fb52d918a71742df25",
"5943e43eaa50bd8fd3d07b0c"
]
},
"componentId": "139b03e325db5846001d77e8",
"componentName": "laborum eiusmod nulla pariatur esse"
}
],
"metadata": {
"skip": 14031305,
"limit": -60160096,
"total": -88717546,
"nextPageSkip": -77255164,
"previousPageSkip": null,
"currentPageSize": -74282382
}
}