Create an activity

post

/crmRestApi/resources/11.13.18.05/activities

Request

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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Activity Assignees
Type: array
Title: Activity Assignees
The activity assignees resource is used to view, create, update, and delete the internal resources assigned to an activity.
Show Source
Nested Schema : Activity Contacts
Type: array
Title: Activity Contacts
The activity contacts resource is used to view, create, update, and delete the contacts associated with an activity.
Show Source
Nested Schema : Activity Objectives
Type: array
Title: Activity Objectives
The activity objectives resource is used to view, create, update, and delete the objective of an activity.
Show Source
Nested Schema : Activity Attachments
Type: array
Title: Activity Attachments
The activity attachments resource is used to view, create, update, and delete attachments of an activity. An attachment includes additional information about an activity.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The note resource is used to view, create, update, and delete notes associated with an activity. A note captures comments, information, or instructions related to an activity.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : activities-ActivityAssignee-item-post-request
Type: object
Show Source
Nested Schema : activities-ActivityContact-item-post-request
Type: object
Show Source
Nested Schema : activities-ActivityObjectives-item-post-request
Type: object
Show Source
  • Title: Activity ID
    The unique identifier of the parent activity.
  • Maximum Length: 64
    The unique number of the activity. The number can also be generated from an external source.
  • Maximum Length: 255
    The objective for the activity.
  • Title: Activity Number
    Maximum Length: 64
    The unique number of the activity. The number can also be generated from an external source.
  • Maximum Length: 30
    The attribute category associated with the activity.
  • Title: Complete
    Maximum Length: 1
    Indicates if the activity objective is completed. If True, the activity is completed.
  • Default Value: 0
    The unique identifier for the conflict in the activity objectives.
  • Maximum Length: 15
    The corporate currency code associated with the activity contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Maximum Length: 30
    The currency conversion rate type associated with the activity contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Maximum Length: 15
    The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Objective
    Maximum Length: 30
    The code indicating the objectives of an activity. A list of valid values is defined in the lookup ORA_ZMM_ACTIVITY_OBJECTIVE.
  • Title: Objective Text
    Maximum Length: 80
    The text area to describe the objective of the activity.
  • Title: Objective ID
    The unique identifier of the objective.
  • The unique identifier for the series that links instances of a series together.
Nested Schema : activities-Attachments-item-post-request
Type: object
Show Source
Nested Schema : activities-Note-item-post-request
Type: object
Show Source
  • Title: Contact Relationship ID
    The unique identifier of the relationship populated when the note is associated with a contact.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Creator Party ID
    The unique identifier of the person who created the note.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Currency
    Maximum Length: 15
    The currency code. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Maximum Length: 30
    The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    The column to store the note text.
  • Title: Type
    Maximum Length: 30
    The code indicating the type of the note. This value is used for categorization of the note. A list of valid values is defined in the lookup ZMM_NOTE_TYPE_CD.
  • Title: Parent Note ID
    The unique identifier of the parent note.
  • Title: Related Object Type
    Maximum Length: 30
    The source object code for the source object as defined in the objects metadata.
  • Title: Related Object
    Maximum Length: 64
    The unique identifier of the source object such as activities, opportunities, as defined in the objects metadata.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    The code indicating the visibility level of the note, such as internal, external, or private.
Nested Schema : activities-smartActions-item-post-request
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 : activities-smartActions-UserActionNavigation-item-post-request
Type: object
Show Source
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : activities-smartActions-UserActionRequestPayload-item-post-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : activities-smartActions-UserActionURLBinding-item-post-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 50
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 80
    The value assigned to the value property of a name-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 : activities-item-response
Type: object
Show Source
Nested Schema : Activity Assignees
Type: array
Title: Activity Assignees
The activity assignees resource is used to view, create, update, and delete the internal resources assigned to an activity.
Show Source
Nested Schema : Activity Contacts
Type: array
Title: Activity Contacts
The activity contacts resource is used to view, create, update, and delete the contacts associated with an activity.
Show Source
Nested Schema : Activity Objectives
Type: array
Title: Activity Objectives
The activity objectives resource is used to view, create, update, and delete the objective of an activity.
Show Source
Nested Schema : Activity Attachments
Type: array
Title: Activity Attachments
The activity attachments resource is used to view, create, update, and delete attachments of an activity. An attachment includes additional information about an activity.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The note resource is used to view, create, update, and delete notes associated with an activity. A note captures comments, information, or instructions related to an activity.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : activities-ActivityAssignee-item-response
Type: object
Show Source
Nested Schema : activities-ActivityContact-item-response
Type: object
Show Source
Nested Schema : activities-ActivityObjectives-item-response
Type: object
Show Source
  • Title: Activity ID
    The unique identifier of the parent activity.
  • Maximum Length: 64
    The unique number of the activity. The number can also be generated from an external source.
  • Maximum Length: 255
    The objective for the activity.
  • Title: Activity Number
    Maximum Length: 64
    The unique number of the activity. The number can also be generated from an external source.
  • Maximum Length: 30
    The attribute category associated with the activity.
  • Title: Complete
    Maximum Length: 1
    Indicates if the activity objective is completed. If True, the activity is completed.
  • Default Value: 0
    The unique identifier for the conflict in the activity objectives.
  • Maximum Length: 15
    The corporate currency code associated with the activity contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Read Only: true
    Maximum Length: 64
    The user who created the activity objective.
  • Read Only: true
    The date and time when the activity objective was created.
  • Maximum Length: 30
    The currency conversion rate type associated with the activity contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Maximum Length: 15
    The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Read Only: true
    The date and time when the activity objective was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the activity objective.
  • Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the activity objective.
  • Links
  • Title: Objective
    Maximum Length: 30
    The code indicating the objectives of an activity. A list of valid values is defined in the lookup ORA_ZMM_ACTIVITY_OBJECTIVE.
  • Title: Objective Text
    Maximum Length: 80
    The text area to describe the objective of the activity.
  • Title: Objective ID
    The unique identifier of the objective.
  • The unique identifier for the series that links instances of a series together.
Nested Schema : activities-Attachments-item-response
Type: object
Show Source
Nested Schema : activities-Note-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    The unique identifier of the relationship populated when the note is associated with a contact.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the row.
  • Title: Creation Date
    Read Only: true
    The date and time when the note was created.
  • Title: Creator Party ID
    The unique identifier of the person who created the note.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Currency
    Maximum Length: 15
    The currency code. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Delete Indicator
    Read Only: true
    Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N.
  • Title: Primary Email
    Read Only: true
    Maximum Length: 320
    The email address of the user who created the note.
  • Title: Primary Address
    Read Only: true
    The address of the user who created the note.
  • Title: Primary Phone
    Read Only: true
    The phone number of the user who created the note.
  • Title: Last Update Date
    Read Only: true
    The date and time of when the note was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Note ID
    Read Only: true
    The unique identifier of a note.
  • Maximum Length: 30
    The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    The column to store the note text.
  • Title: Type
    Maximum Length: 30
    The code indicating the type of the note. This value is used for categorization of the note. A list of valid values is defined in the lookup ZMM_NOTE_TYPE_CD.
  • Title: Parent Note ID
    The unique identifier of the parent note.
  • Title: Party ID
    Read Only: true
    The unique identifier of the party associated with the note.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    The name of the author of the note.
  • Title: Related Object Type
    Maximum Length: 30
    The source object code for the source object as defined in the objects metadata.
  • Title: Related Object
    Maximum Length: 64
    The unique identifier of the source object such as activities, opportunities, as defined in the objects metadata.
  • Title: Update Indicator
    Read Only: true
    Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    The code indicating the visibility level of the note, such as internal, external, or private.
Nested Schema : activities-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 150
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Boolean type indicating if this action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function associated with the smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique identifier of the smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : activities-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : activities-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : activities-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 50
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 80
    The value assigned to the value property of a name-value pair.
Back to Top

Examples

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

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/

Example of Request Body

The following shows an example of the request body.

{                                                                                                          
   "ActivityFunctionCode" : "APPOINTMENT",
    "ActivityStartDate" : "2014-05-26T13:00:00+07:00",
    "ActivityEndDate" : "2014-05-26T14:00:00+07:00",
    "Subject" : "ATAP_REST_TASK_TEST004_Appt1"
}

Example of Response Body

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

