Update a contact
patch
/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts/{MemberId}
Request
Path Parameters
-
MemberId(required): integer(int64)
The unique identifier of the contact.
-
SrNumber(required): string
The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
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
-
AccessLevelCd: string
Title:
Access Level
Maximum Length:30
The service request access level granted to the contact. -
ContactPartyName: string
Title:
Name
Maximum Length:360
The name of a service request contact. -
ContactTypeCd: string
Title:
Contact Type
Maximum Length:30
The service request contact type such as Customer or Partner. -
ContactUniqueName: string
Title:
Unique Name
Maximum Length:900
The unique party name associated with the contact. -
MemberId: integer
(int64)
Title:
Member ID
The unique identifier of the contact. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the contact. -
PersonId: integer
(int64)
Title:
Person ID
The unique identification of a person that is a contact on a service request.This is only used for human resource help desk service request. -
PrimaryContactFlag: boolean
Title:
Primary
Indicates if the contact is the primary contact for the service request. If yes, the value is True, else the value is False. The default value is false. -
RelationTypeCd: string
Title:
Relationship Type Code
Maximum Length:30
The code indicating the type of relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.
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 : serviceRequests-contacts-item-response
Type:
Show Source
object
-
AccessLevelCd: string
Title:
Access Level
Maximum Length:30
The service request access level granted to the contact. -
AccountName: string
Title:
Account Name
Read Only:true
Maximum Length:900
The primary account of the service request contact. -
ContactEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the party associated with the contact. -
ContactFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the party associated with the contact. -
ContactPartyName: string
Title:
Name
Maximum Length:360
The name of a service request contact. -
ContactPartyNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The public unique identifier of the contact associated with the service request. -
ContactPreferredContactMethod: string
Title:
Preferred Contact Method
Read Only:true
Maximum Length:30
The preferred contact method of the party associated with the contact. -
ContactTypeCd: string
Title:
Contact Type
Maximum Length:30
The service request contact type such as Customer or Partner. -
ContactUniqueName: string
Title:
Unique Name
Maximum Length:900
The unique party name associated with the contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the contact has been deleted. -
DoNotContactFlag: boolean
Title:
Do Not Contact
Read Only:true
Maximum Length:1
Indicates whether the contact of the service request does not want to be contacted. The default value is false. -
FormattedAddress: string
Title:
Formatted Address
Read Only:true
The formatted address of the service request contact. -
JobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The job title of the service request contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The application login id of the user who last updated the contacts object associated with the service request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberId: integer
(int64)
Title:
Member ID
The unique identifier of the contact. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the contact. -
PersonId: integer
(int64)
Title:
Person ID
The unique identification of a person that is a contact on a service request.This is only used for human resource help desk service request. -
PrimaryContactFlag: boolean
Title:
Primary
Indicates if the contact is the primary contact for the service request. If yes, the value is True, else the value is False. The default value is false. -
RelationTypeCd: string
Title:
Relationship Type Code
Maximum Length:30
The code indicating the type of relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the associated service request. -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The public unique number of the a service request. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the contact has been 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
- AccessLevelLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_ACCESS_LEVEL
The list of values for the access level of the service request contact. - finder:
- ContactTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_CONTACT_TYPE
The list of values indicating the service request contact type such as Partner or Customer. - finder:
- PersonDVO
-
Operation: /crmRestApi/resources/11.13.18.05/contactsThe list of values for the contact party name.
- RelationshipTypeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_CONTACT_REL_TYPE_CD
The list of values for the service request contact relation type such as Alternate, Follower, Third_Party, and so on. - finder:
Examples
The following example shows how to update a contact by submitting a PATCH request on the REST resource.
Example of Request Header
The following shows an example of the request header.
PATCH /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001/child/contacts/300100090124783 HTTP/1.1 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "PartyId":" 300100075388631" }
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200: OK Date: Mon, 15 Nov 2016 10:11:57 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "MemberId": 300100090124783, "SrId": 300100089812740, "PartyId": 300100075388631, "RelationTypeCd": null, "ContactUniqueName": "autouislr1 svc", "ContactFormattedPhoneNumber": null, "ContactEmailAddress": "autouislr1@oracle.com", "ContactPreferredContactMethod": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2016-10-18T07:42:37-07:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateDate": "2016-11-15T02:10:00-08:00", "LastUpdateLogin": "41438BCB97E343F5E0535CC0F20AC895", "PrimaryContactFlag": false, "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001/child/contacts/300100090124783", "name": "contacts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } } , { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001/child/contacts/300100090124783", "name": "contacts", "kind": "item" } , { "rel": "parent", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001", "name": "serviceRequests", "kind": "item" } , { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001/child/contacts/300100090124783/lov/PersonDVO", "name": "PersonDVO", "kind": "collection" } , { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001/child/contacts/300100090124783/lov/RelationshipTypeLookup", "name": "RelationshipTypeLookup", "kind": "collection" } ], }