Get a past renewal
get
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals/{pastRenewalsUniqID}
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of: string
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. -
Metadata-Context: string
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: string
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.
Root Schema : learnerLearningRecords-pastRenewals-item-response
Type:
Show Source
object-
activeDate: string
(date-time)
Title:
Active DateDate when the learning assignment moved to an active status. -
actualCpeUnits: number
Title:
Actual CPE UnitsContinuing professional education units that the learner achieved for this assignment. -
actualEffortInHours: number
Title:
Actual Effort in HoursActual effort, in hours, that it took the learner to complete the assignment. -
actualScore: number
Title:
Actual ScoreLearner score for this assignment. -
assignedDate: string
(date-time)
Title:
Enrolled on DateDate when the learning item was assigned. -
assignedToDisplayName: string
Title:
Assignee Display NameRead Only:trueMaximum Length:240Display name for the learning item assignee. -
assignedToId: integer
(int64)
Title:
Assignee Person IDUnique identifier for the learning item assignee. -
assignedToNumber: string
Title:
Assignee Person NumberRead Only:trueMaximum Length:30Friendly number identifying the learning item assignee. -
assignedToPersonImageURL: string
Title:
Assignee Person Image URLRead Only:trueMaximum Length:19Image URL for the learning item assignee. -
assignedToPersonPrimaryEmailAddress: string
Title:
Assignee Primary Email AddressRead Only:trueMaximum Length:240Primary email address for the learning item assignee. -
assignedToPersonPrimaryPhoneNumber: string
Title:
Assignee Primary Phone NumberRead Only:trueMaximum Length:60Primary phone number for the learning item assignee. -
assignedToType: string
Title:
Assignee Attribution TypeRead Only:trueMaximum Length:19Entity type for the learning assignment assignee. The valid value is person. -
assignedToTypeMeaning: string
Title:
Assignee Attribution Type DescriptionRead Only:trueMaximum Length:4000Description of the assignedToType attribute value. -
assignerAttributionType: string
Title:
Assigner Attribution TypeMaximum Length:30Default Value:ORA_PERSONEntity type for the learning assignment creator, such as person, specialist, or community. Valid values are defined in the AssignerToAttributionTypeLOV list. -
assignerAttributionTypeMeaning: string
Title:
Assigner Attribution Type DescriptionRead Only:trueMaximum Length:4000Description of the assignerAttributionType attribute value. -
assignerCommentsToLearner: string
Title:
Assigner Comments to LearnerMaximum Length:4000Assigner comments to the learner made when creating the assignment. The value is null when there's no comment. -
assignerDisplayName: string
Title:
Enrolled ByRead Only:trueMaximum Length:240Display name for the learning assignment creator. For example, in case of voluntary assignment, it's the name of the learner. For a specialist created assignment, it's the name of the specialist or the specified Assign As alias. -
assignerId: integer
(int64)
Title:
Assigner IDRead Only:trueIdentifier for the learning item assigner. -
assignerNumber: string
Title:
Assigner NumberRead Only:trueMaximum Length:30Number for identifying the learning item assigner. -
assignerPersonImageURL: string
Title:
Assigner Person Image URLRead Only:trueMaximum Length:19Image URL for the learning item assigner. -
assignerPersonPrimaryEmailAddress: string
Title:
Assigner Person Primary Email AddressRead Only:trueMaximum Length:240Email address for the learning item assigner. -
assignerPersonPrimaryPhoneNumber: string
Title:
Assigner Person Primary Phone NumberRead Only:trueMaximum Length:60Phone number for learning item assigner. -
assignmentAttributionId: integer
(int64)
Title:
Assigner Attribution IDUnique identifier for the entity that created the learning assignment. -
assignmentCreatedDate: string
(date-time)
Title:
Assignment Created DateRead Only:trueDate and time when the learning assignment was created. -
assignmentDetailsDeepLink: string
Title:
Assignment Details Deep LinkRead Only:trueMaximum Length:4000URL to open the learning assignment item page directly from the browser. -
assignmentDetailsEmbedLink: string
Title:
Assignment Details Embed LinkRead Only:trueMaximum Length:4000URL to embed the learning item page in other pages. It opens the isolated learning item page without the global toolbar on the top. -
assignmentDueDate: string
(date-time)
Title:
Due DateDue date of the learning-specialist-created assignment. The value is null for voluntary assignments. -
assignmentDueInFromSystemDate: integer
Title:
Assignment Due in from System DateRead Only:trueDue in days for the requested learning assignment. -
assignmentJustification: string
Title:
JustificationMaximum Length:4000Justification provided by the specialist when assigning, or the learner when enrolling in, a learning item. -
assignmentLastModifiedDate: string
(date-time)
Title:
Assignment Last Modified DateRead Only:trueDate and time when the learning assignment was most recently updated. -
assignmentRecordId: integer
(int64)
Title:
Enrollment Record IDApplication-generated primary key. -
assignmentRecordNumber: string
Title:
Enrollment NumberRead Only:trueMaximum Length:30Number for identifying past learning renewal assignments. -
assignmentStateMeaning: string
Read Only:
trueMaximum Length:255Indicates the current state of an enrollment, usually including the enrollment status. For example, Completed - Expired or Required - Overdue. -
assignmentStateSeverity: string
Read Only:
trueMaximum Length:255Indicates the severity of the enrollment state, such as FATAL, WARN or INFO. For example, an overdue enrollment would have a severity of FATAL. -
assignmentStatus: string
Title:
Enrollment Record StatusMaximum Length:32Default Value:ORA_ASSN_REC_ACTIVEStatus for the learning enrollment, such as Active, Content Completed, Completed, Withdrawn, or Deleted. Valid values are defined in the AssignmentStatusLOV list. -
assignmentStatusMeaning: string
Title:
Enrollment Record Status DescriptionRead Only:trueMaximum Length:4000Description of the assignmentStatus attribute value. -
assignmentSubStatus: string
Title:
Enrollment Record SubstatusMaximum Length:30Default Value:ORA_ASSN_REC_NOTSTARTEDLearning enrollment substatus, such as Not Started, or In Progress. Valid values are defined in the AssignmentSubStatusLOV list. -
assignmentSubStatusMeaning: string
Title:
Enrollment Record Substatus DescriptionRead Only:trueMaximum Length:4000Description of the assignmentSubStatus attribute value. -
assignmentType: string
Title:
Enrollment TypeMaximum Length:30Type of the learning enrollment, such as required or voluntary. Valid values are defined in the AssignmentTypeLOV list. -
assignmentTypeMeaning: string
Title:
Enrollment Type DescriptionRead Only:trueMaximum Length:4000Description of the assignmentType attribute value. -
canEditAssignmentHint: string
Title:
Can Edit Assignment HintMaximum Length:4000Hint to identify if the user can edit the learning assignment, such as Can delete, Can withdraw, or No edit. Valid values are defined in the CanEditAssignmentHintLOV list. -
canEditAssignmentHintMeaning: string
Title:
Can Edit Assignment Hint DescriptionRead Only:trueMaximum Length:4000Description of the canEditAssignmentHint attribute value. -
completedDate: string
(date-time)
Title:
Completed DateDate when the learning was completed. -
contentCompletedDate: string
(date)
Title:
Content Completed DateRead Only:trueCompleted date for past learning assignment renewals. -
contentCompletedTimestamp: string
(date-time)
Title:
Content Completed DateRead Only:trueDate and time when the learning content was completed. -
currentWaitlistPosition: integer
(int64)
Title:
Current Waitlist PositionRead Only:trueCurrent waitlist position of the learner. -
dataSecurityPrivilege: string
Title:
Data Security PrivilegeMaximum Length:32Data 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
Title:
Data Security Privilege DescriptionRead Only:trueMaximum Length:4000Description of the value of the dataSecurityPrivilege attribute. -
deletedDate: string
(date-time)
Title:
Deleted DateRead Only:trueDate when the learner was removed from the waitlist. -
enrollmentQuestionnaireId: integer
Unique identifier for the learning enrollment questionnaire.
-
enteredPendingPaymentDate: string
(date-time)
Title:
Entered Pending Payment DateRead Only:trueDate when the learning assignment was added to the pending payment. -
enteredPendingPrerequisitesDate: string
(date)
Title:
Date Learner Entered Pending PrerequisitesRead Only:trueDate when the learning assignment entered pending prerequisites. -
enteredPendingPrerequisitesTimestamp: string
(date-time)
Title:
Date Learner Entered Pending PrerequisitesRead Only:trueDate and time when the learning assignment entered pending prerequisites. -
enteredPendingSeatAcceptanceDate: string
(date-time)
Title:
Date Learning Item Entered Pending Seat AcceptanceDate when the learning assignment entered the pending seat acceptance status. -
enteredWaitlistDate: string
(date)
Title:
Date Learner Entered WaitlistRead Only:trueDate when the learning assignment was added to the waitlist. -
enteredWaitlistTimestamp: string
(date-time)
Title:
Date Learner Entered WaitlistRead Only:trueDate and time when the learning assignment was added to the waitlist. -
evaluationSubmittedDate: string
(date)
Title:
Evaluation Submission DateRead Only:trueEvaluation submitted for past learning assignment renewals. -
evaluationSubmittedTimestamp: string
(date-time)
Title:
Evaluation Submission DateRead Only:trueDate and time when the evaluation was submitted. -
exemptedDate: string
(date-time)
Title:
Exempted DateRead Only:trueDate when the learning assignment was exempted. -
exitedPendingPrerequisitesDate: string
(date)
Title:
Date Learner Exited Pending PrerequisitesRead Only:trueDate when the learning assignment exited pending prerequisites. -
exitedPendingPrerequisitesTimestamp: string
(date-time)
Title:
Date Learner Exited Pending PrerequisitesRead Only:trueDate and time when the learning assignment exited pending prerequisites. -
exitedPendingSeatAcceptanceDate: string
(date-time)
Title:
Date Learning Item Exited Pending Seat AcceptanceDate when the learning assignment exited the pending seat acceptance status. -
exitedWaitlistDate: string
(date)
Title:
Date Learner Exited WaitlistRead Only:trueDate when the learner exited the waitlist. -
exitedWaitlistTimestamp: string
(date-time)
Title:
Date Learner Exited WaitlistRead Only:trueDate and time when the learner was removed from the learning item waitlist. -
expectedEffortInHours: string
Title:
Expected EffortRead Only:trueMaximum Length:83Expected learner effort to complete the learning assignment. -
expirationDate: string
(date)
Title:
Expiration DateRead Only:trueDate when the learning assignment expired, in the case of a renewal scenario. -
expirationInDaysSystemDate: number
Title:
Expiration in Days from TodayRead Only:trueExpiration in days for the requested learning assignment. -
expirationRule: string
Title:
ExpiresRead Only:trueMaximum Length:80Expiration rule for the learning assignment, in the case of a renewal scenario. -
expirationRuleCode: string
Read Only:
trueMaximum Length:30Code that represents the expirationRule attribute. -
expirationTimestamp: string
(date-time)
Title:
Expiration DateRead Only:trueDate and time when the learning will expire. -
hasFutureRenewal: string
Title:
Requires RenewalRead Only:trueMaximum Length:20Indicates whether the learning assignment is of type Expiration and has future renewal. -
hasPastRenewal: string
Title:
Past Renewal ExistsRead Only:trueMaximum Length:1Indicates whether the learning assignment has past renewals. -
isLearnerOnLatestLIVersion: string
Title:
Learner on Latest Learning Item VersionRead Only:trueMaximum Length:1Indicates whether the learning enrollment uses the most recent learning item version. Valid values are Y and N. The default value is Y. -
learningItemAuthorDisplayName: string
Read Only:
trueMaximum Length:2000Display name the learning item author. -
learningItemAuthorEmailAddress: string
Read Only:
trueMaximum Length:255Primary email address of the person. -
learningItemAuthorPersonId: integer
Read Only:
truePerson identifier for the learning item author. -
learningItemAuthorPhoneNumber: string
Read Only:
trueMaximum Length:60Phone number for the learning item author. -
learningItemAuthorType: string
Read Only:
trueMaximum Length:32Learning author type. Valid values are ORA_PERSON or ORA_ADHOC. -
learningItemCompletionCertificateLink: string
Title:
Learning Item Completion Certificate LinkURL to open and download the learning item completion certificate directly from the browser. This is supported for completed and bypass completed assignments for a course, specialization, or legacy learning item type. -
learningItemCoordDisplayName: string
Read Only:
trueMaximum Length:2000Display name of the learning item coordinator. -
learningItemCoordEmailAddress: string
Read Only:
trueMaximum Length:255Primary email address of the person. -
learningItemCoordPersonId: integer
Read Only:
truePerson identifier for the learning item coordinator. -
learningItemCoordPhoneNumber: string
Read Only:
trueMaximum Length:60Phone number for the learning item coordinator. -
learningItemCoverArtLink: string
Title:
Learning Item Cover Art LinkRead Only:trueMaximum Length:4000URL to open the learning item cover art directly from the browser. -
learningItemCpeType: string
Title:
Learning Item CPE TypeMaximum Length:30Continuing professional education type for the learning item. Valid values are defined in the CpeTypeLOV list. -
learningItemCpeTypeMeaning: string
Title:
Learning Item CPE Type DescriptionRead Only:trueMaximum Length:4000Description of the learningItemCpeType attribute value. -
learningItemDataLink: string
Title:
Learning Item Data LinkRead Only:trueMaximum Length:4000Data link to the learning item. -
learningItemDeepLink: string
Title:
Learning Item Deep LinkMaximum Length:4000URL to open the past learning renewals item page directly from the browser. -
learningItemDefinitionUsedDate: string
(date-time)
Title:
Learning Item Definition Used DateRead Only:trueMost recent updated date for the learning enrollment based on the learning item version as of this day. -
learningItemEffectiveAsOf: string
(date)
Title:
Assigned Learning Effective DateRead Only:trueEffective start date of the learning item. -
learningItemEffectiveDate: string
(date-time)
Read Only:
trueEffective date of the learning item. -
learningItemEmbedLink: string
Title:
Learning Item Embed LinkRead Only:trueMaximum Length:4000URL to embed the learning item page in other pages. It opens the isolated learning item page without the global toolbar on the top. -
learningItemId: integer
(int64)
Title:
Assigned Learning Item IDUnique identifier for the learning item. It's the internal primary key. -
learningItemInstructorDisplayName: string
Read Only:
trueMaximum Length:2000Display name for the learning item instructor. -
learningItemInstructorEmailAddress: string
Read Only:
trueMaximum Length:255Primary email address of the person. -
learningItemInstructorPersonId: integer
Read Only:
truePerson identifier for the learning item instructor. -
learningItemInstructorPersonNumber: string
Read Only:
trueMaximum Length:30Person number of the learning item instructor. -
learningItemInstructorPrimaryPhoneNumber: string
Read Only:
trueMaximum Length:2000Phone number of the instructor of the learning item. -
learningItemInstructorType: string
Read Only:
trueMaximum Length:32Type of instructor. Valid values are ORA_PERSON or ORA_ADHOC -
learningItemInstructorTypeMeaning: string
Read Only:
trueMaximum Length:4000Meaning for the learningItemType attribute. -
learningItemLatestChangeEventDate: string
(date-time)
Title:
Learning Item Latest Change DateRead Only:trueDate when the learning item was most recently changed. -
learningItemMaximumPrice: number
Title:
Learning Item Maximum PriceMaximum price for the learning item. -
learningItemMinimumPrice: number
Title:
Learning Item Minimum PriceMinimum price for the learning item. -
learningItemNotificationPattern: string
Read Only:
trueMaximum Length:32Notification pattern, such as Default Notification Pattern. -
learningItemNumber: string
Title:
Assigned Learning Item NumberMaximum Length:30Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface. -
learningItemPriceCurrency: string
Title:
Learning Item CurrencyCurrency for the learning item price. Valid values are defined in the PriceCurrencyLOVVA list. -
learningItemPublisherDisplayName: string
Title:
Published ByRead Only:trueMaximum Length:240Name of the learning item publisher. -
learningItemSubType: string
Title:
Assigned Learning Item SubtypeMaximum Length:30Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list. -
learningItemSubTypeMeaning: string
Read Only:
trueMaximum Length:4000Description of the learningItemSubType attribute value. -
learningItemThumbnailLink: string
Title:
Learning Item Thumbnail LinkRead Only:trueMaximum Length:4000URL to open the learning item thumbnail directly from the browser. -
learningItemTitle: string
Title:
Assigned Learning Item TitleMaximum Length:250Title of the learning item. -
learningItemTrailerLink: string
Title:
Learning Item Trailer LinkRead Only:trueMaximum Length:4000URL to open the learning item trailer directly from the browser. -
learningItemType: string
Title:
Assigned Learning Item TypeMaximum Length:32Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the AssignedLearningItemTypeLOV list. -
learningItemTypeMeaning: string
Title:
Assigned Learning Item Type DescriptionRead Only:trueMaximum Length:4000Description of the learningItemType attribute value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
liShortDescription: string
Title:
Learning Item Short DescriptionMaximum Length:4000Description provided while creating the learning item. -
liTotalExpectedEffort: number
Title:
Learning Item Total Expected EffortExpected effort to complete the past learning renewal item. -
liTotalExpectedEffortUOM: string
Title:
Learning Item Total Expected Effort UnitsMaximum Length:30Effort expected to complete the past learning renewal item. Valid values are defined in the LiTotalExpectedEffortUomLOV list. -
liTotalExpectedEffortUOMMeaning: string
Title:
Learning Item Total Expected Effort Units DescriptionRead Only:trueMaximum Length:4000Description of the liTotalExpectedEffortUOM attribute value. -
nextRenewalAssignmentDeepLink: string
Title:
Next Renewal Assignment Deep LinkRead Only:trueMaximum Length:4000URL to open the next learning renewal item page directly from the browser. -
nextRenewalAssignmentEmbedLink: string
Title:
Next Renewal Assignment Embed LinkRead Only:trueMaximum Length:4000URL to embed the learning item page in other pages. It opens the isolated learning item page without the global toolbar on the top. -
nextRenewalAssignmentId: integer
(int64)
Title:
Renewal Assignment IDRead Only:trueIdentifier of the learning renewal assignment. Applies if the learning assignment has an expiration with renewal. -
nextRenewalAssignmentNumber: string
Title:
Renewal Assignment NumberRead Only:trueMaximum Length:30Assignment number for the renewal learning assignment. Applies if the learning assignment has an expiration with renewal. -
purchaseAmount: number
Title:
Purchase AmountPurchase amount for the requested past learning renewals. -
purchaseCurrency: string
Title:
Purchase CurrencyMaximum Length:19Purchase currency for the past learning renewal. Valid values are defined in the PriceCurrencyLOVVA list. -
purchasedDate: string
(date)
Title:
Purchased DateRead Only:trueDate of purchase for the learning transaction, if the learning is paid. -
purchasedTimestamp: string
(date-time)
Title:
Purchased DateRead Only:trueDate and time for the purchase of the paid learning. -
reasonCode: string
Title:
Status Change Reason CodeMaximum Length:30Reason code for the learning renewal assignment. Applies if the learning assignment has an expiration with renewal. Valid values are defined in the ReasonCodeLOV list. -
refundRule: string
Title:
Refund RuleRead Only:trueMaximum Length:240Refund rule for the learning renewal assignment. - relatedLearningRecords: array Related Learning Records
-
renewalPeriod: number
Title:
Renewal PeriodRead Only:trueNumber of days before the learning assignment expiration when the learner is assigned the renewal assignment. -
requestApprovedDate: string
(date)
Title:
Request Approval DateRead Only:trueApproved date for the requested learning assignment. -
requestApprovedTimestamp: string
(date-time)
Title:
Request Approval DateRead Only:trueDate and time when the learning assignment approval request was assigned to the approver. -
requestedCompleteByDate: string
(date)
Title:
Request Completion DateRequested date by when the learner should complete the learning assignment. -
requestedDate: string
(date-time)
Title:
Requested DateRead Only:trueDate when the learning assignment was requested. -
requestedStartDate: string
(date-time)
Title:
Requested Start ByRequest start date specified in the learning assignment. -
requestRejectedDate: string
(date)
Title:
Request Rejection DateRead Only:trueRejected date for the requested learning assignment. -
requestRejectedTimestamp: string
(date-time)
Title:
Request Rejection DateRead Only:trueDate and time when the learning assignment request was rejected.. -
sourceId: integer
(int64)
Title:
Enrollment Source IdentifierUnique identifier for the source where this assignment was created. -
sourceType: string
Title:
Enrollment Source TypeMaximum Length:30Type for the source where this assignment was created, such as Recommendation or Search. -
startedDate: string
(date)
Title:
Assignment Start DateRead Only:trueStart date for the requested past learning renewals. -
startedTimestamp: string
(date-time)
Title:
Assignment Start DateRead Only:trueDate and time when the learner started the learning assignment. -
statusChangeComment: string
Title:
CommentsMaximum Length:4000Comment status change date for the learning assignment. -
validityPeriodRule: string
Title:
Validity Period OptionRead Only:trueMaximum Length:30Validity period rule for the assignment indicating when the validity period for the completed learning begins. -
validityPeriodRuleMeaning: string
Title:
Validity Period Option DescriptionRead Only:trueMaximum Length:4000Description of the validityPeriodRule attribute value. -
viewModeOverrideLearningItemId: integer
Identifier for the parent learning item when the view mode is overridden by the parent's setting.
-
withdrawnDate: string
(date-time)
Title:
Withdrawn DateRead Only:trueDate when the learner withdrew from the learning item. -
withdrawnRequestedDate: string
(date-time)
Title:
Withdrawn Requested DateRead Only:trueAssignment withdrawn requested date for the learning renewal assignment. Applies if the learning assignment has an expiration with renewal.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
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.
Links
- AssignedLearningItemSubTypeLOV
-
Parameters:
- finder:
LookupTypeFinder
The following properties are defined on the LOV link relation:- Source Attribute: learningItemSubType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AssignedToTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ATTRIBUTION_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: assignedToType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AssignerToAttributionTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ATTRIBUTION_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: assignerAttributionType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AssignmentStatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSIGN_RECORD_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: assignmentStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AssignmentSubStatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSIGN_RECORD_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: assignmentSubStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CanEditAssignmentHintLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_CAN_EDIT_ASSIGNMENT_HINT
The following properties are defined on the LOV link relation:- Source Attribute: canEditAssignmentHint; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CpeTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_CPE_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: learningItemCpeType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- DataSecurityPrivilegeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSIGNMENT_SEC_CONTEXT
The following properties are defined on the LOV link relation:- Source Attribute: dataSecurityPrivilege; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemAuthorTypeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_AUTHOR_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: learningItemAuthorType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemNotificationPatternLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_NOTIF_PATTERN
The following properties are defined on the LOV link relation:- Source Attribute: learningItemNotificationPattern; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LiTotalExpectedEffortUomLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LEARN_DURATION_UOM
The following properties are defined on the LOV link relation:- Source Attribute: liTotalExpectedEffortUOM; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ReasonCodeLOV
-
Parameters:
- finder:
LookupTypeFinder
The following properties are defined on the LOV link relation:- Source Attribute: reasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ValidityPeriodOptionLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_CO_VALIDITY_OPTIONS
The following properties are defined on the LOV link relation:- Source Attribute: validityPeriodRule; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- relatedLearningRecords
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID - pastRenewalsUniqID:
$request.path.pastRenewalsUniqID
The relatedLearningRecords resource provides details of the related learning assignments for the learning assignment. - learnerLearningRecordsUniqID: