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

Get an activity

get

/crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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
  • The unique identifier for the activity assignee.
  • Read Only: true
    Maximum Length: 80
    Activity assignee composite key
  • Maximum Length: 30
    The code indicating the function of the activity.
  • Title: Activity ID
    The unique identifier of the parent activity.
  • Title: Activity Number
    Maximum Length: 64
    The unique number of the activity. The number can also be generated from an external source.
  • Title: Assignee ID
    The unique identifier of the assignee associated with the activity.
  • Title: Name
    The name of the assignee.
  • The alternate key identifier of the activity resource.
  • The identifier for the ATK popup notification created.
  • Title: Attendance
    Maximum Length: 1
    Default Value: true
    Indicates if the resource attended the activity. If True, the resource attended.
  • Default Value: 0
    This value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete.
  • Maximum Length: 15
    The corporate currency code associated with the activity assignee. 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 activity assignee.
  • Title: Creation Date
    Read Only: true
    The date and time of when the activity assignee was created.
  • Maximum Length: 30
    The currency conversion rate type associated with the activity assignee. 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: Dismissed
    Maximum Length: 1
    Default Value: false
    Indicates if the activity has been dismissed. The default value is false.
  • Title: Title
    The job name for the activity assignee.
  • Title: Last Updated Date
    Read Only: true
    The date and time when data related to an activity assignee was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The unique identifier of the user who last updated the activity assignee.
  • Title: Last Updated Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the activity assignee.
  • Links
  • Title: Phone
    The phone number of the contact.
  • Title: Owner
    The primary assignee for an Activity.
  • Title: Email
    The e-mail address of the activity assignee contact.
  • The primary formatted address information of an activity assignee.
  • The unique identifier for the series that links instances of a series together.
  • Title: Reminder Time
    The date and time to send the appointment reminder.
  • Title: Reminder
    The time period before the start date and time of an activity when a reminder should be sent to the resources on an activity.
  • Title: Name
    Read Only: true
    The name of activity resource.
  • Title: Resource Number
    Read Only: true
    Maximum Length: 30
    Resource Number of the resource associated with the activity.
  • Title: Response
    Maximum Length: 30
    Default Value: NOT_RESPONDED
    The code indicating the response of a resource on an appointment.
  • Title: Sender Job ID
    The unique identifier of the sender job.
  • Title: Show Time As
    Maximum Length: 30
    The choice of display of time on your calendar for an appointment, for example: free, busy, tentative.
  • Smart Actions
    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.
  • The date used to sort activities.
  • Maximum Length: 30
    The status of the activity.
  • Title: Due Date Reminder
    Allows the user to select the reminder period for a task due date. For example, 1 day before the task due date.
  • Read Only: true
    The primary key value of the record in the source table that is upgraded to Rel9 Activity record.
  • Read Only: true
    Maximum Length: 30
    The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record.
  • The unique identifier of user (Not for public usage).
  • Read Only: true
    The unique identifier of the user (Not for public usage).
  • Title: User Last Update Date
    The date and time when the record was last updated by a user in the disconnect mode.
  • The name of the user.
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-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: 1024
    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-ActivityAssignee-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-ActivityAssignee-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-ActivityAssignee-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: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : activities-ActivityContact-item-response
Type: object
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-ActivityContact-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: 1024
    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-ActivityContact-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-ActivityContact-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-ActivityContact-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: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
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.
  • Read Only: true
    Maximum Length: 320
    The email address of the user who created the note.
  • Read Only: true
    The address of the user who created the note.
  • 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.
  • 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.
  • Smart Actions
    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.
  • 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: Source System
    Maximum Length: 30
    This is the source object code for the source object as defined in 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 : 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-Note-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: 1024
    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-Note-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-Note-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-Note-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: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
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: 1024
    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: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Links
AccountListVA
The list of values indicating the name of the account associated with the activity.

The following properties are defined on the LOV link relation:
  • Source Attribute: AccountName; Target Attribute: PartyUniqueName
  • Display Attribute: PartyUniqueName, PreferredContactEmail
ActivityAssignee
Parameters:
  • ActivityNumber: $request.path.ActivityNumber
The activity assignees resource is used to view, create, update, and delete the internal resources assigned to an activity.
ActivityContact
Parameters:
  • ActivityNumber: $request.path.ActivityNumber
The activity contacts resource is used to view, create, update, and delete the contacts associated with an activity.
ActivityFunctionCodeExtendedVA
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_FUNCTION_TYPE_CD
The list of values indicating the function of the activity.

The following properties are defined on the LOV link relation:
  • Source Attribute: ActivityFunctionCodeTrans; Target Attribute: LookupCode
  • Display Attribute: Meaning
ActivityFunctionCodeListVA
The list of values for an activity that compares tasks with appointments.

The following properties are defined on the LOV link relation:
  • Source Attribute: ActivityFunctionCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
ActivityObjectives
Parameters:
  • ActivityNumber: $request.path.ActivityNumber
The activity objectives resource is used to view, create, update, and delete the objective of an activity.
ActivitySubtypeCodeFilterVA
Parameters:
  • finder: ByActivityTypeFinder%3BBind_ActivityTypeCode%3D{ActivityTypeCode}
The list of values indicating the activity sub types dependent on the selected activity type.

The following properties are defined on the LOV link relation:
  • Source Attribute: ActivitySubtypeCode; Target Attribute: ActivitySubtypeCode
  • Display Attribute: Meaning
ActivityTypeCodeListVA
Parameters:
  • finder: ByActivityFunctionFinder%3BBind_ActivityFunctionCode%3D{ActivityFunctionCode}
The list of values indicating the type or category of the activity.

The following properties are defined on the LOV link relation:
  • Source Attribute: ActivityTypeCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
AppointmentStatusListVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZMM_ACTIVITY_STATUS_CD%2CBindLookupCode%3D{StatusCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: AppointmentStatus; Target Attribute: LookupCode
  • Display Attribute: Meaning
AssetListVA
The list of values indicating the assets associated with an activity.

The following properties are defined on the LOV link relation:
  • Source Attribute: AssetName; Target Attribute: Product
  • Display Attribute: Product
Attachments
Parameters:
  • ActivityNumber: $request.path.ActivityNumber
The activity attachments resource is used to view, create, update, and delete attachments of an activity. An attachment includes additional information about an activity.
CaseVA
The list of values indicating the reference number of the case.

The following properties are defined on the LOV link relation:
  • Source Attribute: CaseNumber; Target Attribute: CaseNumber
  • Display Attribute: CaseNumber
DealVA
The following properties are defined on the LOV link relation:
  • Source Attribute: DealNumber; Target Attribute: DealNumber
  • Display Attribute: DealNumber
DirectionCodeListVA
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_DIRECTION
The list of values indicating the direction options for an activity, such as inbound/outbound, optional. The default value is null.

The following properties are defined on the LOV link relation:
  • Source Attribute: DirectionCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
ExternallyOwnedLookupVA
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating whether the activity is externally owned.

The following properties are defined on the LOV link relation:
  • Source Attribute: ExternallyOwnedFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
ExtnResourceVA
Parameters:
  • finder: FilterByManagerReportsFlagRF
The following properties are defined on the LOV link relation:
  • Source Attribute: OwnerName; Target Attribute: PartyName
  • Display Attribute: PartyName, EmailAddress
LeadListVA
The following properties are defined on the LOV link relation:
  • Source Attribute: LeadName; Target Attribute: Name
  • Display Attribute: Name
Note
Parameters:
  • ActivityNumber: $request.path.ActivityNumber
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.
OpportunityPVO
The following properties are defined on the LOV link relation:
  • Source Attribute: OpportunityName; Target Attribute: Name
  • Display Attribute: Name
OutcomeCodeListVA
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_OUTCOME
The list of values of an outcome of the activity such as call transferred, at risk, captured issue.

The following properties are defined on the LOV link relation:
  • Source Attribute: OutcomeCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
OwnerListVA
The list of values indicating the user who submitted the Call Report.

The following properties are defined on the LOV link relation:
  • Source Attribute: SubmittedByName; Target Attribute: PartyName
  • Display Attribute: PartyName, EmailAddress
PartnerEnrolledProgramsListVA
The list of values indicating the enrollment number of the unique program.

The following properties are defined on the LOV link relation:
  • Source Attribute: PartnerEnrollmentNumber; Target Attribute: EnrollmentNumber
  • Display Attribute: EnrollmentNumber
PartnerNamePickerVA
Parameters:
  • finder: ActivePartnersFinder
The list of values containing the names of the partners who can be associated with the activity.

The following properties are defined on the LOV link relation:
  • Source Attribute: PartnerPartyName; Target Attribute: PartyUniqueName
  • Display Attribute: PartyUniqueName
PartnerProgramsListVA
The list of values indicating the name of the partner program associated with the activity.

The following properties are defined on the LOV link relation:
  • Source Attribute: PartnerProgramName; Target Attribute: ProgramName
  • Display Attribute: ProgramName
PrimaryContactListVA
The list of values indicating the name of the primary contact of the activity.

The following properties are defined on the LOV link relation:
  • Source Attribute: PrimaryContactName; Target Attribute: PartyName
  • Display Attribute: PartyUniqueName, PrimaryEmailAddress
PriorityCodeListVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZMM_ACTIVITY_PRIORITY_CD%2CBindLookupCode%3D{PriorityCode}
The list of values indicating the priority of the activity priority. The default value is 2. The possible values are: 1, 2, 3.

The following properties are defined on the LOV link relation:
  • Source Attribute: PriorityCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
RatedCurrenciesVA
The list of values indicating the currency used by the activity.

The following properties are defined on the LOV link relation:
  • Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
  • Display Attribute: CurrencyCode
RecurDayListVA
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RECUR_DAY_CD
The list of values indicating the recurrence of an appointment on a specific day of the month, such as 1, 10, 12, 17.

The following properties are defined on the LOV link relation:
  • Source Attribute: RecurDay; Target Attribute: LookupCode
  • Display Attribute: Meaning
RecurMonthListVA
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RECUR_MONTH_CD
The list of values indicating the recurrence of an appointment in a specified month, such as April, June, March.

The following properties are defined on the LOV link relation:
  • Source Attribute: RecurMonth; Target Attribute: LookupCode
  • Display Attribute: Meaning
RecurPatternListVA
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RECUR_PATTERN_CD
The list of values indicating the recurring appointment for a specific week, such as First, Second, Third, Fourth, Last. The recurrence can be monthly or yearly.

The following properties are defined on the LOV link relation:
  • Source Attribute: RecurPattern; Target Attribute: LookupCode
  • Display Attribute: Meaning
RecurTypeCodeListVA
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RECUR_TYPE_CD
The list of values indicating how often an appointment recurs, such as Daily, Weekly, Monthly, Yearly.

The following properties are defined on the LOV link relation:
  • Source Attribute: RecurTypeCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
RecurWeekDayListVA
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RECUR_DAYWEEK_CD
The list of values indicating the activity that recurs on every weekday, such as Monday to Sunday, Weekday, Weekend, Day.

The following properties are defined on the LOV link relation:
  • Source Attribute: RecurWeekday; Target Attribute: LookupCode
  • Display Attribute: Meaning
ReminderPeriodVA
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DZMM_ACTIVITY_REMINDER
The list of values indicating when the reminder should be sent, such as one hour before, 15 minutes before.

The following properties are defined on the LOV link relation:
  • Source Attribute: ReminderPeriod; Target Attribute: LookupCode
  • Display Attribute: Meaning
ResponseCodeVA
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DZMM_ACTIVITY_RESPONSE_CD
The list of values indicating whether a reminder is needed.

The following properties are defined on the LOV link relation:
  • Source Attribute: ResponseCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
SalesObjectiveVA
The following properties are defined on the LOV link relation:
  • Source Attribute: SalesObjectiveName; Target Attribute: Name
  • Display Attribute: Name
ServiceRequestVA
The following properties are defined on the LOV link relation:
  • Source Attribute: SrNumber; Target Attribute: SrNumber
  • Display Attribute: SrNumber
ShowStatusVA
Parameters:
  • finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DORA_ZMM_ACTIVITY_STATE
The list of values indicating the status of a record.

The following properties are defined on the LOV link relation:
  • Source Attribute: ShowStatus; Target Attribute: LookupCode
  • Display Attribute: Meaning
ShowTimeAsVA
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DZMM_ACTIVITY_SHOWTIMEAS_CD
The list of values indicating the choice of display of time on your calendar for an activity.

The following properties are defined on the LOV link relation:
  • Source Attribute: ShowTimeAs; Target Attribute: LookupCode
  • Display Attribute: Meaning
StatusCodeListVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZMM_ACTIVITY_STATUS_CD%2CBindLookupCode%3D{StatusCode}
The list of values indicating the status of the activity. The default value is Not Started.

The following properties are defined on the LOV link relation:
  • Source Attribute: StatusCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
TaskReminderPeriodVA
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DORA_ZMM_TASK_REMINDER
The list of values indicating the time when a task reminder occurs.

The following properties are defined on the LOV link relation:
  • Source Attribute: TaskReminderPeriod; Target Attribute: LookupCode
  • Display Attribute: Meaning
YesNoAllDayLookup
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating whether the appointment is for the entire day, such as True or False.

The following properties are defined on the LOV link relation:
  • Source Attribute: AllDayFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
YesNoLookup
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating if the activity was generated due to auto sync.

The following properties are defined on the LOV link relation:
  • Source Attribute: OutlookAutoSyncFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
YesNoLookup1
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating the dismiss status of the activity

The following properties are defined on the LOV link relation:
  • Source Attribute: DismissFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
smartActions
Parameters:
  • ActivityNumber: $request.path.ActivityNumber
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.
Back to Top

Examples

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

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167274

Example of Response Body

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

{
  "ActivityId" : 300100091331333,
  "ActivityNumber" : "CDRM_167274",
  "AccountId" : null,
  "ActivityCreatedBy" : "SALES_ADMIN",
  "ActivityCreationDate" : "2016-08-24T00:23:41-07:00",
  "ActivityPartialDescription" : null,
  "ActivityEndDate" : "2014-05-26T00:00:00-07:00",
  "RecordSet" : null,
  "ShowStatus" : null,
  "Subject" : "ATAP_REST_TASK_TEST004_ADHOCCALLREP7",
  "ActivityFunctionCodeTrans" : null,
  "ActivityFunctionCode" : "APPOINTMENT",
  "ActivityLastUpdateLogin" : "3ACD2BA10C14B0DEE053780CF10A305B",
  "ActivityStartDate" : "2014-05-25T23:00:00-07:00",
  "ActivityTypeCode" : "MEETING",
  "ActivityUpdateDate" : "2016-08-24T01:37:10-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-24T00:23:41-07:00",
-
}
Back to Top