Jump to

• Request
• Response

Get all digital learning items

get

/hcmRestApi/resources/11.13.18.05/digitalLearningProviders

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:
  

  • learningItemBusinessDriver; string; The business driver, such as Compliance or Self Development.
  • learningItemCreationDate; string; Date when the learning item was created.
  • 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.
  • learningItemNumber; string; User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI.
  • learningItemPublisherName; string; Name of the publisher of the learning item.
  • learningItemStatus; string; Status of the learning item.
  • learningItemTitle; string; Title of the learning item.
  • 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 : digitalLearningProviders

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/digitalLearningProviders-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object digitalLearningProviders-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/digitalLearningProviders-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 : digitalLearningProviders-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.
• classification: string
  JSON object represented as a string that contains the levels of classification or folder structure of a provider-managed content item in a predefined format.
• 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.
• learningItemAuthorDisplayName: string
  Title: Author

  Maximum Length: 2000

  Display name the learning item author.
• learningItemBusinessDriver: string
  Title: Business Driver

  Maximum Length: 32

  The business driver, such as Compliance or Self Development.
• 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.
• learningItemExpectedEffortInSeconds: number
  Title: Expected Effort

  Expected effort needed by the learner to complete the learning item.
• 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.
• 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.
• 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.
• learningItemPublisherName: string
  Maximum Length: 2000

  Name of the publisher of the learning item.
• 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.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• skillsQualifications: string
  JSON object represented as a string that contains information about skills and qualifications associated with a provider-managed content item.

{
    "type":"object",
    "properties":{
        "learningItemShortDescription":{
            "title":"Learning Item Short Description",
            "maxLength":255,
            "type":"string",
            "description":"Short description of the learning item.",
            "nullable":true,
            "x-queryable":false
        },
        "learningItemExpectedEffortInSeconds":{
            "title":"Expected Effort",
            "type":"number",
            "description":"Expected effort needed by the learner to complete 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
        },
        "learningItemPublisherName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the publisher of the learning item.",
            "nullable":true,
            "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
        },
        "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/digitalLearningProviders-content-item-response"
            }
        },
        "learningItemCreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the learning item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemTypeMeaning":{
            "title":"Learning Item Type Description",
            "maxLength":255,
            "type":"string",
            "description":"Meaning for the learningItemType attribute.",
            "nullable":true,
            "readOnly":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
        },
        "learningItemInstructorDisplayName":{
            "title":"Instructor",
            "maxLength":2000,
            "type":"string",
            "description":"Display name for the learning item instructor.",
            "nullable":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/digitalLearningProviders-assets-item-response"
            }
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "learningItemLastModifiedByDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the person who last modified the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "classification":{
            "type":"string",
            "description":"JSON object represented as a string that contains the levels of classification or folder structure of a provider-managed content item in a predefined format.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "skillsQualifications":{
            "type":"string",
            "description":"JSON object represented as a string that contains information about skills and qualifications associated with a provider-managed content item.",
            "nullable":true,
            "x-queryable":false
        },
        "learningItemLongDescription":{
            "title":"Long Description",
            "type":"string",
            "description":"Long, rich text description of the learning item.",
            "nullable":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
        }
    }
}

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 digitalLearningProviders-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/digitalLearningProviders-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 digitalLearningProviders-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/digitalLearningProviders-content-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 : digitalLearningProviders-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.
• 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
        },
        "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 : 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 : digitalLearningProviders-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.
• 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.
• 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.
• 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
        },
        "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
        },
        "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
        },
        "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 : 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/digitalLearningProviders/action/publish

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

Back to Top