Jump to

• Request
• Response
• Examples

Update an interaction reference

patch

/crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences/{interactions_interactionReferences_Id}

Request

Path Parameters

• InteractionId(required): integer(int64)
  The unique identifier of the interaction.
• interactions_interactionReferences_Id(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the interaction reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : interactions-interactionReferences-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the reference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction reference can be deleted by the current user. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the interaction.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the reference was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the interaction reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectNumber":{
            "title":"Reference Number",
            "maxLength":255,
            "type":"string",
            "description":"The alternate key identifier of the object associated with the interaction reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier used for integration with external systems.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ObjectTypeCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

Back to Top

Examples

The following example shows how to update an interaction reference by submitting a PATCH request on the REST resource.

Request Header Example

The following shows an example of the request header.

PATCH /crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences/300100097921285

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200: OK
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_CHATS"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
  "ReferenceId" : 300100097921285,
  "InteractionId" : 300100096307925,
  "ObjectTypeCd" : "SVC_CHATS",
  "ObjectId" : 30001233322,
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2017-03-10T00:31:09-08:00",
  "LastUpdatedBy" : "SALES_ADMIN",
  "LastUpdateDate" : "2017-03-10T00:39:47-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" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
    }
  }, {
    "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"
  } ]
}

Back to Top