Jump to

• Request
• Response

GET action not supported

get

/hcmRestApi/resources/11.13.18.05/learningContentItems

Request

Query Parameters

• 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 a learning content item that matches the primary key criteria specified.
    Finder Variables:
    • ContentId; integer; System-generated primary key. Surrogate key.
• 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:
  

  • AssessmentAttempts; integer; Indicates the number of attempts allowed for the assessment.
  • AssessmentCode; string; Unique identifier for the assessment.
  • AssessmentMasteryScore; number; Indicates the minimum score needed to pass the assessment.
  • AssessmentScoreVisibleToAdministrator; string; Indicates whether the assessment is visible to the administrator or not. This attribute doesn't have a default value. Valid values are Y and N.
  • AssessmentScoreVisibleToLearner; string; Indicates whether the assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.
  • AssessmentTimeLimit; number; Indicates the time limit for the assessment.
  • AssessmentTimeLimitUOM; string; Indicates the unit of measure for the assessment time limit.
  • CompletedAssessmentVisibleToLearner; string; Indicates whether the completed assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.
  • ContentId; integer; Unique identifier for the content object.
  • Description; string; Description of the content item.
  • EndDate; string; End date of the content item.
  • FileName; string; File name of the content item to be uploaded. Depending on the tracking type, the extension should be zip, pdf, or mov.
  • IngestionStatus; string; Ingestion status of the content item. For Video and SCORM/AICC/HACP content, valid value is ORA_MED_TRANSCODING.
  • ItemNumber; string; Unique user key for the content item.
  • MarkCompleteOnOpen; string; Indicates whether the learning content item can be marked complete when opened. This attribute doesn't have a default value. Valid values are Y and N.
  • ReplaceStatus; string; Replacement status of the content item. For video, PDF, and SCORM/AICC/HACP content, valid values are ORA_MED_REPLACE_BEGIN and ORA_MED_REPLACE_END. Use ORA_MED_REPLACE_BEGIN to request the auth token for uploading a replacement to Akamai. Use ORA_MED_REPLACE_END to perform the replacement after the new media has been uploaded to Akamai.
  • StartDate; string; Start date of the content item.
  • Status; string; Status of the content item. For PDF and WEBLINK content, valid values are ORA_CONT_INACTIVE, ORA_CONT_ACTIVE.
  • Title; string; Tiitle of the content item.
  • TrackingType; string; Tracking type for the content item. Valid values are ORA_SCORM_12, ORA_SCORM_2004, ORA_HACP, ORA_PDF, ORA_AUTO, and ORA_VIDEO.
  • URL; string; Starting URL of the content item.
  • UUID; string; Internal value, no input required.
  • UploadAuthToken; string; Upload authentication token generated for the learning content item.
  • UploadLocation; string; Upload location of the learning content item.
• 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

• 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 : learningContentItems

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object learningContentItems-item-response

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

Type: object

Show Source

• AssessmentAttempts: integer
  Indicates the number of attempts allowed for the assessment.
• AssessmentCode: string
  Unique identifier for the assessment.
• AssessmentMasteryScore: number
  Indicates the minimum score needed to pass the assessment.
• AssessmentScoreVisibleToAdministrator: string
  Indicates whether the assessment is visible to the administrator or not. This attribute doesn't have a default value. Valid values are Y and N.
• AssessmentScoreVisibleToLearner: string
  Indicates whether the assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.
• AssessmentTimeLimit: number
  Indicates the time limit for the assessment.
• AssessmentTimeLimitUOM: string
  Indicates the unit of measure for the assessment time limit.
• CompletedAssessmentVisibleToLearner: string
  Indicates whether the completed assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.
• ContentId: integer
  Unique identifier for the content object.
• Description: string
  Description of the content item.
• EndDate: string (date)
  End date of the content item.
• FileName: string
  File name of the content item to be uploaded. Depending on the tracking type, the extension should be zip, pdf, or mov.
• IngestionStatus: string
  Ingestion status of the content item. For Video and SCORM/AICC/HACP content, valid value is ORA_MED_TRANSCODING.
• ItemNumber: string
  Unique user key for the content item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MarkCompleteOnOpen: string
  Indicates whether the learning content item can be marked complete when opened. This attribute doesn't have a default value. Valid values are Y and N.
