1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Cases
  4. Case Contacts

Get all case contacts

get

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseContacts

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • CaseContactAltKeyFinder: Finds a case contact with the specified alternate key.
      Finder Variables:
      • CaseNumber; string; The alternate key identifier of the case.
      • ContactPartyNumber; string; The alternate key identifier of the contact party associated with a case.
    • PrimaryKey: Finds a case contact with the specified primary key.
      Finder Variables:
      • CaseContactId; integer; The unique identifier of the case contact.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CaseContactId; integer; The unique identifier of the case contact.
    • CaseId; integer; The unique identifier of the case.
    • CaseNumber; string; The alternate key identifier of the case.
    • ContactPartyNumber; string; The alternate key identifier of the contact party.
    • CreatedBy; string; The user who created the contact for the case.
    • CreationDate; string; The date and time when the case contact was created.
    • EmailAddress; string; The email address of the contact.
    • JobTitle; string; The job title of the contact.
    • LastUpdateDate; string; The date and time when the contact for the case was last updated.
    • LastUpdatedBy; string; The user who last updated the contact for the case.
    • PartyId; integer; The unique identifier of the party.
    • PartyName; string; The name of the party.
    • PersonId; integer; The unique identifier of a person who is an employee on the case.
    • RelationshipCd; string; The code indicating the relation of the contact to the case. For example, ORA_SVC_BENEFICIARY, contact who is the beneficiary of the case, ORA_SVC_CHILD, contact who is a legal child of the applicant, ORA_SVC_DEPENDENT, contact is dependent on the applicant, ORA_SVC_GUARDIAN, contact is a legal guardian of the applicant, ORA_SVC_LAWYER, contact is an attorney by profession dealing with the case, ORA_SVC_PARENT, contact is the legal parent of the applicant, ORA_SVC_PERPETRATOR, contact who carries out a criminal, or harmful act, ORA_SVC_REFERRAL, contact who refers a service provider, ORA_SVC_REPORTER, contact who reports an incident, ORA_SVC_SERVICE_PROVIDER, contact or a business entity who is rendering specific services or benefits to the applicant, ORA_SVC_SIBLING, contact who is the legal sibling of the applicant, ORA_SVC_SPOUSE, contact who is a spouse of the applicant, or ORA_SVC_VICTIM, contact who is affected by an incident or an event,
    • RelationshipCdMeaning; string; The display value corresponding to the relationship lookup code for the case contact.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : cases-caseContacts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : cases-caseContacts-item-response
Type: object
Show Source
  • Title: Contact ID
    Read Only: true
    The unique identifier of the case contact.
  • Title: Case ID
    The unique identifier of the case.
  • Title: Case Number
    Maximum Length: 30
    The alternate key identifier of the case.
  • Title: Contact Party Number
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the contact party.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code of the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the contact for the case.
  • Title: Creation Date
    Read Only: true
    The date and time when the case contact was created.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Currency Code
    Maximum Length: 15
    The currency code associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Delete
    Read Only: true
    Indicates whether the case contact can be deleted.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the contact.
  • Title: Phone
    Read Only: true
    The phone number of the contact.
  • Title: Job Title
    Read Only: true
    Maximum Length: 100
    The job title of the contact.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the contact for the case was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the contact for the case.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the contact for the case.
  • Links
  • Title: Party ID
    The unique identifier of the party.
  • Title: Party Name
    Maximum Length: 360
    The name of the party.
  • Title: Person ID
    The unique identifier of a person who is an employee on the case.
  • Title: Primary Contact
    Read Only: true
    Indicates whether the contact is the primary contact for the case.
  • Title: Relationship Code
    Maximum Length: 30
    The code indicating the relation of the contact to the case. For example, ORA_SVC_BENEFICIARY, contact who is the beneficiary of the case, ORA_SVC_CHILD, contact who is a legal child of the applicant, ORA_SVC_DEPENDENT, contact is dependent on the applicant, ORA_SVC_GUARDIAN, contact is a legal guardian of the applicant, ORA_SVC_LAWYER, contact is an attorney by profession dealing with the case, ORA_SVC_PARENT, contact is the legal parent of the applicant, ORA_SVC_PERPETRATOR, contact who carries out a criminal, or harmful act, ORA_SVC_REFERRAL, contact who refers a service provider, ORA_SVC_REPORTER, contact who reports an incident, ORA_SVC_SERVICE_PROVIDER, contact or a business entity who is rendering specific services or benefits to the applicant, ORA_SVC_SIBLING, contact who is the legal sibling of the applicant, ORA_SVC_SPOUSE, contact who is a spouse of the applicant, or ORA_SVC_VICTIM, contact who is affected by an incident or an event,
  • Title: Relationship Value
    Maximum Length: 255
    The display value corresponding to the relationship lookup code for the case contact.
  • Title: Update
    Read Only: true
    Indicates whether the case contact can be updated.
Back to Top

Examples

The following example shows how to get all case contacts by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseContacts

Example of Response Body

The following shows an example of the response body in JSON format.

 {
    "items": [
        {
            "CaseContactId": 300100215772591,
            "CaseId": 300100215793299,
            "CorpCurrencyCode": null,
            "CreatedBy": "AUTOUICASE1",
            "CreationDate": "2021-08-23T06:29:06+00:00",
            "CurcyConvRateType": null,
            "CurrencyCode": null,
            "LastUpdateDate": "2021-08-23T06:29:06.965+00:00",
            "LastUpdateLogin": "C9E50EC5A48AEE00E05323EAF40A1FFD",
            "LastUpdatedBy": "AUTOUICASE1",
            "PartyId": 7755,
            "ContactPartyNumber": "6191",
            "RelationshipCd": null,
            "PartyName": "Fred Bramer",
            "CaseNumber": "CDRM_4003",
            "PrimaryFlag": false,
            "UpdateFlag": true,
            "DeleteFlag": true,
            "RelationshipCdMeaning": null,
            "EmailAddress": "sendmail-test-discard@oracle.com",
            "FormattedPhoneNumber": "+1 ",
            "JobTitle": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseContacts/300100215772591",
                    "name": "caseContacts",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseContacts/300100215772591",
                    "name": "caseContacts",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003",
                    "name": "cases",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseContacts/300100215772591/lov/PersonDVO",
                    "name": "PersonDVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseContacts/300100215772591/lov/ContactRelCdLookup",
                    "name": "ContactRelCdLookup",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseContacts",
            "name": "caseContacts",
            "kind": "collection"
        }
    ]
}
Back to Top