Check if timeout is reached - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Check if timeout is reached","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/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":["CWMS utils"],"summary":"Check if timeout is reached","description":"This API checks whether the specified time in \"timeup\" has been reached.\nIf \"timeup\" is zero, it calculates the end time and includes it in the response.\nIn subsequent calls, this end time is used as input to determine if the timeout has been reached.","operationId":"checkTimeOut","requestBody":{"description":"Timeout request","content":{"application/json":{"schema":{"type":"object","properties":{"continue":{"type":"boolean","description":"Continue flag to indicate if the timeout has been reached","example":true},"timeout":{"type":"integer","description":"Timeout in seconds","example":20},"timeup":{"type":"integer","description":"Timeup in milliseconds set by the API","example":1257894020000}},"description":"timeout request object","$$ref":"#/components/schemas/TimeoutRequest"}}},"required":true},"responses":{"200":{"description":"Timed out after specified duration","content":{"application/json":{"schema":{"type":"object","properties":{"continue":{"type":"boolean","description":"Continue flag to indicate if the timeout has been reached","example":true},"timeout":{"type":"integer","description":"Timeout in seconds","example":20},"timeup":{"type":"integer","description":"Timeup in milliseconds set by the API","example":1257894020000}},"description":"timeout request object","$$ref":"#/components/schemas/TimeoutRequest"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"A structure to hold the error details","properties":{"code":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message"},"status":{"type":"string","description":"Status"},"statusInt":{"type":"integer","description":"Status integer"}},"$$ref":"#/components/schemas/AutomationsError"}}}},"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 error details","properties":{"code":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message"},"status":{"type":"string","description":"Status"},"statusInt":{"type":"integer","description":"Status integer"}},"$$ref":"#/components/schemas/AutomationsError"}}}}},"x-codegen-request-body-name":"body","__originalOperationId":"checkTimeOut","method":"post","path":"/cwms-utils/check-timeout"}}