Jump to

• Request
• Response

Get a list of messages received by a patient

get

/20241001/patientMessages/inboxItems

Retrieves the received messages based on a given patient ID.

The service currently only supports a page limit of 1000 and returns 1 page.

Adjust date and time parameters to retrieve further items.

Request

Query Parameters

• createDateTimeGreaterThanOrEqualTo: string
  Messages created after this date and time value are retrieved. Reminders set to show up after this date and time are retrieved. Defaults to 90 days before the current date and time. Must be before the createDateTimeLessThanOrEqualTo. The ISO 8601 combined date and time in UTC point-in-time format is used to specify the date and time value, excluding milliseconds.
• createDateTimeLessThanOrEqualTo: string
  Messages created before this date and time value are retrieved. Reminders set to show up before this date and time are retrieved. Defaults to the current date and time. Must be after the createDateTimeGreaterThanOrEqualTo. Future dates are not supported and if provided, the default current date and time are used instead. The ISO 8601 combined date and time in UTC point-in-time format is used to specify the date and time value, excluding milliseconds.
• limit: integer
  Minimum Value: 1000

  Maximum Value: 1000

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

  Default Value: 1000
• notificationType: array[string]
  Collection Format: multi

  The type of messages to be retrieved. Defaults to [ MESSAGE ].

  • Allowed Values: [ "MESSAGE", "REMINDER" ]

• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous List request.
• patientId(required): string
  The patient ID to filter the resource query against.
• 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
• sortBy: string
  The field to sort by. Only one sort order may be provided. Default order for createDateTime is descending. Sort the patient messages by createDatTime for sent items. Sort the reminders by remindDateTime and the messages by createDateTime for inbox items.

  Default Value: createDateTime

  Allowed Values: [ "createDateTime", "priority" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Allowed Values: [ "ASC", "DESC" ]
• status: array[string]
  Collection Format: multi

  A comma-delimited status string of messages to be retrieved. Defaults to [ OPENED, UNREAD ].

  • Allowed Values: [ "OPENED", "UNREAD", "DELETED" ]

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

Returns the list of messages retrieved for a given patient

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain.
• opc-prev-page: string
  For list pagination. When this header appears in the response, additional pages of results remain.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : PatientInboxMessagesCollection

Type: object

The list of messages that have been received by the patient.

Show Source

• hasAdditionalListItems(required): boolean
  An indicator of whether more messages existed for the given filtering criteria.
• items(required): array items
  The list of the received patient messages retrieved. Can be empty.

{
    "type":"object",
    "description":"The list of messages that have been received by the patient.",
    "required":[
        "items",
        "hasAdditionalListItems"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of the received patient messages retrieved. Can be empty.",
            "items":{
                "$ref":"#/definitions/PatientInboxMessageSummary"
            }
        },
        "hasAdditionalListItems":{
            "type":"boolean",
            "description":"An indicator of whether more messages existed for the given filtering criteria."
        }
    }
}

Nested Schema : items

Type: array

The list of the received patient messages retrieved. Can be empty.

Show Source

• Array of: object PatientInboxMessageSummary
  The representation of a inbox message for a patient.

{
    "type":"array",
    "description":"The list of the received patient messages retrieved. Can be empty.",
    "items":{
        "$ref":"#/definitions/PatientInboxMessageSummary"
    }
}

Nested Schema : PatientInboxMessageSummary

Type: object

The representation of a inbox message for a patient.

Show Source

• carbonCopyRecipients: array carbonCopyRecipients
  The list of the personnel and group inboxes who received a copy of the message.
• conversationId(required): string
  The identifier of the conversation. All messages are assigned a conversationId, even if no replies have taken place. Multiple messages could have the same conversation ID if they are part of the same thread or back and forth of replies. This allows the consumer to group the messages together visually in a thread.
• createdDateTime(required): createdDateTime
  The date and time that the message was created. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.
• dueDateTime: dueDateTime
  The date and time that the message becomes due. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.
• encounter: encounter
  The encounter associated with the message.
• hasAttachments(required): boolean
  An indicator that indicates if this message has any attachment.
• id(required): string
  The identifier for the received message.
• messageSender(required): messageSender
  The personnel or group inbox who sent the message.
• notificationStatus(required): notificationStatus
  The status of the received message.
• notificationType(required): notificationType
  The type of the received message.
• notificationVersion(required): integer
  The task version for the message.
• patient(required): patient
  The patient who is the subject of the message or who the message is about.
• previousItemId: string
  The identifier for the previous received message if replied.
• priority(required): priority
  The priority of the received message.
• recipientNotificationVersion(required): integer
  The receiver version for the message.
• recipients(required): array recipients
  The list of the person, personnel, and group inboxes who are the recipient of the message.
• remindDateTime: remindDateTime
  The date and time that the reminder should appear. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.
• responsiblePersonnelId: string
  The identifier of the responsible personnel for the message. Used for reporting and helps systems and users handle the message.
• subject: string
  The subject of the received message.
• updatedDateTime(required): updatedDateTime
  The date and time that the message was last updated. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.

{
    "type":"object",
    "description":"The representation of a inbox message for a patient.",
    "required":[
        "id",
        "patient",
        "conversationId",
        "createdDateTime",
        "updatedDateTime",
        "priority",
        "notificationStatus",
        "notificationType",
        "hasAttachments",
        "notificationVersion",
        "recipientNotificationVersion",
        "recipients",
        "messageSender"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier for the received message."
        },
        "patient":{
            "allOf":[
                {
                    "$ref":"#/definitions/PersonSimple"
                }
            ],
            "description":"The patient who is the subject of the message or who the message is about."
        },
        "encounter":{
            "allOf":[
                {
                    "$ref":"#/definitions/Encounter"
                }
            ],
            "description":"The encounter associated with the message."
        },
        "conversationId":{
            "type":"string",
            "description":"The identifier of the conversation.\nAll messages are assigned a conversationId, even if no replies have taken place.\nMultiple messages could have the same conversation ID if they are part of the same thread or back and forth of replies.\nThis allows the consumer to group the messages together visually in a thread.\n"
        },
        "previousItemId":{
            "type":"string",
            "description":"The identifier for the previous received message if replied."
        },
        "subject":{
            "type":"string",
            "description":"The subject of the received message."
        },
        "createdDateTime":{
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeWithZone"
                }
            ],
            "description":"The date and time that the message was created.\nThe ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.\n"
        },
        "updatedDateTime":{
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeWithZone"
                }
            ],
            "description":"The date and time that the message was last updated.\nThe ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.\n"
        },
        "remindDateTime":{
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeWithZone"
                }
            ],
            "description":"The date and time that the reminder should appear.\nThe ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.\n"
        },
        "dueDateTime":{
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeWithZone"
                }
            ],
            "description":"The date and time that the message becomes due.\nThe ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.\n"
        },
        "priority":{
            "allOf":[
                {
                    "$ref":"#/definitions/Priority"
                }
            ],
            "description":"The priority of the received message."
        },
        "notificationStatus":{
            "allOf":[
                {
                    "$ref":"#/definitions/NotificationStatus"
                }
            ],
            "description":"The status of the received message."
        },
        "notificationType":{
            "allOf":[
                {
                    "$ref":"#/definitions/NotificationType"
                }
            ],
            "description":"The type of the received message."
        },
        "hasAttachments":{
            "type":"boolean",
            "description":"An indicator that indicates if this message has any attachment."
        },
        "notificationVersion":{
            "type":"integer",
            "description":"The task version for the message."
        },
        "recipientNotificationVersion":{
            "type":"integer",
            "description":"The receiver version for the message."
        },
        "recipients":{
            "type":"array",
            "description":"The list of the person, personnel, and group inboxes who are the recipient of the message.",
            "items":{
                "$ref":"#/definitions/Participant"
            }
        },
        "carbonCopyRecipients":{
            "type":"array",
            "description":"The list of the personnel and group inboxes who received a copy of the message.",
            "items":{
                "$ref":"#/definitions/Participant"
            }
        },
        "messageSender":{
            "allOf":[
                {
                    "$ref":"#/definitions/SenderSummary"
                }
            ],
            "description":"The personnel or group inbox who sent the message."
        },
        "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 : carbonCopyRecipients

Type: array

The list of the personnel and group inboxes who received a copy of the message.

Show Source

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

{
    "type":"array",
    "description":"The list of the personnel and group inboxes who received a copy of the message.",
    "items":{
        "$ref":"#/definitions/Participant"
    }
}

Nested Schema : createdDateTime

The date and time that the message was created. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.

Match All

The date and time that the message was created. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.

Show Source

• object DateTimeWithZone
  A representation of the date and time with the time zone.

{
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeWithZone"
        }
    ],
    "description":"The date and time that the message was created.\nThe ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.\n"
}

Nested Schema : dueDateTime

