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": 50, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "in": "eu in culpa", "not-in": "Lorem sed", "equals": "aliqua consectetur", "contains": "elit adipisicing", "starts-with": "quis esse voluptate cillum", "ends-with": "pariatur" } }
{ "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": "Be1FA7c9f40Fc7Ce5B0dc96d", "createdBy": "9dEbE99D7411ada40d4b4586", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "E3D1B12d096Bdffc3D3A3A5a", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "114adF6A28c5D977bC8e27ac", "name": "quis cupidatat exercitation incididunt Ut", "description": "A user-defined object to help group documents." }, { "_id": "8E7aCb0C7dB96FF6C745E69d", "name": "ut", "description": "A user-defined object to help group documents." }, { "_id": "9Eb1B8F9f59Af7F46D80F5Ac", "name": "enim", "description": "A user-defined object to help group documents." }, { "_id": "64aa2e4CcA194CF3dDB14926", "name": "dolor velit et in quis", "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": "DdC4C59bbB12D347c945f2C4", "createdBy": "e1be34401C5A94a98cddD6CD", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "38AC612b9446aC6c1aB454A6", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "1f77B0c8cef92Eb5aaBAaeD7", "name": "ex sint commodo magna ut", "description": "A user-defined object to help group documents." }, { "_id": "EE460aD9cdba44bFEE8B67DD", "name": "qui ut in labore", "description": "A user-defined object to help group documents." }, { "_id": "7Fc02cfDfd75AC914f90838B", "name": "ullamco Excepteur veniam do commodo", "description": "A user-defined object to help group documents." }, { "_id": "ac3E77976c2037b7c7cEF7aD", "name": "in nostrud est consequat ut", "description": "A user-defined object to help group documents." }, { "_id": "ee23cbbbB2e6d94F9AACCCeE", "name": "in ad ex", "description": "A user-defined object to help group documents." } ] } ], "total": 45301284, "start": -14538167, "end": -87202587, "count": 14741592, "next": "aliqua exercitation proident occaecat officia", "previous": "pariatur" }
{ "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." } } }