1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Interactions
  4. Interactions (Spectra)
  5. Interaction Participant

Create an interaction participant

post

/api/boss/data/objects/ora/cxServiceCore/interaction/v1/$en/interactions/{interactions_id}/participants

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Match All
Show Source
Nested Schema : oraCxServiceCoreInteraction.InteractionParticipant_post-item
Match All
Show Source
Nested Schema : oraCxServiceCoreInteraction.InteractionParticipant_item
Match All
Interaction participants are people or entities, such contact or household, that participate in the interaction.
Show Source
Nested Schema : oraCxServiceCoreInteraction.InteractionParticipant_item-fields
Type: object
Show Source
Nested Schema : Interaction Participant
Type: object
Title: Interaction Participant
Interaction participants are people or entities, such contact or household, that participate in the interaction.
Nested Schema : oraCxServiceCoreInteraction.InteractionParticipant_post-item-allOf[1]
Type: object
Show Source
Nested Schema : __busObj_context
Type: object
Show Source
Nested Schema : contact
Match All
The contact party identifier.
Show Source
Nested Schema : interaction
Match All
Interactions track the communications associated with an object such as Account or Contact.
Show Source
Nested Schema : participantType
Match All
Type of interaction participant.
Show Source
Nested Schema : resourceParty
Match All
The resource party identifier.
Show Source
Nested Schema : oraCxSalesCommonCustomerMgmt.Contact_item-fields
Match All
Show Source
Nested Schema : oraCxSalesCommonCustomerMgmt.Contact_item-fields-allOf[0]
Type: object
Show Source
Nested Schema : oraCxSalesCommonParty.Person_abstract-item
Type: object
Show Source
Nested Schema : oraCxSalesCommonCustomerMgmt.Contact_item-fields-allOf[2]
Type: object
Show Source
Nested Schema : Contact Party ID
Type: object
Title: Contact Party ID
The contact party identifier.
Nested Schema : departmentCode
Match All
The department code for the person. A list of accepted values is defined in the lookup DEPARTMENT_TYPE.
Show Source
  • Title: Department Code
    The department code for the person. A list of accepted values is defined in the lookup DEPARTMENT_TYPE.
  • Allowed Values: [ "ACCOUNTING", "ACCOUNTS PAYABLE", "ACCOUNTS RECEIVABLE", "CALL CENTER", "CONSULTING", "CUSTOMER SERVICE", "DISTRIBUTION/LOGISTICS", "EDUCATION", "FACILITIES", "HUMAN RESOURCES", "INFORMATION TECHNOLOGY", "INVESTOR RELATIONS", "LEGAL", "MANUFACTURING", "MARKETING", "OPERATIONS", "PAYROLL", "PUBLIC RELATIONS", "PURCHASING", "R&D", "REAL ESTATE", "SALES", "SUPPORT", "TRAINING" ]
Nested Schema : gender
Match All
The gender of the person as identified by them. A list of accepted values are defined in the lookup HZ_GENDER.
Show Source
  • Title: Gender
    The gender of the person as identified by them. A list of accepted values are defined in the lookup HZ_GENDER.
  • Allowed Values: [ "FEMALE", "MALE" ]
Nested Schema : jobTitleCode
Match All
The code given to the job title.
Show Source
  • Title: Job Title Code
    The code given to the job title.
  • Allowed Values: [ "ACCOUNTANT", "ACCOUNTS_PAYABLE_SPECIALIST", "ADMINISTRATOR", "ANALYST", "ARCHITECT", "ARTIST", "ASSISTANT", "ASSOCIATE", "ATTORNEY", "AUDITOR", "BROKER", "BUYER", "CEO", "CFO", "CHAIRMAN", "CIO", "CONSULTANT", "CONTRLR", "COO", "CTO", "DESIGNER", "DEVELOPER", "DIRECTOR", "EDITOR", "ENGINEER", "MANAGER", "OFFICER", "OPERATOR", "OWNER", "PARALEGAL", "PARTNER", "PHYSICIAN", "PLANNER", "PRESIDENT", "PRODUCER", "RECEPTIONIST", "REPORTER", "REPRESENTATIVE", "RESEARCHER", "STAFF", "SUPERVISOR", "TRAINER", "VICE PRESIDENT", "WRITER" ]
Nested Schema : maritalStatus
Match All
The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS.
Show Source
  • Title: Marital Status
    The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS.
  • Allowed Values: [ "M", "S" ]
Nested Schema : ownerResource
Match All
Show Source
Nested Schema : preferredContactMethod
Match All
The preferred communication method of a person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD.
Show Source
  • Title: Preferred Contact Method
    The preferred communication method of a person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD.
  • Allowed Values: [ "EMAIL", "MAIL", "PHONE" ]
