Jump to

• Request
• Response

Get a personnel member by ID

get

/20240101/personnel/{personnelId}

Retrieves a personnel member by their ID.

Request

Path Parameters

• personnelId(required): string
  The unique personnel member identifier.

Header Parameters

• 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

• etag: string
  For optimistic concurrency control. See if-match.
• opc-request-id: string
  Unique Oracle Cerner-assigned identifier for the request. If you need to contact Oracle Cerner about a particular request, you must provide the request ID.

Body ()

Root Schema : Personnel

Type: object

The details of a personnel member who was retrieved.

Show Source

• addresses: array addresses
  A collection of addresses for the personnel member. If the logged-in user is a patient, none of the addresses are returned.
• aliases: array aliases
  A collection of aliases (only returning NPI, SPI, DEA, Tax ID) for the personnel member.
• birthDate: string
  The birth date and time in ISO-8601 format for the personnel member.
• credentials: array credentials
  A collection of credentials for the personnel member.
• gender: object CodeValueSimple
  A minimal representation of a code value.
• id(required): string
  The unique identifier for the personnel member.
• isActive: boolean
  Indicates whether the personnel member is active.
• isPhysician: boolean
  True if the personnel member is designated as a provider. May include physician assistants or nurse practitioners in addition to physicians.
• lastModifiedDateTime: 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.
• names: array names
  A collection of names for the personnel member.
• primaryAssignedLocationId: string
  The primary location identifier to which a personnel member is assigned.
• roles: array roles
  A collection of roles for the personnel member. The primary role is guaranteed to be the first entry in the list.
• specialties: array specialties
  A collection of specialties (general and location-specific) for the personnel member. The primary specialty is guaranteed to be the first entry in the list.
• telecoms: array telecoms
  A collection of telecommunication details for the personnel member. If the logged-in user is a patient, none of the methods (except secure emails) are returned.
• userName: string
  The username of the personnel member. May be null.

