Jump to

• Request
• Response

Get a location by location identifier

get

/20240101/locations/{locationId}

Retrieves details about a single location by location identifier.

Request

Path Parameters

• locationId(required): string
  The location ID to look up. A valid location ID is a positive, a non-floating point, and a numerical value.

  Default Value: UNRESTRICTED

Header Parameters

• oh-identifier-mapping-scope: string
  The URI of the standard used for mapping relationships between Oracle Health EHR and an external system.
• 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

Body ()

Root Schema : Location

Type: object

The details of a location.

Match All

The details of a location.

The details of a location.

Show Source

• object LocationSummary
  The details of the location that were retrieved.
• object Location-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/LocationSummary"
        },
        {
            "properties":{
                "diagnostics":{
                    "description":"Collection of diagnostic events.",
                    "items":{
                        "$ref":"#/definitions/DiagnosticEvent"
                    },
                    "type":"array"
                }
            }
        }
    ],
    "description":"The details of a location.",
    "type":"object"
}

Nested Schema : LocationSummary

Type: object

The details of the location that were retrieved.

Show Source

• addresses: array addresses
  A collection of address details for the location.
• aliases: array aliases
  A collection of aliases that identify the location. Aliases are grouped by type and ordered by system.
• attributes: array attributes
  A collection of location descriptors.
• description(required): string
  The description of the location.
• effective(required): object DateTimePeriod
  A representation of a date and time range.
• id(required): string
  The unique identifier for the location.
• isPatientCareLocation(required): boolean
  True if the location is a patient care location and false if it is not.
• name(required): string
  A display name of the location.
• organization: object Organization
  The organization associated with the patient and encounter. Only loaded for inbox list and message details views when the OptionalShouldLoadOrganizationSummary is set.
• parentLocation: object ParentLocation
  The details of a parent location.
