Jump to

• Request
• Response

Get all related assignment records

get

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

Request

Path Parameters

• learnerLearningRecordsUniqID(required): string
  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.
• pastRenewalsUniqID(required): string
  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

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• 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 related learning assignments that match the specified primary key criteria.
    Finder Variables
    • assignmentRelationId; integer; Unique identifier for the assignment relation.
  • findByAssignee Finds all the related learning assignments that match the specified assignee criteria.
    Finder Variables
    • 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 learning assignee.
  • findByAssignmentRecordId Finds all the related learning assignments that match the specified primary key criteria.
    Finder Variables
    • assignmentRecordId; integer; Unique identifier for the assignment record.
    • 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.
  • findByLearningItem Finds all the related learning assignments that match the specified learning item criteria.
    Finder Variables
    • 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.
  • findByLearningItemTitle Finds all the related learning assignments for learning items that match the specified learning item criteria.
    Finder Variables
    • 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 the related learning assignments for the specified manager's subordinates.
    Finder Variables
    • 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 learning assignments that match the specified primary key criteria.
    Finder Variables
    • 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.
• 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:
  

  • actualCpeUnits; number; Continuing professional education units that the learner achieved for this assignment.
  • actualEffortInHours; number; Actual learner effort, in hours, to complete the related learning assignment.
  • actualScore; number; Actual learner score for the related learning assignment.
  • assignedDate; string; Learning start date, visible to the learner on various self-service learning pages.
  • assignedToDisplayName; string; Display name of 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 learning item assignee.
  • assignedToPersonPrimaryPhoneNumber; string; Primary phone number for the learning item assignee.
  • assignedToType; string; Entity type for the related learning assignment assignee. Valid value is a person.
  • assignedToTypeMeaning; string; Description of the assigned to type.
  • assignerAttributionType; string; Entity type for the related learning assignment creator, such as person, specialist, or community. Valid values are defined in the AssignerToAttributionTypeLOV list.
  • assignerAttributionTypeMeaning; string; Description of the assigner attribution type.
  • assignerCommentsToLearner; string; Assigner comments to the learner made while creating the related learning assignment. It's null when there are no comments.
  • assignerDisplayName; string; 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.
  • assignerId; integer; Unique identifier for the related learning assignment assigner.
  • assignerNumber; string; Friendly number identifying the related learning assignment assigner.
  • assignerPersonImageURL; string; Image URL for the person who assigned the learning item to the learner.
  • assignerPersonPrimaryEmailAddress; string; Email address for the learning item assigner.
  • assignerPersonPrimaryPhoneNumber; string; Phone number for the learning item assigner.
  • assignmentAttributionId; integer; Unique identifier for the related learning assignment creator.
  • assignmentCreatedDate; string; Date and time when the related learning assignment was created.
  • assignmentDetailsDeepLink; string; URL to open the related learning enrollment page directly from the browser.
  • assignmentDetailsEmbedLink; string; URL to embed the learning item page in the 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 date, in days, for the requested learning assignment.
  • assignmentJustification; string; Justification provided by the learner during a request, or the justification added by the specialist in the learning request details during the related assignment.
  • assignmentLastModifiedDate; string; Date and time when the related assignment was most recently updated.
  • assignmentRecordId; integer; Unique identifier for the related learning enrollment.
  • assignmentRecordNumber; string; Friendly number identifying the related learning enrollment in the user interface.
  • assignmentRelationId; integer; Unique identifier for the learning assignment relation.
  • assignmentRelationType; string; 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.
  • assignmentRelationTypeMeaning; string; Description of the learning assignment relation type.
  • assignmentStatus; string; Status of the related learning enrollment, such as Active, Content Completed, Completed, Withdrawn, or Deleted. Valid values are defined in the AssignmentStatusLOV list.
  • assignmentStatusMeaning; string; Description of the learning assignment status.
  • assignmentSubStatus; string; 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.
  • assignmentSubStatusMeaning; string; Description of the learning assignment substatus.
  • assignmentType; string; Type of the related learning enrollment, such as required or voluntary. Valid values are defined in the AssignmentTypeLOV list.
  • assignmentTypeMeaning; string; Description of the related learning assignment type.
  • canEditAssignmentHint; string; 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.
  • canEditAssignmentHintMeaning; string; Description of the can edit learning assignment hint.
  • completedDate; string; Date when the learning was completed.
  • contentCompletedDate; string; Completed date for the requested learning assignment.
  • currentWaitlistPosition; integer; Current waitlist position for 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.
  • enteredPendingPaymentDate; string; Date when the related learning assignment was added to the pending payment.
  • enteredPendingPrerequisitesDate; string; Date when the related learning assignment entered pending prerequisites.
  • enteredWaitlistDate; string; Date when the learning assignment was added to the waitlist.
  • evaluationSubmittedDate; string; Date when the requested learning assignment evaluation was submitted.
  • exemptedDate; string; Date when the learning assignment was exempted.
  • exitedPendingPrerequisitesDate; string; Date when the related learning assignment exited pending prerequisites.
  • exitedWaitlistDate; string; Date when the learner exited the waitlist.
  • expectedEffortInHours; string; Expected effort, in hours, to complete the related learning assignment.
  • expirationDate; string; Date when the assignment expired in a renewal scenario.
  • expirationInDaysSystemDate; number; Expiration time, in days, for the requested learning assignment.
  • expirationRule; string; Expiration rule for the related learning assignment in a renewal scenario.
  • hasFutureRenewal; string; Indicates whether the related learning assignment is of type Expiration and has a future renewal.
  • hasPastRenewal; string; Indicates whether the related learning assignment has a past renewal.
  • learningItemCompletionCertificateLink; string; URL to open and download the learning item completion certificate directly from the browser. Supported for completed and bypass completed course, specialization, and legacy learning assignments.
  • 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 CpeTypeLOV list.
  • learningItemCpeTypeMeaning; string; Description of the continuing professional education type.
  • learningItemDataLink; string; Data link to the learning item.
  • learningItemDeepLink; string; URL to open the learning item page directly from the browser.
  • learningItemEffectiveAsOf; string; Learning item version to assign. It can be set to Latest or Assignment to Learner Date.
  • learningItemEmbedLink; string; URL to embed the learning item page in the 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.
  • 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 user interface.
  • learningItemPriceCurrency; string; Currency for the learning item price. Valid values are defined in the PriceCurrencyLOVVA list.
  • learningItemPublisherDisplayName; string; Display 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 learning item subtype.
  • 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 learning item type.
  • liShortDescription; string; Short description provided while creating the learning item.
  • liTotalExpectedEffort; number; Expected effort to complete the related learning assignment item.
  • liTotalExpectedEffortUOM; string; Unit of measure for the expected effort to complete the related learning assignment item. Valid values are defined in the LiTotalExpectedEffortUomLOV list.
  • liTotalExpectedEffortUOMMeaning; string; Description of the unit of measurement for the total expected effort.
  • nextRenewalAssignmentDeepLink; string; URL to open the next renewal learning enrollment page directly from the browser.
  • nextRenewalAssignmentEmbedLink; string; URL to embed the next renewal learning enrollment page in other pages. It opens the isolated learning item page without the global tool bar on the top.
  • nextRenewalAssignmentId; integer; Unique identifier for the renewal assignment of the current learning assignment. It's applicable if the learning assignment has an expiration with renewal.
  • nextRenewalAssignmentNumber; string; Friendly number for the renewal assignment of the current learning assignment. It's applicable if the learning assignment has an expiration with the renewal.
  • purchaseAmount; number; Purchase amount for the requested learning assignment.
  • purchaseCurrency; string; Purchase currency for the requested learning assignment. Valid values are defined in the PriceCurrencyLOVVA list.
  • purchasedDate; string; Date the learning was purchased.
  • reasonCode; string; 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.
  • refundRule; string; Refund rule for the learning assignment.
  • renewalPeriod; number; Number of days before the current learning assignment expires to assign the renewed assignment.
  • requestApprovedDate; string; Approved date for the requested learning assignment.
  • requestRejectedDate; string; Rejected date for the requested learning assignment.
  • requestedCompleteByDate; string; Requested date by when the learner should complete the related learning assignment.
  • requestedDate; string; Date when the related learning assignment was requested.
  • requestedStartDate; string; Learning request start date specified in the related learning assignment.
  • startedDate; string; Start date for the requested learning assignment.
  • statusChangeComment; string; Date when the comment status for the learning assignment was changed.
  • validityPeriodRule; string; Validity period rule for the learning assignment indicating the period when the completed learning is valid.
  • validityPeriodRuleMeaning; string; Description of the validity period rule.
  • withdrawnDate; string; Date when the learner was withdrawn from the learning item.
  • withdrawnRequestedDate; string; Withdrawal requested date for the learning assignment.
