Get Request Broker State

Get Request Broker State

Only Solution users, Container admins, and System admins can retrieve RequestBrokerStates.

Request
URI
GET
https://{api_host}/container-service/api/requests/{id}
COPY
Path Parameters
string
id
Required

The id of the RequestBrokerState


Responses
200

OK with the RequestBrokerState

Returns RequestBrokerState of type(s) */*
{
    "documentExpirationTimeMicros": "string",
    "requestTrackerLink": "string",
    "documentUpdateTimeMicros": "string",
    "serviceTaskCallback": {
        "taskStageFailed": "string",
        "taskStageComplete": "string",
        "serviceSelfLink": "string"
    },
    "documentSelfLink": "string",
    "groupResourcePlacementLink": "string",
    "resourceDescriptionLink": "string",
    "resourceCount": 0,
    "resourceLinks": [
        "string"
    ],
    "tenantLinks": [
        "string"
    ],
    "taskInfo": {
        "stage": "string",
        "failure": {
            "documentKind": "string",
            "errorCode": 0,
            "stackTrace": [
                "string"
            ],
            "message": "string",
            "statusCode": 0
        },
        "isDirect": false
    },
    "operation": "string",
    "taskSubStage": "string",
    "resourceType": "string"
}
string
documentExpirationTimeMicros
Optional

documentExpirationTimeMicros

string
requestTrackerLink
Optional

requestTrackerLink

string
documentUpdateTimeMicros
Optional

documentUpdateTimeMicros

serviceTaskCallback
Optional

serviceTaskCallback

object
customProperties
Optional

customProperties

string
documentSelfLink
Optional

documentSelfLink

string
groupResourcePlacementLink
Optional

groupResourcePlacementLink

string
resourceDescriptionLink
Optional

resourceDescriptionLink

integer As int64 As int64
resourceCount
Optional

resourceCount

array of string
resourceLinks
Optional

resourceLinks

array of string
tenantLinks
Optional

tenantLinks

taskInfo
Optional

taskInfo

string
operation
Optional

operation

string
taskSubStage
Optional

taskSubStage

string
resourceType
Optional

resourceType


404

'Not Found' if no RequestBrokerState with provided id

Operation doesn't return any data structure