Summary
Gets a page of template documents.
Description
Gets a page of template documents.
Route
GET /automation-studio/templates
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryParameters | object | yes | Parameters for filtering, paginating, projecting, and sorting template documents. |
{ "queryParameters": { "limit": 25, "skip": 0, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "in": "velit", "not-in": "anim cupidatat minim", "equals": "aliquip", "contains": "aliqua minim exercitation", "starts-with": "Duis", "ends-with": "ex commodo aliquip" } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "properties": { "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": "Sort direction, 1 for ascending and -1 for descending.", "default": 1, "enum": [ -1, 1 ] }, "sort": { "type": "string", "description": "Field to sort by", "default": "name", "enum": [ "name" ] }, "include": { "type": "string", "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", "examples": [ "name", "description", "name,description" ] }, "exclude": { "type": "string", "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", "examples": [ "_id", "description", "_id,description" ] }, "in": { "description": "Search for fields exactly matching one of the given list options", "type": "string" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "type": "string" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "type": "string" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "type": "string" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "type": "string" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "type": "string" } } } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
result | object | Results for the given search parameters. |
{ "items": [ { "name": "test", "group": "Sample group", "command": "show ip br", "description": "description", "template": "Value FIRST_WORD (S+)\n\nStart\n ^FIRST_WORD.* -> Record", "data": "some sample text to match against", "type": "test", "_id": "8c3ffAc136D2E74973DE2E1e", "createdBy": "fd8fFF0F25Ae6470BDBC502E", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "D80fdd2CC2ABb3edDAEB2E12", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "bB3CCB2fCD60DaaF926AFDfB", "name": "occaecat dolor reprehenderit", "description": "A user-defined object to help group documents." }, { "_id": "2E4CfdeEcEEECA88984f3EEc", "name": "proident", "description": "A user-defined object to help group documents." }, { "_id": "8FCf72dEdB50B187b0Ae423a", "name": "fugiat occaecat reprehenderit non quis", "description": "A user-defined object to help group documents." }, { "_id": "aCbDfacAF7A2eefBBB4e7CBE", "name": "ut officia quis ipsum nulla", "description": "A user-defined object to help group documents." }, { "_id": "fB3dce45DB37CAc5dD9C06E7", "name": "irure", "description": "A user-defined object to help group documents." } ] }, { "name": "test", "group": "Sample group", "command": "show ip br", "description": "description", "template": "Value FIRST_WORD (S+)\n\nStart\n ^FIRST_WORD.* -> Record", "data": "some sample text to match against", "type": "test", "_id": "AF975462fCC2020ea3F97Bc6", "createdBy": "3e4cBa9BED45D7F0D1737DB9", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "7834AbC6Ffacc43D63B51b9c", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "BDDfd3Ffa190b56D4C93C2BD", "name": "aliqua ullamco culpa", "description": "A user-defined object to help group documents." }, { "_id": "2611D6C83B3704bCB6e526b0", "name": "sint elit ut dolore", "description": "A user-defined object to help group documents." }, { "_id": "5EBA6a4DBa76Ff8eD9C2de8f", "name": "nostrud non in", "description": "A user-defined object to help group documents." }, { "_id": "A9ffBCe37D31eC6DcD47DB12", "name": "ut proident aliquip", "description": "A user-defined object to help group documents." }, { "_id": "2A1BDb20cAba57DCf0F3dB8E", "name": "fugiat do in deserunt", "description": "A user-defined object to help group documents." } ] }, { "name": "test", "group": "Sample group", "command": "show ip br", "description": "description", "template": "Value FIRST_WORD (S+)\n\nStart\n ^FIRST_WORD.* -> Record", "data": "some sample text to match against", "type": "test", "_id": "A8BED9B57c92b2aB90a4fFf6", "createdBy": "6b04FF9F8a5c3A26899CE7ED", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "8B351aAa91E1cda5aC0BB275", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "cCEd636BaAd5E0Bd09C8A0dd", "name": "dolor ut quis", "description": "A user-defined object to help group documents." }, { "_id": "ecC2AB21b6a3D6FCFB22D3BB", "name": "nisi minim amet", "description": "A user-defined object to help group documents." } ] }, { "name": "test", "group": "Sample group", "command": "show ip br", "description": "description", "template": "Value FIRST_WORD (S+)\n\nStart\n ^FIRST_WORD.* -> Record", "data": "some sample text to match against", "type": "test", "_id": "c18fd33bea9f0Ce034cCEBB9", "createdBy": "4747Ce1fDA64a215D17EDAf2", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "779A12ddE1eaf86A8aa6DA2C", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "bEdadB37Ea8AFbbCdbDAFd1a", "name": "ea incididunt non", "description": "A user-defined object to help group documents." } ] } ], "total": -74282338, "start": 57077676, "end": -50108920, "count": 89292038, "next": null, "previous": null }
{ "title": "result", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "template" } }, "total": { "type": "integer", "description": "Total number of documents matching the given query parameters." }, "start": { "type": "integer", "description": "Search index of first document in the items array." }, "end": { "type": "integer", "description": "Search index of the last document in the items array." }, "count": { "type": "integer", "description": "Length of the items array." }, "next": { "type": [ "string", "null" ], "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results." }, "previous": { "type": [ "string", "null" ], "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results." } } }