Get all activities
get
/crmRestApi/resources/11.13.18.05/activities
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- ActivitesByContactId: Finds activities where a specified contact is defined.
Finder Variables:- ContactIDAttr; integer; The contact ID related to the activities.
- ActivityNumberRowFinder: Finds the unique identifier for an activity.
Finder Variables:- ActivityNumber; string; The unique number of the activity. The number can also be generated from an external source.
- AppointmentsWithNoMyCallReport: Finds appointments not having an associated call report.
Finder Variables:- DateRange; integer; The date range within which you want search for appointments.
- EndDtRFAttr; string; The appointment end date.
- StartDtRFAttr; string; The appointment start date.
- CompletedActivities: Finds activities in a completed status.
Finder Variables:- Bind_CurrentDate; string; Finds the date used to locate completed activities.
- Bind_RecurSeriesType_BV; string; The recurring type code of an appointment.
- Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
- Bind_TaskStatus_BV; string; The status of the tasks.
- GetActivitiesByActivityNumber: Finds activities with the specified activity number.
Finder Variables:- ActivityNumber; string; Finds the activity number use to locate the activity.
- GetListOfCallReports: Finds call reports.
Finder Variables:- AccountIdAttr; integer; Finds the account ID related to the call reports.
- EndDtRFAttr; string; Finds the end date of the call report.
- LeadIdAttr; string; Finds the lead ID related to the call reports.
- OpportunityIdAttr; string; Finds the opportunity ID related to the call reports.
- StartDtRFAttr; string; Finds the start date of the call report.
- GetListOfCallReportsForPastAppt: Finds call reports related to a past appointment.
Finder Variables:- ParentActivityIdAttr; string; The parent activity ID related to the call reports.
- MyActivitiesAsResource: Finds activities where a specified user is a resource.
Finder Variables:- Bind_RecurSeriesType_BV; string; The recurring type code of an appointment.
- Bind_UserResourceId; integer; Finds the resource ID of the user.
- MyAppointmentsInDateRange: Finds appointments within a data range.
Finder Variables:- EndDtRFAttr; string; Finds the appointment end date.
- StartDtRFAttr; string; Finds the appointment start date.
- MyCallReportsInDateRange: Finds call reports within a date range.
Finder Variables:- AccountIdAttr; integer; The account ID related to the call reports.
- EndDtRFAttr; string; The end date of the call reports.
- LeadIdAttr; string; The lead ID related to the call reports.
- OpportunityIdAttr; string; The opportunity ID related to the call reports.
- StartDtRFAttr; string; The start date of the call report.
- MyOpenActivities: Finds all open activities owned by a specified user.
Finder Variables:- Bind_Subject; string; Open activities owned by a specified user.
- MyOpenTasks: Finds tasks in an open status.
Finder Variables:- Bind_LoggedInUserId_BV; integer; The ID of the user who is logged into the application.
- Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
- Bind_TaskStatus_BV; string; The status of the task.
- Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
- MyTasks: Finds tasks owned by a specified user.
Finder Variables:- Bind_LoggedInUserId_BV; integer; Finds the ID of the user who is logged into the application.
- Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
- OpenActivities: Finds all open activities.
Finder Variables:- Bind_CurrentDate; string; Finds the date used to locate current activities.
- Bind_RecurSeriesType_BV; string; The recurring type code of an appointment
- Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
- Bind_TaskStatus_BV; string; The status of the tasks.
- Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
- OpenTasksByHighPriority: Finds tasks with a priority value of high.
Finder Variables:- Bind_LoggedInUserId_BV; integer; The ID of the user who is logged into the application.
- Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
- Bind_TaskPriority_BV; string; The priority of the task.
- Bind_TaskStatus_BV; string; The status of the task.
- Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
- OverdueTasks: Finds tasks with a due date in the past.
Finder Variables:- Bind_CurrentDate; string; The date used to locate current activities.
- Bind_CurrentUPTZDate; string; The date used to locate the Tasks whose due date is before the current date.
- Bind_LoggedInUserId_BV; integer; The ID of the user who is logged into the application.
- Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
- Bind_TaskStatus_BV; string; The status of the tasks.
- Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
- PrimaryKey: Finds the activity with the specified primary key identifier.
Finder Variables:- ActivityId; integer; The unique identifier of the activity.
- ActivitesByContactId: Finds activities where a specified contact is defined.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AccountId; integer; The unique identifier of the activity account. Examples of account are: customer, organization, person, partner.
- AccountIdAttr; integer; The attribute for the account Id (Not for public usage).
- AccountNumber; string; The account number of the account associated with the activity.
- ActivityCreatedBy; string; The user who created the activity.
- ActivityCreationDate; string; The date when the record was created.
- ActivityDescription; string; A text area for capturing information about the activity. The value should be Base64 encoded. You can use any base64 encoder to encode the text to Base64. If you want to provide text instead of base64 code, then you can use the endpoint enclosures endpoint. For example to update the description for activity ID 12345, use the endpoint /crmRestApi/resources/11.13.18.05/activities/12345/enclosure/ActivityDescription.
- ActivityEndDate; string; The date and time of when an appointment ends. The time when a task is completed.
- ActivityFilter; string; An attribute to add additional activity filter (Not for public usage).
- ActivityFunctionCode; string; The code indicating the function of an activity, such as Appointment, Task, or Call Report.
- ActivityId; integer; The unique identifier of the activity.
- ActivityMtgMinutes; string; The minutes of meeting of the activity. The value should be Base64 encoded. You can use any base64 encoder to encode the text to Base64. If you want to provide text instead of base64 code, then you can use the endpoint enclosures endpoint. For example to update the meeting minutes for activity ID 12345, use the endpoint /crmRestApi/resources/11.13.18.05/activities/12345/enclosure/ActivityMtgMinutes.
- ActivityNumber; string; The unique number of the activity. The number can also be generated from an external source.
- ActivityPartialDescription; string; A column that stores the first 4000 characters of activity description.
- ActivityStartDate; string; The starting date and time of an appointment or a task. The default value for an appointment is null. The default value for a task is the date and time when the task is created.
- ActivitySubtypeCode; string; Displays a list of subtype values that are dependent on the value of the activity.
- ActivityTypeCode; string; The code indicating the type or category of the activity. A list of valid values is defined in the lookup ZMM_ACTIVITY_TYPE.
- ActivityUpdateDate; string; The date when the record was last updated.
- AllDayFlag; boolean; Indicates whether the appointment is for the entire day. If the value is True, the appointment is for the entire day. The default value is False.
- AppointmentStatus; string; The status of the appointment.
- ArticleVersionId; string; The unique identifier of the article version.
- AssessmentId; integer; The unique identifier of the assessment that is associated to the activity or the activity template.
- AssetId; integer; The unique identifier of an asset.
- AssetName; string; The name of the asset that is associated with an activity.
- AssetNumber; string; The alternate key identifier of the associated asset.
- AssetSerialNumber; string; The serial number of the associated asset.
- AutoLogSource; string; The name of the source for the activity.
- BpId; integer; The unique identifier of the business plan.
- BuOrgId; integer; The unique identifier for the Business Unit. This attribute is obsolete.
- BusinessPlanName; string; The name of the business plan associated with the activity.
- BusinessPlanNumber; string; The business plan number of the business plan associated with the activity.
- CalendarRecurType; string; The activity recurrence type.
- CalendarTimeType; string; Indicates all day appointment (Not for public usage).
- CallReportCount; integer; A count of the number of call reports.
- CallReportUpcomingYN; string; Indicates if there are any Call reports associated with the current Appointments Lead, Opportunity, or Account.
- CallReportYN; string; Indicates whether the activity is associated with a call report. The default value is false.
- CampaignId; integer; The unique identifier of the related campaign.
- CampaignName; string; The name of the campaign associated with the activity.
- CampaignNumber; string; The campaign number of the campaign associated with the activity.
- CaseId; integer; The unique identifier of the case.
- CaseNumber; string; The alternate identifier of the case.
- CaseTitle; string; The title of the case.
- CheckedInBy; string; The user who checks in to a location.
- CheckedOutBy; string; The user who checks out of a location.
- CheckinDate; string; The date and time when a user checks in to a location.
- CheckinLatitude; number; The latitude when a user checks in to a location.
- CheckinLongitude; number; The longitude when a user checks in to a location.
- CheckoutDate; string; The date and time when a user checks out of a location.
- CheckoutLatitude; number; The latitude when a user checks out of a location.
- CheckoutLongitude; number; The longitude when a user checks out of a location.
- ClaimId; integer; The unique identifier of the claim.
- ClaimName; string; The name of the claim associated with the activity.
- ClaimNumber; string; The number of the claim associated with the activity.
- ConflictId; integer; The unique identifier of the conflict. (Not for public usage).
- ContactIDAttr; integer; The contact identifier (Not for public usage).
- ContactNumber; string; The contact number of primary contact associated with the activity.
- CreatedBy; string; The user who created the activity.
- CreationDate; string; The date when the activity was created.
- CurrentDateForCallReport; string; The current date for the call report.
- CurrentDateForCallReportAttr; string; The attribute for the current date for the call report (Not for public usage).
- CurrentSystemDtTransient; string; The current system date.
- CustomerAccountId; integer; The unique identifier of the customer account related to the activity.
- DealId; integer; The unique identifier of the related deal.
- DealNumber; string; The unique number of the deal associated to the activity. The number can also be generated from an external source.
- DelegatorId; integer; The unique identifier of the activity resource that delegated activity ownership to another resource.
- DelegatorName; string; The name of the activity resource that delegated activity ownership to another resource.
- DeleteFlag; boolean; Indicates if the activity has been deleted.
- DirectionCode; string; The code indicating the direction of an activity. The options are inbound and outbound. The default value is null.
- DismissAssignee; string; Indicates whether the assignees is dismissed. Valid values are Y and N.
- DismissFlag; boolean; Indicates if the calls that were logged for a past appointment are dismissed.
- DueDate; string; The date the task activity is due to be completed.
- EmailSentDate; string; The date and time when the activity e-mail notifications are shared through Outlook.
- EndDateForCallReport; string; The end date of the call report.
- EndDateForCallReportAttr; string; The attribute for end date of the call report (Not for public usage).
- EndDtRFAttr; string; The attribute for activity start date (Not for public usage).
- ExternalContactEmail; string; Indicates the e-mail address of an external contact.
- ExternalContactName; string; Indicates the name of an external contact.
- ExternallyOwnedFlag; boolean; Indicates whether the activity is created by an external contact.
- FundRequestId; integer; The unique identifier of the fund request.
- FundRequestName; string; The name of the fund request associated with the activity.
- FundRequestNumber; string; The fund request number of the fund request associated with the activity.
- IbAssetId; integer; The unique identifier of the installed base asset associated with the activity.
- IbAssetNumber; string; The number of the installed base asset associated with the activity.
- LastUpdateDate; string; The date and time when the activity was last updated.
- LastUpdatedBy; string; The user who last updated the activity.
- LeadId; integer; The unique identifier of the related lead.
- LeadIdAttr; integer; The attribute for the lead Id (Not for public usage).
- LeadName; string; The activity lead name.
- LeadNumber; string; The lead number of lead associated with the activity.
- Location; string; The location of the appointment.
- LocationId; integer; The unique identifier of the account or contact location.
- LoginUserRFAttr; integer; The attribute for activity login user (Not for public usage).
- ObjectiveId; integer; The unique identifier of the objective.
- OpportunityId; integer; The unique identifier of the related opportunity.
- OpportunityIdAttr; integer; The attribute for the opportunity Id (Not for public usage).
- OpportunityName; string; The name of the opportunity associated with the activity.
- OpportunityNumber; string; The opportunity number of the opportunity associated with the activity.
- OrchestrationId; integer; The unique identifier of the orchestration object.
- OrchestrationStepId; integer; The unique identifier of the orchestration step.
- OsnActivityId; integer; The unique activity identifier.
- OtherPartyPhoneNumber; string; The inbound phone number that is used to make a call. Identifies the phone number dialed for outbound calls.
- OutcomeCode; string; The code indicating the outcome of the activity. A list of valid values is defined in the lookup ZMM_ACTIVITY_OUTCOME.
- OutlookAutoSyncFlag; boolean; Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365.
- OutlookFlag; boolean; Indicates whether the activity is created in Outlook. If the value is Y, then the activity is created in Outlook and synchronized.
- OutlookGlobalId; string; The unique identifier of an appointment created from Microsoft 365.
- OutlookIdentifier; string; The unique identifier for the activity in Outlook.
- OwnerId; integer; The unique identifier of the activity owner. Identifies only resources.
- OwnerName; string; The name of the owner of the activity.
- ParentActivityId; integer; The related activity ID, only applicable if the record is a follow up activity.
- ParentActivityIdAttr; string; The attribute for the parent activity Id (Not for public usage).
- PartialMtgMinutes; string; A column that stores a truncated string of the meeting minutes.
- PartnerEnrollmentId; integer; The unique identifier of the related program enrollment.
- PartnerPartyId; integer; The party identifier of the partner organization.
- PartnerPartyName; string; The party name of the partner organization.
- PartnerPartyNumber; string; The partner party number of partner associated with the activity.
- PartnerProgramId; integer; The unique identifier of the related partner program.
- PartnerProgramNumber; string; The partner program number of partner program associated with the activity.
- PercentageComplete; number; The amount of activity completed in percentage. This is a free form numeric value ranging from 0 to 100.
- PrimaryContactEmailAddress; string; The e-mail address of the primary contact for the activity.
- PrimaryContactId; integer; The unique identifier of the activity contact.
- PrimaryContactName; string; The name of the primary contact of the activity.
- PriorityCode; string; The code indicating the priority of the activity, such as High, Medium and Low. The default value is Medium.
- PrivateFlag; boolean; Indicates whether the activity is private. The default value is false.
- RecordSet; string; The set of records to display in activity search.
- RecurEndDate; string; The date when a recurring activity ends.
- RecurExceptionFlag; boolean; Indicates if the appointment instance is updated outside the recurring appointment series. The default value is false.
- RecurRecType; string; Either "I" for instance or "S" for series or "N" for non-recurring. Do not populate it if Activity is of type Task (Not for public usage).
- RecurSeriesId; integer; The unique identifier for the series that links instances of a series together.
- RecurUpdatedAttributes; string; The updated field references for recurring appointment exception records.
- ReferenceCustomerId; integer; The unique identifier of the referenced customer who is associated with the activity.
- ResourceNumber; string; The resource number of owner associated with the activity.
- ResponseCode; string; The code indicating the response of the owner on an appointment.
- SalesObjectiveName; string; The name of the sales objective associated with the activity.
- SalesObjectiveNumber; string; The sales objective number of the sales objective associated with the activity.
- SelectedFlag; boolean; The records selected for Mass Update (Not for public usage).
- ShowStatus; string; Indicates whether the activity is open, complete, or all activities.
- SmartActionContext; string; The metadata associated with the smart action.
- SmartActionId; integer; The unique identifier of the smart action.
- SortDate; string; The date used to sort the activities. The sort date can be the appointment start date, the task due date, or the task complete date.
- SrId; integer; The unique identifier of the related service request.
- SrNumber; string; The alternate key identifier of the service request.
- StartDateForCallReport; string; The start date of the call report.
- StartDateForCallReportAttr; string; The attribute for start date of the call report (Not for public usage).
- StartDtRFAttr; string; The attribute for Activity Start Date (Not for public usage).
- StatusCode; string; The code indicating the status of the activity. The default value is Not Started. A list of valid values is defined in the lookup ZMM_ACTIVITY_STATUS_CD.
- Subject; string; The unique subject, name, or title of the activity.
- SubmittedByName; string; The user who submitted the Call Report.
- SubmittedDate; string; The date and time when the Call Report was submitted.
- TemplateFlag; string; Indicates whether this is a template activity.
- TemplateId; integer; The unique identifier of the template.
- UpdateFlag; boolean; Indicates whether the activity has been updated. The default value is true.
- UpgSourceObjectId; string; The primary key value of the record in the source table that is upgraded to Rel9 Activity record.
- UpgSourceObjectType; string; The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record.
- WebConferenceId; string; The unique identifier of the web conference.
- WebConferenceURL; string; The web conference join URL.
- WebconfSyncStatusFlag; boolean; The appointment interaction status.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : activities
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : activities-item-response
Type:
Show Source
object
-
AccountAddress: string
Title:
Account Address
Read Only:true
The address associated with the account. -
AccountId: integer
(int64)
Title:
Account ID
The unique identifier of the activity account. Examples of account are: customer, organization, person, partner. -
AccountIdAttr: integer
The attribute for the account Id (Not for public usage).
-
AccountName: string
Title:
Account
The name of the account associated with the activity. -
AccountNameOsn: string
Title:
Social Account Name
The account name displayed in Oracle Social Network. -
AccountNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
The account number of the account associated with the activity. -
AccountPhoneNumber: string
Title:
Account Phone Number
Read Only:true
The phone number associated with the account. -
AccountStatus: string
Read Only:
true
Maximum Length:1
The status of the account. -
AccountType: string
Read Only:
true
Maximum Length:30
The type of the account. -
ActivityAssignee: array
Activity Assignees
Title:
Activity Assignees
The activity assignees resource is used to view, create, update, and delete the internal resources assigned to an activity. -
ActivityContact: array
Activity Contacts
Title:
Activity Contacts
The activity contacts resource is used to view, create, update, and delete the contacts associated with an activity. -
ActivityCreatedBy: string
Title:
Activity Created By
Read Only:true
Maximum Length:64
The user who created the activity. -
ActivityCreationDate: string
(date-time)
Title:
Activity Creation Date
Read Only:true
The date when the record was created. -
ActivityDescription: string
(byte)
Title:
Description
A text area for capturing information about the activity. The value should be Base64 encoded. You can use any base64 encoder to encode the text to Base64. If you want to provide text instead of base64 code, then you can use the endpoint enclosures endpoint. For example to update the description for activity ID 12345, use the endpoint /crmRestApi/resources/11.13.18.05/activities/12345/enclosure/ActivityDescription. -
ActivityDirection: string
Read Only:
true
The direction of the interaction. -
ActivityEndDate: string
(date-time)
Title:
End Date
The date and time of when an appointment ends. The time when a task is completed. -
ActivityFilter: string
Read Only:
true
An attribute to add additional activity filter (Not for public usage). -
ActivityFunctionCode: string
Title:
Activity
Maximum Length:30
The code indicating the function of an activity, such as Appointment, Task, or Call Report. -
ActivityFunctionCodeTrans: string
Title:
Activity
Maximum Length:255
The activity function code. -
ActivityId: integer
(int64)
Title:
Activity ID
The unique identifier of the activity. -
ActivityLastUpdateLogin: string
Title:
Activity Last Update Login
Read Only:true
Maximum Length:32
The date when the record was last updated. -
ActivityMtgMinutes: string
(byte)
Title:
Meeting Minutes
The minutes of meeting of the activity. The value should be Base64 encoded. You can use any base64 encoder to encode the text to Base64. If you want to provide text instead of base64 code, then you can use the endpoint enclosures endpoint. For example to update the meeting minutes for activity ID 12345, use the endpoint /crmRestApi/resources/11.13.18.05/activities/12345/enclosure/ActivityMtgMinutes. -
ActivityNumber: string
Title:
Activity Number
Maximum Length:64
The unique number of the activity. The number can also be generated from an external source. -
ActivityObjectives: array
Activity Objectives
Title:
Activity Objectives
The activity objectives resource is used to view, create, update, and delete the objective of an activity. -
ActivityOutcome: string
Read Only:
true
The outcome of the activity. -
ActivityPartialDescription: string
Title:
Short Description
Maximum Length:4000
A column that stores the first 4000 characters of activity description. -
ActivityPriority: string
Title:
Priority
Indicates the priority of the activity (Not for public usage). -
ActivityStartDate: string
(date-time)
Title:
Start Date
The starting date and time of an appointment or a task. The default value for an appointment is null. The default value for a task is the date and time when the task is created. -
ActivityStatus: string
Title:
Status
Read Only:true
The status of the activity. -
ActivitySubtypeCode: string
Title:
Subtype
Maximum Length:30
Displays a list of subtype values that are dependent on the value of the activity. -
ActivityTimezone: string
Represents the time zone that the activity needs to be created in, other than the default logged in the user's time zone preference.
-
ActivityType: string
Title:
Activity Type
The type of the activity. -
ActivityTypeCode: string
Title:
Type
Maximum Length:30
The code indicating the type or category of the activity. A list of valid values is defined in the lookup ZMM_ACTIVITY_TYPE. -
ActivityUpdateDate: string
(date-time)
Title:
Activity Updated Date
Read Only:true
The date when the record was last updated. -
ActivityUpdatedBy: string
Title:
Activity Updated By
Read Only:true
Maximum Length:64
The login of the user who last updated the record. -
ActivityUserLastUpdateDate: string
(date-time)
Title:
Activity User Last Updated Date
Read Only:true
The date when the record was last updated by the activity user. -
AllDayFlag: boolean
Title:
All Day
Maximum Length:1
Default Value:false
Indicates whether the appointment is for the entire day. If the value is True, the appointment is for the entire day. The default value is False. -
AppointmentStatus: string
Title:
Appointment Status
Maximum Length:30
The status of the appointment. -
ApptEndTime: string
(date-time)
Title:
End Time
The time when the activity ends. -
ApptStartTime: string
(date-time)
Title:
Start Time
The time when the activity starts. -
ArticleVersionId: string
Title:
Article Version ID
Maximum Length:64
The unique identifier of the article version. -
AssessmentId: integer
(int64)
Title:
Assessment ID
The unique identifier of the assessment that is associated to the activity or the activity template. -
AssetId: integer
(int64)
Title:
Asset ID
The unique identifier of an asset. -
AssetName: string
Title:
Asset
The name of the asset that is associated with an activity. -
AssetNumber: string
Title:
Asset Number
The alternate key identifier of the associated asset. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
The serial number of the associated asset. -
AttachmentEntityName: string
Maximum Length:
255
Default Value:ZMM_ACTY_ACTIVITIES
The name of the attachment entity. -
Attachments: array
Activity Attachments
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. -
AutoLogSource: string
Title:
Source System
Maximum Length:30
The name of the source for the activity. -
BpId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BuOrgId: integer
(int64)
Title:
Business Unit
The unique identifier for the Business Unit. This attribute is obsolete. -
BusinessPlanName: string
Title:
Business Plan
The name of the business plan associated with the activity. -
BusinessPlanNumber: string
Title:
Business Plan Number
The business plan number of the business plan associated with the activity. -
CalendarAccess: boolean
The access rights to calendar (Not for public usage).
-
CalendarRecurType: string
The activity recurrence type.
-
CalendarSubject: string
The activity subject.
-
CalendarSubjectDay: string
The title of the calendar.
-
CalendarTimeType: string
Indicates all day appointment (Not for public usage).
-
CallReportCount: integer
(int32)
Title:
Call Report Count
Default Value:0
A count of the number of call reports. -
CallReportUpcomingYN: string
Indicates if there are any Call reports associated with the current Appointments Lead, Opportunity, or Account.
-
CallReportYN: string
Indicates whether the activity is associated with a call report. The default value is false.
-
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the related campaign. -
CampaignName: string
Title:
Campaign
The name of the campaign associated with the activity. -
CampaignNumber: string
Title:
Campaign Number
The campaign number of the campaign associated with the activity. -
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
CaseNumber: string
Title:
Case Number
The alternate identifier of the case. -
CaseTitle: string
Title:
Title
Read Only:true
Maximum Length:400
The title of the case. -
CheckedInBy: string
Title:
Checked-In By
Maximum Length:64
The user who checks in to a location. -
CheckedOutBy: string
Title:
Checked-Out By
Maximum Length:64
The user who checks out of a location. -
CheckinDate: string
(date-time)
Title:
Check-In Time
The date and time when a user checks in to a location. -
CheckinLatitude: number
Title:
Check-In Latitude
The latitude when a user checks in to a location. -
CheckinLongitude: number
Title:
Check-In Longitude
The longitude when a user checks in to a location. -
CheckoutDate: string
(date-time)
Title:
Check-Out Time
The date and time when a user checks out of a location. -
CheckoutLatitude: number
Title:
Check-Out Latitude
The latitude when a user checks out of a location. -
CheckoutLongitude: number
Title:
Check-Out Longitude
The longitude when a user checks out of a location. -
ClaimId: integer
(int64)
Title:
Claim ID
The unique identifier of the claim. -
ClaimName: string
Title:
MDF Claim
The name of the claim associated with the activity. -
ClaimNumber: string
Title:
Claim Number
The number of the claim associated with the activity. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. (Not for public usage). -
ContactIDAttr: integer
The contact identifier (Not for public usage).
-
ContactNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The contact number of primary contact associated with the activity. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the activity. 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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the activity. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the activity was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate
Maximum Length:30
The rate of currency conversion for an activity. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency used by the activity. 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. -
CurrentDateForCallReport: string
(date-time)
The current date for the call report.
-
CurrentDateForCallReportAttr: string
(date-time)
The attribute for the current date for the call report (Not for public usage).
-
CurrentSystemDtTransient: string
(date)
Read Only:
true
The current system date. -
CustomerAccountId: integer
(int64)
Title:
Customer Account ID
The unique identifier of the customer account related to the activity. -
DealId: integer
(int64)
Title:
Deal ID
The unique identifier of the related deal. -
DealNumber: string
Title:
Deal Registration
The unique number of the deal associated to the activity. The number can also be generated from an external source. -
DelegatorId: integer
(int64)
Title:
Delegator ID
The unique identifier of the activity resource that delegated activity ownership to another resource. -
DelegatorName: string
Title:
Delegated By
The name of the activity resource that delegated activity ownership to another resource. -
DeleteFlag: boolean
Read Only:
true
Indicates if the activity has been deleted. -
DerivedAccountId: integer
The unique identifier of the derived account.
-
DirectionCode: string
Title:
Direction
Maximum Length:30
The code indicating the direction of an activity. The options are inbound and outbound. The default value is null. -
DismissAssignee: string
Title:
Dismissed
Indicates whether the assignees is dismissed. Valid values are Y and N. -
DismissFlag: boolean
Title:
Dismissed
Maximum Length:1
Indicates if the calls that were logged for a past appointment are dismissed. -
DoNotCallFlag: boolean
Read Only:
true
Indicates whether the primary contact should be called. The default value is false. -
DueDate: string
(date)
Title:
Due Date
The date the task activity is due to be completed. -
Duration: number
Title:
Duration
The duration of an appointment or task. -
DynamicClaimLOVSwitcher: string
Read Only:
true
The unique identifier of the account. -
EmailSentDate: string
(date-time)
The date and time when the activity e-mail notifications are shared through Outlook.
-
EndDateForCallReport: string
(date-time)
The end date of the call report.
-
EndDateForCallReportAttr: string
(date-time)
The attribute for end date of the call report (Not for public usage).
-
EndDtRFAttr: string
(date-time)
The attribute for activity start date (Not for public usage).
-
ExternalContactEmail: string
Title:
Primary Email
Maximum Length:320
Indicates the e-mail address of an external contact. -
ExternalContactName: string
Title:
External Contact Name
Maximum Length:360
Indicates the name of an external contact. -
ExternallyOwnedFlag: boolean
Title:
Externally Owned
Maximum Length:1
Default Value:false
Indicates whether the activity is created by an external contact. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the fund request. -
FundRequestName: string
Title:
MDF Request
The name of the fund request associated with the activity. -
FundRequestNumber: string
Title:
Fund Request Number
The fund request number of the fund request associated with the activity. -
IbAssetId: integer
(int64)
Title:
IB Asset ID
The unique identifier of the installed base asset associated with the activity. -
IbAssetNumber: string
Title:
Installed Base Asset
The number of the installed base asset associated with the activity. -
IbAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
The serial number of the installed base asset associated with the activity. -
InstNumDerivedFrom: string
Default Value:
Y
The attribute to identify recurrence mode (Not for public usage). -
IsClientService: string
Default Value:
Y
The obsolete attribute (Not for public usage). -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the activity was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the activity. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The unique identifier of the user who last logged in to the application. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the related lead. -
LeadIdAttr: integer
The attribute for the lead Id (Not for public usage).
-
LeadName: string
Title:
Lead
The activity lead name. -
LeadNameOsn: string
Title:
Social Lead Name
The lead name displayed in Oracle Social Network. -
LeadNumber: string
Title:
Lead Number
The lead number of lead associated with the activity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Title:
Location
Maximum Length:200
The location of the appointment. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier of the account or contact location. -
LoginUserRFAttr: integer
The attribute for activity login user (Not for public usage).
-
MdfRequestId: integer
The identifier for fund request.
-
MobileActivityCode: string
Title:
Mobile Activity Code
Maximum Length:50
The code indicating if an external mobile was used for the activity. -
Note: array
Notes
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. -
NotesLinkSourceCodeTransient: string
Read Only:
true
The note source object. -
ObjectiveId: integer
(int64)
Title:
Objective ID
The unique identifier of the objective. -
OpportunityId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the related opportunity. -
OpportunityIdAttr: integer
The attribute for the opportunity Id (Not for public usage).
-
OpportunityName: string
Title:
Opportunity
The name of the opportunity associated with the activity. -
OpportunityNameOsn: string
Title:
Social Opportunity Name
The opportunity name displayed in Oracle Social Network. -
OpportunityNumber: string
Title:
Opportunity Number
The opportunity number of the opportunity associated with the activity. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration step. -
OrigEntityCode: string
Maximum Length:
30
Default Value:ACTIVITY
The column to store the source of activity record during upgrade. -
OrigEntityNumber: string
Maximum Length:
64
The column to store the original user key of the object being upgraded to Activity. -
OsnActivityId: integer
(int64)
The unique activity identifier.
-
OtherPartyPhoneNumber: string
Title:
Other Party Phone Number
Maximum Length:40
The inbound phone number that is used to make a call. Identifies the phone number dialed for outbound calls. -
OutcomeCode: string
Title:
Outcome
Maximum Length:30
The code indicating the outcome of the activity. A list of valid values is defined in the lookup ZMM_ACTIVITY_OUTCOME. -
OutlookAutoSyncFlag: boolean
Title:
Microsoft Auto-Synchronization
Maximum Length:1
Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365. -
OutlookFlag: boolean
Title:
Outlook
Maximum Length:1
Default Value:false
Indicates whether the activity is created in Outlook. If the value is Y, then the activity is created in Outlook and synchronized. -
OutlookGlobalId: string
Title:
Outlook Global ID
Maximum Length:1024
The unique identifier of an appointment created from Microsoft 365. -
OutlookIdentifier: string
Title:
Outlook Identifier
Maximum Length:1024
The unique identifier for the activity in Outlook. -
OwnerAddress: string
Title:
Activity Owner Address
Read Only:true
The address of the activity owner. -
OwnerEmailAddress: string
Title:
Activity Owner Email
Read Only:true
Maximum Length:320
The e-mail address of the activity owner. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the activity owner. Identifies only resources. -
OwnerName: string
Title:
Owner
Maximum Length:360
The name of the owner of the activity. -
OwnerNameOsn: string
Title:
Social Owner Name
The owner name displayed in Oracle Social Network. -
OwnerPhoneNumber: string
Title:
Activity Owner Phone Number
Read Only:true
The phone number of the activity owner. -
ParentActivityId: integer
(int64)
Title:
Parent ID
The related activity ID, only applicable if the record is a follow up activity. -
ParentActivityIdAttr: string
The attribute for the parent activity Id (Not for public usage).
-
PartialMtgMinutes: string
Title:
Short Meeting Minutes
Maximum Length:4000
A column that stores a truncated string of the meeting minutes. -
PartnerEnrollmentId: integer
(int64)
Title:
Enrollment ID
The unique identifier of the related program enrollment. -
PartnerEnrollmentNumber: string
Title:
Enrollment Number
The surrogate key for partner enrollment. -
PartnerPartyId: integer
(int64)
Title:
Partner Party ID
The party identifier of the partner organization. -
PartnerPartyName: string
Title:
Partner
Maximum Length:80
The party name of the partner organization. -
PartnerPartyNumber: string
Title:
Partner Number
The partner party number of partner associated with the activity. -
PartnerProgramId: integer
(int64)
Title:
Partner Program ID
The unique identifier of the related partner program. -
PartnerProgramName: string
Title:
Program
The name of the partner program associated with the activity. -
PartnerProgramNumber: string
Title:
Program Number
The partner program number of partner program associated with the activity. -
PartnerUsageFlag: boolean
Title:
Partner Usage
Maximum Length:1
Default Value:false
Indicates whether the activity is created for an organization account with usage as Partner. The default value is false. -
PercentageComplete: number
Title:
Percentage Complete
Default Value:0
The amount of activity completed in percentage. This is a free form numeric value ranging from 0 to 100. -
PrimaryContactEmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The e-mail address of the primary contact for the activity. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact ID
The unique identifier of the activity contact. -
PrimaryContactName: string
Title:
Primary Contact
The name of the primary contact of the activity. -
PrimaryContactNameOsn: string
Title:
Social Primary Contact Name
The primary contact name displayed in Oracle Social Network. -
PrimaryFormattedAddress: string
Title:
Primary Contact Address
Read Only:true
The formatted address information of the activity primary contact. -
PrimaryFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the primary contact. -
PriorityCode: string
Title:
Priority
Maximum Length:30
The code indicating the priority of the activity, such as High, Medium and Low. The default value is Medium. -
PrivateFlag: boolean
Title:
Private
Maximum Length:1
Indicates whether the activity is private. The default value is false. -
RecordSet: string
Title:
Record Set
Maximum Length:255
The set of records to display in activity search. -
RecurDay: integer
(int64)
Title:
Day
The recurrence of an appointment on a specific day of the month. -
RecurEndDate: string
(date-time)
Title:
Ends
The date when a recurring activity ends. -
RecurEveryOptionFlag: boolean
Title:
Recurrence Option
Maximum Length:1
Indicates the frequency of recurrence of an activity. If the recurrence is everyday of the week, it is set to Y if it is weekdays only, it is set to N. The recurring options are every day, week, month, year, and so on. -
RecurExceptionFlag: boolean
Title:
Recurrence Exception
Maximum Length:1
Indicates if the appointment instance is updated outside the recurring appointment series. The default value is false. -
RecurFrequency: number
Title:
Repeat
The frequency with which the recurring appointment series repeats. -
RecurFriFlag: boolean
Title:
Friday
Maximum Length:1
The recurrence of an appointment on every Friday. -
RecurMonFlag: boolean
Title:
Monday
Maximum Length:1
The recurrence of an appointment on every Monday. -
RecurMonth: string
Title:
Month
Maximum Length:30
The recurrence of an appointment in a specified month. -
RecurNumberOfInstances: number
Title:
Number of Instances
The specific number of occurrences for the series, after which the recurring series ends. -
RecurOrigInstDate: string
(date-time)
Title:
Original Instance Date
The original date of a recurring appointment instance. -
RecurPattern: string
Title:
Pattern
Maximum Length:30
The recurring appointment for a specific week, for example, First, Second, Third, Fourth, Last. The recurrence can be monthly or yearly. -
RecurRecType: string
Title:
Recurrence Record Type
Maximum Length:1
Default Value:N
Either "I" for instance or "S" for series or "N" for non-recurring. Do not populate it if Activity is of type Task (Not for public usage). -
RecurSatFlag: boolean
Title:
Saturday
Maximum Length:1
Indicates if the activity recurs on Saturday. -
RecurSeriesId: integer
(int64)
Title:
Recurrence Series ID
The unique identifier for the series that links instances of a series together. -
RecurSunFlag: boolean
Title:
Sunday
Maximum Length:1
Indicates if the activity recurs on Sunday. -
RecurThuFlag: boolean
Title:
Thursday
Maximum Length:1
Indicates if the activity recurs on Thursday. -
RecurTueFlag: boolean
Title:
Tuesday
Maximum Length:1
Indicates if the activity recurs on Tuesday. -
RecurTypeCode: string
Title:
Recurrence Type
Maximum Length:30
Indicates how often an appointment recurs, for example: Daily, Weekly, Monthly, Yearly. -
RecurUpdatedAttributes: string
Title:
Recurrence Updated Attributes
Maximum Length:4000
The updated field references for recurring appointment exception records. -
RecurWedFlag: boolean
Title:
Wednesday
Maximum Length:1
Indicates if the activity recurs on Wednesday. -
RecurWeekday: string
Title:
Pattern Type
Maximum Length:30
The activity that recurs on every weekday, for example: Monday to Sunday, Weekday, Weekend, Day. -
ReferenceCustomerActTypeCode: string
Title:
Reference Customer Activity Type
Maximum Length:30
The type of the customer activity. To be used for configuration only. -
ReferenceCustomerId: integer
(int64)
Title:
Reference Customer
The unique identifier of the referenced customer who is associated with the activity. -
ReminderPeriod: string
Title:
Set Reminder
The time period before the start date and time of an activity when a reminder should be sent to the owner of the activity. -
ResourceNumber: string
Title:
Resource Number
Read Only:true
Maximum Length:30
The resource number of owner associated with the activity. -
ResponseCode: string
Title:
Response
The code indicating the response of the owner on an appointment. -
SalesObjectiveName: string
Title:
Sales Objective
The name of the sales objective associated with the activity. -
SalesObjectiveNumber: string
Title:
Sales Objective Number
The sales objective number of the sales objective associated with the activity. -
SearchDate: string
(date-time)
The date filter used in search (Not for public usage).
-
SelectedFlag: boolean
Default Value:
false
The records selected for Mass Update (Not for public usage). -
ShowStatus: string
Title:
Show
Maximum Length:255
Indicates whether the activity is open, complete, or all activities. -
ShowTimeAs: string
Title:
Show Time As
The choice of display of time on your calendar for an activity. -
SmartActionContext: string
Title:
Smart Action Context
Maximum Length:4000
The metadata associated with the smart action. -
SmartActionId: integer
(int64)
Title:
Smart Action ID
The unique identifier of the smart action. -
smartActions: array
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. -
SortDate: string
(date-time)
Title:
Date
The date used to sort the activities. The sort date can be the appointment start date, the task due date, or the task complete date. -
SourceObjectCode: string
The code indicating the source object associated with the activity.
-
SourceObjectId: integer
The unique identifier of the object associated with the activity.
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the related service request. -
SrNumber: string
Title:
Service Request
The alternate key identifier of the service request. -
StartDateForCallReport: string
(date-time)
The start date of the call report.
-
StartDateForCallReportAttr: string
(date-time)
The attribute for start date of the call report (Not for public usage).
-
StartDtRFAttr: string
(date-time)
The attribute for Activity Start Date (Not for public usage).
-
StatusCode: string
Title:
Status
Maximum Length:30
The code indicating the status of the activity. The default value is Not Started. A list of valid values is defined in the lookup ZMM_ACTIVITY_STATUS_CD. -
Subject: string
Title:
Subject
Maximum Length:500
The unique subject, name, or title of the activity. -
SubmittedBy: integer
(int64)
Title:
Submitted By
The user who submitted the Call Report. -
SubmittedByName: string
Title:
Submitted By
Maximum Length:255
The user who submitted the Call Report. -
SubmittedDate: string
(date-time)
Title:
Submitted Date
The date and time when the Call Report was submitted. -
SwitchCallId: string
Title:
Switch Call ID
Maximum Length:128
The unique identifier of the call, on the external phone system. -
TaskReminderPeriod: string
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. -
TemplateDuration: number
Title:
Template Duration
The duration in number of days, for the template activity. This attribute is used with the start date when generating an activity from a template in order to calculate the due date. -
TemplateFlag: string
Title:
Template
Maximum Length:1
Default Value:N
Indicates whether this is a template activity. -
TemplateId: integer
(int64)
Title:
Template ID
The unique identifier of the template. -
TemplateLeadTime: number
Title:
Lead Time
The lead time that is calculated from the activity start date, for the template activity. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the activity has been updated. The default value is true. -
UpgSourceObjectId: string
Read Only:
true
Maximum Length:64
The primary key value of the record in the source table that is upgraded to Rel9 Activity record. -
UpgSourceObjectType: string
Read Only:
true
Maximum Length:30
The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record. -
WebConferenceDetails: string
(byte)
Title:
Web Conference Details
The web conference details. -
WebConferenceId: string
Title:
Web Conference ID
Maximum Length:255
The unique identifier of the web conference. -
WebConferenceURL: string
Title:
Web Conference URL
Maximum Length:2000
The web conference join URL. -
WebconfSyncStatusFlag: boolean
Title:
Web Conference Synchronization
Maximum Length:1
The appointment interaction status.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
ActivityAssigneeId: integer
(int64)
The unique identifier for the activity assignee.
-
ActivityFunctionCode: string
Maximum Length:
30
The code indicating the function of the activity. -
ActivityId: integer
(int64)
Title:
Activity ID
The unique identifier of the parent activity. -
ActyActivityNumber: string
Title:
Activity Number
Maximum Length:64
The unique number of the activity. The number can also be generated from an external source. -
AssigneeId: integer
(int64)
Title:
Assignee ID
The unique identifier of the assignee associated with the activity. -
AssigneeName: string
Title:
Name
The name of the assignee. -
AssigneePartyNumber: string
The alternate key identifier of the activity resource.
-
AtkMessageId: integer
(int64)
The identifier for the ATK popup notification created.
-
AttendeeFlag: boolean
Title:
Attendance
Maximum Length:1
Default Value:true
Indicates if the resource attended the activity. If True, the resource attended. -
ConflictId: integer
(int64)
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. -
CorpCurrencyCode: string
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the activity assignee. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of when the activity assignee was created. -
CurcyConvRateType: string
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. -
CurrencyCode: string
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. -
DismissFlag: boolean
Title:
Dismissed
Maximum Length:1
Default Value:false
Indicates if the activity has been dismissed. The default value is false. -
JobName: string
Title:
Title
The job name for the activity assignee. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when data related to an activity assignee was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The unique identifier of the user who last updated the activity assignee. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the activity assignee. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Phone: string
Title:
Phone
The phone number of the contact. -
PrimaryAssigneeFlag: string
Title:
Owner
The primary assignee for an Activity. -
PrimaryEmail: string
Title:
Email
The e-mail address of the activity assignee contact. -
PrimaryFormattedAddress: string
The primary formatted address information of an activity assignee.
-
RecurSeriesId: integer
(int64)
The unique identifier for the series that links instances of a series together.
-
ReminderDatetime: string
(date-time)
Title:
Reminder Time
The date and time to send the appointment reminder. -
ReminderPeriod: integer
(int32)
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. -
ResourceName: string
Title:
Name
Read Only:true
The name of activity resource. -
ResourceNumber: string
Title:
Resource Number
Read Only:true
Maximum Length:30
Resource Number of the resource associated with the activity. -
ResponseCode: string
Title:
Response
Maximum Length:30
Default Value:NOT_RESPONDED
The code indicating the response of a resource on an appointment. -
SenderJobId: integer
(int64)
Title:
Sender Job ID
The unique identifier of the sender job. -
ShowTimeAsCode: string
Title:
Show Time As
Maximum Length:30
The choice of display of time on your calendar for an appointment, for example: free, busy, tentative. -
SortDate: string
(date-time)
The date used to sort activities.
-
StatusCode: string
Maximum Length:
30
The status of the activity. -
TaskReminderPeriod: integer
(int32)
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. -
UpgSourceObjectId: integer
(int64)
Read Only:
true
The primary key value of the record in the source table that is upgraded to Rel9 Activity record. -
UpgSourceObjectType: string
Read Only:
true
Maximum Length:30
The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record. -
UserGuid: string
The unique identifier of user (Not for public usage).
-
UserGuid1: string
Read Only:
true
The unique identifier of the user (Not for public usage). -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date and time when the record was last updated by a user in the disconnect mode. -
UserName: string
The name of the user.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : activities-ActivityContact-item-response
Type:
Show Source
object
-
AccountId: integer
The unique identifier of the account.
-
ActivityContactId: integer
(int64)
Title:
Activity Contact ID
The unique identifier for the surrogate activity contact. -
ActivityId: integer
(int64)
Title:
Activity ID
The unique identifier of the parent activity for the objective. -
ActivityNumber: string
Maximum Length:
64
The unique number of the activity. The number can also be generated from an external source. -
ActyActivityNumber: string
Title:
Activity Number
Maximum Length:64
The unique number of the activity. The number can also be generated from an external source. -
Affinity: string
Read Only:
true
The affinity of an activity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
AttendeeFlag: boolean
Title:
Attendance
Maximum Length:1
Default Value:true
Indicates if the contact attended the activity. If True, the contact attended. -
BuyingRole: string
Title:
Buying Role
Read Only:true
The roles played by the activity contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
ConflictId: integer
(int64)
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. -
ContactAccount: string
Title:
Account
The account associated with the activity contact. -
ContactAccountId: integer
The unique identifier of the account associated with the activity contact.
-
ContactAccountType: string
The account type for the contact.
-
ContactCustomer: string
Title:
Contact Customer
The customer contact for the activity. -
ContactEmail: string
Title:
Email
The e-mail address of the activity contact. -
ContactId: integer
(int64)
Title:
Contact ID
The unique identifier of the contact associated with the activity. -
ContactJobTitle: string
Title:
Title
The job title of the activity contact. -
ContactLovSwitcher: string
Indicates contact LOV switcher (Not for public usage).
-
ContactName: string
Title:
Name
The name of the contact for the activity. -
ContactPartyNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The alternate key identifier of the activity contact. -
ContactPhone: string
Title:
Phone
The phone number of the activity contact. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency used by the activity contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the activity contact. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the activity contact was created. -
CurcyConvRateType: string
Maximum Length:
30
The rate of currency conversion for an activity contact. -
CurrencyCode: string
Maximum Length:
15
The currency used for an activity contact. -
DoNotCallFlag: boolean
Read Only:
true
Indicates whether the contact should be called. The default value is false. -
DoNotContactFlag: boolean
Read Only:
true
Indicates whether the activity contact should be contacted. The default value is false. -
DoNotEmailFlag: boolean
Read Only:
true
Indicates whether the contact should be emailed. The default value is false. -
EmailContactPreferenceFlag: string
Indicates the email contact preference.
-
ExternalContactEmail: string
Title:
External Contact Email
Maximum Length:320
The email address of the external contact. -
ExternalContactFlag: boolean
Title:
External Contact
Maximum Length:1
Default Value:false
Flag indicating that an activity is owned by an external contact. -
ExternalContactName: string
Title:
External Contact Name
Maximum Length:360
The name of an external contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time of when the activity contact was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The unique identifier of the user who last updated the activity contact. This is defaulted by the system. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the activity objective. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Read Only:true
The activity contact name. -
PhoneContactPreferenceFlag: string
Indicates the phone contact preference.
-
PrimaryContactFlag: boolean
Title:
Primary
Indicates if this contact is the primary contact. -
PrimaryFormattedAddress: string
The formatted address information of the activity contact.
-
RecurSeriesId: integer
(int64)
The unique identifier that links instances of a series together.
-
RelationshipId: integer
(int64)
Title:
Relationship ID
The unique identifier of the relationship of the contact. -
UpgSourceObjectId: integer
(int64)
Read Only:
true
The primary key value of the record in the source table that is upgraded to Rel9 Activity record. -
UpgSourceObjectType: string
Read Only:
true
Maximum Length:30
The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date and time of when the contact was last updated by a user in the disconnect mode.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : activities-ActivityObjectives-item-response
Type:
Show Source
object
-
ActivityId: integer
(int64)
Title:
Activity ID
The unique identifier of the parent activity. -
ActivityNumber: string
Maximum Length:
64
The unique number of the activity. The number can also be generated from an external source. -
ActivityObjective: string
Maximum Length:
255
The objective for the activity. -
ActyActivityNumber: string
Title:
Activity Number
Maximum Length:64
The unique number of the activity. The number can also be generated from an external source. -
AttributeCategory: string
Maximum Length:
30
The attribute category associated with the activity. -
CompletedFlag: boolean
Title:
Complete
Maximum Length:1
Indicates if the activity objective is completed. If True, the activity is completed. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier for the conflict in the activity objectives. -
CorpCurrencyCode: string
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. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the activity objective. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the activity objective was created. -
CurcyConvRateType: string
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. -
CurrencyCode: string
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. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the activity objective was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the activity objective. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the activity objective. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectiveCode: string
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. -
ObjectiveFreefmtText: string
Title:
Objective Text
Maximum Length:80
The text area to describe the objective of the activity. -
ObjectiveId: integer
(int64)
Title:
Objective ID
The unique identifier of the objective. -
RecurSeriesId: integer
(int64)
The unique identifier for the series that links instances of a series together.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : activities-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the image. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the type of the data in the attachment. For example, FILE, WEB_PAGE, or TEXT. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : activities-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship populated when the note is associated with a contact. -
CorpCurrencyCode: string
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the note was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the person who created the note. -
CurcyConvRateType: string
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. -
CurrencyCode: string
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. -
DeleteFlag: boolean
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. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time of when the note was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of a note. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The column to store the note text. -
NoteTypeCode: string
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. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the party associated with the note. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of the author of the note. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The source object code for the source object as defined in the objects metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the source object such as activities, opportunities, as defined in the objects metadata. -
UpdateFlag: boolean
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. -
VisibilityCode: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : activities-smartActions-item-response
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity: string
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. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether the smart suggest is enabled for the action. -
SystemActionFlag: boolean
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. -
UpdateOfAttributes: string
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. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique identifier of the smart action definition. -
UserActionName: string
Title:
Action Name
Maximum Length:256
The unique identifier of the smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
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. -
UserActionURLBinding: array
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
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. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
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. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value assigned to the value property of a name-value pair. -
ValueStruct: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : activities-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
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. -
URLBindingId: integer
(int64)
The unique identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- createActivitiesFromTemplate
-
This method lets you create activities from a template.
- createMultipleActivitiesFromTemplate
-
This method lets you create multiple activities from a template.
- sendNotificationToResources
-
This method lets you send notification to resources along with the details of the interaction.
- updateActivityWrapup
-
This method is used when an interaction or wrap up is created for an activity. It updates the value of this attribute.
Examples
The following example shows how to get all activities 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/
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items" : [ { "ActivityId" : 300100036212819, "ActivityNumber" : "CDRM_1007", "AccountId" : null, "ActivityCreatedBy" : "SALES_MANAGER", "ActivityCreationDate" : "2014-07-08T09:27:10-07:00", "ActivityPartialDescription" : null, "ActivityEndDate" : "2014-07-08T11:00:00-07:00", "RecordSet" : null, "ShowStatus" : null, "Subject" : "ghgh", "ActivityFunctionCodeTrans" : null, "ActivityFunctionCode" : "APPOINTMENT", "ActivityLastUpdateLogin" : "396B86F8D0E8B627E053780CF10A99D3", "ActivityStartDate" : "2014-07-08T10:00:00-07:00", "ActivityTypeCode" : "MEETING", "ActivityUpdateDate" : "2016-08-06T10:58:21-07:00", "ActivityUpdatedBy" : "SALES_ADMIN", "ActivityUserLastUpdateDate" : null, "AllDayFlag" : false, "AssessmentId" : null, "AutoLogSource" : null, "BuOrgId" : null, "CampaignId" : null, "ConflictId" : 0, "CreatedBy" : "SALES_MANAGER", - }