{
  "ActivityId" : 300100091331612,
  "ActivityNumber" : "CDRM_167288",
  "AccountId" : null,
  "ActivityCreatedBy" : "SALES_ADMIN",
  "ActivityCreationDate" : "2016-08-24T01:24:42-07:00",
  "ActivityPartialDescription" : null,
  "ActivityEndDate" : "2014-05-26T00:00:00-07:00",
  "RecordSet" : null,
  "ShowStatus" : null,
  "Subject" : "ATAP_REST_TASK_TEST004_Appt1",
  "ActivityFunctionCodeTrans" : null,
  "ActivityFunctionCode" : "APPOINTMENT",
  "ActivityLastUpdateLogin" : "3ACD2BA10C14B0DEE053780CF10A305B",
  "ActivityStartDate" : "2014-05-25T23:00:00-07:00",
  "ActivityTypeCode" : "MEETING",
  "ActivityUpdateDate" : "2016-08-24T01:24:42-07:00",
  "ActivityUpdatedBy" : "SALES_ADMIN",
  "ActivityUserLastUpdateDate" : null,
  "AllDayFlag" : null,
  "AssessmentId" : null,
  "AutoLogSource" : null,
  "BuOrgId" : null,
  "CampaignId" : null,
  "ConflictId" : 0,
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2016-08-24T01:24:42-07:00",
  "CustomerAccountId" : null,
  "DirectionCode" : null,
  "DueDate" : null,
  "Duration" : 3600000,
  "LastUpdateDate" : "2016-08-24T01:24:42-07:00",
  "LastUpdateLogin" : "3ACD2BA10C14B0DEE053780CF10A305B",
  "LastUpdatedBy" : "SALES_ADMIN",
  "LeadId" : null,
  "Location" : null,
  "MobileActivityCode" : null,
  "OpportunityId" : null,
  "OtherPartyPhoneNumber" : null,
  "OutcomeCode" : null,
  "OutlookFlag" : false,
  "OutlookIdentifier" : null,
  "OwnerId" : 100010025532672,
  "ParentActivityId" : null,
  "PartnerUsageFlag" : false,
  "PercentageComplete" : 0,
  "PrimaryContactId" : null,
  "PriorityCode" : null,
  "RecurDay" : null,
  "RecurEndDate" : null,
  "RecurEveryOptionFlag" : null,
  "RecurExceptionFlag" : null,
  "RecurFrequency" : null,
  "RecurFriFlag" : null,
  "RecurMonFlag" : null,
  "RecurMonth" : null,
  "RecurNumberOfInstances" : null,
  "RecurOrigInstDate" : null,
  "RecurPattern" : null,
  "RecurRecType" : "N",
  "RecurSatFlag" : null,
  "RecurSeriesId" : null,
  "RecurSunFlag" : null,
  "RecurThuFlag" : null,
  "RecurTueFlag" : null,
  "RecurTypeCode" : null,
  "RecurUpdatedAttributes" : null,
  "RecurWedFlag" : null,
  "RecurWeekday" : null,
  "ReferenceCustomerActTypeCode" : null,
  "ReferenceCustomerId" : null,
  "SortDate" : "2014-05-25T23:00:00-07:00",
  "StatusCode" : null,
  "SwitchCallId" : null,
  "TemplateDuration" : null,
  "TemplateFlag" : "N",
  "TemplateId" : null,
  "TemplateLeadTime" : null,
  "NotesLinkSourceCodeTransient" : "ACTIVITY",
  "AttachmentEntityName" : "ZMM_ACTY_ACTIVITIES",
  "AccountName" : null,
  "OwnerName" : "Gabrielle   Lee",
  "PrimaryContactName" : null,
  "LeadName" : null,
  "OpportunityName" : null,
  "CampaignName" : null,
  "CurcyConvRateType" : "Corporate",
  "CurrencyCode" : "EUR",
  "CorpCurrencyCode" : "EUR",
  "PartnerProgramId" : null,
  "ActivityType" : "Meeting",
  "CurrentSystemDtTransient" : "2016-08-24",
  "ActivityPriority" : null,
  "ApptEndTime" : null,
  "ApptStartTime" : null,
  "AccountAddress" : null,
  "AccountPhoneNumber" : null,
  "CalendarSubject" : "ATAP_REST_TASK_TEST004_Appt1",
  "CalendarRecurType" : "SINGLE",
  "CalendarTimeType" : "TIME",
  "ActivityStatus" : null,
  "OsnActivityId" : 300100091331612,
  "AccountType" : null,
  "PartnerEnrollmentId" : null,
  "PartnerProgramName" : null,
  "PartnerEnrollmentNumber" : null,
  "AccountLovSwitcher" : "LOV_AccountName",
  "SourceObjectCode" : null,
  "SourceObjectId" : null,
  "ShowTimeAs" : "BUSY",
  "ResponseCode" : "ACCEPT",
  "ReminderPeriod" : "-1",
  "PrimaryContactLovSwitcher" : "LOV_PrimaryContactName",
  "AccountNameOsn" : null,
  "LeadNameOsn" : null,
  "OpportunityNameOsn" : null,
  "PrimaryContactNameOsn" : null,
  "OwnerNameOsn" : "Gabrielle   Lee",
  "DynamicLeadLOVSwitcher" : "LOV_SourceObjectCd_LEAD",
  "DynamicOptyLOVSwitcher" : "LOV_SourceObjectCd_OPPORTUNITY",
  "DynamicCampaignLOVSwitcher" : "LOV_SourceObjectCd_CAMPAIGN",
  "InstNumDerivedFrom" : "Y",
  "UpgSourceObjectId" : null,
  "UpgSourceObjectType" : null,
  "IsClientService" : "Y",
  "OrigEntityCode" : "ACTIVITY",
  "OrigEntityNumber" : "CDRM_167288",
  "SearchDate" : null,
  "RecordSetLOVSwitcher" : "LOV_RecordSetNoDelegation",
  "StartDtRFAttr" : null,
  "EndDtRFAttr" : null,
  "LoginUserRFAttr" : 100010025532672,
  "PrivateFlag" : null,
  "CallReportYN" : "N",
  "AccountIdAttr" : null,
  "OpportunityIdAttr" : null,
  "LeadIdAttr" : null,
  "PrimaryContactEmailAddress" : null,
  "PrimaryFormattedPhoneNumber" : null,
  "ParentActivityIdAttr" : null,
  "CallReportCount" : 0,
  "StartDateForCallReport" : null,
  "EndDateForCallReport" : null,
  "StartDateForCallReportAttr" : null,
  "EndDateForCallReportAttr" : null,
  "CallReportUpcomingYN" : "N",
  "CurrentDateForCallReport" : null,
  "CurrentDateForCallReportAttr" : null,
  "PartialMtgMinutes" : null,
  "DealId" : null,
  "DynamicDealLOVSwitcher" : "LOV_SourceObjectCd_DEAL",
  "DealNumber" : null,
  "ContactIDAttr" : null,
  "CalendarSubjectDay" : "ATAP_REST_TASK_TEST004_Appt1",
  "DelegatorId" : null,
  "DelegatorName" : null,
  "AccountStatus" : null,
  "SubmittedBy" : null,
  "SubmittedDate" : null,
  "SubmittedByName" : null,
  "SrId" : null,
  "SrNumber" : null,
  "DynamicServiceRequestLOVSwitcher" : "LOV_SourceObjectCd_SERVICE_REQUEST",
  "ActivityFilter" : null,
  "BpId" : null,
  "FundRequestId" : null,
  "ObjectiveId" : null,
  "ClaimId" : null,
  "SalesObjectiveName" : null,
  "DynamicObjLOVSwitcher" : "LOV_SourceObjectCd_OBJECTIVE",
  "BusinessPlanName" : null,
  "DynamicBpLOVSwitcher" : "LOV_SourceObjectCd_BP",
  "DynamicMdfLOVSwitcher" : null,
  "ClaimName" : null,
  "DynamicClaimLOVSwitcher" : null,
  "FundRequestName" : null,
  "MdfRequestId" : null,
  "CalendarAccess" : "true",
  "DerivedAccountId" : null,
  "ActivityTimezone" : null,
  "UpdateFlag" : true,
  "DeleteFlag" : true,
  "LocationId" : null,
  "PrimaryFormattedAddress" : null,
  "DoNotCallFlag" : null,
  "OwnerPhoneNumber" : "+1 (650) 506-6601",
  "OwnerAddress" : "100 Palmer Ave,Unit 1,BELMONT, CA 94002",
  "OwnerEmailAddress" : "sendmail-test-discard@oracle.com",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288",
    "name" : "activities",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288",
    "name" : "activities",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/RecurDayListVA",
    "name" : "RecurDayListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/ClaimPVO2",
    "name" : "ClaimPVO2",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/ClaimPVO1",
    "name" : "ClaimPVO1",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/RecurTypeCodeListVA",
    "name" : "RecurTypeCodeListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/ResponseCodeVA",
    "name" : "ResponseCodeVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/OwnerListVA",
    "name" : "OwnerListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/FundRequestPVO1",
    "name" : "FundRequestPVO1",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/ShowTimeAsVA",
    "name" : "ShowTimeAsVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/ActivityFunctionCodeListVA",
    "name" : "ActivityFunctionCodeListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/RecurPatternListVA",
    "name" : "RecurPatternListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/PartnerEnrolledProgramsListVA",
    "name" : "PartnerEnrolledProgramsListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/YesNoLookup",
    "name" : "YesNoLookup",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/ShowStatusVA",
    "name" : "ShowStatusVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/ObjectVA",
    "name" : "ObjectVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/StatusCodeListVA",
    "name" : "StatusCodeListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/YesNoAllDayLookup",
    "name" : "YesNoAllDayLookup",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/PrimaryContactListVA",
    "name" : "PrimaryContactListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/RecurMonthListVA",
    "name" : "RecurMonthListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/DirectionCodeListVA",
    "name" : "DirectionCodeListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/ActivityTypeCodeListVA",
    "name" : "ActivityTypeCodeListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/AccountListVA",
    "name" : "AccountListVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/ReminderPeriodVA",
    "name" : "ReminderPeriodVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/ActivityFunctionCodeExtendedVA",
    "name" : "ActivityFunctionCodeExtendedVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/RecordSetAllRecordsFilterVA",
    "name" : "RecordSetAllRecordsFilterVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167288/lov/RatedCurrenciesVA",
    "name" : "RatedCurrenciesVA",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_16728
Back to Top