• 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

• 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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : learnerLearningRecords-pastRenewals-relatedLearningRecords

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-pastRenewals-relatedLearningRecords-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object learnerLearningRecords-pastRenewals-relatedLearningRecords-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-pastRenewals-relatedLearningRecords-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : learnerLearningRecords-pastRenewals-relatedLearningRecords-item-response

Type: object

Show Source

• actualCpeUnits: number
  Title: Actual CPE Units

  Read Only: true

  Continuing professional education units that the learner achieved for this assignment.
• actualEffortInHours: number
  Title: Actual Effort in Hours

  Actual learner effort, in hours, to complete the related learning assignment.
• actualScore: number
  Title: Actual Score

  Read Only: true

  Actual learner score for the related learning assignment.
• assignedDate: string (date-time)
  Title: Enrolled on Date

  Read Only: true

  Learning start date, visible to the learner on various self-service learning pages.
• assignedToDisplayName: string
  Title: Assignee Display Name

  Read Only: true

  Maximum Length: 240

  Display name of the learning item assignee.
• assignedToId: integer (int64)
  Title: Assignee Person ID

  Read Only: true

  Unique identifier for the learning item assignee.
• assignedToNumber: string
  Title: Assignee Person Number

  Read Only: true

  Maximum Length: 30

  Friendly number identifying the learning item assignee.
