Get an activity
get
/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}
Request
Path Parameters
-
ActivityId(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=
-
SrId(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 -
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: 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 : internalServiceRequests-activities-item-response
Type:
Show Source
object-
AccountAddress: string
Title:
Account AddressRead Only:trueThe address associated with the account. -
AccountId: integer
(int64)
Title:
Account IDThe unique identifier of the account. -
AccountIdAttr: integer
The internal attribute for the account Id.
-
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 associated with the account. -
AccountStatus: string
Read Only:
trueMaximum Length:1The status of the account. -
AccountType: string
Read Only:
trueMaximum Length:30The 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 direction of the interaction. -
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 internal 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 (Internal 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:trueThe 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 TimeThe time when the activity ends. -
ApptStartTime: string
(date-time)
Title:
Start TimeThe time when the activity starts. -
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. -
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. (Internal 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. (Internal Usage)
-
CallReportCount: integer
(int32)
Title:
Call Report CountDefault Value:0A count of 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 internal identifier of the conflict -
ContactIDAttr: integer
The internal 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)
The current date for the call report.
-
CurrentDateForCallReportAttr: string
(date-time)
The internal attribute for the current date for the call report.
-
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 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 internal attribute for end date of the call report.
-
EndDtRFAttr: string
(date-time)
The internal attribute for activity start date.
-
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 internal attribute to identify recurrence mode. -
IsClientService: string
Default Value:
YThe obsolete internal attribute. -
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 internal attribute for the lead Id.
-
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 internal attribute for activity login user.
-
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 internal attribute for the opportunity Id.
-
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 activity identifier.
-
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 internal attribute for the parent activity Id.
-
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 primary 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 set of records to display in activity search. -
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 (Internal Usage).
-
SelectedFlag: boolean
Default Value:
falseThe records selected for Mass Update (Internal Usage). -
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. -
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 internal attribute for start date of the call report.
-
StartDtRFAttr: string
(date-time)
The internal 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. -
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 primary key value of the record in the source table that is upgraded to Rel9 Activity record. -
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 : 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.
Links
- AccountListVA
-
Operation: /crmRestApi/resources/11.13.18.05/accountsThe list of values indicating the name of the account associated with the activity.
The following properties are defined on the LOV link relation:- Source Attribute: AccountName; Target Attribute: PartyUniqueName
- Display Attribute: PartyUniqueName, PreferredContactEmail
- ActivityFunctionCodeExtendedVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_FUNCTION_TYPE_CD
The list of values indicating the function of the activity.
The following properties are defined on the LOV link relation:- Source Attribute: ActivityFunctionCodeTrans; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ActivityFunctionCodeListVA
-
The list of values for an activity that compares tasks with appointments.
The following properties are defined on the LOV link relation:- Source Attribute: ActivityFunctionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- ActivitySubtypeCodeFilterVA
-
Parameters:
- finder:
ByActivityTypeFinder%3BBind_ActivityTypeCode%3D{ActivityTypeCode}
The list of values indicating the activity sub types dependent on the selected activity type.
The following properties are defined on the LOV link relation:- Source Attribute: ActivitySubtypeCode; Target Attribute: ActivitySubtypeCode
- Display Attribute: Meaning
- finder:
- ActivityTypeCodeListVA
-
Parameters:
- finder:
ByActivityFunctionFinder%3BBind_ActivityFunctionCode%3D{ActivityFunctionCode}
The list of values indicating the type or category of the activity.
The following properties are defined on the LOV link relation:- Source Attribute: ActivityTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AppointmentStatusListVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZMM_ACTIVITY_STATUS_CD%2CBindLookupCode%3D{StatusCode}
The list of values indicating the appointment status of the activity.
The following properties are defined on the LOV link relation:- Source Attribute: AppointmentStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AssetListVA
-
Operation: /crmRestApi/resources/11.13.18.05/assetsThe list of values indicating the assets associated with an activity.
The following properties are defined on the LOV link relation:- Source Attribute: AssetName; Target Attribute: Product
- Display Attribute: Product
- CaseVA
-
Operation: /crmRestApi/resources/11.13.18.05/casesThe list of values indicating the reference number of the case.
The following properties are defined on the LOV link relation:- Source Attribute: CaseNumber; Target Attribute: CaseNumber
- Display Attribute: CaseNumber
- DealVA
-
Operation: /crmRestApi/resources/11.13.18.05/dealsThe following properties are defined on the LOV link relation:
- Source Attribute: DealNumber; Target Attribute: DealNumber
- Display Attribute: DealNumber
- DirectionCodeListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_DIRECTION
The list of values indicating the direction options for an activity, such as inbound/outbound, optional. The default value is null.
The following properties are defined on the LOV link relation:- Source Attribute: DirectionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ExternallyOwnedLookupVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating whether the activity is externally owned.
The following properties are defined on the LOV link relation:- Source Attribute: ExternallyOwnedFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ExtnResourceVA
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesParameters:
- finder:
FilterByManagerReportsFlagRF
The following properties are defined on the LOV link relation:- Source Attribute: OwnerName; Target Attribute: PartyName
- Display Attribute: PartyName, EmailAddress
- finder:
- LeadListVA
-
Operation: /crmRestApi/resources/11.13.18.05/leadsThe following properties are defined on the LOV link relation:
- Source Attribute: LeadName; Target Attribute: Name
- Display Attribute: Name
- OpportunityPVO
-
The following properties are defined on the LOV link relation:
- Source Attribute: OpportunityName; Target Attribute: Name
- Display Attribute: Name
- OutcomeCodeListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_OUTCOME
The list of values of an outcome of the activity such as call transferred, at risk, captured issue.
The following properties are defined on the LOV link relation:- Source Attribute: OutcomeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- OwnerListVA
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesThe list of values indicating the user who submitted the Call Report.
The following properties are defined on the LOV link relation:- Source Attribute: SubmittedByName; Target Attribute: PartyName
- Display Attribute: PartyName, EmailAddress
- PartnerEnrolledProgramsListVA
-
Operation: /crmRestApi/resources/11.13.18.05/partnersThe list of values indicating the enrollment number of the unique program.
The following properties are defined on the LOV link relation:- Source Attribute: PartnerEnrollmentNumber; Target Attribute: EnrollmentNumber
- Display Attribute: EnrollmentNumber
- PartnerNamePickerVA
-
Parameters:
- finder:
ActivePartnersFinder
The list of values containing the names of the partners who can be associated with the activity.
The following properties are defined on the LOV link relation:- Source Attribute: PartnerPartyName; Target Attribute: PartyUniqueName
- Display Attribute: PartyUniqueName
- finder:
- PartnerProgramsListVA
-
The list of values indicating the name of the partner program associated with the activity.
The following properties are defined on the LOV link relation:- Source Attribute: PartnerProgramName; Target Attribute: ProgramName
- Display Attribute: ProgramName
- PrimaryContactListVA
-
Operation: /crmRestApi/resources/11.13.18.05/contactsThe list of values indicating the name of the primary contact of the activity.
The following properties are defined on the LOV link relation:- Source Attribute: PrimaryContactName; Target Attribute: PartyName
- Display Attribute: PartyUniqueName, PrimaryEmailAddress
- PriorityCodeListVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZMM_ACTIVITY_PRIORITY_CD%2CBindLookupCode%3D{PriorityCode}
The list of values indicating the priority of the activity priority. The default value is 2. The possible values are: 1, 2, 3.
The following properties are defined on the LOV link relation:- Source Attribute: PriorityCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RatedCurrenciesVA
-
The list of values indicating the currency used by the activity.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
- RecurDayListVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RECUR_DAY_CD
The list of values indicating the recurrence of an appointment on a specific day of the month, such as 1, 10, 12, 17.
The following properties are defined on the LOV link relation:- Source Attribute: RecurDay; Target Attribute: LookupCode
- Display Attribute: Meaning
- 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.
The following properties are defined on the LOV link relation:- Source Attribute: RecurMonth; Target Attribute: LookupCode
- Display Attribute: Meaning
- 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.
The following properties are defined on the LOV link relation:- Source Attribute: RecurPattern; Target Attribute: LookupCode
- Display Attribute: Meaning
- 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.
The following properties are defined on the LOV link relation:- Source Attribute: RecurTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- 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.
The following properties are defined on the LOV link relation:- Source Attribute: RecurWeekday; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ReminderPeriodVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DZMM_ACTIVITY_REMINDER
The list of values indicating when the reminder should be sent, such as one hour before, 15 minutes before.
The following properties are defined on the LOV link relation:- Source Attribute: ReminderPeriod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ResponseCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DZMM_ACTIVITY_RESPONSE_CD
The list of values indicating whether a reminder is needed.
The following properties are defined on the LOV link relation:- Source Attribute: ResponseCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesObjectiveVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: SalesObjectiveName; Target Attribute: Name
- Display Attribute: Name
- ServiceRequestVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: SrNumber; Target Attribute: SrNumber
- Display Attribute: SrNumber
- ShowStatusVA
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DORA_ZMM_ACTIVITY_STATE
The list of values indicating the status of a record.
The following properties are defined on the LOV link relation:- Source Attribute: ShowStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ShowTimeAsVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DZMM_ACTIVITY_SHOWTIMEAS_CD
The list of values indicating the choice of display of time on your calendar for an activity.
The following properties are defined on the LOV link relation:- Source Attribute: ShowTimeAs; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StatusCodeListVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZMM_ACTIVITY_STATUS_CD%2CBindLookupCode%3D{StatusCode}
The list of values indicating the status of the activity. The default value is Not Started.
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TaskReminderPeriodVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_ZMM_TASK_REMINDER
The list of values indicating the time when a task reminder occurs.
The following properties are defined on the LOV link relation:- Source Attribute: TaskReminderPeriod; Target Attribute: LookupCode
- Display Attribute: Meaning
- 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.
The following properties are defined on the LOV link relation:- Source Attribute: AllDayFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating if the activity was generated due to auto sync.
The following properties are defined on the LOV link relation:- Source Attribute: OutlookAutoSyncFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoLookup1
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating the dismiss status of the activity
The following properties are defined on the LOV link relation:- Source Attribute: DismissFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: