Jump to

• Request
• Response

Get a list of historical versions by allergy ID

get

/20240101/allergies/{allergyId}/versions

Retrieves the historical versions for the allergy ID. Each history contains the changes from the previous version.

Request

Path Parameters

• allergyId(required): string
  The unique identifier of the allergy.

Query Parameters

• limit: integer
  Minimum Value: 100

  Maximum Value: 100

  For list pagination. The maximum number of results per page, or items to return in a paginated List call.

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

  For list pagination. The value of the opc-next-page response header from the previous List request.
• 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
• accept-charset: string
  Specifies which character sets are acceptable for the response. Defaults to UTF-8.

  Default Value: UTF-8
• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain.
• opc-prev-page: string
  For list pagination. When this header appears in the response, additional pages of results remain.
• 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 : AllergyVersionCollection

Type: object

The list of all the versions for an allergy.

Show Source

• items(required): array items
  Unique Items Required: true

  The list of allergy versions for an allergy.

{
    "type":"object",
    "description":"The list of all the versions for an allergy.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"The list of allergy versions for an allergy.",
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AllergyVersionSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Unique Items Required: true

The list of allergy versions for an allergy.

Show Source

• Array of: object AllergyVersionSummary
  A version of an allergy that includes AllergySummary and other fields that display changes from the previous version.

{
    "description":"The list of allergy versions for an allergy.",
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AllergyVersionSummary"
    }
}

Nested Schema : AllergyVersionSummary

Type: object

A version of an allergy that includes AllergySummary and other fields that display changes from the previous version.

Show Source

• allergyFieldUpdates: array allergyFieldUpdates
  The list of changes made to allergy fields in the current instance. This value can be null.
• allergySummary(required): object AllergySummary
  The summary of an allergy that contains only important information about the allergy.
• areNotesAdded(required): boolean
  Boolean flag to indicate if notes were added to the current instance.
• combineDetails: object Combine
  The details of where the changes to an allergy based on a combine came from.
• effectiveDateTimePeriod(required): object DateTimePeriodWithoutZone
  A representation of a date and time range without time zone information.
• lastModifiedBy(required): object PersonSimple
  A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.
• lastModifiedDateTime(required): string(date-time)
  The date and time that represents the end of the current instance's effectiveness in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ) as defined by RFC 3339.

  Example: 2018-06-16T21:31:35.457Z
• reactionVersions: array reactionVersions

  The versions of reactions associated with the current allergy.

  A history of reaction versions is returned only for reactions with changes, or a new reaction. This value can be null.

• reviewInfo: object ReviewInfo
  The information around who and when the data was reviewed.

{
    "description":"A version of an allergy that includes <code>AllergySummary</code> and other fields that display changes from the previous version.",
    "type":"object",
    "required":[
        "areNotesAdded",
        "effectiveDateTimePeriod",
        "lastModifiedDateTime",
        "lastModifiedBy",
        "allergySummary"
    ],
    "properties":{
        "areNotesAdded":{
            "type":"boolean",
            "description":"Boolean flag to indicate if notes were added to the current instance."
        },
        "effectiveDateTimePeriod":{
            "description":"The <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a> date and time representing the period of this instance's effectiveness.",
            "$ref":"#/definitions/DateTimePeriodWithoutZone"
        },
        "lastModifiedDateTime":{
            "type":"string",
            "format":"date-time",
            "example":"2018-06-16T21:31:35.457Z",
            "description":"The date and time that represents the end of the current instance's effectiveness in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ)\nas defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\n"
        },
        "lastModifiedBy":{
            "description":"The personnel member who made this update.",
            "$ref":"#/definitions/PersonSimple"
        },
        "allergySummary":{
            "description":"The summary of the allergy for this instance that contains only important information about the allergy.\n",
            "$ref":"#/definitions/AllergySummary"
        },
        "allergyFieldUpdates":{
            "type":"array",
            "description":"The list of changes made to allergy fields in the current instance. This value can be null.",
            "items":{
                "$ref":"#/definitions/UpdatedAllergyField"
            }
        },
        "reactionVersions":{
            "type":"array",
            "description":"<p>The versions of reactions associated with the current allergy.</p> \n<p>A history of reaction versions is returned only for reactions with changes, or a new reaction. This value can be null.</p>\n",
            "items":{
                "$ref":"#/definitions/ReactionVersion"
            }
        },
        "reviewInfo":{
            "description":"Details of the review of the current instance. This value can be null.",
            "$ref":"#/definitions/ReviewInfo"
        },
        "combineDetails":{
            "description":"Details of where the changes to an allergy based on a combine came from. This value can be null.",
            "$ref":"#/definitions/Combine"
        }
    }
}

Nested Schema : allergyFieldUpdates

Type: array

The list of changes made to allergy fields in the current instance. This value can be null.

