Jump to

• Request
• Response

Get detailed information about a message

get

/20241001/patientMessages/{patientMessageId}

This resource retrieves the details about a message based on a given message ID. Only a single message ID can be provided at a time.

Returns a 400 status code if multiple message IDs are provided.

Request

Path Parameters

• patientMessageId(required): string
  The unique identifier of the message.

Query Parameters

• shouldLoadOrganizationSummary: boolean
  If true, the inbox item list and message details by ID populate the organization object, which includes ID, display, and orgTypes.

  Default Value: false

Header Parameters

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

  Default Value: application/json
• accept-charset: string
  Specifies which character sets are acceptable for the response. Defaults to UTF-8.

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Contains details about the retrieved message.

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

Type: object

The detailed information about a message.

Show Source

• attachments: array attachments
  The list of attachments on the message.
• canReply: boolean
  An indicator that the message can be replied to.
• carbonCopyRecipients: array carbonCopyRecipients
  The list of carbon copy receivers.
• content(required): string
  The content of the message in XHTML format. The service supports HTML5, but a subset of the tags are disallowed. The user is informed through a detailed 400 error if the content contains an invalid tag.
• conversationId: string
  The identifier of the conversation that the message is part of.
• createDateTime(required): object DateTimeWithZone
  A representation of the date and time with the time zone.
• dueDateTime: object DateTimeWithZone
  A representation of the date and time with the time zone.
• encounter: object Encounter
  The encounter associated with the message.
• id(required): string
  The identifier of the message.
• messageSender(required): object SenderSummary
  The sender of the message.
• notificationType(required): object NotificationType
  The information about the message type.
• notificationVersion(required): integer
  The sender's version of the message.
• patient: object PersonSimple
  A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.
• priority(required): object Priority
  The priority of the message.
• recipientAccessed: array recipientAccessed
  The list of receivers that have at least read the message. Their message is not in UNREAD status.
• recipientNotificationVersion: integer
  The recipient's version of the message. Only populated if user is one of the recipients.
• recipients(required): array recipients
  The list of receivers.
• relatedMessageIds: array relatedMessageIds
  The list of other message identifiers in the conversation.
• remindDateTime: object DateTimeWithZone
  A representation of the date and time with the time zone.
• responsiblePersonnelId: string
  The identifier of the responsible personnel for the message. Used for reporting and helps systems and users handle the message.
• status: object NotificationStatus
  The information about the status of a message.
• subject: string
  The subject of the message.
• updateDateTime(required): object DateTimeWithZone
  A representation of the date and time with the time zone.

{
    "type":"object",
    "description":"The detailed information about a message.\n",
    "required":[
        "id",
        "notificationType",
        "messageSender",
        "recipients",
        "content",
        "createDateTime",
        "updateDateTime",
        "priority",
        "notificationVersion"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the message."
        },
        "notificationType":{
            "$ref":"#/definitions/NotificationType",
            "description":"The type of the message."
        },
        "status":{
            "$ref":"#/definitions/NotificationStatus",
            "description":"The status of the message. The status is not populated if retrieving the details of a sent notification."
        },
        "messageSender":{
            "$ref":"#/definitions/SenderSummary",
            "description":"The details about the sender."
        },
        "recipients":{
            "type":"array",
            "description":"The list of receivers.",
            "items":{
                "$ref":"#/definitions/Participant"
            }
        },
        "carbonCopyRecipients":{
            "type":"array",
            "description":"The list of carbon copy receivers.",
            "items":{
                "$ref":"#/definitions/Participant"
            }
        },
        "recipientAccessed":{
            "type":"array",
            "description":"The list of receivers that have at least read the message. Their message is not in UNREAD status.",
            "items":{
                "$ref":"#/definitions/Participant"
            }
        },
        "patient":{
            "$ref":"#/definitions/PersonSimple",
            "description":"The patient who is the subject of the message or who the message is about."
        },
        "encounter":{
            "$ref":"#/definitions/Encounter",
            "description":"The information about the encounter associated with the message."
        },
        "subject":{
            "type":"string",
            "description":"The subject of the message."
        },
        "content":{
            "type":"string",
            "description":"The content of the message in XHTML format.\nThe service supports HTML5, but a subset of the tags are disallowed.\nThe user is informed through a detailed 400 error if the content contains an invalid tag.\n"
        },
        "createDateTime":{
            "$ref":"#/definitions/DateTimeWithZone",
            "description":"The date and time that the message was created."
        },
        "updateDateTime":{
            "$ref":"#/definitions/DateTimeWithZone",
            "description":"The date and time that the message was last updated."
        },
        "dueDateTime":{
            "$ref":"#/definitions/DateTimeWithZone",
            "description":"The date and time that the message becomes due."
        },
        "remindDateTime":{
            "$ref":"#/definitions/DateTimeWithZone",
            "description":"The date and time that the reminder should appear."
        },
        "conversationId":{
            "type":"string",
            "description":"The identifier of the conversation that the message is part of."
        },
        "relatedMessageIds":{
            "type":"array",
            "description":"The list of other message identifiers in the conversation.",
            "items":{
                "type":"string"
            }
        },
        "priority":{
            "$ref":"#/definitions/Priority",
            "description":"The priority of the message."
        },
        "canReply":{
            "type":"boolean",
            "description":"An indicator that the message can be replied to."
        },
        "attachments":{
            "type":"array",
            "description":"The list of attachments on the message.",
            "items":{
                "$ref":"#/definitions/Attachment"
            }
        },
        "notificationVersion":{
            "type":"integer",
            "description":"The sender's version of the message."
        },
        "recipientNotificationVersion":{
            "type":"integer",
            "description":"The recipient's version of the message. Only populated if user is one of the recipients."
        },
        "responsiblePersonnelId":{
            "type":"string",
            "description":"The identifier of the responsible personnel for the message.\nUsed for reporting and helps systems and users handle the message.\n"
        }
    }
}

