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": "name,description", "exclude": "description", "in": "Ut quis Excepteur do", "not-in": "ut in", "equals": "do sunt dolor", "contains": "dolor", "starts-with": "est labore irure", "ends-with": "ea ut adipisicing Excepteur qui" } }
{ "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": "Eab9eFd8AAfe1a1EA18bAECa", "createdBy": "709A8EDCebBACDb7D3ababDd", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "E3FbbEafD9Fcab57A3a4772b", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "d2FFddcdAe98B9448de4dC8B", "name": "cupidatat in veniam et", "description": "A user-defined object to help group documents." }, { "_id": "D7adAfCB374eAf0ee1da9671", "name": "exercitation dolor", "description": "A user-defined object to help group documents." }, { "_id": "7De6b2B2AED9e450979d158F", "name": "qui", "description": "A user-defined object to help group documents." }, { "_id": "Ae510f2e3dFCB8FB48eF2c05", "name": "et adipisicing", "description": "A user-defined object to help group documents." }, { "_id": "dc7d70DF8AFbFc54C575Df83", "name": "laborum cillum aliqua Lorem", "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": "7F544db5cfDcBEcfD0E7aecD", "createdBy": "09acacBaeCEC89AfaDd69aB2", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "Ec64e51Fa159dc2cf8493ef3", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "39Ae363c208aA50828E1Ee05", "name": "aliqua", "description": "A user-defined object to help group documents." }, { "_id": "Dbc9E03badb7710169086038", "name": "in officia", "description": "A user-defined object to help group documents." }, { "_id": "B2Eeff9ac03Ed72C9Ba2ddfE", "name": "Duis adipisicing", "description": "A user-defined object to help group documents." }, { "_id": "f2ADE01ba03c83EEC2C412DA", "name": "Lorem dolore officia", "description": "A user-defined object to help group documents." }, { "_id": "6DcaBf50b2BB7d3b8AeAc46E", "name": "do ullamco in eiusmod", "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": "53f29fA6eD827355E8cDDc88", "createdBy": "24C46c89d0125D3DaaD92C54", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "93De3Fcabe6a5e72A173DED0", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "8eDd4f901132CcB8bfEEBe76", "name": "magna in elit", "description": "A user-defined object to help group documents." }, { "_id": "b13CE6C066fAcF6841dE0387", "name": "pariatur aute reprehenderit cillum esse", "description": "A user-defined object to help group documents." }, { "_id": "D25eB3138d0CBffBAFEc9453", "name": "id ea reprehenderit", "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": "8FBe4486AD515f9E495Dab2C", "createdBy": "Beb3DD6c86f8f645bc1AabDd", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "ef8f7DA5BBE83EE5c18E9CFe", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "b96C3a1Ed57F75d3e9bDFC6c", "name": "adipisicing incididunt et", "description": "A user-defined object to help group documents." }, { "_id": "975ff7bF7E5aAaF65BcC08C4", "name": "tempor consequat reprehenderit", "description": "A user-defined object to help group documents." }, { "_id": "aB8e3DdC8Ba2a3eC9e15BfdA", "name": "cillum incididunt", "description": "A user-defined object to help group documents." }, { "_id": "6AaA3A76811506b876FB9DE4", "name": "deserunt pariatur aliquip consectetur", "description": "A user-defined object to help group documents." }, { "_id": "95444fac1eDffe2E823c0A78", "name": "proident", "description": "A user-defined object to help group documents." } ] } ], "total": 99218361, "start": 69971695, "end": -61243389, "count": -7472691, "next": "in laborum velit officia tempor", "previous": "laboris incididunt irure cillum proident" }
{ "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." } } }