Jump to

• Request
• Response

Get all digital learning items

get

/hcmRestApi/resources/11.13.18.05/digitalLearning

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds all digital learning items that match the specified primary key criteria.
    Finder Variables
    • learningItemId; integer; Learning Item ID for the digital learning item.
  • findByLearningItemId Finds all digital learning items that match the specified primary key criteria.
    Finder Variables
    • SysEffectiveDate; object;
    • learningItemId; integer; Learning Item ID for the digital learning item.
  • findByLearningItemNumber Finds all the digital learning items that match the specified learning item number.
    Finder Variables
    • SysEffectiveDate; object;
    • learningItemNumber; string; User-friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • contentBinaryTrackerId; string; Tracker ID for the content binary.
  • learningItemAttributionType; string; Indicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST.
  • learningItemAuthoredOnDate; string; Date when the learning item was authored.
  • learningItemBusinessDriver; string; The business driver, such as Compliance or Self Development.
  • learningItemCoordPersonNumber; string; Person number of the learning item coordinator.
  • learningItemCreationDate; string; Date when the learning item was created.
  • learningItemDraftExists; string; Indicates if a draft version of this learning item exists. Valid values are Y or N.
  • learningItemFeatureEndDate; string; Date when the learning item stops being featured.
  • learningItemFeatureStartDate; string; Date when the learning item starts being featured.
  • learningItemId; integer; Learning item Id of the course.
  • learningItemInactiveDate; string; Date when the learning item will be set to inactive.
  • learningItemLastModifiedDate; string; Date when the learning item was last modified.
  • learningItemLearningLevel; string; The learning level, such as Beginner, Moderate, or Advanced.
  • learningItemNotificationPattern; string; The notification pattern, such as Default Notification Pattern.
  • learningItemNumber; string; User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI.
  • learningItemPreviewURL; string; URL used by the administrator to preview the learning item.
  • learningItemProvider; string; The name of the provider used to create the learning item, such as Skillsoft or LinkedIn.
  • learningItemProviderMeaning; string; Description for the learningItemProvider attribute value.
  • learningItemProviderType; string; The type of the provider used. Valid values are File,URL,Connector or Questionnaire.
  • learningItemProviderTypeMeaning; string; Description for the learningItemProviderType attribute value.
  • learningItemPublishEndDate; string; Date when the learning item stops being visible in the learning catalog.
  • learningItemPublishStartDate; string; Date when the learning item starts being visible in the learning catalog.
  • learningItemPublishedExists; string; Indicate if a published version of this learning item exists. Valid values are Y or N.
  • learningItemPublisher; string; The learning item publisher, such as Learning Department.
  • learningItemPublisherName; string; Name of the publisher of the learning item.
  • learningItemRatingAverage; integer; Rating average for the learning item.
  • learningItemRatingCount; integer; Rating count for the learning item.
  • learningItemSelfEnrollmentURL; string; URL for the learner to self enroll
  • learningItemStatus; string; Status of the learning item.
  • learningItemTitle; string; Title of the learning item.
  • learningItemTrailerLink; string; URL to open the learning item trailer directly from the browser.
  • learningItemType; string; Type of learning item, such as video, online course, document, assessment, or observation checklist.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Effective-Of:
  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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : digitalLearning

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object digitalLearning-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-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-item-response

Type: object

Show Source

• 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.
• content: array Learning Content
  Title: Learning Content

  A child of the learning courses resource, this resource captures the details of content associated with the course, such as storage provider number, delivery provider number, display mode, delivery URL, and supported languages.
• contentBinaryTrackerId: string
  Read Only: true

  Maximum Length: 255

  Tracker ID for the content binary.
• coverArtAssetBinaryTrackerId: string
  Read Only: true

  Maximum Length: 255

  Tracker ID for the cover art asset binary.
• dataSecurityPrivilege: string
  Title: Data Security Privilege

  Data security privilege, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV.
• learningItemAttributionType: string
  Maximum Length: 30

  Default Value: ORA_PERSON

  Indicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST.
• learningItemAuthorDisplayName: string
  Title: Author

  Maximum Length: 2000

  Display name the learning item author.
• learningItemAuthoredOnDate: string (date-time)
  Date when the learning item was authored.
• learningItemAuthorPersonNumber: string
  Maximum Length: 30

  Person number of the learning item author.
