Jump to

• Request
• Response
• Examples

Create activity from template

post

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/action/createActivitiesFromTemplate

This method lets you create activities from a template.

Request

Path Parameters

• SrNumber(required): string
  The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• accountId: number
  The unique identifier of the account.
• activityStartDate: string (date-time)
  This is used to denote the activity start date in the activity from template.
• appointmentStatus: string
  The appointment status field in the custom activity from template.
• assigneeId: number
  The unique identifier of the assignee.
• contactId: number
  The unique identifier of the contact.
• customObjectId: number
  The unique identifier of the custom object.
• leadId: number
  The unique identifier of the lead.
• opptyId: number
  The unique identifier of the opportunity.
• orchestrationId: number
  The unique identifier of the orchestration.
• orchestrationStepId: number
  The unique identifier of the orchestration step.
• ownerId: number
  The unique identifier of the owner.
• smartActionContext: string
  This is used to store the metadata content for the smart action in custom activity from template.
• smartActionId: number
  The unique identifier of the smart action.
• templateId: number
  The unique identifier of the template.

{
    "type":"object",
    "properties":{
        "activityStartDate":{
            "type":"string",
            "description":"This is used to denote the activity start date in the activity from template.",
            "format":"date-time",
            "nullable":true
        },
        "customObjectId":{
            "type":"number",
            "description":"The unique identifier of the custom object.",
            "nullable":true
        },
        "contactId":{
            "type":"number",
            "description":"The unique identifier of the contact.",
            "nullable":true
        },
        "appointmentStatus":{
            "type":"string",
            "description":"The appointment status field in the custom activity from template.",
            "nullable":true
        },
        "templateId":{
            "type":"number",
            "description":"The unique identifier of the template.",
            "nullable":true
        },
        "ownerId":{
            "type":"number",
            "description":"The unique identifier of the owner.",
            "nullable":true
        },
        "assigneeId":{
            "type":"number",
            "description":"The unique identifier of the assignee.",
            "nullable":true
        },
        "accountId":{
            "type":"number",
            "description":"The unique identifier of the account.",
            "nullable":true
        },
        "orchestrationId":{
            "type":"number",
            "description":"The unique identifier of the orchestration.",
            "nullable":true
        },
        "orchestrationStepId":{
            "type":"number",
            "description":"The unique identifier of the orchestration step.",
            "nullable":true
        },
        "smartActionId":{
            "type":"number",
            "description":"The unique identifier of the smart action.",
            "nullable":true
        },
        "smartActionContext":{
            "type":"string",
            "description":"This is used to store the metadata content for the smart action in custom activity from template.",
            "nullable":true
        },
        "opptyId":{
            "type":"number",
            "description":"The unique identifier of the opportunity.",
            "nullable":true
        },
        "leadId":{
            "type":"number",
            "description":"The unique identifier of the lead.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): array result
  Returns activities created from a template.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"array",
            "description":"Returns activities created from a template.",
            "items":{
                "type":"number"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: array

Returns activities created from a template.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Returns activities created from a template.",
    "items":{
        "type":"number"
    }
}

Back to Top

Examples

The following example shows how to create an activity from template by submitting a POST request on the REST resource.

cURL Command

curl -u <username:password> \
 -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000000007/child/activities/action/createActivitiesFromTemplate  \
 -H 'Content-Type: application/vnd.oracle.adf.action+json'  | json_pp

Example of Request Body

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

{
    "templateId": "300100562365305",
    "orchestrationId": "300100550933508"
}

Example of Response Body

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

{
    "result": [
        "300100562364452",
        "300100562364456"
    ]
}

Back to Top