• ReplaceStatus: string
  Replacement status of the content item. For video, PDF, and SCORM/AICC/HACP content, valid values are ORA_MED_REPLACE_BEGIN and ORA_MED_REPLACE_END. Use ORA_MED_REPLACE_BEGIN to request the auth token for uploading a replacement to Akamai. Use ORA_MED_REPLACE_END to perform the replacement after the new media has been uploaded to Akamai.
• StartDate: string (date)
  Start date of the content item.
• Status: string
  Status of the content item. For PDF and WEBLINK content, valid values are ORA_CONT_INACTIVE, ORA_CONT_ACTIVE.
• Title: string
  Tiitle of the content item.
• TrackingType: string
  Tracking type for the content item. Valid values are ORA_SCORM_12, ORA_SCORM_2004, ORA_HACP, ORA_PDF, ORA_AUTO, and ORA_VIDEO.
• UploadAuthToken: string
  Upload authentication token generated for the learning content item.
• UploadLocation: string
  Upload location of the learning content item.
• URL: string
  Starting URL of the content item.
• UUID: string
  Internal value, no input required.

{
    "type":"object",
    "properties":{
        "Description":{
            "type":"string",
            "description":"Description of the content item.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplaceStatus":{
            "type":"string",
            "description":"Replacement status of the content item. For video, PDF, and SCORM/AICC/HACP content, valid values are ORA_MED_REPLACE_BEGIN and ORA_MED_REPLACE_END. Use ORA_MED_REPLACE_BEGIN to request the auth token for uploading a replacement to Akamai. Use ORA_MED_REPLACE_END to perform the replacement after the new media has been uploaded to Akamai.",
            "nullable":true,
            "x-queryable":true
        },
        "FileName":{
            "type":"string",
            "description":"File name of the content item to be uploaded. Depending on the tracking type, the extension should be zip, pdf, or mov.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentMasteryScore":{
            "type":"number",
            "description":"Indicates the minimum score needed to pass the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentScoreVisibleToLearner":{
            "type":"string",
            "description":"Indicates whether the assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "URL":{
            "type":"string",
            "description":"Starting URL of the content item.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the content item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CompletedAssessmentVisibleToLearner":{
            "type":"string",
            "description":"Indicates whether the completed assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Unique user key for the content item.",
            "nullable":true,
            "x-queryable":true
        },
        "IngestionStatus":{
            "type":"string",
            "description":"Ingestion status of the content item. For Video and SCORM/AICC/HACP content,\nvalid value is ORA_MED_TRANSCODING.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentAttempts":{
            "type":"integer",
            "description":"Indicates the number of attempts allowed for the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UUID":{
            "type":"string",
            "description":"Internal value, no input required.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the content item. For PDF and WEBLINK content, valid values are ORA_CONT_INACTIVE, ORA_CONT_ACTIVE.",
            "nullable":true,
            "x-queryable":true
        },
        "UploadAuthToken":{
            "type":"string",
            "description":"Upload authentication token generated for the learning content item.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentTimeLimitUOM":{
            "type":"string",
            "description":"Indicates the unit of measure for the assessment time limit.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "type":"string",
            "description":"Tiitle of the content item.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the content item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TrackingType":{
            "type":"string",
            "description":"Tracking type for the content item. Valid values are ORA_SCORM_12,\nORA_SCORM_2004, ORA_HACP,\nORA_PDF,\nORA_AUTO, and ORA_VIDEO.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentCode":{
            "type":"string",
            "description":"Unique identifier for the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentScoreVisibleToAdministrator":{
            "type":"string",
            "description":"Indicates whether the assessment is visible to the administrator or not. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentTimeLimit":{
            "type":"number",
            "description":"Indicates the time limit for the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentId":{
            "type":"integer",
            "description":"Unique identifier for the content object.",
            "nullable":true,
            "x-queryable":true
        },
        "UploadLocation":{
            "type":"string",
            "description":"Upload location of the learning content item.",
            "nullable":true,
            "x-queryable":true
        },
        "MarkCompleteOnOpen":{
            "type":"string",
            "description":"Indicates whether the learning content item can be marked complete when opened. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":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 : 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."
        }
    }
}

Back to Top