Jump to

• Request
• Response

Create a content item

post

/hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}/child/content

Request

Path Parameters

• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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(required): 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.
• deliveryProviderNumber: string
  Maximum Length: 255

  User-friendly number identifying the learning content delivery provider.
• 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(required): 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.
• type: string
  Maximum Length: 30

  Type of learning content, such as Video or SCORM

{
    "required":[
        "autoCommit",
        "status"
    ],
    "type":"object",
    "properties":{
        "sourceId":{
            "maxLength":2000,
            "type":"string",
            "description":"Unique identifier for the course in the external application, if available.",
            "nullable":true
        },
        "obsAllowReassignment":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the observer can reassign the observation checklist task. Valid values are Y or N. Default value is N.",
            "nullable":true
        },
        "obsMaximumAttempts":{
            "title":"Number of Observer Recorded Attempts",
            "type":"integer",
            "description":"Maximum number of attempts allowed for an observer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "durationInSeconds":{
            "type":"integer",
            "description":"Content duration in seconds.",
            "nullable":true
        },
        "obsManagerType":{
            "maxLength":255,
            "type":"string",
            "description":"Manager type, such as Line Manager, Project Manager, or Regional Manager.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "contentId":{
            "title":"Content ID",
            "type":"integer",
            "description":"The unique identifier for the content.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "obsAttemptRule":{
            "title":"Observer Recorded Attempts",
            "maxLength":120,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "passingScore":{
            "title":"Mastery Score",
            "type":"number",
            "description":"Score required to successfully complete the provided learning content.",
            "nullable":true
        },
        "obsRepType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of representative, such as Benefits representative, Learning representative, or Payroll representative.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "type":{
            "maxLength":30,
            "type":"string",
            "description":"Type of learning content, such as Video or SCORM",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "completionThreshold":{
            "title":"Percentage Watched for Completion",
            "type":"number",
            "description":"What percentage of the content a learner needs to complete to be marked successful.",
            "nullable":true
        },
        "obsType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of observer, such as Individuals, Management Hierarchy, or Representative.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "obsAttemptReviewByLearner":{
            "title":"When Learner Can Review Observer Attempts",
            "maxLength":120,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "allowFwdScrub":{
            "title":"Allow learners to fast forward",
            "maxLength":32,
            "type":"string",
            "description":"Indicates if forward scrubbing is enabled.Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "assets":{
            "title":"Learning Content Assets",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-content-assets-item-post-request"
            }
        },
        "allowBrowseCondition":{
            "title":"Learner Content Browsing",
            "maxLength":30,
            "type":"string",
            "description":"When a learner is allowed to browse the content.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "deliveryProviderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"User-friendly number identifying the learning content delivery provider.",
            "nullable":true
        },
        "questionnaireCode":{
            "maxLength":255,
            "type":"string",
            "description":"Unique code for the questionnaire.",
            "nullable":true
        },
        "autoCommit":{
            "title":"Auto Commit",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if automatic commit is enabled.Valid values are Y or N.",
            "nullable":false
        },
        "learnerAttemptReviewCondition":{
            "title":"When Learner Can Review Attempts",
            "maxLength":32,
            "type":"string",
            "description":"When a learner can review attempts.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "contentBinaries":{
            "title":"Content Binaries",
            "type":"array",
            "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-content-contentBinaries-item-post-request"
            }
        },
        "learnerMaximumAttempts":{
            "title":"Number of Recorded Attempts",
            "type":"integer",
            "description":"The maximum attempts allowed on for the learning content.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "sourceMinimumScore":{
            "type":"number",
            "description":"Minimum score that learners can achieve for the provided learning content.",
            "nullable":true
        },
        "obsAllowBrowseCondition":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates when learners can browse the content of an observation checklist.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "sourcePassingScore":{
            "type":"number",
            "description":"Score required to successfully complete the provided learning content. This is a read only attribute.",
            "nullable":true
        },
        "questionnaireVersion":{
            "type":"integer",
            "description":"Version of the questionnaire.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "timeLimitInSeconds":{
            "title":"Time Limit",
            "type":"integer",
            "description":"Time limit in seconds that the learner is provided to complete the content.",
            "nullable":true
        },
        "enableScoring":{
            "title":"Enable Scoring",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if scoring is enabled or not. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "learnerAttemptReview":{
            "maxLength":120,
            "type":"string",
            "description":"What attempts a learner can review.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "displayMode":{
            "maxLength":32,
            "type":"string",
            "description":"How the content is displayed to the learner, such as embedded.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "completionRule":{
            "title":"Completion Rule",
            "maxLength":32,
            "type":"string",
            "description":"The completion rule that determines how completions are handled by the content. It also determines if manager or learner confirmation is required.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "obsPersonDetails":{
            "title":"Observer Person Details",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-content-obsPersonDetails-item-post-request"
            }
        },
        "scoredContentCompletionRule":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates how to set completions when the learner closes the player window.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "sourceLaunchURL":{
            "maxLength":2000,
            "type":"string",
            "description":"Source URL for the digital learning item",
            "nullable":true
        },
        "sourceMaximumScore":{
            "type":"number",
            "description":"Maximum score that learners can achieve for the provided learning content.",
            "nullable":true
        },
        "obsManagerLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Manager level, such as first level manager, second level manger, or third level manager.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "obsAttemptReviewConditionByLearner":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates when learners can review the observer's recorded attempts.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "storageProviderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"User-friendly number identifying the learning content storage provider.",
            "nullable":true
        },
        "obsShowFeedbackToLearner":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether observer's feedback should be visible to the learner. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "learnerAttemptRule":{
            "title":"Recorded Attempts",
            "maxLength":120,
            "type":"string",
            "description":"The rule used to configure attempts.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "showFeedbackToLearner":{
            "title":"Let learners view response feedback",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if feedback should be visible to the learner. Valid values are Y or N",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "scoreViewRule":{
            "title":"Score Visibility",
            "maxLength":32,
            "type":"string",
            "description":"Determines who can view the score, such as learners, learning administrators, or both.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the learning content, such as active or processing.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "obsLearnerSelfAssessEnable":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the observation checklist supports self-assessment. Valid values are Y or N. Default value is N.",
            "nullable":true
        }
    }
}

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