Nested Schema : attachments

Type: array

The list of attachments on the message.

Show Source

• Array of: object Attachment
  The details about a message attachment.

{
    "type":"array",
    "description":"The list of attachments on the message.",
    "items":{
        "$ref":"#/definitions/Attachment"
    }
}

Nested Schema : carbonCopyRecipients

Type: array

The list of carbon copy receivers.

Show Source

• Array of: object Participant
  The sender or recipient of the message.

{
    "type":"array",
    "description":"The list of carbon copy receivers.",
    "items":{
        "$ref":"#/definitions/Participant"
    }
}

Nested Schema : DateTimeWithZone

Type: object

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

Show Source

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

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

Nested Schema : Encounter

Type: object

The encounter associated with the message.

Show Source

• id(required): string
  The unique identifier for the encounter.
• 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.

{
    "type":"object",
    "description":"The encounter associated with the message.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier for the encounter."
        },
        "organization":{
            "$ref":"#/definitions/Organization",
            "description":"The organization associated with the encounter."
        }
    }
}

Nested Schema : SenderSummary

Type: object

The sender of the message.

Show Source

• groupInboxSummary: object GroupInboxSummary
  The summary of the Group Inbox sender.
• id(required): string
  The unique identifier for the participant.
• personName: object PersonNameSummary
  A summary of just first, last, and full name for a person (which could be a personnel member, patient, or nonpatient person).
• personnelName: object PersonNameSummary
  A summary of just first, last, and full name for a person (which could be a personnel member, patient, or nonpatient person).
• type(required): string
  Allowed Values: [ "PERSON", "PERSONNEL", "GROUPINBOX" ]

  The type of the participant. This field must be set. Set to PERSON for sent item sender. Set to PERSONNEL or GROUPINBOX for sent item recipients. Set to PERSONNEL or GROUPINBOX for inbox item sender.

{
    "type":"object",
    "required":[
        "id",
        "type"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier for the participant."
        },
        "type":{
            "type":"string",
            "description":"The type of the participant. This field must be set.\nSet to <code>PERSON</code> for sent item sender.\nSet to <code>PERSONNEL</code> or <code>GROUPINBOX</code> for sent item recipients.\nSet to <code>PERSONNEL</code> or <code>GROUPINBOX</code> for inbox item sender.\n",
            "enum":[
                "PERSON",
                "PERSONNEL",
                "GROUPINBOX"
            ]
        },
        "personName":{
            "description":"The name of the person, for cases where the participant is of type person.",
            "$ref":"#/definitions/PersonNameSummary"
        },
        "personnelName":{
            "description":"The name of the personnel, for cases where the participant is of type personnel.",
            "$ref":"#/definitions/PersonNameSummary"
        },
        "groupInboxSummary":{
            "description":"The details of the group inbox, for cases where the participant is of type group inbox.",
            "$ref":"#/definitions/GroupInboxSummary"
        }
    },
    "description":"The sender of the message."
}

Nested Schema : NotificationType

Type: object

The information about the message type.

Show Source

• value(required): string
  Allowed Values: [ "MESSAGE", "REMINDER", "UNKNOWN" ]

  The type of message.

{
    "type":"object",
    "description":"The information about the message type.",
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"string",
            "description":"The type of message.",
            "enum":[
                "MESSAGE",
                "REMINDER",
                "UNKNOWN"
            ]
        }
    }
}

Nested Schema : PersonSimple

Type: object

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

Show Source

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

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

Nested Schema : Priority

Type: object

The priority of the message.

Show Source

• value(required): string
  Allowed Values: [ "HIGH", "NORMAL" ]

  The value of the priority. HIGH denotes STAT. NORMAL denotes ROUTINE.