Nested Schema : primaryContact
Match All
Show Source
Nested Schema : primaryCustomerAccount
Match All
Show Source
Nested Schema : rentOrOwn
Match All
Indicates whether the person owns or rents their residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND.
Show Source
  • Title: Rent or Own Indicator
    Indicates whether the person owns or rents their residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND.
  • Allowed Values: [ "O", "R" ]
Nested Schema : salutoryIntroduction
Match All
Contains titles or honorifics preceding a person's name, like Mr., Mrs., Ms., and so on. For example, Mr. in Mr. John Smith.
Show Source
  • Title: Salutary Introduction
    Contains titles or honorifics preceding a person's name, like Mr., Mrs., Ms., and so on. For example, Mr. in Mr. John Smith.
  • Allowed Values: [ "MR.", "MRS.", "MS." ]
Nested Schema : type
Match All
Show Source
  • Title: Type
  • Allowed Values: [ "ZCA_CONTACT", "ZCA_CUSTOMER", "ZCA_PROSPECT" ]
Nested Schema : oraCxSalesCommonResourceMgmt.Resource_item-fields
Type: object
Show Source
Nested Schema : Owner Resource
Type: object
Title: Owner Resource
Nested Schema : corporateCurrency
Match All
The corporate currency code for the record.
Show Source
Nested Schema : currency
Match All
The currency code for the record.
Show Source
Nested Schema : person
Match All
The accessor for Person in Resource business object.
Show Source
Nested Schema : timezone
Match All
Show Source
Nested Schema : oraErpCoreCurrencySetup.Currency_item-fields
Match All
Show Source
Nested Schema : oraErpCoreCurrencySetup.Currency_item-fields-allOf[0]
Type: object
Show Source
Nested Schema : oraErpCoreCurrencySetup.Currency_item-fields-allOf[1]
Type: object
Nested Schema : Corporate Currency Code
Type: object
Title: Corporate Currency Code
The corporate currency code for the record.
Nested Schema : deriveTypeInformation
Match All
A currency derivation type indicates whether amounts are in euros or derived from the euro. Possible values are defined in lookup type FND_CURRENCIES_DERIVATION_TYPE.
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_abstract-item
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_abstract-item-allOf[0]
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.LookupCode_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Derivation Type
Type: object
Title: Derivation Type
A currency derivation type indicates whether amounts are in euros or derived from the euro. Possible values are defined in lookup type FND_CURRENCIES_DERIVATION_TYPE.
Nested Schema : owningType
Match All
The standard lookup types list of values resource is used to query the list of standard lookup types.
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupType_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.LookupType_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupType_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Standard Lookup Type
Type: object
Title: Standard Lookup Type
The standard lookup types list of values resource is used to query the list of standard lookup types.
Nested Schema : configurationLevel
Match All
Show Source
Nested Schema : restAccessSecured
Match All
Show Source
  • Read Only: true
  • Allowed Values: [ "ANON", "AUTH", "SECURE" ]
Nested Schema : taxonomyNode
Match All
The taxonomy node list of values resource is used to query the taxonomy nodes.
Show Source
Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Taxonomy Node
Type: object
Title: Taxonomy Node
The taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : hierarchySource
Match All
The taxonomy hierarchy represents relationships between taxonomy nodes.
Show Source
Nested Schema : moduleType
Match All
Show Source
  • Read Only: true
  • Allowed Values: [ "APPLICATION", "LBA", "PAGE", "PRODUCT_LINE", "DELIVERY_ROOT", "FAMILY" ]
Nested Schema : oraCommonAppsInfraObjects.TaxonomyHierarchy_item-fields
Type: object
Show Source
Nested Schema : Taxonomy Hierarchy
Type: object
Title: Taxonomy Hierarchy
The taxonomy hierarchy represents relationships between taxonomy nodes.
Nested Schema : sourceNode
Match All
The taxonomy node list of values resource is used to query the taxonomy nodes.
Show Source
Nested Schema : targetNode
Match All
The taxonomy node list of values resource is used to query the taxonomy nodes.
Show Source
Nested Schema : Taxonomy Node
Type: object
Title: Taxonomy Node
The taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : $context
Type: object
Show Source
Nested Schema : links
Type: object
Read Only: true
Show Source
Nested Schema : $self
Type: object
Show Source
Nested Schema : Taxonomy Node
Type: object
Title: Taxonomy Node
The taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : Currency Code
Type: object
Title: Currency Code
The currency code for the record.
Nested Schema : oraCxSalesCommonResourceMgmt.ResourcePerson_item-fields
Match All
Show Source
Nested Schema : oraCxSalesCommonResourceMgmt.ResourcePerson_item-fields-allOf[0]
Type: object
Show Source
  • Title: Internal
    Read Only: true
    Default Value: false
    Indicates whether the person is an internal member of the organization. If Y, the person is an internal member. For example, employee or retired employee. If N they're an external person. For example, partner contact, supplier contact. Default value is set to N.
  • Title: Middle Name
    The middle name of the person.
  • Title: Person Name
    Read Only: true
    The combination of title, first, middle, last, and suffix names of the person.