• assignedToPersonImageURL: string
  Title: Assignee Person Image URL

  Read Only: true

  Maximum Length: 19

  Image URL for the learning item assignee.
• assignedToPersonPrimaryEmailAddress: string
  Title: Assignee Primary Email Address

  Read Only: true

  Maximum Length: 240

  Primary email address for learning item assignee.
• assignedToPersonPrimaryPhoneNumber: string
  Title: Assignee Primary Phone Number

  Read Only: true

  Maximum Length: 60

  Primary phone number for the learning item assignee.
• assignedToType: string
  Title: Assignee Attribution Type

  Read Only: true

  Maximum Length: 19

  Entity type for the related learning assignment assignee. Valid value is a person.
• assignedToTypeMeaning: string
  Title: Assignee Attribution Type Description

  Read Only: true

  Maximum Length: 4000

  Description of the assigned to type.
• assignerAttributionType: string
  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.
• assignerAttributionTypeMeaning: string
  Title: Assigner Attribution Type Description

  Read Only: true

  Maximum Length: 4000

  Description of the assigner attribution type.
• assignerCommentsToLearner: string
  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.
• assignerDisplayName: string
  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.
• assignerId: integer (int64)
  Title: Assigner ID

  Read Only: true

  Unique identifier for the related learning assignment assigner.
• assignerNumber: string
  Title: Assigner Number

  Read Only: true

  Maximum Length: 30

  Friendly number identifying the related learning assignment assigner.
• assignerPersonImageURL: string
  Title: Assigner Person Image URL

  Read Only: true

  Maximum Length: 19

  Image URL for 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 for the learning item assigner.
• assignerPersonPrimaryPhoneNumber: string
  Title: Assigner Person Primary Phone Number

  Read Only: true

  Maximum Length: 60

  Phone number for the learning item assigner.
• assignmentAttributionId: integer (int64)
  Title: Assigner Attribution ID

  Read Only: true

  Unique identifier for the related learning assignment creator.
• assignmentCreatedDate: string (date-time)
  Title: Assignment Created Date

  Read Only: true

  Date and time when the related learning assignment was created.
• assignmentDetailsDeepLink: string
  Title: Assignment Details Deep Link

  Read Only: true

  Maximum Length: 4000

  URL to open the related learning enrollment page directly from the browser.
• assignmentDetailsEmbedLink: string
  Title: Assignment Details Embed Link

  Read Only: true

  Maximum Length: 4000

  URL to embed the learning item page in the other pages. It opens the isolated learning item page without the global toolbar on the top.
• assignmentDueDate: string (date-time)
  Title: Due Date

  Due date of the learning-specialist-created assignment. The value is null for voluntary assignments.
• assignmentDueInFromSystemDate: integer
  Title: Assignment Due in from System Date

  Read Only: true

  Due date, in days, for the requested learning assignment.
• assignmentJustification: string
  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.
• assignmentLastModifiedDate: string (date-time)
  Title: Assignment Last Modified Date

  Read Only: true

  Date and time when the related assignment was most recently updated.
• assignmentRecordId: integer (int64)
  Title: Enrollment Record ID

  Read Only: true

  Unique identifier for the related learning enrollment.
• assignmentRecordNumber: string
  Title: Enrollment Number

  Read Only: true

  Maximum Length: 30

  Friendly number identifying the related learning enrollment in the user interface.
• assignmentRelationId: integer (int64)
  Title: Assignment Relation ID

  Read Only: true

  Unique identifier for the learning assignment relation.
• assignmentRelationType: string
  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.
• assignmentRelationTypeMeaning: string
  Title: Assignment Relation Type Description

  Read Only: true

  Description of the learning assignment relation type.
• assignmentStatus: string
  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.
• assignmentStatusMeaning: string
  Title: Enrollment Record Status Description

  Read Only: true

  Maximum Length: 4000

  Description of the learning assignment status.
• assignmentSubStatus: string
  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.
• assignmentSubStatusMeaning: string
  Title: Enrollment Record Substatus Description

  Read Only: true

  Maximum Length: 4000

  Description of the learning assignment substatus.
• assignmentType: string
  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.