Show Source

• Array of: object UpdatedAllergyField
  A record of the change to an allergy version.

{
    "type":"array",
    "description":"The list of changes made to allergy fields in the current instance. This value can be null.",
    "items":{
        "$ref":"#/definitions/UpdatedAllergyField"
    }
}

Nested Schema : AllergySummary

Type: object

The summary of an allergy that contains only important information about the allergy.

Show Source

• createdBy(required): object PersonSimple
  A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.
• createdDateTime(required): string(date-time)
  The date and time that the allergy was created in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ) as defined by RFC 3339.

  Example: 2018-06-16T21:31:35.457Z
• id(required): string
  The unique identifier of the allergy.
• lastModifiedBy(required): object PersonSimple
  A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.
• lastModifiedDateTime(required): string(date-time)
  The date and time that the allergy was last modified in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ) as defined by RFC 3339.

  Example: 2018-06-16T21:31:35.457Z
• patient(required): object PersonSimple
  A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.
• substance(required): object NomenclatureOrFreetextValue
  The nomenclature or free text value of the data.
• version(required): string
  The unique identifier of the instance for this allergy.

{
    "description":"The summary of an allergy that contains only important information about the allergy.",
    "type":"object",
    "required":[
        "id",
        "version",
        "createdDateTime",
        "createdBy",
        "lastModifiedDateTime",
        "lastModifiedBy",
        "patient",
        "substance"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier of the allergy."
        },
        "version":{
            "type":"string",
            "description":"The unique identifier of the instance for this allergy."
        },
        "createdDateTime":{
            "type":"string",
            "format":"date-time",
            "example":"2018-06-16T21:31:35.457Z",
            "description":"The date and time that the allergy was created in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ)\nas defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\n"
        },
        "createdBy":{
            "description":"The original personnel who created this allergy",
            "$ref":"#/definitions/PersonSimple"
        },
        "lastModifiedDateTime":{
            "type":"string",
            "format":"date-time",
            "example":"2018-06-16T21:31:35.457Z",
            "description":"The date and time that the allergy was last modified in the ISO-8601 representation of the date and time format (YYYY-MM-DDTHH:MM:SS:SSSZ)\nas defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\n"
        },
        "lastModifiedBy":{
            "description":"The personnel member who last updated the allergy.",
            "$ref":"#/definitions/PersonSimple"
        },
        "patient":{
            "description":"The patient details of the allergy.",
            "$ref":"#/definitions/PersonSimple"
        },
        "substance":{
            "description":"The substance causing this allergy.",
            "$ref":"#/definitions/NomenclatureOrFreetextValue"
        }
    }
}

Nested Schema : Combine

Type: object

The details of where the changes to an allergy based on a combine came from.

Show Source

• allergyId(required): string
  The identifier of the allergy that was combined.
• combinedPatient(required): object PersonSimple
  A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.

{
    "type":"object",
    "description":"The details of where the changes to an allergy based on a combine came from.",
    "required":[
        "combinedPatient",
        "allergyId"
    ],
    "properties":{
        "combinedPatient":{
            "description":"The patient from whom the allergy was combined.",
            "$ref":"#/definitions/PersonSimple"
        },
        "allergyId":{
            "type":"string",
            "description":"The identifier of the allergy that was combined."
        }
    }
}

Nested Schema : DateTimePeriodWithoutZone

Type: object

A representation of a date and time range without time zone information.

Show Source

• endDateTime: string(date-time)
  The date and time represented in YYYY-MM-DDTHH:MM:SS:SSSZ format without the UTC offset as defined by RFC 3339. No time zone information is associated with this date and time.

  Example: 2018-06-16T21:31:35.457Z
• startDateTime: string(date-time)
  The date and time represented in YYYY-MM-DDTHH:MM:SS:SSSZ format without the UTC offset as defined by RFC 3339. No time zone information is associated with this date and time.

  Example: 2018-06-16T21:31:35.457Z

{
    "type":"object",
    "description":"A representation of a date and time range without time zone information.",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "example":"2018-06-16T21:31:35.457Z",
            "description":"The date and time represented in YYYY-MM-DDTHH:MM:SS:SSSZ format without the UTC offset as defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\nNo time zone information is associated with this date and time.\n"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "example":"2018-06-16T21:31:35.457Z",
            "description":"The date and time represented in YYYY-MM-DDTHH:MM:SS:SSSZ format without the UTC offset as defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\nNo time zone information is associated with this date and time.\n"
        }
    }
}

Nested Schema : PersonSimple

Type: object

A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.

Show Source

• id(required): string
  The unique identifier for the individual.
• name: object PersonNameSummary
  A summary of just first, last, and full name for a person (which could be a personnel member, patient, or nonpatient person).

{
    "description":"A simple representation of the individual person that was retrieved.\nThe individual could be a personnel member (provider), a patient, or a nonpatient person.\n",
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"The unique identifier for the individual.",
            "type":"string"
        },
        "name":{
            "description":"The name of the individual.",
            "$ref":"#/definitions/PersonNameSummary"
        }
    }
}

Nested Schema : reactionVersions

Type: array

The versions of reactions associated with the current allergy.

A history of reaction versions is returned only for reactions with changes, or a new reaction. This value can be null.

Show Source

• Array of: object ReactionVersion
  A version of a reaction.

{
    "type":"array",
    "description":"<p>The versions of reactions associated with the current allergy.</p> \n<p>A history of reaction versions is returned only for reactions with changes, or a new reaction. This value can be null.</p>\n",
    "items":{
        "$ref":"#/definitions/ReactionVersion"
    }
}

Nested Schema : ReviewInfo

Type: object

The information around who and when the data was reviewed.

Show Source

• reviewedBy(required): object PersonSimple
  A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.
• reviewedDateTime(required): object DateTimeWithZone
  A representation of the date and time with the time zone.

{
    "description":"The information around who and when the data was reviewed.",
    "type":"object",
    "required":[
        "reviewedDateTime",
        "reviewedBy"
    ],
    "properties":{
        "reviewedDateTime":{
            "$ref":"#/definitions/DateTimeWithZone",
            "description":"The date and time and time zone the review occurred in."
        },
        "reviewedBy":{
            "description":"The details of the personnel member who reviewed this data.",
            "$ref":"#/definitions/PersonSimple"
        }
    }
}

Nested Schema : UpdatedAllergyField

Type: object

A record of the change to an allergy version.

Show Source

• currentValue(required): string
  The current value of the field.
• field(required): string
  Allowed Values: [ "CANCEL_REASON", "INFO_SOURCE", "CRITICALITY", "STATUS", "CATEGORY", "REACTION_TYPE", "ONSET_DATETIME", "ONSET_PRECISION", "ONSET_UNIT" ]

  The name of the field that has changed.
• previousValue: string
  The previous value of the field.

{
    "description":"A record of the change to an allergy version.",
    "type":"object",
    "required":[
        "field",
        "currentValue"
    ],
    "properties":{
        "field":{
            "description":"The name of the field that has changed.",
            "type":"string",
            "enum":[
                "CANCEL_REASON",
                "INFO_SOURCE",
                "CRITICALITY",
                "STATUS",
                "CATEGORY",
                "REACTION_TYPE",
                "ONSET_DATETIME",
                "ONSET_PRECISION",
                "ONSET_UNIT"
            ]
        },
        "previousValue":{
            "type":"string",
            "description":"The previous value of the field."
        },
        "currentValue":{
            "type":"string",
            "description":"The current value of the field."
        }
    }
}

Nested Schema : NomenclatureOrFreetextValue

Type: object

The nomenclature or free text value of the data.

Show Source

• freeText: string
  The free text display of the data. This display is returned only if the type is FREE_TEXT.
• nomenclature: object NomenclatureSimple
  The model object for a nomenclature.
• type(required): string
  Allowed Values: [ "NOMENCLATURE", "FREE_TEXT" ]

  The type of value the data is captured as.

{
    "description":"The nomenclature or free text value of the data.",
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "nomenclature":{
            "description":"The nomenclature details of the data. The details are returned only if the type is <code>NOMENCLATURE</code>.",
            "$ref":"#/definitions/NomenclatureSimple"
        },
        "freeText":{
            "type":"string",
            "description":"The free text display of the data. This display is returned only if the type is <code>FREE_TEXT</code>."
        },
        "type":{
            "type":"string",
            "description":"The type of value the data is captured as.",
            "enum":[
                "NOMENCLATURE",
                "FREE_TEXT"
            ]
        }
    }
}

Nested Schema : NomenclatureSimple

Type: object

The model object for a nomenclature.

Show Source

• code: string
  The universal clinical code of the term.

  Example: 452.5b
• conceptCki: string
  The concept CKI of the nomenclature.
• displayName: string
  The display of the nomenclature.

  Example: Anemia Nomenclature
• id(required): string
  The unique identifier of the nomenclature.

  Example: 1643574645
• terminology: object CodeValueSimple
  A minimal representation of a code value.
• terminologyAxis: object CodeValueSimple
  A minimal representation of a code value.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "example":"1643574645",
            "description":"The unique identifier of the nomenclature."
        },
        "displayName":{
            "type":"string",
            "example":"Anemia Nomenclature",
            "description":"The display of the nomenclature."
        },
        "code":{
            "type":"string",
            "example":"452.5b",
            "description":"The universal clinical code of the term."
        },
        "conceptCki":{
            "type":"string",
            "description":"The concept CKI of the nomenclature."
        },
        "terminology":{
            "description":"A code value representing the terminology (in other words, the vocabulary) that the nomenclature is associated with.",
            "$ref":"#/definitions/CodeValueSimple"
        },
        "terminologyAxis":{
            "description":"A code value representing the terminology axis of this concept, used to further segment where this concept falls within a terminology.",
            "$ref":"#/definitions/CodeValueSimple"
        }
    },
    "description":"The model object for a nomenclature."
}

