Create Request Broker State

Create Request Broker State

Only Solution users, Container admins, Container developers and System admins can create RequestBrokerStates.

Request
URI
POST
https://{api_host}/container-service/api/requests
COPY
Request Body
RequestBrokerState of type(s) application/json
Required 
{
    "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
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

TaskState
taskInfo
Optional

taskInfo

string
operation
Optional

operation

string
taskSubStage
Optional

taskSubStage

string
resourceType
Optional

resourceType

Responses
200

successful operation

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
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

TaskState
taskInfo
Optional

taskInfo

string
operation
Optional

operation

string
taskSubStage
Optional

taskSubStage

string
resourceType
Optional

resourceType


201

'Created' is returned for the new state with the state url in the location header of the response;

Operation doesn't return any data structure

On This Page
Requests Operations
POST
Create Request Broker State
DELETE
Delete Request Broker State
GET
Get Request Broker State
GET
List Request Broker State
PATCH
Patch Request Broker State
PUT
Update Request Broker State