Update a content item
patch
/hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}/child/content/{contentUniqID}
Request
Path Parameters
-
contentUniqID(required): string
This is the hash key of the attributes which make up the composite key for the (content) resource and used to uniquely identify an instance of (content). The client should not generate the hash key value. Instead, the client should query on the (content) collection resource in order to navigate to a specific instance of (content) to get the hash key.
-
digitalLearningUniqID(required): string
This is the hash key of the attributes which make up the composite key for the (digitalLearning) resource and used to uniquely identify an instance of (digitalLearning). The client should not generate the hash key value. Instead, the client should query on the (digitalLearning) collection resource in order to navigate to a specific instance of (digitalLearning) to get the hash key.
Header Parameters
-
Effective-Of:
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:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
allowBrowseCondition: string
Title:
Learner Content Browsing
Maximum Length:30
When a learner is allowed to browse the content. -
allowFwdScrub: string
Title:
Allow learners to fast forward
Maximum Length:32
Indicates if forward scrubbing is enabled.Valid values are Y or N. -
assets: array
Learning Content Assets
Title:
Learning Content Assets
The 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 Commit
Maximum Length:1
Indicates if automatic commit is enabled.Valid values are Y or N. -
completionRule: string
Title:
Completion Rule
Maximum Length:32
The completion rule that determines how completions are handled by the content. It also determines if manager or learner confirmation is required. -
completionThreshold: number
Title:
Percentage Watched for Completion
What percentage of the content a learner needs to complete to be marked successful. -
contentBinaries: array
Content Binaries
Title:
Content Binaries
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
contentId: integer
(int64)
Title:
Content ID
The unique identifier for the content. -
displayMode: string
Maximum Length:
32
How the content is displayed to the learner, such as embedded. -
durationInSeconds: integer
Content duration in seconds.
-
enableScoring: string
Title:
Enable Scoring
Maximum Length:1
Indicates if scoring is enabled or not. Valid values are Y or N. -
learnerAttemptReview: string
Maximum Length:
120
What attempts a learner can review. -
learnerAttemptReviewCondition: string
Title:
When Learner Can Review Attempts
Maximum Length:32
When a learner can review attempts. -
learnerAttemptRule: string
Title:
Recorded Attempts
Maximum Length:120
The rule used to configure attempts. -
learnerMaximumAttempts: integer
(int64)
Title:
Number of Recorded Attempts
The maximum attempts allowed on for the learning content. -
obsAllowBrowseCondition: string
Maximum Length:
32
Indicates when learners can browse the content of an observation checklist. -
obsAllowReassignment: string
Maximum Length:
1
Indicates whether the observer can reassign the observation checklist task. Valid values are Y or N. Default value is N. -
obsAttemptReviewByLearner: string
Title:
When Learner Can Review Observer Attempts
Maximum Length:120
Determines 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. -
obsAttemptReviewConditionByLearner: string
Maximum Length:
32
Indicates when learners can review the observer's recorded attempts. -
obsAttemptRule: string
Title:
Observer Recorded Attempts
Maximum Length:120
Determines 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:
1
Indicates whether the observation checklist supports self-assessment. Valid values are Y or N. Default value is N. -
obsManagerLevel: string
Maximum Length:
30
Manager level, such as first level manager, second level manger, or third level manager. -
obsManagerType: string
Maximum Length:
255
Manager type, such as Line Manager, Project Manager, or Regional Manager. -
obsMaximumAttempts: integer
(int64)
Title:
Number of Observer Recorded Attempts
Maximum number of attempts allowed for an observer. -
obsPersonDetails: array
Observer Person Details
Title:
Observer Person Details
The obsPersonDetails resource is a child of the digitalLearning resource. This resource enumerates the list of named observers and provides their details, such as person display name and person number. -
obsRepType: string
Maximum Length:
255
Type of representative, such as Benefits representative, Learning representative, or Payroll representative. -
obsShowFeedbackToLearner: string
Maximum Length:
1
Indicates whether observer's feedback should be visible to the learner. Valid values are Y or N. -
obsType: string
Maximum Length:
30
Type of observer, such as Individuals, Management Hierarchy, or Representative. -
passingScore: number
Title:
Mastery Score
Score required to successfully complete the provided learning content. -
questionnaireCode: string
Maximum Length:
255
Unique code for the questionnaire. -
questionnaireVersion: integer
(int64)
Version of the questionnaire.
-
scoredContentCompletionRule: string
Maximum Length:
30
Indicates how to set completions when the learner closes the player window. -
scoreViewRule: string
Title:
Score Visibility
Maximum Length:32
Determines who can view the score, such as learners, learning administrators, or both. -
showFeedbackToLearner: string
Title:
Let learners view response feedback
Maximum Length:1
Indicates if feedback should be visible to the learner. Valid values are Y or N -
sourceId: string
Maximum Length:
2000
Unique identifier for the course in the external application, if available. -
sourceLaunchURL: string
Maximum Length:
2000
Source URL for the digital 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.
-
status: string
Title:
Status
Maximum Length:30
Status of the learning content, such as active or processing. -
timeLimitInSeconds: integer
Title:
Time Limit
Time limit in seconds that the learner is provided to complete the content. -
type: string
Maximum Length:
30
Type of learning content, such as Video or SCORM
Nested Schema : Learning Content Assets
Type:
array
Title:
Learning Content Assets
The 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:
array
Title:
Content Binaries
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : Observer Person Details
Type:
array
Title:
Observer Person Details
The obsPersonDetails resource is a child of the digitalLearning resource. This resource enumerates the list of named observers and provides their details, such as person display name and person number.
Show Source
Nested Schema : digitalLearning-content-assets-item-patch-request
Type:
Show Source
object
-
assetBinaries: array
Content Binaries
Title:
Content Binaries
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
The unique identifier for the learning item asset, such as cover art or a trailer.
-
assetNumber: string
Maximum Length:
30
User-friendly number identifying the learning item asset, such as cover art or a trailer. -
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:
30
Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC. -
sourceURL: string
Maximum Length:
2000
Web link to the image source location. -
status: string
Maximum Length:
30
Status of the learning item asset. -
type: string
Maximum Length:
30
Indicates the type of learning asset, such as cover art or a trailer.
Nested Schema : Content Binaries
Type:
array
Title:
Content Binaries
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : digitalLearning-content-assets-assetBinaries-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Expiration date of the attachment. This is a read-only attribute.
-
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
File URL of the attachment.
-
PostProcessingAction: string
Title:
PostProcessingAction
-
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Content type of the uploaded file. This is a read-only attribute.
-
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment.
Nested Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Expiration date of the attachment. This is a read-only attribute.
-
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
File URL of the attachment.
-
PostProcessingAction: string
Title:
PostProcessingAction
-
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Content type of the uploaded file. This is a read-only attribute.
-
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment.
Nested Schema : schema
Type:
Show Source
object
-
personNumber: string
Maximum Length:
255
The numeric identifier for the person.
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.
Root Schema : digitalLearning-content-item-response
Type:
Show Source
object
-
addedOnDate: string
(date-time)
Read Only:
true
Date when the learning item was added to the learning catalog. -
allowBrowseCondition: string
Title:
Learner Content Browsing
Maximum Length:30
When a learner is allowed to browse the content. -
allowFwdScrub: string
Title:
Allow learners to fast forward
Maximum Length:32
Indicates if forward scrubbing is enabled.Valid values are Y or N. -
assets: array
Learning Content Assets
Title:
Learning Content Assets
The 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 Commit
Maximum Length:1
Indicates if automatic commit is enabled.Valid values are Y or N. -
chapterLevel: integer
Title:
Chapter Level
Read Only:true
Chapter level of the learning content.Currently this is always set to 1. -
chapterPosition: string
Title:
Chapter Position
Read Only:true
Maximum Length:255
Chapter position of the learning content.Currently this is always set to 1. -
completionRule: string
Title:
Completion Rule
Maximum Length:32
The completion rule that determines how completions are handled by the content. It also determines if manager or learner confirmation is required. -
completionThreshold: number
Title:
Percentage Watched for Completion
What percentage of the content a learner needs to complete to be marked successful. -
contentBinaries: array
Content Binaries
Title:
Content Binaries
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
contentId: integer
(int64)
Title:
Content ID
The unique identifier for the content. -
coverArtHighRenditionLink: string
Read Only:
true
Maximum Length:255
A link to the high rendition version of the learning cover art image. -
coverArtLowRenditionLink: string
Read Only:
true
Maximum Length:255
A link to the low rendition version of learning the cover art image. -
coverArtMedRenditionLink: string
Read Only:
true
Maximum Length:255
A link to the medium rendition version of the learning cover art image. -
deliveryProviderNumber: string
Maximum Length:
255
User-friendly number identifying the learning content delivery provider. -
deliveryURL: string
Read Only:
true
Maximum Length:255
URL used to deliver the learning item to the learner. -
displayMode: string
Maximum Length:
32
How the content is displayed to the learner, such as embedded. -
durationInSeconds: integer
Content duration in seconds.
-
enableScoring: string
Title:
Enable Scoring
Maximum Length:1
Indicates if scoring is enabled or not. Valid values are Y or N. -
learnerAttemptReview: string
Maximum Length:
120
What attempts a learner can review. -
learnerAttemptReviewCondition: string
Title:
When Learner Can Review Attempts
Maximum Length:32
When a learner can review attempts. -
learnerAttemptRule: string
Title:
Recorded Attempts
Maximum Length:120
The rule used to configure attempts. -
learnerMaximumAttempts: integer
(int64)
Title:
Number of Recorded Attempts
The maximum attempts allowed on for the learning content. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
obsAllowBrowseCondition: string
Maximum Length:
32
Indicates when learners can browse the content of an observation checklist. -
obsAllowReassignment: string
Maximum Length:
1
Indicates whether the observer can reassign the observation checklist task. Valid values are Y or N. Default value is N. -
obsAttemptReviewByLearner: string
Title:
When Learner Can Review Observer Attempts
Maximum Length:120
Determines 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:
true
Maximum Length:255
Description for the obsAttemptReviewByLearner attribute value. -
obsAttemptReviewConditionByLearner: string
Maximum Length:
32
Indicates when learners can review the observer's recorded attempts. -
obsAttemptRule: string
Title:
Observer Recorded Attempts
Maximum Length:120
Determines 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:
1
Indicates whether the observation checklist supports self-assessment. Valid values are Y or N. Default value is N. -
obsManagerLevel: string
Maximum Length:
30
Manager level, such as first level manager, second level manger, or third level manager. -
obsManagerType: string
Maximum Length:
255
Manager type, such as Line Manager, Project Manager, or Regional Manager. -
obsMaximumAttempts: integer
(int64)
Title:
Number of Observer Recorded Attempts
Maximum number of attempts allowed for an observer. -
obsPersonDetails: array
Observer Person Details
Title:
Observer Person Details
The obsPersonDetails resource is a child of the digitalLearning resource. This resource enumerates the list of named observers and provides their details, such as person display name and person number. -
obsRepType: string
Maximum Length:
255
Type of representative, such as Benefits representative, Learning representative, or Payroll representative. -
obsShowFeedbackToLearner: string
Maximum Length:
1
Indicates whether observer's feedback should be visible to the learner. Valid values are Y or N. -
obsType: string
Maximum Length:
30
Type of observer, such as Individuals, Management Hierarchy, or Representative. -
passingScore: number
Title:
Mastery Score
Score required to successfully complete the provided learning content. -
questionnaireCode: string
Maximum Length:
255
Unique code for the questionnaire. -
questionnaireName: string
Read Only:
true
Maximum Length:255
Name of the questionnaire. -
questionnaireVersion: integer
(int64)
Version of the questionnaire.
-
scoredContentCompletionRule: string
Maximum Length:
30
Indicates how to set completions when the learner closes the player window. -
scoreViewRule: string
Title:
Score Visibility
Maximum Length:32
Determines who can view the score, such as learners, learning administrators, or both. -
showFeedbackToLearner: string
Title:
Let learners view response feedback
Maximum Length:1
Indicates if feedback should be visible to the learner. Valid values are Y or N -
sourceId: string
Maximum Length:
2000
Unique identifier for the course in the external application, if available. -
sourceLaunchURL: string
Maximum Length:
2000
Source URL for the digital 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:
true
Maximum Length:255
List of languages the learning content supports. -
status: string
Title:
Status
Maximum Length:30
Status of the learning content, such as active or processing. -
storageProviderNumber: string
Maximum Length:
255
User-friendly number identifying the learning content storage provider. -
timeLimitInSeconds: integer
Title:
Time Limit
Time limit in seconds that the learner is provided to complete the content. -
title: string
Title:
Title
Read Only:true
Maximum Length:4000
Title of the learning content. -
type: string
Maximum Length:
30
Type of learning content, such as Video or SCORM
Nested Schema : Learning Content Assets
Type:
array
Title:
Learning Content Assets
The 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:
array
Title:
Content Binaries
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Observer Person Details
Type:
array
Title:
Observer Person Details
The obsPersonDetails resource is a child of the digitalLearning resource. This resource enumerates the list of named observers and provides their details, such as person display name and person number.
Show Source
Nested Schema : digitalLearning-content-assets-item-response
Type:
Show Source
object
-
addedOnDate: string
(date-time)
Read Only:
true
Date when the learning item was added to the learning catalog. -
assetBinaries: array
Content Binaries
Title:
Content Binaries
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
The unique identifier for the learning item asset, such as cover art or a trailer.
-
assetNumber: string
Maximum Length:
30
User-friendly number identifying the learning item asset, such as cover art or a trailer. -
highRenditionLink: string
Read Only:
true
Maximum Length:255
A link to the high rendition version of the learning cover art image. -
learningItemId: integer
(int64)
Title:
Learning Item ID
The learning item identifier of the asset. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lowRenditionLink: string
Read Only:
true
Maximum Length:255
A link to the low rendition version of learning the cover art image. -
medRenditionLink: string
Read Only:
true
Maximum Length:255
A link 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:
30
Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC. -
sourceURL: string
Maximum Length:
2000
Web link to the image source location. -
status: string
Maximum Length:
30
Status of the learning item asset. -
type: string
Maximum Length:
30
Indicates the type of learning asset, such as cover art or a trailer.
Nested Schema : Content Binaries
Type:
array
Title:
Content Binaries
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : digitalLearning-content-assets-assetBinaries-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Attribute provided by the Attachment UI components to support the upload of files.
-
AttachedDocumentId: integer
(int64)
Unique identifier of the attached document.
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Read Only:
true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Read Only:
true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Read Only:
true
Date when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Read Only:
true
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Expiration date of the attachment. This is a read-only attribute.
-
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
File URL of the attachment.
-
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when attachment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the attachment record. -
LastUpdatedByUserName: string
Read Only:
true
User name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
-
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Content type of the uploaded file. This is a read-only attribute.
-
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment. -
UserName: string
Read Only:
true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : digitalLearning-content-contentBinaries-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Attribute provided by the Attachment UI components to support the upload of files.
-
AttachedDocumentId: integer
(int64)
Unique identifier of the attached document.
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Read Only:
true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Read Only:
true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Read Only:
true
Date when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Read Only:
true
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Expiration date of the attachment. This is a read-only attribute.
-
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
File URL of the attachment.
-
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when attachment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the attachment record. -
LastUpdatedByUserName: string
Read Only:
true
User name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
-
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Content type of the uploaded file. This is a read-only attribute.
-
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment. -
UserName: string
Read Only:
true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : digitalLearning-content-obsPersonDetails-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
personDisplayName: string
Read Only:
true
Maximum Length:255
Display name for the person. -
personNumber: string
Maximum Length:
255
The numeric identifier for the person.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AllowBrowseConditionLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_BROWSE_CONTENT
The following properties are defined on the LOV link relation:- Source Attribute: allowBrowseCondition; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AllowFwdScrubLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ALLOW_FWD_SCRUB
The following properties are defined on the LOV link relation:- Source Attribute: allowFwdScrub; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CompletionAffirmationLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LC_COMPLETION_RULE
The following properties are defined on the LOV link relation:- Source Attribute: completionRule; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ContentTypeLOVVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LC_CONTENT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: type; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- DisplayModeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_CONTENT_DISPLAY_MODE
The following properties are defined on the LOV link relation:- Source Attribute: displayMode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EnableScoringLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: enableScoring; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearnerAttemptReviewConditionLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ATTEMPT_REVIEW_COND
The following properties are defined on the LOV link relation:- Source Attribute: learnerAttemptReviewCondition; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearnerAttemptReviewLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSES_REC_ATTEMPT_REV
The following properties are defined on the LOV link relation:- Source Attribute: learnerAttemptReview; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearnerAttemptRuleLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSES_REC_ATTEMPTS
The following properties are defined on the LOV link relation:- Source Attribute: learnerAttemptRule; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningContentStatusLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LC_CONTENT_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: status; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ObsAllowBrowseConditionLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_BROWSE_CONTENT
The following properties are defined on the LOV link relation:- Source Attribute: obsAllowBrowseCondition; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ObsAttemptReviewByLearnerLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSES_REC_ATTEMPT_REV
The following properties are defined on the LOV link relation:- Source Attribute: obsAttemptReviewByLearner; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ObsAttemptReviewConditionByLearnerLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ATTEMPT_REVIEW_COND
The following properties are defined on the LOV link relation:- Source Attribute: obsAttemptReviewConditionByLearner; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ObsAttemptRuleLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSES_REC_ATTEMPTS
The following properties are defined on the LOV link relation:- Source Attribute: obsAttemptRule; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ObsManagerLevelLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_MNGR_HRCHY_LEVEL
The following properties are defined on the LOV link relation:- Source Attribute: obsManagerLevel; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ObsRepTypeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DPER_RESPONSIBILITY_TYPES
The following properties are defined on the LOV link relation:- Source Attribute: obsRepType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ObsShowFeedbackToLearnerLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: obsShowFeedbackToLearner; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ObsTypeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LI_OBSERVER_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: obsType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ScoreViewRuleLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LC_SCORE_VIEW_RULE
The following properties are defined on the LOV link relation:- Source Attribute: scoreViewRule; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ScoredContentEvidenceRuleLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_SCORED_CONT_COMPLETION
The following properties are defined on the LOV link relation:- Source Attribute: scoredContentCompletionRule; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ShowFeedbackToLearnerLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: showFeedbackToLearner; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- assets
-
Parameters:
- contentUniqID:
$request.path.contentUniqID
- digitalLearningUniqID:
$request.path.digitalLearningUniqID
The 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. - contentUniqID:
- contentBinaries
-
Parameters:
- contentUniqID:
$request.path.contentUniqID
- digitalLearningUniqID:
$request.path.digitalLearningUniqID
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description. - contentUniqID:
- obsPersonDetails
-
Parameters:
- contentUniqID:
$request.path.contentUniqID
- digitalLearningUniqID:
$request.path.digitalLearningUniqID
The obsPersonDetails resource is a child of the digitalLearning resource. This resource enumerates the list of named observers and provides their details, such as person display name and person number. - contentUniqID: