Get all activities
get
/crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity
Request
Path Parameters
-
TemplateId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
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> -
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 identifier related to the activities.
- ActivityNumberRowFinder Finds the unique identifier for an activity.
Finder Variables- ActivityNumber; string; The unique number of the activity.
- AppointmentsWithNoMyCallReport Finds appointments not having an associated call report.
Finder Variables- DateRange; integer; Finds appointments with no call reports within a date range.
- EndDtRFAttr; string; Finds appointments with no call reports based on appointment end date.
- StartDtRFAttr; string; Finds appointments with no call reports based on 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; Finds the recurring type code of an appointment for completed activities.
- Bind_TaskActFuncCd_BV; string; Finds the completed activities with a function code of task.
- Bind_TaskStatus_BV; string; Finds the status of the tasks.
- ForRollup Finds the activities associated with the rollups.
Finder Variables- AttributeName; string; The Rollup Attribute Name to identify a rollups.
- RollupId; string; The unique identifier of a rollup.
- SourceObject; string; The Source object code of a rollup.
- SourceObjectId; integer; The Source Object identifier of the party.
- GetActivitiesByActivityNumber Finds an activity with the specified activity number.
Finder Variables- ActivityNumber; string; The unique number of the activity
- GetListOfCallReports Finds the list of all call reports.
Finder Variables- AccountIdAttr; integer; Finds all call reports with the account identifier.
- EndDtRFAttr; string; Finds all call reports with the end date.
- LeadIdAttr; string; Finds all call reports with the lead identifier.
- OpportunityIdAttr; string; Finds all call reports with the opportunity identifier.
- StartDtRFAttr; string; Finds all call reports based with the start date.
- GetListOfCallReportsForPastAppt Finds call reports related to a past appointment.
Finder Variables- ParentActivityIdAttr; string; The parent activity identifier related to the call reports.
- MyActivitiesAsResource Finds activities where a specified user is a resource.
Finder Variables- Bind_UserResourceId; integer; Finds the resource identifier of the user.
- MyAppointmentsInDateRange Finds appointments within a data range.
Finder Variables- EndDtRFAttr; string; Finds the appointment with the end date.
- StartDtRFAttr; string; Finds the appointment with the start date.
- MyCallReportsInDateRange Finds call reports within a data range.
Finder Variables- AccountIdAttr; integer; Finds the account identifier related to the call reports.
- EndDtRFAttr; string; Finds the end date of the call reports.
- LeadIdAttr; string; Finds the lead identifier related to the call reports.
- OpportunityIdAttr; string; Finds the opportunity identifier related to the call reports.
- StartDtRFAttr; string; Finds the start date of the call reports.
- MyOpenActivities Finds all open activities owned by a specified user.
Finder Variables- Bind_Subject; string; Finds Open activities owned by a specified user.
- MyOpenTasks Finds tasks that have open status.
Finder Variables- Bind_LoggedInUserId_BV; integer; Finds open tasks based on the user identifier.
- 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 status Cancel.
- MyTasks Finds tasks owned by a specified user.
Finder Variables- Bind_LoggedInUserId_BV; integer; Finds the ID of the user who's logged into the application.
- Bind_TaskActFuncCd_BV; string; Finds the activities with a function code of my task.
- OpenActivities Finds all open activities.
Finder Variables- Bind_CurrentDate; string; Finds the date used to locate current activities.
- Bind_RecurSeriesType_BV; string; Finds the date used to locate current activities.
- Bind_TaskActFuncCd_BV; string; The open activities with a function code of task.
- Bind_TaskStatus_BV; string; Finds the status of the tasks associated to open activities.
- Bind_TaskStatus_Cancel_BV; string; Finds the tasks with a canceled status.
- OpenTasksByHighPriority Finds tasks with a priority value of high.
Finder Variables- Bind_LoggedInUserId_BV; integer; Finds the identifier of the user who's logged into the application.
- Bind_TaskActFuncCd_BV; string; Finds the activities with a function code of task.
- Bind_TaskPriority_BV; string; Finds the priority of the task.
- Bind_TaskStatus_BV; string; Finds the status of the task.
- Bind_TaskStatus_Cancel_BV; string; Find the tasks with a Cancel status.
- OverdueTasks Finds tasks with a due date in the past.
Finder Variables- Bind_CurrentDate; string; The date used to locate current tasks.
- Bind_CurrentUPTZDate; string; The date used to locate the Tasks whose due date is before the current date.
- Bind_LoggedInUserId_BV; integer; The identifier of the user who's logged into the application.
- Bind_TaskActFuncCd_BV; string; The activities with a function code of overdue task.
- Bind_TaskStatus_BV; string; The status of the tasks.
- Bind_TaskStatus_Cancel_BV; string; The overdue tasks with a status Cancel.
- PrimaryKey Finds the activity with the specified primary key identifier.
Finder Variables- ActivityId; integer; The unique identifier of an 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 account.
- AccountIdAttr; integer; The attribute for the account identifier. This attribute isn't for public usage.
- AccountNumber; string; The account number of the account associated with the activity.
- ActivityCreatedBy; string; The activity user who created the activity.
- ActivityCreationDate; string; The date when the activity was created.
- ActivityDescription; string; A text field for capturing some descriptive information about the activity.
- ActivityEndDate; string; The end date and time of an appointment, or the completion time of a task.
- ActivityFilter; string; An attribute to add additional activity filter.
- ActivityFunctionCode; string; The task vs appointment. This is for system use only.
- ActivityId; integer; System generated nonnullable primary key of the table.
- ActivityMtgMinutes; string; The activity meeting minutes.
- ActivityNumber; string; The alternate identifier of the activity.
- ActivityPartialDescription; string; A column that stores the first 4000 characters of activity description.
- ActivityStartDate; string; The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task.
- ActivitySubtypeCode; string; Displays a list of subtype values that are dependent on the value of the activity.
- ActivityTypeCode; string; The type or category of the activity.
- ActivityUpdateDate; string; The date when the activity was updated.
- AllDayFlag; boolean; Designates that an appointment is the entire day.
- AppointmentStatus; string; The status of the appointment.
- ArticleVersionId; string; The unique identifier of the article version.
- AssessmentId; integer; The unique identifier of the assessment.
- AssetId; integer; The unique identifier of the asset.
- AssetName; string; The name of the asset.
- AssetNumber; string; The alternate identifier of the asset.
- AssetSerialNumber; string; The serial number of the asset.
- AutoLogSource; string; For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same 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 business plan name associated to 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. This isn't for public usage.
- CallReportCount; integer; Indicates the number of call reports.
- CallReportUpcomingYN; string; Indicates Y,N,M for upcoming appointments.
- CallReportYN; string; Flag to Check if this activity has a Call Report
- CampaignId; integer; The unique identifier of the campaign.
- CampaignName; string; The name of the campaign associated to 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 name of the person who checks-in to a location.
- CheckedOutBy; string; The name of the person who checks-out to a location.
- CheckinDate; string; Stores the date and time when a user checks in to an appointment.
- CheckinLatitude; number; Stores the latitude of a location where a user checks in to an appointment.
- CheckinLongitude; number; Stores the longitude of a location where a user checks in to an appointment.
- CheckoutDate; string; Stores the date and time when a user checks out of an appointment.
- CheckoutLatitude; number; Stores the latitude of a location where a user checks out of an appointment.
- CheckoutLongitude; number; Stores the longitude of a location where a user checks out of an appointment.
- ClaimId; integer; The unique identifier of the claim.
- ClaimName; string; The name associated to the activity.
- ClaimNumber; string; The number of the claim associated with the activity.
- ConflictId; integer; The unique identifier of the conflict. This attribute isn't for public usage.
- ContactIDAttr; integer; The contact identifier.
- ContactNumber; string; The contact number of primary contact associated with the activity.
- CreatedBy; string; The user who created the activity.
- CreationDate; string; Attribute to capture the Date and Time the activity was created. This is defaulted by the application.
- CurrentDateForCallReport; string; Indicates the current date for the call report.
- CurrentDateForCallReportAttr; string; The attribute for the current date for the call report. This isn't for public usage.
- CurrentSystemDtTransient; string; The current system date.
- CustomerAccountId; integer; The unique identifier of the customer account.
- DealId; integer; The unique identifier of the related deal.
- DealNumber; string; The deal number associated to the activity.
- DelegatorId; integer; The activity resource that delegated activity ownership to another resource.
- DelegatorName; string; The name of activity resource that delegated activity ownership to another resource.
- DeleteFlag; boolean; Indicates whether the user has access to delete the record.
- DirectionCode; string; The inbound or outbound. It's optional. The default is null.
- DismissAssignee; string; Indicates whether the assignees is dismissed. Valid values are Y and N.
- DismissFlag; boolean; Indicates whether this activity is dismissed.
- DueDate; string; The date the task activity is due to be completed.
- EmailSentDate; string; This field is used to capture the Activity Email Notification shared date for Outlook integration.
- EndDateForCallReport; string; The end date of the call report.
- EndDateForCallReportAttr; string; The attribute for end date of the call report. This isn't for public use.
- EndDtRFAttr; string; The attribute for activity start date. This isn't for public use.
- ExternalContactEmail; string; The email address of an external contact.
- ExternalContactName; string; The name of an external contact.
- ExternallyOwnedFlag; boolean; Indicates that the activity isn't created by an internal resource.
- FundRequestId; integer; The unique identifier of the fund request.
- FundRequestName; string; The fund request name associated to 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 attribute to capture the date and time the activity was last updated.
- LastUpdatedBy; string; The attribute to capture the identifier of the user who last updated the activity.
- LeadId; integer; Indicates the related lead to the activity.
- LeadIdAttr; integer; The attribute for the lead identifier. This isn't for public use.
- LeadName; string; Indicates the lead name.
- LeadNumber; string; The lead number of lead associated with the activity.
- Location; string; Indicates the location of an appointment.
- LocationId; integer; The location or address ID of the activity account or primary contact.
- LoginUserRFAttr; integer; The attribute for activity login user. This isn't for public use.
- ObjectiveId; integer; The unique identifier of the objective.
- OpportunityId; integer; The unique identifier of the related opportunity.
- OpportunityIdAttr; integer; The attribute for the opportunity identifier. This isn't for public use.
- OpportunityName; string; The name of opportunity associated to the activity.
- OpportunityNumber; string; The opportunity number of the opportunity associated with the activity.
- OrchestrationId; integer; The unique identifier to identify the orchestration process.
- OrchestrationStepId; integer; The unique identifier to identify the orchestration step.
- OsnActivityId; integer; The unique identifier for an activity.
- OtherPartyPhoneNumber; string; For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called.
- OutcomeCode; string; The code of the outcome of the activity.
- OutlookAutoSyncFlag; boolean; Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365.
- OutlookFlag; boolean; Indicates whether the activity was created from Outlook and synced.
- OutlookGlobalId; string; The unique identifier of an appointment created from Microsoft 365.
- OutlookIdentifier; string; The unique identifier from outlook activity.
- OwnerId; integer; The primary resource on the activity. Supports resources only.
- OwnerName; string; The name of primary resource of activity.
- ParentActivityId; integer; The related activity identifier, only applicable if the record is a follow up activity.
- ParentActivityIdAttr; string; The attribute for the parent activity identifier. This isn't for public use.
- PartialMtgMinutes; string; A column that stores a truncated string of the meeting minutes.
- PartnerEnrollmentId; integer; The unique identifier of the partner 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 related partner program.
- PartnerProgramNumber; string; The partner program number of partner program associated with the activity.
- PercentageComplete; number; The numeric value 0 to100 to reflect the percent complete status of the activity. Free form numeric. Percentage value at end.
- PrimaryContactEmailAddress; string; Hold the email identifier of the primary contact.
- PrimaryContactId; integer; The primary contact of the activity.
- PrimaryContactName; string; The name of the primary contact.
- PriorityCode; string; The priority of the activity. Default to 2. Possible values: 1, 2, 3.
- PrivateFlag; boolean; Indicates whether the activity is private.
- RecordSet; string; The record set of the activity.
- RecurEndDate; string; Ends on a specified date.
- RecurExceptionFlag; boolean; Indicates if appointment instance has been updated outside of recurring appointment series.
- RecurRecType; string; For Internal Use Only. Either I for instance or S for series or N for nonrecurring. Don't populate it if Activity is of type Task.
- RecurSeriesId; integer; Series Id that links instances of a series together.
- RecurUpdatedAttributes; string; The updated field references for recurring appointment exception records.
- ReferenceCustomerId; integer; The identifier of the reference customer party associated with the activity.
- ResourceNumber; string; The resource number of owner associated with the activity.
- ResponseCode; string; The response code.
- SalesObjectiveName; string; The sales objective name associated to the activity.
- SalesObjectiveNumber; string; The sales objective number of the sales objective associated with the activity.
- SelectedFlag; boolean; The records selected for Mass Update.
- ShowStatus; string; Indicates whether the activity is open, complete, or all activities.
- SmartActionContext; string; Stores metadata needed for smart action.
- SmartActionId; integer; The smart action Identifier. Foreign key from zca_user_action.
- SortDate; string; This is an internal column which is used to sort the activity based on the due date for task and start date for activity.
- SrId; integer; The unique identifier of the service request.
- SrNumber; string; The service request number.
- StartDateForCallReport; string; The start date of the call report.
- StartDateForCallReportAttr; string; The attribute for start date of the call report.
- StartDtRFAttr; string; The attribute for activity start date.
- StatusCode; string; Status of the activity. Defaulted to NOT_STARTED.
- Subject; string; The subject of the activity.
- SubmittedByName; string; The name of the call report submitter.
- SubmittedDate; string; The call report submission date.
- TemplateFlag; string; Indicates whether this is a template activity.
- TemplateId; integer; The unique identifier of the template associated to the activity.
- UpdateFlag; boolean; Indicates whether the user has access to update the record.
- UpgSourceObjectId; string; The unique identifier for source object.
- 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: string
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: string
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 : activityTemplates-Activity
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : activityTemplates-Activity-item-response
Type:
Show Source
object-
AccountAddress: string
Title:
Account AddressRead Only:trueThe address of the account associated with the activity. -
AccountId: integer
(int64)
Title:
Account IDThe unique identifier of the account. -
AccountIdAttr: integer
The attribute for the account identifier. This attribute isn't for public usage.
-
AccountName: string
Title:
AccountThe name of the account associated to activity. -
AccountNameOsn: string
Title:
Social Account NameThe account name displayed in Oracle Social Network. -
AccountNumber: string
Title:
Account NumberRead Only:trueMaximum Length:30The account number of the account associated with the activity. -
AccountPhoneNumber: string
Title:
Account Phone NumberRead Only:trueThe phone number of the account associated with the activity. -
AccountStatus: string
Read Only:
trueMaximum Length:1The status of the account. -
AccountType: string
Read Only:
trueMaximum Length:30Indicates the type of the account. -
ActivityCreatedBy: string
Title:
Activity Created ByRead Only:trueMaximum Length:64The activity user who created the activity. -
ActivityCreationDate: string
(date-time)
Title:
Activity Creation DateRead Only:trueThe date when the activity was created. -
ActivityDescription: string
(byte)
Title:
DescriptionA text field for capturing some descriptive information about the activity. -
ActivityDirection: string
Read Only:
trueThe code indicating the direction of an activity. -
ActivityEndDate: string
(date-time)
Title:
End DateThe end date and time of an appointment, or the completion time of a task. -
ActivityFilter: string
Read Only:
trueAn attribute to add additional activity filter. -
ActivityFunctionCode: string
Title:
ActivityMaximum Length:30The task vs appointment. This is for system use only. -
ActivityFunctionCodeTrans: string
Title:
ActivityMaximum Length:255The activity function code. -
ActivityId: integer
(int64)
Title:
Activity IDSystem generated nonnullable primary key of the table. -
ActivityLastUpdateLogin: string
Title:
Activity Last Update LoginRead Only:trueMaximum Length:32Original Activity Last Update Login -
ActivityMtgMinutes: string
(byte)
Title:
Meeting MinutesThe activity meeting minutes. -
ActivityNumber: string
Title:
Activity NumberMaximum Length:64The alternate identifier of the activity. -
ActivityOutcome: string
Read Only:
trueThe outcome of the activity. -
ActivityPartialDescription: string
Title:
Short DescriptionMaximum Length:4000A column that stores the first 4000 characters of activity description. -
ActivityPriority: string
Title:
PriorityIndicates the priority of the activity. This attribute isn't for public usage. -
ActivityStartDate: string
(date-time)
Title:
Start DateThe start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task. -
ActivityStatus: string
Title:
StatusRead Only:trueIndicates the status of the activity. -
ActivitySubtypeCode: string
Title:
SubtypeMaximum Length:30Displays 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 user's timezone preference.
-
ActivityType: string
Title:
Activity TypeThe type of the activity. -
ActivityTypeCode: string
Title:
TypeMaximum Length:30The type or category of the activity. -
ActivityUpdateDate: string
(date-time)
Title:
Activity Updated DateRead Only:trueThe date when the activity was updated. -
ActivityUpdatedBy: string
Title:
Activity Updated ByRead Only:trueMaximum Length:64The user who updated the activity. -
ActivityUserLastUpdateDate: string
(date-time)
Title:
Activity User Last Updated DateRead Only:trueThe date when the activity was last updated. -
AllDayFlag: boolean
Title:
All DayMaximum Length:1Default Value:falseDesignates that an appointment is the entire day. -
AppointmentStatus: string
Title:
Appointment StatusMaximum Length:30The status of the appointment. -
ApptEndTime: string
(date-time)
Title:
End TimeIndicates the appointment end time. -
ApptStartTime: string
(date-time)
Title:
Start TimeIndicates the appointment start time. -
ArticleVersionId: string
Title:
Article Version IDMaximum Length:64The unique identifier of the article version. -
AssessmentId: integer
(int64)
Title:
Assessment IDThe unique identifier of the assessment. -
AssetId: integer
(int64)
Title:
Asset IDThe unique identifier of the asset. -
AssetName: string
Title:
AssetThe name of the asset. -
AssetNumber: string
Title:
Asset NumberThe alternate identifier of the asset. -
AssetSerialNumber: string
Title:
Asset Serial NumberRead Only:trueMaximum Length:100The serial number of the asset. -
AttachmentEntityName: string
Maximum Length:
255Default Value:ZMM_ACTY_ACTIVITIESThe name of the attachment entity. -
Attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
AutoLogSource: string
Title:
Source SystemMaximum Length:30For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same activity. -
BpId: integer
(int64)
Title:
Business Plan IDThe unique identifier of the business plan. -
BuOrgId: integer
(int64)
Title:
Business UnitThe unique identifier for the Business Unit. This attribute is obsolete. -
BusinessPlanName: string
Title:
Business PlanThe business plan name associated to the activity. -
BusinessPlanNumber: string
Title:
Business Plan NumberThe business plan number of the business plan associated with the activity. -
CalendarAccess: boolean
The access rights to calendar. This isn't 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. This isn't for public usage.
-
CallReportCount: integer
(int32)
Title:
Call Report CountDefault Value:0Indicates the number of call reports. -
CallReportUpcomingYN: string
Indicates Y,N,M for upcoming appointments.
-
CallReportYN: string
Flag to Check if this activity has a Call Report
-
CampaignId: integer
(int64)
Title:
Campaign IDThe unique identifier of the campaign. -
CampaignName: string
Title:
CampaignThe name of the campaign associated to the activity. -
CampaignNumber: string
Title:
Campaign NumberThe campaign number of the campaign associated with the activity. -
CaseId: integer
(int64)
Title:
Case IDThe unique identifier of the case. -
CaseNumber: string
Title:
Case NumberThe alternate identifier of the case. -
CaseTitle: string
Title:
TitleRead Only:trueMaximum Length:400The title of the case. -
CheckedInBy: string
Title:
Checked-In ByMaximum Length:64The name of the person who checks-in to a location. -
CheckedOutBy: string
Title:
Checked-Out ByMaximum Length:64The name of the person who checks-out to a location. -
CheckinDate: string
(date-time)
Title:
Check-In TimeStores the date and time when a user checks in to an appointment. -
CheckinLatitude: number
Title:
Check-In LatitudeStores the latitude of a location where a user checks in to an appointment. -
CheckinLongitude: number
Title:
Check-In LongitudeStores the longitude of a location where a user checks in to an appointment. -
CheckoutDate: string
(date-time)
Title:
Check-Out TimeStores the date and time when a user checks out of an appointment. -
CheckoutLatitude: number
Title:
Check-Out LatitudeStores the latitude of a location where a user checks out of an appointment. -
CheckoutLongitude: number
Title:
Check-Out LongitudeStores the longitude of a location where a user checks out of an appointment. -
ClaimId: integer
(int64)
Title:
Claim IDThe unique identifier of the claim. -
ClaimName: string
Title:
MDF ClaimThe name associated to the activity. -
ClaimNumber: string
Title:
Claim NumberThe number of the claim associated with the activity. -
ConflictId: integer
(int64)
Default Value:
0The unique identifier of the conflict. This attribute isn't for public usage. -
ContactIDAttr: integer
The contact identifier.
-
ContactNumber: string
Title:
Contact NumberRead Only:trueMaximum Length:30The contact number of primary contact associated with the activity. -
CorpCurrencyCode: string
Title:
Corporate CurrencyMaximum Length:15The corporate currency code from profile. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the activity. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueAttribute to capture the Date and Time the activity was created. This is defaulted by the application. -
CurcyConvRateType: string
Title:
Currency Conversion RateMaximum Length:30Holds the currency code of a record. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15Holds the currency conversion rate type from profile. -
CurrentDateForCallReport: string
(date-time)
Indicates the current date for the call report.
-
CurrentDateForCallReportAttr: string
(date-time)
The attribute for the current date for the call report. This isn't for public usage.
-
CurrentSystemDtTransient: string
(date)
Read Only:
trueThe current system date. -
CustomerAccountId: integer
(int64)
Title:
Customer Account IDThe unique identifier of the customer account. -
DealId: integer
(int64)
Title:
Deal IDThe unique identifier of the related deal. -
DealNumber: string
Title:
Deal RegistrationThe deal number associated to the activity. -
DelegatorId: integer
(int64)
Title:
Delegator IDThe activity resource that delegated activity ownership to another resource. -
DelegatorName: string
Title:
Delegated ByThe name of activity resource that delegated activity ownership to another resource. -
DeleteFlag: boolean
Read Only:
trueIndicates whether the user has access to delete the record. -
DerivedAccountId: integer
The unique identifier of the derived account.
-
DirectionCode: string
Title:
DirectionMaximum Length:30The inbound or outbound. It's optional. The default is null. -
DismissAssignee: string
Title:
DismissedIndicates whether the assignees is dismissed. Valid values are Y and N. -
DismissFlag: boolean
Title:
DismissedMaximum Length:1Indicates whether this activity is dismissed. -
DoNotCallFlag: boolean
Read Only:
trueFlag to indicate if primary Contact can be called. -
DueDate: string
(date)
Title:
Due DateThe date the task activity is due to be completed. -
Duration: number
Title:
DurationThe duration of an appointment or task. -
DynamicClaimLOVSwitcher: string
Read Only:
trueThe dynamic claim switcher. -
EmailSentDate: string
(date-time)
This field is used to capture the Activity Email Notification shared date for Outlook integration.
-
EndDateForCallReport: string
(date-time)
The end date of the call report.
-
EndDateForCallReportAttr: string
(date-time)
The attribute for end date of the call report. This isn't for public use.
-
EndDtRFAttr: string
(date-time)
The attribute for activity start date. This isn't for public use.
-
ExternalContactEmail: string
Title:
Primary EmailMaximum Length:320The email address of an external contact. -
ExternalContactName: string
Title:
External Contact NameMaximum Length:360The name of an external contact. -
ExternallyOwnedFlag: boolean
Title:
Externally OwnedMaximum Length:1Default Value:falseIndicates that the activity isn't created by an internal resource. -
FundRequestId: integer
(int64)
Title:
Fund Request IDThe unique identifier of the fund request. -
FundRequestName: string
Title:
MDF RequestThe fund request name associated to the activity. -
FundRequestNumber: string
Title:
Fund Request NumberThe fund request number of the fund request associated with the activity. -
IbAssetId: integer
(int64)
Title:
IB Asset IDThe unique identifier of the installed base asset associated with the activity. -
IbAssetNumber: string
Title:
Installed Base AssetThe number of the installed base asset associated with the activity. -
IbAssetSerialNumber: string
Title:
Installed Base Asset Serial NumberRead Only:trueMaximum Length:80The serial number of the installed base asset associated with the activity. -
InstNumDerivedFrom: string
Default Value:
YThe attribute to identify recurrence mode. This isn't for public use. -
IsClientService: string
Default Value:
YThe obsolete attribute. This isn't for public use. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe attribute to capture the date and time the activity was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The attribute to capture the identifier of the user who last updated the activity. -
LastUpdateLogin: string
Title:
Last Updated LoginRead Only:trueMaximum Length:32The attribute to capture the identifiers of the user who last updated the activity. -
LeadId: integer
(int64)
Title:
Lead IDIndicates the related lead to the activity. -
LeadIdAttr: integer
The attribute for the lead identifier. This isn't for public use.
-
LeadName: string
Title:
LeadIndicates the lead name. -
LeadNameOsn: string
Title:
Social Lead NameThe lead name displayed in Oracle Social Network. -
LeadNumber: string
Title:
Lead NumberThe lead number of lead associated with the activity. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Location: string
Title:
LocationMaximum Length:200Indicates the location of an appointment. -
LocationId: integer
(int64)
Title:
Location IDThe location or address ID of the activity account or primary contact. -
LoginUserRFAttr: integer
The attribute for activity login user. This isn't for public use.
-
MdfRequestId: integer
The identifier for fund request.
-
MobileActivityCode: string
Title:
Mobile Activity CodeMaximum Length:50The unique identifier of external mobile device. -
NotesLinkSourceCodeTransient: string
Read Only:
trueThe note source object. -
ObjectiveId: integer
(int64)
Title:
Objective IDThe unique identifier of the objective. -
OpportunityId: integer
(int64)
Title:
Opportunity IDThe unique identifier of the related opportunity. -
OpportunityIdAttr: integer
The attribute for the opportunity identifier. This isn't for public use.
-
OpportunityName: string
Title:
OpportunityThe name of opportunity associated to the activity. -
OpportunityNameOsn: string
Title:
Social Opportunity NameThe opportunity name displayed in Oracle Social Network. -
OpportunityNumber: string
Title:
Opportunity NumberThe opportunity number of the opportunity associated with the activity. -
OrchestrationId: integer
(int64)
Title:
Orchestration IDThe unique identifier to identify the orchestration process. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step IDThe unique identifier to identify the orchestration step. -
OrigEntityCode: string
Maximum Length:
30Default Value:ACTIVITYThe column to store the source of activity record during upgrade. -
OrigEntityNumber: string
Maximum Length:
64The column to store the original user key of the object being upgraded to activity. -
OsnActivityId: integer
(int64)
The unique identifier for an activity.
-
OtherPartyPhoneNumber: string
Title:
Other Party Phone NumberMaximum Length:40For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called. -
OutcomeCode: string
Title:
OutcomeMaximum Length:30The code of the outcome of the activity. -
OutlookAutoSyncFlag: boolean
Title:
Microsoft Auto-SynchronizationMaximum Length:1Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365. -
OutlookFlag: boolean
Title:
OutlookMaximum Length:1Default Value:falseIndicates whether the activity was created from Outlook and synced. -
OutlookGlobalId: string
Title:
Outlook Global IDMaximum Length:1024The unique identifier of an appointment created from Microsoft 365. -
OutlookIdentifier: string
Title:
Outlook IdentifierMaximum Length:1024The unique identifier from outlook activity. -
OwnerAddress: string
Title:
Activity Owner AddressRead Only:trueThe activity owner's address. -
OwnerEmailAddress: string
Title:
Activity Owner EmailRead Only:trueMaximum Length:320The activity owner's email address. -
OwnerId: integer
(int64)
Title:
Owner IDThe primary resource on the activity. Supports resources only. -
OwnerName: string
Title:
OwnerMaximum Length:360The name of primary resource of activity. -
OwnerNameOsn: string
Title:
Social Owner NameThe owner name displayed in Oracle Social Network. -
OwnerPhoneNumber: string
Title:
Activity Owner Phone NumberRead Only:trueThe activity owner's phone number. -
ParentActivityId: integer
(int64)
Title:
Parent IDThe related activity identifier, only applicable if the record is a follow up activity. -
ParentActivityIdAttr: string
The attribute for the parent activity identifier. This isn't for public use.
-
PartialMtgMinutes: string
Title:
Short Meeting MinutesMaximum Length:4000A column that stores a truncated string of the meeting minutes. -
PartnerEnrollmentId: integer
(int64)
Title:
Enrollment IDThe unique identifier of the partner enrollment. -
PartnerEnrollmentNumber: string
Title:
Enrollment NumberThe surrogate key for partner enrollment. -
PartnerPartyId: integer
(int64)
Title:
Partner Party IDThe party identifier of the partner organization. -
PartnerPartyName: string
Title:
PartnerMaximum Length:80The party name of the partner organization. -
PartnerPartyNumber: string
Title:
Partner NumberThe partner party number of partner associated with the activity. -
PartnerProgramId: integer
(int64)
Title:
Partner Program IDThe related partner program. -
PartnerProgramName: string
Title:
ProgramThe name of partner program associated to the activity. -
PartnerProgramNumber: string
Title:
Program NumberThe partner program number of partner program associated with the activity. -
PartnerUsageFlag: boolean
Title:
Partner UsageMaximum Length:1Default Value:falseFlag to indicate that the Activity has been created for an Organization Account with usage as Partner. -
PercentageComplete: number
Title:
Percentage CompleteDefault Value:0The numeric value 0 to100 to reflect the percent complete status of the activity. Free form numeric. Percentage value at end. -
PrimaryContactEmailAddress: string
Title:
Primary EmailRead Only:trueMaximum Length:320Hold the email identifier of the primary contact. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact IDThe primary contact of the activity. -
PrimaryContactName: string
Title:
Primary ContactThe name of the primary contact. -
PrimaryContactNameOsn: string
Title:
Social Primary Contact NameThe contact name displayed in Oracle Social Network. -
PrimaryFormattedAddress: string
Title:
Primary Contact AddressRead Only:trueThe address of the primary contact. -
PrimaryFormattedPhoneNumber: string
Title:
PhoneRead Only:trueThe phone number of the primary contact. -
PriorityCode: string
Title:
PriorityMaximum Length:30The priority of the activity. Default to 2. Possible values: 1, 2, 3. -
PrivateFlag: boolean
Title:
PrivateMaximum Length:1Indicates whether the activity is private. -
RecordSet: string
Title:
Record SetMaximum Length:255The record set of the activity. -
RecurDay: integer
(int64)
Title:
DayRepeat on specified day of month for monthly appointments. -
RecurEndDate: string
(date-time)
Title:
EndsEnds on a specified date. -
RecurEveryOptionFlag: boolean
Title:
Recurrence OptionMaximum Length:1It's set to indicate if the recurrence occurs for every day, month, year, and so on. For example, a daily recurring appointment can occur every day of the week or weekdays only. If it's everyday of the week, it's set to Y if it's weekdays only, it's set to N. -
RecurExceptionFlag: boolean
Title:
Recurrence ExceptionMaximum Length:1Indicates if appointment instance has been updated outside of recurring appointment series. -
RecurFrequency: number
Title:
RepeatFrequency that the recurring appointment series repeats. -
RecurFriFlag: boolean
Title:
FridayMaximum Length:1Repeat on Friday. -
RecurMonFlag: boolean
Title:
MondayMaximum Length:1Repeat on Monday. -
RecurMonth: string
Title:
MonthMaximum Length:30Repeat on specified month (for yearly appointments). -
RecurNumberOfInstances: number
Title:
Number of InstancesDesignates specific number of occurrences for the series to end after. -
RecurOrigInstDate: string
(date-time)
Title:
Original Instance DateOriginal date of a recurring appointment instance. -
RecurPattern: string
Title:
PatternMaximum Length:30Designates which week for appointment to recur for monthly and yearly appointments. Possible values: First, Second, Third, Fourth, Last. -
RecurRecType: string
Title:
Recurrence Record TypeMaximum Length:1Default Value:NFor Internal Use Only. Either I for instance or S for series or N for nonrecurring. Don't populate it if Activity is of type Task. -
RecurSatFlag: boolean
Title:
SaturdayMaximum Length:1Repeat on Saturday. -
RecurSeriesId: integer
(int64)
Title:
Recurrence Series IDSeries Id that links instances of a series together. -
RecurSunFlag: boolean
Title:
SundayMaximum Length:1Repeat on Sunday. -
RecurThuFlag: boolean
Title:
ThursdayMaximum Length:1Repeat on Thursday. -
RecurTueFlag: boolean
Title:
TuesdayMaximum Length:1Repeat on Tuesday. -
RecurTypeCode: string
Title:
Recurrence TypeMaximum Length:30Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, Yearly. -
RecurUpdatedAttributes: string
Title:
Recurrence Updated AttributesMaximum Length:4000The updated field references for recurring appointment exception records. -
RecurWedFlag: boolean
Title:
WednesdayMaximum Length:1Repeat on Wednesday. -
RecurWeekday: string
Title:
Pattern TypeMaximum Length:30It works in conjunction with RecurPattern attribute. Possible values: Monday to Sunday, Weekday, Weekend, Day. -
ReferenceCustomerActTypeCode: string
Title:
Reference Customer Activity TypeMaximum Length:30The activity type for a reference customer activity. To be used as an extension only. -
ReferenceCustomerId: integer
(int64)
Title:
Reference CustomerThe identifier of the reference customer party associated with the activity. -
ReminderPeriod: string
Title:
Set ReminderThe reminder period. -
ResourceNumber: string
Title:
Resource NumberRead Only:trueMaximum Length:30The resource number of owner associated with the activity. -
ResponseCode: string
Title:
ResponseThe response code. -
SalesObjectiveName: string
Title:
Sales ObjectiveThe sales objective name associated to the activity. -
SalesObjectiveNumber: string
Title:
Sales Objective NumberThe sales objective number of the sales objective associated with the activity. -
SearchDate: string
(date-time)
The date filter used in search.
-
SelectedFlag: boolean
Default Value:
falseThe records selected for Mass Update. -
ShowStatus: string
Title:
ShowMaximum Length:255Indicates whether the activity is open, complete, or all activities. -
ShowTimeAs: string
Title:
Show Time AsThe show time of the activity. -
SmartActionContext: string
Title:
Smart Action ContextMaximum Length:4000Stores metadata needed for smart action. -
SmartActionId: integer
(int64)
Title:
Smart Action IDThe smart action Identifier. Foreign key from zca_user_action. -
smartActions: array
Smart Actions
Title:
Smart ActionsThis VO stores the endpoint and security details for every user action. -
SortDate: string
(date-time)
Title:
DateThis is an internal column which is used to sort the activity based on the due date for task and start date for activity. -
SourceObjectCode: string
The code of the object to which activity will get related to.
-
SourceObjectId: integer
The identifier of the object to which activity will get related to.
-
SrId: integer
(int64)
Title:
Service Request IDThe unique identifier of the service request. -
SrNumber: string
Title:
Service RequestThe service request number. -
StartDateForCallReport: string
(date-time)
The start date of the call report.
-
StartDateForCallReportAttr: string
(date-time)
The attribute for start date of the call report.
-
StartDtRFAttr: string
(date-time)
The attribute for activity start date.
-
StatusCode: string
Title:
StatusMaximum Length:30Status of the activity. Defaulted to NOT_STARTED. -
Subject: string
Title:
SubjectMaximum Length:500The subject of the activity. -
SubmittedBy: integer
(int64)
Title:
Submitted ByThe call report submitter. -
SubmittedByName: string
Title:
Submitted ByMaximum Length:255The name of the call report submitter. -
SubmittedDate: string
(date-time)
Title:
Submitted DateThe call report submission date. -
SwitchCallId: string
Title:
Switch Call IDMaximum Length:128The unique identifier of the call on the external phone system. -
TaskReminderPeriod: string
Title:
Due Date ReminderThe task reminder period. -
TemplateDuration: number
Title:
Template DurationThe duration in days of the template activity. This attribute is used with the start date when generating an activity from a template to calculate the due date. -
TemplateFlag: string
Title:
TemplateMaximum Length:1Default Value:NIndicates whether this is a template activity. -
TemplateId: integer
(int64)
Title:
Template IDThe unique identifier of the template associated to the activity. -
TemplateLeadTime: number
Title:
Lead TimeThe lead time in days of the template activity. This attribute is used with the date input parameter when generating an activity from a template to calculate the activity start date. Activity start date is equal date provided as input parameter and lead time. -
UpdateFlag: boolean
Read Only:
trueIndicates whether the user has access to update the record. -
UpgSourceObjectId: string
Read Only:
trueMaximum Length:64The unique identifier for source object. -
UpgSourceObjectType: string
Read Only:
trueMaximum Length:30The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record. -
WebConferenceDetails: string
(byte)
Title:
Web Conference DetailsThe web conference details. -
WebConferenceId: string
Title:
Web Conference IDMaximum Length:255The unique identifier of the web conference. -
WebConferenceURL: string
Title:
Web Conference URLMaximum Length:2000The web conference join URL. -
WebconfSyncStatusFlag: boolean
Title:
Web Conference SynchronizationMaximum Length:1The appointment interaction status.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Actions
Type:
arrayTitle:
Smart ActionsThis VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : activityTemplates-Activity-Attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : activityTemplates-Activity-smartActions-item-response
Type:
Show Source
object-
ActionIntent: string
(byte)
Title:
Action IntentJSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation MessageMaximum Length:4000A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content TypeMaximum Length:50The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action NameMaximum Length:256Consumer-friendly action name. -
Entity: string
Title:
Parent EntityMaximum Length:150REST Resources the action belongs to. -
Href: string
Title:
REST EndpointMaximum Length:1024The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512List of applications that this action can be used in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP MethodMaximum Length:15HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function associated with the smart action. -
PageType: string
Title:
Page TypeMaximum Length:256The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart SuggestMaximum Length:1Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action IDUniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action NameMaximum Length:256Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
PriorityNumber to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload DefinitionsIf an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
arrayTitle:
Smart Action REST Payload DefinitionsIf an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
arrayTitle:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Show Source
Nested Schema : activityTemplates-Activity-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object-
Binding: string
Title:
Payload Value Binding TypeMaximum Length:64Indicates the binding type of the value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute NameMaximum Length:256The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean value. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : activityTemplates-Activity-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object-
Binding: string
Title:
URL Binding TypeMaximum Length:64This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- createActivitiesFromTemplate
-
Parameters:
- TemplateId:
$request.path.TemplateId
This method lets you create activities from a template. - TemplateId:
- createMultipleActivitiesFromTemplate
-
Parameters:
- TemplateId:
$request.path.TemplateId
This method lets you create multiple activities from a template. - TemplateId:
- generateActivitySummary
-
Parameters:
- TemplateId:
$request.path.TemplateId
Generate Activity Summary - TemplateId:
- sendNotificationToResources
-
Parameters:
- TemplateId:
$request.path.TemplateId
This method lets you send notification to resources along with the details of the interaction. - TemplateId:
- updateActivityWrapup
-
Parameters:
- TemplateId:
$request.path.TemplateId
This method is used when an interaction or wrap up is created for an activity. It updates the value of this attribute. - TemplateId:
Examples
The following example shows how to get all activities of an activity template by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity
Example of Response Body
The following shows an example of the response body in JSON format.
{
"items": [
{
"ActivityId": 300100581270692,
"TemplateId": 300100581270691,
"TemplateFlag": "Y",
"ActivityNumber": "CDRM_92501",
"AccountId": null,
"PartnerUsageFlag": false,
"ActivityCreatedBy": "SALES_ADMIN",
"ActivityCreationDate": "2023-06-20T20:18:15.205+00:00",
"ActivityPartialDescription": null,
"ActivityFunctionCode": "APPOINTMENT",
"StatusCode": null,
"ActivityEndDate": null,
"RecordSet": null,
"ShowStatus": null,
"Subject": "2301560980078_STAGE1STEP3APPSUB",
"ActivityFunctionCodeTrans": null,
"ActivityLastUpdateLogin": "FDFE6280F5995238E0535F10060A7BBD",
"ActivityStartDate": null,
"ActivityTypeCode": "MEETING",
"ActivityUpdateDate": "2023-06-20T20:18:15.624+00:00",
"ActivityUpdatedBy": "SALES_ADMIN",
"ActivityUserLastUpdateDate": null,
"AllDayFlag": false,
"AssessmentId": null,
"AutoLogSource": null,
"BuOrgId": null,
"CampaignId": null,
"ConflictId": 0,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2023-06-20T20:18:15.205+00:00",
"CustomerAccountId": null,
"DirectionCode": null,
"DueDate": null,
"Duration": null,
"LastUpdateDate": "2023-06-20T20:18:15.624+00:00",
"LastUpdateLogin": "FDFE6280F5995238E0535F10060A7BBD",
"LastUpdatedBy": "SALES_ADMIN",
"LeadId": null,
"Location": null,
"MobileActivityCode": null,
"OpportunityId": null,
"OtherPartyPhoneNumber": null,
"OutcomeCode": null,
"OutlookFlag": false,
"OutlookIdentifier": null,
"ExternalContactEmail": null,
"ExternalContactName": null,
"ExternallyOwnedFlag": false,
"OwnerId": 100010025532672,
"ParentActivityId": null,
"PercentageComplete": 0,
"PrimaryContactId": null,
"PriorityCode": null,
"RecurDay": null,
"RecurEndDate": null,
"RecurEveryOptionFlag": null,
"RecurExceptionFlag": null,
"RecurFrequency": null,
"RecurFriFlag": null,
"RecurMonFlag": null,
"RecurMonth": null,
"RecurNumberOfInstances": null,
"RecurOrigInstDate": null,
"RecurPattern": null,
"RecurRecType": "N",
"RecurSatFlag": null,
"RecurSeriesId": null,
"RecurSunFlag": null,
"RecurThuFlag": null,
"RecurTueFlag": null,
"RecurTypeCode": null,
"RecurUpdatedAttributes": null,
"RecurWedFlag": null,
"RecurWeekday": null,
"ReferenceCustomerActTypeCode": null,
"ReferenceCustomerId": null,
"SortDate": null,
"SwitchCallId": null,
"TemplateDuration": 5,
"TemplateLeadTime": null,
"NotesLinkSourceCodeTransient": "ACTIVITY",
"AttachmentEntityName": "ZMM_ACTY_ACTIVITIES",
"AccountName": null,
"OwnerName": "Gabrielle Lee",
"PrimaryContactName": null,
"LeadName": null,
"OpportunityName": null,
"CampaignName": null,
"CurcyConvRateType": "Corporate",
"CurrencyCode": "USD",
"CorpCurrencyCode": "USD",
"PartnerProgramId": null,
"ActivityType": "Meeting",
"CurrentSystemDtTransient": "2025-03-17",
"ActivityPriority": null,
"ApptEndTime": null,
"ApptStartTime": null,
"AccountAddress": null,
"AccountPhoneNumber": null,
"CalendarSubject": "2301560980078_STAGE1STEP3APPSUB",
"CalendarRecurType": "SINGLE",
"CalendarTimeType": "TIME",
"ActivityStatus": null,
"OsnActivityId": 300100581270692,
"AccountType": null,
"PartnerEnrollmentId": null,
"PartnerProgramName": null,
"PartnerEnrollmentNumber": null,
"SourceObjectCode": null,
"SourceObjectId": null,
"ShowTimeAs": "BUSY",
"ResponseCode": "ACCEPT",
"ReminderPeriod": "-1",
"AccountNameOsn": null,
"LeadNameOsn": null,
"OpportunityNameOsn": null,
"PrimaryContactNameOsn": null,
"OwnerNameOsn": "Gabrielle Lee",
"InstNumDerivedFrom": null,
"UpgSourceObjectId": null,
"UpgSourceObjectType": null,
"IsClientService": null,
"OrigEntityCode": "ACTIVITY",
"OrigEntityNumber": "CDRM_92501",
"SearchDate": null,
"StartDtRFAttr": null,
"EndDtRFAttr": null,
"LoginUserRFAttr": 100010025532672,
"PrivateFlag": null,
"CallReportYN": "N",
"AccountIdAttr": null,
"OpportunityIdAttr": null,
"LeadIdAttr": null,
"PrimaryContactEmailAddress": null,
"PrimaryFormattedPhoneNumber": null,
"ParentActivityIdAttr": null,
"CallReportCount": 0,
"StartDateForCallReport": null,
"EndDateForCallReport": null,
"StartDateForCallReportAttr": null,
"EndDateForCallReportAttr": null,
"CallReportUpcomingYN": "N",
"CurrentDateForCallReport": null,
"CurrentDateForCallReportAttr": null,
"PartialMtgMinutes": null,
"DealId": null,
"DealNumber": null,
"ContactIDAttr": null,
"CalendarSubjectDay": "2301560980078_STAGE1STEP3APPSUB",
"DelegatorId": null,
"DelegatorName": null,
"AccountStatus": null,
"SubmittedBy": null,
"SubmittedDate": null,
"SubmittedByName": null,
"SrId": null,
"SrNumber": null,
"DismissFlag": null,
"ActivityFilter": null,
"BpId": null,
"FundRequestId": null,
"ObjectiveId": null,
"ClaimId": null,
"SalesObjectiveName": null,
"BusinessPlanName": null,
"ClaimName": null,
"DynamicClaimLOVSwitcher": null,
"FundRequestName": null,
"MdfRequestId": null,
"CalendarAccess": "true",
"ActivityTimezone": null,
"UpdateFlag": true,
"DeleteFlag": true,
"DerivedAccountId": null,
"SelectedFlag": null,
"LocationId": null,
"OwnerPhoneNumber": "+1 (650) 506-6601",
"OwnerAddress": "100 Palmer Ave,Unit 1,BELMONT, CA 94002",
"OwnerEmailAddress": "gopikannan.mariappan@oracle.com",
"ActivityOutcome": null,
"ActivityDirection": null,
"EmailSentDate": null,
"PrimaryFormattedAddress": null,
"DoNotCallFlag": null,
"CheckinDate": null,
"CheckinLatitude": null,
"CheckinLongitude": null,
"CheckoutDate": null,
"CheckoutLatitude": null,
"CheckoutLongitude": null,
"AssetName": null,
"AssetId": null,
"CheckedInBy": null,
"CheckedOutBy": null,
"AssetNumber": null,
"AssetSerialNumber": null,
"PartnerPartyId": null,
"PartnerPartyName": null,
"OpportunityNumber": null,
"LeadNumber": null,
"AccountNumber": null,
"ContactNumber": null,
"ResourceNumber": "100010025532672",
"PartnerPartyNumber": null,
"PartnerProgramNumber": null,
"BusinessPlanNumber": null,
"SalesObjectiveNumber": null,
"ClaimNumber": null,
"FundRequestNumber": null,
"CampaignNumber": null,
"ActivitySubtypeCode": null,
"CaseId": null,
"CaseNumber": null,
"CaseTitle": null,
"IbAssetId": null,
"IbAssetNumber": null,
"IbAssetSerialNumber": null,
"DismissAssignee": null,
"WebConferenceId": null,
"WebConferenceURL": null,
"WebconfSyncStatusFlag": null,
"ArticleVersionId": null,
"TaskReminderPeriod": null,
"OutlookGlobalId": null,
"OutlookAutoSyncFlag": null,
"OrchestrationId": null,
"OrchestrationStepId": null,
"AppointmentStatus": null,
"SmartActionContext": null,
"SmartActionId": null,
"ActivityCustNumTest_c": null,
"ActivityCustNum_c": null,
"ActivityCustText_c": null,
"ActivityCustDate_c": null,
"ActivityCustCurrency_c": null,
"ActivityCustPerc_c": null,
"ActivityCustDateTime_c": null,
"ActivityCustCheckbox_c": null,
"ActivityCustFCL_c": null,
"ActivityCustDCL_Id_c": null,
"ActivityCustDCL_c": null,
"ActivityCustFormulaText_c": null,
"ActivityConReqCustDCL_Id_c": null,
"ActivityConReqCustDCL_c": null,
"ActivityConUpdateCustDCL_Id_c": null,
"ActivityConUpdateCustDCL_c": null,
"TempInCelsius_c": null,
"LeadCreator_c": null,
"ActivityParentFCL_c": null,
"ActivityChildFCL_c": null,
"ZOEACTIVITYCUSTDCL_Id_c": null,
"ZOEACTIVITYCUSTDCL_c": null,
"ActivityAccountDCL_Id_c": null,
"ActivityAccountDCL_c": null,
"ActivityOptyDCL_Id_c": null,
"ActivityOptyDCL_c": null,
"ActivitySelfRefDCL_Id_c": null,
"ActivitySelfRefDCL_c": null,
"ActivityCopyFCL_c": null,
"ActivityCustBPMText_c": null,
"ORCH_CUSTOM_OBJ_Id_ORCH2Activity": null,
"Notify_c": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/300100581270692",
"name": "Activity",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/300100581270692",
"name": "Activity",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691",
"name": "activityTemplates",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/300100581270692/child/Attachments",
"name": "Attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/300100581270692/child/CustChildFor_ActivityCollection_c",
"name": "CustChildFor_ActivityCollection_c",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/300100581270692/child/CustTopFor_Activity_Activity1M_Tgt",
"name": "CustTopFor_Activity_Activity1M_Tgt",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/300100581270692/child/smartActions",
"name": "smartActions",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/300100581270692/action/ActivityFunctionName1306018331",
"name": "ActivityFunctionName1306018331",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/300100581270692/action/OracleUrlSA",
"name": "OracleUrlSA",
"kind": "other"
},
{
"rel": "enclosure",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/300100581270692/enclosure/ActivityDescription",
"name": "ActivityDescription",
"kind": "other"
},
{
"rel": "enclosure",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/300100581270692/enclosure/ActivityMtgMinutes",
"name": "ActivityMtgMinutes",
"kind": "other"
},
{
"rel": "enclosure",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/300100581270692/enclosure/WebConferenceDetails",
"name": "WebConferenceDetails",
"kind": "other"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity",
"name": "Activity",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/action/createActivitiesFromTemplate",
"name": "createActivitiesFromTemplate",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/action/createMultipleActivitiesFromTemplate",
"name": "createMultipleActivitiesFromTemplate",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/action/updateActivityWrapup",
"name": "updateActivityWrapup",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/action/sendNotificationToResources",
"name": "sendNotificationToResources",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100581270691/child/Activity/action/generateActivitySummary",
"name": "generateActivitySummary",
"kind": "other"
}
]
}