Nested Schema : oraCxSalesCommonResourceMgmt.ResourcePerson_item-fields-allOf[2]
Type: object
Show Source
  • Title: Comments
    The free text comments about the person.
  • Title: Do Not Call
    Indicates whether the person can be called or not. If the value is True, then the person must not be called. The default is False. A list of accepted values is defined using the lookup YES_NO.
  • Title: Do Not Contact
    Indicates whether the person can be contacted or not by phone, e-mail, or mail. If the value is True, then the person must not be contacted. The default is False. A list of accepted values is defined using the lookup YES_NO.
  • Title: Do Not Mail
    Indicates whether the person can be sent mail or not. If the value is True, then the person must not be sent mail. The default is False. A list of accepted values is defined using the lookup YES_NO.
  • Title: First Name
    First name of the person.
  • Title: Gender
    The gender of the person as identified by them. A list of accepted values are defined in the lookup HZ_GENDER.
  • Title: Person ID
    The unique identifier of the person profile.
  • Title: Job Title
    The free form text for job title of the person.
  • Title: Job Title Code
    The code given to the job title.
  • Title: Last Name
    The last name of the person.
  • Title: Preferred Contact Method
    The preferred communication method of a person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD.
  • Title: Registry ID
    The alternate identifier of the contact.
  • Title: Salutation
    The phrase used to address a contact party in any correspondence.
  • Title: Prefix
    Contains titles or honorifics preceding a person's name, like Mr., Mrs., Ms., and so on. For example, Mr. in Mr. John Smith.
  • Title: Title
    A professional or family title, such as Don or The Right Honorable.
Nested Schema : Resource Person
Type: object
Title: Resource Person
The accessor for Person in Resource business object.
Nested Schema : gender
Match All
Show Source
Nested Schema : jobTitleCode
Match All
Show Source
  • Allowed Values: [ "ACCOUNTANT", "ACCOUNTS_PAYABLE_SPECIALIST", "ADMINISTRATOR", "ANALYST", "ARCHITECT", "ARTIST", "ASSISTANT", "ASSOCIATE", "ATTORNEY", "AUDITOR", "BROKER", "BUYER", "CEO", "CFO", "CHAIRMAN", "CIO", "CONSULTANT", "CONTRLR", "COO", "CTO", "DESIGNER", "DEVELOPER", "DIRECTOR", "EDITOR", "ENGINEER", "MANAGER", "OFFICER", "OPERATOR", "OWNER", "PARALEGAL", "PARTNER", "PHYSICIAN", "PLANNER", "PRESIDENT", "PRODUCER", "RECEPTIONIST", "REPORTER", "REPRESENTATIVE", "RESEARCHER", "STAFF", "SUPERVISOR", "TRAINER", "VICE PRESIDENT", "WRITER" ]
Nested Schema : preferredContactMethod
Match All
Show Source
Nested Schema : salutoryIntroduction
Match All
Show Source
Nested Schema : timezone
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.Timezone_item-fields
Type: object
Show Source
Nested Schema : Time Zone
Type: object
Title: Time Zone
Nested Schema : Time Zone
Type: object
Title: Time Zone
Nested Schema : Primary Contact
Type: object
Title: Primary Contact
Nested Schema : oraCxSalesCommonCustomerMgmt.Customer_item-fields
Match All
Show Source
Nested Schema : oraCxSalesCommonCustomerMgmt.Customer_item-fields-allOf[0]
Type: object
Show Source
Nested Schema : oraCxSalesCommonParty.Organization_abstract-item
Type: object
Show Source
Nested Schema : oraCxSalesCommonCustomerMgmt.Customer_item-fields-allOf[2]
Type: object
Show Source
  • Title: Organization ID
    The unique identifier of the organization profile.
  • Title: Name
    The name of the organization.
  • Title: Registry ID
    The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.
