Summary
Get Automations
Description
Query the Automation document collection
Route
GET /operations-manager/automations
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryParameters | object | yes | query params for searching |
{ "queryParameters": { "contains": "event", "containsField": "name", "equals": "my event trigger", "equalsField": "name", "startsWith": "my", "startsWithField": "name", "limit": 10, "skip": 10, "order": 1, "sort": "name" } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "properties": { "contains": { "type": "string", "examples": [ "event" ], "description": "The value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document" }, "containsField": { "type": "string", "examples": [ "name" ], "description": "The field to run a contains query on" }, "equals": { "type": "string", "examples": [ "my event trigger" ], "description": "The value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document" }, "equalsField": { "type": "string", "examples": [ "name" ], "description": "The field to run an equals query on" }, "startsWith": { "type": "string", "examples": [ "my" ], "description": "The value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document" }, "startsWithField": { "type": "string", "examples": [ "name" ], "description": "The field to run a startsWith query on" }, "limit": { "type": "integer", "description": "Number of results to return. Used for pagination.", "default": 25, "minimum": 0, "examples": [ 1, 10, 50 ] }, "skip": { "type": "integer", "description": "Number of results to skip. Used for pagination.", "default": 0, "minimum": 0, "examples": [ 1, 10, 50 ] }, "order": { "type": "integer", "description": "The sort direction: 1 for ascending or -1 for descending.", "default": 1, "enum": [ -1, 1 ] }, "sort": { "type": "string", "description": "Field to sort by. Default is name.", "default": "name", "enum": [ "name" ] } } } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
result | object | total number and a list of automations documents that matched the search query |
{ "list": [ { "name": "My document", "_id": "5cb7b531d06cceb89fd21b1c", "description": "A description about an Automation", "componentType": "workflows", "componentId": "exercitation deserunt dolor", "gbac": { "write": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "read": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ] }, "created": "2019-04-16T00:43:22.038Z", "createdBy": "Pronghorn", "lastUpdated": "2019-04-16T00:43:22.038Z", "lastUpdatedBy": "Pronghorn" }, { "name": "My document", "_id": "5cb7b531d06cceb89fd21b1c", "description": "A description about an Automation", "componentType": null, "componentId": null, "gbac": { "write": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "read": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ] }, "created": "2019-04-16T00:43:22.038Z", "createdBy": "4321abcdef694aa79dae47ad", "lastUpdated": "2019-04-16T00:43:22.038Z", "lastUpdatedBy": "Pronghorn" }, { "name": "My document", "_id": "4321abcdef694aa79dae47ad", "description": "A description about an Automation", "componentType": null, "componentId": "eu exercitation sed incididunt dolore", "gbac": { "write": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "read": [ "5cb7b531d06cceb89fd21b1c" ] }, "created": "2019-04-16T00:43:22.038Z", "createdBy": "Pronghorn", "lastUpdated": "2019-04-16T00:43:22.038Z", "lastUpdatedBy": "5cb7b531d06cceb89fd21b1c" }, { "name": "My document", "_id": "5cb7b531d06cceb89fd21b1c", "description": "A description about an Automation", "componentType": null, "componentId": "ad veniam culpa Ut eiusmod", "gbac": { "write": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "read": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ] }, "created": "2019-04-16T00:43:22.038Z", "createdBy": "Pronghorn", "lastUpdated": "2019-04-16T00:43:22.038Z", "lastUpdatedBy": "5cb7b531d06cceb89fd21b1c" }, { "name": "My document", "_id": "5cb7b531d06cceb89fd21b1c", "description": "A description about an Automation", "componentType": "workflows", "componentId": "aliqua labore velit", "gbac": { "write": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "read": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ] }, "created": "2019-04-16T00:43:22.038Z", "createdBy": "Pronghorn", "lastUpdated": "2019-04-16T00:43:22.038Z", "lastUpdatedBy": "4321abcdef694aa79dae47ad" } ], "skip": 10, "limit": 50, "total": -54096341 }
{ "title": "result", "properties": { "list": { "type": "array", "items": { "$ref": "automations-schema" } }, "skip": { "type": "integer", "description": "Number of results to skip. Used for pagination.", "default": 0, "minimum": 0, "examples": [ 1, 10, 50 ] }, "limit": { "type": "integer", "description": "Number of results to return. Used for pagination.", "default": 25, "minimum": 0, "examples": [ 1, 10, 50 ] }, "total": { "description": "total number of event docs that matched the query", "type": "integer" } } }