{
"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
DetailsExampleSchema
Name
Type
Description
result
object
total number and a list of automations documents that matched the search query
Copied to Clipboard
{
"list": [
{
"_id": "4321abcdef694aa79dae47ad",
"name": "My document",
"description": "A description of an automation.",
"componentType": null,
"created": "2019-04-16T00:43:22.038Z",
"lastUpdated": "2019-04-16T00:43:22.038Z",
"gbac": {
"write": [
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c"
],
"read": [
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"4321abcdef694aa79dae47ad"
]
},
"createdBy": "officia dolor proident",
"lastUpdatedBy": "magna reprehenderit",
"componentName": "do occaecat",
"componentId": "dolore officia Lorem"
},
{
"_id": "4321abcdef694aa79dae47ad",
"name": "My document",
"description": "A description of an automation.",
"componentType": null,
"created": "2019-04-16T00:43:22.038Z",
"lastUpdated": "2019-04-16T00:43:22.038Z",
"gbac": {
"write": [
"4321abcdef694aa79dae47ad",
"5cb7b531d06cceb89fd21b1c"
],
"read": [
"5cb7b531d06cceb89fd21b1c",
"4321abcdef694aa79dae47ad",
"4321abcdef694aa79dae47ad"
]
},
"createdBy": "in ullamco ex",
"lastUpdatedBy": "minim eu",
"componentName": "cupidatat mollit sed ex",
"componentId": null
},
{
"_id": "4321abcdef694aa79dae47ad",
"name": "My document",
"description": "A description of an automation.",
"componentType": null,
"created": "2019-04-16T00:43:22.038Z",
"lastUpdated": "2019-04-16T00:43:22.038Z",
"gbac": {
"write": [
"4321abcdef694aa79dae47ad",
"4321abcdef694aa79dae47ad",
"5cb7b531d06cceb89fd21b1c"
],
"read": [
"4321abcdef694aa79dae47ad"
]
},
"createdBy": "consequat mollit enim ullamco pariatur",
"lastUpdatedBy": "commodo ea deserunt",
"componentName": "eiusmod laboris commodo elit magna",
"componentId": "sit do elit anim deserunt"
}
],
"skip": 0,
"limit": 10,
"total": -92414727
}
Copied to Clipboard
{
"title": "result",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "automation-api"
}
},
"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"
}
}
}