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 learning assignments that match the specified primary key criteria.
Finder Variables- assignmentRelationId; integer; Unique identifier for the assignment relation.
- findByAssignee Finds all the related learning assignments that match the specified assignee criteria.
Finder Variables- dataSecurityPrivilege; string; Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
- learnerId; integer; Unique identifier for the learning assignee.
- findByAssignmentRecordId Finds all the related learning assignments that match the specified primary key criteria.
Finder Variables- assignmentRecordId; integer; Unique identifier for the assignment record.
- dataSecurityPrivilege; string; Data security privilege, such as Learner or Learner Manager, is the intent and permissions for the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
- findByLearningItem Finds all the related learning assignments that match the specified learning item criteria.
Finder Variables- dataSecurityPrivilege; string; Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. 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; Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
- learningItemTitle; string; Title of the learning item.
- findByManager Finds all the related learning assignments for the specified manager's subordinates.
Finder Variables- dataSecurityPrivilege; string; Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
- managerId; integer; Unique identifier for the learner's manager.
- findByPendingApproval Finds all learning assignments that the signed in person needs to approve.
Finder Variables - findMostRelevantAssignment Finds the most relevant learning assignments that match the specified primary key criteria.
Finder Variables- dataSecurityPrivilege; string; Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
- learningItemId; integer; Unique identifier for the learning Item.
- PrimaryKey Finds all the related learning 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 that the learner achieved for this assignment.
- actualEffortInHours; number; Actual learner effort, in hours, to complete the related learning assignment.
- actualScore; number; Actual learner score for the related learning assignment.
- assignedDate; string; Learning start date, visible to the learner on various self-service learning pages.
- assignedToDisplayName; string; Display name of the learning item assignee.
- assignedToId; integer; Unique identifier for the learning item assignee.
- assignedToNumber; string; Friendly number identifying the learning item assignee.
- assignedToPersonImageURL; string; Image URL for the learning item assignee.
- assignedToPersonPrimaryEmailAddress; string; Primary email address for learning item assignee.
- assignedToPersonPrimaryPhoneNumber; string; Primary phone number for the learning item assignee.
- assignedToType; string; Entity type for the related learning assignment assignee. Valid value is a person.
- assignedToTypeMeaning; string; Description of the assigned to type.
- assignerAttributionType; string; Entity type for the related learning assignment creator, such as person, specialist, or community. Valid values are defined in the AssignerToAttributionTypeLOV list.
- assignerAttributionTypeMeaning; string; Description of the assigner attribution type.
- assignerCommentsToLearner; string; Assigner comments to the learner made while creating the related learning assignment. It's null when there are no comments.
- assignerDisplayName; string; Display name of the related learning assignment creator. For example, it's the learner for voluntary assignments, and the specialist or the Assign As alias for specialist-created assignments.
- assignerId; integer; Unique identifier for the related learning assignment assigner.
- assignerNumber; string; Friendly number identifying the related learning assignment assigner.
- assignerPersonImageURL; string; Image URL for the person who assigned the learning item to the learner.
- assignerPersonPrimaryEmailAddress; string; Email address for the learning item assigner.
- assignerPersonPrimaryPhoneNumber; string; Phone number for the learning item assigner.
- assignmentAttributionId; integer; Unique identifier for the related learning assignment creator.
- assignmentCreatedDate; string; Date and time when the related learning assignment was created.
- assignmentDetailsDeepLink; string; URL to open the related learning enrollment page directly from the browser.
- assignmentDetailsEmbedLink; string; URL to embed the learning item page in the other pages. It opens the isolated learning item page without the global toolbar on the top.
- assignmentDueDate; string; Due date of the learning-specialist-created assignment. The value is null for voluntary assignments.
- assignmentDueInFromSystemDate; integer; Due date, in days, for the requested learning assignment.
- assignmentJustification; string; Justification provided by the learner during a request, or the justification added by the specialist in the learning request details during the related assignment.
- assignmentLastModifiedDate; string; Date and time when the related assignment was most recently updated.
- assignmentRecordId; integer; Unique identifier for the related learning enrollment.
- assignmentRecordNumber; string; Friendly number identifying the related learning enrollment in the user interface.
- assignmentRelationId; integer; Unique identifier for the learning assignment relation.
- assignmentRelationType; string; Type of learning assignment relation, such as previous completions that were expired by this learning enrollment and exempted learning enrollments allowing the learner to claim the credit. Valid values are defined in the AssignmentRelationTypeLOV list.
- assignmentRelationTypeMeaning; string; Description of the learning assignment relation type.
- assignmentStatus; string; Status of the related learning enrollment, such as Active, Content Completed, Completed, Withdrawn, or Deleted. Valid values are defined in the AssignmentStatusLOV list.
- assignmentStatusMeaning; string; Description of the learning assignment status.
- assignmentSubStatus; string; Granular status of the associated learning enrollment. For example, No Offering Selected, Not Started, In Progress, and Pending Active are various substatuses for the Active status. Valid values are defined in the AssignmentSubStatusLOV list.
- assignmentSubStatusMeaning; string; Description of the learning assignment substatus.
- assignmentType; string; Type of the related learning enrollment, such as required or voluntary. Valid values are defined in the AssignmentTypeLOV list.
- assignmentTypeMeaning; string; Description of the related learning assignment type.
- canEditAssignmentHint; string; Specifies whether you can edit the assignment hint, such as Can delete, Can withdraw, or No edit, for the related learning assignment. Valid values are defined in the CanEditAssignmentHintLOV list.
- canEditAssignmentHintMeaning; string; Description of the can edit learning assignment hint.
- completedDate; string; Date when the learning was completed.
- contentCompletedDate; string; Completed date for the requested learning assignment.
- currentWaitlistPosition; integer; Current waitlist position for the learner.
- dataSecurityPrivilege; string; Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
- dataSecurityPrivilegeMeaning; string; Description of the value of the dataSecurityPrivilege attribute.
- deletedDate; string; Date when the learner was removed from the waitlist.
- enteredPendingPaymentDate; string; Date when the related learning assignment was added to the pending payment.
- enteredPendingPrerequisitesDate; string; Date when the related learning assignment entered pending prerequisites.
- enteredWaitlistDate; string; Date when the learning assignment was added to the waitlist.
- evaluationSubmittedDate; string; Date when the requested learning assignment evaluation was submitted.
- exemptedDate; string; Date when the learning assignment was exempted.
- exitedPendingPrerequisitesDate; string; Date when the related learning assignment exited pending prerequisites.
- exitedWaitlistDate; string; Date when the learner exited the waitlist.
- expectedEffortInHours; string; Expected effort, in hours, 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 learning assignment.
- expirationRule; string; Expiration rule for the related learning assignment in a renewal scenario.
- hasFutureRenewal; string; Indicates whether the related learning assignment is of type Expiration and has a 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. Supported for completed and bypass completed course, specialization, and legacy learning assignments.
- 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 CpeTypeLOV list.
- learningItemCpeTypeMeaning; string; Description of 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 version to assign. It can be set to Latest or Assignment to Learner Date.
- learningItemEmbedLink; string; URL to embed the learning item page in the other pages. It opens the isolated learning item page without the global toolbar on the top.
- learningItemId; integer; Unique identifier for the learning item. It'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 user interface.
- learningItemPriceCurrency; string; Currency for the learning item price. Valid values are defined in the PriceCurrencyLOVVA list.
- learningItemPublisherDisplayName; string; Display name of the learning item publisher.
- learningItemSubType; string; Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.
- learningItemSubTypeMeaning; string; Description of 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, or eLearning. Valid values are defined in the AssignedLearningItemTypeLOV list.
- learningItemTypeMeaning; string; Description of the learning item type.
- liShortDescription; string; Short description provided while creating the learning item.
- liTotalExpectedEffort; number; Expected effort to complete the related learning assignment item.
- liTotalExpectedEffortUOM; string; Unit of measure for the expected effort to complete the related learning assignment item. Valid values are defined in the LiTotalExpectedEffortUomLOV list.
- liTotalExpectedEffortUOMMeaning; string; Description of the unit of measurement for the total expected effort.
- nextRenewalAssignmentDeepLink; string; URL to open the next renewal learning enrollment page directly from the browser.
- nextRenewalAssignmentEmbedLink; string; URL to embed the next renewal learning enrollment page in other pages. It opens the isolated learning item page without the global tool bar on the top.
- nextRenewalAssignmentId; integer; Unique identifier for the renewal assignment of the current learning assignment. It's applicable if the learning assignment has an expiration with renewal.
- nextRenewalAssignmentNumber; string; Friendly number for the renewal assignment of the current learning assignment. It's applicable if the learning assignment has an expiration with the renewal.
- purchaseAmount; number; Purchase amount for the requested learning assignment.
- purchaseCurrency; string; Purchase currency for the requested learning assignment. Valid values are defined in the PriceCurrencyLOVVA list.
- purchasedDate; string; Date the learning was purchased.
- reasonCode; string; Reason code for the learning assignment status change. Use this attribute when the learner's manager withdraws the assignment or marks it as complete. Valid values are defined in the ReasonCodeLOV list.
- refundRule; string; Refund rule for the learning assignment.
- renewalPeriod; number; Number of days before the current learning assignment expires to assign the renewed assignment.
- requestApprovedDate; string; Approved date for the requested learning assignment.
- requestRejectedDate; string; Rejected date for the requested learning assignment.
- requestedCompleteByDate; string; Requested date by when the learner should complete the related learning assignment.
- requestedDate; string; Date when the related learning assignment was requested.
- requestedStartDate; string; Learning request start date specified in the related learning assignment.
- startedDate; string; Start date for the requested learning assignment.
- statusChangeComment; string; Date when the comment status for the learning assignment was changed.
- validityPeriodRule; string; Validity period rule for the learning assignment indicating the period when the completed learning is valid.
- validityPeriodRuleMeaning; string; Description of the validity period rule.
- withdrawnDate; string; Date when the learner was withdrawn from the learning item.
- withdrawnRequestedDate; string; Withdrawal requested date for the learning 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:
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.
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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.