Jump to

• Request
• Response

GetTaggingWorkRequest

get

/20160918/taggingWorkRequests/{work_request_id}

Get details of a specified work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the tagging service.

Request

Supported Media Types

• application/json

Path Parameters

• workRequestId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the work request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The work request was retrieved.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
• retry-after: number(float)
  The number of seconds that the client should wait before polling again.

Body ()

Root Schema : TaggingWorkRequest

Type: object

The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows.

Show Source

• compartmentId: string
  The OCID of the compartment that contains the work request.
• id(required): string
  The OCID of the work request.
• operationType(required): string
  Allowed Values: [ "DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", "IMPORT_STANDARD_TAGS" ]

  An enum-like description of the type of work the work request is doing.
• percentComplete: number(float)
  Minimum Value: 1

  Maximum Value: 100

  How much progress the operation has made.
• resources: array resources
  The resources this work request affects.
• status(required): string
  Allowed Values: [ "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "PARTIALLY_SUCCEEDED", "CANCELING", "CANCELED" ]

  The current status of the work request.
• timeAccepted: string(date-time)
  Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
• timeFinished: string(date-time)
  Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
• timeStarted: string(date-time)
  Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

{
    "description":"The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows.",
    "required":[
        "id",
        "operationType",
        "status"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The OCID of the work request."
        },
        "operationType":{
            "type":"string",
            "enum":[
                "DELETE_TAG_DEFINITION",
                "DELETE_NON_EMPTY_TAG_NAMESPACE",
                "BULK_DELETE_TAG_DEFINITION",
                "BULK_EDIT_OF_TAGS",
                "IMPORT_STANDARD_TAGS"
            ],
            "description":"An enum-like description of the type of work the work request is doing."
        },
        "compartmentId":{
            "type":"string",
            "description":"The OCID of the compartment that contains the work request."
        },
        "status":{
            "type":"string",
            "enum":[
                "ACCEPTED",
                "IN_PROGRESS",
                "FAILED",
                "SUCCEEDED",
                "PARTIALLY_SUCCEEDED",
                "CANCELING",
                "CANCELED"
            ],
            "description":"The current status of the work request."
        },
        "resources":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkRequestResource"
            },
            "description":"The resources this work request affects."
        },
        "timeAccepted":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z "
        },
        "timeStarted":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z "
        },
        "timeFinished":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z "
        },
        "percentComplete":{
            "type":"number",
            "format":"float",
            "minimum":"1",
            "maximum":"100",
            "description":"How much progress the operation has made."
        }
    },
    "type":"object"
}

Nested Schema : resources

Type: array

The resources this work request affects.

Show Source

• Array of: object WorkRequestResource
  A resource that is created or operated on by an asynchronous operation that is tracked by a work request.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WorkRequestResource"
    },
    "description":"The resources this work request affects."
}

Nested Schema : WorkRequestResource

Type: object

A resource that is created or operated on by an asynchronous operation that is tracked by a work request.

Show Source

• actionType(required): string
  Allowed Values: [ "CREATED", "UPDATED", "DELETED", "RELATED", "IN_PROGRESS", "FAILED" ]

  The way in which this resource was affected by the operation that spawned the work request.
• entityType(required): string
  The resource type the work request affects.
• entityUri: string
  The URI path that you can use for a GET request to access the resource metadata.
• identifier(required): string
  An OCID or other unique identifier for the resource.

{
    "description":"A resource that is created or operated on by an asynchronous operation that is tracked by a work request.",
    "properties":{
        "actionType":{
            "description":"The way in which this resource was affected by the operation that spawned the work request.",
            "type":"string",
            "enum":[
                "CREATED",
                "UPDATED",
                "DELETED",
                "RELATED",
                "IN_PROGRESS",
                "FAILED"
            ]
        },
        "entityType":{
            "description":"The resource type the work request affects.",
            "type":"string"
        },
        "identifier":{
            "description":"An OCID or other unique identifier for the resource.",
            "type":"string"
        },
        "entityUri":{
            "description":"The URI path that you can use for a GET request to access the resource metadata.",
            "type":"string"
        }
    },
    "required":[
        "actionType",
        "entityType",
        "identifier"
    ],
    "type":"object"
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top