Job Status

To check the status of a previously submitted group jobs as a Product Admin, use the API below.

info

{api-base-url} can be obtained from the MirrorFly console.

HTTP request#

curl -X GET 'http://{api-base-url}/api/v1/group/jobs?jobId=:jobId' \
--header 'Authorization:xxxxxxx'

Request Params#

ParamDataTypeRequiredDescription
jobIdStringYesID of the group delete job

Responses#

If successful, this action deletes the given group.

{
"status": 200,
"data": {
"id": <numeric-id>,
"jobId": "<job-uuid>",
"jobType": "GROUP_DELETION",
"jobReferenceId": "<group-id>",
"status": "<job-status>",
"requestedBy": "<requested-by>",
"createdAt": "<timestamp>",
"updatedAt": "<timestamp>",
"metadata": <object>, // Meta Information about the submited Job
"remarks": "<optional remarks>"
},
"message": "Job status retrieved",
"error": false
}

Error#

In the case of an error, an error object like below is returned.

When the token passed in Headers is expired

{
"status": 401,
"message": "Token Expired"
}

In the case of a Unauthorized access (not a Product Admin)

{
"status": 403,
"message": "User access denied",
"error": true
}