• Array of: object schema

{
    "title":"Learning Content Assets",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-content-assets-item-post-request"
    }
}

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

• Array of: object schema

{
    "title":"Content Binaries",
    "type":"array",
    "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-content-contentBinaries-item-post-request"
    }
}

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

• Array of: object schema

{
    "title":"Observer Person Details",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-content-obsPersonDetails-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• learningItemId: integer (int64)
  Title: Learning Item ID

  The learning item identifier of the asset.
• 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(required): string
  Maximum Length: 30

  Indicates the type of learning asset, such as cover art or a trailer.

{
    "required":[
        "type"
    ],
    "type":"object",
    "properties":{
        "sourceURL":{
            "maxLength":2000,
            "type":"string",
            "description":"Web link to the image source location.",
            "nullable":true
        },
        "assetNumber":{
            "maxLength":30,
            "type":"string",
            "description":"User-friendly number identifying the learning item asset, such as cover art or a trailer.",
            "nullable":true
        },
        "relationshipType":{
            "maxLength":30,
            "type":"string",
            "description":"Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "assetId":{
            "type":"integer",
            "description":"The unique identifier for the learning item asset, such as cover art or a trailer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "assetBinaries":{
            "title":"Content Binaries",
            "type":"array",
            "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-content-assets-assetBinaries-item-post-request"
            }
        },
        "type":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of learning asset, such as cover art or a trailer.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "learningItemId":{
            "title":"Learning Item ID",
            "type":"integer",
            "description":"The learning item identifier of the asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the learning item asset.",
            "nullable":true
        },
        "primary":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        }
    }
}

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

• Array of: object digitalLearning-content-assets-assetBinaries-item-post-request

{
    "title":"Content Binaries",
    "type":"array",
    "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-content-assets-assetBinaries-item-post-request"
    }
}

Nested Schema : digitalLearning-content-assets-assetBinaries-item-post-request

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• 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.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier of the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• 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.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier of the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• personNumber: string
  Maximum Length: 255

  The numeric identifier for the person.

{
    "type":"object",
    "properties":{
        "personNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The numeric identifier for the person.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : digitalLearning-content-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "sourceId":{
            "maxLength":2000,
            "type":"string",
            "description":"Unique identifier for the course in the external application, if available.",
            "nullable":true,
            "x-queryable":true
        },
        "obsAllowReassignment":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the observer can reassign the observation checklist task. Valid values are Y or N. Default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "obsMaximumAttempts":{
            "title":"Number of Observer Recorded Attempts",
            "type":"integer",
            "description":"Maximum number of attempts allowed for an observer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "obsManagerType":{
            "maxLength":255,
            "type":"string",
            "description":"Manager type, such as Line Manager, Project Manager, or Regional Manager.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "passingScore":{
            "title":"Mastery Score",
            "type":"number",
            "description":"Score required to successfully complete the provided learning content.",
            "nullable":true,
            "x-queryable":true
        },
        "coverArtHighRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"A link to the high rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "type":{
            "maxLength":30,
            "type":"string",
            "description":"Type of learning content, such as Video or SCORM",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "allowFwdScrub":{
            "title":"Allow learners to fast forward",
            "maxLength":32,
            "type":"string",
            "description":"Indicates if forward scrubbing is enabled.Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "chapterLevel":{
            "title":"Chapter Level",
            "type":"integer",
            "description":"Chapter level of the learning content.Currently this is always set to 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "assets":{
            "title":"Learning Content Assets",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-content-assets-item-response"
            }
        },
        "allowBrowseCondition":{
            "title":"Learner Content Browsing",
            "maxLength":30,
            "type":"string",
            "description":"When a learner is allowed to browse the content.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "deliveryProviderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"User-friendly number identifying the learning content delivery provider.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "addedOnDate":{
            "type":"string",
            "description":"Date when the learning item was added to the learning catalog.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "questionnaireCode":{
            "maxLength":255,
            "type":"string",
            "description":"Unique code for the questionnaire.",
            "nullable":true,
            "x-queryable":true
        },
        "learnerAttemptReviewCondition":{
            "title":"When Learner Can Review Attempts",
            "maxLength":32,
            "type":"string",
            "description":"When a learner can review attempts.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "contentBinaries":{
            "title":"Content Binaries",
            "type":"array",
            "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-content-contentBinaries-item-response"
            }
        },
        "obsAllowBrowseCondition":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates when learners can browse the content of an observation checklist.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "sourcePassingScore":{
            "type":"number",
            "description":"Score required to successfully complete the provided learning content. This is a read only attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "enableScoring":{
            "title":"Enable Scoring",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if scoring is enabled or not. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "displayMode":{
            "maxLength":32,
            "type":"string",
            "description":"How the content is displayed to the learner, such as embedded.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "completionRule":{
            "title":"Completion Rule",
            "maxLength":32,
            "type":"string",
            "description":"The completion rule that determines how completions are handled by the content. It also determines if manager or learner confirmation is required.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "obsPersonDetails":{
            "title":"Observer Person Details",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-content-obsPersonDetails-item-response"
            }
        },
        "sourceLaunchURL":{
            "maxLength":2000,
            "type":"string",
            "description":"Source URL for the digital learning item",
            "nullable":true,
            "x-queryable":true
        },
        "obsManagerLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Manager level, such as first level manager, second level manger, or third level manager.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "obsShowFeedbackToLearner":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether observer's feedback should be visible to the learner. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learnerAttemptRule":{
            "title":"Recorded Attempts",
            "maxLength":120,
            "type":"string",
            "description":"The rule used to configure attempts.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "showFeedbackToLearner":{
            "title":"Let learners view response feedback",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if feedback should be visible to the learner. Valid values are Y or N",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the learning content, such as active or processing.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "obsLearnerSelfAssessEnable":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the observation checklist supports self-assessment. Valid values are Y or N. Default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "chapterPosition":{
            "title":"Chapter Position",
            "maxLength":255,
            "type":"string",
            "description":"Chapter position of the learning content.Currently this is always set to 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "durationInSeconds":{
            "type":"integer",
            "description":"Content duration in seconds.",
            "nullable":true,
            "x-queryable":true
        },
        "contentId":{
            "title":"Content ID",
            "type":"integer",
            "description":"The unique identifier for the content.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "obsAttemptRule":{
            "title":"Observer Recorded Attempts",
            "maxLength":120,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "obsRepType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of representative, such as Benefits representative, Learning representative, or Payroll representative.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "title":{
            "title":"Title",
            "maxLength":4000,
            "type":"string",
            "description":"Title of the learning content.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "completionThreshold":{
            "title":"Percentage Watched for Completion",
            "type":"number",
            "description":"What percentage of the content a learner needs to complete to be marked successful.",
            "nullable":true,
            "x-queryable":true
        },
        "obsType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of observer, such as Individuals, Management Hierarchy, or Representative.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "obsAttemptReviewByLearner":{
            "title":"When Learner Can Review Observer Attempts",
            "maxLength":120,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "sourceSupportedLanguages":{
            "maxLength":255,
            "type":"string",
            "description":"List of languages the learning content supports.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "deliveryURL":{
            "maxLength":255,
            "type":"string",
            "description":"URL used to deliver the learning item to the learner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "autoCommit":{
            "title":"Auto Commit",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if automatic commit is enabled.Valid values are Y or N.",
            "nullable":false,
            "x-queryable":true
        },
        "learnerMaximumAttempts":{
            "title":"Number of Recorded Attempts",
            "type":"integer",
            "description":"The maximum attempts allowed on for the learning content.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "sourceMinimumScore":{
            "type":"number",
            "description":"Minimum score that learners can achieve for the provided learning content.",
            "nullable":true,
            "x-queryable":true
        },
        "questionnaireVersion":{
            "type":"integer",
            "description":"Version of the questionnaire.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "timeLimitInSeconds":{
            "title":"Time Limit",
            "type":"integer",
            "description":"Time limit in seconds that the learner is provided to complete the content.",
            "nullable":true,
            "x-queryable":true
        },
        "coverArtLowRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"A link to the low rendition version of learning the cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learnerAttemptReview":{
            "maxLength":120,
            "type":"string",
            "description":"What attempts a learner can review.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "scoredContentCompletionRule":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates how to set completions when the learner closes the player window.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "coverArtMedRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"A link to the medium rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "sourceMaximumScore":{
            "type":"number",
            "description":"Maximum score that learners can achieve for the provided learning content.",
            "nullable":true,
            "x-queryable":true
        },
        "obsAttemptReviewConditionByLearner":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates when learners can review the observer's recorded attempts.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "storageProviderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"User-friendly number identifying the learning content storage provider.",
            "nullable":true,
            "x-queryable":true
        },
        "obsAttemptReviewByLearnerMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the obsAttemptReviewByLearner attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "questionnaireName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "scoreViewRule":{
            "title":"Score Visibility",
            "maxLength":32,
            "type":"string",
            "description":"Determines who can view the score, such as learners, learning administrators, or both.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object digitalLearning-content-assets-item-response

{
    "title":"Learning Content Assets",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-content-assets-item-response"
    }
}

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