Nested Schema : Primary Customer Account
Type: object
Title: Primary Customer Account
Nested Schema : certificationLevel
Match All
The certification level the organization. A list of valid certification level codes is defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
Show Source
  • Title: Certification Level
    The certification level the organization. A list of valid certification level codes is defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Allowed Values: [ "100", "200", "300" ]
Nested Schema : corporateCurrency
Match All
Show Source
Nested Schema : hierarchy
Match All
Show Source
Nested Schema : homeCountry
Match All
Show Source
Nested Schema : hQBranchIndicator
Match All
The status of this site, such as HQ, a branch, or a single location. A list of accepted values are defined in the lookup type HQ_BRANCH_IND.
Show Source
  • Title: HQ Branch Indicator
    The status of this site, such as HQ, a branch, or a single location. A list of accepted values are defined in the lookup type HQ_BRANCH_IND.
  • Allowed Values: [ "BR", "DIV", "HQ", "SL", "SUB" ]
Nested Schema : legalStatus
Match All
Show Source
Nested Schema : masterCustomer
Match All
Show Source
Nested Schema : ownerResource
Match All
Show Source
Nested Schema : salesProfileStatus
Match All
A valid user defined status of the sales account.
Show Source
  • Title: Status
    A valid user defined status of the sales account.
  • Allowed Values: [ "ACTIVE", "INACTIVE" ]
Nested Schema : type
Match All
The account type that defines if the account is a sales account or a prospect or any other party type. The accepted values are defined in the lookup type ZCA_ACCOUNT_TYPE. It's defaulted to ZCA_CUSTOMER if no value is provided.
Show Source
  • Title: Type
    The account type that defines if the account is a sales account or a prospect or any other party type. The accepted values are defined in the lookup type ZCA_ACCOUNT_TYPE. It's defaulted to ZCA_CUSTOMER if no value is provided.
  • Allowed Values: [ "ZCA_CONTACT", "ZCA_CUSTOMER", "ZCA_PROSPECT" ]
Nested Schema : Corporate Currency
Type: object
Title: Corporate Currency
Nested Schema : oraCxSalesCommonCustomerMgmt.CustomerHierarchyColumnFlattened_item-fields
Type: object
Show Source
Nested Schema : Hierarchy-
Type: object
Title: Hierarchy-
Nested Schema : baseLevel
Match All
Show Source
Nested Schema : level1
Match All
Show Source
Nested Schema : level2
Match All
Show Source
Nested Schema : level3
Match All
Show Source
Nested Schema : level4
Match All
Show Source
Nested Schema : level5
Match All
Show Source
Nested Schema : level6
Match All
Show Source
Nested Schema : level7
Match All
Show Source
Nested Schema : level8
Match All
Show Source
Nested Schema : parent
Match All
Show Source
Nested Schema : topLevel
Match All
Show Source
Nested Schema : ultimateParent
Match All
Show Source
Nested Schema : Base Level Id
Type: object
Title: Base Level Id
Nested Schema : Level 1 Id
Type: object
Title: Level 1 Id
Nested Schema : Level 2 Id
Type: object
Title: Level 2 Id
Nested Schema : Level 3 Id
Type: object
Title: Level 3 Id
Nested Schema : Level 4 Id
Type: object
Title: Level 4 Id
Nested Schema : Level 5 Id
Type: object
Title: Level 5 Id
Nested Schema : Level 6 Id
Type: object
Title: Level 6 Id
Nested Schema : Level 7 Id
Type: object
Title: Level 7 Id
Nested Schema : Level 8 Id
Type: object
Title: Level 8 Id
Nested Schema : Parent
Type: object
Title: Parent
Nested Schema : Top Level Id
Type: object
Title: Top Level Id
Nested Schema : Ultimate Parent
Type: object
Title: Ultimate Parent
Nested Schema : oraCommonAppsInfraObjects.Territory_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.Territory_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.Territory_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Home Country
Type: object
Title: Home Country
Nested Schema : Legal Status
Type: object
Title: Legal Status
Nested Schema : Master Party ID
Type: object
Title: Master Party ID
Nested Schema : Owner Resource
Type: object
Title: Owner Resource
Nested Schema : oraCxServiceCoreInteraction.Interaction_item-fields
Type: object
Show Source
Nested Schema : Interaction
Type: object
Title: Interaction
Interactions track the communications associated with an object such as Account or Contact.
Nested Schema : appClassification
Match All
Application classification of the interaction such as sales, service, human resources, help desk, and so on.
Show Source
Nested Schema : appInterfaceType
Match All
Application interface used for interaction creation such as Redwood and ADF.
Show Source
Nested Schema : businessUnit
Match All
The name of the business unit.
Show Source
Nested Schema : channel
Match All
The unique identifier of the interaction channel.
Show Source
Nested Schema : channelType
Match All
Indicates the type of channel for the interaction.
Show Source
Nested Schema : contact
Match All
The unique identifier of the contact person with whom the agent is interacting.
Show Source
Nested Schema : contactPerson
Match All
The unique identifier of the contact person.
Show Source
Nested Schema : customer
Match All
The account name associated with the interaction.
Show Source
Nested Schema : directionCode
Match All
The list of values for the direction of the interaction, either inbound or outbound.
Show Source
  • Title: Direction
    Default Value: ORA_SVC_INBOUND
    The list of values for the direction of the interaction, either inbound or outbound.
  • Allowed Values: [ "ORA_SVC_INBOUND", "ORA_SVC_OUTBOUND" ]
