Run Closure

Run Closure

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

Request
URI
POST
https://{api_host}/container-service/api/resources/closures/{id}
COPY
Path Parameters
string
id
Required

The id of the ClosureState

Request Body
ClosureState of type(s) application/json
Optional 
{
    "documentExpirationTimeMicros": "string",
    "parentLink": "string",
    "descriptionLink": "string",
    "documentUpdateTimeMicros": "string",
    "errorMsg": "string",
    "regionId": "string",
    "lastLeasedTimeMillis": 0,
    "documentSelfLink": "string",
    "tagLinks": [
        "string"
    ],
    "name": "string",
    "closureSemaphore": "string",
    "resourceLinks": [
        "string"
    ],
    "groupLinks": [
        "string"
    ],
    "tenantLinks": [
        "string"
    ],
    "id": "string",
    "state": "string",
    "logs": [
        "string"
    ],
    "desc": "string"
}
object
outputs
Optional

outputs

string
documentExpirationTimeMicros
Optional

documentExpirationTimeMicros

string
parentLink
Optional

parentLink

object
inputs
Optional

inputs

string
descriptionLink
Optional

descriptionLink

string
documentUpdateTimeMicros
Optional

documentUpdateTimeMicros

string
errorMsg
Optional

errorMsg

object
customProperties
Optional

customProperties

string
regionId
Optional

regionId

integer As int64 As int64
lastLeasedTimeMillis
Optional

lastLeasedTimeMillis

string
documentSelfLink
Optional

documentSelfLink

array of string
tagLinks
Optional

tagLinks

string
name
Optional

name

string
closureSemaphore
Optional

closureSemaphore

array of string
resourceLinks
Optional

resourceLinks

array of string
groupLinks
Optional

groupLinks

array of string
tenantLinks
Optional

tenantLinks

string
id
Optional

id

string
state
Optional

state

Possible values are : CREATED, STARTED, FINISHED, FAILED, CANCELLED,
array of string
logs
Optional

logs

string
desc
Optional

desc

Responses
200

OK with the Closure Run

Returns ClosureState of type(s) */* 
{
    "documentExpirationTimeMicros": "string",
    "parentLink": "string",
    "descriptionLink": "string",
    "documentUpdateTimeMicros": "string",
    "errorMsg": "string",
    "regionId": "string",
    "lastLeasedTimeMillis": 0,
    "documentSelfLink": "string",
    "tagLinks": [
        "string"
    ],
    "name": "string",
    "closureSemaphore": "string",
    "resourceLinks": [
        "string"
    ],
    "groupLinks": [
        "string"
    ],
    "tenantLinks": [
        "string"
    ],
    "id": "string",
    "state": "string",
    "logs": [
        "string"
    ],
    "desc": "string"
}
object
outputs
Optional

outputs

string
documentExpirationTimeMicros
Optional

documentExpirationTimeMicros

string
parentLink
Optional

parentLink

object
inputs
Optional

inputs

string
descriptionLink
Optional

descriptionLink

string
documentUpdateTimeMicros
Optional

documentUpdateTimeMicros

string
errorMsg
Optional

errorMsg

object
customProperties
Optional

customProperties

string
regionId
Optional

regionId

integer As int64 As int64
lastLeasedTimeMillis
Optional

lastLeasedTimeMillis

string
documentSelfLink
Optional

documentSelfLink

array of string
tagLinks
Optional

tagLinks

string
name
Optional

name

string
closureSemaphore
Optional

closureSemaphore

array of string
resourceLinks
Optional

resourceLinks

array of string
groupLinks
Optional

groupLinks

array of string
tenantLinks
Optional

tenantLinks

string
id
Optional

id

string
state
Optional

state

Possible values are : CREATED, STARTED, FINISHED, FAILED, CANCELLED,
array of string
logs
Optional

logs

string
desc
Optional

desc


404

'Not Found' if no ClosureState with provided id

Operation doesn't return any data structure

On This Page
Closures Operations
POST
Create Closure Description
POST
Create Closure State
DELETE
Delete Closure Description
DELETE
Delete Closure State
GET
Get Closure Description
GET
Get Closure State
GET
List Closure Description
GET
List Closure State
PATCH
Patch Closure Description
PATCH
Patch Closure State
POST
Run Closure
PUT
Update Closure Description
PUT
Update Closure State