• learningItemAuthorType: string
  Maximum Length: 32

  The learning author type. Valid values are ORA_PERSON or ORA_ADHOC .
• learningItemBusinessDriver: string
  Title: Business Driver

  Maximum Length: 32

  The business driver, such as Compliance or Self Development.
• learningItemCoordDisplayName: string
  Title: learningItemCoordDisplayName

  Read Only: true

  Maximum Length: 255

  Display name of the learning item coordinator.
• learningItemCoordPersonNumber: string
  Maximum Length: 32

  Person number of the learning item coordinator.
• learningItemCoverArtHighRenditionLink: string
  Read Only: true

  Maximum Length: 255

  A link to the high rendition version of the learning cover art image.
• learningItemCoverArtLowRenditionLink: string
  Read Only: true

  Maximum Length: 255

  A link to the low rendition version of learning the cover art image.
• learningItemCoverArtMedRenditionLink: string
  Read Only: true

  Maximum Length: 255

  A link to the medium rendition version of the learning cover art image.
• learningItemCreatedByDisplayName: string
  Read Only: true

  Maximum Length: 255

  Display name of the person who created the learning item.
• learningItemCreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the learning item was created.
• learningItemDeliveryURL: string
  Read Only: true

  Maximum Length: 255

  URL used to deliver the learning item to the learner.
• learningItemDescription: string
  Title: Description

  Maximum Length: 4000

  Plain text version of the long description of the learning item.
• learningItemDetailsDeepLink: string
  Title: Learning Item Deep Link

  Maximum Length: 255

  URL to open the learning item page directly from the browser.
• learningItemDetailsEmbedLink: string
  Title: Learning Item Embed Link

  Read Only: true

  Maximum Length: 255

  URL that can be used to embed the learning item page in other pages. It opens the isolated learning item page without the global tool bar on the top.
• learningItemDFF: array learningItemDFF
• learningItemDraftExists: string
  Read Only: true

  Maximum Length: 255

  Indicates if a draft version of this learning item exists. Valid values are Y or N.
• learningItemExpectedEffortInSeconds: number
  Title: Expected Effort

  Expected effort needed by the learner to complete the learning item.
• learningItemFeatureEndDate: string (date-time)
  Title: Featured End Date

  Date when the learning item stops being featured.
• learningItemFeatureStartDate: string (date-time)
  Title: Featured Start Date

  Date when the learning item starts being featured.
• learningItemId: integer (int64)
  Title: Learning Item ID

  Learning item Id of the course.
• learningItemInactiveDate: string (date-time)
  Date when the learning item will be set to inactive.
• learningItemInstructorDisplayName: string
  Title: Instructor

  Maximum Length: 2000

  Display name for the learning item instructor.
• learningItemInstructorPersonNumber: string
  Maximum Length: 30

  Person number of the learning item instructor.
• learningItemInstructorType: string
  Maximum Length: 32

  The instructor type. Valid values are ORA_PERSON or ORA_ADHOC .
• learningItemLastModifiedByDisplayName: string
  Read Only: true

  Maximum Length: 255

  Display name of the person who last modified the learning item.
• learningItemLastModifiedDate: string (date-time)
  Title: Last Modified

  Read Only: true

  Date when the learning item was last modified.
• learningItemLearningLevel: string
  Title: Learning Level

  Maximum Length: 32

  The learning level, such as Beginner, Moderate, or Advanced.
• learningItemLongDescription: string
  Title: Long Description

  Long, rich text description of the learning item.
• learningItemNotificationPattern: string
  Title: Notification Pattern

  Maximum Length: 32

  The notification pattern, such as Default Notification Pattern.
• learningItemNumber: string
  Title: Learning Item Number

  Maximum Length: 2000

  User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI.
• learningItemPreviewURL: string
  Read Only: true

  Maximum Length: 255

  URL used by the administrator to preview the learning item.
• learningItemProvider: string
  Maximum Length: 32

  The name of the provider used to create the learning item, such as Skillsoft or LinkedIn.
• learningItemProviderMeaning: string
  Read Only: true

  Maximum Length: 255

  Description for the learningItemProvider attribute value.
• learningItemProviderType: string
  Maximum Length: 32

  The type of the provider used. Valid values are File,URL,Connector or Questionnaire.
• learningItemProviderTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Description for the learningItemProviderType attribute value.
• learningItemPublishedExists: string
  Read Only: true

  Maximum Length: 255

  Indicate if a published version of this learning item exists. Valid values are Y or N.
• learningItemPublishEndDate: string (date-time)
  Title: Publish End Date

  Date when the learning item stops being visible in the learning catalog.
• learningItemPublisher: string
  Title: Publisher

  Maximum Length: 32

  The learning item publisher, such as Learning Department.
• learningItemPublisherName: string
  Maximum Length: 2000

  Name of the publisher of the learning item.
• learningItemPublishStartDate: string (date-time)
  Title: Publish Start Date

  Date when the learning item starts being visible in the learning catalog.
• learningItemRatingAverage: integer
  Read Only: true

  Rating average for the learning item.
• learningItemRatingCount: integer
  Read Only: true

  Rating count for the learning item.
• learningItemSelfEnrollmentURL: string
  Read Only: true

  URL for the learner to self enroll
• learningItemShortDescription: string
  Title: Learning Item Short Description

  Maximum Length: 255

  Short description of the learning item.
• learningItemStatus: string
  Title: Learning Item Status

  Maximum Length: 30

  Default Value: ORA_DRAFT

  Status of the learning item.
• learningItemSupportedLanguages: string
  Title: Instruction Languages

  Maximum Length: 255

  List of languages the learning item supports.
• learningItemTitle: string
  Title: Title

  Maximum Length: 255

  Title of the learning item.
• learningItemTrailerLink: string
  Read Only: true

  Maximum Length: 255

  URL to open the learning item trailer directly from the browser.
• learningItemType: string
  Title: Assigned Learning Item Subtype

  Maximum Length: 30

  Type of learning item, such as video, online course, document, assessment, or observation checklist.
• learningItemTypeMeaning: string
  Title: Learning Item Type Description

  Read Only: true

  Maximum Length: 255

  Meaning for the learningItemType attribute.
• learningItemVisibility: string
  Maximum Length: 32

  The visibility of the learning item, such as Public or Secret.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• metrics: array Digital Learning Metrics
  Title: Digital Learning Metrics

  The metrics resource returns the metrics on the digital learning, such as the number of current and future dated enrollments, completion count, passed and failed counts, and recommendations count.
• relatedMaterials: array Related Materials
  Title: Related Materials

  The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.
• trailerAssetBinaryTrackerId: string
  Read Only: true

  Maximum Length: 255

  Tracker ID for the trailer asset binary.
• whereUsed: array Where Used
  Title: Where Used

  The whereUsed resource provides details about the usages of a digital learning item in topics and learning communities.

