{"type":"api","title":"Showtech command to collect CDG showtech logs","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/e05c97f6-c05c-3a2b-97ed-ca9f414d72b7","info":{"title":"Crosswork Data Gateway Troubleshooting API","description":"APIs to support CDG 3.0.0 troubleshooting","version":"7.1.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/CDG/cdg_troubleshooting_api_overview.md"}},"swagger":"2.0","basePath":"/crosswork/dg-manager/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer Auth Token"}}},"spec":{"summary":"Showtech command to collect CDG showtech logs","operationId":"SubmitShowtechCommand","deprecated":false,"produces":["application/json"],"consumes":["application/json "],"parameters":[{"name":"Body","in":"body","required":true,"description":"Request payload to collect CDG showtech logs","schema":{"title":"ShowtechCommandPayload","example":{"id":"5065","commandName":"SHOW_TECH_SUPPORT","clientId":{"uuid":"d58de587-5da2-4a62-b010-32395acc8dbc"},"args":[{"key":"passphrase","value":{"str":"test1234"}}]},"type":"object","properties":{"id":{"type":"string"},"commandName":{"type":"string"},"clientId":{"title":"ClientId","example":{"uuid":"d58de587-5da2-4a62-b010-32395acc8dbc"},"type":"object","properties":{"uuid":{"type":"string"}},"required":["uuid"],"$$ref":"#/definitions/ClientId"},"args":{"type":"array","items":{"title":"Arg","example":{"key":"passphrase","value":{"str":"test1234"}},"type":"object","properties":{"key":{"type":"string"},"value":{"title":"Value","example":{"str":"test1234"},"type":"object","properties":{"str":{"type":"string"}},"required":["str"],"$$ref":"#/definitions/Value"}},"required":["key","value"],"$$ref":"#/definitions/Arg"}}},"required":["id","commandName","clientId","args"],"$$ref":"#/definitions/SubmitShowtechCommand"}}],"responses":{"200":{"description":"OK. The showtech log collection command got submitted. Use /command/query to find out the status.","schema":{"title":"ShowtechStatusResponse","example":{"command":{"clientId":{"uuid":"3739350e-0acb-47ee-826e-52f069511cf5"},"id":"275f4b7d-6db9-458c-b4a9-3da61a1f8239","commandName":"SHOW_TECH_SUPPORT","args":[]},"response":{"clientId":{"uuid":"3739350e-0acb-47ee-826e-52f069511cf5"},"responseId":"275f4b7d-6db9-458c-b4a9-3da61a1f8239","commandName":"SHOW_TECH_SUPPORT","value":{"str":"SHOW_TECH_SUPPORT send to client with UUID 3739350e-0acb-47ee-826e-52f069511cf5"},"status":"STARTED"}},"type":"object","properties":{"command":{"title":"command","example":{"clientId":{"uuid":"3739350e-0acb-47ee-826e-52f069511cf5"},"id":"275f4b7d-6db9-458c-b4a9-3da61a1f8239","commandName":"SHOW_TECH_SUPPORT","args":[]},"type":"object","properties":{"clientId":{"title":"ClientId","example":{"uuid":"d58de587-5da2-4a62-b010-32395acc8dbc"},"type":"object","properties":{"uuid":{"type":"string"}},"required":["uuid"],"$$ref":"#/definitions/ClientId"},"id":{"type":"string"},"commandName":{"type":"string"}},"$$ref":"#/definitions/command"},"response":{"title":"response","example":{"clientId":{"uuid":"3739350e-0acb-47ee-826e-52f069511cf5"},"responseId":"275f4b7d-6db9-458c-b4a9-3da61a1f8239","commandName":"SHOW_TECH_SUPPORT","value":{"str":"SHOW_TECH_SUPPORT send to client with UUID 3739350e-0acb-47ee-826e-52f069511cf5"},"status":"STARTED"},"type":"object","properties":{"clientId":{"title":"ClientId","example":{"uuid":"d58de587-5da2-4a62-b010-32395acc8dbc"},"type":"object","properties":{"uuid":{"type":"string"}},"required":["uuid"],"$$ref":"#/definitions/ClientId"},"responseId":{"type":"string"},"commandName":{"type":"string"},"value":{"title":"value","example":{"str":"SHOW_TECH_SUPPORT send to client with UUID 3739350e-0acb-47ee-826e-52f069511cf5"},"type":"object","properties":{"str":{"type":"string"}},"$$ref":"#/definitions/value"},"status":{"type":"string"}},"$$ref":"#/definitions/response"}},"$$ref":"#/definitions/ShowtechStatusResponse"}},"400":{"description":"Bad Request. The request is malformed in some way and the server cannot process it.","headers":{}}},"__originalOperationId":"SubmitShowtechCommand","security":[{"bearerAuth":[]}],"method":"post","path":"/command/showtech"}}