• status(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE", "DELETED", "COMBINED" ]

  Indicates the status of the location.
• telecoms: array telecoms
  A collection of contact details, for example, telephone number or fax, for the location.
• timezone: object TimeZone
  The time zone information of the location.
• type(required): object CodeValueSimple
  A minimal representation of a code value.
• update(required): object Update
  Meta information about a resource.

{
    "description":"The details of the location that were retrieved.",
    "properties":{
        "addresses":{
            "description":"A collection of address details for the location.",
            "items":{
                "$ref":"#/definitions/Address"
            },
            "type":"array"
        },
        "aliases":{
            "description":"A collection of aliases that identify the location. Aliases are grouped by type and ordered by system.",
            "items":{
                "$ref":"#/definitions/Alias"
            },
            "type":"array"
        },
        "attributes":{
            "description":"A collection of location descriptors.",
            "items":{
                "$ref":"#/definitions/Attribute"
            },
            "type":"array"
        },
        "description":{
            "description":"The description of the location.",
            "type":"string"
        },
        "effective":{
            "$ref":"#/definitions/DateTimePeriod"
        },
        "id":{
            "description":"The unique identifier for the location.",
            "type":"string"
        },
        "isPatientCareLocation":{
            "description":"True if the location is a patient care location and false if it is not.",
            "type":"boolean"
        },
        "name":{
            "description":"A display name of the location.",
            "type":"string"
        },
        "organization":{
            "$ref":"#/definitions/Organization"
        },
        "parentLocation":{
            "$ref":"#/definitions/ParentLocation"
        },
        "status":{
            "description":"Indicates the status of the location.",
            "enum":[
                "ACTIVE",
                "INACTIVE",
                "DELETED",
                "COMBINED"
            ],
            "type":"string"
        },
        "telecoms":{
            "description":"A collection of contact details, for example, telephone number or fax, for the location.",
            "items":{
                "$ref":"#/definitions/Telecom"
            },
            "type":"array"
        },
        "timezone":{
            "$ref":"#/definitions/TimeZone"
        },
        "type":{
            "$ref":"#/definitions/CodeValueSimple"
        },
        "update":{
            "$ref":"#/definitions/Update"
        }
    },
    "required":[
        "id",
        "name",
        "type",
        "effective",
        "update",
        "description",
        "isPatientCareLocation",
        "status"
    ],
    "type":"object"
}

Nested Schema : Location-allOf[1]

Type: object

Show Source

• diagnostics: array diagnostics
  Collection of diagnostic events.

{
    "properties":{
        "diagnostics":{
            "description":"Collection of diagnostic events.",
            "items":{
                "$ref":"#/definitions/DiagnosticEvent"
            },
            "type":"array"
        }
    }
}

Nested Schema : addresses

Type: array

A collection of address details for the location.

Show Source

• Array of: object Address
  A postal address.

{
    "description":"A collection of address details for the location.",
    "items":{
        "$ref":"#/definitions/Address"
    },
    "type":"array"
}

Nested Schema : aliases

Type: array

A collection of aliases that identify the location. Aliases are grouped by type and ordered by system.

Show Source

• Array of: object Alias
  An alias for another concept.

{
    "description":"A collection of aliases that identify the location. Aliases are grouped by type and ordered by system.",
    "items":{
        "$ref":"#/definitions/Alias"
    },
    "type":"array"
}

Nested Schema : attributes

Type: array

A collection of location descriptors.

Show Source

• Array of: object Attribute
  Location descriptor.

{
    "description":"A collection of location descriptors.",
    "items":{
        "$ref":"#/definitions/Attribute"
    },
    "type":"array"
}

Nested Schema : DateTimePeriod

Type: object

A representation of a date and time range.

Show Source

• end: string
  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.
• start: string
  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.

{
    "type":"object",
    "description":"A representation of a date and time range.",
    "properties":{
        "start":{
            "type":"string",
            "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>. No time zone information is associated with this date and time.\n"
        },
        "end":{
            "type":"string",
            "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>. No time zone information is associated with this date and time.\n"
        }
    }
}

Nested Schema : Organization

Type: object

The organization associated with the patient and encounter. Only loaded for inbox list and message details views when the OptionalShouldLoadOrganizationSummary is set.

Show Source

• display: string
  The display name for the organization.
• id(required): string
  The unique identifier for the organization.
• orgTypes: array orgTypes
  The list of the organization types.

{
    "type":"object",
    "description":"The organization associated with the patient and encounter.\nOnly loaded for inbox list and message details views when the <code>OptionalShouldLoadOrganizationSummary</code> is set.\n",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier for the organization."
        },
        "display":{
            "type":"string",
            "description":"The display name for the organization."
        },
        "orgTypes":{
            "type":"array",
            "description":"The list of the organization types.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ParentLocation

Type: object

The details of a parent location.

Show Source

• id: string
  The unique identifier of the parent location. This is the parent location with a root code of 0. If multiple parents have a root code of 0, the child organization is disqualified and not returned.

{
    "type":"object",
    "description":"The details of a parent location.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier of the parent location. This is the parent location with a root code of 0. If multiple parents have a root code of 0, the child organization is disqualified and not returned."
        }
    }
}

Nested Schema : telecoms

Type: array

A collection of contact details, for example, telephone number or fax, for the location.

Show Source

• Array of: object Telecom
  A contact detail (such as a telephone number) by which the party may be contacted.

{
    "description":"A collection of contact details, for example, telephone number or fax, for the location.",
    "items":{
        "$ref":"#/definitions/Telecom"
    },
    "type":"array"
}

Nested Schema : TimeZone

Type: object

The time zone information of the location.

Show Source

• value: string
  The time zone value for the location.

{
    "description":"The time zone information of the location.",
    "properties":{
        "value":{
            "description":"The time zone value for the location.",
            "type":"string"
        }
    },
    "type":"object"
}

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

Type: object

Meta information about a resource.

Show Source

• lastModifiedDateTime(required): string(date-time)
  The date and time in ISO-8601 format of the last changed date and time of the resource.
• version(required): integer(int64)
  The count specific identifier of the resource.

{
    "description":"Meta information about a resource.",
    "properties":{
        "lastModifiedDateTime":{
            "description":"The date and time in ISO-8601 format of the last changed date and time of the resource.",
            "format":"date-time",
            "type":"string"
        },
        "version":{
            "description":"The count specific identifier of the resource.",
            "format":"int64",
            "type":"integer"
        }
    },
    "required":[
        "version",
        "lastModifiedDateTime"
    ],
    "type":"object"
}

Nested Schema : Address