• assignmentTypeMeaning: string
  Title: Enrollment Type Description

  Read Only: true

  Maximum Length: 4000

  Description of the related learning assignment type.
• canEditAssignmentHint: string
  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.
• canEditAssignmentHintMeaning: string
  Title: Can Edit Assignment Hint Description

  Read Only: true

  Maximum Length: 4000

  Description of the can edit learning assignment hint.
• completedDate: string (date-time)
  Title: Completed Date

  Read Only: true

  Date when the learning was completed.
• contentCompletedDate: string (date)
  Title: Content Completed Date

  Read Only: true

  Completed date for the requested learning assignment.
• currentWaitlistPosition: integer (int64)
  Title: Current Waitlist Position

  Read Only: true

  Current waitlist position for the learner.
• dataSecurityPrivilege: string
  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.
• dataSecurityPrivilegeMeaning: string
  Title: Data Security Privilege Description

  Read Only: true

  Maximum Length: 4000

  Description of the value of the dataSecurityPrivilege attribute.
• deletedDate: string (date)
  Title: Deleted Date

  Read Only: true

  Date when the learner was removed from the waitlist.
• enteredPendingPaymentDate: string (date-time)
  Title: Entered Pending Payment Date

  Read Only: true

  Date when the related learning assignment was added to the pending payment.
• enteredPendingPrerequisitesDate: string (date)
  Title: Date Learner Entered Pending Prerequisites

  Read Only: true

  Date when the related learning assignment entered pending prerequisites.
• enteredWaitlistDate: string (date)
  Title: Date Learner Entered Waitlist

  Read Only: true

  Date when the learning assignment was added to the waitlist.
• evaluationSubmittedDate: string (date)
  Title: Evaluation Submission Date

  Read Only: true

  Date when the requested learning assignment evaluation was submitted.
• exemptedDate: string (date-time)
  Title: Exempted Date

  Read Only: true

  Date when the learning assignment was exempted.
• exitedPendingPrerequisitesDate: string (date)
  Title: Date Learner Exited Pending Prerequisites

  Read Only: true

  Date when the related learning assignment exited pending prerequisites.
• 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, in hours, to complete the related learning assignment.
• expirationDate: string (date)
  Title: Expiration Date

  Read Only: true

  Date when the assignment expired in a renewal scenario.
• expirationInDaysSystemDate: number
  Title: Expiration in Days from Today

  Read Only: true

  Expiration time, in days, for the requested learning assignment.
• expirationRule: string
  Title: Expires

  Read Only: true

  Maximum Length: 80

  Expiration rule for the related learning assignment in a renewal scenario.
• hasFutureRenewal: string
  Title: Requires Renewal

  Read Only: true

  Maximum Length: 20

  Indicates whether the related learning assignment is of type Expiration and has a future renewal.
• hasPastRenewal: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the related learning assignment has a past renewal.
• learningItemCompletionCertificateLink: string
  Title: Learning Item Completion Certificate Link

  URL to open and download the learning item completion certificate directly from the browser. Supported for completed and bypass completed course, specialization, and legacy learning assignments.
• 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

  Read Only: true

  Maximum Length: 30

  Continuing professional education type of the learning item. Valid values are defined in the CpeTypeLOV list.
• learningItemCpeTypeMeaning: string
  Title: Learning Item CPE Type Description

  Read Only: true

  Maximum Length: 4000

  Description of the continuing professional education type.
• 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 learning item page directly from the browser.
• learningItemEffectiveAsOf: string (date)
  Title: Assigned Learning Effective Date

  Read Only: true

  Learning item version to assign. It can be set to Latest or Assignment to Learner Date.
• learningItemEmbedLink: string
  Title: Learning Item Embed Link

  Read Only: true

  Maximum Length: 4000

  URL to embed the learning item page in the other pages. It opens the isolated learning item page without the global toolbar on the top.
• learningItemId: integer (int64)
  Title: Assigned Learning Item ID

  Read Only: true

  Unique identifier for the learning item. It's the internal primary key.
• 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: 255

  Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.
• learningItemPriceCurrency: string
  Title: Learning Item Currency

  Currency for the learning item price. Valid values are defined in the PriceCurrencyLOVVA list.
• learningItemPublisherDisplayName: string
  Title: Published By

  Read Only: true

  Maximum Length: 240

  Display name of the learning item publisher.
• learningItemSubType: string
  Title: Assigned Learning Item Subtype

  Read Only: true

  Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.
• learningItemSubTypeMeaning: string
  Read Only: true

  Maximum Length: 4000

  Description of the learning item subtype.
• 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

  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.
• learningItemTypeMeaning: string
  Title: Assigned Learning Item Type Description

  Read Only: true

  Maximum Length: 4000

  Description of the learning item type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• liShortDescription: string
  Title: Learning Item Short Description

  Maximum Length: 4000

  Short description provided while creating the learning item.
