Jump to

• Request
• Response
• Examples

Get a work request item

get

/api/20210901/workRequests/{id}

Return a single work request item by id.

Request

Path Parameters

• id(required): string
  Catalog item ID in base64url format.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

WorkRequest item.

Body ()

Root Schema : WorkRequest

Type: object

Show Source

• Errors: array Errors
  Errors from this work request, if any.
• id(required): string
• operationType(required): string
  Allowed Values: [ "CREATE_SNAPSHOT", "RESTORE_SNAPSHOT", "RELOAD_DATASET" ]
• percentComplete(required): number (float)
  Percentage of the request completed.
• resources: array resources
  Resources this work request affects.
• resourceType: string
  Allowed Values: [ "SNAPSHOT", "SYSTEM", "DATASET" ]

  Type of the resource associated with a work request.
• status(required): string
  Allowed Values: [ "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" ]

  Status of a work request.
• timeAccepted(required): string (date-time)
  Time the work request was accepted, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`
• timeFinished: string (date-time)
  Time the work request was finished, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`
• timeStarted: string (date-time)
  Time the work request was started, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "operationType":{
            "$ref":"#/components/schemas/WorkRequestOperationType"
        },
        "resourceType":{
            "$ref":"#/components/schemas/WorkRequestResourceType"
        },
        "status":{
            "$ref":"#/components/schemas/WorkRequestStatus"
        },
        "resources":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WorkRequestResource"
            },
            "description":"Resources this work request affects.\n"
        },
        "Errors":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WorkRequestError"
            },
            "description":"Errors from this work request, if any.\n"
        },
        "percentComplete":{
            "type":"number",
            "format":"float",
            "description":"Percentage of the request completed.\n"
        },
        "timeAccepted":{
            "type":"string",
            "format":"date-time",
            "description":"Time the work request was accepted, in the format defined by RFC3339.\n\nExample: `2016-08-25T21:10:29.600Z`\n"
        },
        "timeStarted":{
            "type":"string",
            "format":"date-time",
            "description":"Time the work request was started, in the format defined by RFC3339.\n\nExample: `2016-08-25T21:10:29.600Z`\n"
        },
        "timeFinished":{
            "type":"string",
            "format":"date-time",
            "description":"Time the work request was finished, in the format defined by RFC3339.\n\nExample: `2016-08-25T21:10:29.600Z`\n"
        }
    },
    "required":[
        "id",
        "operationType",
        "status",
        "percentComplete",
        "timeAccepted"
    ]
}

Nested Schema : Errors

Type: array

Errors from this work request, if any.

Show Source

• Array of: WorkRequestError

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/WorkRequestError"
    },
    "description":"Errors from this work request, if any.\n"
}

Nested Schema : resources

Type: array

Resources this work request affects.

Show Source

• Array of: object WorkRequestResource

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/WorkRequestResource"
    },
    "description":"Resources this work request affects.\n"
}

Nested Schema : WorkRequestError

Match All

Show Source

• object Error
• object WorkRequestError-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Error"
        },
        {
            "type":"object",
            "properties":{
                "timestamp":{
                    "type":"string",
                    "format":"date-time"
                }
            }
        }
    ]
}

Nested Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Nested Schema : WorkRequestError-allOf[1]

Type: object

Show Source

• timestamp: string (date-time)

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : WorkRequestResource

Type: object

Show Source

• actionResult(required): string
  Way in which this resource was affected by this work request.
• id: string
  ID of the resource the work request is affecting.
• metadata: object metadata
  Additional Properties Allowed: additionalProperties

  Additional metadata of the resource.
• resourceType(required): string
  Allowed Values: [ "SNAPSHOT", "SYSTEM", "DATASET" ]

  Type of the resource associated with a work request.

{
    "properties":{
        "actionResult":{
            "type":"string",
            "description":"Way in which this resource was affected by this work request.\n"
        },
        "resourceType":{
            "$ref":"#/components/schemas/WorkRequestResourceType"
        },
        "id":{
            "type":"string",
            "description":"ID of the resource the work request is affecting."
        },
        "metadata":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Additional metadata of the resource.\n"
        }
    },
    "required":[
        "actionResult",
        "resourceType"
    ]
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Additional metadata of the resource.\n"
}

Additional metadata of the resource.

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404 Response

Not Found. The requested resource was not found.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

409 Response

Conflict (operation results in constraint violation, the operation is incompatible with the current state, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

412 Response

Precondition Failed. One or more preconditions are not satisfied for the operation to proceed.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Back to Top

Examples

You can get detailed status information for a work request using workRequestId or oa-work-request-id. The details include the request type, current status of the request (for example, RUNNING, SUCCEEDED, FAILED), percentage complete, and the time the work request was accepted, started, and completed.

• Example 1: Get snapshot work request status using a workRequestId or oa-work-request-id
• Example 2: Get dataset work request status using a oa-work-request-id

Example 1: Get snapshot work request status using a workRequestId or oa-work-request-id

In this example, you obtain information about a work request where the workRequestId (or oa-work-request-id) is lfc-ab:1-cd:2.

cURL Example:

curl -i \
  --header 'Authorization: Bearer <token>' \
  --request GET 'https://<hostname>/api/20210901/workRequests/lfc-ab:1-cd:2'

Example of Request Body

Not applicable.

Example of Response Body

Status 200:

{

  "id": "lfc-ab:1-cd:2",

  "operationType": "CREATE_SNAPSHOT",

  "percentComplete": 100,

  "status": "SUCCEEDED",

  "timeAccepted": "2021-11-02T17:30:39.123Z",

  "timeStarted": "2021-11-02T17:30:39.123Z",

  "timeFinished": "2021-11-02T17:32:41.798Z",

  "resources": [

    {

      "resourceType": "SNAPSHOT",

      "id": "ac6fdab7-9c16-4d22-a56f-cb7b5d15505a",
 
      "actionResult": "CREATED"

    }

  ]

}

Example 2: Get dataset work request status using a oa-work-request-id

In this example, you obtain information about a work request where the oa-work-request-id is bidr-1E309E468A4518E149438E31294EB54.

cURL Example:

curl -i \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --request GET 'https://<hostname>/api/20210901/workRequests/bidr-1E309E468A4518E149438E31294EB54'

Example of Request Body

Not applicable.

Example of Response Body

Status 200:

{

  "id": "bidr-1E309E468A4518E149438E31294EB54",

  "operationType": "RELOAD_DATASET",

  "percentComplete": 100,

  "resourceType": "DATASET",

  "status": "SUCCEEDED",

  "timeAccepted": "2022-07-06T20:25:11.0+0000",

  "timeStarted": "2022-07-06T20:25:32.0+0000",

  "timeFinished": "2022-07-06T20:25:42.0+0000",

}

Back to Top