1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Learning Events
  4. Activities

Get all activities

get

/hcmRestApi/resources/11.13.18.05/learningEvents/{learningEventsUniqID}/child/activities

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Learning Events resource and used to uniquely identify an instance of Learning Events. The client should not generate the hash key value. Instead, the client should query on the Learning Events collection resource in order to navigate to a specific instance of Learning Events to get the hash key.
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>
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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

    • PrimaryKey Finds all activities that match the specified primary key criteria.
      Finder Variables
      • activityId; integer; Unique identifier for the activity.
    • findByActivityNumber Finds all activities that match the specified activity number.
      Finder Variables
      • SysEffectiveDate; object;
      • activityNumber; string; Friendly number identifying 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:
    • activityId; integer; Unique identifier for the activity.
    • activityNumber; string; Friendly number identifying the activity.
    • activityType; string; Activity type, such as Internal or External.
    • attendanceConfirmationURL; string; Link to the page where the learner can confirm attendance for an activity.
    • attendanceQRDownloadURL; string; Link to the page where the learner can download the QR code to confirm attendance for an activity.
    • classroomDisplayName; string; Display name of the activity classrooms.
    • completionRule; string; Completion rule that determines how the content handles completions. It also determines if manager or learner confirmation is required.
    • completionType; string; Completion type for the activity, such as Mandatory or Optional.
    • endDate; string; End date for the activity.
    • expectedEffortInSeconds; number; Expected effort needed by the learner to complete the learning item.
    • externalDetailsURL; string; Details URL for the activity.
    • startDate; string; Start date for the activity.
    • status; string; Status for the activity
    • timezone; string; Time zone for the activity
  • 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
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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 : learningEvents-activities
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : learningEvents-activities-item-response
Type: object
Show Source
Nested Schema : Ad Hoc Resources
Type: array
Title: Ad Hoc Resources
The adhocResources resources captures the details of additional resources required for an instructor-led training, such as printers or whiteboards.
Show Source
Nested Schema : Classrooms
Type: array
Title: Classrooms
The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.
Show Source
Nested Schema : Instructors
Type: array
Title: Instructors
The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
Show Source
Nested Schema : Related Materials
Type: array
Title: Related Materials
The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.
Show Source
Nested Schema : learningEvents-activities-adhocResources-item-response
Type: object
Show Source
Nested Schema : learningEvents-activities-classroomDetails-item-response
Type: object
Show Source
Nested Schema : learningEvents-activities-instructorDetails-item-response
Type: object
Show Source
Nested Schema : learningEvents-activities-relatedMaterials-item-response
Type: object
Show Source
  • Links
  • Related Materials Binaries
    Title: Related Materials Binaries
    The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
  • Maximum Length: 80
    Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.
Nested Schema : Related Materials Binaries
Type: array
Title: Related Materials Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : learningEvents-activities-relatedMaterials-relatedMaterialsBinaries-item-response
Type: object
Show Source
Back to Top