• liTotalExpectedEffort: number
  Title: Learning Item Total Expected Effort

  Expected effort to complete the related learning assignment item.
• liTotalExpectedEffortUOM: string
  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.
• liTotalExpectedEffortUOMMeaning: string
  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.
• nextRenewalAssignmentDeepLink: string
  Title: Next Renewal Assignment Deep Link

  Read Only: true

  Maximum Length: 4000

  URL to open the next renewal learning enrollment page directly from the browser.
• nextRenewalAssignmentEmbedLink: string
  Title: Next Renewal Assignment Embed Link

  Read Only: true

  Maximum Length: 4000

  URL to embed the next renewal learning enrollment 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

  Unique identifier for the renewal assignment of the current learning assignment. It's applicable if the learning assignment has an expiration with renewal.
• nextRenewalAssignmentNumber: string
  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.
• purchaseAmount: number
  Title: Purchase Amount

  Purchase amount for the requested learning assignment.
• purchaseCurrency: string
  Title: Purchase Currency

  Maximum Length: 19

  Purchase currency for the requested learning assignment. Valid values are defined in the PriceCurrencyLOVVA list.
• purchasedDate: string (date)
  Title: Purchased Date

  Read Only: true

  Date the learning was purchased.
• reasonCode: string
  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.
• refundRule: string
  Title: Refund Rule

  Read Only: true

  Maximum Length: 240

  Refund rule for the learning assignment.
• renewalPeriod: number
  Title: Renewal Period

  Read Only: true

  Number of days before the current learning assignment expires to assign the renewed assignment.
• requestApprovedDate: string (date)
  Title: Request Approval Date

  Read Only: true

  Approved date for the requested learning assignment.
• requestedCompleteByDate: string (date)
  Title: Request Completion Date

  Read Only: true

  Requested date by when the learner should complete the related learning assignment.
• requestedDate: string (date-time)
  Title: Requested Date

  Read Only: true

  Date when the related learning assignment was requested.
• requestedStartDate: string (date-time)
  Title: Requested Start By

  Learning request start date specified in the related learning assignment.
• requestRejectedDate: string (date)
  Title: Request Rejection Date

  Read Only: true

  Rejected date for the requested learning assignment.
• startedDate: string (date)
  Title: Assignment Start Date

  Read Only: true

  Start date for the requested learning assignment.
• statusChangeComment: string
  Title: Comments

  Read Only: true

  Maximum Length: 4000

  Date when the comment status for the learning assignment was changed.
• validityPeriodRule: string
  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.
• validityPeriodRuleMeaning: string
  Title: Validity Period Option Description

  Read Only: true

  Maximum Length: 4000

  Description of the validity period rule.
• withdrawnDate: string (date-time)
  Title: Withdrawn Date

  Read Only: true

  Date when the learner was withdrawn from the learning item.
• withdrawnRequestedDate: string (date-time)
  Title: Withdrawn Requested Date

  Read Only: true

  Withdrawal requested date for the learning assignment.

