Get all learning items
get
/hcmRestApi/resources/11.13.18.05/learningSelfPacedItems
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all learning items that match the specified primary key criteria.
Finder Variables- learningItemId; integer; Unique identifier for the learning item.
- findByLearningItemId Finds all learning items that match the specified primary key criteria.
Finder Variables- SysEffectiveDate; object;
- learningItemId; integer; Unique identifier for the learning item.
- findByLearningItemNumber Finds all the learning items that match the specified learning item number.
Finder Variables- SysEffectiveDate; object;
- learningItemNumber; string; User-friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.
- PrimaryKey Finds all learning items that match the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- learningItemActiveDate; string; Date when the learning item was activated
- learningItemApprovalRuleESS; string; Determines how approvals are configured for self-service enrollment.
- learningItemApprovalRuleMSS; string; Determines how approvals are configured for manager enrollment.
- learningItemAttributionType; string; Indicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST.
- learningItemAuthorPersonId; integer; Person identifier for the learning item author.
- learningItemAuthoredOnDate; string; Date when the learning item was authored.
- learningItemBusinessDriver; string; Business driver, such as Compliance or Self Development.
- learningItemCatalogProfileName; string; Name of the learning catalog profile.
- learningItemCommunityOverridesVisibility; string; Indicates whether the learning item visibility can be overridden by a community. Valid values are Y or N.
- learningItemCompletionCertificateEnabled; string; Indicates if a completion certificate is enabled or not. Valid values are Y or N.
- learningItemCompletionCertificateFileName; string; File name of the completion certificate.
- learningItemCompletionCertificateLink; string; Preview link for the completion certificate.
- learningItemCompletionCertificateTitle; string; Title of the completion certificate.
- learningItemContentDeleteDate; string; Date when the learning item content was deleted
- learningItemContentDeleteReasonCode; string; Reason for deleting the learning item content.
- learningItemCoordPersonId; integer; Person identifier for the learning item coordinator.
- learningItemCoordPersonNumber; string; Person number of the learning item coordinator.
- learningItemCreationDate; string; Date when the learning item was created.
- learningItemDeletionReasonCode; string; Reason for deleting the learning item.
- learningItemDraftExists; string; Indicates if a draft version of this learning item exists. Valid values are Y or N.
- learningItemEnrollCondition; string; Indicates when a learner can enroll in this learning item.
- learningItemEnrollmentEndDate; string; Date when the enrollment period ends.
- learningItemEnrollmentStartDate; string; Date when the enrollment period begins.
- learningItemEnrollmentVisibilityMSS; string; Indicates whether the enrollment details are visible to the line manager. Valid values are ORA_SHOW and ORA_HIDE. The default value is ORA_SHOW.
- learningItemFeatureEndDate; string; Date when the learning item stops being featured.
- learningItemFeatureStartDate; string; Date when the learning item starts being featured.
- learningItemId; integer; Learning item Id of the course.
- learningItemInactiveDate; string; Date when the learning item will be set to inactive.
- learningItemInactiveReasonCode; string; Reason for moving the learning item to inactive status.
- learningItemInstructorPersonId; integer; Person identifier for the learning item instructor.
- learningItemLastModifiedDate; string; Date when the learning item was last modified.
- learningItemLearningLevel; string; Learning level, such as Beginner, Moderate, or Advanced.
- learningItemLearningPathOverridesVisibility; string; Indicates whether the learning item visibility can be overridden by a learning path. Valid values are Y or N.
- learningItemMarkCompleteMSS; string; Indicates if the manager can mark an enrollment as complete. Possible values are Y or N. Default value is Y.
- learningItemNotificationPattern; string; Notification pattern, such as Default Notification Pattern.
- learningItemNumber; string; User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI.
- learningItemPreviewURL; string; URL used by the administrator to preview the learning item.
- learningItemProvider; string; Name of the provider used to create the learning item, such as Skillsoft or LinkedIn.
- learningItemProviderMeaning; string; Description for the learningItemProvider attribute value.
- learningItemProviderType; string; Type of the provider used. Valid values are File,URL,Connector or Questionnaire.
- learningItemProviderTypeMeaning; string; Description for the learningItemProviderType attribute value.
- learningItemPublishEndDate; string; Date when the learning item stops being visible in the learning catalog.
- learningItemPublishStartDate; string; Date when the learning item starts being visible in the learning catalog.
- learningItemPublishedExists; string; Indicate if a published version of this learning item exists. Valid values are Y or N.
- learningItemPublisher; string; Learning item publisher, such as Learning Department.
- learningItemPublisherName; string; Name of the publisher of the learning item.
- learningItemRatingAverage; integer; Rating average for the learning item.
- learningItemRatingCount; integer; Rating count for the learning item.
- learningItemReactivationReasonCode; string; Reason for moving the inactive learning item to active status.
- learningItemSelfEnrollRetakeRule; string; Determines whether the learners can retake the learning again or not. Valid values are ORA_NEVER,ORA_PASS or ORA_PASS_FAIL. The default value is ORA_PASS.
- learningItemSelfEnrollmentURL; string; URL for the learner to self enroll
- learningItemSourcePublishedDate; string; Date when content for the self-paced learning was published. This value is imported for self-paced learning managed by external content providers.
- learningItemStatus; string; Status of the learning item.
- learningItemStatusComment; string; Status change comment for the learning item.
- learningItemTitle; string; Title of the learning item.
- learningItemTrailerLink; string; URL to open the learning item trailer directly from the browser.
- learningItemType; string; Type of learning item, such as video, online course, document, assessment, or observation checklist.
- learningItemWithdrawalRuleESS; string; Determines how the learner's assignment withdrawals are processed.
- learningItemWithdrawalRuleMSS; string; Determines how the manager's assignment withdrawals are processed.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Effective-Of: string
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context: string
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: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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.
Root Schema : learningSelfPacedItems
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-item-response
Type:
Show Source
object-
assets: array
Learning Content Assets
Title:
Learning Content AssetsThe assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status. -
changeRequests: array
Change Requests
Title:
Change RequestsThe changeRequests resource contains the change details, such as identifier, comment, processing status, and status. -
content: array
Learning Content
Title:
Learning ContentThe content resource captures the details of content associated with the course, such as storage provider number, delivery provider number, display mode, delivery URL, and supported languages. -
dataSecurityPrivilege: string
Title:
Data Security PrivilegeData security privilege, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV. -
learningItemActiveDate: string
(date-time)
Date when the learning item was activated
-
learningItemApprovalRuleESS: string
Maximum Length:
30Determines how approvals are configured for self-service enrollment. -
learningItemApprovalRuleMSS: string
Maximum Length:
30Determines how approvals are configured for manager enrollment. -
learningItemAttributionType: string
Maximum Length:
30Default Value:ORA_PERSONIndicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST. -
learningItemAuthorDisplayName: string
Title:
AuthorMaximum Length:2000Display name the learning item author. -
learningItemAuthoredOnDate: string
(date-time)
Date when the learning item was authored.
-
learningItemAuthorEmailAddress: string
Read Only:
trueMaximum Length:255Primary email address of the person. -
learningItemAuthorPersonId: integer
(int64)
Person identifier for the learning item author.
-
learningItemAuthorPersonNumber: string
Maximum Length:
30Person number of the learning item author. -
learningItemAuthorPhoneNumber: string
Read Only:
trueMaximum Length:255Phone number for the learning item author. -
learningItemAuthorType: string
Maximum Length:
32Learning author type. Valid values are ORA_PERSON or ORA_ADHOC. -
learningItemBusinessDriver: string
Title:
Business DriverMaximum Length:32Business driver, such as Compliance or Self Development. -
learningItemCatalogProfileId: integer
Unique identifier for the learning catalog profile.
-
learningItemCatalogProfileName: string
Read Only:
trueMaximum Length:255Name of the learning catalog profile. -
learningItemCatalogProfileNumber: string
Number for the learning catalog profile.
-
learningItemCommunityOverridesVisibility: string
Maximum Length:
1Indicates whether the learning item visibility can be overridden by a community. Valid values are Y or N. -
learningItemCompletionCertificateEnabled: string
Maximum Length:
1Indicates if a completion certificate is enabled or not. Valid values are Y or N. -
learningItemCompletionCertificateFileName: string
File name of the completion certificate.
-
learningItemCompletionCertificateLink: string
Maximum Length:
255Preview link for the completion certificate. -
learningItemCompletionCertificateTitle: string
Maximum Length:
255Title of the completion certificate. -
learningItemContentDeleteDate: string
(date-time)
Date when the learning item content was deleted
-
learningItemContentDeleteReasonCode: string
Maximum Length:
30Reason for deleting the learning item content. -
learningItemCoordDisplayName: string
Title:
learningItemCoordDisplayNameRead Only:trueMaximum Length:255Display name of the learning item coordinator. -
learningItemCoordEmailAddress: string
Read Only:
trueMaximum Length:255Email address for the learning item coordinator. -
learningItemCoordPersonId: integer
(int64)
Person identifier for the learning item coordinator.
-
learningItemCoordPersonNumber: string
Maximum Length:
32Person number of the learning item coordinator. -
learningItemCoordPhoneNumber: string
Read Only:
trueMaximum Length:255Phone number for the learning item coordinator. -
learningItemCoverArtHighRenditionLink: string
Read Only:
trueMaximum Length:255Link to the high rendition version of the learning cover art image. -
learningItemCoverArtLowRenditionLink: string
Read Only:
trueMaximum Length:255Link to the low rendition version of the learning cover art image. -
learningItemCoverArtMedRenditionLink: string
Read Only:
trueMaximum Length:255Link to the medium rendition version of the learning cover art image. -
learningItemCreatedByDisplayName: string
Read Only:
trueMaximum Length:255Display name of the person who created the learning item. -
learningItemCreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the learning item was created. -
learningItemDeletionReasonCode: string
Maximum Length:
30Reason for deleting the learning item. -
learningItemDeliveryURL: string
Read Only:
trueMaximum Length:255URL used to deliver the learning item to the learner. -
learningItemDescription: string
Title:
DescriptionMaximum Length:4000Plain text version of the long description of the learning item. -
learningItemDetailsDeepLink: string
Title:
Learning Item Deep LinkMaximum Length:255URL to open the learning item page directly from the browser. -
learningItemDetailsEmbedLink: string
Title:
Learning Item Embed LinkRead Only:trueMaximum Length:255URL that can be used to embed the learning item page in other pages. It opens the isolated learning item page without the global tool bar on the top. -
learningItemDFF: array
learningItemDFF
-
learningItemDraftExists: string
Read Only:
trueMaximum Length:255Indicates if a draft version of this learning item exists. Valid values are Y or N. -
learningItemEnrollCondition: string
Maximum Length:
30Indicates when a learner can enroll in this learning item. -
learningItemEnrollmentEndDate: string
(date-time)
Date when the enrollment period ends.
-
learningItemEnrollmentStartDate: string
(date-time)
Date when the enrollment period begins.
-
learningItemEnrollmentVisibilityMSS: string
Maximum Length:
30Indicates whether the enrollment details are visible to the line manager. Valid values are ORA_SHOW and ORA_HIDE. The default value is ORA_SHOW. -
learningItemExpectedEffortInSeconds: number
Title:
Expected EffortExpected effort needed by the learner to complete the learning item. -
learningItemFeatureEndDate: string
(date-time)
Title:
Featured End DateDate when the learning item stops being featured. -
learningItemFeatureStartDate: string
(date-time)
Title:
Featured Start DateDate when the learning item starts being featured. -
learningItemId: integer
(int64)
Title:
Learning Item IDLearning item Id of the course. -
learningItemInactiveDate: string
(date-time)
Date when the learning item will be set to inactive.
-
learningItemInactiveReasonCode: string
Maximum Length:
30Reason for moving the learning item to inactive status. -
learningItemInstructorDisplayName: string
Title:
InstructorMaximum Length:2000Display name for the learning item instructor. -
learningItemInstructorEmailAddress: string
Read Only:
trueMaximum Length:255Primary Email address of the instructor for the learning item. -
learningItemInstructorPersonId: integer
(int64)
Person identifier for the learning item instructor.
-
learningItemInstructorPersonNumber: string
Maximum Length:
30Person number of the learning item instructor. -
learningItemInstructorPhoneNumber: string
Read Only:
trueMaximum Length:255Phone number of the instructor. -
learningItemInstructorType: string
Maximum Length:
32Type of instructor. Valid values are ORA_PERSON or ORA_ADHOC -
learningItemKeepCompletionsOnDelete: string
Indicates whether learning completions should persist when the learning item is deleted. Valid values are Y and N.
-
learningItemLastModifiedByDisplayName: string
Read Only:
trueMaximum Length:255Display name of the person who last modified the learning item. -
learningItemLastModifiedDate: string
(date-time)
Title:
Last ModifiedRead Only:trueDate when the learning item was last modified. -
learningItemLearningLevel: string
Title:
Learning LevelMaximum Length:32Learning level, such as Beginner, Moderate, or Advanced. -
learningItemLearningPathOverridesVisibility: string
Maximum Length:
1Indicates whether the learning item visibility can be overridden by a learning path. Valid values are Y or N. -
learningItemLongDescription: string
Title:
Long DescriptionLong, rich text description of the learning item. -
learningItemMarkCompleteMSS: string
Maximum Length:
30Indicates if the manager can mark an enrollment as complete. Possible values are Y or N. Default value is Y. -
learningItemNotificationPattern: string
Title:
Notification PatternMaximum Length:32Notification pattern, such as Default Notification Pattern. -
learningItemNumber: string
Title:
Learning Item NumberMaximum Length:2000User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI. -
learningItemPreviewURL: string
Read Only:
trueMaximum Length:255URL used by the administrator to preview the learning item. -
learningItemProvider: string
Maximum Length:
32Name of the provider used to create the learning item, such as Skillsoft or LinkedIn. -
learningItemProviderMeaning: string
Read Only:
trueMaximum Length:255Description for the learningItemProvider attribute value. -
learningItemProviderType: string
Maximum Length:
32Type of the provider used. Valid values are File,URL,Connector or Questionnaire. -
learningItemProviderTypeMeaning: string
Read Only:
trueMaximum Length:255Description for the learningItemProviderType attribute value. -
learningItemPublishedExists: string
Read Only:
trueMaximum Length:255Indicate if a published version of this learning item exists. Valid values are Y or N. -
learningItemPublishEndDate: string
(date-time)
Title:
Publish End DateDate when the learning item stops being visible in the learning catalog. -
learningItemPublisher: string
Title:
PublisherMaximum Length:32Learning item publisher, such as Learning Department. -
learningItemPublisherName: string
Maximum Length:
2000Name of the publisher of the learning item. -
learningItemPublishStartDate: string
(date-time)
Title:
Publish Start DateDate when the learning item starts being visible in the learning catalog. -
learningItemRatingAverage: integer
Read Only:
trueRating average for the learning item. -
learningItemRatingCount: integer
Read Only:
trueRating count for the learning item. -
learningItemReactivationReasonCode: string
Maximum Length:
30Reason for moving the inactive learning item to active status. -
learningItemSelfEnrollmentURL: string
Read Only:
trueURL for the learner to self enroll -
learningItemSelfEnrollRetakeRule: string
Maximum Length:
30Determines whether the learners can retake the learning again or not. Valid values are ORA_NEVER,ORA_PASS or ORA_PASS_FAIL. The default value is ORA_PASS. -
learningItemShortDescription: string
Title:
Learning Item Short DescriptionMaximum Length:255Short description of the learning item. -
learningItemSourcePublishedDate: string
(date-time)
Date when content for the self-paced learning was published. This value is imported for self-paced learning managed by external content providers.
-
learningItemStatus: string
Title:
Learning Item StatusMaximum Length:30Default Value:ORA_DRAFTStatus of the learning item. -
learningItemStatusComment: string
Maximum Length:
4000Status change comment for the learning item. -
learningItemSupportedLanguages: string
Title:
Instruction LanguagesMaximum Length:255List of languages the learning item supports. -
learningItemTalentProfileSummary: array
Learning Item Talent Profile Summary
Title:
Learning Item Talent Profile SummaryThe summary learning information from the talent profile, such as if a course is configured with prerequisites or outcomes. -
learningItemTitle: string
Title:
TitleMaximum Length:255Title of the learning item. -
learningItemTrailerLink: string
Read Only:
trueMaximum Length:255URL to open the learning item trailer directly from the browser. -
learningItemType: string
Title:
Assigned Learning Item SubtypeMaximum Length:30Type of learning item, such as video, online course, document, assessment, or observation checklist. -
learningItemTypeMeaning: string
Title:
Learning Item Type DescriptionRead Only:trueMaximum Length:255Meaning for the learningItemType attribute. -
learningItemVisibility: string
Maximum Length:
32Visibility of the learning item, such as Public or Secret. -
learningItemWithdrawalRuleESS: string
Maximum Length:
30Determines how the learner's assignment withdrawals are processed. -
learningItemWithdrawalRuleMSS: string
Maximum Length:
30Determines how the manager's assignment withdrawals are processed. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
messages: array
Messages
Title:
MessagesThe messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description. -
metrics: array
Learning Catalog Item Metrics
Title:
Learning Catalog Item MetricsThe metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count. - relatedMaterials: array Related Materials
-
userActionHints: array
User Action Hints
Title:
User Action HintsThe userActionHints resource provides hints for possible actions on its parent resource. -
whereUsed: array
Where Used
Title:
Where UsedThe whereUsed resource provides details about the uses of a learning item in topics and learning communities.
Nested Schema : Learning Content Assets
Type:
arrayTitle:
Learning Content AssetsThe assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.
Show Source
Nested Schema : Change Requests
Type:
arrayTitle:
Change RequestsThe changeRequests resource contains the change details, such as identifier, comment, processing status, and status.
Show Source
Nested Schema : Learning Content
Type:
arrayTitle:
Learning ContentThe content resource captures the details of content associated with the course, such as storage provider number, delivery provider number, display mode, delivery URL, and supported languages.
Show Source
Nested Schema : Learning Item Talent Profile Summary
Type:
arrayTitle:
Learning Item Talent Profile SummaryThe summary learning information from the talent profile, such as if a course is configured with prerequisites or outcomes.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Messages
Type:
arrayTitle:
MessagesThe messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.
Show Source
Nested Schema : Learning Catalog Item Metrics
Type:
arrayTitle:
Learning Catalog Item MetricsThe metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.
Show Source
Nested Schema : User Action Hints
Type:
arrayTitle:
User Action HintsThe userActionHints resource provides hints for possible actions on its parent resource.
Show Source
Nested Schema : Where Used
Type:
arrayTitle:
Where UsedThe whereUsed resource provides details about the uses of a learning item in topics and learning communities.
Show Source
Nested Schema : learningSelfPacedItems-assets-item-response
Type:
Show Source
object-
addedOnDate: string
(date-time)
Read Only:
trueDate when the learning item was added to the learning catalog. -
assetBinaries: array
Content Binaries
Title:
Content BinariesThe assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
Unique identifier for the learning item asset, such as cover art or a trailer.
-
assetNumber: string
Maximum Length:
30User-friendly number identifying the learning item asset, such as cover art or a trailer. -
highRenditionLink: string
Read Only:
trueMaximum Length:255Link to the high rendition version of the learning cover art image. -
learningItemId: integer
(int64)
Title:
Learning Item IDThe learning item identifier of the asset. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
lowRenditionLink: string
Read Only:
trueMaximum Length:255Link to the low rendition version of the learning cover art image. -
medRenditionLink: string
Read Only:
trueMaximum Length:255Link to the medium rendition version of the learning cover art image. -
primary: string
Indicates whether the asset is currently being used as the cover art or the trailer. Valid values are Y and N. The default value is Y.
-
relationshipType: string
Maximum Length:
30Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC. -
sourceURL: string
Maximum Length:
2000Web link to the image source location. -
status: string
Maximum Length:
30Status of the learning item asset. -
type: string
Maximum Length:
30Indicates the type of learning asset, such as cover art or a trailer.
Nested Schema : Content Binaries
Type:
arrayTitle:
Content BinariesThe assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-assets-assetBinaries-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided by the Attachment UI components to support the upload of files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255Attachment creator. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser name of the attachment creator. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the attachment was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAttachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255Description for the attachment. -
DmDocumentId: string
Maximum Length:
255Surrogate identifier for the document attached. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path where the attachment will be created. -
DmVersionNumber: string
Maximum Length:
255Version number for the attachment. -
DownloadInfo: string
Title:
DownloadInfoRead Only:trueJSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageExpiration date for the attachment. This is a read-only attribute. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File ContentsActual content of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name for the attachment file. -
FileUrl: string
Title:
File UrlFile URL for the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when attachment record was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Name of the person who most recently updated the attachment record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueUser name of the person who most recently updated the attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be done after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File SizeSize of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File NameName of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded TextText uploaded in the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI for the attachment. This is a read-only attribute. -
Url: string
Title:
UrlMaximum Length:4000URL for a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : learningSelfPacedItems-changeRequests-item-response
Type:
Show Source
object-
changeRequestId: integer
(int64)
Unique identifier for the change request.
-
comment: string
Maximum Length:
4000Optional comment that explains the need for this change. -
createdByDisplayName: string
Read Only:
trueDisplay name of the change requester. -
createdById: integer
(int64)
Identifier for the change requester.
-
creationDate: string
(date-time)
Read Only:
trueDate when the change request was created. -
deleteExistingContent: string
Maximum Length:
30Indicates whether the change request should delete existing content. Possible values are Yes, No, or Not Applicable. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
notificationMessage: string
Maximum Length:
4000Notification message text sent to the learners. -
notifyLearners: string
Maximum Length:
30Indicates whether to notify learners about this change request. Possible values are Yes, No, or Not Applicable. -
processingStatus: string
Maximum Length:
30Processing status for the change request. -
processingStatusMeaning: string
Read Only:
trueMaximum Length:255Description for the change request processing status. -
reasonCode: string
Maximum Length:
30Reason for reconciliation. -
reasonCodeMeaning: string
Read Only:
trueMaximum Length:255Description for the reasonCode attribute value. -
reconcileByDisplayName: string
Read Only:
trueMaximum Length:255Display name of the person reconciling the change request. -
reconcileById: integer
(int64)
Identifier for the person reconciling the change request.
-
reconcileEndDate: string
(date-time)
Date and time when the change request reconciliation should end.
-
reconcileLastRunProcessDate: string
(date-time)
Date and time when the change request was most recently reconciled.
-
reconcileLastRunProcessId: integer
(int64)
Unique identifier associated with the most recent reconciliation run for the change request.
-
reconcileStartDate: string
(date-time)
Date and time to start the change request reconciliation.
-
restartInProgressAttempts: string
Maximum Length:
30Indicates whether in-progress attempts need to be restarted. Possible values are Yes, No, or Not Applicable. -
status: string
Maximum Length:
30Status for the change request.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-content-item-response
Type:
Show Source
object-
addedOnDate: string
(date-time)
Read Only:
trueDate when the learning item was added to the learning catalog. -
allowBrowseCondition: string
Title:
Learner Content BrowsingMaximum Length:30When a learner is allowed to browse the content. -
allowFwdScrub: string
Title:
Allow learners to fast forwardMaximum Length:32Indicates if forward scrubbing is enabled.Valid values are Y or N. -
assets: array
Learning Content Assets
Title:
Learning Content AssetsThe assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status. -
autoCommit: string
Title:
Auto CommitMaximum Length:1Indicates if automatic commit is enabled.Valid values are Y or N. -
autoLaunchOnPageOpen: string
Maximum Length:
1Indicates whether the content needs to be automatically launched when the enrollment page opens. -
chapterLevel: integer
Title:
Chapter LevelRead Only:trueChapter level of the learning content.Currently this is always set to 1. -
chapterPosition: string
Title:
Chapter PositionRead Only:trueMaximum Length:255Chapter position of the learning content.Currently this is always set to 1. -
completeBeforeExitAU: string
Maximum Length:
30Indicates how completions are recorded by the AICC player. ORA_YES means completions are recorded without waiting for the ExitAU AICC call. ORA_NO means the player waits for the ExitAU call. -
completionRule: string
Title:
Completion RuleMaximum Length:32Completion rule that determines how the content handles completions. It also determines if manager or learner confirmation is required. -
completionThreshold: number
Title:
Percentage Watched for CompletionWhat percentage of the content a learner needs to complete to be marked successful. -
contentBinaries: array
Content Binaries
Title:
Content BinariesThe assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
contentId: integer
(int64)
Title:
Content IDThe unique identifier for the content. -
coverArtHighRenditionLink: string
Read Only:
trueMaximum Length:255Link to the high rendition version of the learning cover art image. -
coverArtLowRenditionLink: string
Read Only:
trueMaximum Length:255Link to the low rendition version of the learning cover art image. -
coverArtMedRenditionLink: string
Read Only:
trueMaximum Length:255Link to the medium rendition version of the learning cover art image. -
deliveryProviderNumber: string
Maximum Length:
255User-friendly number identifying the learning content delivery provider. -
deliveryURL: string
Read Only:
trueMaximum Length:255URL used to deliver the learning item to the learner. -
displayMode: string
Maximum Length:
32How the content is displayed to the learner, such as embedded. -
durationInSeconds: integer
Content duration in seconds.
-
effortCalculationRule: string
Maximum Length:
30Determines how the learner's effort is calculated. -
enableScoring: string
Title:
Enable ScoringMaximum Length:1Indicates if scoring is enabled or not. Valid values are Y or N. -
learnerAttemptReview: string
Maximum Length:
120What attempts a learner can review. -
learnerAttemptReviewCondition: string
Title:
When Learner Can Review AttemptsMaximum Length:32When a learner can review attempts. -
learnerAttemptRule: string
Title:
Recorded AttemptsMaximum Length:120The rule used to configure attempts. -
learnerMaximumAttempts: integer
(int64)
Title:
Number of Recorded AttemptsThe maximum attempts allowed on for the learning content. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
obsAllowBrowseCondition: string
Maximum Length:
32Indicates when learners can browse the content of an observation checklist. -
obsAllowReassignment: string
Maximum Length:
1Indicates whether the observer can reassign the observation checklist task. Valid values are Y or N. Default value is N. -
obsAttemptReviewByLearner: string
Title:
Learner Review of Observer Recorded AttemptsMaximum Length:120Determines what observer attempts a learner can review. Valid values are ORA_WLF_ARAR_DONT_ENABLE, ORA_WLF_ARAR_LAST_ATTEMPT, ORA_WLF_ARAR_ANY_PAST_ATTEMPT or ORA_WLF_ARAR_LAST_PASS_ATEMPT. If the content is an observation checklist and null for other content types, the default value is ORA_WLF_ARAR_LAST_ATTEMPT. -
obsAttemptReviewByLearnerMeaning: string
Read Only:
trueMaximum Length:255Description for the obsAttemptReviewByLearner attribute value. -
obsAttemptReviewConditionByLearner: string
Title:
When Learner Can Review Observer AttemptsMaximum Length:32Indicates when learners can review the observer's recorded attempts. -
obsAttemptRule: string
Title:
Observer Recorded AttemptsMaximum Length:120Determines how many attempts can be recorded. Valid values are ORA_WLF_ARA_LTD_NUM,ORA_WLF_ARA_SNGL,ORA_WLF_ARA_SNGL_RESUME or ORA_WLF_ARA_UNLTD. The default value is ORA_WLF_ARA_SNGL. -
obsLearnerSelfAssessEnable: string
Maximum Length:
1Indicates whether the observation checklist supports self-assessment. Valid values are Y or N. Default value is N. -
obsManagerLevel: string
Maximum Length:
30Manager level, such as first level manager, second level manger, or third level manager. -
obsManagerType: string
Maximum Length:
255Manager type, such as Line Manager, Project Manager, or Regional Manager. -
obsManagerTypeMeaning: string
Read Only:
trueMaximum Length:255Description for the obsManagerType attribute value. -
obsMaximumAttempts: integer
(int64)
Title:
Number of Observer Recorded AttemptsMaximum number of attempts allowed for an observer. -
obsPersonDetails: array
Observer Person Details
Title:
Observer Person DetailsThe obsPersonDetails resource lists the named observers and provides their details, such as person display name and person number. -
obsRepType: string
Maximum Length:
255Type of representative, such as Benefits representative, Learning representative, or Payroll representative. -
obsRepTypeMeaning: string
Read Only:
trueMaximum Length:255Description for the obsRepType attribute value. -
obsShowFeedbackToLearner: string
Maximum Length:
1Indicates whether observer's feedback should be visible to the learner. Valid values are Y or N. -
obsType: string
Maximum Length:
30Type of observer, such as Individuals, Management Hierarchy, or Representative. -
passingScore: number
Title:
Mastery ScoreScore required to successfully complete the provided learning content. -
questionnaireCode: string
Maximum Length:
255Unique code for the questionnaire. -
questionnaireName: string
Read Only:
trueMaximum Length:255Name of the questionnaire. -
questionnaireVersion: integer
(int64)
Version of the questionnaire.
-
retryAttemptsBeforeDelay: integer
(int64)
Number of times a learner can attempt the learning item without a delay.
-
retryDelayInHours: number
Time of delay, in hours, after which the learner can try the content again.
-
scoredContentCompletionRule: string
Maximum Length:
30Indicates how to set completions when the learner closes the player window. -
scoreViewRule: string
Title:
Score VisibilityMaximum Length:32Determines who can view the score, such as learners, learning administrators, or both. -
showFeedbackToLearner: string
Title:
Let learners view response feedbackMaximum Length:1Indicates if feedback should be visible to the learner. Valid values are Y or N -
sourceId: string
Maximum Length:
2000Unique identifier for the course in the external application, if available. -
sourceLaunchURL: string
Maximum Length:
2000Source URL for the learning item -
sourceMaximumScore: number
Maximum score that learners can achieve for the provided learning content.
-
sourceMinimumScore: number
Minimum score that learners can achieve for the provided learning content.
-
sourcePassingScore: number
Score required to successfully complete the provided learning content. This is a read only attribute.
-
sourceSupportedLanguages: string
Read Only:
trueMaximum Length:255List of languages the learning content supports. -
status: string
Title:
StatusMaximum Length:30Status of the learning content, such as active or processing. -
storageProviderNumber: string
Maximum Length:
255User-friendly number identifying the learning content storage provider. -
timeLimitInSeconds: integer
Title:
Time LimitTime limit in seconds that the learner is provided to complete the content. -
title: string
Title:
TitleRead Only:trueMaximum Length:4000Title of the learning content. -
type: string
Maximum Length:
30Type of learning content, such as Video or SCORM
Nested Schema : Learning Content Assets
Type:
arrayTitle:
Learning Content AssetsThe assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.
Show Source
Nested Schema : Content Binaries
Type:
arrayTitle:
Content BinariesThe assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Observer Person Details
Type:
arrayTitle:
Observer Person DetailsThe obsPersonDetails resource lists the named observers and provides their details, such as person display name and person number.
Show Source
Nested Schema : learningSelfPacedItems-content-assets-item-response
Type:
Show Source
object-
addedOnDate: string
(date-time)
Read Only:
trueDate when the learning item was added to the learning catalog. -
assetBinaries: array
Content Binaries
Title:
Content BinariesThe assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
Unique identifier for the learning item asset, such as cover art or a trailer.
-
assetNumber: string
Maximum Length:
30User-friendly number identifying the learning item asset, such as cover art or a trailer. -
highRenditionLink: string
Read Only:
trueMaximum Length:255Link to the high rendition version of the learning cover art image. -
learningItemId: integer
(int64)
Title:
Learning Item IDThe learning item identifier of the asset. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
lowRenditionLink: string
Read Only:
trueMaximum Length:255Link to the low rendition version of the learning cover art image. -
medRenditionLink: string
Read Only:
trueMaximum Length:255Link to the medium rendition version of the learning cover art image. -
primary: string
Indicates whether the asset is currently being used as the cover art or the trailer. Valid values are Y and N. The default value is Y.
-
relationshipType: string
Maximum Length:
30Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC. -
sourceURL: string
Maximum Length:
2000Web link to the image source location. -
status: string
Maximum Length:
30Status of the learning item asset. -
type: string
Maximum Length:
30Indicates the type of learning asset, such as cover art or a trailer.
Nested Schema : Content Binaries
Type:
arrayTitle:
Content BinariesThe assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-content-assets-assetBinaries-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided by the Attachment UI components to support the upload of files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255Attachment creator. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser name of the attachment creator. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the attachment was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAttachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255Description for the attachment. -
DmDocumentId: string
Maximum Length:
255Surrogate identifier for the document attached. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path where the attachment will be created. -
DmVersionNumber: string
Maximum Length:
255Version number for the attachment. -
DownloadInfo: string
Title:
DownloadInfoRead Only:trueJSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageExpiration date for the attachment. This is a read-only attribute. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File ContentsActual content of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name for the attachment file. -
FileUrl: string
Title:
File UrlFile URL for the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when attachment record was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Name of the person who most recently updated the attachment record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueUser name of the person who most recently updated the attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be done after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File SizeSize of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File NameName of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded TextText uploaded in the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI for the attachment. This is a read-only attribute. -
Url: string
Title:
UrlMaximum Length:4000URL for a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-content-contentBinaries-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided by the Attachment UI components to support the upload of files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255Attachment creator. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser name of the attachment creator. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the attachment was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAttachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255Description for the attachment. -
DmDocumentId: string
Maximum Length:
255Surrogate identifier for the document attached. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path where the attachment will be created. -
DmVersionNumber: string
Maximum Length:
255Version number for the attachment. -
DownloadInfo: string
Title:
DownloadInfoRead Only:trueJSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageExpiration date for the attachment. This is a read-only attribute. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File ContentsActual content of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name for the attachment file. -
FileUrl: string
Title:
File UrlFile URL for the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when attachment record was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Name of the person who most recently updated the attachment record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueUser name of the person who most recently updated the attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be done after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File SizeSize of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File NameName of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded TextText uploaded in the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI for the attachment. This is a read-only attribute. -
Url: string
Title:
UrlMaximum Length:4000URL for a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-content-obsPersonDetails-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
personDisplayName: string
Read Only:
trueMaximum Length:255Display name for the person. -
personNumber: string
Maximum Length:
255The numeric identifier for the person.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-learningItemDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
LearningItemId: integer
(int64)
-
LearningItemType: string
Maximum Length:
32 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-learningItemTalentProfileSummary-item-response
Type:
Show Source
object-
hasOutcomes: string
Title:
Has OutcomesRead Only:trueMaximum Length:1Indicates whether the course has outcomes. Valid values are Y or N -
hasPrerequisites: string
Title:
Has PrerequisitesRead Only:trueMaximum Length:1Indicates whether the course has prerequisites. Valid values are Y or N -
hasSkillsAndQualifications: string
Read Only:
trueMaximum Length:1Indicates whether the course has skills or qualifications. Valid values are Y or N -
learningItemId: string
Read Only:
trueMaximum Length:32Learning item Id of the course. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-messages-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
message: string
Read Only:
trueUser-friendly string describing the message. -
messageCode: string
Read Only:
trueCode to indicate the type of message. -
messageSecondaryText: string
Read Only:
trueSecondary text for the message. -
messageSeverity: string
Read Only:
trueIndicates the severity of the message like: INFO, WARN, or FATAL. -
visibility: string
Read Only:
trueMaximum Length:8Determines the message visibility. Valid values are Show or Hide.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-metrics-item-response
Type:
Show Source
object-
averageActualEffortPERAttempt: number
Read Only:
trueAverage of the actual effort per attempt. -
averageAttemptsPERCompletion: number
Read Only:
trueAverage of the actual effort per completion. -
averageRating: number
Read Only:
trueRating average for the learning catalog item. -
completedCount: number
Read Only:
trueCount of completed enrollments. -
conversationCount: number
Read Only:
trueCount of conversations on the learning item. -
currentCountEnrollments: number
Read Only:
trueCount of enrollments that are either in active or preactive status. -
currentCountLearners: number
Read Only:
trueCount of unique learners whose enrollments are in either in active or preactive status. -
failCountEnrollments: number
Read Only:
trueCount of enrollments with failed status. -
failCountLearners: number
Read Only:
trueCount of learners who failed the learning item. -
futureCountEnrollments: number
Read Only:
trueCount of future-dated enrollments. -
futureCountLearners: number
Read Only:
trueCount of learners with future-dated enrollments. -
inProgressCount: number
Read Only:
trueCount of in-progress enrollments. -
learningItemId: integer
Read Only:
trueUnique identifier for the learning item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
notInterestedCount: number
Read Only:
trueCount of learners who aren't interested in the learning item. -
passCountEnrollments: number
Read Only:
trueCount of enrollments with passed status. -
passCountLearners: number
Read Only:
trueCount of learners who passed the learning item. -
totalRatings: number
Read Only:
trueRating count for the learning catalog item. -
totalViewCount: number
Read Only:
trueCount of views on the learning item. -
viewCountInLastThirtyDays: number
Read Only:
trueCount of views on the learning item in the past 30 days. -
whereUsedCount: number
Read Only:
trueCount of learning items, such as communities, journeys, user groups, and specializations that use the learning item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-userActionHints-item-response
Type:
Show Source
object-
canManageLearningItem: string
Read Only:
trueMaximum Length:255Hint to identify whether a user can manage the learning item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-whereUsed-item-response
Type:
Show Source
object-
learningItemCoverArtLink: string
Read Only:
trueMaximum Length:255URL to the cover art. -
learningItemCreatorEmailAddress: string
Read Only:
trueEmail address for the learning item creator. -
learningItemDescription: string
Read Only:
trueMaximum Length:4000Description of the learning item. -
learningItemId: integer
(int64)
Read Only:
trueUnique identifier for the learning item, it's the internal primary key. -
learningItemNumber: string
Maximum Length:
30Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface. -
learningItemStatus: string
Read Only:
trueMaximum Length:30Status for the learning item. -
learningItemSubType: string
Read Only:
trueMaximum Length:30Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list. -
learningItemSubTypeMeaning: string
Read Only:
trueMaximum Length:255Description of the learning item subtype. -
learningItemTitle: string
Read Only:
trueMaximum Length:250Title of the learning item. -
learningItemType: string
Read Only:
trueMaximum Length:32Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the AssignedLearningItemTypeLOV list. -
learningItemTypeMeaning: string
Read Only:
trueMaximum Length:255Description of the learning item type. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- publish
-
Publishes the learning item and makes it available for use.