{"type":"api","title":"Get Resource details","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/b95772dc6c621d9842faced8610ee58b0cb9cb02/773d8c2d-0de2-3906-8d3f-8a19d6895750","info":{"title":"Crosswork Workflow Manager Solutions - Automations","description":"The automation service acts as an orchestrator, handling the scheduling, execution,\nbatch processing, and monitoring of MOPs and their activities. The API provides endpoints for managing these operations.","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"},"version":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/CWM-SOLUTIONS/automations-api.overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://crosswork-ip:30603/crosswork/cwms/automations/v1"}]},"spec":{"tags":["MOP Jobs"],"summary":"Get Resource details","description":"This API provides an overview of resource execution, offering insights into the\ncurrent status of the resource, the stages it has progressed through,\nand all activities carried out at each stage.","operationId":"describeResource","parameters":[{"name":"job-id","in":"path","description":"Job ID","required":true,"schema":{"type":"string"}},{"name":"resource-id","in":"path","description":"Resource ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the resource status","content":{"application/json":{"schema":{"type":"object","description":"A structure to hold the resource details","properties":{"activities":{"type":"array","description":"List of activities associated with the resource","items":{"type":"object","description":"A structure to hold the activity details","properties":{"cwmJobURI":{"type":"string","description":"URI to the CWM job details"},"details":{"type":"object","description":"Any stash data stored for the activity"},"message":{"type":"string","description":"Message explaining the status of the activity"},"name":{"type":"string","description":"Name of the activity"},"order":{"type":"integer","description":"Order of the activity within the MOP"},"result":{"type":"string","description":"enum of success, warning, failure, running"},"stage":{"type":"string","description":"Stage the activity is executed"},"startDateTime":{"type":"string","description":"Start date and time of the activity"},"endDateTime":{"type":"string","description":"End date and time of the activity"}},"$$ref":"#/components/schemas/Activity"}},"deviceUuid":{"type":"string","description":"Device UUID"},"name":{"type":"string","description":"Resource name"},"result":{"type":"string","description":"enum of success, warning, failure, running, pending"}},"$$ref":"#/components/schemas/DescribeResourceResponse"}}}},"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"A structure to hold the standard response","properties":{"code":{"type":"integer","description":"HTTP status code"},"key":{"type":"string","description":"Key to retrieve the job details"},"message":{"type":"string","description":"Message"},"status":{"type":"string","description":"Status"},"statusInt":{"type":"integer","description":"Status integer"}},"$$ref":"#/components/schemas/StandardResponse"}}}},"406":{"description":"API requests are not acceptable at this time","content":{"application/json":{"schema":{"type":"object","description":"A structure to hold the standard response","properties":{"code":{"type":"integer","description":"HTTP status code"},"key":{"type":"string","description":"Key to retrieve the job details"},"message":{"type":"string","description":"Message"},"status":{"type":"string","description":"Status"},"statusInt":{"type":"integer","description":"Status integer"}},"$$ref":"#/components/schemas/StandardResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"A structure to hold the standard response","properties":{"code":{"type":"integer","description":"HTTP status code"},"key":{"type":"string","description":"Key to retrieve the job details"},"message":{"type":"string","description":"Message"},"status":{"type":"string","description":"Status"},"statusInt":{"type":"integer","description":"Status integer"}},"$$ref":"#/components/schemas/StandardResponse"}}}}},"__originalOperationId":"describeResource","method":"get","path":"/status/job/{job-id}/resource/{resource-id}"}}