{
    "type":"object",
    "description":"The priority of the message.",
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"string",
            "description":"The value of the priority.\n<code>HIGH</code> denotes <code>STAT</code>.\n<code>NORMAL</code> denotes <code>ROUTINE</code>.\n",
            "enum":[
                "HIGH",
                "NORMAL"
            ]
        }
    }
}

Nested Schema : recipientAccessed

Type: array

The list of receivers that have at least read the message. Their message is not in UNREAD status.

Show Source

• Array of: object Participant
  The sender or recipient of the message.

{
    "type":"array",
    "description":"The list of receivers that have at least read the message. Their message is not in UNREAD status.",
    "items":{
        "$ref":"#/definitions/Participant"
    }
}

Nested Schema : recipients

Type: array

The list of receivers.

Show Source

• Array of: object Participant
  The sender or recipient of the message.

{
    "type":"array",
    "description":"The list of receivers.",
    "items":{
        "$ref":"#/definitions/Participant"
    }
}

Nested Schema : relatedMessageIds

Type: array

The list of other message identifiers in the conversation.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of other message identifiers in the conversation.",
    "items":{
        "type":"string"
    }
}

Nested Schema : NotificationStatus

Type: object

The information about the status of a message.

Show Source

• value(required): string
  Allowed Values: [ "UNREAD", "OPENED", "DELETED", "UNKNOWN" ]

  The status of the message.

{
    "type":"object",
    "description":"The information about the status of a message.",
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"string",
            "description":"The status of the message.",
            "enum":[
                "UNREAD",
                "OPENED",
                "DELETED",
                "UNKNOWN"
            ]
        }
    }
}

Nested Schema : Attachment

Type: object

The details about a message attachment.

Show Source

• id(required): string
  The identifier of the attachment.
• name(required): string
  The name of the attachment
• version(required): integer
  The version of the attachment.

{
    "type":"object",
    "description":"The details about a message attachment.",
    "required":[
        "name",
        "id",
        "version"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the attachment"
        },
        "id":{
            "type":"string",
            "description":"The identifier of the attachment."
        },
        "version":{
            "type":"integer",
            "description":"The version of the attachment."
        }
    }
}

Nested Schema : Participant

Type: object

The sender or recipient of the message.

Show Source

• groupInboxName: string
  The name of the group inbox, for cases where the participant is of type group inbox.
• id(required): string
  The unique identifier for the participant.
• personName: object PersonNameSummary
  A summary of just first, last, and full name for a person (which could be a personnel member, patient, or nonpatient person).
• personnelName: object PersonNameSummary
  A summary of just first, last, and full name for a person (which could be a personnel member, patient, or nonpatient person).
• type(required): string
  Allowed Values: [ "PERSON", "PERSONNEL", "GROUPINBOX" ]

  The type of the participant. This field must be set. Set to PERSON for sent item sender. Set to PERSONNEL or GROUPINBOX for sent item recipients and inbox item carbon copy recipients. Set to PERSON, PERSONNEL, or GROUPINBOX for inbox item recipients.

{
    "type":"object",
    "description":"The sender or recipient of the message.",
    "required":[
        "id",
        "type"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier for the participant."
        },
        "type":{
            "type":"string",
            "description":"The type of the participant. This field must be set.\nSet to <code>PERSON</code> for sent item sender.\nSet to <code>PERSONNEL</code> or <code>GROUPINBOX</code> for sent item recipients and inbox item carbon copy recipients.\nSet to <code>PERSON</code>, <code>PERSONNEL</code>, or <code>GROUPINBOX</code> for inbox item recipients.\n",
            "enum":[
                "PERSON",
                "PERSONNEL",
                "GROUPINBOX"
            ]
        },
        "personName":{
            "description":"The name of the person, for cases where the participant is of type person.",
            "$ref":"#/definitions/PersonNameSummary"
        },
        "personnelName":{
            "description":"The name of the personnel, for cases where the participant is of type personnel.",
            "$ref":"#/definitions/PersonNameSummary"
        },
        "groupInboxName":{
            "type":"string",
            "description":"The name of the group inbox, for cases where the participant is of type group inbox."
        }
    }
}

Nested Schema : PersonNameSummary

Type: object

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

Show Source

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

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

Nested Schema : 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 : 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 : GroupInboxSummary

Type: object

The summary of the Group Inbox sender.

Show Source

• groupInboxName(required): string
  The name of the group inbox.
• personnelSender: object PersonSimple
  A simple representation of the individual person that was retrieved. The individual could be a personnel member (provider), a patient, or a nonpatient person.

{
    "type":"object",
    "required":[
        "groupInboxName"
    ],
    "properties":{
        "groupInboxName":{
            "type":"string",
            "description":"The name of the group inbox."
        },
        "personnelSender":{
            "$ref":"#/definitions/PersonSimple",
            "description":"The sender who sent the message from group inbox."
        }
    },
    "description":"The summary of the Group Inbox sender."
}

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