The date and time that the message becomes due. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.

Match All

The date and time that the message becomes due. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.

Show Source

• object DateTimeWithZone
  A representation of the date and time with the time zone.

{
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeWithZone"
        }
    ],
    "description":"The date and time that the message becomes due.\nThe ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.\n"
}

Nested Schema : encounter

The encounter associated with the message.

Match All

The encounter associated with the message.

Show Source

• object Encounter
  The encounter associated with the message.

{
    "allOf":[
        {
            "$ref":"#/definitions/Encounter"
        }
    ],
    "description":"The encounter associated with the message."
}

Nested Schema : messageSender

The personnel or group inbox who sent the message.

Match All

The personnel or group inbox who sent the message.

Show Source

• object SenderSummary
  The sender of the message.

{
    "allOf":[
        {
            "$ref":"#/definitions/SenderSummary"
        }
    ],
    "description":"The personnel or group inbox who sent the message."
}

Nested Schema : notificationStatus

The status of the received message.

Match All

The status of the received message.

Show Source

• object NotificationStatus
  The information about the status of a message.

{
    "allOf":[
        {
            "$ref":"#/definitions/NotificationStatus"
        }
    ],
    "description":"The status of the received message."
}

Nested Schema : notificationType

The type of the received message.

Match All

The type of the received message.

Show Source

• object NotificationType
  The information about the message type.

{
    "allOf":[
        {
            "$ref":"#/definitions/NotificationType"
        }
    ],
    "description":"The type of the received message."
}

Nested Schema : patient

The patient who is the subject of the message or who the message is about.

Match All

The patient who is the subject of the message or who the message is about.

Show Source

• 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.

{
    "allOf":[
        {
            "$ref":"#/definitions/PersonSimple"
        }
    ],
    "description":"The patient who is the subject of the message or who the message is about."
}

Nested Schema : priority

The priority of the received message.

Match All

The priority of the received message.

Show Source

• object Priority
  The priority of the message.

{
    "allOf":[
        {
            "$ref":"#/definitions/Priority"
        }
    ],
    "description":"The priority of the received message."
}

Nested Schema : recipients

Type: array

The list of the person, personnel, and group inboxes who are the recipient of the message.

Show Source

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

{
    "type":"array",
    "description":"The list of the person, personnel, and group inboxes who are the recipient of the message.",
    "items":{
        "$ref":"#/definitions/Participant"
    }
}

Nested Schema : remindDateTime

The date and time that the reminder should appear. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.

Match All

The date and time that the reminder should appear. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.

Show Source

• object DateTimeWithZone
  A representation of the date and time with the time zone.

{
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeWithZone"
        }
    ],
    "description":"The date and time that the reminder should appear.\nThe ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.\n"
}

Nested Schema : updatedDateTime

The date and time that the message was last updated. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.

Match All

The date and time that the message was last updated. The ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.

Show Source

• object DateTimeWithZone
  A representation of the date and time with the time zone.

{
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeWithZone"
        }
    ],
    "description":"The date and time that the message was last updated.\nThe ISO 8601 combined date and time in UTC format is used to specify the date and time value, excluding milliseconds.\n"
}

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: personName
  The name of the person, for cases where the participant is of type person.
• personnelName: personnelName
  The name of the personnel, for cases where the participant is of type personnel.
• 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.",
            "allOf":[
                {
                    "$ref":"#/definitions/PersonNameSummary"
                }
            ]
        },
        "personnelName":{
            "description":"The name of the personnel, for cases where the participant is of type personnel.",
            "allOf":[
                {
                    "$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 : personName

The name of the person, for cases where the participant is of type person.

Match All

The name of the person, for cases where the participant is of type person.

Show Source

• 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":"The name of the person, for cases where the participant is of type person.",
    "allOf":[
        {
            "$ref":"#/definitions/PersonNameSummary"
        }
    ]
}

Nested Schema : personnelName

The name of the personnel, for cases where the participant is of type personnel.

Match All

The name of the personnel, for cases where the participant is of type personnel.

Show Source

• 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":"The name of the personnel, for cases where the participant is of type personnel.",
    "allOf":[
        {
            "$ref":"#/definitions/PersonNameSummary"
        }
    ]
}

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 : 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: organization
  The organization associated with the encounter.

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

Nested Schema : organization

The organization associated with the encounter.

Match All

The organization associated with the encounter.

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/definitions/Organization"
        }
    ],
    "description":"The organization associated with the encounter."
}

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

