Jump to

• Request
• Response

Mark allergies as reviewed

post

/20240101/actions/markAllergiesReviewed

Marks allergies as reviewed for the provided patient ID.

Allergies in an ACTIVE, PROPOSED, and RESOLVED status are marked as reviewed.

Users must have view privileges to mark allergies as reviewed.

A maximum limit of 100 allergies can be marked as reviewed at a time.

Request

Query Parameters

• patientId(required): string
  The patient ID to filter the resource query against.

Header Parameters

• accept: string
  Specifies which media types are acceptable for the response. Defaults to application/json.

  Default Value: application/json
• authorization(required): string
  Contains the credentials to authenticate a consumer to the service.
• opc-request-id: string
  Unique Oracle Health assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

Body ()

A list of allergy IDs and versions to be marked as reviewed.

Root Schema : MarkAllergiesReviewedDetails

Type: object

The allergies to be marked reviewed. A maximum limit of 100 allergies can be marked reviewed at a time.

Show Source

• allergies(required): array allergies
  Minimum Number of Items: 1

  Maximum Number of Items: 100

  Unique Items Required: true

  The allergies to be marked as reviewed.
• encounterId: string
  The active encounter used while reviewing the allergy.

{
    "type":"object",
    "description":"The allergies to be marked reviewed. A maximum limit of 100 allergies can be marked reviewed at a time.",
    "required":[
        "allergies"
    ],
    "properties":{
        "encounterId":{
            "type":"string",
            "description":"The active encounter used while reviewing the allergy."
        },
        "allergies":{
            "description":"The allergies to be marked as reviewed.",
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AllergyToReview"
            },
            "minItems":1,
            "maxItems":100
        }
    }
}

Nested Schema : allergies

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 100

Unique Items Required: true

The allergies to be marked as reviewed.

Show Source

• Array of: object AllergyToReview
  The allergy to be marked as reviewed.

{
    "description":"The allergies to be marked as reviewed.",
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AllergyToReview"
    },
    "minItems":1,
    "maxItems":100
}

Nested Schema : AllergyToReview

Type: object

The allergy to be marked as reviewed.

Show Source

• id(required): string
  The unique identifier of the allergy.
• version(required): string
  The unique identifier of this version of the allergy.

{
    "type":"object",
    "description":"The allergy to be marked as reviewed.",
    "required":[
        "id",
        "version"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier of the allergy."
        },
        "version":{
            "type":"string",
            "description":"The unique identifier of this version of the allergy."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

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.

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 : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• 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"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers that caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers
  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers that caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
    "items":{
        "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 : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• 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"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers that caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers
  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers that caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
    "items":{
        "type":"string"
    }
}

403 Response

NotAuthorized

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 : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• 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"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers that caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers
  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers that caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
    "items":{
        "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 : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• 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"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers that caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers
  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers that caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
    "items":{
        "type":"string"
    }
}

409 Response

Conflict

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 : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• 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"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers that caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers
  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers that caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
    "items":{
        "type":"string"
    }
}

422 Response

Unprocessable Entity

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 : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• 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"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers that caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers
  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers that caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
    "items":{
        "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.

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• 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"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers that caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers
  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers that caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
    "items":{
        "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 : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• 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"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

A list of details regarding any and all errors from the resulting service request.

Show Source

• Array of: object ErrorDetail
  Additional detail information pertaining to the error.

{
    "type":"array",
    "description":"A list of details regarding any and all errors from the resulting service request.",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

• detail: string
  A human-readable explanation specific to this occurrence of the problem.
• source: object ErrorDetailSource
  An object containing references to the source of the error.

{
    "type":"object",
    "description":"Additional detail information pertaining to the error.",
    "properties":{
        "detail":{
            "type":"string",
            "description":"A human-readable explanation specific to this occurrence of the problem."
        },
        "source":{
            "$ref":"#/definitions/ErrorDetailSource"
        }
    }
}

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

• headers: array headers
  A list of the request headers that caused the error.
• parameters: array parameters
  A list of which URI query parameters caused the error.
• pointers: array pointers
  A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

{
    "type":"object",
    "description":"An object containing references to the source of the error.\n",
    "properties":{
        "pointers":{
            "type":"array",
            "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
            "items":{
                "type":"string"
            }
        },
        "parameters":{
            "type":"array",
            "description":"A list of which URI query parameters caused the error.",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"array",
            "description":"A list of the request headers that caused the error.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of the request headers that caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of which URI query parameters caused the error.",
    "items":{
        "type":"string"
    }
}

Nested Schema : pointers

Type: array

A list of JSON Pointers (RFC6901) to the values in the request document that caused the error. For example, /data for a primary data object, or /data/attributes/title for a specific attribute. A JSON Pointer must point to a value in the request document that exists. If it does not exist, the client should ignore the pointer.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of JSON Pointers (<a\nhref=\"https://datatracker.ietf.org/doc/html/rfc6901\">RFC6901</a>) to the values in the request document that caused the error. \nFor example, <code>/data</code> for a primary data object, or <code>/data/attributes/title</code> for a specific attribute. A JSON Pointer must \npoint to a value in the request document that exists. If it does not exist, the client should ignore the pointer.\n",
    "items":{
        "type":"string"
    }
}

Back to Top