[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
Get Task Info
DescriptionRetrieve the task information.
Request
URLURL
https://{api_host}//tasks/{taskId}
Path Parameters
Path Parameters
string
taskId
Required
The ID of the task.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
TaskDrResponseEntity
of type application/json
Information about the task.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"complete_time": 0,
"description": "string",
"description_id": "string",
"entity": "string",
"entity_name": "string",
"error": {
"details": "string",
"message": "string"
},
"id": "string",
"progress": 0,
"queued_time": 0,
"result": {},
"start_time": 0,
"status": "QUEUED"
}
Errors
ResponseError
400
Bad request - the server could not understand the request due to invalid syntax or invalid request body content
401
Unauthorized - the client must authenticate itself to get the requested response
ResponseError
403
Forbidden - not sufficient access rights to fulfill the request
404
Not Found - server cannot find the requested in URL resource
ResponseError
500
Internal server error - unexpected condition prevents fulfilling the request
Code Samples
PowerCLI Client SDK Example
Invoke-SrmGetTaskInfo -taskId "MytaskId"
cURL Command
curl https://{api_host}/tasks/{taskId}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions: System.View
x-dr-remote-site-connectivity-contract:
not-authenticated: FULL_DATA
server-down: FULL_DATA
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
On This Page
Tasks Operations
get