{
    "description":"The details of a personnel member who was retrieved.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"The unique identifier for the personnel member.",
            "type":"string"
        },
        "addresses":{
            "description":"A collection of addresses for the personnel member. If the logged-in user is a patient, none of the addresses are returned.",
            "items":{
                "$ref":"#/definitions/Address"
            },
            "type":"array"
        },
        "aliases":{
            "description":"A collection of aliases (only returning NPI, SPI, DEA, Tax ID) for the personnel member.",
            "items":{
                "$ref":"#/definitions/Alias"
            },
            "type":"array"
        },
        "birthDate":{
            "description":"The birth date and time in ISO-8601 format for the personnel member.",
            "type":"string"
        },
        "credentials":{
            "description":"A collection of credentials for the personnel member.",
            "items":{
                "$ref":"#/definitions/Credential"
            },
            "type":"array"
        },
        "gender":{
            "$ref":"#/definitions/CodeValueSimple"
        },
        "isActive":{
            "description":"Indicates whether the personnel member is active.",
            "type":"boolean"
        },
        "isPhysician":{
            "description":"True if the personnel member is designated as a provider. May include physician assistants or nurse practitioners in addition to physicians.",
            "type":"boolean"
        },
        "names":{
            "description":"A collection of names for the personnel member.",
            "items":{
                "$ref":"#/definitions/PersonName"
            },
            "type":"array"
        },
        "primaryAssignedLocationId":{
            "description":"The primary location identifier to which a personnel member is assigned.",
            "type":"string"
        },
        "roles":{
            "description":"A collection of roles for the personnel member. The primary role is guaranteed to be the first entry in the list.",
            "items":{
                "$ref":"#/definitions/Role"
            },
            "type":"array"
        },
        "specialties":{
            "description":"A collection of specialties (general and location-specific) for the personnel member. The primary specialty is guaranteed to be the first entry in the list.",
            "items":{
                "$ref":"#/definitions/Specialty"
            },
            "type":"array"
        },
        "telecoms":{
            "description":"A collection of telecommunication details for the personnel member. If the logged-in user is a patient, none of the methods (except secure emails) are returned.",
            "items":{
                "$ref":"#/definitions/Telecom"
            },
            "type":"array"
        },
        "userName":{
            "description":"The username of the personnel member. May be null.",
            "type":"string"
        },
        "lastModifiedDateTime":{
            "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 : addresses

Type: array

A collection of addresses for the personnel member. If the logged-in user is a patient, none of the addresses are returned.

Show Source

• Array of: object Address
  A postal address.

{
    "description":"A collection of addresses for the personnel member. If the logged-in user is a patient, none of the addresses are returned.",
    "items":{
        "$ref":"#/definitions/Address"
    },
    "type":"array"
}

Nested Schema : aliases

Type: array

A collection of aliases (only returning NPI, SPI, DEA, Tax ID) for the personnel member.

Show Source

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

{
    "description":"A collection of aliases (only returning NPI, SPI, DEA, Tax ID) for the personnel member.",
    "items":{
        "$ref":"#/definitions/Alias"
    },
    "type":"array"
}

Nested Schema : credentials

Type: array

A collection of credentials for the personnel member.

Show Source

• Array of: object Credential
  The credential information for personnel.

{
    "description":"A collection of credentials for the personnel member.",
    "items":{
        "$ref":"#/definitions/Credential"
    },
    "type":"array"
}

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

Type: array

A collection of names for the personnel member.

Show Source

• Array of: object PersonName
  The basic data representation of a person name.

{
    "description":"A collection of names for the personnel member.",
    "items":{
        "$ref":"#/definitions/PersonName"
    },
    "type":"array"
}

Nested Schema : roles

Type: array

A collection of roles for the personnel member. The primary role is guaranteed to be the first entry in the list.

Show Source

• Array of: object Role
  The personnel member's role information and indicator for the default role.

{
    "description":"A collection of roles for the personnel member. The primary role is guaranteed to be the first entry in the list.",
    "items":{
        "$ref":"#/definitions/Role"
    },
    "type":"array"
}

Nested Schema : specialties

Type: array

A collection of specialties (general and location-specific) for the personnel member. The primary specialty is guaranteed to be the first entry in the list.

Show Source

• Array of: object Specialty
  The specialty of the personnel member, which can be location-specific or a general specialty if no locations are provided.

{
    "description":"A collection of specialties (general and location-specific) for the personnel member. The primary specialty is guaranteed to be the first entry in the list.",
    "items":{
        "$ref":"#/definitions/Specialty"
    },
    "type":"array"
}

Nested Schema : telecoms

Type: array

A collection of telecommunication details for the personnel member. If the logged-in user is a patient, none of the methods (except secure emails) are returned.

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 telecommunication details for the personnel member. If the logged-in user is a patient, none of the methods (except secure emails) are returned.",
    "items":{
        "$ref":"#/definitions/Telecom"
    },
    "type":"array"
}

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

Type: object

The credential information for personnel.

Show Source

• credential(required): object CodeValueSimple
  A minimal representation of a code value.
• dateTimePeriod: object DateTimePeriod
  A representation of a date and time range.
• displaySequence: integer(int64)
  The display sequence number of the credential.
• id(required): string
  A unique identifier for the credential.
• isActive: boolean
  Indicates whether the credential is active.
• state: object CodeValueSimple
  A minimal representation of a code value.
• type(required): object CodeValueSimple
  A minimal representation of a code value.
• value: string
  The external identifier of the credential.

{
    "description":"The credential information for personnel.",
    "properties":{
        "credential":{
            "$ref":"#/definitions/CodeValueSimple"
        },
        "displaySequence":{
            "description":"The display sequence number of the credential.",
            "format":"int64",
            "type":"integer"
        },
        "id":{
            "description":"A unique identifier for the credential.",
            "type":"string"
        },
        "isActive":{
            "description":"Indicates whether the credential is active.",
            "type":"boolean"
        },
        "dateTimePeriod":{
            "$ref":"#/definitions/DateTimePeriod"
        },
        "state":{
            "$ref":"#/definitions/CodeValueSimple"
        },
        "type":{
            "$ref":"#/definitions/CodeValueSimple"
        },
        "value":{
            "description":"The external identifier of the credential.",
            "type":"string"
        }
    },
    "required":[
        "id",
        "credential",
        "type"
    ]
}

