1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Learner Learning Records
  4. Past Renewals

Get all past renewals

get

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals

Request

Path Parameters
  • 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
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all the past renewal learning assignments that match the specified primary key criteria.
      Finder Variables
      • assignmentRecordId; integer; Unique identifier for the assignment record.
    • findByAssignee Finds all learning assignments that match the specified assignee criteria.
      Finder Variables
      • SysEffectiveDate; object;
      • 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 assignee.
    • findByAssignmentRecordId Finds all the past renewal learning assignments that match the specified primary key criteria.
      Finder Variables
      • SysEffectiveDate; object;
      • assignmentRecordId; integer; Unique identifier for the assignment record.
      • 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.
    • findByAttribution Finds all the assignments that match the specified learning item criteria.
      Finder Variables
      • SysEffectiveDate; object;
      • assignedToId; integer; Unique identifier for the learning assignee.
      • assignerAttributionType; string; Entity type that created the learning assignment, such as person, specialist, or community. Valid values are defined in the list AssignerToAttributionTypeLOV.
      • assignerId; integer; Unique identifier for the learning assigner.
    • findByLearningItem Finds all learning assignments that match the specified learning item criteria.
      Finder Variables
      • SysEffectiveDate; object;
      • 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.
      • learningItemId; integer; Title of the learning item.
    • findByLearningItemTitle Finds all the past renewal assignments for learning Items that match the specified learning Item criteria.
      Finder Variables
      • SysEffectiveDate; object;
      • 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 learning assignments for the specified manager's subordinates.
      Finder Variables
      • SysEffectiveDate; object;
      • 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 past renewal learning assignment that matches the specified primary key criteria.
        Finder Variables
        • SysEffectiveDate; object;
        • 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.
      • findMyCompletedLearnings Finds all the required or voluntary assignments that are complete and match the specified learning item criteria.
        Finder Variables
        • SysEffectiveDate; object;
        • learningItemTitle; string; Title of the learning item.
      • findMyCurrentLearnings Finds all the required or voluntary assignments that are incomplete and match the specified learning item criteria.
        Finder Variables
        • SysEffectiveDate; object;
        • learningItemTitle; string; Title of the learning item.
      • findMyLearningHistory Finds all the required or voluntary assignments that match the specified learning item criteria.
        Finder Variables
        • SysEffectiveDate; object;
        • learningItemTitle; string; Title of the learning item.
      • findMyRequiredLearnings Finds all the required assignments that are incomplete and match the specified learning item criteria.
        Finder Variables
        • SysEffectiveDate; object;
        • learningItemTitle; string; Title of the learning item.
    • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
    • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

      Example:
      self,canonical
    • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
    • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

      Format: ?q=expression1;expression2

      You can use these queryable attributes to filter this collection resource using the q query parameter:
      • activeDate; string; Date when the learning assignment moved to an active status.
      • actualCpeUnits; number; Continuing professional education units that the learner achieved for this assignment.
      • actualEffortInHours; number; Actual effort, in hours, that it took the learner to complete the assignment.
      • actualScore; number; Learner score for this assignment.
      • assignedDate; string; Date when the learning item was assigned.
      • assignedToDisplayName; string; Display name for 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 the learning item assignee.
      • assignedToPersonPrimaryPhoneNumber; string; Primary phone number for the learning item assignee.
      • assignedToType; string; Entity type for the learning assignment assignee. The valid value is person.
      • assignedToTypeMeaning; string; Description of the assignedToType attribute value.
      • assignerAttributionType; string; Entity type for the learning assignment creator, such as person, specialist, or community. Valid values are defined in the AssignerToAttributionTypeLOV list.
      • assignerAttributionTypeMeaning; string; Description of the assignerAttributionType attribute value.
      • assignerCommentsToLearner; string; Assigner comments to the learner made when creating the assignment. The value is null when there's no comment.
      • assignerDisplayName; string; Display 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; Identifier for the learning item assigner.
      • assignerNumber; string; Number for identifying the learning item assigner.
      • assignerPersonImageURL; string; Image URL for the learning item assigner.
      • assignerPersonPrimaryEmailAddress; string; Email address for the learning item assigner.
      • assignerPersonPrimaryPhoneNumber; string; Phone number for learning item assigner.
      • assignmentAttributionId; integer; Unique identifier for the entity that created the learning assignment.
      • assignmentCreatedDate; string; Date and time when the learning assignment was created.
      • assignmentDetailsDeepLink; string; URL to open the learning assignment item page directly from the browser.
      • assignmentDetailsEmbedLink; string; URL 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; Due date of the learning-specialist-created assignment. The value is null for voluntary assignments.
      • assignmentDueInFromSystemDate; integer; Due in days for the requested learning assignment.
      • assignmentJustification; string; Justification provided by the specialist when assigning, or the learner when enrolling in, a learning item.
      • assignmentLastModifiedDate; string; Date and time when the learning assignment was most recently updated.
      • assignmentRecordId; integer; Application-generated primary key.
      • assignmentRecordNumber; string; Number for identifying past learning renewal assignments.
      • 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 for the learning enrollment, such as Active, Content Completed, Completed, Withdrawn, or Deleted. Valid values are defined in the AssignmentStatusLOV list.
      • assignmentStatusMeaning; string; Description of the assignmentStatus attribute value.
      • assignmentSubStatus; string; Learning enrollment substatus, such as Not Started, or In Progress. Valid values are defined in the AssignmentSubStatusLOV list.
      • assignmentSubStatusMeaning; string; Description of the assignmentSubStatus attribute value.
      • assignmentType; string; Type of the learning enrollment, such as required or voluntary. Valid values are defined in the AssignmentTypeLOV list.
      • assignmentTypeMeaning; string; Description of the assignmentType attribute value.
      • canEditAssignmentHint; string; Hint 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; Description of the canEditAssignmentHint attribute value.
      • completedDate; string; Date when the learning was completed.
      • contentCompletedDate; string; Completed date for past learning assignment renewals.
      • contentCompletedTimestamp; string; Date and time when the learning content was completed.
      • currentWaitlistPosition; integer; Current waitlist position of 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.
      • enrollmentQuestionnaireId; integer; Unique identifier for the learning enrollment questionnaire.
      • enteredPendingPaymentDate; string; Date when the learning assignment was added to the pending payment.
      • enteredPendingPrerequisitesDate; string; Date when the learning assignment entered pending prerequisites.
      • enteredPendingPrerequisitesTimestamp; string; Date and time when the learning assignment entered pending prerequisites.
      • enteredPendingSeatAcceptanceDate; string; Date when the learning assignment entered the pending seat acceptance status.
      • enteredWaitlistDate; string; Date when the learning assignment was added to the waitlist.
      • enteredWaitlistTimestamp; string; Date and time when the learning assignment was added to the waitlist.
      • evaluationSubmittedDate; string; Evaluation submitted for past learning assignment renewals.
      • evaluationSubmittedTimestamp; string; Date and time when the evaluation was submitted.
      • exemptedDate; string; Date when the learning assignment was exempted.
      • exitedPendingPrerequisitesDate; string; Date when the learning assignment exited pending prerequisites.
      • exitedPendingPrerequisitesTimestamp; string; Date and time when the learning assignment exited pending prerequisites.
      • exitedPendingSeatAcceptanceDate; string; Date when the learning assignment exited the pending seat acceptance status.
      • exitedWaitlistDate; string; Date when the learner exited the waitlist.
      • exitedWaitlistTimestamp; string; Date and time when the learner was removed from the learning item waitlist.
      • expectedEffortInHours; string; Expected learner effort to complete the learning assignment.
      • expirationDate; string; Date when the learning assignment expired, in the case of a renewal scenario.
      • expirationInDaysSystemDate; number; Expiration in days for the requested learning assignment.
      • expirationRule; string; Expiration rule for the learning assignment, in the case of a renewal scenario.
      • expirationRuleCode; string; Code that represents the expirationRule attribute.
      • expirationTimestamp; string; Date and time when the learning will expire.
      • hasFutureRenewal; string; Indicates whether the learning assignment is of type Expiration and has future renewal.
      • hasPastRenewal; string; Indicates whether the learning assignment has past renewals.
      • isLearnerOnLatestLIVersion; string; Indicates whether the learning enrollment uses the most recent learning item version. Valid values are Y and N. The default value is Y.
      • learningItemAuthorDisplayName; string; Display name the learning item author.
      • learningItemAuthorEmailAddress; string; Primary email address of the person.
      • learningItemAuthorPersonId; integer; Person identifier for the learning item author.
      • learningItemAuthorPhoneNumber; string; Phone number for the learning item author.
      • learningItemAuthorType; string; Learning author type. Valid values are ORA_PERSON or ORA_ADHOC.
      • 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 for 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.
      • learningItemCoordPersonId; integer; Person identifier for the learning item coordinator.
      • learningItemCoordPhoneNumber; string; Phone number for the learning item coordinator.
      • learningItemCoverArtLink; string; URL to open the learning item cover art directly from the browser.
      • learningItemCpeType; string; Continuing professional education type for the learning item. Valid values are defined in the CpeTypeLOV list.
      • learningItemCpeTypeMeaning; string; Description of the learningItemCpeType attribute value.
      • learningItemDataLink; string; Data link to the learning item.
      • learningItemDeepLink; string; URL to open the past learning renewals item page directly from the browser.
      • learningItemDefinitionUsedDate; string; Most recent updated date for the learning enrollment based on the learning item version as of this day.
      • learningItemEffectiveAsOf; string; Effective start date of the learning item.
      • learningItemEffectiveDate; string; Effective date of the learning item.
      • learningItemEmbedLink; string; URL 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; Unique identifier for the learning item. It's the internal primary key.
      • learningItemInstructorDisplayName; string; Display name for the learning item instructor.
      • learningItemInstructorEmailAddress; string; Primary email address of the person.
      • learningItemInstructorPersonId; integer; Person identifier for the learning item instructor.
      • learningItemInstructorPersonNumber; string; Person number of the learning item instructor.
      • learningItemInstructorPrimaryPhoneNumber; string; Phone number of the instructor of the learning item.
      • learningItemInstructorType; string; Type of instructor. Valid values are ORA_PERSON or ORA_ADHOC
      • learningItemInstructorTypeMeaning; string; Meaning for the learningItemType attribute.
      • learningItemLatestChangeEventDate; string; Date when the learning item was most recently changed.
      • learningItemMaximumPrice; number; Maximum price for the learning item.
      • learningItemMinimumPrice; number; Minimum price for the learning item.
      • learningItemNotificationPattern; string; Notification pattern, such as Default Notification Pattern.
      • 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; 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 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, or eLearning. Valid values are defined in the AssignedLearningItemTypeLOV list.
      • learningItemTypeMeaning; string; Description of the learningItemType attribute value.
      • liShortDescription; string; Description provided while creating the learning item.
      • liTotalExpectedEffort; number; Expected effort to complete the past learning renewal item.
      • liTotalExpectedEffortUOM; string; Effort expected to complete the past learning renewal item. Valid values are defined in the LiTotalExpectedEffortUomLOV list.
      • liTotalExpectedEffortUOMMeaning; string; Description of the liTotalExpectedEffortUOM attribute value.
      • nextRenewalAssignmentDeepLink; string; URL to open the next learning renewal item page directly from the browser.
      • nextRenewalAssignmentEmbedLink; string; URL 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; Identifier of the learning renewal assignment. Applies if the learning assignment has an expiration with renewal.
      • nextRenewalAssignmentNumber; string; Assignment number for the renewal learning assignment. Applies if the learning assignment has an expiration with renewal.
      • purchaseAmount; number; Purchase amount for the requested past learning renewals.
      • purchaseCurrency; string; Purchase currency for the past learning renewal. Valid values are defined in the PriceCurrencyLOVVA list.
      • purchasedDate; string; Date of purchase for the learning transaction, if the learning is paid.
      • purchasedTimestamp; string; Date and time for the purchase of the paid learning.
      • reasonCode; string; Reason 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; Refund rule for the learning renewal assignment.
      • renewalPeriod; number; Number of days before the learning assignment expiration when the learner is assigned the renewal assignment.
      • requestApprovedDate; string; Approved date for the requested learning assignment.
      • requestApprovedTimestamp; string; Date and time when the learning assignment approval request was assigned to the approver.
      • requestRejectedDate; string; Rejected date for the requested learning assignment.
      • requestRejectedTimestamp; string; Date and time when the learning assignment request was rejected..
      • requestedCompleteByDate; string; Requested date by when the learner should complete the learning assignment.
      • requestedDate; string; Date when the learning assignment was requested.
      • requestedStartDate; string; Request start date specified in the learning assignment.
      • 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 learning renewals.
      • startedTimestamp; string; Date and time when the learner started the learning assignment.
      • statusChangeComment; string; Comment status change date for the learning assignment.
      • validityPeriodRule; string; Validity period rule for the assignment indicating when the validity period for the completed learning begins.
      • validityPeriodRuleMeaning; string; Description of the validityPeriodRule attribute value.
      • withdrawnDate; string; Date when the learner withdrew from the learning item.
      • withdrawnRequestedDate; string; Assignment withdrawn requested date for the learning renewal assignment. Applies if the learning assignment has an expiration with renewal.
    • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
    Header Parameters
    • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
    • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
    • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

    There's no request body for this operation.

    Back to Top

    Response

    Supported Media Types

    Default Response

    The following table describes the default response for this task.
    Headers
    • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
    • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
    Body ()
    Root Schema : learnerLearningRecords-pastRenewals
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : learnerLearningRecords-pastRenewals-item-response
    Type: object
    Show Source
    Nested Schema : Related Learning Records
    Type: array
    Title: Related Learning Records
    The relatedLearningRecords resource provides details of the related learning assignments for the learning assignment.
    Show Source
    Nested Schema : learnerLearningRecords-pastRenewals-relatedLearningRecords-item-response
    Type: object
    Show Source
    Back to Top