Nested Schema : CodeValueSimple

Type: object

A minimal representation of a code value.

Show Source

• cdfMeaning: string
  A programmatic value, primarily used by applications to search for this value.
• display: string
  The text consumers see that represents this code value.
• id(required): string
  The ID of the code value.

{
    "description":"A minimal representation of a code value.",
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the code value.",
            "type":"string"
        },
        "display":{
            "description":"The text consumers see that represents this code value.",
            "type":"string"
        },
        "cdfMeaning":{
            "description":"A programmatic value, primarily used by applications to search for this value.",
            "type":"string"
        }
    }
}

Nested Schema : PersonNameSummary

Type: object

A summary of just first, last, and full name for a person (which could be a personnel member, patient, or nonpatient person).

Show Source

• firstName: string
  The person's first given name.
• fullName: string
  The fully formatted name.
• lastName: string
  The person's family last name.

{
    "description":"A summary of just first, last, and full name for a person (which could be a personnel member, patient, or nonpatient person).",
    "type":"object",
    "properties":{
        "firstName":{
            "description":"The person's first given name.",
            "type":"string"
        },
        "lastName":{
            "description":"The person's family last name.",
            "type":"string"
        },
        "fullName":{
            "description":"The fully formatted name.",
            "type":"string"
        }
    }
}

Nested Schema : ReactionVersion

Type: object

A version of a reaction.

Show Source

• isNew: boolean
  Identifies if this reaction is a new reaction.
• symptom: object NomenclatureOrFreetextValue
  The nomenclature or free text value of the data.
• versionsOfUpdatedReactionFields: array versionsOfUpdatedReactionFields
  The set of changes for this reaction.

{
    "type":"object",
    "description":"A version of a reaction.",
    "properties":{
        "symptom":{
            "description":"The symptom summary for the reaction.",
            "$ref":"#/definitions/NomenclatureOrFreetextValue"
        },
        "isNew":{
            "description":"Identifies if this reaction is a new reaction.",
            "type":"boolean"
        },
        "versionsOfUpdatedReactionFields":{
            "type":"array",
            "description":"The set of changes for this reaction.",
            "items":{
                "$ref":"#/definitions/UpdatedReactionField"
            }
        }
    }
}

Nested Schema : versionsOfUpdatedReactionFields

Type: array

The set of changes for this reaction.

Show Source

• Array of: object UpdatedReactionField
  A record of the change to a reaction version.

{
    "type":"array",
    "description":"The set of changes for this reaction.",
    "items":{
        "$ref":"#/definitions/UpdatedReactionField"
    }
}

Nested Schema : UpdatedReactionField

Type: object

A record of the change to a reaction version.

Show Source

• currentValue(required): string
  The current value of the field.
• field(required): string
  Allowed Values: [ "SEVERITY", "IS_ACTIVE" ]

  The name of the field that was updated.
• previousValue: string
  The previous value of the field.

{
    "type":"object",
    "description":"A record of the change to a reaction version.",
    "required":[
        "field",
        "currentValue"
    ],
    "properties":{
        "field":{
            "type":"string",
            "description":"The name of the field that was updated.",
            "enum":[
                "SEVERITY",
                "IS_ACTIVE"
            ]
        },
        "previousValue":{
            "type":"string",
            "description":"The previous value of the field."
        },
        "currentValue":{
            "type":"string",
            "description":"The current value of the field."
        }
    }
}

Nested Schema : DateTimeWithZone

Type: object

A representation of the date and time with the time zone.

Show Source

• dateTime: string(date-time)
  The date and time represented in YYYY-MM-DDTHH:MM:SS:SSSZ format without the UTC offset as defined by RFC 3339. No timezone information is associated with this date/time.
• ianaTimeZone: string
  The time zone, provided that the date includes time precision. If dateTime contains time, then this field is required.

{
    "type":"object",
    "description":"A representation of the date and time with the time zone.",
    "properties":{
        "dateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time represented in YYYY-MM-DDTHH:MM:SS:SSSZ format without the UTC offset as defined by <a href=\"https://tools.ietf.org/html/rfc3339\">RFC 3339</a>.\nNo timezone information is associated with this date/time.\n"
        },
        "ianaTimeZone":{
            "type":"string",
            "description":"The time zone, provided that the date includes time precision. If <code>dateTime</code> contains time, then this field is required."
        }
    }
}

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"
    }
}

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