Create a source system reference
post
/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Attribute1: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 1. -
Attribute10: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 10. -
Attribute11: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 11. -
Attribute12: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 12. -
Attribute13: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 13. -
Attribute14: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 14. -
Attribute15: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 15. -
Attribute16: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 16. -
Attribute17: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 17. -
Attribute18: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 18. -
Attribute19: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 19. -
Attribute2: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 2. -
Attribute20: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 20. -
Attribute21: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 21. -
Attribute22: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 22. -
Attribute23: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 23. -
Attribute24: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 24. -
Attribute25: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 25. -
Attribute26: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 26. -
Attribute27: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 27. -
Attribute28: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 28. -
Attribute29: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 29. -
Attribute3: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 3. -
Attribute30: string
Maximum Length:
255
Stores the value in the column for the flexfield mapped to character column 30. -
Attribute4: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 4. -
Attribute5: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 5. -
Attribute6: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 6. -
Attribute7: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 7. -
Attribute8: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 8. -
Attribute9: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 9. -
AttributeCategory: string
Maximum Length:
30
The attribute stores the category value for a group of flexfields. -
AttributeDate1: string
(date)
Stores the value in the column for the flexfield mapped to date column 1.
-
AttributeDate10: string
(date)
Stores the value in the column for the flexfield mapped to date column 10.
-
AttributeDate11: string
(date)
Stores the value in the column for the flexfield mapped to date column 11.
-
AttributeDate12: string
(date)
Stores the value in the column for the flexfield mapped to date column 12.
-
AttributeDate2: string
(date)
Stores the value in the column for the flexfield mapped to date column 2.
-
AttributeDate3: string
(date)
Stores the value in the column for the flexfield mapped to date column 3.
-
AttributeDate4: string
(date)
Stores the value in the column for the flexfield mapped to date column 4.
-
AttributeDate5: string
(date)
Stores the value in the column for the flexfield mapped to date column 5.
-
AttributeDate6: string
(date)
Stores the value in the column for the flexfield mapped to date column 6.
-
AttributeDate7: string
(date)
Stores the value in the column for the flexfield mapped to date column 7.
-
AttributeDate8: string
(date)
Stores the value in the column for the flexfield mapped to date column 8.
-
AttributeDate9: string
(date)
Stores the value in the column for the flexfield mapped to date column 9.
-
AttributeNumber1: number
Stores the value in the column for the flexfield mapped to number column 1.
-
AttributeNumber10: number
Stores the value in the column for the flexfield mapped to number column 10.
-
AttributeNumber11: number
Stores the value in the column for the flexfield mapped to number column 11.
-
AttributeNumber12: number
Stores the value in the column for the flexfield mapped to number column 12.
-
AttributeNumber2: number
Stores the value in the column for the flexfield mapped to number column 2.
-
AttributeNumber3: number
Stores the value in the column for the flexfield mapped to number column 3.
-
AttributeNumber4: number
Stores the value in the column for the flexfield mapped to number column 4.
-
AttributeNumber5: number
Stores the value in the column for the flexfield mapped to number column 5.
-
AttributeNumber6: number
Stores the value in the column for the flexfield mapped to number column 6.
-
AttributeNumber7: number
Stores the value in the column for the flexfield mapped to number column 7.
-
AttributeNumber8: number
Stores the value in the column for the flexfield mapped to number column 8.
-
AttributeNumber9: number
Stores the value in the column for the flexfield mapped to number column 9.
-
CreatedByModule: string
Maximum Length:
30
Default Value:ORA_ZCH_WS
The module that created the source system reference. -
EndDateActive: string
(date)
The end date of the source system reference. This cannot be a past date.
-
ExistingSourceSystem: string
The referenced source system that already exists in the OSR base table. Can be provided in case of insert.
-
ExistingSourceSystemReferenceValue: string
The referenced source system reference that already exists in the OSR base table. It can be provided in case of insert. The existing source system and existing source system reference are used to identify the fusion identifier for which new source system reference is to be created.
-
OwnerEntityId: integer
(int64)
The fusion identifier for a record in owner entity object for which new source system, source system reference are associated. It can be provided in case of insert.
-
OwnerEntityObject: string
Maximum Length:
30
The TCA entity that holds the fusion identifier, for which new source system, source system reference are associated. Valid values are lookup-code of lookup type ORA_ZCH_OWNER_ENTITY_OBJECT. -
ReasonCode: string
Maximum Length:
30
This is validated against the MOSR_REASON lookup type. -
SourceSystem: string
Title:
Source System
Maximum Length:30
The source system name. Provide it in case of insert. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system id for the source system logical entity. Provide it in case of insert. -
StartDateActive: string
(date)
The start date of the source system reference. This cannot be a future date.
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 : hubSourceSystemReferences-item-response
Type:
Show Source
object
-
Attribute1: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 1. -
Attribute10: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 10. -
Attribute11: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 11. -
Attribute12: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 12. -
Attribute13: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 13. -
Attribute14: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 14. -
Attribute15: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 15. -
Attribute16: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 16. -
Attribute17: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 17. -
Attribute18: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 18. -
Attribute19: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 19. -
Attribute2: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 2. -
Attribute20: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 20. -
Attribute21: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 21. -
Attribute22: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 22. -
Attribute23: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 23. -
Attribute24: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 24. -
Attribute25: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 25. -
Attribute26: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 26. -
Attribute27: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 27. -
Attribute28: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 28. -
Attribute29: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 29. -
Attribute3: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 3. -
Attribute30: string
Maximum Length:
255
Stores the value in the column for the flexfield mapped to character column 30. -
Attribute4: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 4. -
Attribute5: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 5. -
Attribute6: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 6. -
Attribute7: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 7. -
Attribute8: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 8. -
Attribute9: string
Maximum Length:
150
Stores the value in the column for the flexfield mapped to character column 9. -
AttributeCategory: string
Maximum Length:
30
The attribute stores the category value for a group of flexfields. -
AttributeDate1: string
(date)
Stores the value in the column for the flexfield mapped to date column 1.
-
AttributeDate10: string
(date)
Stores the value in the column for the flexfield mapped to date column 10.
-
AttributeDate11: string
(date)
Stores the value in the column for the flexfield mapped to date column 11.
-
AttributeDate12: string
(date)
Stores the value in the column for the flexfield mapped to date column 12.
-
AttributeDate2: string
(date)
Stores the value in the column for the flexfield mapped to date column 2.
-
AttributeDate3: string
(date)
Stores the value in the column for the flexfield mapped to date column 3.
-
AttributeDate4: string
(date)
Stores the value in the column for the flexfield mapped to date column 4.
-
AttributeDate5: string
(date)
Stores the value in the column for the flexfield mapped to date column 5.
-
AttributeDate6: string
(date)
Stores the value in the column for the flexfield mapped to date column 6.
-
AttributeDate7: string
(date)
Stores the value in the column for the flexfield mapped to date column 7.
-
AttributeDate8: string
(date)
Stores the value in the column for the flexfield mapped to date column 8.
-
AttributeDate9: string
(date)
Stores the value in the column for the flexfield mapped to date column 9.
-
AttributeNumber1: number
Stores the value in the column for the flexfield mapped to number column 1.
-
AttributeNumber10: number
Stores the value in the column for the flexfield mapped to number column 10.
-
AttributeNumber11: number
Stores the value in the column for the flexfield mapped to number column 11.
-
AttributeNumber12: number
Stores the value in the column for the flexfield mapped to number column 12.
-
AttributeNumber2: number
Stores the value in the column for the flexfield mapped to number column 2.
-
AttributeNumber3: number
Stores the value in the column for the flexfield mapped to number column 3.
-
AttributeNumber4: number
Stores the value in the column for the flexfield mapped to number column 4.
-
AttributeNumber5: number
Stores the value in the column for the flexfield mapped to number column 5.
-
AttributeNumber6: number
Stores the value in the column for the flexfield mapped to number column 6.
-
AttributeNumber7: number
Stores the value in the column for the flexfield mapped to number column 7.
-
AttributeNumber8: number
Stores the value in the column for the flexfield mapped to number column 8.
-
AttributeNumber9: number
Stores the value in the column for the flexfield mapped to number column 9.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreatedByModule: string
Maximum Length:
30
Default Value:ORA_ZCH_WS
The module that created the source system reference. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
EndDateActive: string
(date)
The end date of the source system reference. This cannot be a past date.
-
ExistingSourceSystem: string
The referenced source system that already exists in the OSR base table. Can be provided in case of insert.
-
ExistingSourceSystemReferenceValue: string
The referenced source system reference that already exists in the OSR base table. It can be provided in case of insert. The existing source system and existing source system reference are used to identify the fusion identifier for which new source system reference is to be created.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerEntityId: integer
(int64)
The fusion identifier for a record in owner entity object for which new source system, source system reference are associated. It can be provided in case of insert.
-
OwnerEntityObject: string
Maximum Length:
30
The TCA entity that holds the fusion identifier, for which new source system, source system reference are associated. Valid values are lookup-code of lookup type ORA_ZCH_OWNER_ENTITY_OBJECT. -
ReasonCode: string
Maximum Length:
30
This is validated against the MOSR_REASON lookup type. -
SourceSystem: string
Title:
Source System
Maximum Length:30
The source system name. Provide it in case of insert. -
SourceSystemReferenceId: integer
(int64)
Read Only:
true
The sequentially generated primary key. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system id for the source system logical entity. Provide it in case of insert. -
StartDateActive: string
(date)
The start date of the source system reference. This cannot be a future date.
-
Status: string
Read Only:
true
Maximum Length:1
Default Value:A
The status of the source system reference. Valid values are Active - 'A' and Inactive - 'I'.
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
- LookupPVO
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ZCH_OWNER_ENTITY_OBJECT
The following properties are defined on the LOV link relation:- Source Attribute: OwnerEntityObject; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
Examples
The following example shows how to create a source system reference by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -user sales_cloud_user -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/
Example of Request Body
The following shows the contents of the request body in JSON format.
{ "SourceSystem": "HCM_Data", "SourceSystemReferenceValue": "3524", "Status": "A" }
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "SourceSystemReferenceId": 15425, "SourceSystem": "HCM_Data", "SourceSystemReferenceValue": "3524", "OwnerEntityObject": "ALL_SITES", "OwnerEntityId": 1394, "ExistingSourceSystem": null, "ExistingSourceSystemReferenceValue": null, "StartDateActive": "2004-02-23", "EndDateActive": "4712-12-31", "Status": "A", "ReasonCode": null, "CreatedBy": "2045", "CreationDate": "1999-10-06T03:54:14+00:00", "LastUpdatedBy": "2045", "LastUpdateDate": "1999-10-06T03:54:14+00:00", "LastUpdateLogin": "357171", "CreatedByModule": "TCA", "AttributeCategory": null, "Attribute1": null, ... "AttributeDate1": null, "AttributeDate2": null, "AttributeDate3": null, "AttributeDate4": null, "AttributeDate5": null, "AttributeDate6": null, "AttributeDate7": null, "AttributeDate8": null, "AttributeDate9": null, "AttributeDate10": null, "AttributeDate11": null, "AttributeDate12": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/15425", "name": "hubSourceSystemReferences", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A61766176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/15425", "name": "hubSourceSystemReferences", "kind": "item" } ] }, ... }