Nested Schema : ownerResource
Match All
The unique identifier of the agent who owns the interaction.
Show Source
Nested Schema : parentInteraction
Match All
The unique identifier of the parent interaction.
Show Source
Nested Schema : queue
Match All
The unique identifier of the interaction queue.
Show Source
Nested Schema : source
Match All
Indicates the display value corresponding to the source code lookup for the interaction.
Show Source
Nested Schema : status
Match All
The interaction status.
Show Source
Nested Schema : stripeCode
Match All
The application stripe of the interaction.
Show Source
  • Title: Stripe Code
    Default Value: ORA_SVC_CRM
    The application stripe of the interaction.
  • Allowed Values: [ "ORA_SVC_CRM", "ORA_SVC_HRHD", "ORA_SVC_ISR" ]
Nested Schema : subStatus
Match All
The lookup code that indicates the substatus code.
Show Source
Nested Schema : Application Classification Code
Type: object
Title: Application Classification Code
Application classification of the interaction such as sales, service, human resources, help desk, and so on.
Nested Schema : Application Interface Type Code
Type: object
Title: Application Interface Type Code
Application interface used for interaction creation such as Redwood and ADF.
Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields
Match All
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.Organization_abstract-item
Match All
Show Source
Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields-allOf[0]
Type: object
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.Organization_abstract-item-allOf[0]
Type: object
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.OrganizationBase_abstract-item
Type: object
Show Source
Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields-allOf[2]
Type: object
Show Source
Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields-allOf[3]
Type: object
Nested Schema : Business Unit
Type: object
Title: Business Unit
The name of the business unit.
Nested Schema : actionOccurrence
Match All
Action Occurrence accessor for the organization.
Show Source
Nested Schema : location
Match All
Location accessor for the organization.
Show Source
Nested Schema : oraHcmHrCoreEmployment.ActionOccurrence_item-fields
Type: object
Show Source
Nested Schema : Action Occurrence
Type: object
Title: Action Occurrence
Action Occurrence accessor for the organization.
Nested Schema : action
Match All
Action accessor for action occurrence item.
Show Source
Nested Schema : actionReason
Match All
Action reason accessor for action occurrence item.
Show Source
Nested Schema : oraHcmHrCoreEmployment.Action_item-fields
Type: object
Show Source
Nested Schema : Action
Type: object
Title: Action
Action accessor for action occurrence item.
Nested Schema : oraHcmHrCoreEmployment.ActionReason_item-fields
Type: object
Show Source
Nested Schema : Action Reason
Type: object
Title: Action Reason
Action reason accessor for action occurrence item.
Nested Schema : oraHcmHrCoreWorkStructures.Location_item-fields
Match All
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.Location_abstract-item
Match All
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.Location_abstract-item-allOf[0]
Type: object
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.LocationBase_abstract-item
Type: object
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.Location_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Location
Type: object
Title: Location
Location accessor for the organization.
Nested Schema : actionOccurrence
Match All
Action Occurrence accessor for the location.
Show Source
Nested Schema : country
Match All
Country name for the location address.
Show Source
Nested Schema : mainAddress
Match All
Main address accessor for the location.
Show Source
Nested Schema : setIdSet
Match All
Set Id set accessor for the location.
Show Source
Nested Schema : status
Match All
Show Source
Nested Schema : timezone
Match All
Time zone code for the location address.
Show Source
Nested Schema : Action Occurrence
Type: object
Title: Action Occurrence
Action Occurrence accessor for the location.
Nested Schema : Country
Type: object
Title: Country
Country name for the location address.
Nested Schema : oraHcmHrCoreWorkStructures.LocationAddress_item-fields
Match All
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.LocationAddressBase_abstract-item
Type: object
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.LocationAddress_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Main Address
Type: object
Title: Main Address
Main address accessor for the location.
Nested Schema : country
Match All
Country accessor for the location address.
Show Source
Nested Schema : location
Match All
Location accessor for the location address.
Show Source
Nested Schema : type
Match All
Show Source
  • Read Only: true
  • Allowed Values: [ "BILL", "BUSN", "CHK", "CODE", "H", "LEGL", "MAILING", "MAIN", "OTH", "T" ]
