Update a source system reference
patch
/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Request
Path Parameters
-
PartyNumber(required): string
The alternate key identifier for the contact party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task.
-
SourceSystemReferenceId(required): integer(int64)
The unique identifier of the source system reference.
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
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
EndDate: string
(date)
The date after which the record is inactive.
-
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is comparedat the start and end of a transaction to determine whether another session has updated the row.
-
PartyId: integer
(int64)
The unique identifier of the associated contact.
-
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the associated contact. -
PartySourceSystem: string
Title:
Party Source System
The source system name for the contact. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier for the record from an external source system. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system reference value required to identify the associated contact. -
Status: string
Maximum Length:
1
Default Value:A
Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : contacts-SourceSystemReference-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EndDate: string
(date)
The date after which the record is inactive.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is comparedat the start and end of a transaction to determine whether another session has updated the row.
-
PartyId: integer
(int64)
The unique identifier of the associated contact.
-
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the associated contact. -
PartySourceSystem: string
Title:
Party Source System
The source system name for the contact. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier for the record from an external source system. -
SourceSystem: string
Title:
Source System
Maximum Length:30
The name of the source system. -
SourceSystemReferenceId: integer
(int64)
Read Only:
true
The unique identifier of the source system reference. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system reference value required to identify the associated contact. -
StartDate: string
(date)
The date when the record was created.
-
Status: string
Maximum Length:
1
Default Value:A
Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.
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.