Type: object

The sender of the message.

Show Source

• groupInboxSummary: groupInboxSummary
  The details of the group inbox, for cases where the participant is of type group inbox.
• id(required): string
  The unique identifier for the participant.
• personName: personName
  The name of the person, for cases where the participant is of type person.
• personnelName: personnelName
  The name of the personnel, for cases where the participant is of type personnel.
• 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.",
            "allOf":[
                {
                    "$ref":"#/definitions/PersonNameSummary"
                }
            ]
        },
        "personnelName":{
            "description":"The name of the personnel, for cases where the participant is of type personnel.",
            "allOf":[
                {
                    "$ref":"#/definitions/PersonNameSummary"
                }
            ]
        },
        "groupInboxSummary":{
            "description":"The details of the group inbox, for cases where the participant is of type group inbox.",
            "allOf":[
                {
                    "$ref":"#/definitions/GroupInboxSummary"
                }
            ]
        }
    },
    "description":"The sender of the message."
}

Nested Schema : groupInboxSummary

The details of the group inbox, for cases where the participant is of type group inbox.

Match All

The details of the group inbox, for cases where the participant is of type group inbox.

Show Source

• object GroupInboxSummary
  The summary of the Group Inbox sender.

{
    "description":"The details of the group inbox, for cases where the participant is of type group inbox.",
    "allOf":[
        {
            "$ref":"#/definitions/GroupInboxSummary"
        }
    ]
}

Nested Schema : personName

The name of the person, for cases where the participant is of type person.

Match All

The name of the person, for cases where the participant is of type person.

Show Source

• 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":"The name of the person, for cases where the participant is of type person.",
    "allOf":[
        {
            "$ref":"#/definitions/PersonNameSummary"
        }
    ]
}

Nested Schema : personnelName

The name of the personnel, for cases where the participant is of type personnel.

Match All

The name of the personnel, for cases where the participant is of type personnel.

Show Source

• 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":"The name of the personnel, for cases where the participant is of type personnel.",
    "allOf":[
        {
            "$ref":"#/definitions/PersonNameSummary"
        }
    ]
}

Nested Schema : GroupInboxSummary

Type: object

The summary of the Group Inbox sender.

Show Source

• groupInboxName(required): string
  The name of the group inbox.
• personnelSender: personnelSender
  The sender who sent the message from group inbox.

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

Nested Schema : personnelSender

The sender who sent the message from group inbox.

Match All

The sender who sent the message from group inbox.

Show Source

• 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.

{
    "allOf":[
        {
            "$ref":"#/definitions/PersonSimple"
        }
    ],
    "description":"The sender who sent the message from group inbox."
}

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: name
  The name of the individual.

{
    "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.",
            "allOf":[
                {
                    "$ref":"#/definitions/PersonNameSummary"
                }
            ]
        }
    }
}

Nested Schema : name

The name of the individual.

Match All

The name of the individual.

Show Source

• 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":"The name of the individual.",
    "allOf":[
        {
            "$ref":"#/definitions/PersonNameSummary"
        }
    ]
}

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

400 Response

Bad Request

Headers

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

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

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

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

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

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

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

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

Show Source

• Array of: string

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

401 Response

Unauthorized

Headers

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

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

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

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

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

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

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

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

Show Source

• Array of: string

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

403 Response

NotAuthorized

Headers

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

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

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

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

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

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

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

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

Show Source

• Array of: string

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

404 Response

Not Found

Headers

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

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

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

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

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

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

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

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

Show Source

• Array of: string

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

429 Response

Too Many Requests

Headers

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

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

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

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

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

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

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

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

Show Source

• Array of: string

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

500 Response

Internal Server Error

Headers

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

Body ()

Root Schema : ApiError

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• details: array details
  A list of details regarding any and all errors from the resulting service request.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        },
        "details":{
            "type":"array",
            "description":"A list of details regarding any and all errors from the resulting service request.",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

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

Show Source

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

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

Nested Schema : ErrorDetail

Type: object

Additional detail information pertaining to the error.

Show Source

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

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

Nested Schema : ErrorDetailSource

Type: object

An object containing references to the source of the error.

Show Source

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

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

Nested Schema : headers

Type: array

A list of the request headers that caused the error.

Show Source

• Array of: string

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

Nested Schema : parameters

Type: array

A list of which URI query parameters caused the error.

Show Source

• Array of: string

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

Nested Schema : pointers

Type: array

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

Show Source

• Array of: string

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

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