Nested Schema : Country
Type: object
Title: Country
Country accessor for the location address.
Nested Schema : Location
Type: object
Title: Location
Location accessor for the location address.
Nested Schema : oraCommonAppsInfraObjects.SetIdSet_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.SetIdSet_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.SetIdSet_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Set Id Set
Type: object
Title: Set Id Set
Set Id set accessor for the location.
Nested Schema : Time Zone
Type: object
Title: Time Zone
Time zone code for the location address.
Nested Schema : oraCxServiceCoreCommon.Channel_item-fields
Match All
Show Source
Nested Schema : oraCxServiceCoreCommon.Channel_item-fields-allOf[0]
Type: object
Show Source
Nested Schema : oraCxServiceCoreCommon.Channel_item-fields-allOf[1]
Type: object
Nested Schema : Channel
Type: object
Title: Channel
The unique identifier of the interaction channel.
Nested Schema : businessUnit
Match All
The unique identifier of the business unit associated with the category.
Show Source
Nested Schema : channelType
Match All
Indicates the channel through which the escalation occurred
Show Source
Nested Schema : customerType
Match All
The type of customers expected to send a message to the channel, such as Consumer, Business, or Both.
Show Source
Nested Schema : multipleMatchesAction
Match All
The action the application should take if multiple matches are found for the message sender, such as Select None or Select First Match.
Show Source
Nested Schema : networkType
Match All
The social network associated with the channel.
Show Source
Nested Schema : noMatchAction
Match All
The action the application should take if no matches are found for the message sender, such as Nothing or Create Contact.
Show Source
Nested Schema : purpose
Match All
The purpose of the channel such as Support, Sales, Inquiry.
Show Source
Nested Schema : source
Match All
The source interface for the channel creation.
Show Source
Nested Schema : stripeCode
Match All
The application stripe of the channel.
Show Source
  • Title: Stripe Code
    The application stripe of the channel.
  • Allowed Values: [ "ORA_SVC_CRM", "ORA_SVC_HRHD", "ORA_SVC_ISR" ]
Nested Schema : Business Unit
Type: object
Title: Business Unit
The unique identifier of the business unit associated with the category.
Nested Schema : Channel Type Code
Type: object
Title: Channel Type Code
Indicates the channel through which the escalation occurred
Nested Schema : Customer Type
Type: object
Title: Customer Type
The type of customers expected to send a message to the channel, such as Consumer, Business, or Both.
Nested Schema : If Multiple Matches Found for Sender
Type: object
Title: If Multiple Matches Found for Sender
The action the application should take if multiple matches are found for the message sender, such as Select None or Select First Match.
Nested Schema : Network
Type: object
Title: Network
The social network associated with the channel.
Nested Schema : If No Matches Found for Sender
Type: object
Title: If No Matches Found for Sender
The action the application should take if no matches are found for the message sender, such as Nothing or Create Contact.
Nested Schema : Purpose
Type: object
Title: Purpose
The purpose of the channel such as Support, Sales, Inquiry.
Nested Schema : Source Code
Type: object
Title: Source Code
The source interface for the channel creation.
Nested Schema : Channel Type
Type: object
Title: Channel Type
Indicates the type of channel for the interaction.
Nested Schema : Contact ID
Type: object
Title: Contact ID
The unique identifier of the contact person with whom the agent is interacting.
Nested Schema : oraHcmHrCoreEmployment.PersonDetail_item-fields
Match All
Show Source
Nested Schema : oraHcmHrCoreEmployment.PersonDetail_abstract-item
Match All
Show Source
Nested Schema : oraHcmHrCoreEmployment.PersonDetail_abstract-item-allOf[0]
Type: object
Show Source
Nested Schema : oraHcmHrCoreEmployment.PersonDetailBase_abstract-item
Type: object
Show Source
Nested Schema : oraHcmHrCoreEmployment.PersonDetail_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Contact Person ID
Type: object
Title: Contact Person ID
The unique identifier of the contact person.
Nested Schema : globalName
Match All
Global name accessor for person detail.
Show Source
Nested Schema : localName
Match All
Local name accessor for person detail.
Show Source
Nested Schema : mailingAddress
Match All
Mailing address accessor for person detail.
Show Source
Nested Schema : primaryEmail
Match All
Primary email accessor for person detail.
Show Source
Nested Schema : primaryNationalIdentifier
Match All
Primary national identifier accessor for person detail.
Show Source
Nested Schema : primaryPhone
Match All
Primary phone accessor for person detail.
Show Source
Nested Schema : oraHcmHrCoreEmployment.Name_item-fields
Match All
Show Source
Nested Schema : oraHcmHrCoreEmployment.Name_item-fields-allOf[0]
Type: object
Show Source
Nested Schema : oraHcmHrCoreEmployment.NameBase_abstract-item
Type: object
Show Source
Nested Schema : oraHcmHrCoreEmployment.Name_item-fields-allOf[2]
Type: object
Show Source
Nested Schema : Global Name
Type: object
Title: Global Name
Global name accessor for person detail.
Nested Schema : honors
Match All
Show Source
Nested Schema : language
Match All
Language for name business object.
Show Source
Nested Schema : legislation
Match All
Legislation for name business object.
Show Source
Nested Schema : militaryRank
Match All
Show Source
Nested Schema : personDetail
Match All
Person details accessor for Name business object.
Show Source
Nested Schema : title
Match All
Show Source
  • Read Only: true
  • Allowed Values: [ "DR.", "ENG.", "HH", "MISS", "MR.", "MRS.", "MS.", "ORA_HRX_ARCH", "ORA_HRX_ATTY", "ORA_HRX_DATIN" ]
Nested Schema : oraCommonAppsInfraObjects.Language_item-fields
Type: object
Show Source
Nested Schema : Language
Type: object
Title: Language
Language for name business object.
Nested Schema : activationStatus
Match All
The activation status of the language.
Show Source
  • Title: Language Activation Status
    Read Only: true
    The activation status of the language.
  • Allowed Values: [ "ACTIVE", "NONE", "PENDING" ]
Nested Schema : installed
Match All
Indicates if the language is installed.
Show Source
  • Title: Language Installed
    Read Only: true
    Indicates if the language is installed.
  • Allowed Values: [ "I", "B", "D" ]
Nested Schema : Legislation
Type: object
Title: Legislation
Legislation for name business object.
Nested Schema : Person Detail
Type: object
Title: Person Detail
Person details accessor for Name business object.
Nested Schema : Local Name
Type: object
Title: Local Name
Local name accessor for person detail.
Nested Schema : oraHcmHrCoreEmployment.PersonAddress_item-fields
Match All
Show Source
Nested Schema : oraHcmHrCoreEmployment.PersonAddress_item-fields-allOf[0]
Type: object
Show Source
Nested Schema : oraHcmHrCoreEmployment.PersonAddressBase_abstract-item
Type: object
Show Source
Nested Schema : oraHcmHrCoreEmployment.PersonAddress_item-fields-allOf[2]
Type: object
Show Source
Nested Schema : Mailing Address
Type: object
Title: Mailing Address
Mailing address accessor for person detail.
Nested Schema : country
Match All
Country code of the person's address.
Show Source
Nested Schema : personDetail
Match All
Person detail accessor for person address.
Show Source
Nested Schema : type
Match All
Show Source
  • Read Only: true
  • Allowed Values: [ "1", "2", "HOME", "JP_C", "MAIL", "ORA_HRX_IN_CUR", "ORA_HRX_IN_PER", "ORA_HRX_LEGAL" ]
Nested Schema : Country
Type: object
Title: Country
Country code of the person's address.
Nested Schema : Person Detail
Type: object
Title: Person Detail
Person detail accessor for person address.
Nested Schema : oraHcmHrCoreEmployment.Email_item-fields
Type: object
Show Source
Nested Schema : Primary Email
Type: object
Title: Primary Email
Primary email accessor for person detail.
Nested Schema : personDetail
Match All
Person detail accessor for email.
Show Source
Nested Schema : type
Match All
Type of the email.
Show Source
  • Title: Type
    Read Only: true
    Type of the email.
  • Allowed Values: [ "H1", "W1" ]
