Jump to

• Request
• Response

List Work Request Logs

get

/20190828/workRequests/{workRequestId}/logs

Return a (paginated) list of logs for a given work request.

Request

Path Parameters

• workRequestId: string
  The ID of the asynchronous request.

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  The maximum number of items to return.

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

  Maximum Length: 1024

  The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Header Parameters

• opc-request-id: string
  The client request ID for tracing.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of work request logs.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• 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 : WorkRequestLogEntryCollection

Type: object

Results of ListWorkRequestLogs

Show Source

• items(optional): array items
  A page of WorkRequestLogEntry objects.

{
    "description":"Results of ListWorkRequestLogs",
    "type":"object",
    "properties":{
        "items":{
            "description":"A page of WorkRequestLogEntry objects.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkRequestLogEntry"
            }
        }
    }
}

Nested Schema : items

Type: array

A page of WorkRequestLogEntry objects.

Show Source

• Array of: object WorkRequestLogEntry
  A log message from the execution of a work request.

{
    "description":"A page of WorkRequestLogEntry objects.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/WorkRequestLogEntry"
    }
}

Nested Schema : WorkRequestLogEntry

Type: object

A log message from the execution of a work request.

Show Source

• message: string
  Human-readable log message.
• timestamp: string(date-time)
  The time the log message was written. An RFC3339 formatted datetime string.

{
    "description":"A log message from the execution of a work request.",
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable log message."
        },
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The time the log message was written. An RFC3339 formatted datetime string."
        }
    },
    "required":[
        "message",
        "timestamp"
    ]
}

400 Response

Bad Request

Headers

• 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 : Error

Type: object

Error Information.

Show Source

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

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

401 Response

Unauthorized

Headers

• 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 : Error

Type: object

Error Information.

Show Source

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

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

404 Response

Not Found

Headers

• 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 : Error

Type: object

Error Information.

Show Source

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

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

429 Response

Too Many Requests

Headers

• 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.
• retry-after: number(float)
  A decimal number representing the number of seconds the client should wait before polling this endpoint again.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

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

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

500 Response

Internal Server Error

Headers

• 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 : Error

Type: object

Error Information.

Show Source

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

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

Default Response

Unknown Error

Headers

• 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 : Error

Type: object

Error Information.

Show Source

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

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

Back to Top