Get all past renewals
get
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals
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.
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> -
effectiveDate: string
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
-
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 past renewal assignments that match the specified primary key criteria.
Finder Variables:- assignmentRecordId; integer; Application-generated primary key, surrogate key.
- findByAssignmentRecordId: Finds all the past renewal assignments that match the specified primary key criteria.
Finder Variables:- SysEffectiveDate; object.
- assignmentRecordId; integer; Application-generated primary key, surrogate key.
- dataSecurityPrivilege; string.
- findByLearningItemTitle: Finds all the past renewal assignments for learning Items that match the specified learning Item criteria.
Finder Variables:- SysEffectiveDate; object.
- dataSecurityPrivilege; string.
- learningItemTitle; string; Title of the learning item.
- findMostRelevantAssignment: Finds the most relevant past renewal assignment record that matches the specified primary key criteria.
Finder Variables:- SysEffectiveDate; object.
- dataSecurityPrivilege; string.
- learningItemId; integer; Application-generated primary key, surrogate key.
- PrimaryKey: Finds all the past renewal 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:- activeDate; string; Date when the assignment record moved to an active status.
- actualCpeUnits; number; Continuing professional education units achieved by the learner for this assignment.
- actualEffortInHours; number; Actual effort, in hours, that it took the learner to complete the assignment.
- actualScore; number; Score achieved by the learner for this assignment.
- assignedDate; string; Date when the learning item was assigned.
- 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 to whom the learning item was assigned.
- assignedToPersonPrimaryPhoneNumber; string; Primary phone number to whom the learning item was assigned.
- assignedToType; string; Entity type to whom the learning record is assigned. The valid value is person.
- assignedToTypeMeaning; string; Description for the assignedToType attribute value.
- assignerAttributionType; string; Entity type that created the learning record, such as person, specialist or community. Valid values are defined in the list AssignerToAttributionTypeLOV.
- assignerAttributionTypeMeaning; string; Description for the assignerAttributionType attribute value.
- assignerCommentsToLearner; string; Comments specified by the assigner for the learner when creating the assignment. It's null when no comment is provided.
- assignerDisplayName; string; Display name for the person who created the learning record for the learner. 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 alias used in Assign As.
- assignerId; integer; Identifier of the person who assigned the learning item to the learner.
- assignerNumber; string; Number for identifying the person who assigned the learning item to the learner.
- 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 that created the learning record.
- assignmentCreatedDate; string; Date and time when the assignment was created.
- assignmentDetailsDeepLink; string; URL to open the assignment item page directly from the browser.
- assignmentDetailsEmbedLink; string; URL that can be used to embed the learning item page in 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 when enrolling for a learning item. It's null for voluntary assignment.
- assignmentDueInFromSystemDate; integer; Due in days for the requested assignment.
- assignmentJustification; string; Justification provided by the specialist or learner when enrolling for a learning item.
- assignmentLastModifiedDate; string; Date and time when the assignment was last updated.
- assignmentRecordId; integer; Application-generated primary key.
- assignmentRecordNumber; string; Number for identifying the assignment record of the past renewals.
- assignmentStateMeaning; string; Indicates the current state of an enrollment, usually including the enrollment status. For example, Completed - Expired or Required - Overdue.
- assignmentStateSeverity; string; Indicates 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; Status of the enrollment, such as Active, Content Completed, Completed, Withdrawn and Deleted. Valid values are defined in the list AssignmentStatusLOV.
- assignmentStatusMeaning; string; Description for the assignmentStatus attribute value.
- assignmentSubStatus; string; Substatus of the enrollment record, such as Not Started, and In Progress. Valid values are defined in the list AssignmentSubStatusLOV.
- assignmentSubStatusMeaning; string; Description for the assignmentSubStatus attribute value.
- assignmentType; string; Type of the enrollment, such as required or voluntary. Valid values are defined in the list AssignmentTypeLOV.
- assignmentTypeMeaning; string; Description for the assignmentType attribute value.
- canEditAssignmentHint; string; Hint to identify if the user can edit the learning record, such as Can delete, Can withdraw, No edit. Valid values are defined in the list CanEditAssignmentHintLOV.
- canEditAssignmentHintMeaning; string; Description for the canEditAssignmentHint attribute value.
- completedDate; string; Date when the learning was completed.
- contentCompletedDate; string; Completed date for the past renewals.
- currentWaitlistPosition; integer; Current waitlist position of the learner.
- dataSecurityPrivilege; string; Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
- dataSecurityPrivilegeMeaning; string; Description for the dataSecurityPrivilege attribute value.
- deletedDate; string; Date when the learner is removed from the waitlist.
- enrollmentQuestionnaireId; integer; Unique identifier of the enrollment questionnaire.
- enteredPendingPaymentDate; string; Date when the assignment record was added to the pending payment.
- enteredPendingPrerequisitesDate; string; Date when the assignment record enters pending prerequisites.
- enteredPendingSeatAcceptanceDate; string; Date when the assignment record entered the pending seat acceptance status.
- enteredWaitlistDate; string; Date when the assignment record was added to the waitlist.
- evaluationSubmittedDate; string; Evaluation submitted for the past renewals.
- exemptedDate; string; Date when the assignment record was exempted.
- exitedPendingPrerequisitesDate; string; Date when the assignment record exited pending prerequisites.
- exitedPendingSeatAcceptanceDate; string; Date when the assignment record exited the pending seat acceptance status.
- exitedWaitlistDate; string; Date when the learner exited the waitlist.
- expectedEffortInHours; string; Expected effort needed by the learner to complete the assignment.
- expirationDate; string; Date when the assignment expired in case of renewal scenario.
- expirationInDaysSystemDate; number; Expiration in days for the requested assignment.
- expirationRule; string; Expiration rule for the assignment in case of renewal scenario.
- hasFutureRenewal; string; Indicates whether the learning assignment is of expiration type and has future renewal.
- hasPastRenewal; string; Indicates whether the learning assignment has past renewals.
- isLearnerOnLatestLIVersion; string; Indicates whether the enrollment record uses the latest learning item version. Valid values are Y and N. The default value is Y.
- learningItemAuthorEmailAddress; string; Primary email address of the person.
- 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.
- learningItemCoordDisplayName; string; Display name of the learning item coordinator.
- learningItemCoordEmailAddress; string; Primary email address of the person.
- 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 learningItemCpeType attribute value.
- learningItemDataLink; string; Data link to the learning item.
- learningItemDeepLink; string; URL to open the past renewals item page directly from the browser.
- learningItemDefinitionUsedDate; string; Last updated date of the enrollment record based on the version of the learning item as of this day.
- learningItemEffectiveAsOf; string; Effective start date of the learning item.
- learningItemEffectiveDate; string; Effective date of the learning item.
- learningItemEmbedLink; string; URL that can be used to embed the learning item page in other pages. It opens the isolated learning item page without the global tool bar on the top.
- learningItemId; integer; Unique identifier for the learning item that's the internal primary key.
- learningItemInstructorDisplayName; string; Display name for the learning item instructor.
- learningItemInstructorEmailAddress; string; Primary email address of the person.
- learningItemInstructorPersonNumber; string; Person number of the learning item instructor.
- learningItemInstructorType; string; The instructor type. Valid values are ORA_PERSON or ORA_ADHOC .
- learningItemInstructorTypeMeaning; string; Meaning for the learningItemType attribute.
- learningItemLatestChangeEventDate; string; Date when the learning item was last changed.
- 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; 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 learningItemSubType attribute value.
- 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 learningItemType attribute value.
- liShortDescription; string; Learning item description provided while creating the learning item.
- liTotalExpectedEffort; number; Expected effort to complete the learning item of the past renewal.
- liTotalExpectedEffortUOM; string; Effort expected to complete the learning item of the past renewal. Valid values are defined in the list LiTotalExpectedEffortUomLOV.
- liTotalExpectedEffortUOMMeaning; string; Description for the liTotalExpectedEffortUOM attribute value.
- nextRenewalAssignmentDeepLink; string; URL to open the next renewal item page directly from the browser.
- nextRenewalAssignmentEmbedLink; string; URL that can be used to embed the learning item page in other pages. It opens the isolated learning item page without the global tool bar on the top.
- nextRenewalAssignmentId; integer; Identifier of the renewal assignment for this assignment. This is applicable if the learning assignment has expiration with renewal.
- nextRenewalAssignmentNumber; string; Assignment number of the renewal assignment for this assignment. This is applicable if the learning assignment has expiration with renewal.
- purchaseAmount; number; Purchase amount for the requested past renewals.
- purchaseCurrency; string; Purchase currency for the past renewal. Valid values are defined in the list PriceCurrencyLOVVA.
- purchasedDate; string; Date of purchase transaction if the learning is paid.
- reasonCode; string; Assignment reason code of the renewal assignment for this assignment. This is applicable if the learning assignment has expiration with renewal. Valid values are defined in the list ReasonCodeLOV.
- refundRule; string; Refund rule for the renewal assignment.
- renewalPeriod; number; Indicates the number of days before the expiration of a learning record when the learner is assigned 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 assignment.
- requestedDate; string; Date when the learning record was requested.
- requestedStartDate; string; Learning request start date specified in the learning record.
- sourceId; integer; Unique identifier for the source where this assignment was created.
- sourceType; string; Type for the source where this assignment was created, such as Recommendation or Search.
- startedDate; string; Start date for the requested past renewals.
- statusChangeComment; string; Comment status change date of the this assignment.
- validityPeriodRule; string; Validity period rule for the assignment that indicates when the validity period for the completed learning begins.
- validityPeriodRuleMeaning; string; Description for the validityPeriodRule attribute value.
- withdrawnDate; string; Date when the learner withdrew from the learning item.
- withdrawnRequestedDate; string; Assignment withdrawn requested date of the renewal assignment for this assignment. This is applicable if the learning assignment has expiration with renewal.
-
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
-
Effective-Of:
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:
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.
Root Schema : learnerLearningRecords-pastRenewals
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-pastRenewals-item-response
Type:
Show Source
object
-
activeDate: string
(date-time)
Title:
Active Date
Date when the assignment record moved to an active status. -
actualCpeUnits: number
Title:
Actual CPE Units
Continuing professional education units achieved by the learner for this assignment. -
actualEffortInHours: number
Title:
Actual Effort in Hours
Actual effort, in hours, that it took the learner to complete the assignment. -
actualScore: number
Title:
Actual Score
Score achieved by the learner for this assignment. -
assignedDate: string
(date-time)
Title:
Enrolled on Date
Date when the learning item was assigned. -
assignedToDisplayName: string
Title:
Assignee Display Name
Read Only:true
Maximum Length:240
Display name of the person to whom the learning item was assigned. -
assignedToId: integer
(int64)
Title:
Assignee Person ID
Unique identifier of the person to whom the learning item was assigned. -
assignedToNumber: string
Title:
Assignee Person Number
Read Only:true
Maximum Length:30
Friendly number identifying the person to whom the learning item was assigned. -
assignedToPersonImageURL: string
Title:
Assignee Person Image URL
Read Only:true
Maximum Length:19
Image URL for the person to whom the learning item was assigned. -
assignedToPersonPrimaryEmailAddress: string
Title:
Assignee Primary Email Address
Read Only:true
Maximum Length:240
Primary email address to whom the learning item was assigned. -
assignedToPersonPrimaryPhoneNumber: string
Title:
Assignee Primary Phone Number
Read Only:true
Maximum Length:60
Primary phone number to whom the learning item was assigned. -
assignedToType: string
Title:
Assignee Attribution Type
Read Only:true
Maximum Length:19
Entity type to whom the learning record is assigned. The valid value is person. -
assignedToTypeMeaning: string
Title:
Assignee Attribution Type Description
Read Only:true
Maximum Length:4000
Description for the assignedToType attribute value. -
assignerAttributionType: string
Title:
Assigner Attribution Type
Maximum Length:30
Default Value:ORA_PERSON
Entity type that created the learning record, such as person, specialist or community. Valid values are defined in the list AssignerToAttributionTypeLOV. -
assignerAttributionTypeMeaning: string
Title:
Assigner Attribution Type Description
Read Only:true
Maximum Length:4000
Description for the assignerAttributionType attribute value. -
assignerCommentsToLearner: string
Title:
Assigner Comments to Learner
Maximum Length:4000
Comments specified by the assigner for the learner when creating the assignment. It's null when no comment is provided. -
assignerDisplayName: string
Title:
Enrolled By
Read Only:true
Maximum Length:240
Display name for the person who created the learning record for the learner. 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 alias used in Assign As. -
assignerId: integer
(int64)
Title:
Assigner ID
Read Only:true
Identifier of the person who assigned the learning item to the learner. -
assignerNumber: string
Title:
Assigner Number
Read Only:true
Maximum Length:30
Number for identifying the person who assigned the learning item to the learner. -
assignerPersonImageURL: string
Title:
Assigner Person Image URL
Read Only:true
Maximum Length:19
Image URL of the person who assigned the learning item to the learner. -
assignerPersonPrimaryEmailAddress: string
Title:
Assigner Person Primary Email Address
Read Only:true
Maximum Length:240
Email address of the person who assigned the learning item to the learner. -
assignerPersonPrimaryPhoneNumber: string
Title:
Assigner Person Primary Phone Number
Read Only:true
Maximum Length:60
Phone number of the person who assigned the learning item to the learner. -
assignmentAttributionId: integer
(int64)
Title:
Assigner Attribution ID
Unique identifier of the entity that created the learning record. -
assignmentCreatedDate: string
(date-time)
Title:
Assignment Created Date
Read Only:true
Date and time when the assignment was created. -
assignmentDetailsDeepLink: string
Title:
Assignment Details Deep Link
Read Only:true
Maximum Length:4000
URL to open the assignment item page directly from the browser. -
assignmentDetailsEmbedLink: string
Title:
Assignment Details Embed Link
Read Only:true
Maximum Length:4000
URL that can be used to embed the learning item page in other pages. It opens the isolated learning item page without the global tool bar on the top. -
assignmentDueDate: string
(date-time)
Title:
Due Date
Due date of the assignment provided by the learning specialist when enrolling for a learning item. It's null for voluntary assignment. -
assignmentDueInFromSystemDate: integer
Title:
Assignment Due in from System Date
Read Only:true
Due in days for the requested assignment. -
assignmentJustification: string
Title:
Justification
Maximum Length:4000
Justification provided by the specialist or learner when enrolling for a learning item. -
assignmentLastModifiedDate: string
(date-time)
Title:
Assignment Last Modified Date
Read Only:true
Date and time when the assignment was last updated. -
assignmentRecordId: integer
(int64)
Title:
Enrollment Record ID
Application-generated primary key. -
assignmentRecordNumber: string
Title:
Enrollment Number
Read Only:true
Maximum Length:30
Number for identifying the assignment record of the past renewals. -
assignmentStateMeaning: string
Read Only:
true
Maximum Length:255
Indicates the current state of an enrollment, usually including the enrollment status. For example, Completed - Expired or Required - Overdue. -
assignmentStateSeverity: string
Read Only:
true
Maximum Length:255
Indicates 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 Status
Maximum Length:32
Default Value:ORA_ASSN_REC_ACTIVE
Status of the enrollment, such as Active, Content Completed, Completed, Withdrawn and Deleted. Valid values are defined in the list AssignmentStatusLOV. -
assignmentStatusMeaning: string
Title:
Enrollment Record Status Description
Read Only:true
Maximum Length:4000
Description for the assignmentStatus attribute value. -
assignmentSubStatus: string
Title:
Enrollment Record Substatus
Maximum Length:30
Default Value:ORA_ASSN_REC_NOTSTARTED
Substatus of the enrollment record, such as Not Started, and In Progress. Valid values are defined in the list AssignmentSubStatusLOV. -
assignmentSubStatusMeaning: string
Title:
Enrollment Record Substatus Description
Read Only:true
Maximum Length:4000
Description for the assignmentSubStatus attribute value. -
assignmentType: string
Title:
Enrollment Type
Maximum Length:30
Type of the enrollment, such as required or voluntary. Valid values are defined in the list AssignmentTypeLOV. -
assignmentTypeMeaning: string
Title:
Enrollment Type Description
Read Only:true
Maximum Length:4000
Description for the assignmentType attribute value. -
canEditAssignmentHint: string
Title:
Can Edit Assignment Hint
Maximum Length:4000
Hint to identify if the user can edit the learning record, such as Can delete, Can withdraw, No edit. Valid values are defined in the list CanEditAssignmentHintLOV. -
canEditAssignmentHintMeaning: string
Title:
Can Edit Assignment Hint Description
Read Only:true
Maximum Length:4000
Description for the canEditAssignmentHint attribute value. -
completedDate: string
(date-time)
Title:
Completed Date
Date when the learning was completed. -
contentCompletedDate: string
(date)
Title:
Content Completed Date
Read Only:true
Completed date for the past renewals. -
currentWaitlistPosition: integer
(int64)
Title:
Current Waitlist Position
Read Only:true
Current waitlist position of the learner. -
dataSecurityPrivilege: string
Title:
Data Security Privilege
Maximum Length:32
Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV. -
dataSecurityPrivilegeMeaning: string
Title:
Data Security Privilege Description
Read Only:true
Maximum Length:4000
Description for the dataSecurityPrivilege attribute value. -
deletedDate: string
(date-time)
Title:
Deleted Date
Read Only:true
Date when the learner is removed from the waitlist. -
enrollmentQuestionnaireId: integer
Unique identifier of the enrollment questionnaire.
-
enteredPendingPaymentDate: string
(date-time)
Title:
Entered Pending Payment Date
Read Only:true
Date when the assignment record was added to the pending payment. -
enteredPendingPrerequisitesDate: string
(date)
Title:
Date Learner Entered Pending Prerequisites
Read Only:true
Date when the assignment record enters pending prerequisites. -
enteredPendingSeatAcceptanceDate: string
(date-time)
Title:
Date Learning Item Entered Pending Seat Acceptance
Date when the assignment record entered the pending seat acceptance status. -
enteredWaitlistDate: string
(date)
Title:
Date Learner Entered Waitlist
Read Only:true
Date when the assignment record was added to the waitlist. -
evaluationSubmittedDate: string
(date)
Title:
Evaluation Submission Date
Read Only:true
Evaluation submitted for the past renewals. -
exemptedDate: string
(date-time)
Title:
Exempted Date
Read Only:true
Date when the assignment record was exempted. -
exitedPendingPrerequisitesDate: string
(date)
Title:
Date Learner Exited Pending Prerequisites
Read Only:true
Date when the assignment record exited pending prerequisites. -
exitedPendingSeatAcceptanceDate: string
(date-time)
Title:
Date Learning Item Exited Pending Seat Acceptance
Date when the assignment record exited the pending seat acceptance status. -
exitedWaitlistDate: string
(date)
Title:
Date Learner Exited Waitlist
Read Only:true
Date when the learner exited the waitlist. -
expectedEffortInHours: string
Title:
Expected Effort
Read Only:true
Maximum Length:83
Expected effort needed by the learner to complete the assignment. -
expirationDate: string
(date)
Title:
Expiration Date
Read Only:true
Date when the assignment expired in case of renewal scenario. -
expirationInDaysSystemDate: number
Title:
Expiration in Days from Today
Read Only:true
Expiration in days for the requested assignment. -
expirationRule: string
Title:
Expires
Read Only:true
Maximum Length:80
Expiration rule for the assignment in case of renewal scenario. -
hasFutureRenewal: string
Title:
Requires Renewal
Read Only:true
Maximum Length:20
Indicates whether the learning assignment is of expiration type and has future renewal. -
hasPastRenewal: string
Title:
Past Renewal Exists
Read Only:true
Maximum Length:1
Indicates whether the learning assignment has past renewals. -
isLearnerOnLatestLIVersion: string
Title:
Learner on Latest Learning Item Version
Read Only:true
Maximum Length:1
Indicates whether the enrollment record uses the latest learning item version. Valid values are Y and N. The default value is Y. -
learningItemAuthorEmailAddress: string
Read Only:
true
Maximum Length:255
Primary email address of the person. -
learningItemCompletionCertificateLink: string
Title:
Learning Item Completion Certificate Link
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. -
learningItemCoordDisplayName: string
Read Only:
true
Maximum Length:2000
Display name of the learning item coordinator. -
learningItemCoordEmailAddress: string
Read Only:
true
Maximum Length:255
Primary email address of the person. -
learningItemCoverArtLink: string
Title:
Learning Item Cover Art Link
Read Only:true
Maximum Length:4000
URL to open the learning item cover art directly from the browser. -
learningItemCpeType: string
Title:
Learning Item CPE Type
Maximum Length:30
Continuing professional education type of the learning item. Valid values are defined in the list CpeTypeLOV. -
learningItemCpeTypeMeaning: string
Title:
Learning Item CPE Type Description
Read Only:true
Maximum Length:4000
Description for the learningItemCpeType attribute value. -
learningItemDataLink: string
Title:
Learning Item Data Link
Read Only:true
Maximum Length:4000
Data link to the learning item. -
learningItemDeepLink: string
Title:
Learning Item Deep Link
Maximum Length:4000
URL to open the past renewals item page directly from the browser. -
learningItemDefinitionUsedDate: string
(date-time)
Title:
Learning Item Definition Used Date
Read Only:true
Last updated date of the enrollment record based on the version of the learning item as of this day. -
learningItemEffectiveAsOf: string
(date)
Title:
Assigned Learning Effective Date
Read Only:true
Effective start date of the learning item. -
learningItemEffectiveDate: string
(date-time)
Read Only:
true
Effective date of the learning item. -
learningItemEmbedLink: string
Title:
Learning Item Embed Link
Read Only:true
Maximum Length:4000
URL that can be used to embed the learning item page in other pages. It opens the isolated learning item page without the global tool bar on the top. -
learningItemId: integer
(int64)
Title:
Assigned Learning Item ID
Unique identifier for the learning item that's the internal primary key. -
learningItemInstructorDisplayName: string
Read Only:
true
Maximum Length:2000
Display name for the learning item instructor. -
learningItemInstructorEmailAddress: string
Read Only:
true
Maximum Length:255
Primary email address of the person. -
learningItemInstructorPersonNumber: string
Read Only:
true
Maximum Length:30
Person number of the learning item instructor. -
learningItemInstructorType: string
Read Only:
true
Maximum Length:32
The instructor type. Valid values are ORA_PERSON or ORA_ADHOC . -
learningItemInstructorTypeMeaning: string
Read Only:
true
Maximum Length:4000
Meaning for the learningItemType attribute. -
learningItemLatestChangeEventDate: string
(date-time)
Title:
Learning Item Latest Change Date
Read Only:true
Date when the learning item was last changed. -
learningItemMaximumPrice: number
Title:
Learning Item Maximum Price
Maximum Price for the learning item. -
learningItemMinimumPrice: number
Title:
Learning Item Minimum Price
Minimum Price for the learning item. -
learningItemNumber: string
Title:
Assigned Learning Item Number
Maximum Length:30
Friendly number identifying the learning item. It's a surrogate key that's shown in the UI. -
learningItemPriceCurrency: string
Title:
Learning Item Currency
Currency of the price for the learning item. Valid values are defined in the list PriceCurrencyLOVVA. -
learningItemPublisherDisplayName: string
Title:
Published By
Read Only:true
Maximum Length:240
Name of the publisher of the learning item. -
learningItemSubType: string
Title:
Assigned Learning Item Subtype
Maximum Length:30
Learning item subtype, such as Video and Tutorial. Valid values are defined in the list AssignedLearningItemSubTypeLOV. -
learningItemSubTypeMeaning: string
Read Only:
true
Maximum Length:4000
Description for the learningItemSubType attribute value. -
learningItemThumbnailLink: string
Title:
Learning Item Thumbnail Link
Read Only:true
Maximum Length:4000
URL to open the learning item thumbnail directly from the browser. -
learningItemTitle: string
Title:
Assigned Learning Item Title
Maximum Length:250
Title of the learning item. -
learningItemTrailerLink: string
Title:
Learning Item Trailer Link
Read Only:true
Maximum Length:4000
URL to open the learning item trailer directly from the browser. -
learningItemType: string
Title:
Assigned Learning Item Type
Maximum Length:32
Learning item type, such as Course, Specialization, Tutorial, Video, and eLearning. Valid values are defined in the list AssignedLearningItemTypeLOV. -
learningItemTypeMeaning: string
Title:
Assigned Learning Item Type Description
Read Only:true
Maximum Length:4000
Description for the learningItemType attribute value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
liShortDescription: string
Title:
Learning Item Short Description
Maximum Length:4000
Learning item description provided while creating the learning item. -
liTotalExpectedEffort: number
Title:
Learning Item Total Expected Effort
Expected effort to complete the learning item of the past renewal. -
liTotalExpectedEffortUOM: string
Title:
Learning Item Total Expected Effort Units
Maximum Length:30
Effort expected to complete the learning item of the past renewal. Valid values are defined in the list LiTotalExpectedEffortUomLOV. -
liTotalExpectedEffortUOMMeaning: string
Title:
Learning Item Total Expected Effort Units Description
Read Only:true
Maximum Length:4000
Description for the liTotalExpectedEffortUOM attribute value. -
nextRenewalAssignmentDeepLink: string
Title:
Next Renewal Assignment Deep Link
Read Only:true
Maximum Length:4000
URL to open the next renewal item page directly from the browser. -
nextRenewalAssignmentEmbedLink: string
Title:
Next Renewal Assignment Embed Link
Read Only:true
Maximum Length:4000
URL that can be used to embed the learning item page in other pages. It opens the isolated learning item page without the global tool bar on the top. -
nextRenewalAssignmentId: integer
(int64)
Title:
Renewal Assignment ID
Read Only:true
Identifier of the renewal assignment for this assignment. This is applicable if the learning assignment has expiration with renewal. -
nextRenewalAssignmentNumber: string
Title:
Renewal Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the renewal assignment for this assignment. This is applicable if the learning assignment has expiration with renewal. -
purchaseAmount: number
Title:
Purchase Amount
Purchase amount for the requested past renewals. -
purchaseCurrency: string
Title:
Purchase Currency
Maximum Length:19
Purchase currency for the past renewal. Valid values are defined in the list PriceCurrencyLOVVA. -
purchasedDate: string
(date)
Title:
Purchased Date
Read Only:true
Date of purchase transaction if the learning is paid. -
reasonCode: string
Title:
Status Change Reason Code
Maximum Length:30
Assignment reason code of the renewal assignment for this assignment. This is applicable if the learning assignment has expiration with renewal. Valid values are defined in the list ReasonCodeLOV. -
refundRule: string
Title:
Refund Rule
Read Only:true
Maximum Length:240
Refund rule for the renewal assignment. - relatedLearningRecords: array Related Learning Records
-
renewalPeriod: number
Title:
Renewal Period
Read Only:true
Indicates the number of days before the expiration of a learning record when the learner is assigned the renewed assignment. -
requestApprovedDate: string
(date)
Title:
Request Approval Date
Read Only:true
Approved date for the requested assignment. -
requestedCompleteByDate: string
(date)
Title:
Request Completion Date
Requested date by which the learner should complete the assignment. -
requestedDate: string
(date-time)
Title:
Requested Date
Read Only:true
Date when the learning record was requested. -
requestedStartDate: string
(date-time)
Title:
Requested Start By
Learning request start date specified in the learning record. -
requestRejectedDate: string
(date)
Title:
Request Rejection Date
Read Only:true
Rejected date for the requested assignment. -
sourceId: integer
(int64)
Title:
Enrollment Source Identifier
Unique identifier for the source where this assignment was created. -
sourceType: string
Title:
Enrollment Source Type
Maximum Length:30
Type for the source where this assignment was created, such as Recommendation or Search. -
startedDate: string
(date)
Title:
Assignment Start Date
Read Only:true
Start date for the requested past renewals. -
statusChangeComment: string
Title:
Comments
Maximum Length:4000
Comment status change date of the this assignment. -
validityPeriodRule: string
Title:
Validity Period Option
Read Only:true
Maximum Length:30
Validity period rule for the assignment that indicates when the validity period for the completed learning begins. -
validityPeriodRuleMeaning: string
Title:
Validity Period Option Description
Read Only:true
Maximum Length:4000
Description for the validityPeriodRule attribute value. -
withdrawnDate: string
(date-time)
Title:
Withdrawn Date
Read Only:true
Date when the learner withdrew from the learning item. -
withdrawnRequestedDate: string
(date-time)
Title:
Withdrawn Requested Date
Read Only:true
Assignment withdrawn requested date of the renewal assignment for this assignment. This is applicable if the learning assignment has expiration with renewal.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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.