Nested Schema : Person Detail
Type: object
Title: Person Detail
Person detail accessor for email.
Nested Schema : oraHcmHrCoreEmployment.NationalIdentifier_item-fields
Type: object
Show Source
Nested Schema : Primary National Identifier
Type: object
Title: Primary National Identifier
Primary national identifier accessor for person detail.
Nested Schema : country
Match All
Country accessor for national identifier.
Show Source
Nested Schema : personDetail
Match All
Person detail accessor for national identifier.
Show Source
Nested Schema : type
Match All
Type accessor for national identifier.
Show Source
Nested Schema : Country
Type: object
Title: Country
Country accessor for national identifier.
Nested Schema : Person Detail
Type: object
Title: Person Detail
Person detail accessor for national identifier.
Nested Schema : oraCommonAppsInfraObjects.CommonLookupCode_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.CommonLookupCode_abstract-item
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.CommonLookupCode_abstract-item-allOf[0]
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.CommonLookupCode_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Type
Type: object
Title: Type
Type accessor for national identifier.
Nested Schema : owningType
Match All
The common lookup types list of values resource is used to query the list of common lookup types.
Show Source
Nested Schema : oraCommonAppsInfraObjects.CommonLookupType_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.CommonLookupType_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Common Lookup Type
Type: object
Title: Common Lookup Type
The common lookup types list of values resource is used to query the list of common lookup types.
Nested Schema : oraHcmHrCoreEmployment.Phone_item-fields
Type: object
Show Source
Nested Schema : Primary Phone
Type: object
Title: Primary Phone
Primary phone accessor for person detail.
Nested Schema : legislation
Match All
Legislation accessor of phone business object.
Show Source
Nested Schema : personDetail
Match All
Person Detail accessor of phone business object.
Show Source
Nested Schema : type
Match All
Type of phone. Valid values are defined in the commonLookupsLOV.
Show Source
Nested Schema : validity
Match All
Time of day when a person can be reached at a specific phone number.
Show Source
  • Title: Validity
    Default Value: A
    Time of day when a person can be reached at a specific phone number.
  • Allowed Values: [ "A", "D", "E", "EW", "W" ]
Nested Schema : Legislation
Type: object
Title: Legislation
Legislation accessor of phone business object.
Nested Schema : Person Detail
Type: object
Title: Person Detail
Person Detail accessor of phone business object.
Nested Schema : Type
Type: object
Title: Type
Type of phone. Valid values are defined in the commonLookupsLOV.
Nested Schema : Account ID
Type: object
Title: Account ID
The account name associated with the interaction.
Nested Schema : Owner Resource ID
Type: object
Title: Owner Resource ID
The unique identifier of the agent who owns the interaction.
Nested Schema : Parent Interaction ID
Type: object
Title: Parent Interaction ID
The unique identifier of the parent interaction.
Nested Schema : oraCxServiceCoreCommon.Queue_item-fields
Type: object
Show Source
Nested Schema : Queue ID
Type: object
Title: Queue ID
The unique identifier of the interaction queue.
Nested Schema : stripeCode
Match All
The code indicating the application stripe of the queue. A list of accepted values is defined in the lookup ORA_SVC_STRIPE_CD.
Show Source
  • Title: Stripe Code
    Read Only: true
    The code indicating the application stripe of the queue. A list of accepted values is defined in the lookup ORA_SVC_STRIPE_CD.
  • Allowed Values: [ "ORA_SVC_CRM", "ORA_SVC_HRHD", "ORA_SVC_ISR" ]
Nested Schema : Source Code
Type: object
Title: Source Code
Indicates the display value corresponding to the source code lookup for the interaction.
Nested Schema : Status
Type: object
Title: Status
The interaction status.
Nested Schema : Substatus Code
Type: object
Title: Substatus Code
The lookup code that indicates the substatus code.
Nested Schema : Participant Type Code
Type: object
Title: Participant Type Code
Type of interaction participant.
Nested Schema : Resource Party ID
Type: object
Title: Resource Party ID
The resource party identifier.
Nested Schema : contact
Match One Schema
Show Source
Nested Schema : interaction
Match One Schema
Show Source
Nested Schema : participantType
Match One Schema
Show Source
Nested Schema : resourceParty
Match One Schema
Show Source
Nested Schema : contact-oneOf[0]
Type: object
Show Source
Nested Schema : contact-oneOf[1]
Type: object
Show Source
Nested Schema : contact-oneOf[3]
Type: object
Nested Schema : id
Match All
Show Source
Nested Schema : registryId
Match All
Show Source
  • Title: Registry ID
    The alternate identifier of the contact.
Nested Schema : interaction-oneOf[0]
Type: object
Show Source
Nested Schema : participantType-oneOf[0]
Type: object
Show Source
Nested Schema : participantType-oneOf[2]
Type: object
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : resourceParty-oneOf[0]
Type: object
Show Source
Nested Schema : resourceParty-oneOf[1]
Type: object
Show Source
  • Title: Registry ID
    Read Only: true
    The alternate unique identifier of the party.
Nested Schema : resourceParty-oneOf[3]
Type: object
Back to Top

Response

Default Response

no content
Back to Top