• Array of: object digitalLearning-content-contentBinaries-item-response

{
    "title":"Content Binaries",
    "type":"array",
    "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-content-contentBinaries-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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

• Array of: object digitalLearning-content-obsPersonDetails-item-response

{
    "title":"Observer Person Details",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-content-obsPersonDetails-item-response"
    }
}

Nested Schema : digitalLearning-content-assets-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "relationshipType":{
            "maxLength":30,
            "type":"string",
            "description":"Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "assetBinaries":{
            "title":"Content Binaries",
            "type":"array",
            "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-content-assets-assetBinaries-item-response"
            }
        },
        "type":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of learning asset, such as cover art or a trailer.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "sourceURL":{
            "maxLength":2000,
            "type":"string",
            "description":"Web link to the image source location.",
            "nullable":true,
            "x-queryable":true
        },
        "highRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"A link to the high rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assetNumber":{
            "maxLength":30,
            "type":"string",
            "description":"User-friendly number identifying the learning item asset, such as cover art or a trailer.",
            "nullable":true,
            "x-queryable":true
        },
        "medRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"A link to the medium rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assetId":{
            "type":"integer",
            "description":"The unique identifier for the learning item asset, such as cover art or a trailer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "lowRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"A link to the low rendition version of learning the cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "addedOnDate":{
            "type":"string",
            "description":"Date when the learning item was added to the learning catalog.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemId":{
            "title":"Learning Item ID",
            "type":"integer",
            "description":"The learning item identifier of the asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the learning item asset.",
            "nullable":true,
            "x-queryable":true
        },
        "primary":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        }
    }
}

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

• Array of: object digitalLearning-content-assets-assetBinaries-item-response

{
    "title":"Content Binaries",
    "type":"array",
    "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-content-assets-assetBinaries-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : digitalLearning-content-assets-assetBinaries-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64 encoded image file displayed in .png format when the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier of the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedByUserName":{
            "type":"string",
            "description":"User name of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who last updated the attachment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"User name of the person who uploaded the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"User name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when attachment record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : digitalLearning-content-contentBinaries-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64 encoded image file displayed in .png format when the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier of the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedByUserName":{
            "type":"string",
            "description":"User name of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who last updated the attachment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"User name of the person who uploaded the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"User name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when attachment record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : digitalLearning-content-obsPersonDetails-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "personNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The numeric identifier for the person.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "personDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name for the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

AllowBrowseConditionLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

AllowFwdScrubLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

CompletionAffirmationLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ContentTypeLOVVO

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

DisplayModeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

EnableScoringLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

LearnerAttemptReviewConditionLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

LearnerAttemptReviewLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

LearnerAttemptRuleLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

LearningContentStatusLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ObsAllowBrowseConditionLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ObsAttemptReviewByLearnerLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ObsAttemptReviewConditionByLearnerLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ObsAttemptRuleLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ObsManagerLevelLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ObsRepTypeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ObsShowFeedbackToLearnerLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ObsTypeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ScoreViewRuleLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ScoredContentEvidenceRuleLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ShowFeedbackToLearnerLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

assets

Operation: /hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}/child/content/{contentUniqID}/child/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.

contentBinaries

Operation: /hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}/child/content/{contentUniqID}/child/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.

obsPersonDetails

Operation: /hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}/child/content/{contentUniqID}/child/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.

Back to Top