Get all related assignment records
get
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals/{pastRenewalsUniqID}/child/relatedLearningRecords
Request
Path Parameters
-
learnerLearningRecordsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Learner Learning Records resource and used to uniquely identify an instance of Learner Learning Records. The client should not generate the hash key value. Instead, the client should query on the Learner Learning Records collection resource in order to navigate to a specific instance of Learner Learning Records to get the hash key.
-
pastRenewalsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Past Renewals resource and used to uniquely identify an instance of Past Renewals. The client should not generate the hash key value. Instead, the client should query on the Past Renewals collection resource in order to navigate to a specific instance of Past Renewals to get the hash key.
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 -
finder: string
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 the related assignments that match the specified primary key criteria.
Finder Variables:- assignmentRelationId; integer; Application-generated primary key, surrogate key.
- findByAssignee: Finds all the related assignments that match the specified assignee criteria.
Finder Variables:- dataSecurityPrivilege; string; Role of the user accessing the learning assignment, such as ORA_LEARNER or ORA_LEARN_MANAGER. Valid values are defined in the list DataSecurityPrivilegeLOV.
- learnerId; integer; Unique identifier for the assignee.
- findByAssignmentRecordId: Finds all the related assignments that match the specified primary key criteria.
Finder Variables:- assignmentRecordId; integer; Application-generated primary key, surrogate key.
- dataSecurityPrivilege; string.
- findByLearningItem: Finds all the related assignments that match the specified learning item criteria.
Finder Variables:- dataSecurityPrivilege; string; Role of the user accessing the learning assignment, such as ORA_LEARNER or ORA_LEARN_MANAGER. Valid values are defined in the list DataSecurityPrivilegeLOV.
- learningItemId; integer; Unique identifier for the learning Item.
- findByLearningItemTitle: Finds all the related learning assignments for learning items that match the specified learning item criteria.
Finder Variables:- dataSecurityPrivilege; string.
- learningItemTitle; string; Title of the learning item.
- findByManager: Finds all the related assignments for the reportees of the specified manager.
Finder Variables:- dataSecurityPrivilege; string; Role of the user accessing the learning assignment, such as ORA_LEARNER or ORA_LEARN_MANAGER. Valid values are defined in the list DataSecurityPrivilegeLOV.
- managerId; integer; Unique identifier for the manager.
- findByPendingApproval: Finds all the related learning assignments that are pending approval from the signed-in user.
Finder Variables: - findMostRelevantAssignment: Finds the most relevant assignments that match the specified primary key criteria.
Finder Variables:- dataSecurityPrivilege; string.
- learningItemId; integer; Application-generated primary key, surrogate key.
- PrimaryKey: Finds all the related assignments that match the specified primary key criteria.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- actualCpeUnits; number; Continuing professional education units achieved by the learner for this assignment.
- actualEffortInHours; number; Actual effort in hours, taken by the learner to complete the related learning assignment.
- actualScore; number; Actual score achieved by the learner for the related learning assignment.
- assignedDate; string; Start date of the learning displayed to the learner in self-service.
- assignedToDisplayName; string; Display-name of the person to whom the learning item was assigned.
- assignedToId; integer; Unique identifier of the person to whom the learning item was assigned.
- assignedToNumber; string; Friendly number identifying the person to whom the learning item was assigned.
- assignedToPersonImageURL; string; Image URL for the person to whom the learning item was assigned.
- assignedToPersonPrimaryEmailAddress; string; Primary email address of the assignee to whom the learning item was assigned.
- assignedToPersonPrimaryPhoneNumber; string; Primary phone number of the assignee to whom the learning item was assigned.
- assignedToType; string; Entity type to whom the related learning record is assigned. Valid value is a person.
- assignedToTypeMeaning; string; Description for assigned to type.
- assignerAttributionType; string; Entity type that created the related learning record, such as person, specialist, or community. Valid values are defined in the list AssignerToAttributionTypeLOV.
- assignerAttributionTypeMeaning; string; Description for the assigner attribution type.
- assignerCommentsToLearner; string; Comments provided by the assigner to the learner while creating the related learning assignment. It's null when there are no comments.
- assignerDisplayName; string; Display-name of the person who created the related learning record for the learner. For example, it's the learner for voluntary assignments and specialist or the alias used in Assign As for specialist-created assignments.
- assignerId; integer; Unique identifier of the assigner of the related learning record.
- assignerNumber; string; Friendly number identifying the assigner of the related learning record.
- assignerPersonImageURL; string; Image URL of the person who assigned the learning item to the learner.
- assignerPersonPrimaryEmailAddress; string; Email address of the person who assigned the learning item to the learner.
- assignerPersonPrimaryPhoneNumber; string; Phone number of the person who assigned the learning item to the learner.
- assignmentAttributionId; integer; Unique identifier of the entity creating the related learning record.
- assignmentCreatedDate; string; Date and time when the related assignment was created.
- assignmentDetailsDeepLink; string; URL to open the related enrollment page directly from the browser.
- assignmentDetailsEmbedLink; string; URL used to embed the learning item page in the other pages. It opens the isolated learning item page without the global tool bar on the top.
- assignmentDueDate; string; Due date of the assignment provided by the learning specialist during the enrollment of a learning item. It's null for voluntary assignments.
- assignmentDueInFromSystemDate; integer; Due date in days for the requested assignment.
- assignmentJustification; string; Justification provided by the learner or a specialist in the Learning Request Details section during the related assignment.
- assignmentLastModifiedDate; string; Date and time when the related assignment was last updated.
- assignmentRecordId; integer; Unique identifier of the related enrollment record.
- assignmentRecordNumber; string; Friendly number identifying the related enrollment record in the UI.
- assignmentRelationId; integer; Unique identifier of the assignment relation.
- assignmentRelationType; string; Type of assignment relation, such as previous completions that were expired by this enrollment and exempted enrollments allowing the learner to claim the credit. Valid values are defined in the list AssignmentRelationTypeLOV.
- assignmentRelationTypeMeaning; string; Description for the assignment relation type.
- assignmentStatus; string; Status of the related enrollment, such as Active, Content Completed, Completed, Withdrawn, and Deleted. Valid values are defined in the list AssignmentStatusLOV.
- assignmentStatusMeaning; string; Description for the assignment status.
- assignmentSubStatus; string; Granular status of the associated enrollment. For example, No Offering Selected, Not Started, In Progress, and Pending Active are various substatuseses for the Active status. Valid values are defined in the list AssignmentSubStatusLOV.
- assignmentSubStatusMeaning; string; Description for the assignment substatus.
- assignmentType; string; Type of the related enrollment, such as required or voluntary. Valid values are defined in the list AssignmentTypeLOV.
- assignmentTypeMeaning; string; Description for the related assignment type.
- canEditAssignmentHint; string; Specifies whether you can edit the assignment hint on the related learning record, such as Can delete, Can withdraw, No edit. Valid values are defined in the list CanEditAssignmentHintLOV.
- canEditAssignmentHintMeaning; string; Description for the can edit assignment hint.
- completedDate; string; Date when the learning was completed.
- contentCompletedDate; string; Completed date for the requested assignment.
- currentWaitlistPosition; integer; Current waitlist position of the learner.
- dataSecurityPrivilege; string; Data security privilege, such as Learner or Learner Manager, is the role of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
- dataSecurityPrivilegeMeaning; string; Description for the data security privilege.
- deletedDate; string; Date when the learner is removed from the waitlist.
- enteredPendingPaymentDate; string; Date when the related assignment record was added to the pending payment.
- enteredPendingPrerequisitesDate; string; Date when the related assignment record entered pending prerequisites.
- enteredWaitlistDate; string; Date when the assignment record was added to the waitlist.
- evaluationSubmittedDate; string; Date when the evaluation was submitted for the requested assignment.
- exemptedDate; string; Date when the assignment record was exempted.
- exitedPendingPrerequisitesDate; string; Date when the related assignment record exited pending prerequisites.
- exitedWaitlistDate; string; Date when the learner exited the waitlist.
- expectedEffortInHours; string; Expected effort in hours, to be put in by the learner to complete the related learning assignment.
- expirationDate; string; Date when the assignment expired in a renewal scenario.
- expirationInDaysSystemDate; number; Expiration time in days for the requested assignment.
- expirationRule; string; Expiration rule for the related learning assignment in a renewal scenario.
- hasFutureRenewal; string; Indicates that the related learning assignment is of expiration type and has future renewal.
- hasPastRenewal; string; Indicates whether the related learning assignment has a past renewal.
- learningItemCompletionCertificateLink; string; URL to open and download the learning item completion certificate directly from the browser. This is supported for completed and bypass completed assignments of a course, specialization, or legacy learning item type.
- learningItemCoverArtLink; string; URL to open the learning item cover art directly from the browser.
- learningItemCpeType; string; Continuing professional education type of the learning item. Valid values are defined in the list CpeTypeLOV.
- learningItemCpeTypeMeaning; string; Description for the continuing professional education type.
- learningItemDataLink; string; Data link to the learning item.
- learningItemDeepLink; string; URL to open the learning item page directly from the browser.
- learningItemEffectiveAsOf; string; Learning item definition to be assigned. It can be set to Latest or Assignment to Learner Date.
- learningItemEmbedLink; string; URL used to embed the learning item page in the other pages. It opens the isolated learning item page without the global tool bar on the top.
- learningItemId; integer; Unique identifier of the learning item that's the internal primary key.
- learningItemMaximumPrice; number; Maximum price for the learning item.
- learningItemMinimumPrice; number; Minimum price for the learning item.
- learningItemNumber; string; Friendly number identifying the learning item. It's a surrogate key that's shown in the UI.
- learningItemPriceCurrency; string; Currency of the price for the learning item. Valid values are defined in the list PriceCurrencyLOVVA.
- learningItemPublisherDisplayName; string; Display-name of the publisher of the learning item.
- learningItemSubType; string; Learning item subtype, such as Video and Tutorial. Valid values are defined in the list AssignedLearningItemSubTypeLOV.
- learningItemSubTypeMeaning; string; Description for the learning item subtype.
- learningItemThumbnailLink; string; URL to open the learning item thumbnail directly from the browser.
- learningItemTitle; string; Title of the learning item.
- learningItemTrailerLink; string; URL to open the learning item trailer directly from the browser.
- learningItemType; string; Learning item type, such as Course, Specialization, Tutorial, Video, and eLearning. Valid values are defined in the list AssignedLearningItemTypeLOV.
- learningItemTypeMeaning; string; Description for the learning item type.
- liShortDescription; string; Learning item short description provided while creating the learning item.
- liTotalExpectedEffort; number; Expected effort to complete the learning item of the related learning record.
- liTotalExpectedEffortUOM; string; Unit of measurement for the expected effort to complete the learning item of the related learning record. Valid values are defined in the list LiTotalExpectedEffortUomLOV.
- liTotalExpectedEffortUOMMeaning; string; Description for the unit of measurement for the total expected effort.
- nextRenewalAssignmentDeepLink; string; URL to open the next renewal enrollment page directly from the browser.
- nextRenewalAssignmentEmbedLink; string; URL used to embed the next renewal enrollment page in other pages. It opens the isolated learning item page without the global tool bar on the top.
- nextRenewalAssignmentId; integer; Unique identifier of the renewal assignment for the current assignment. It's applicable if the learning assignment has an expiration with renewal.
- nextRenewalAssignmentNumber; string; Friendly number of the renewal assignment for current assignment. It's applicable if the learning assignment has an expiration with the renewal.
- purchaseAmount; number; Purchase amount for the requested assignment.
- purchaseCurrency; string; Currency of purchase for the requested assignment. Valid values are defined in the list PriceCurrencyLOVVA.
- purchasedDate; string; Date of purchase of the paid learning.
- reasonCode; string; Assignment reason code of the assignment. This attribute is used when the learner assignment is withdrawn or marked complete by the manager. Valid values are defined in the list ReasonCodeLOV.
- refundRule; string; Refund rule for the assignment.
- renewalPeriod; number; Number of days before the current learning assignment expires to assign the renewed assignment.
- requestApprovedDate; string; Approved date for the requested assignment.
- requestRejectedDate; string; Rejected date for the requested assignment.
- requestedCompleteByDate; string; Requested date by which the learner should complete the related learning assignment.
- requestedDate; string; Date when the related learning record was requested.
- requestedStartDate; string; Learning request start date specified in the related learning record.
- startedDate; string; Start date for the requested assignment.
- statusChangeComment; string; Date when the comment status of the assignment was changed.
- validityPeriodRule; string; The validity period rule for the assignment indicates the period for which completed learning is valid.
- validityPeriodRuleMeaning; string; Description for the validity period rule.
- withdrawnDate; string; Date when the learner was withdrawn from the learning item.
- withdrawnRequestedDate; string; Assignment withdrawal requested date of the assignment.
-
totalResults: boolean
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
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
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.