Get a contact member

get

/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/{serviceRequests_id}/contacts/{serviceRequests-contacts_id}

Request

Path Parameters
  • This path parameter maps to the following field defined in the Service Requests/Service Request Contacts REST resource:
    1. memberId: The unique identifier of the contact.
  • This path parameter maps to the following field defined in the Service Requests REST resource:
    1. number: The unique number that's used to identify a service request. You can edit the service request number to a format that's best suitable to your organizational requirements.
Query Parameters
  • Restricts the resource fields. Only the specified fields and mandatory system fields are returned.

There's no request body for this operation.

Back to Top

Response

Default Response

A single item response
Body ()
Root Schema : serviceRequests-contacts_item-response
Match All
Show Source
Nested Schema : oraCxServiceCoreSrMgmt.ContactMember_item
Match All
The contacts resource is used to view, create, update, and delete contacts. It's a list of workers associated with a service request. For example, the agent can communicate with a worker and their manager. Agents communicate service request resolutions or other information with contacts. Communication channels include email and phone.
Show Source
  • oraCxServiceCoreSrMgmt.ContactMember_item-fields
  • Service Request Contact
    Title: Service Request Contact
    The contacts resource is used to view, create, update, and delete contacts. It's a list of workers associated with a service request. For example, the agent can communicate with a worker and their manager. Agents communicate service request resolutions or other information with contacts. Communication channels include email and phone.
Nested Schema : oraCxServiceCoreSrMgmt.ContactMember_item-fields
Type: object
Show Source
Nested Schema : Service Request Contact
Type: object
Title: Service Request Contact
The contacts resource is used to view, create, update, and delete contacts. It's a list of workers associated with a service request. For example, the agent can communicate with a worker and their manager. Agents communicate service request resolutions or other information with contacts. Communication channels include email and phone.
Nested Schema : __busObj_context
Type: object
Show Source
Nested Schema : accessLevelCode
Match All
The access level granted to the service request contact.
Show Source
  • Title: Access Level
    Read Only: true
    The access level granted to the service request contact.
  • Allowed Values: [ "ORA_SVC_NO_SR_ACCESS", "ORA_SVC_REG_SR_ACCESS" ]
Nested Schema : contact
Match All
The unique party identifier of the contact.
Show Source
Nested Schema : contactTypeCode
Match All
The service request contact type such as Customer or Partner.
Show Source
  • Title: Contact Type
    Read Only: true
    The service request contact type such as Customer or Partner.
  • Allowed Values: [ "ORA_SVC_CUSTOMER", "ORA_SVC_UNDETERMINED", "ORA_SVC_PARTNER" ]
Nested Schema : serviceRequest
Match All
The service requests resource is used to view, create, update, and delete service requests. A service request is a document to track a request from a worker for a service from the time the worker makes the request until the request is resolved.
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
Type: object
Title: Contact
The unique party identifier of the contact.
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 : 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 : primaryCustomerAccount
Match All
Show Source
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: Prefix
    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
Match All
Resource records comprehensive details regarding a resource's engagement, activities, and overall duration.
Show Source
Nested Schema : oraCxSalesCommonResourceMgmt.Resource_item-fields
Type: object
Show Source
Nested Schema : Resource
Type: object
Title: Resource
Resource records comprehensive details regarding a resource's engagement, activities, and overall duration.
Nested Schema : ownerResource-allOf[2]
Type: object
Nested Schema : person
Match All
Show Source
Nested Schema : oraCxSalesCommonResourceMgmt.ResourcePerson_item
Match All
Resource Person records essential details pertaining to an individual within the resource framework.
Show Source
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: 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
Resource Person records essential details pertaining to an individual within the resource framework.
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
Match All
The time zones list of values resource is used to query the time zones.
Show Source
Nested Schema : oraCommonAppsInfraObjects.Timezone_item-fields
Type: object
Show Source
Nested Schema : Time Zone
Type: object
Title: Time Zone
The time zones list of values resource is used to query the time zones.
Nested Schema : timezone-allOf[2]
Type: object
Nested Schema : $context
Type: object
Show Source
Nested Schema : oraCxSalesCommonCustomerMgmt.Customer_item
Match All
Customer includes information about a Sales or Financial Account such as the total number of employees in a company, historical data, contact information, primary addresses, and so on.
Show Source
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 : Customer
Type: object
Title: Customer
Customer includes information about a Sales or Financial Account such as the total number of employees in a company, historical data, contact information, primary addresses, and so on.
Nested Schema : primaryCustomerAccount-allOf[2]
Type: object
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 : 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 : oraErpCoreCurrencySetup.Currency_item
Match All
Currencies are defined and populated through seed data and used to create transactions within the application. This object encapsulates various properties and functionalities related to a specific currency.
Show Source
Nested Schema : oraErpCoreCurrencySetup.Currency_item-fields
Type: object
Show Source
Nested Schema : Currency
Type: object
Title: Currency
Currencies are defined and populated through seed data and used to create transactions within the application. This object encapsulates various properties and functionalities related to a specific currency.
Nested Schema : corporateCurrency-allOf[2]
Type: object
Nested Schema : deriveTypeInformation
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_item
Match All
The standard lookup codes list of values resource is used to query the list of standard lookup codes.
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 : Standard Lookup Code
Type: object
Title: Standard Lookup Code
The standard lookup codes list of values resource is used to query the list of standard lookup codes.
Nested Schema : deriveTypeInformation-allOf[2]
Type: object
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 : Taxonomy Node
Type: object
Title: Taxonomy Node
The taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : oraCxSalesCommonCustomerMgmt.CustomerHierarchyColumnFlattened_item
Match All
The account hierarchy summaries resource is used to view the account hierarchy information.
Show Source
Nested Schema : oraCxSalesCommonCustomerMgmt.CustomerHierarchyColumnFlattened_item-fields
Type: object
Show Source
Nested Schema : Account Hierarchy
Type: object
Title: Account Hierarchy
The account hierarchy summaries resource is used to view the account hierarchy information.
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 : oraCommonAppsInfraObjects.Territory_item
Match All
The territories list of values resource is used to query the ISO standard territories.
Show Source
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 : Territory
Type: object
Title: Territory
The territories list of values resource is used to query the ISO standard territories.
Nested Schema : homeCountry-allOf[2]
Type: object
Nested Schema : legalStatus-allOf[2]
Type: object
Nested Schema : ownerResource-allOf[2]
Type: object
Nested Schema : oraCxServiceCoreSrMgmt.ServiceRequest_item-fields
Type: object
Show Source
Nested Schema : Service Request
Type: object
Title: Service Request
The service requests resource is used to view, create, update, and delete service requests. A service request is a document to track a request from a worker for a service from the time the worker makes the request until the request is resolved.
Nested Schema : assigneeResource
Match All
Show Source
Nested Schema : businessUnit
Match All
Show Source
Nested Schema : category
Match All
Show Source
Nested Schema : channelType
Match All
The channel type.
Show Source
Nested Schema : createdByParty
Match All
Show Source
Nested Schema : customer
Match All
Show Source
Nested Schema : installedBaseAsset
Match All
The unique identifier of the associated install base asset record.
Show Source
Nested Schema : internalPriority
Match All
The internal priority of the service request.
Show Source
Nested Schema : lastUpdatedByParty
Match All
Show Source
Nested Schema : ownerTypeCode
Match All
The type of the service request owner. For example, customer or partner.
Show Source
  • Title: Owner Type
    Read Only: true
    The type of the service request owner. For example, customer or partner.
  • Allowed Values: [ "ORA_SVC_CUSTOMER", "ORA_SVC_PARTNER" ]
