Update a case contact
patch
/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseContacts/{CaseContactId}
Request
Path Parameters
-
CaseContactId(required): integer(int64)
The unique identifier of the case contact.
-
CaseNumber(required): string
The alternate key identifier of the case.
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CorpCurrencyCode: string
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. -
CurcyConvRateType: string
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. -
CurrencyCode: string
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. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the party. -
PartyName: string
Title:
Party Name
Maximum Length:360
The name of the party. -
PersonId: integer
(int64)
Title:
Person ID
The unique identifier of a person who is an employee on the case. -
RelationshipCd: string
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, -
RelationshipCdMeaning: string
Title:
Relationship Value
Maximum Length:255
The display value corresponding to the relationship lookup code for the case contact.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : cases-caseContacts-item-response
Type:
Show Source
object
-
CaseContactId: integer
(int64)
Title:
Contact ID
Read Only:true
The unique identifier of the case contact. -
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
CaseNumber: string
Title:
Case Number
Maximum Length:30
The alternate key identifier of the case. -
ContactPartyNumber: string
Title:
Contact Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the contact party. -
CorpCurrencyCode: string
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the contact for the case. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the case contact was created. -
CurcyConvRateType: string
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. -
CurrencyCode: string
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. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the case contact can be deleted. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the contact. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the contact. -
JobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The job title of the contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the contact for the case was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the contact for the case. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the contact for the case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the party. -
PartyName: string
Title:
Party Name
Maximum Length:360
The name of the party. -
PersonId: integer
(int64)
Title:
Person ID
The unique identifier of a person who is an employee on the case. -
PrimaryFlag: boolean
Title:
Primary Contact
Read Only:true
Indicates whether the contact is the primary contact for the case. -
RelationshipCd: string
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, -
RelationshipCdMeaning: string
Title:
Relationship Value
Maximum Length:255
The display value corresponding to the relationship lookup code for the case contact. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the case contact can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ContactRelCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_CONTACT_REL_CD
The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing. - finder:
- PersonDVO
-
Operation: /crmRestApi/resources/11.13.18.05/contactsAn object that includes attributes used to store values while creating or updating a contact. A contact is a person who either has a relationship to other objects like contact and household or is a standalone customer or prospect. This object is an aggregation of person profile, contact information, and references a single primary address
Examples
The following example shows how to update a case contact by submitting a patch request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseContacts/{CaseContactId}
Example of Request Body
The following shows an example of the request body in JSON format.
Example of Response Body
The following shows an example of the response body in JSON format.