Type: object

A postal address.

Show Source

• city: string
  The text name of the city associated with the address.
• country: object MultivalueField
  A field that can be represented by multiple values (one of which could be code value). Currently, only code value and free-text name are supported.
• county: object MultivalueField
  A field that can be represented by multiple values (one of which could be code value). Currently, only code value and free-text name are supported.
• postalCode: string
  A postal code designating a region defined by the postal service.
• state: object MultivalueField
  A field that can be represented by multiple values (one of which could be code value). Currently, only code value and free-text name are supported.
• street1: string
  The first line of the street address.
• street2: string
  The second line of the street address.
• street3: string
  The third line of the street address.
• street4: string
  The fourth line of the street address.
• type: object CodeValueSimple
  A minimal representation of a code value.

{
    "description":"A postal address.",
    "properties":{
        "city":{
            "description":"The text name of the city associated with the address.",
            "type":"string"
        },
        "country":{
            "description":"The country associated with the address.",
            "$ref":"#/definitions/MultivalueField"
        },
        "county":{
            "description":"The county associated with the address.",
            "$ref":"#/definitions/MultivalueField"
        },
        "postalCode":{
            "description":"A postal code designating a region defined by the postal service.",
            "type":"string"
        },
        "state":{
            "description":"The state or province associated with the address.",
            "$ref":"#/definitions/MultivalueField"
        },
        "street1":{
            "description":"The first line of the street address.",
            "type":"string"
        },
        "street2":{
            "description":"The second line of the street address.",
            "type":"string"
        },
        "street3":{
            "description":"The third line of the street address.",
            "type":"string"
        },
        "street4":{
            "description":"The fourth line of the street address.",
            "type":"string"
        },
        "type":{
            "$ref":"#/definitions/CodeValueSimple"
        }
    }
}

Nested Schema : MultivalueField

Type: object

A field that can be represented by multiple values (one of which could be code value). Currently, only code value and free-text name are supported.

Show Source

• codeValue: object CodeValueSimple
  A minimal representation of a code value.
• displayName: string
  The displayable free-text name of the field.

{
    "description":"A field that can be represented by multiple values (one of which could be code value).\nCurrently, only code value and free-text name are supported.\n",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"The displayable free-text name of the field.",
            "type":"string"
        },
        "codeValue":{
            "$ref":"#/definitions/CodeValueSimple"
        }
    }
}

Nested Schema : Alias

Type: object

An alias for another concept.

Show Source

• dateTimePeriod: object DateTimePeriod
  A representation of a date and time range.
• displayName(required): string
  The displayable name for the alias.
• id(required): string
  The unique identifier for the alias.
• systemIdentifier: object CodeValueSimple
  A minimal representation of a code value.
• systemNamespace: string
  The namespace URI with a set of possible system identifier values that are unique.
• type: object CodeValueSimple
  A minimal representation of a code value.

{
    "description":"An alias for another concept.",
    "required":[
        "id",
        "displayName"
    ],
    "properties":{
        "id":{
            "description":"The unique identifier for the alias.",
            "type":"string"
        },
        "displayName":{
            "description":"The displayable name for the alias.",
            "type":"string"
        },
        "dateTimePeriod":{
            "$ref":"#/definitions/DateTimePeriod"
        },
        "type":{
            "$ref":"#/definitions/CodeValueSimple"
        },
        "systemIdentifier":{
            "$ref":"#/definitions/CodeValueSimple"
        },
        "systemNamespace":{
            "description":"The namespace URI with a set of possible system identifier values that are unique.",
            "type":"string"
        }
    }
}

Nested Schema : Attribute

Type: object

Location descriptor.

Show Source

• description: string
  Location description.

  Example: ICU
• type(required): object CodeValueSimple
  A minimal representation of a code value.
• value(required): object value
  • If valueType is type CODE, the value is a system identifier.
  • If valueType is type NUMBER or STRING, the value is a string representation of a number or a string value.
• valueType(required): string
  Allowed Values: [ "CODE", "NUMBER", "STRING" ]

  Value type (CODE/NUMBER/STRING) of attribute.