Nested Schema : primaryContact
Match All
Show Source
Nested Schema : problemType
Match All
The problem code of the service request.
Show Source
Nested Schema : productGroup
Match All
Show Source
Nested Schema : productItem
Match All
Show Source
Nested Schema : queue
Match All
Show Source
Nested Schema : reportedByParty
Match All
Show Source
Nested Schema : resolution
Match All
The resolution code of the service request.
Show Source
Nested Schema : resolvedByParty
Match All
Show Source
Nested Schema : resolveOutcome
Match All
The outcome of a service request resolution.
Show Source
Nested Schema : severity
Match All
The severity of the service request.
Show Source
Nested Schema : source
Match All
Indicates how the service request was created.
Show Source
Nested Schema : sourceUpdatedByParty
Match All
Show Source
Nested Schema : status
Match All
The status code of the service request.
Show Source
Nested Schema : statusType
Match All
The status type of the service request.
Show Source
Nested Schema : transferReason
Match All
The lookup code that indicates the transfer reason.
Show Source
Nested Schema : Assignee Resource
Type: object
Title: Assignee Resource
Nested Schema : Business Unit
Type: object
Title: Business Unit
Nested Schema : Category
Type: object
Title: Category
Nested Schema : Channel Type
Type: object
Title: Channel Type
The channel type.
Nested Schema : Created by Party
Type: object
Title: Created by Party
Nested Schema : Customer
Type: object
Title: Customer
Nested Schema : Installed Base Asset ID
Type: object
Title: Installed Base Asset ID
The unique identifier of the associated install base asset record.
Nested Schema : Internal Priority Code
Type: object
Title: Internal Priority Code
The internal priority of the service request.
Nested Schema : Last Updated by Party
Type: object
Title: Last Updated by Party
Nested Schema : Primary Contact
Type: object
Title: Primary Contact
Nested Schema : Problem Type Code
Type: object
Title: Problem Type Code
The problem code of the service request.
Nested Schema : Product Group
Type: object
Title: Product Group
Nested Schema : Product
Type: object
Title: Product
Nested Schema : Queue
Type: object
Title: Queue
Nested Schema : Reported by Party
Type: object
Title: Reported by Party
Nested Schema : Resolution Code
Type: object
Title: Resolution Code
The resolution code of the service request.
Nested Schema : Resolved by Party
Type: object
Title: Resolved by Party
Nested Schema : Outcome
Type: object
Title: Outcome
The outcome of a service request resolution.
Nested Schema : Severity Code
Type: object
Title: Severity Code
The severity of the service request.
Nested Schema : Source Code
Type: object
Title: Source Code
Indicates how the service request was created.
Nested Schema : Source Updated by Party
Type: object
Title: Source Updated by Party
Nested Schema : Status
Type: object
Title: Status
The status code of the service request.
Nested Schema : Status Type
Type: object
Title: Status Type
The status type of the service request.
Nested Schema : Transfer Reason
Type: object
Title: Transfer Reason
The lookup code that indicates the transfer reason.
Back to Top