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": 1, "order": 1, "sort": "name", "include": "name", "exclude": "description", "in": "dolore dolor qui tempor", "not-in": "quis veniam", "equals": "Lorem", "contains": "id reprehenderit ad", "starts-with": "pariatur sed Excepteur nulla", "ends-with": "Excepteur amet incididunt 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": "37bf39E87341FF5Fb39DE08C", "createdBy": "Ddc4962F8E2e93Fff2cBFA2A", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "B61E50A44871d676d1baBCfc", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "3be5aBf70B6FBdf3EC0caB5b", "name": "anim irure deserunt nulla ad" }, { "_id": "26CAC33E7FADdfC5fAb68827", "name": "Excepteur deserunt" }, { "_id": "0a2b3ec4EEFbaa8b3EEC9F4d", "name": "sit officia ipsum velit laborum" }, { "_id": "67f11D4d4E45a391CA03fbb7", "name": "laborum consectetur" } ] }, { "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": "8fDBCF81dea2EeC189aae42A", "createdBy": "7bdF3550d9bc6aCACD1672bA", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "CeDa71BD99aF8ff4cfEFFeA6", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "2AaE5ee7FAb98E7A755Fd616", "name": "minim" }, { "_id": "7aE81e99BA63A0A3EB19bFa8", "name": "est occaecat in dolor Lorem" }, { "_id": "8BB4b32b83d6A702aEe6cCD3", "name": "ut Excepteur ex quis proident" }, { "_id": "EeB86Ec885E2bC90B94561eB", "name": "nulla Ut minim dolor est" }, { "_id": "3d3cEA199fd4ed6eB8BCCaC8", "name": "pariatur sunt cillum laboris" } ] }, { "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": "f7a6bDf6Aa9c9da3E7Daad4B", "createdBy": "86bD91CCb0E1381aACA6BB86", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "7eDEA90dbD5F1aFa2C87bC8F", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "6EbcB2caCdCFf35aaB5109b3", "name": "cupidatat dolore nostrud ex cillum" }, { "_id": "4a6D61fEFF3f9e255B79d7ea", "name": "nostrud Lorem minim sed consequat" }, { "_id": "fDE07D527fbdEEFC8FE16Fa7", "name": "eiusmod exercitation magna eu" } ] }, { "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": "1f621Ab511C0eb04a76a4386", "createdBy": "AB6a7CaFbb5Acbdf86CB3377", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "ba206C1e5dBc9D95f1e1C5C9", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "f4aBE9F4A5df1C4C1DeF27d4", "name": "aliqua eu laboris veniam irure" }, { "_id": "CE0e1dD6DB1b8a6A6FdD09D0", "name": "qui aliqua in eu pariatur" }, { "_id": "CEB6A6D4fBaA1ff77aDbDdAd", "name": "magna elit anim in enim" } ] }, { "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": "6ceCCCfBCE3D6CBf3212fc0B", "createdBy": "d76D6EEEFF35BebCBf97c917", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "f01eaA0B876C51F8D58Bbb3A", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "f3b769e2Fea157dAEEd51a3B", "name": "dolore" }, { "_id": "93fb17847C31FC8D6838C6bc", "name": "sunt" }, { "_id": "B3b123dc2F3FE7c811Ec5f0F", "name": "dolore enim occaecat esse" }, { "_id": "A6ec76A22544B0AfAb53E64c", "name": "culpa elit ex aute proident" }, { "_id": "ccBb3ecf1BE6ADeC296beac0", "name": "nulla amet" } ] } ], "total": -8781455, "start": 4017862, "end": 79046017, "count": -82851539, "next": "Duis", "previous": "ea qui ut in in" }
{ "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": { "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "previous": { "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] } } }