Get a related assignment record

get

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals/{pastRenewalsUniqID}/child/relatedLearningRecords/{assignmentRelationId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • This is the hash key of the attributes which make up the composite key for the (learnerLearningRecords) resource and used to uniquely identify an instance of (learnerLearningRecords). The client should not generate the hash key value. Instead, the client should query on the (learnerLearningRecords) collection resource in order to navigate to a specific instance of (learnerLearningRecords) to get the hash key.
  • This is the hash key of the attributes which make up the composite key for the (pastRenewals) resource and used to uniquely identify an instance of (pastRenewals). The client should not generate the hash key value. Instead, the client should query on the (pastRenewals) collection resource in order to navigate to a specific instance of (pastRenewals) 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>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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-relatedLearningRecords-item-response
Type: object
Show Source
  • Title: Actual CPE Units
    Read Only: true
    Continuing professional education units that the learner achieved for this assignment.
  • Title: Actual Effort in Hours
    Actual learner effort, in hours, to complete the related learning assignment.
  • Title: Actual Score
    Read Only: true
    Actual learner score for the related learning assignment.
  • Title: Enrolled on Date
    Read Only: true
    Learning start date, visible to the learner on various self-service learning pages.
  • Title: Assignee Display Name
    Read Only: true
    Maximum Length: 240
    Display name of the learning item assignee.
  • Title: Assignee Person ID
    Read Only: true
    Unique identifier for the learning item assignee.
  • Title: Assignee Person Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the learning item assignee.
  • Title: Assignee Person Image URL
    Read Only: true
    Maximum Length: 19
    Image URL for the learning item assignee.
  • Title: Assignee Primary Email Address
    Read Only: true
    Maximum Length: 240
    Primary email address for learning item assignee.
  • Title: Assignee Primary Phone Number
    Read Only: true
    Maximum Length: 60
    Primary phone number for the learning item assignee.
  • Title: Assignee Attribution Type
    Read Only: true
    Maximum Length: 19
    Entity type for the related learning assignment assignee. Valid value is a person.
  • Title: Assignee Attribution Type Description
    Read Only: true
    Maximum Length: 4000
    Description of the assigned to type.
  • Title: Assigner Attribution Type
    Read Only: true
    Maximum Length: 30
    Default Value: ORA_PERSON
    Entity type for the related learning assignment creator, such as person, specialist, or community. Valid values are defined in the AssignerToAttributionTypeLOV list.
  • Title: Assigner Attribution Type Description
    Read Only: true
    Maximum Length: 4000
    Description of the assigner attribution type.
  • Title: Assigner Comments to Learner
    Maximum Length: 4000
    Assigner comments to the learner made while creating the related learning assignment. It's null when there are no comments.
  • Title: Enrolled By
    Read Only: true
    Maximum Length: 240
    Display name of the related learning assignment creator. For example, it's the learner for voluntary assignments, and the specialist or the Assign As alias for specialist-created assignments.
  • Title: Assigner ID
    Read Only: true
    Unique identifier for the related learning assignment assigner.
  • Title: Assigner Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the related learning assignment assigner.
  • Title: Assigner Person Image URL
    Read Only: true
    Maximum Length: 19
    Image URL for the person who assigned the learning item to the learner.
  • Title: Assigner Person Primary Email Address
    Read Only: true
    Maximum Length: 240
    Email address for the learning item assigner.
  • Title: Assigner Person Primary Phone Number
    Read Only: true
    Maximum Length: 60
    Phone number for the learning item assigner.
  • Title: Assigner Attribution ID
    Read Only: true
    Unique identifier for the related learning assignment creator.
  • Title: Assignment Created Date
    Read Only: true
    Date and time when the related learning assignment was created.
  • Title: Due Date
    Due date of the learning-specialist-created assignment. The value is null for voluntary assignments.
  • Title: Assignment Due in from System Date
    Read Only: true
    Due date, in days, for the requested learning assignment.
  • Title: Justification
    Read Only: true
    Maximum Length: 4000
    Justification provided by the learner during a request, or the justification added by the specialist in the learning request details during the related assignment.
  • Title: Assignment Last Modified Date
    Read Only: true
    Date and time when the related assignment was most recently updated.
  • Title: Enrollment Record ID
    Read Only: true
    Unique identifier for the related learning enrollment.
  • Title: Enrollment Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the related learning enrollment in the user interface.
  • Title: Assignment Relation ID
    Read Only: true
    Unique identifier for the learning assignment relation.
  • Title: Assignment Relation Type
    Read Only: true
    Type of learning assignment relation, such as previous completions that were expired by this learning enrollment and exempted learning enrollments allowing the learner to claim the credit. Valid values are defined in the AssignmentRelationTypeLOV list.
  • Title: Assignment Relation Type Description
    Read Only: true
    Description of the learning assignment relation type.
  • Title: Enrollment Record Status
    Read Only: true
    Maximum Length: 32
    Status of the related learning enrollment, such as Active, Content Completed, Completed, Withdrawn, or Deleted. Valid values are defined in the AssignmentStatusLOV list.
  • Title: Enrollment Record Status Description
    Read Only: true
    Maximum Length: 4000
    Description of the learning assignment status.
  • Title: Enrollment Record Substatus
    Read Only: true
    Maximum Length: 30
    Granular status of the associated learning enrollment. For example, No Offering Selected, Not Started, In Progress, and Pending Active are various substatuses for the Active status. Valid values are defined in the AssignmentSubStatusLOV list.
  • Title: Enrollment Record Substatus Description
    Read Only: true
    Maximum Length: 4000
    Description of the learning assignment substatus.
  • Title: Enrollment Type
    Read Only: true
    Maximum Length: 32
    Type of the related learning enrollment, such as required or voluntary. Valid values are defined in the AssignmentTypeLOV list.
  • Title: Enrollment Type Description
    Read Only: true
    Maximum Length: 4000
    Description of the related learning assignment type.
  • Title: Can Edit Assignment Hint
    Maximum Length: 4000
    Specifies whether you can edit the assignment hint, such as Can delete, Can withdraw, or No edit, for the related learning assignment. Valid values are defined in the CanEditAssignmentHintLOV list.
  • Title: Can Edit Assignment Hint Description
    Read Only: true
    Maximum Length: 4000
    Description of the can edit learning assignment hint.
  • Title: Completed Date
    Read Only: true
    Date when the learning was completed.
  • Title: Content Completed Date
    Read Only: true
    Completed date for the requested learning assignment.
  • Title: Current Waitlist Position
    Read Only: true
    Current waitlist position for the learner.
  • Title: Data Security Privilege
    Maximum Length: 32
    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.
  • Title: Data Security Privilege Description
    Read Only: true
    Maximum Length: 4000
    Description of the value of the dataSecurityPrivilege attribute.
  • Title: Deleted Date
    Read Only: true
    Date when the learner was removed from the waitlist.
  • Title: Entered Pending Payment Date
    Read Only: true
    Date when the related learning assignment was added to the pending payment.
  • Title: Date Learner Entered Pending Prerequisites
    Read Only: true
    Date when the related learning assignment entered pending prerequisites.
  • Title: Date Learner Entered Waitlist
    Read Only: true
    Date when the learning assignment was added to the waitlist.
  • Title: Evaluation Submission Date
    Read Only: true
    Date when the requested learning assignment evaluation was submitted.
  • Title: Exempted Date
    Read Only: true
    Date when the learning assignment was exempted.
  • Title: Date Learner Exited Pending Prerequisites
    Read Only: true
    Date when the related learning assignment exited pending prerequisites.
  • Title: Date Learner Exited Waitlist
    Read Only: true
    Date when the learner exited the waitlist.
  • Title: Expected Effort
    Read Only: true
    Maximum Length: 83
    Expected effort, in hours, to complete the related learning assignment.
  • Title: Expiration Date
    Read Only: true
    Date when the assignment expired in a renewal scenario.
  • Title: Expiration in Days from Today
    Read Only: true
    Expiration time, in days, for the requested learning assignment.
  • Title: Expires
    Read Only: true
    Maximum Length: 80
    Expiration rule for the related learning assignment in a renewal scenario.
  • Title: Requires Renewal
    Read Only: true
    Maximum Length: 20
    Indicates whether the related learning assignment is of type Expiration and has a future renewal.
  • Read Only: true
    Maximum Length: 1
    Indicates whether the related learning assignment has a past renewal.
  • Title: Learning Item CPE Type
    Read Only: true
    Maximum Length: 30
    Continuing professional education type of the learning item. Valid values are defined in the CpeTypeLOV list.
  • Title: Learning Item CPE Type Description
    Read Only: true
    Maximum Length: 4000
    Description of the continuing professional education type.
  • Title: Assigned Learning Effective Date
    Read Only: true
    Learning item version to assign. It can be set to Latest or Assignment to Learner Date.
  • Title: Assigned Learning Item ID
    Read Only: true
    Unique identifier for the learning item. It's the internal primary key.
  • Title: Learning Item Maximum Price
    Maximum price for the learning item.
  • Title: Learning Item Minimum Price
    Minimum price for the learning item.
  • Title: Assigned Learning Item Number
    Maximum Length: 255
    Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.
  • Title: Learning Item Currency
    Currency for the learning item price. Valid values are defined in the PriceCurrencyLOVVA list.
  • Title: Published By
    Read Only: true
    Maximum Length: 240
    Display name of the learning item publisher.
  • Title: Assigned Learning Item Subtype
    Read Only: true
    Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.
  • Read Only: true
    Maximum Length: 4000
    Description of the learning item subtype.
  • Title: Assigned Learning Item Title
    Maximum Length: 250
    Title of the learning item.
  • Title: Assigned Learning Item Type
    Read Only: true
    Maximum Length: 32
    Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the AssignedLearningItemTypeLOV list.
  • Title: Assigned Learning Item Type Description
    Read Only: true
    Maximum Length: 4000
    Description of the learning item type.
  • Links
  • Title: Learning Item Short Description
    Maximum Length: 4000
    Short description provided while creating the learning item.
  • Title: Learning Item Total Expected Effort
    Expected effort to complete the related learning assignment item.
  • Title: Learning Item Total Expected Effort Units
    Maximum Length: 30
    Unit of measure for the expected effort to complete the related learning assignment item. Valid values are defined in the LiTotalExpectedEffortUomLOV list.
  • Title: Learning Item Total Expected Effort Units Description
    Read Only: true
    Maximum Length: 4000
    Description of the unit of measurement for the total expected effort.
  • Title: Renewal Assignment ID
    Read Only: true
    Unique identifier for the renewal assignment of the current learning assignment. It's applicable if the learning assignment has an expiration with renewal.
  • Title: Renewal Assignment Number
    Read Only: true
    Maximum Length: 30
    Friendly number for the renewal assignment of the current learning assignment. It's applicable if the learning assignment has an expiration with the renewal.
  • Title: Purchase Amount
    Purchase amount for the requested learning assignment.
  • Title: Purchase Currency
    Maximum Length: 19
    Purchase currency for the requested learning assignment. Valid values are defined in the PriceCurrencyLOVVA list.
  • Title: Purchased Date
    Read Only: true
    Date the learning was purchased.
  • Title: Status Change Reason Code
    Read Only: true
    Maximum Length: 30
    Reason code for the learning assignment status change. Use this attribute when the learner's manager withdraws the assignment or marks it as complete. Valid values are defined in the ReasonCodeLOV list.
  • Title: Refund Rule
    Read Only: true
    Maximum Length: 240
    Refund rule for the learning assignment.
  • Title: Renewal Period
    Read Only: true
    Number of days before the current learning assignment expires to assign the renewed assignment.
  • Title: Request Approval Date
    Read Only: true
    Approved date for the requested learning assignment.
  • Title: Request Completion Date
    Read Only: true
    Requested date by when the learner should complete the related learning assignment.
  • Title: Requested Date
    Read Only: true
    Date when the related learning assignment was requested.
  • Title: Requested Start By
    Learning request start date specified in the related learning assignment.
  • Title: Request Rejection Date
    Read Only: true
    Rejected date for the requested learning assignment.
  • Title: Assignment Start Date
    Read Only: true
    Start date for the requested learning assignment.
  • Title: Comments
    Read Only: true
    Maximum Length: 4000
    Date when the comment status for the learning assignment was changed.
  • Title: Validity Period Option
    Read Only: true
    Maximum Length: 30
    Validity period rule for the learning assignment indicating the period when the completed learning is valid.
  • Title: Validity Period Option Description
    Read Only: true
    Maximum Length: 4000
    Description of the validity period rule.
  • Title: Withdrawn Date
    Read Only: true
    Date when the learner was withdrawn from the learning item.
  • Title: Withdrawn Requested Date
    Read Only: true
    Withdrawal requested date for the learning assignment.
Back to Top