Get an activity
get
/crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/{ActivityId}
Request
Path Parameters
-
ActivityId(required): integer(int64)
System generated non-nullable primary key of the table.
-
AssetId(required): integer(int64)
The unique identifier of the asset.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : assets-assetActivities-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
Party Id of the activity account (Customer - org/person, or Partner etc.). -
AccountIdAttr: integer
The attribute for the account identifier (Not for public usage).
-
AccountName: string
Title:
Account
The name of account associated to activity. -
AccountNameOsn: string
Title:
Social Account Name
The account name as displayed in Oracle Social Network. -
AccountNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
Account Number of 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. -
ActivityCreatedBy: string
Title:
Activity Created By
Read Only:true
Maximum Length:64
Original Activity Created By -
ActivityCreationDate: string
(date-time)
Title:
Activity Creation Date
Read Only:true
Original Activity Creation Date -
ActivityDescription: string
(byte)
Title:
Description
A text field for capturing some descriptive information about the activity. -
ActivityDirection: string
Read Only:
true
The outcome of the activity. -
ActivityEndDate: string
(date-time)
Title:
End Date
The date and time when an appointment ends or the completion time of a task. -
ActivityFilter: string
Read Only:
true
An attribute to add additional activity filter (Not for public usage). -
ActivityFunctionCode: string
Title:
Activity
Maximum Length:30
The activity function code that is task vs appointment. For system use only. -
ActivityFunctionCodeTrans: string
Title:
Activity
Maximum Length:255
The activity function code. -
ActivityId: integer
(int64)
Title:
Activity ID
System generated non-nullable primary key of the table. -
ActivityLastUpdateLogin: string
Title:
Activity Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the activity. -
ActivityMtgMinutes: string
(byte)
Title:
Meeting Minutes
The meeting minutes of the activity. -
ActivityNumber: string
Title:
Activity Number
Maximum Length:64
System generated or can come from external system (user key). -
ActivityOutcome: string
Read Only:
true
The direction of the interaction. -
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 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:
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 user's time zone preference.
-
ActivityType: string
Title:
Activity Type
The type of the activity. -
ActivityTypeCode: string
Title:
Type
Maximum Length:30
The type or category of the activity. -
ActivityUpdateDate: string
(date-time)
Title:
Activity Updated Date
Read Only:true
The date when the activity was updated. -
ActivityUpdatedBy: string
Title:
Activity Updated By
Read Only:true
Maximum Length:64
The user who updated the activity. -
ActivityUserLastUpdateDate: string
(date-time)
Title:
Activity User Last Updated Date
Read Only:true
The date when the activity was last updated. -
AllDayFlag: boolean
Title:
All Day
Maximum Length:1
Default Value:false
Designates that an appointment is the entire day. -
AppointmentStatus: string
Title:
Appointment Status
Maximum Length:30
Denotes 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
Knowledge Article Version -
AssessmentId: integer
(int64)
Title:
Assessment ID
The unique identifier of the assessment to which the activity or the activity template is associated to. -
AssetId: integer
(int64)
Title:
Asset ID
Id of the Asset associated with the activity. -
AssetName: string
Title:
Asset
Name of the Asset associated with the activity -
AssetNumber: string
Title:
Asset Number
Asset Number. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
Asset Serial Number. -
AttachmentEntityName: string
Maximum Length:
255
Default Value:ZMM_ACTY_ACTIVITIES
The name of the attachment entity. -
AutoLogSource: string
Title:
Source System
Maximum Length:30
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
(int64)
Title:
Business Plan ID
The unique identifier of the related 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 business plan name associated to the activity. -
BusinessPlanNumber: string
Title:
Business Plan Number
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 whether the appointment is upcoming.
-
CallReportYN: string
Indicates whether the activity has a call report.
-
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignName: string
Title:
Campaign
The name of campaign associated to the activity. -
CampaignNumber: string
Title:
Campaign Number
Campaign Number of the campaign associated with the activity. -
CaseId: integer
(int64)
Title:
Case ID
Case Id -
CaseNumber: string
Title:
Case Number
Case Number -
CaseTitle: string
Title:
Title
Read Only:true
Maximum Length:400
Case Title -
CheckedInBy: string
Title:
Checked-In By
Maximum Length:64
Specifies the name of the person who checks-in to a location. -
CheckedOutBy: string
Title:
Checked-Out By
Maximum Length:64
Specifies the name of the person who checks-out to a location. -
CheckinDate: string
(date-time)
Title:
Check-In Time
Stores the date and time when a user checks in to an Appointment. -
CheckinLatitude: number
Title:
Check-In Latitude
Stores the latitude of a location where a user checks in to an Appointment. -
CheckinLongitude: number
Title:
Check-In Longitude
Stores the longitude of a location where a user checks in to an Appointment. -
CheckoutDate: string
(date-time)
Title:
Check-Out Time
Stores the date and time when a user checks out of an Appointment. -
CheckoutLatitude: number
Title:
Check-Out Latitude
Stores the latitude of a location where a user checks out of an Appointment. -
CheckoutLongitude: number
Title:
Check-Out Longitude
Stores the longitude of a location where a user checks out of an Appointment. -
ClaimId: integer
(int64)
Title:
Claim ID
The unique identifier of the related claim. -
ClaimName: string
Title:
MDF Claim
The claim name associated to the activity. -
ClaimNumber: string
Title:
Claim Number
Claim 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
Contact Number of primary contact associated with the activity. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the asset. 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 Look -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The system attribute used to capture the user ID of the activity creator. This is defaulted by the system. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The system attribute to capture the date and time the activity was created. This is defaulted by the system. -
CurcyConvRateType: string
Title:
Currency Conversion Rate
Maximum Length:30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code. -
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 customer account that the activity relates to. -
DealId: integer
(int64)
Title:
Deal ID
The unique identifier of the deal. -
DealNumber: string
Title:
Deal Registration
The deal number associated to the activity. -
DelegatorId: integer
(int64)
Title:
Delegator ID
The activity resource that delegated activity ownership to another resource. -
DelegatorName: string
Title:
Delegated By
The name of activity resource that delegated activity ownership to another resource. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the user has access to delete the record. -
DerivedAccountId: integer
The unique identifier of the derived account.
-
DirectionCode: string
Title:
Direction
Maximum Length:30
The code of the direction. Values are Inbound or Outbound. The default is null. -
DismissAssignee: string
Title:
Dismissed
Flag to dismiss Assignee. Valid values are Y and N. -
DismissFlag: boolean
Title:
Dismissed
Maximum Length:1
Indicates whether this activity is dismissed. -
DoNotCallFlag: boolean
Read Only:
true
Flag to indicate if primary Contact can be called. -
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)
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 (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 email 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 that the activity is not created by an internal resource. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the related fund request. -
FundRequestName: string
Title:
MDF Request
The fund request name associated to the activity. -
FundRequestNumber: string
Title:
Fund Request Number
Fund Request Number of the fund request associated with the activity. -
IbAssetId: integer
(int64)
Title:
IB Asset ID
Id of the Installed Base Asset associated with the activity. -
IbAssetNumber: string
Title:
Installed Base Asset
Number of the Installed Base Asset associated with the activity. -
IbAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
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 when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login of the user who last updated the row. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead. -
LeadIdAttr: integer
The attribute for the lead identifier (Not for public usage).
-
LeadName: string
Title:
Lead
The name of the lead. -
LeadNameOsn: string
Title:
Social Lead Name
The lead name as displayed in Oracle Social Network. -
LeadNumber: string
Title:
Lead Number
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 location or address identifier of the activity account or primary contact. -
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 unique identifier of external mobile device. -
NotesLinkSourceCodeTransient: string
Read Only:
true
The note source object. -
ObjectiveId: integer
(int64)
Title:
Objective ID
The unique identifier of the related objective. -
OpportunityId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OpportunityIdAttr: integer
The attribute for the opportunity identifier (Not for public usage).
-
OpportunityName: string
Title:
Opportunity
The name of opportunity associated to the activity. -
OpportunityNameOsn: string
Title:
Social Opportunity Name
The opportunity name displayed in Oracle Social Network. -
OpportunityNumber: string
Title:
Opportunity Number
Opportunity Number of the opportunity Associated with the activity. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier to identify the orchestration process. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier to identify 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
For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called. -
OutcomeCode: string
Title:
Outcome
Maximum Length:30
The outcome of the activity. -
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 created from Outlook and synced, "Y". -
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 from Outlook Activity. -
OwnerAddress: string
Title:
Activity Owner Address
Read Only:true
The activity owner's address. -
OwnerEmailAddress: string
Title:
Activity Owner Email
Read Only:true
Maximum Length:320
The activity owner's email address. -
OwnerId: integer
(int64)
Title:
Owner ID
The primary resource on the activity. Supports resources only. -
OwnerName: string
Title:
Owner
Maximum Length:360
The name of primary resource of 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 activity owner's phone number. -
ParentActivityId: integer
(int64)
Title:
Parent ID
The unique identifier of the parent activity. It is only applicable if the record is a follow up activity. -
ParentActivityIdAttr: string
The attribute for the parent activity identifier (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 partner enrollment. -
PartnerEnrollmentNumber: string
Title:
Enrollment Number
The surrogate key for partner enrollment. -
PartnerPartyId: integer
(int64)
Title:
Partner Party ID
Party identifier of the partner organization. -
PartnerPartyName: string
Title:
Partner
Maximum Length:80
Party name of the partner organization. -
PartnerPartyNumber: string
Title:
Partner Number
Partner Party Number of partner associated with the activity. -
PartnerProgramId: integer
(int64)
Title:
Partner Program ID
The unique identifier of the partner program. -
PartnerProgramName: string
Title:
Program
The name of partner program associated to the activity. -
PartnerProgramNumber: string
Title:
Program Number
Partner Program Number of partner program associated with the activity. -
PartnerUsageFlag: boolean
Title:
Partner Usage
Maximum Length:1
Default Value:false
Flag to indicate that the Activity has been created for an Organization Account with usage as Partner. -
PercentageComplete: number
Title:
Percentage Complete
Default Value:0
Numeric Value 0-100 to reflect the percent complete status of the activity. Free form numeric. % value at end. -
PrimaryContactEmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email id of the primary contact. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact ID
The unique identifier of the primary contact. -
PrimaryContactName: string
Title:
Primary Contact
The name of primary contact. -
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
Holds Address of the primary contact -
PrimaryFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the primary contact. -
PriorityCode: string
Title:
Priority
Maximum Length:30
The priority of the activity. Default to 2. Possible values: 1, 2, 3. -
PrivateFlag: boolean
Title:
Private
Maximum Length:1
Indicates whether the activity is private. -
RecordSet: string
Title:
Record Set
Maximum Length:255
The set of records to display in activity search. -
RecurDay: integer
(int64)
Title:
Day
Repeat on specified day of month (for monthly appointments). -
RecurEndDate: string
(date-time)
Title:
Ends
Ends on a specified date. -
RecurEveryOptionFlag: boolean
Title:
Recurrence Option
Maximum Length:1
Indicates whether the recurrence occurs for every day, month, year, etc. For example, a daily recurring appointment can occur every day of the week or weekdays only. If it is everyday of the week, it is set to Y if it is weekdays only, it is set to N. -
RecurExceptionFlag: boolean
Title:
Recurrence Exception
Maximum Length:1
Indicates whether the appointment instance has been updated outside of recurring appointment series. -
RecurFrequency: number
Title:
Repeat
The frequency with which the recurring appointment series repeats. -
RecurFriFlag: boolean
Title:
Friday
Maximum Length:1
Repeats on Friday. -
RecurMonFlag: boolean
Title:
Monday
Maximum Length:1
Repeats on Monday. -
RecurMonth: string
Title:
Month
Maximum Length:30
Repeats on specified month (for yearly appointments). -
RecurNumberOfInstances: number
Title:
Number of Instances
Designates specific number of occurrences for the series to end after. -
RecurOrigInstDate: string
(date-time)
Title:
Original Instance Date
The original date of a recurring appointment instance. -
RecurPattern: string
Title:
Pattern
Maximum Length:30
Designates which week for appointment to recur (for monthly and yearly appointments). Possible values: First, Second, Third, Fourth, Last. -
RecurRecType: string
Title:
Recurrence Record Type
Maximum Length:1
Default Value:N
The recurring record type. Either "I" for instance or "S" for series or "N" for non-recurring. Do not populate it if Activity is of type Task. For internal use only. -
RecurSatFlag: boolean
Title:
Saturday
Maximum Length:1
Repeats on Saturday. -
RecurSeriesId: integer
(int64)
Title:
Recurrence Series ID
The unique identifier of the series that links instances of a series together. -
RecurSunFlag: boolean
Title:
Sunday
Maximum Length:1
Repeats on Sunday. -
RecurThuFlag: boolean
Title:
Thursday
Maximum Length:1
Repeats on Thursday. -
RecurTueFlag: boolean
Title:
Tuesday
Maximum Length:1
Repeats on Tuesday. -
RecurTypeCode: string
Title:
Recurrence Type
Maximum Length:30
Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, Yearly. -
RecurUpdatedAttributes: string
Title:
Recurrence Updated Attributes
Maximum Length:4000
The recurring updated attributes. -
RecurWedFlag: boolean
Title:
Wednesday
Maximum Length:1
Repeats on Wednesday. -
RecurWeekday: string
Title:
Pattern Type
Maximum Length:30
It works in conjunction with RecurPattern attribute. Possible values: Monday to Sunday, Weekday, Weekend, Day -
ReferenceCustomerActTypeCode: string
Title:
Reference Customer Activity Type
Maximum Length:30
Activity Type for a reference customer activity. To be used as an extension only. -
ReferenceCustomerId: integer
(int64)
Title:
Reference Customer
The unique identifier of the reference customer (party) associated with the activity. -
ReminderPeriod: string
Title:
Set Reminder
The reminder period. -
ResourceNumber: string
Title:
Resource Number
Read Only:true
Maximum Length:30
Resource Number of owner associated with the activity. -
ResponseCode: string
Title:
Response
The response code. -
SalesObjectiveName: string
Title:
Sales Objective
The sales objective name associated to the activity. -
SalesObjectiveNumber: string
Title:
Sales Objective Number
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. -
ShowTimeAs: string
Title:
Show Time As
The show time. -
SmartActionContext: string
Title:
Smart Action Context
Maximum Length:4000
Stores metadata needed for smart action. -
SmartActionId: integer
(int64)
Title:
Smart Action ID
The smart action identifier. Foriegn key from zca_user_action. -
SortDate: string
(date-time)
Title:
Date
This 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 unique identifier of the object to which activity will get related to.
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
SrNumber: string
Title:
Service Request
The alternate 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 status of the activity. Defaulted to NOT_STARTED. -
Subject: string
Title:
Subject
Maximum Length:500
The subject, name, or title of the activity. -
SubmittedBy: integer
(int64)
Title:
Submitted By
The user who submitted the report. -
SubmittedByName: string
Title:
Submitted By
Maximum Length:255
The user who submitted the report. -
SubmittedDate: string
(date-time)
Title:
Submitted Date
The date when the 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
Task Reminder Period -
TemplateDuration: number
Title:
Template Duration
The duration (in days) of 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 (in days) of the template activity. This attribute is used with the date input parameter when generating an activity from a template in order to calculate the activity start date. Activity start date is equal to date provided as input parameter and lead time. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the user has access to update the record. -
UpgSourceObjectId: string
Read Only:
true
Maximum Length:64
The primary key value of the record in the source table that is upgraded to 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
Web conference details -
WebConferenceId: string
Title:
Web Conference ID
Maximum Length:255
Web conference unique id -
WebConferenceURL: string
Title:
Web Conference URL
Maximum Length:2000
Web conference join URL -
WebconfSyncStatusFlag: boolean
Title:
Web Conference Synchronization
Maximum Length:1
Appointment Interaction Status
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.
Links
- AccountListVA
-
Operation: /crmRestApi/resources/11.13.18.05/accountsThe list of values indicating the name of the account associated with the activity.
- ActivityFunctionCodeExtendedVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_FUNCTION_TYPE_CD
The list of values indicating the function of the activity. - finder:
- ActivityFunctionCodeListVA
-
The list of values for an activity that compares tasks with appointments.
- ActivitySubtypeCodeFilterVA
-
Parameters:
- finder:
ByActivityTypeFinder%3BBind_ActivityTypeCode%3D{ActivityTypeCode}
The list of values indicating the activity subtypes dependent on the selected activity type. - finder:
- ActivityTypeCodeListVA
-
Parameters:
- finder:
ByActivityFunctionFinder%3BBind_ActivityFunctionCode%3D{ActivityFunctionCode}
The list of values indicating the type or category of the activity. - finder:
- AppointmentStatusListVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZMM_ACTIVITY_STATUS_CD%2CBindLookupCode%3D{StatusCode}
The list of values indicating the status of the activity. - finder:
- AssetListVA
-
Operation: /crmRestApi/resources/11.13.18.05/assetsThe list of values indicating the assets associated with an activity.
- CaseVA
-
Operation: /crmRestApi/resources/11.13.18.05/casesThe list of values indicating the reference number of the case.
- DealVA
-
Operation: /crmRestApi/resources/11.13.18.05/dealsThe list of values indicating the unique number of the deal associated to the activity. The number can also be generated from an external source.
- DirectionCodeListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_DIRECTION
The list of values indicating the direction options for an activity, such as inbound or outbound, optional. The default value is null. - finder:
- ExternallyOwnedLookupVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating whether the activity is externally owned. - finder:
- ExtnResourceVA
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesParameters:
- finder:
FilterByManagerReportsFlagRF
The list of values indicating the name of the owner of the activity. - finder:
- LeadListVA
-
Operation: /crmRestApi/resources/11.13.18.05/leadsThe list of values indicating the activity lead name.
- OpportunityPVO
-
The list of values indicating the activity opportunity name.
- OutcomeCodeListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_OUTCOME
The list of values of an outcome of the activity such as call transferred, at risk, captured issue. - finder:
- OwnerListVA
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesThe list of values indicating the user who submitted the Call Report.
- PartnerEnrolledProgramsListVA
-
Operation: /crmRestApi/resources/11.13.18.05/partnersThe list of values indicating the enrollment number of the unique program.
- PartnerNamePickerVA
-
Parameters:
- finder:
ActivePartnersFinder
The list of values containing the names of the partners who can be associated with the activity. - finder:
- PartnerProgramsListVA
-
The list of values indicating the name of the partner program associated with the activity.
- PrimaryContactListVA
-
Operation: /crmRestApi/resources/11.13.18.05/contactsThe list of values indicating the name of the primary contact of the activity.
- PriorityCodeListVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZMM_ACTIVITY_PRIORITY_CD%2CBindLookupCode%3D{PriorityCode}
The list of values indicating the priority of the activity priority. The default value is 2. The possible values are: 1, 2, 3. - finder:
- RatedCurrenciesVA
-
The list of values indicating the currency used by the activity.
- RecurDayListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RECUR_DAY_CD
The list of values indicating the recurrence of an appointment on a specific day of the month, such as 1, 10, 12, 17. - finder:
- RecurMonthListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RECUR_MONTH_CD
The list of values indicating the recurrence of an appointment in a specified month, such as April, June, March. - finder:
- RecurPatternListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RECUR_PATTERN_CD
The list of values indicating the recurring appointment for a specific week, such as First, Second, Third, Fourth, Last. The recurrence can be monthly or yearly. - finder:
- RecurTypeCodeListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RECUR_TYPE_CD
The list of values indicating how often an appointment recurs, such as Daily, Weekly, Monthly, Yearly. - finder:
- RecurWeekDayListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RECUR_DAYWEEK_CD
The list of values indicating the activity that recurs on every weekday, such as Monday to Sunday, Weekday, Weekend, Day. - finder:
- ReminderPeriodVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DZMM_ACTIVITY_REMINDER
The list of values indicating the time when a activity reminder occurs. - finder:
- ResponseCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DZMM_ACTIVITY_RESPONSE_CD
The list of values indicating whether a reminder is needed. - finder:
- SalesObjectiveVA
-
The list of values indicating the name of the sales objective associated with the activity.
- ServiceRequestVA
-
The list of values indicating the service request number.
- ShowStatusVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DORA_ZMM_ACTIVITY_STATE
The list of values indicating the status of a record. - finder:
- ShowTimeAsVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DZMM_ACTIVITY_SHOWTIMEAS_CD
The list of values indicating the display of time on your calendar for an appointment, such as free, busy, tentative. - finder:
- StatusCodeListVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZMM_ACTIVITY_STATUS_CD%2CBindLookupCode%3D{StatusCode}
The list of values indicating the status of the activity. - finder:
- TaskReminderPeriodVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_ZMM_TASK_REMINDER
The list of values indicating the time when a task reminder occurs. - finder:
- YesNoAllDayLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating whether the appointment is for the entire day, such as True or False. - finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating if the activity was generated due to auto sync. - finder:
- YesNoLookup1
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating the dismiss status of the activity. - finder: