Jump to

• Request
• Response

List work request errors

get

/20180828/workRequests/{workRequestId}/errors

This path lists the errors for a work request.

Request

Path Parameters

• workRequestId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 10
• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• sortBy: string
  The field that you can use to sort the available information. Only one sort order may be provided. Results in the `timestamp` field are displayed in descending by default.

  Default Value: timestamp

  Allowed Values: [ "timestamp" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list of work request errors was retrieved.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : WorkRequestErrorCollection

Type: object

A list of work request errors. This list can contain both errors and other information, such as metadata.

Show Source

• items(required): array items
  A list of work request errors.

{
    "type":"object",
    "description":"A list of work request errors. This list can contain both errors and other information, such as metadata.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"A list of work request errors.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkRequestError"
            }
        }
    }
}

Nested Schema : items

Type: array

A list of work request errors.

Show Source

• Array of: object WorkRequestError
  An error encountered while performing an operation that is tracked by a work request.

{
    "description":"A list of work request errors.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/WorkRequestError"
    }
}

Nested Schema : WorkRequestError

Type: object

An error encountered while performing an operation that is tracked by a work request.

Show Source

• code(required): string
  A machine-usable code for the error that occurred. For a list of error codes, see the following resource: [API Errors](/iaas/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error message.
• timestamp(required): string(date-time)
  The date and time the error occurred, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).

{
    "description":"An error encountered while performing an operation that is tracked by a work request.",
    "properties":{
        "code":{
            "type":"string",
            "description":"A machine-usable code for the error that occurred. For a list of error codes, see the following resource:\n[API Errors](/iaas/Content/API/References/apierrors.htm).\n"
        },
        "message":{
            "type":"string",
            "description":"A human-readable error message."
        },
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the error occurred, in the format defined by\n[RFC 3339](https://tools.ietf.org/html/rfc3339).\n"
        }
    },
    "required":[
        "code",
        "message",
        "timestamp"
    ]
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

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

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

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

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

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

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

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

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

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

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

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

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top