{
    "description":"Location descriptor.",
    "properties":{
        "description":{
            "description":"Location description.",
            "example":"ICU",
            "type":"string"
        },
        "type":{
            "$ref":"#/definitions/CodeValueSimple"
        },
        "value":{
            "description":"<ul>\n  <li>If <code>valueType</code> is type <code>CODE</code>, the value is a system identifier.</li>\n  <li>If <code>valueType</code> is type <code>NUMBER</code> or <code>STRING</code>, the value is a string representation of a number or a string value.</li>\n</ul>\n",
            "example":{
                "display":"ICU",
                "id":"20140688",
                "meaning":"ICU"
            },
            "type":"object"
        },
        "valueType":{
            "description":"Value type (CODE/NUMBER/STRING) of attribute.",
            "enum":[
                "CODE",
                "NUMBER",
                "STRING"
            ],
            "type":"string"
        }
    },
    "required":[
        "type",
        "valueType",
        "value"
    ],
    "type":"object"
}

Nested Schema : value

Type: object

• If valueType is type CODE, the value is a system identifier.
• If valueType is type NUMBER or STRING, the value is a string representation of a number or a string value.

Example:

{
    "display":"ICU",
    "id":"20140688",
    "meaning":"ICU"
}

Nested Schema : orgTypes

Type: array

The list of the organization types.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of the organization types.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Telecom

Type: object

A contact detail (such as a telephone number) by which the party may be contacted.

Show Source

• contact: object CodeValueSimple
  A minimal representation of a code value.
• extension: string
  The extension associated with this contact.
• format: object CodeValueSimple
  A minimal representation of a code value.
• id(required): string
  The unique Millennium Platform identifier for the telecommunication.
• type: object CodeValueSimple
  A minimal representation of a code value.
• value(required): string
  The actual contact point details such as phone number or fax number.

{
    "description":"A contact detail (such as a telephone number) by which the party may be contacted.",
    "required":[
        "id",
        "value"
    ],
    "properties":{
        "contact":{
            "$ref":"#/definitions/CodeValueSimple"
        },
        "extension":{
            "description":"The extension associated with this contact.",
            "type":"string"
        },
        "format":{
            "$ref":"#/definitions/CodeValueSimple"
        },
        "id":{
            "description":"The unique Millennium Platform identifier for the telecommunication.",
            "type":"string"
        },
        "type":{
            "$ref":"#/definitions/CodeValueSimple"
        },
        "value":{
            "description":"The actual contact point details such as phone number or fax number.",
            "type":"string"
        }
    }
}

Nested Schema : diagnostics

Type: array

Collection of diagnostic events.

Show Source

• Array of: object DiagnosticEvent
  The details of this diagnostic event.

{
    "description":"Collection of diagnostic events.",
    "items":{
        "$ref":"#/definitions/DiagnosticEvent"
    },
    "type":"array"
}

Nested Schema : DiagnosticEvent

Type: object

The details of this diagnostic event.

Show Source

• field: string
  The field within the parameters or criteria body that caused the event.
• message: string
  An event message that is useful for troubleshooting.
• type(required): string
  Allowed Values: [ "INVALID_PARAMETER", "MAPPING_NOT_FOUND", "MAPPING_SERVICE_FAILURE", "REQUEST_API_LIMIT_EXCEEDED", "RESOURCE_NOT_FOUND", "MAPPING_SCOPE_NOT_RECOGNIZED" ]

  String representing the event type.
• value: string
  The value associated with the field or type.

{
    "description":"The details of this diagnostic event.",
    "required":[
        "type"
    ],
    "properties":{
        "field":{
            "description":"The field within the parameters or criteria body that caused the event.",
            "type":"string"
        },
        "message":{
            "description":"An event message that is useful for troubleshooting.",
            "type":"string"
        },
        "type":{
            "description":"String representing the event type.",
            "enum":[
                "INVALID_PARAMETER",
                "MAPPING_NOT_FOUND",
                "MAPPING_SERVICE_FAILURE",
                "REQUEST_API_LIMIT_EXCEEDED",
                "RESOURCE_NOT_FOUND",
                "MAPPING_SCOPE_NOT_RECOGNIZED"
            ],
            "type":"string"
        },
        "value":{
            "description":"The value associated with the field or type.",
            "type":"string"
        }
    }
}

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

412 Response

Precondition Failed

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