Nested Schema : PersonName

Type: object

The basic data representation of a person name.

Show Source

• dateTimePeriod: object DateTimePeriod
  A representation of a date and time range.
• firstName: string
  The person's first given name.
• fullFormatted: string
  The fully formatted name.
• id: string
  The unique ID of the name identifier.
• lastName: string
  The person's family name.
• middleName: string
  The person's middle or secondary given name or names.
• suffix: string
  The name suffix includes any titles that follow the regular person's name.
• title: string
  The title preceding the person's name.

{
    "description":"The basic data representation of a person name.",
    "properties":{
        "firstName":{
            "description":"The person's first given name.",
            "type":"string"
        },
        "fullFormatted":{
            "description":"The fully formatted name.",
            "type":"string"
        },
        "id":{
            "description":"The unique ID of the name identifier.",
            "type":"string"
        },
        "lastName":{
            "description":"The person's family name.",
            "type":"string"
        },
        "middleName":{
            "description":"The person's middle or secondary given name or names.",
            "type":"string"
        },
        "dateTimePeriod":{
            "$ref":"#/definitions/DateTimePeriod"
        },
        "suffix":{
            "description":"The name suffix includes any titles that follow the regular person's name.",
            "type":"string"
        },
        "title":{
            "description":"The title preceding the person's name.",
            "type":"string"
        }
    }
}

Nested Schema : Role

Type: object

The personnel member's role information and indicator for the default role.

Show Source

• isDefault: boolean
  The default position of the personnel member. This position is not the primary position. Primary position is planned for implementation in the future. See the Millennium Identity and Access Management Glossary for more information.
• millenniumCodeValue: object CodeValueSimple
  A minimal representation of a code value.

{
    "description":"The personnel member's role information and indicator for the default role.",
    "properties":{
        "isDefault":{
            "description":"The default position of the personnel member. This position is not the primary position. Primary position is planned for implementation in the future. See the <a href=\"https://pages.github.cerner.com/millennium-security/products/millennium_authorization/role_based_access_control/projects/multiple_roles/glossary/\">Millennium Identity and Access Management Glossary</a> for more information.",
            "type":"boolean"
        },
        "millenniumCodeValue":{
            "$ref":"#/definitions/CodeValueSimple"
        }
    }
}

Nested Schema : Specialty

Type: object

The specialty of the personnel member, which can be location-specific or a general specialty if no locations are provided.

Show Source

• isPrimary(required): boolean
  True if the specialty is designated to be primary for the personnel member. False otherwise.
• locationIds: array locationIds
  The locations that the specialty is associated with. If this field is empty, then the specialty is general and not based on location.
• specialty(required): object CodeValueSimple
  A minimal representation of a code value.

{
    "description":"The specialty of the personnel member, which can be location-specific or a general specialty if no locations are provided.",
    "properties":{
        "isPrimary":{
            "description":"True if the specialty is designated to be primary for the personnel member. False otherwise.",
            "type":"boolean"
        },
        "locationIds":{
            "description":"The locations that the specialty is associated with. If this field is empty, then the specialty is general and not based on location.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "specialty":{
            "$ref":"#/definitions/CodeValueSimple"
        }
    },
    "required":[
        "isPrimary",
        "specialty"
    ]
}

Nested Schema : locationIds

Type: array

The locations that the specialty is associated with. If this field is empty, then the specialty is general and not based on location.

Show Source

• Array of: string

{
    "description":"The locations that the specialty is associated with. If this field is empty, then the specialty is general and not based on location.",
    "type":"array",
    "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"
        }
    }
}

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

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

Default Response

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : 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