{
    "type":"object",
    "properties":{
        "learningItemDraftExists":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates if a draft version of this learning item exists. Valid values are Y or N.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemCoverArtLowRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"A link to the low rendition version of learning the cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "trailerAssetBinaryTrackerId":{
            "maxLength":255,
            "type":"string",
            "description":"Tracker ID for the trailer asset binary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-learningItemDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "learningItemShortDescription":{
            "title":"Learning Item Short Description",
            "maxLength":255,
            "type":"string",
            "description":"Short description of the learning item.",
            "nullable":true,
            "x-queryable":false
        },
        "learningItemNumber":{
            "title":"Learning Item Number",
            "maxLength":2000,
            "type":"string",
            "description":"User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "learningItemAuthoredOnDate":{
            "type":"string",
            "description":"Date when the learning item was authored.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemNotificationPattern":{
            "title":"Notification Pattern",
            "maxLength":32,
            "type":"string",
            "description":"The notification pattern, such as Default Notification Pattern.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemLastModifiedDate":{
            "title":"Last Modified",
            "type":"string",
            "description":"Date when the learning item was last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemCreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the learning item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemRatingAverage":{
            "type":"integer",
            "description":"Rating average for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemPublishStartDate":{
            "title":"Publish Start Date",
            "type":"string",
            "description":"Date when the learning item starts being visible in the learning catalog.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "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-assets-item-response"
            }
        },
        "learningItemProviderMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the learningItemProvider attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemPreviewURL":{
            "maxLength":255,
            "type":"string",
            "description":"URL used by the administrator to preview the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemDescription":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"Plain text version of the long description of the learning item.",
            "nullable":true,
            "x-queryable":false
        },
        "dataSecurityPrivilege":{
            "title":"Data Security Privilege",
            "type":"string",
            "description":"Data security privilege, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "learningItemProviderTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the learningItemProviderType attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "whereUsed":{
            "title":"Where Used",
            "type":"array",
            "description":"The whereUsed resource provides details about the usages of a digital learning item in topics and learning communities.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-whereUsed-item-response"
            }
        },
        "learningItemProvider":{
            "maxLength":32,
            "type":"string",
            "description":"The name of the provider used to create the learning item, such as Skillsoft or LinkedIn.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "contentBinaryTrackerId":{
            "maxLength":255,
            "type":"string",
            "description":"Tracker ID for the content binary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemVisibility":{
            "maxLength":32,
            "type":"string",
            "description":"The visibility of the learning item, such as Public or Secret.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemCoverArtHighRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"A link to the high rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemProviderType":{
            "maxLength":32,
            "type":"string",
            "description":"The type of the provider used. Valid values are File,URL,Connector or Questionnaire.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemBusinessDriver":{
            "title":"Business Driver",
            "maxLength":32,
            "type":"string",
            "description":"The business driver, such as Compliance or Self Development.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemAuthorType":{
            "maxLength":32,
            "type":"string",
            "description":"The learning author type. Valid values are ORA_PERSON or ORA_ADHOC .",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemCoordDisplayName":{
            "title":"learningItemCoordDisplayName",
            "maxLength":255,
            "type":"string",
            "description":"Display name of the learning item coordinator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "metrics":{
            "title":"Digital Learning Metrics",
            "type":"array",
            "description":"The metrics resource returns the metrics on the digital learning, such as the number of current and future dated enrollments, completion count, passed and failed counts, and recommendations count.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-metrics-item-response"
            }
        },
        "learningItemLongDescription":{
            "title":"Long Description",
            "type":"string",
            "description":"Long, rich text description of the learning item.",
            "nullable":true,
            "x-queryable":false
        },
        "learningItemRatingCount":{
            "type":"integer",
            "description":"Rating count for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemCoverArtMedRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"A link to the medium rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemLearningLevel":{
            "title":"Learning Level",
            "maxLength":32,
            "type":"string",
            "description":"The learning level, such as Beginner, Moderate, or Advanced.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemExpectedEffortInSeconds":{
            "title":"Expected Effort",
            "type":"number",
            "description":"Expected effort needed by the learner to complete the learning item.",
            "nullable":true,
            "x-queryable":false
        },
        "learningItemDetailsEmbedLink":{
            "title":"Learning Item Embed Link",
            "maxLength":255,
            "type":"string",
            "description":"URL that can be used to embed the learning item page in other pages. It opens the isolated learning item page without the global tool bar on the top.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemPublisherName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the publisher of the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemInstructorPersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Person number of the learning item instructor.",
            "nullable":true,
            "x-queryable":false
        },
        "learningItemFeatureEndDate":{
            "title":"Featured End Date",
            "type":"string",
            "description":"Date when the learning item stops being featured.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemTitle":{
            "title":"Title",
            "maxLength":255,
            "type":"string",
            "description":"Title of the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemSupportedLanguages":{
            "title":"Instruction Languages",
            "maxLength":255,
            "type":"string",
            "description":"List of languages the learning item supports.",
            "nullable":true,
            "x-queryable":false
        },
        "content":{
            "title":"Learning Content",
            "type":"array",
            "description":"A child of the learning courses resource, this resource captures the details of content associated with the course, such as storage provider number, delivery provider number, display mode, delivery URL, and supported languages.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-content-item-response"
            }
        },
        "learningItemTypeMeaning":{
            "title":"Learning Item Type Description",
            "maxLength":255,
            "type":"string",
            "description":"Meaning for the learningItemType attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemSelfEnrollmentURL":{
            "type":"string",
            "description":"URL for the learner to self enroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemInstructorDisplayName":{
            "title":"Instructor",
            "maxLength":2000,
            "type":"string",
            "description":"Display name for the learning item instructor.",
            "nullable":true,
            "x-queryable":false
        },
        "learningItemStatus":{
            "title":"Learning Item Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the learning item.",
            "nullable":false,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemInactiveDate":{
            "type":"string",
            "description":"Date when the learning item will be set to inactive.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemCreatedByDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the person who created the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemAuthorDisplayName":{
            "title":"Author",
            "maxLength":2000,
            "type":"string",
            "description":"Display name the learning item author.",
            "nullable":true,
            "x-queryable":false
        },
        "learningItemInstructorType":{
            "maxLength":32,
            "type":"string",
            "description":"The instructor type. Valid values are ORA_PERSON or ORA_ADHOC .",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemDetailsDeepLink":{
            "title":"Learning Item Deep Link",
            "maxLength":255,
            "type":"string",
            "description":"URL to open the learning item page directly from the browser.",
            "nullable":true,
            "x-queryable":false
        },
        "learningItemId":{
            "title":"Learning Item ID",
            "type":"integer",
            "description":"Learning item Id of the course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "learningItemPublishEndDate":{
            "title":"Publish End Date",
            "type":"string",
            "description":"Date when the learning item stops being visible in the learning catalog.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemPublisher":{
            "title":"Publisher",
            "maxLength":32,
            "type":"string",
            "description":"The learning item publisher, such as Learning Department.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemAuthorPersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Person number of the learning item author.",
            "nullable":true,
            "x-queryable":false
        },
        "learningItemPublishedExists":{
            "maxLength":255,
            "type":"string",
            "description":"Indicate if a published version of this learning item exists. Valid values are Y or N.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemLastModifiedByDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the person who last modified the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemFeatureStartDate":{
            "title":"Featured Start Date",
            "type":"string",
            "description":"Date when the learning item starts being featured.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemType":{
            "title":"Assigned Learning Item Subtype",
            "maxLength":30,
            "type":"string",
            "description":"Type of learning item, such as video, online course, document, assessment, or observation checklist.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemAttributionType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST.",
            "nullable":true,
            "default":"ORA_PERSON",
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "relatedMaterials":{
            "title":"Related Materials",
            "type":"array",
            "description":"The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-relatedMaterials-item-response"
            }
        },
        "learningItemDeliveryURL":{
            "maxLength":255,
            "type":"string",
            "description":"URL used to deliver the learning item to the learner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemCoordPersonNumber":{
            "maxLength":32,
            "type":"string",
            "description":"Person number of the learning item coordinator.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemTrailerLink":{
            "maxLength":255,
            "type":"string",
            "description":"URL to open the learning item trailer directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "coverArtAssetBinaryTrackerId":{
            "maxLength":255,
            "type":"string",
            "description":"Tracker ID for the cover art asset binary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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-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-assets-item-response"
    }
}

Nested Schema : Learning Content

Type: array

Title: Learning Content

A child of the learning courses resource, this resource captures the details of content associated with the course, such as storage provider number, delivery provider number, display mode, delivery URL, and supported languages.

Show Source

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

{
    "title":"Learning Content",
    "type":"array",
    "description":"A child of the learning courses resource, this resource captures the details of content associated with the course, such as storage provider number, delivery provider number, display mode, delivery URL, and supported languages.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-content-item-response"
    }
}

Nested Schema : learningItemDFF

Type: array

Show Source

• Array of: object digitalLearning-learningItemDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-learningItemDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : Digital Learning Metrics

Type: array

Title: Digital Learning Metrics

The metrics resource returns the metrics on the digital learning, such as the number of current and future dated enrollments, completion count, passed and failed counts, and recommendations count.

Show Source

• Array of: object digitalLearning-metrics-item-response

{
    "title":"Digital Learning Metrics",
    "type":"array",
    "description":"The metrics resource returns the metrics on the digital learning, such as the number of current and future dated enrollments, completion count, passed and failed counts, and recommendations count.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-metrics-item-response"
    }
}

Nested Schema : Related Materials

Type: array

Title: Related Materials

The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.

Show Source

• Array of: object digitalLearning-relatedMaterials-item-response

{
    "title":"Related Materials",
    "type":"array",
    "description":"The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-relatedMaterials-item-response"
    }
}

Nested Schema : Where Used

Type: array

Title: Where Used

The whereUsed resource provides details about the usages of a digital learning item in topics and learning communities.

Show Source

• Array of: object digitalLearning-whereUsed-item-response

{
    "title":"Where Used",
    "type":"array",
    "description":"The whereUsed resource provides details about the usages of a digital learning item in topics and learning communities.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-whereUsed-item-response"
    }
}

Nested Schema : digitalLearning-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-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-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-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-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-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 : 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"
    }
}

Nested Schema : digitalLearning-learningItemDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• EffectiveEndDate: string (date)
• EffectiveStartDate: string (date)
• LearningItemId: integer (int64)
• LearningItemType: string
  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LearningItemId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LearningItemType":{
            "maxLength":32,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : digitalLearning-metrics-item-response

Type: object

Show Source

• averageActualEffortPERAttempt: number
  Read Only: true

  Average of the actual effort per attempt.
• averageAttemptsPERCompletion: number
  Read Only: true

  Average of the actual effort per completion.
• averageRating: number
  Read Only: true

  Rating average for the digital learning.
• completedCount: number
  Read Only: true

  Count of completed enrollments.
• conversationCount: number
  Read Only: true

  Count of conversations on the digital learning.
• currentCountEnrollments: number
  Read Only: true

  Count of enrollments that are either in active or preactive status.
• currentCountLearners: number
  Read Only: true

  Count of unique learners whose enrollments are in either in active or preactive status.
• failCountEnrollments: number
  Read Only: true

  Count of enrollments with failed status.
• failCountLearners: number
  Read Only: true

  Count of learners who failed the digital learning.
• futureCountEnrollments: number
  Read Only: true

  Count of future-dated enrollments.
• futureCountLearners: number
  Read Only: true

  Count of learners with future-dated enrollments.
• inProgressCount: number
  Read Only: true

  Count of in-progress enrollments.
• learningItemId: integer
  Read Only: true

  Learning Item ID for the digital learning item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• notInterestedCount: number
  Read Only: true

  Count of learners who aren't interested in the digital learning.
• passCountEnrollments: number
  Read Only: true

  Count of enrollments with passed status.
• passCountLearners: number
  Read Only: true

  Count of learners who passed the digital learning.
• totalRatings: number
  Read Only: true

  Rating count for the digital learning.
• totalViewCount: number
  Read Only: true

  Count of views on the digital learning.
• viewCountInLastThirtyDays: number
  Read Only: true

  Count of views on the digital learning in the past 30 days.
• whereUsedCount: number
  Read Only: true

  Count of learning items, such as communities, journeys, organizations, and specializations that use the digital learning.

{
    "type":"object",
    "properties":{
        "averageActualEffortPERAttempt":{
            "type":"number",
            "description":"Average of the actual effort per attempt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "futureCountEnrollments":{
            "type":"number",
            "description":"Count of future-dated enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currentCountLearners":{
            "type":"number",
            "description":"Count of unique learners whose enrollments are in either in active or preactive status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "notInterestedCount":{
            "type":"number",
            "description":"Count of learners who aren't interested in the digital learning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currentCountEnrollments":{
            "type":"number",
            "description":"Count of enrollments that are either in active or preactive status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "passCountEnrollments":{
            "type":"number",
            "description":"Count of enrollments with passed status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "totalRatings":{
            "type":"number",
            "description":"Rating count for the digital learning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "failCountLearners":{
            "type":"number",
            "description":"Count of learners who failed the digital learning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "completedCount":{
            "type":"number",
            "description":"Count of completed enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "inProgressCount":{
            "type":"number",
            "description":"Count of in-progress enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "futureCountLearners":{
            "type":"number",
            "description":"Count of learners with future-dated enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "viewCountInLastThirtyDays":{
            "type":"number",
            "description":"Count of views on the digital learning in the past 30 days.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "totalViewCount":{
            "type":"number",
            "description":"Count of views on the digital learning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "whereUsedCount":{
            "type":"number",
            "description":"Count of learning items, such as communities, journeys, organizations, and specializations that use the digital learning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "averageAttemptsPERCompletion":{
            "type":"number",
            "description":"Average of the actual effort per completion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "failCountEnrollments":{
            "type":"number",
            "description":"Count of enrollments with failed status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "conversationCount":{
            "type":"number",
            "description":"Count of conversations on the digital learning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "averageRating":{
            "type":"number",
            "description":"Rating average for the digital learning.",
            "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"
            }
        },
        "learningItemId":{
            "type":"integer",
            "description":"Learning Item ID for the digital learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "passCountLearners":{
            "type":"number",
            "description":"Count of learners who passed the digital learning.",
            "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"
    }
}

Nested Schema : digitalLearning-relatedMaterials-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• relatedMaterialsBinaries: array Related Materials Binaries
  Title: Related Materials Binaries

  Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
• visibility: string
  Maximum Length: 80

  Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.

{
    "type":"object",
    "properties":{
        "visibility":{
            "maxLength":80,
            "type":"string",
            "description":"Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "relatedMaterialsBinaries":{
            "title":"Related Materials 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-relatedMaterials-relatedMaterialsBinaries-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 : Related Materials Binaries

Type: array

Title: Related Materials 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-relatedMaterials-relatedMaterialsBinaries-item-response

{
    "title":"Related Materials 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-relatedMaterials-relatedMaterialsBinaries-item-response"
    }
}

Nested Schema : digitalLearning-relatedMaterials-relatedMaterialsBinaries-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

  User name of the person who uploaded the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Description of the attachment.
• DmFolderPath: string
  Maximum Length: 1000

  Surrogate identifier of the document attached.
• DmVersionNumber: string
  Maximum Length: 255

  The folder path from which the attachment is created.
• DownloadInfo: string
  Version number of the attachment.
• ErrorStatusCode: string
  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusMessage: string
  The error status code, if any, for the attachment.
• ExpirationDate: string (date-time)
  The error message, if any, for the attachment.
• FileContents: string (byte)
  Expiration date of the attachment. This is a read-only attribute.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Actual content of the attachment.
• FileUrl: string
  Name of the attachment file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  File URL of the attachment.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Base64 encoded image file displayed in .png format when the source is a convertible image.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Date when attachment record was last updated.
• LastUpdatedByUserName: string
  Read Only: true

  Name of the user who last updated the attachment record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction
• Title: string
  Title: Title

  User name of the user who last updated the attachment.
• UploadedFileContentType: string
  Title of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Size of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Name of the uploaded file. This is a read-only attribute.
• Uri: string
  Maximum Length: 4000

  Text uploaded in the attachment.
• Url: string
  Maximum Length: 4000

  URI of the attachment. This is a read-only attribute.
• UserName: string
  Read Only: true

  Maximum Length: 255

  URL of a web page type 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":"User name of the person who uploaded 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":"Actual content of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"File URL of the attachment.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DownloadInfo":{
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":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
            },
            "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":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Date when attachment record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "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
            },
            "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":"User name of the user who last updated the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"Name of the user who last updated the attachment record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileUrl":{
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "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
            }
        },
        "FileContents":{
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"Surrogate identifier of the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UploadedText":{
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "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
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Base64 encoded image file displayed in .png format when the source is a convertible image.",
            "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":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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-whereUsed-item-response

Type: object

Show Source

• learningItemCoverArtLink: string
  Read Only: true

  Maximum Length: 255

  URL to the cover art.
• learningItemDescription: string
  Read Only: true

  Maximum Length: 4000

  Description of the learning item.
• learningItemId: integer (int64)
  Unique identifier for the learning item, it's the internal primary key.
• learningItemNumber: string
  Maximum Length: 30

  Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.
• learningItemStatus: string
  Read Only: true

  Maximum Length: 30

  Status for the learning item.
• learningItemSubType: string
  Read Only: true

  Maximum Length: 30

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

  Maximum Length: 255

  Description of the learning item subtype.
• learningItemTitle: string
  Read Only: true

  Maximum Length: 250

  Title of the learning item.
• learningItemType: string
  Read Only: true

  Maximum Length: 32

  Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the AssignedLearningItemTypeLOV list.
• learningItemTypeMeaning: string
  Read Only: true

  Maximum Length: 255

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

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "learningItemStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status for the learning item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the learning item type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemSubTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the learning item subtype.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemCoverArtLink":{
            "maxLength":255,
            "type":"string",
            "description":"URL to the cover art.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemSubType":{
            "maxLength":30,
            "type":"string",
            "description":"Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "learningItemType":{
            "maxLength":32,
            "type":"string",
            "description":"Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the AssignedLearningItemTypeLOV list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemTitle":{
            "maxLength":250,
            "type":"string",
            "description":"Title of the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier for the learning item, it's the internal primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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

publish

Operation: /hcmRestApi/resources/11.13.18.05/digitalLearning/action/publish

Publishes the digital learning item and makes it available for use.

Back to Top