Create an interaction reference
post
/crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences
Request
Path Parameters
-
InteractionId(required): integer(int64)
The unique identifier of the interaction.
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
-
InteractionId: integer
(int64)
Title:
Interaction ID
The unique identifier of the interaction reference. -
InteractionNumber: string
Title:
Interaction Number
Maximum Length:30
The alternate key identifier for the interaction. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object associated with the interaction reference. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The code indicating the type of the object present in the interaction reference. A list of valid values is defined in the lookup ORA_SVC_IM_REF_OBJECT_TYPE_CD.
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 : interactions-interactionReferences-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the reference. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the reference was created. -
DeleteFlag: boolean
Read Only:
true
Indicates if the interaction reference can be deleted by the current user. The default value is false. -
InteractionId: integer
(int64)
Title:
Interaction ID
The unique identifier of the interaction reference. -
InteractionNumber: string
Title:
Interaction Number
Maximum Length:30
The alternate key identifier for the interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the reference was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the reference. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the reference. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object associated with the interaction reference. -
ObjectNumber: string
Title:
Reference Number
Read Only:true
Maximum Length:255
The alternate key identifier of the object associated with the interaction reference. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The code indicating the type of the object present in the interaction reference. A list of valid values is defined in the lookup ORA_SVC_IM_REF_OBJECT_TYPE_CD. -
ReferenceId: integer
(int64)
Title:
Reference ID
Read Only:true
The unique identifier used for integration with external systems. -
UpdateFlag: boolean
Read Only:
true
Indicates if the interaction reference can be updated by the current user. The default value is true if the user has access to update the interaction reference.
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
- ObjectTypeCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_IM_REF_OBJECT_TYPE_CD
The list of values indicating the object types.
The following properties are defined on the LOV link relation:- Source Attribute: ObjectTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to create an interaction reference by submitting a POST request on the REST resource.
Request Header Example
The following shows an example of the request header.
POST /crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences/
Response Header Example
The following shows an example of the response header.
HTTP/1.1 201: Created Date: Fri, 03 Mar 2017 07:54:53 GMT Server : Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourcecollection+json Content-Language: en
Request Body Example
The following shows an example of the request body in JSON format.
{ "ObjectTypeCd": "SVC_SERVICE_REQUESTS", "ObjectId": "30001233322" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ReferenceId" : 300100097921285, "InteractionId" : 300100096307925, "ObjectTypeCd" : "SVC_SERVICE_REQUESTS", "ObjectId" : 30001233322, "CreatedBy" : "SALES_ADMIN", "CreationDate" : "2017-03-10T00:31:09-08:00", "LastUpdatedBy" : "SALES_ADMIN", "LastUpdateDate" : "2017-03-10T00:31:09-08:00", "LastUpdateLogin" : "4A49E601416B05A8E05307B3F20A1B38", "UpdateFlag" : "true", "DeleteFlag" : "true", "links" : [ { "rel" : "self", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences/300100097921285", "name" : "interactionReferences", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences/300100097921285", "name" : "interactionReferences", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925", "name" : "interactions", "kind" : "item" } ] }