1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Activity Templates

Update an activity template

patch

/crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}

Request

Path Parameters
  • 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
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Activities
Type: array
Title: Activities
Activity
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    Indicates the binding type of the value.
  • Title: Mandatory
    Maximum Length: 1
    Boolean value indicating if the payload is mandatory.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The key in the Key Value pair that forms the payload.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean value.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value in the Key Value pair that forms the payload.
  • Title: Payload Value Structure
    Maximum Length: 20
    If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : schema
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Title: URL Binding Parameter Name
    Maximum Length: 50
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 80
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : activityTemplates-item-response
Type: object
Show Source
Nested Schema : Activities
Type: array
Title: Activities
Activity
Show Source
Nested Schema : activityTemplates-Activity-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : activityTemplates-Activity-Attachments-item-response
Type: object
Show Source
Nested Schema : activityTemplates-Activity-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : activityTemplates-Activity-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : activityTemplates-Activity-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : activityTemplates-Activity-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 50
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 80
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Links
Activity
Parameters:
  • TemplateId: $request.path.TemplateId
Activity
YesNoLookup
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The following properties are defined on the LOV link relation:
  • Source Attribute: ActiveFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
Back to Top

Examples

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

cURL Command

curl -u <username:password> \
 -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplate/300100562364349  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
    "TemplateName": "Vision Peace Power",
    "TemplateDescription": "Aims for the ultimate peace."
}

Example of Response Body

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

{
    "TemplateId": 300100562365305,
    "TemplateName": "Vision Peace Power",
    "TemplateDescription": "Aims for the ultimate peace.",
    "SourceObjectCode": "LEAD",
    "SubTypeCode": null,
    "SetId": 0,
    "ActiveFlag": true,
    "CreatedBy": "SALES_ADMIN",
    "CreationDate": "2022-08-18T08:36:58+00:00",
    "LastUpdateDate": "2022-08-18T08:38:35+00:00",
    "LastUpdateLogin": "E58B1AF5AD890A25E05315C5F20A42C4",
    "LastUpdatedBy": "SALES_ADMIN",
    "ObjectVersionNumber": 2,
    "UserLastUpdateDate": null,
    "TemplateFlag": "Y",
    "OrchestrationId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100562365305",
            "name": "activityTemplates",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100562365305",
            "name": "activityTemplates",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100562365305/child/Activity",
            "name": "Activity",
            "kind": "collection"
        }
    ]
}
Back to Top