{
    "type":"object",
    "properties":{
        "assignedDate":{
            "title":"Enrolled on Date",
            "type":"string",
            "description":"Learning start date, visible to the learner on various self-service learning pages.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemSubTypeMeaning":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning item subtype.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "nextRenewalAssignmentDeepLink":{
            "title":"Next Renewal Assignment Deep Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the next renewal learning enrollment page directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignerPersonPrimaryPhoneNumber":{
            "title":"Assigner Person Primary Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"Phone number for the learning item assigner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "requestApprovedDate":{
            "title":"Request Approval Date",
            "type":"string",
            "description":"Approved date for the requested learning assignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignedToPersonPrimaryPhoneNumber":{
            "title":"Assignee Primary Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"Primary phone number for the learning item assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemEffectiveAsOf":{
            "title":"Assigned Learning Effective Date",
            "type":"string",
            "description":"Learning item version to assign. It can be set to Latest or Assignment to Learner Date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignedToType":{
            "title":"Assignee Attribution Type",
            "maxLength":19,
            "type":"string",
            "description":"Entity type for the related learning assignment assignee. Valid value is a person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "expirationInDaysSystemDate":{
            "title":"Expiration in Days from Today",
            "type":"number",
            "description":"Expiration time, in days, for the requested learning assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignerCommentsToLearner":{
            "title":"Assigner Comments to Learner",
            "maxLength":4000,
            "type":"string",
            "description":"Assigner comments to the learner made while creating the related learning assignment. It's null when there are no comments.",
            "nullable":true,
            "x-queryable":true
        },
        "actualEffortInHours":{
            "title":"Actual Effort in Hours",
            "type":"number",
            "description":"Actual learner effort, in hours, to complete the related learning assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "assignerPersonImageURL":{
            "title":"Assigner Person Image URL",
            "maxLength":19,
            "type":"string",
            "description":"Image URL for the person who assigned the learning item to the learner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "assignerId"
                ]
            },
            "x-queryable":true
        },
        "assignedToDisplayName":{
            "title":"Assignee Display Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the learning item assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentTypeMeaning":{
            "title":"Enrollment Type Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the related learning assignment type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemCoverArtLink":{
            "title":"Learning Item Cover Art Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the learning item cover art directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "nextRenewalAssignmentId":{
            "title":"Renewal Assignment ID",
            "type":"integer",
            "description":"Unique identifier for the renewal assignment of the current learning assignment. It's applicable if the learning assignment has an expiration with renewal.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "learningItemEmbedLink":{
            "title":"Learning Item Embed Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to embed the learning item page in the other pages. It opens the isolated learning item page without the global toolbar on the top.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "assignmentRecordId",
                    "learningItemId",
                    "learningItemType"
                ]
            },
            "x-queryable":true
        },
        "actualCpeUnits":{
            "title":"Actual CPE Units",
            "type":"number",
            "description":"Continuing professional education units that the learner achieved for this assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentRelationId":{
            "title":"Assignment Relation ID",
            "type":"integer",
            "description":"Unique identifier for the learning assignment relation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "assignedToPersonPrimaryEmailAddress":{
            "title":"Assignee Primary Email Address",
            "maxLength":240,
            "type":"string",
            "description":"Primary email address for learning item assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "deletedDate":{
            "title":"Deleted Date",
            "type":"string",
            "description":"Date when the learner was removed from the waitlist.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "liShortDescription":{
            "title":"Learning Item Short Description",
            "maxLength":4000,
            "type":"string",
            "description":"Short description provided while creating the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemCpeTypeMeaning":{
            "title":"Learning Item CPE Type Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the continuing professional education type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignerId":{
            "title":"Assigner ID",
            "type":"integer",
            "description":"Unique identifier for the related learning assignment assigner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "assignedToId":{
            "title":"Assignee Person ID",
            "type":"integer",
            "description":"Unique identifier for the learning item assignee.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "assignmentRecordNumber":{
            "title":"Enrollment Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the related learning enrollment in the user interface.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "assignmentDueInFromSystemDate":{
            "title":"Assignment Due in from System Date",
            "type":"integer",
            "description":"Due date, in days, for the requested learning assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignedToTypeMeaning":{
            "title":"Assignee Attribution Type Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the assigned to type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "startedDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"Start date for the requested learning assignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "purchaseCurrency":{
            "title":"Purchase Currency",
            "maxLength":19,
            "type":"string",
            "description":"Purchase currency for the requested learning assignment. Valid values are defined in the PriceCurrencyLOVVA list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "offeringAssignmentRecordId"
                ]
            },
            "x-queryable":true
        },
        "statusChangeComment":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Date when the comment status for the learning assignment was changed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "requestedCompleteByDate":{
            "title":"Request Completion Date",
            "type":"string",
            "description":"Requested date by when the learner should complete the related learning assignment.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "withdrawnRequestedDate":{
            "title":"Withdrawn Requested Date",
            "type":"string",
            "description":"Withdrawal requested date for the learning assignment.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "hasFutureRenewal":{
            "title":"Requires Renewal",
            "maxLength":20,
            "type":"string",
            "description":"Indicates whether the related learning assignment is of type Expiration and has a future renewal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "requestedDate":{
            "title":"Requested Date",
            "type":"string",
            "description":"Date when the related learning assignment was requested.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "reasonCode":{
            "title":"Status Change Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "enteredPendingPaymentDate":{
            "title":"Entered Pending Payment Date",
            "type":"string",
            "description":"Date when the related learning assignment was added to the pending payment.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentCreatedDate":{
            "title":"Assignment Created Date",
            "type":"string",
            "description":"Date and time when the related learning assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemCpeType":{
            "title":"Learning Item CPE Type",
            "maxLength":30,
            "type":"string",
            "description":"Continuing professional education type of the learning item. Valid values are defined in the CpeTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignmentStatus":{
            "title":"Enrollment Record Status",
            "maxLength":32,
            "type":"string",
            "description":"Status of the related learning enrollment, such as Active, Content Completed, Completed, Withdrawn, or Deleted. Valid values are defined in the AssignmentStatusLOV list.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "renewalPeriod":{
            "title":"Renewal Period",
            "type":"number",
            "description":"Number of days before the current learning assignment expires to assign the renewed assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentSubStatusMeaning":{
            "title":"Enrollment Record Substatus Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning assignment substatus.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "assignmentSubStatus"
                ]
            },
            "x-queryable":true
        },
        "expirationRule":{
            "title":"Expires",
            "maxLength":80,
            "type":"string",
            "description":"Expiration rule for the related learning assignment in a renewal scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentDetailsDeepLink":{
            "title":"Assignment Details Deep Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the related learning enrollment page directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentRecordId":{
            "title":"Enrollment Record ID",
            "type":"integer",
            "description":"Unique identifier for the related learning enrollment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "CATEGORY":"General",
                "precision":18
            },
            "x-queryable":true
        },
        "assignmentAttributionId":{
            "title":"Assigner Attribution ID",
            "type":"integer",
            "description":"Unique identifier for the related learning assignment creator.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "assignedToPersonImageURL":{
            "title":"Assignee Person Image URL",
            "maxLength":19,
            "type":"string",
            "description":"Image URL for the learning item assignee.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "assignedToId"
                ]
            },
            "x-queryable":true
        },
        "learningItemPublisherDisplayName":{
            "title":"Published By",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the learning item publisher.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemThumbnailLink":{
            "title":"Learning Item Thumbnail Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the learning item thumbnail directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemTrailerLink":{
            "title":"Learning Item Trailer Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the learning item trailer directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentJustification":{
            "title":"Justification",
            "maxLength":4000,
            "type":"string",
            "description":"Justification provided by the learner during a request, or the justification added by the specialist in the learning request details during the related assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "liTotalExpectedEffortUOM":{
            "title":"Learning Item Total Expected Effort Units",
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure for the expected effort to complete the related learning assignment item. Valid values are defined in the LiTotalExpectedEffortUomLOV list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "learningItemNumber":{
            "title":"Assigned Learning Item Number",
            "maxLength":255,
            "type":"string",
            "description":"Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentStatusMeaning":{
            "title":"Enrollment Record Status Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning assignment status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "assignmentStatus"
                ]
            },
            "x-queryable":true
        },
        "nextRenewalAssignmentNumber":{
            "title":"Renewal Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number for the renewal assignment of the current learning assignment. It's applicable if the learning assignment has an expiration with the renewal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignedToNumber":{
            "title":"Assignee Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning item assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "requestedStartDate":{
            "title":"Requested Start By",
            "type":"string",
            "description":"Learning request start date specified in the related learning assignment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "refundRule":{
            "title":"Refund Rule",
            "maxLength":240,
            "type":"string",
            "description":"Refund rule for the learning assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "purchasedDate":{
            "title":"Purchased Date",
            "type":"string",
            "description":"Date the learning was purchased.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "dataSecurityPrivilege":{
            "title":"Data Security Privilege",
            "maxLength":32,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "assignmentDetailsEmbedLink":{
            "title":"Assignment Details Embed Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to embed the learning item page in the other pages. It opens the isolated learning item page without the global toolbar on the top.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemMinimumPrice":{
            "title":"Learning Item Minimum Price",
            "type":"number",
            "description":"Minimum price for the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "dataSecurityPrivilegeMeaning":{
            "title":"Data Security Privilege Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the value of the dataSecurityPrivilege attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "liTotalExpectedEffortUOMMeaning":{
            "title":"Learning Item Total Expected Effort Units Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the unit of measurement for the total expected effort.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "canEditAssignmentHintMeaning":{
            "title":"Can Edit Assignment Hint Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the can edit learning assignment hint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "liTotalExpectedEffort":{
            "title":"Learning Item Total Expected Effort",
            "type":"number",
            "description":"Expected effort to complete the related learning assignment item.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentSubStatus":{
            "title":"Enrollment Record Substatus",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "completedDate":{
            "title":"Completed Date",
            "type":"string",
            "description":"Date when the learning was completed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentRelationTypeMeaning":{
            "title":"Assignment Relation Type Description",
            "type":"string",
            "description":"Description of the learning assignment relation type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "exemptedDate":{
            "title":"Exempted Date",
            "type":"string",
            "description":"Date when the learning assignment was exempted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemDeepLink":{
            "title":"Learning Item Deep Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the learning item page directly from the browser.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "learningItemId",
                    "learningItemType"
                ]
            },
            "x-queryable":true
        },
        "assignerDisplayName":{
            "title":"Enrolled By",
            "maxLength":240,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignerPersonPrimaryEmailAddress":{
            "title":"Assigner Person Primary Email Address",
            "maxLength":240,
            "type":"string",
            "description":"Email address for the learning item assigner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "canEditAssignmentHint":{
            "title":"Can Edit Assignment Hint",
            "maxLength":4000,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignerNumber":{
            "title":"Assigner Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the related learning assignment assigner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "withdrawnDate":{
            "title":"Withdrawn Date",
            "type":"string",
            "description":"Date when the learner was withdrawn from the learning item.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "exitedWaitlistDate":{
            "title":"Date Learner Exited Waitlist",
            "type":"string",
            "description":"Date when the learner exited the waitlist.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemTitle":{
            "title":"Assigned Learning Item Title",
            "maxLength":250,
            "type":"string",
            "description":"Title of the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentType":{
            "title":"Enrollment Type",
            "maxLength":32,
            "type":"string",
            "description":"Type of the related learning enrollment, such as required or voluntary. Valid values are defined in the AssignmentTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "learningItemDataLink":{
            "title":"Learning Item Data Link",
            "maxLength":4000,
            "type":"string",
            "description":"Data link to the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "assignmentRecordId",
                    "learningItemId",
                    "learningItemType"
                ]
            },
            "x-queryable":true
        },
        "learningItemTypeMeaning":{
            "title":"Assigned Learning Item Type Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning item type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "learningItemType"
                ]
            },
            "x-queryable":true
        },
        "validityPeriodRuleMeaning":{
            "title":"Validity Period Option Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the validity period rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "evaluationSubmittedDate":{
            "title":"Evaluation Submission Date",
            "type":"string",
            "description":"Date when the requested learning assignment evaluation was submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "enteredPendingPrerequisitesDate":{
            "title":"Date Learner Entered Pending Prerequisites",
            "type":"string",
            "description":"Date when the related learning assignment entered pending prerequisites.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "exitedPendingPrerequisitesDate":{
            "title":"Date Learner Exited Pending Prerequisites",
            "type":"string",
            "description":"Date when the related learning assignment exited pending prerequisites.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemId":{
            "title":"Assigned Learning Item ID",
            "type":"integer",
            "description":"Unique identifier for the learning item. It's the internal primary key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "enteredWaitlistDate":{
            "title":"Date Learner Entered Waitlist",
            "type":"string",
            "description":"Date when the learning assignment was added to the waitlist.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "expirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the assignment expired in a renewal scenario.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currentWaitlistPosition":{
            "title":"Current Waitlist Position",
            "type":"integer",
            "description":"Current waitlist position for the learner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":30
            },
            "x-queryable":true
        },
        "learningItemPriceCurrency":{
            "title":"Learning Item Currency",
            "type":"string",
            "description":"Currency for the learning item price. Valid values are defined in the PriceCurrencyLOVVA list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignmentRelationType":{
            "title":"Assignment Relation Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "expectedEffortInHours":{
            "title":"Expected Effort",
            "maxLength":83,
            "type":"string",
            "description":"Expected effort, in hours, to complete the related learning assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "actualScore":{
            "title":"Actual Score",
            "type":"number",
            "description":"Actual learner score for the related learning assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9,
                "scale":3
            },
            "x-queryable":true
        },
        "contentCompletedDate":{
            "title":"Content Completed Date",
            "type":"string",
            "description":"Completed date for the requested learning assignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentLastModifiedDate":{
            "title":"Assignment Last Modified Date",
            "type":"string",
            "description":"Date and time when the related assignment was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemMaximumPrice":{
            "title":"Learning Item Maximum Price",
            "type":"number",
            "description":"Maximum price for the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemType":{
            "title":"Assigned Learning Item Type",
            "maxLength":32,
            "type":"string",
            "description":"Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the AssignedLearningItemTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "requestRejectedDate":{
            "title":"Request Rejection Date",
            "type":"string",
            "description":"Rejected date for the requested learning assignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "purchaseAmount":{
            "title":"Purchase Amount",
            "type":"number",
            "description":"Purchase amount for the requested learning assignment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "offeringAssignmentRecordId"
                ]
            },
            "x-queryable":true
        },
        "assignerAttributionTypeMeaning":{
            "title":"Assigner Attribution Type Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the assigner attribution type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"Due date of the learning-specialist-created assignment. The value is null for voluntary assignments.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemCompletionCertificateLink":{
            "title":"Learning Item Completion Certificate Link",
            "type":"string",
            "description":"URL to open and download the learning item completion certificate directly from the browser. Supported for completed and bypass completed course, specialization, and legacy learning assignments.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemSubType":{
            "title":"Assigned Learning Item Subtype",
            "type":"string",
            "description":"Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "hasPastRenewal":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the related learning assignment has a past renewal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "validityPeriodRule":{
            "title":"Validity Period Option",
            "maxLength":30,
            "type":"string",
            "description":"Validity period rule for the learning assignment indicating the period when the completed learning is valid.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "nextRenewalAssignmentEmbedLink":{
            "title":"Next Renewal Assignment Embed Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to embed the next renewal learning enrollment page in other pages. It opens the isolated learning item page without the global tool bar on the top.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignerAttributionType":{
            "title":"Assigner Attribution Type",
            "maxLength":30,
            "type":"string",
            "description":"Entity type for the related learning assignment creator, such as person, specialist, or community. Valid values are defined in the AssignerToAttributionTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_PERSON",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top