{"type":"api","title":"Retrieve tags","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/4ecd3a14-d0be-3ef0-ba5d-c3cd958217a7","info":{"title":"Crosswork Device Lifecycle Management (DLM) Inventory API","description":"Crosswork DLM Inventory APIs allow the user to perform CRUD operations on Crosswork Tags, Credentials, Providers and Nodes.","version":"1.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/DLM/nodedbapi-overview.md"}},"swagger":"2.0","basePath":"/crosswork/inventory/v1","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","description":"bearer auth","name":"Authorization","in":"header"}}},"spec":{"summary":"Retrieve tags","description":"Read the Tags information\nRequest Body: RobotNodeTagGetReq\n -- Mandatory: Filter, even if it is empty\nFilters supported: Name or Category or Created_by. Output is always sorted using Tags Name\nResponse Body: RobotNodeTagList\n - Topic field in RobotNodeTagList response is deprecated\nDEPRECATED URL : post: /v2/dlm/invmgr/tags/get","operationId":"NodeDb_GetTags","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"created_by":{"type":"string"},"creation_time":{"type":"string","format":"int64"},"devices_tagged":{"type":"integer","format":"int64"}},"$$ref":"#/definitions/robotapiRobotNodeTag"},"title":"List of Tags"},"user":{"type":"string"},"total_count":{"type":"integer","format":"int32","title":"Number of total tags available at present"},"result_count":{"type":"integer","format":"int32"},"topic":{"type":"string"},"criteria":{"type":"string"}},"example":{"tags":[{"name":"test","category":"test"}]},"$$ref":"#/definitions/robotapiRobotNodeTagList"}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string"},"value":{"type":"string","format":"byte"}},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"string","code":0,"message":"string","details":[{"type_url":"string","value":"string"}]},"$$ref":"#/definitions/runtimeError"}}},"parameters":[{"name":"body","in":"body","description":"Read the Tags information request","required":true,"schema":{"type":"object","properties":{"filter":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"created_by":{"type":"string"},"creation_time":{"type":"string","format":"int64"},"devices_tagged":{"type":"integer","format":"int64"}},"$$ref":"#/definitions/robotapiRobotNodeTag"},"filterData":{"type":"object","properties":{"SortBy":{"type":"string"},"PageSize":{"type":"integer","format":"int64"},"PageNum":{"type":"integer","format":"int64"},"Descending":{"type":"boolean"},"MatchCase":{"type":"boolean"},"Criteria":{"type":"string"}},"$$ref":"#/definitions/robotapiRobotFilterData"},"limit":{"type":"integer","format":"int64"},"next_from":{"type":"string"}},"example":{"limit":100,"next_from":"0","filter":{"category":"default"}},"$$ref":"#/definitions/robotapiRobotNodeTagGetReq"}}],"tags":["NodeDb"],"__originalOperationId":"NodeDb_GetTags","consumes":["application/json"],"produces":["application/json"],"security":[{"bearerAuth":[]}],"method":"post","path":"/tags/query"}}