Get Request Status

Get request status and generate Report for the operation performed.

Request

URI

GET

https://apigw.vmware.com/v1/m4/api/myvmware/external/requests/{requestId}/status

COPY

Path Parameters

string

requestId

Required

Id of request for which status is needed

requestId example

1uy14hzktpz7n7a9h

Header Parameters

string

Authorization

Required

Bearer Access Token Generated using API Key

Authorization example

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Authentication

This operation uses the following authentication methods.

bearerAuthentication

Responses

200

Report Generated Successfully.

Returns RequestDetailsResponse of type(s) application/json

{
    "id": "1uy14hzktpz7n7a9h",
    "operation": "inviteUsers",
    "performedBy": "[email protected]",
    "creationTime": "1970-01-01T00:00:00.001Z",
    "status": "COMPLETED",
    "message": "Request is completed successfully. Please check report for further details.",
    "report": [
        {
            "[email protected]": "Invitation has been sent to user successfully."
        }
    ]
}

string

Optional

Unique id of which request execution is required to be checked.

string

operation

Optional

Operation performed for this request

string

performedBy

Optional

User who initiated this request

string As date-time As date-time

creationTime

Optional

Timestamp when this request was submitted

string

status

Optional

Current status of the request

string

message

Optional

Current status of the request

object

report

Optional

Report generated after request execution

400

Either request is not valid or input validation has failed.

Returns ErrorResponse of type(s) application/json

{
    "statusCode": 400,
    "timestamp": "string",
    "traceId": "b13a30a88b1e4d64",
    "requestId": "61f8f6d7acb254330dc6cbc9cf993717",
    "errorDetails": [
        {
            "errorCode": "VMW-XXX-XXX",
            "message": "Error occured while processing your request."
        }
    ]
}

integer As int32 As int32

statusCode

Optional

Generally the http code i.e. 400, 500 for the error

string As date-time As date-time

timestamp

Optional

The timestamp of the error

string

traceId

Optional

Unique Trace Id assigned to this request.

string

requestId

Optional

Unique Request Id assigned to this request.

array of ErrorDesription

errorDetails

Optional

Complete error details.

401

Access Token is not valid or expired.

Returns ErrorResponse of type(s) application/json

{
    "statusCode": 400,
    "timestamp": "string",
    "traceId": "b13a30a88b1e4d64",
    "requestId": "61f8f6d7acb254330dc6cbc9cf993717",
    "errorDetails": [
        {
            "errorCode": "VMW-XXX-XXX",
            "message": "Error occured while processing your request."
        }
    ]
}

integer As int32 As int32

statusCode

Optional

Generally the http code i.e. 400, 500 for the error

string As date-time As date-time

timestamp

Optional

The timestamp of the error

string

traceId

Optional

Unique Trace Id assigned to this request.

string

requestId

Optional

Unique Request Id assigned to this request.

array of ErrorDesription

errorDetails

Optional

Complete error details.

404

Operation with given requestId doesn't exist.

Returns ErrorResponse of type(s) application/json

{
    "statusCode": 400,
    "timestamp": "string",
    "traceId": "b13a30a88b1e4d64",
    "requestId": "61f8f6d7acb254330dc6cbc9cf993717",
    "errorDetails": [
        {
            "errorCode": "VMW-XXX-XXX",
            "message": "Error occured while processing your request."
        }
    ]
}

integer As int32 As int32

statusCode

Optional

Generally the http code i.e. 400, 500 for the error

string As date-time As date-time

timestamp

Optional

The timestamp of the error

string

traceId

Optional

Unique Trace Id assigned to this request.

string

requestId

Optional

Unique Request Id assigned to this request.

array of ErrorDesription

errorDetails

Optional

Complete error details.

500

Server error while getting the details.

Returns ErrorResponse of type(s) application/json

{
    "statusCode": 400,
    "timestamp": "string",
    "traceId": "b13a30a88b1e4d64",
    "requestId": "61f8f6d7acb254330dc6cbc9cf993717",
    "errorDetails": [
        {
            "errorCode": "VMW-XXX-XXX",
            "message": "Error occured while processing your request."
        }
    ]
}

integer As int32 As int32

statusCode

Optional

Generally the http code i.e. 400, 500 for the error

string As date-time As date-time

timestamp

Optional

The timestamp of the error

string

traceId

Optional

Unique Trace Id assigned to this request.