Get a related assignment record

get

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/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 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>
  • 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-relatedLearningRecords-item-response
Type: object
Show Source
  • Title: Actual CPE Units
    Read Only: true
    Continuing professional education units achieved by the learner for this assignment.
  • Title: Actual Effort in Hours
    Actual effort in hours, taken by the learner to complete the related learning assignment.
  • Title: Actual Score
    Read Only: true
    Actual score achieved by the learner for the related learning assignment.
  • Title: Enrolled on Date
    Read Only: true
    Start date of the learning displayed to the learner in self-service.
  • Title: Assignee Display Name
    Read Only: true
    Maximum Length: 240
    Display-name of the person to whom the learning item was assigned.
  • Title: Assignee Person ID
    Read Only: true
    Unique identifier of the person to whom the learning item was assigned.
  • Title: Assignee Person Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the person to whom the learning item was assigned.
  • Title: Assignee Person Image URL
    Read Only: true
    Maximum Length: 19
    Image URL for the person to whom the learning item was assigned.
  • Title: Assignee Primary Email Address
    Read Only: true
    Maximum Length: 240
    Primary email address of the assignee to whom the learning item was assigned.
  • Title: Assignee Primary Phone Number
    Read Only: true
    Maximum Length: 60
    Primary phone number of the assignee to whom the learning item was assigned.
  • Title: Assignee Attribution Type
    Read Only: true
    Maximum Length: 19
    Entity type to whom the related learning record is assigned. Valid value is a person.
  • Title: Assignee Attribution Type Description
    Read Only: true
    Maximum Length: 4000
    Description for assigned to type.
  • Title: Assigner Attribution Type
    Read Only: true
    Maximum Length: 30
    Default Value: ORA_PERSON
    Entity type that created the related learning record, such as person, specialist, or community. Valid values are defined in the list AssignerToAttributionTypeLOV.
  • Title: Assigner Attribution Type Description
    Read Only: true
    Maximum Length: 4000
    Description for the assigner attribution type.
  • Title: Assigner Comments to Learner
    Maximum Length: 4000
    Comments provided by the assigner to the learner 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 person who created the related learning record for the learner. For example, it's the learner for voluntary assignments and specialist or the alias used in Assign As for specialist-created assignments.
  • Title: Assigner ID
    Read Only: true
    Unique identifier of the assigner of the related learning record.
  • Title: Assigner Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the assigner of the related learning record.
  • Title: Assigner Person Image URL
    Read Only: true
    Maximum Length: 19
    Image URL of the person who assigned the learning item to the learner.
  • 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.
  • 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.
  • Title: Assigner Attribution ID
    Read Only: true
    Unique identifier of the entity creating the related learning record.
  • Title: Assignment Created Date
    Read Only: true
    Date and time when the related assignment was created.
  • Title: Due Date
    Due date of the assignment provided by the learning specialist during the enrollment of a learning item. It's null for voluntary assignments.
  • Title: Assignment Due in from System Date
    Read Only: true
    Due date in days for the requested assignment.
  • Title: Justification
    Read Only: true
    Maximum Length: 4000
    Justification provided by the learner or a specialist in the Learning Request Details section during the related assignment.
  • Title: Assignment Last Modified Date
    Read Only: true
    Date and time when the related assignment was last updated.
  • Title: Enrollment Record ID
    Read Only: true
    Unique identifier of the related enrollment record.
  • Title: Enrollment Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the related enrollment record in the UI.
  • Title: Assignment Relation ID
    Read Only: true
    Unique identifier of the assignment relation.
  • Title: Assignment Relation Type
    Read Only: true
    Type of assignment relation, such as previous completions that were expired by this enrollment and exempted enrollments allowing the learner to claim the credit. Valid values are defined in the list AssignmentRelationTypeLOV.
  • Title: Assignment Relation Type Description
    Read Only: true
    Description for the assignment relation type.
  • Title: Enrollment Record Status
    Read Only: true
    Maximum Length: 32
    Status of the related enrollment, such as Active, Content Completed, Completed, Withdrawn, and Deleted. Valid values are defined in the list AssignmentStatusLOV.
  • Title: Enrollment Record Status Description
    Read Only: true
    Maximum Length: 4000
    Description for the assignment status.
  • Title: Enrollment Record Substatus
    Read Only: true
    Maximum Length: 30
    Granular status of the associated enrollment. For example, No Offering Selected, Not Started, In Progress, and Pending Active are various substatuseses for the Active status. Valid values are defined in the list AssignmentSubStatusLOV.
  • Title: Enrollment Record Substatus Description
    Read Only: true
    Maximum Length: 4000
    Description for the assignment substatus.
  • Title: Enrollment Type
    Read Only: true
    Maximum Length: 32
    Type of the related enrollment, such as required or voluntary. Valid values are defined in the list AssignmentTypeLOV.
  • Title: Enrollment Type Description
    Read Only: true
    Maximum Length: 4000
    Description for the related assignment type.
  • Title: Can Edit Assignment Hint
    Maximum Length: 4000
    Specifies whether you can edit the assignment hint on the related learning record, such as Can delete, Can withdraw, No edit. Valid values are defined in the list CanEditAssignmentHintLOV.
  • Title: Can Edit Assignment Hint Description
    Read Only: true
    Maximum Length: 4000
    Description for the can edit 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 assignment.
  • Title: Current Waitlist Position
    Read Only: true
    Current waitlist position of the learner.
  • Title: Data Security Privilege
    Maximum Length: 32
    Data security privilege, such as Learner or Learner Manager, is the role of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
  • Title: Data Security Privilege Description
    Read Only: true
    Maximum Length: 4000
    Description for the data security privilege.
  • Title: Deleted Date
    Read Only: true
    Date when the learner is removed from the waitlist.
  • Title: Entered Pending Payment Date
    Read Only: true
    Date when the related assignment record was added to the pending payment.
  • Title: Date Learner Entered Pending Prerequisites
    Read Only: true
    Date when the related assignment record entered pending prerequisites.
  • Title: Date Learner Entered Waitlist
    Read Only: true
    Date when the assignment record was added to the waitlist.
  • Title: Evaluation Submission Date
    Read Only: true
    Date when the evaluation was submitted for the requested assignment.
  • Title: Exempted Date
    Read Only: true
    Date when the assignment record was exempted.
  • Title: Date Learner Exited Pending Prerequisites
    Read Only: true
    Date when the related assignment record 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 be put in by the learner 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 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 that the related learning assignment is of expiration type and has 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 list CpeTypeLOV.
  • Title: Learning Item CPE Type Description
    Read Only: true
    Maximum Length: 4000
    Description for the continuing professional education type.
  • Title: Assigned Learning Effective Date
    Read Only: true
    Learning item definition to be assigned. It can be set to Latest or Assignment to Learner Date.
  • Title: Assigned Learning Item ID
    Read Only: true
    Unique identifier of the learning item that'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 UI.
  • Title: Learning Item Currency
    Currency of the price for the learning item. Valid values are defined in the list PriceCurrencyLOVVA.
  • Title: Published By
    Read Only: true
    Maximum Length: 240
    Display-name of the publisher of the learning item.
  • Title: Assigned Learning Item Subtype
    Read Only: true
    Learning item subtype, such as Video and Tutorial. Valid values are defined in the list AssignedLearningItemSubTypeLOV.
  • Read Only: true
    Maximum Length: 4000
    Description for 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, and eLearning. Valid values are defined in the list AssignedLearningItemTypeLOV.
  • Title: Assigned Learning Item Type Description
    Read Only: true
    Maximum Length: 4000
    Description for the learning item type.
  • Links
  • Title: Learning Item Short Description
    Maximum Length: 4000
    Learning item short description provided while creating the learning item.
  • Title: Learning Item Total Expected Effort
    Expected effort to complete the learning item of the related learning record.
  • Title: Learning Item Total Expected Effort Units
    Maximum Length: 30
    Unit of measurement for the expected effort to complete the learning item of the related learning record. Valid values are defined in the list LiTotalExpectedEffortUomLOV.
  • Title: Learning Item Total Expected Effort Units Description
    Read Only: true
    Maximum Length: 4000
    Description for the unit of measurement for the total expected effort.
  • Title: Renewal Assignment ID
    Read Only: true
    Unique identifier of the renewal assignment for the current 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 of the renewal assignment for current assignment. It's applicable if the learning assignment has an expiration with the renewal.
  • Title: Purchase Amount
    Purchase amount for the requested assignment.
  • Title: Purchase Currency
    Maximum Length: 19
    Currency of purchase for the requested assignment. Valid values are defined in the list PriceCurrencyLOVVA.
  • Title: Purchased Date
    Read Only: true
    Date of purchase of the paid learning.
  • Title: Status Change Reason Code
    Read Only: true
    Maximum Length: 30
    Assignment reason code of the assignment. This attribute is used when the learner assignment is withdrawn or marked complete by the manager. Valid values are defined in the list ReasonCodeLOV.
  • Title: Refund Rule
    Read Only: true
    Maximum Length: 240
    Refund rule for the 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 assignment.
  • Title: Request Completion Date
    Read Only: true
    Requested date by which the learner should complete the related learning assignment.
  • Title: Requested Date
    Read Only: true
    Date when the related learning record was requested.
  • Title: Requested Start By
    Learning request start date specified in the related learning record.
  • Title: Request Rejection Date
    Read Only: true
    Rejected date for the requested assignment.
  • Title: Assignment Start Date
    Read Only: true
    Start date for the requested assignment.
  • Title: Comments
    Read Only: true
    Maximum Length: 4000
    Date when the comment status of the assignment was changed.
  • Title: Validity Period Option
    Read Only: true
    Maximum Length: 30
    The validity period rule for the assignment indicates the period for which completed learning is valid.
  • Title: Validity Period Option Description
    Read Only: true
    Maximum Length: 4000
    Description for 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
    Assignment withdrawal requested date of the assignment.
Back to Top