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

Get all activities

get

/crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities

Request

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

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

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • ActivitesByContactId: Finds activities where a specified contact is defined.
      Finder Variables:
      • ContactIDAttr; integer; The contact ID related to the activities.
    • ActivityNumberRowFinder: Finds the unique identifier for an activity.
      Finder Variables:
      • ActivityNumber; string; The unique number of the activity. The number can also be generated from an external source.
    • AppointmentsWithNoMyCallReport: Finds appointments which don't have an associated call report.
      Finder Variables:
      • DateRange; integer; The date range within which you want to search for appointments.
      • EndDtRFAttr; string; The appointment end date.
      • StartDtRFAttr; string; The appointment start date.
    • CompletedActivities: Finds activities in a completed status.
      Finder Variables:
      • Bind_CurrentDate; string; Finds the date used to locate completed activities.
      • Bind_RecurSeriesType_BV; string; The recurring type code of an appointment.
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
      • Bind_TaskStatus_BV; string; The status of the tasks.
    • GetActivitiesByActivityNumber: Finds activities with the specified activity number.
      Finder Variables:
      • ActivityNumber; string; Finds the activity number used to locate the activity.
    • GetListOfCallReports: Finds call reports.
      Finder Variables:
      • AccountIdAttr; integer; Finds the account ID related to the call reports.
      • EndDtRFAttr; string; The end date of the call reports.
      • LeadIdAttr; string; Finds the lead ID related to the call reports.
      • OpportunityIdAttr; string; The unique identifier of the opportunity.
      • StartDtRFAttr; string; The start date of the call report.
    • GetListOfCallReportsForPastAppt: Finds call reports related to a past appointment.
      Finder Variables:
      • ParentActivityIdAttr; string; The parent activity ID related to the call reports.
    • MyActivitiesAsResource: Finds activities where a specified user is a resource.
      Finder Variables:
      • Bind_RecurSeriesType_BV; string; The recurring type code of an appointment.
      • Bind_UserResourceId; integer; Finds the resource ID of the user.
    • MyAppointmentsInDateRange: Finds appointments within a data range.
      Finder Variables:
      • EndDtRFAttr; string; Finds the appointment end date.
      • StartDtRFAttr; string; Finds the appointment start date.
    • MyCallReportsInDateRange: Finds call reports within a date range.
      Finder Variables:
      • AccountIdAttr; integer.
      • EndDtRFAttr; string; The end date of the call reports.
      • LeadIdAttr; string.
      • OpportunityIdAttr; string.
      • StartDtRFAttr; string; The start date of the call report.
    • MyOpenActivities: Finds all open activities owned by a specified user.
      Finder Variables:
      • Bind_Subject; string; Open activities owned by a specified user.
    • MyOpenTasks: Finds tasks in an open status.
      Finder Variables:
      • Bind_LoggedInUserId_BV; integer; The ID of the user who is logged into the application.
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
      • Bind_TaskStatus_BV; string; The status of the task.
      • Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
    • MyTasks: Finds tasks owned by a specified user.
      Finder Variables:
      • Bind_LoggedInUserId_BV; integer; Finds the ID of the user who is logged into the application.
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
    • OpenActivities: Finds all open activities.
      Finder Variables:
      • Bind_CurrentDate; string; Finds the date used to locate current activities.
      • Bind_RecurSeriesType_BV; string; The recurring type code of an appointment
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
      • Bind_TaskStatus_BV; string; The status of the tasks.
      • Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
    • OpenTasksByHighPriority: Finds tasks with a priority value of high.
      Finder Variables:
      • Bind_LoggedInUserId_BV; integer; The ID of the user who is logged into the application.
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
      • Bind_TaskPriority_BV; string; The priority of the task.
      • Bind_TaskStatus_BV; string; The status of the task.
      • Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
    • OverdueTasks: Finds tasks with a due date in the past.
      Finder Variables:
      • Bind_CurrentDate; string; The date used to locate current activities.
      • Bind_CurrentUPTZDate; string; The date used to locate the tasks whose due date is before the current date.
      • Bind_LoggedInUserId_BV; integer; The ID of the user who is logged into the application.
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
      • Bind_TaskStatus_BV; string; The status of the tasks.
      • Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
    • PrimaryKey: Finds the activity with the specified primary key identifier.
      Finder Variables:
      • ActivityId; integer; The unique identifier of the activity.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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; Party Id of the activity account (Customer - org/person, or Partner etc.).
    • AccountIdAttr; integer; The attribute for the account identifier (Not for public usage).
    • AccountNumber; string; Account Number of account associated with the activity.
    • ActivityCreatedBy; string; Original Activity Created By
    • ActivityCreationDate; string; Original Activity Creation Date
    • ActivityDescription; string; A text field for capturing some descriptive information about the activity.
    • ActivityEndDate; string; The date and time when an appointment ends or the completion time of a task.
    • ActivityFilter; string; An attribute to add additional activity filter (Not for public usage).
    • ActivityFunctionCode; string; The activity function code that is task vs appointment. For system use only.
    • ActivityId; integer; System generated non-nullable primary key of the table.
    • ActivityMtgMinutes; string; The meeting minutes of the activity.
    • ActivityNumber; string; System generated or can come from external system (user key).
    • 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; Denotes the status of the appointment.
    • ArticleVersionId; string; Knowledge Article Version
    • AssessmentId; integer; The unique identifier of the assessment to which the activity or the activity template is associated to.
    • AssetId; integer; Id of the Asset associated with the activity.
    • AssetName; string; Name of the Asset associated with the activity
    • AssetNumber; string; Asset Number.
    • AssetSerialNumber; string; Asset Serial Number.
    • 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 related 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; Business Plan Number of the business plan associated with the activity.
    • CalendarRecurType; string; The activity recurrence type.
    • CalendarTimeType; string; Indicates all day appointment (Not for public usage).
    • CallReportCount; integer; A count of the number of call reports.
    • CallReportUpcomingYN; string; Indicates whether the appointment is upcoming.
    • CallReportYN; string; Indicates whether the activity has a call report.
    • CampaignId; integer; The unique identifier of the campaign.
    • CampaignName; string; The name of campaign associated to the activity.
    • CampaignNumber; string; Campaign Number of the campaign associated with the activity.
    • CaseId; integer; Case Id
    • CaseNumber; string; Case Number
    • CaseTitle; string; Case Title
    • CheckedInBy; string; Specifies the name of the person who checks-in to a location.
    • CheckedOutBy; string; Specifies 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 related claim.
    • ClaimName; string; The claim name associated to the activity.
    • ClaimNumber; string; Claim Number of the claim associated with the activity.
    • ConflictId; integer; The unique identifier of the conflict. (Not for public usage).
    • ContactIDAttr; integer; The contact identifier (Not for public usage).
    • ContactNumber; string; Contact Number of primary contact associated with the activity.
    • CreatedBy; string; The system attribute used to capture the user ID of the activity creator. This is defaulted by the system.
    • CreationDate; string; The system attribute to capture the date and time the activity was created. This is defaulted by the system.
    • CurrentDateForCallReport; string; The current date for the call report.
    • CurrentDateForCallReportAttr; string; The attribute for the current date for the call report (Not for public usage).
    • CurrentSystemDtTransient; string; The current system date.
    • CustomerAccountId; integer; The unique identifier of customer account that the activity relates to.
    • DealId; integer; The unique identifier of the 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 code of the direction. Values are Inbound or Outbound. The default is null.
    • DismissAssignee; string; Flag to dismiss Assignee. 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 (Not for public usage).
    • EndDtRFAttr; string; The attribute for activity start date (Not for public usage).
    • ExternalContactEmail; string; Indicates the email address of an external contact.
    • ExternalContactName; string; Indicates the name of an external contact.
    • ExternallyOwnedFlag; boolean; Indicates that the activity is not created by an internal resource.
    • FundRequestId; integer; The unique identifier of the related fund request.
    • FundRequestName; string; The fund request name associated to the activity.
    • FundRequestNumber; string; Fund Request Number of the fund request associated with the activity.
    • IbAssetId; integer; Id of the Installed Base Asset associated with the activity.
    • IbAssetNumber; string; Number of the Installed Base Asset associated with the activity.
    • LastUpdateDate; string; The date when the row was last updated.
    • LastUpdatedBy; string; The user who last updated the row.
    • LeadId; integer; The unique identifier of the lead.
    • LeadIdAttr; integer; The attribute for the lead identifier (Not for public usage).
    • LeadName; string; The name of the lead.
    • LeadNumber; string; Lead Number of lead associated with the activity.
    • Location; string; The location of the appointment.
    • LocationId; integer; The location or address identifier of the activity account or primary contact.
    • LoginUserRFAttr; integer; The attribute for activity login user (Not for public usage).
    • ObjectiveId; integer; The unique identifier of the related objective.
    • OpportunityId; integer; The unique identifier of the opportunity.
    • OpportunityIdAttr; integer; The attribute for the opportunity identifier (Not for public usage).
    • OpportunityName; string; The name of opportunity associated to the activity.
    • OpportunityNumber; string; 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 activity identifier.
    • OtherPartyPhoneNumber; string; For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called.
    • OutcomeCode; string; 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 created from Outlook and synced, "Y".
    • 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 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; A column that stores a truncated string of the meeting minutes.
    • PartnerEnrollmentId; integer; The unique identifier of the partner enrollment.
    • PartnerPartyId; integer; Party identifier of the partner organization.
    • PartnerPartyName; string; Party name of the partner organization.
    • PartnerPartyNumber; string; Partner Party Number of partner associated with the activity.
    • PartnerProgramId; integer; The unique identifier of the partner program.
    • PartnerProgramNumber; string; Partner Program Number of partner program associated with the activity.
    • PercentageComplete; number; Numeric Value 0-100 to reflect the percent complete status of the activity. Free form numeric. % value at end.
    • PrimaryContactEmailAddress; string; The email id of the primary contact.
    • PrimaryContactId; integer; The unique identifier of the primary contact.
    • PrimaryContactName; string; The name of 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 set of records to display in activity search.
    • RecurEndDate; string; Ends on a specified date.
    • RecurExceptionFlag; boolean; Indicates whether the appointment instance has been updated outside of recurring appointment series.
    • RecurRecType; string; 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.
    • RecurSeriesId; integer; The unique identifier of the series that links instances of a series together.
    • RecurUpdatedAttributes; string; The recurring updated attributes.
    • ReferenceCustomerId; integer; The unique identifier of the reference customer (party) associated with the activity.
    • ResourceNumber; string; 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; Sales Objective Number of the sales objective associated with the activity.
    • SelectedFlag; boolean; The records selected for Mass Update (Not for public usage).
    • ShowStatus; string; Indicates whether the activity is open, complete.
    • SmartActionContext; string; Stores metadata needed for smart action.
    • SmartActionId; integer; The smart action identifier. Foriegn 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 alternate identifier of the service request.
    • StartDateForCallReport; string; The start date of the call report.
    • StartDateForCallReportAttr; string; The attribute for start date of the call report (Not for public usage).
    • StartDtRFAttr; string; The attribute for Activity Start Date (Not for public usage).
    • StatusCode; string; The status of the activity. Defaulted to NOT_STARTED.
    • Subject; string; The subject, name, or title of the activity.
    • SubmittedByName; string; The user who submitted the report.
    • SubmittedDate; string; The date when the report was submitted.
    • TemplateFlag; string; Indicates whether this is a template activity.
    • TemplateId; integer; The unique identifier of the template.
    • UpdateFlag; boolean; Indicates whether the user has access to update the record.
    • UpgSourceObjectId; string; The primary key value of the record in the source table that is upgraded to activity record.
    • UpgSourceObjectType; string; The source object type could be Appointment, Task, or Interaction to indicate the source of the upgraded record.
    • WebConferenceId; string; Web conference unique id
    • WebConferenceURL; string; Web conference join URL
    • WebconfSyncStatusFlag; boolean; Appointment Interaction Status
  • 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
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : assets-assetActivities
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : assets-assetActivities-item-response
Type: object
Show Source
Links
createActivitiesFromTemplate
Parameters:
  • AssetId: $request.path.AssetId
This method lets you create activities from a template.
createMultipleActivitiesFromTemplate
Parameters:
  • AssetId: $request.path.AssetId
This method lets you create multiple activities from a template.
sendNotificationToResources
Parameters:
  • AssetId: $request.path.AssetId
This method lets you send notification to resources along with the details of the interaction.
updateActivityWrapup
Parameters:
  • AssetId: $request.path.AssetId
This method is used when an interaction or wrap up is created for an activity. It updates the value of this attribute.
Back to Top