Get all activities

get

/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities

Request

Path Parameters
  • 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
  • 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 not having an associated call report.
      Finder Variables:
      • DateRange; integer; The date range within which you want search for appointments.
      • EndDtRFAttr; string; The appointment end date.
      • StartDtRFAttr; string; The appointment start date.
    • CompletedActivities: Finds activities in a completed status.
      Finder Variables:
      • Bind_CurrentDate; string; Finds the date used to locate completed activities.
      • Bind_RecurSeriesType_BV; string; The recurring type code of an appointment.
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
      • Bind_TaskStatus_BV; string; The status of the tasks.
    • GetActivitiesByActivityNumber: Finds activities with the specified activity number.
      Finder Variables:
      • ActivityNumber; string; Finds the activity number use to locate the activity.
    • GetListOfCallReports: Finds call reports.
      Finder Variables:
      • AccountIdAttr; integer; Finds the account ID related to the call reports.
      • EndDtRFAttr; string; Finds the end date of the call report.
      • LeadIdAttr; string; Finds the lead ID related to the call reports.
      • OpportunityIdAttr; string; Finds the opportunity ID related to the call reports.
      • StartDtRFAttr; string; Finds the start date of the call report.
    • GetListOfCallReportsForPastAppt: Finds call reports related to a past appointment.
      Finder Variables:
      • ParentActivityIdAttr; string; The parent activity ID related to the call reports.
    • MyActivitiesAsResource: Finds activities where a specified user is a resource.
      Finder Variables:
      • Bind_RecurSeriesType_BV; string; The recurring type code of an appointment.
      • Bind_UserResourceId; integer; Finds the resource ID of the user.
    • MyAppointmentsInDateRange: Finds appointments within a data range.
      Finder Variables:
      • EndDtRFAttr; string; Finds the appointment end date.
      • StartDtRFAttr; string; Finds the appointment start date.
    • MyCallReportsInDateRange: Finds call reports within a date range.
      Finder Variables:
      • AccountIdAttr; integer; The account ID related to the call reports.
      • EndDtRFAttr; string; The end date of the call reports.
      • LeadIdAttr; string; The lead ID related to the call reports.
      • OpportunityIdAttr; string; The opportunity ID related to the call reports.
      • StartDtRFAttr; string; The start date of the call report.
    • MyOpenActivities: Finds all open activities owned by a specified user.
      Finder Variables:
      • Bind_Subject; string; Open activities owned by a specified user.
    • MyOpenTasks: Finds tasks in an open status.
      Finder Variables:
      • Bind_LoggedInUserId_BV; integer; The ID of the user who is logged into the application.
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
      • Bind_TaskStatus_BV; string; The status of the task.
      • Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
    • MyTasks: Finds tasks owned by a specified user.
      Finder Variables:
      • Bind_LoggedInUserId_BV; integer; Finds the ID of the user who is logged into the application.
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
    • OpenActivities: Finds all open activities.
      Finder Variables:
      • Bind_CurrentDate; string; Finds the date used to locate current activities.
      • Bind_RecurSeriesType_BV; string; The recurring type code of an appointment
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
      • Bind_TaskStatus_BV; string; The status of the tasks.
      • Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
    • OpenTasksByHighPriority: Finds tasks with a priority value of high.
      Finder Variables:
      • Bind_LoggedInUserId_BV; integer; The ID of the user who is logged into the application.
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
      • Bind_TaskPriority_BV; string; The priority of the task.
      • Bind_TaskStatus_BV; string; The status of the task.
      • Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
    • OverdueTasks: Finds tasks with a due date in the past.
      Finder Variables:
      • Bind_CurrentDate; string; The date used to locate current activities.
      • Bind_CurrentUPTZDate; string; The date used to locate the Tasks whose due date is before the current date.
      • Bind_LoggedInUserId_BV; integer; The ID of the user who is logged into the application.
      • Bind_TaskActFuncCd_BV; string; The activities with a function code of task.
      • Bind_TaskStatus_BV; string; The status of the tasks.
      • Bind_TaskStatus_Cancel_BV; string; The tasks with a cancelled status.
    • PrimaryKey: Finds the activity with the specified primary key identifier.
      Finder Variables:
      • ActivityId; integer; The unique identifier of the activity.
  • 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; The unique identifier of the account.
    • AccountIdAttr; integer; The internal attribute for the account Id.
    • AccountNumber; string; The account number of the account associated with the activity.
    • ActivityCreatedBy; string; The activity user who created the activity.
    • ActivityCreationDate; string; The date when the activity was created.
    • ActivityDescription; string; A text field for capturing some descriptive information about the activity.
    • ActivityEndDate; string; The end date and time of an appointment, or the completion time of a task.
    • ActivityFilter; string; An internal attribute to add additional activity filter.
    • ActivityFunctionCode; string; The task vs appointment. This is for system use only.
    • ActivityId; integer; System generated nonnullable primary key of the table.
    • ActivityMtgMinutes; string; The activity meeting minutes.
    • ActivityNumber; string; The alternate identifier of the activity.
    • ActivityPartialDescription; string; A column that stores the first 4000 characters of activity description.
    • ActivityStartDate; string; The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task.
    • ActivitySubtypeCode; string; Displays a list of subtype values that are dependent on the value of the activity.
    • ActivityTypeCode; string; The type or category of the activity.
    • ActivityUpdateDate; string; The date when the activity was updated.
    • AllDayFlag; boolean; Designates that an appointment is the entire day.
    • AppointmentStatus; string; The status of the appointment.
    • ArticleVersionId; string; The unique identifier of the article version.
    • AssessmentId; integer; The unique identifier of the assessment.
    • AssetId; integer; The unique identifier of the asset.
    • AssetName; string; The name of the asset.
    • AssetNumber; string; The alternate identifier of the asset.
    • AssetSerialNumber; string; The serial number of the asset.
    • AutoLogSource; string; For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same activity.
    • BpId; integer; The unique identifier of the business plan.
    • BuOrgId; integer; The unique identifier for the Business Unit. This attribute is obsolete.
    • BusinessPlanName; string; The business plan name associated to the activity.
    • BusinessPlanNumber; string; The business plan number of the business plan associated with the activity.
    • CalendarRecurType; string; The activity recurrence type.
    • CalendarTimeType; string; Indicates all day appointment. (Internal Usage)
    • CallReportCount; integer; A 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; The unique identifier of the campaign.
    • CampaignName; string; The name of the campaign associated to the activity.
    • CampaignNumber; string; The campaign number of the campaign associated with the activity.
    • CaseId; integer; The unique identifier of the case.
    • CaseNumber; string; The alternate identifier of the case.
    • CaseTitle; string; The title of the case.
    • CheckedInBy; string; The name of the person who checks-in to a location.
    • CheckedOutBy; string; The name of the person who checks-out to a location.
    • CheckinDate; string; Stores the date and time when a user checks in to an appointment.
    • CheckinLatitude; number; Stores the latitude of a location where a user checks in to an appointment.
    • CheckinLongitude; number; Stores the longitude of a location where a user checks in to an appointment.
    • CheckoutDate; string; Stores the date and time when a user checks out of an appointment.
    • CheckoutLatitude; number; Stores the latitude of a location where a user checks out of an appointment.
    • CheckoutLongitude; number; Stores the longitude of a location where a user checks out of an appointment.
    • ClaimId; integer; The unique identifier of the claim.
    • ClaimName; string; The name associated to the activity.
    • ClaimNumber; string; The number of the claim associated with the activity.
    • ConflictId; integer; The unique internal identifier of the conflict
    • ContactIDAttr; integer; The internal contact identifier.
    • ContactNumber; string; The contact number of primary contact associated with the activity.
    • CreatedBy; string; The user who created the activity.
    • CreationDate; string; Attribute to capture the Date and Time the activity was created. This is defaulted by the application.
    • CurrentDateForCallReport; string; The current date for the call report.
    • CurrentDateForCallReportAttr; string; The internal attribute for the current date for the call report.
    • CurrentSystemDtTransient; string; The current system date,
    • CustomerAccountId; integer; The unique identifier of the customer account.
    • DealId; integer; The unique identifier of the related deal.
    • DealNumber; string; The deal number associated to the activity.
    • DelegatorId; integer; The activity resource that delegated activity ownership to another resource.
    • DelegatorName; string; The name of activity resource that delegated activity ownership to another resource.
    • DeleteFlag; boolean; Indicates whether the user has access to delete the record.
    • DirectionCode; string; The inbound or outbound. It's optional. The default is null.
    • DismissAssignee; string; Indicates whether the assignees is dismissed. Valid values are Y and N.
    • DismissFlag; boolean; Indicates whether this activity is dismissed.
    • DueDate; string; The date the task activity is due to be completed.
    • EmailSentDate; string; This field is used to capture the Activity Email Notification shared date for Outlook integration.
    • EndDateForCallReport; string; The end date of the call report.
    • EndDateForCallReportAttr; string; The internal attribute for end date of the call report.
    • EndDtRFAttr; string; The internal attribute for activity start date.
    • ExternalContactEmail; string; The email address of an external contact.
    • ExternalContactName; string; The name of an external contact.
    • ExternallyOwnedFlag; boolean; Indicates that the activity isn't created by an internal resource.
    • FundRequestId; integer; The unique identifier of the fund request.
    • FundRequestName; string; The fund request name associated to the activity.
    • FundRequestNumber; string; The fund request number of the fund request associated with the activity.
    • IbAssetId; integer; The unique identifier of the installed base asset associated with the activity.
    • IbAssetNumber; string; The number of the installed base asset associated with the activity.
    • LastUpdateDate; string; The attribute to capture the date and time the activity was last updated.
    • LastUpdatedBy; string; The attribute to capture the identifier of the user who last updated the activity.
    • LeadId; integer; Indicates the related lead to the activity.
    • LeadIdAttr; integer; The internal attribute for the lead Id.
    • LeadName; string; Indicates the lead name.
    • LeadNumber; string; The lead number of lead associated with the activity.
    • Location; string; Indicates the location of an appointment.
    • LocationId; integer; The location or address ID of the activity account or primary contact.
    • LoginUserRFAttr; integer; The internal attribute for activity login user.
    • ObjectiveId; integer; The unique identifier of the objective.
    • OpportunityId; integer; The unique identifier of the related opportunity.
    • OpportunityIdAttr; integer; The internal attribute for the opportunity Id.
    • OpportunityName; string; The name of opportunity associated to the activity.
    • OpportunityNumber; string; The opportunity number of the opportunity associated with the activity.
    • OrchestrationId; integer; The unique identifier to identify the orchestration process.
    • OrchestrationStepId; integer; The unique identifier to identify the orchestration step.
    • OsnActivityId; integer; The unique 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 code of the outcome of the activity.
    • OutlookAutoSyncFlag; boolean; Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365.
    • OutlookFlag; boolean; Indicates whether the activity was created from Outlook and synced.
    • OutlookGlobalId; string; The unique identifier of an appointment created from Microsoft 365.
    • OutlookIdentifier; string; The unique identifier from outlook activity.
    • OwnerId; integer; The primary resource on the activity. Supports resources only.
    • OwnerName; string; The name of primary resource of activity.
    • ParentActivityId; integer; The related activity identifier, only applicable if the record is a follow up activity.
    • ParentActivityIdAttr; string; The internal attribute for the parent activity Id.
    • PartialMtgMinutes; string; A column that stores a truncated string of the meeting minutes.
    • PartnerEnrollmentId; integer; The unique identifier of the partner enrollment.
    • PartnerPartyId; integer; The party identifier of the partner organization.
    • PartnerPartyName; string; The party name of the partner organization.
    • PartnerPartyNumber; string; The partner party number of partner associated with the activity.
    • PartnerProgramId; integer; The related partner program.
    • PartnerProgramNumber; string; The partner program number of partner program associated with the activity.
    • PercentageComplete; number; The numeric value 0 to100 to reflect the percent complete status of the activity. Free form numeric. Percentage value at end.
    • PrimaryContactEmailAddress; string; Hold the email identifier of the primary contact.
    • PrimaryContactId; integer; The primary contact of the activity.
    • PrimaryContactName; string; The name of the primary contact.
    • PriorityCode; string; The priority of the activity. Default to 2. Possible values: 1, 2, 3.
    • PrivateFlag; boolean; Indicates whether the activity is private.
    • RecordSet; string; The set of records to display in activity search.
    • RecurEndDate; string; Ends on a specified date.
    • RecurExceptionFlag; boolean; Indicates if appointment instance has been updated outside of recurring appointment series.
    • RecurRecType; string; For Internal Use Only. Either I for instance or S for series or N for nonrecurring. Don't populate it if Activity is of type Task.
    • RecurSeriesId; integer; Series Id that links instances of a series together.
    • RecurUpdatedAttributes; string; The updated field references for recurring appointment exception records.
    • ReferenceCustomerId; integer; The identifier of the reference customer party associated with the activity.
    • ResourceNumber; string; The resource number of owner associated with the activity.
    • ResponseCode; string; The response code.
    • SalesObjectiveName; string; The sales objective name associated to the activity.
    • SalesObjectiveNumber; string; The sales objective number of the sales objective associated with the activity.
    • SelectedFlag; boolean; The records selected for Mass Update (Internal Usage).
    • ShowStatus; string; Indicates whether the activity is open, complete, or all activities.
    • SmartActionContext; string; Stores metadata needed for smart action.
    • SmartActionId; integer; The smart action Identifier. Foreign key from zca_user_action.
    • SortDate; string; This is an internal column which is used to sort the activity based on the due date for task and start date for activity.
    • SrId; integer; The unique identifier of the service request.
    • SrNumber; string; The service request number.
    • StartDateForCallReport; string; The start date of the call report.
    • StartDateForCallReportAttr; string; The internal attribute for start date of the call report.
    • StartDtRFAttr; string; The internal attribute for Activity Start Date.
    • StatusCode; string; Status of the activity. Defaulted to NOT_STARTED.
    • Subject; string; The subject of the activity.
    • SubmittedByName; string; The name of the call report submitter.
    • SubmittedDate; string; The call report submission date.
    • TemplateFlag; string; Indicates whether this is a template activity.
    • TemplateId; integer; The unique identifier of the template.
    • 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 Rel9 Activity record.
    • UpgSourceObjectType; string; The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record
    • WebConferenceId; string; The unique identifier of the web conference.
    • WebConferenceURL; string; The web conference join URL.
    • WebconfSyncStatusFlag; boolean; The appointment interaction status.
  • 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 : hrHelpDeskRequests-activities
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : hrHelpDeskRequests-activities-item-response
Type: object
Show Source
Back to Top