Jump to

• Request
• Response

Get a learning content item

get

/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/learningItems/{workerJourneyTasks_learningItems_Id}

Request

Path Parameters

• workerJourneyTasksUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Worker Journey Tasks resource and used to uniquely identify an instance of Worker Journey Tasks. The client should not generate the hash key value. Instead, the client should query on the Worker Journey Tasks collection resource in order to navigate to a specific instance of Worker Journey Tasks to get the hash key.
• workerJourneyTasks_learningItems_Id(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : workerJourneyTasks-learningItems-item-response

Type: object

Show Source

• elearnCoverArtLink: string
  Title: eLearning Cover Art Link

  Read Only: true

  URL of the content item's cover art.
• elearnDisableReassignObserverChecklistToAnyone: string
  Title: eLearning Disable Reassignment of the Observer Checklist to Anyone

  Read Only: true

  Maximum Length: 1

  Indicates whether the reassignment of the observer checklist to any user who isn't a configured observer, as defined on the learning item, is disabled. Valid values are Y, N for the observation checklist e-learn type. Default value is Y.
• elearnDisableSelfAssessChecklist: string
  Title: eLearning Disable Self-Assessment Checklist

  Read Only: true

  Maximum Length: 1

  Indicates whether the self-assessment checklist for the observation checklist is disabled. Valid values are Y, N for the observation checklist elearnType. Default value is Y.
• elearnObserverType: string
  Title: eLearning Observer Type

  Read Only: true

  Maximum Length: 30

  Type of observer for the observation checklist e-learn type such as Individuals or Representative. Valid values are defined in the list ELearnObserverTypeLOV.
• elearnObserverTypeMeaning: string
  Title: eLearning Observer Type Description

  Read Only: true

  Maximum Length: 80

  Description of the e-learn observer type.
• elearnRichMediaLink: string
  Title: eLearning Rich Media Link

  Read Only: true

  URL to open the rich media directly from the browser.
• elearnRouteUsing: string
  Title: eLearning Route Using

  Read Only: true

  Maximum Length: 30

  Approval routes for the observation checklist e-learn type. Valid values are defined in the list ELearnRouteUsingLOV.
• elearnRouteUsingMeaning: string
  Title: eLearning Route Using Description

  Read Only: true

  Maximum Length: 80

  Description of the elearnRouteUsing.
• elearnTimePERAttempt: number
  Title: eLearning Time per Attempt

  Read Only: true

  Time limit per attempt on the learning content item.
• elearnTimePERAttemptUnits: string
  Title: eLearning Time per Attempt Units

  Read Only: true

  Maximum Length: 30

  Units for time limit per attempt on the learning content item such as Hour, or Minute. Valid values are defined in the list ELearnTimePerAttemptUnitsLOV.
• elearnType: string
  Title: Content Type

  Read Only: true

  Maximum Length: 30

  Type of self-paced learning such as Video or SCORM. Valid values are defined in the list ContentTypeLOV.
• elearnTypeMeaning: string
  Title: Content Type Description

  Read Only: true

  Description of the e-learn type.
• learningItemDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 4000

  Description of the learning item.
• learningItemId: integer (int64)
  Title: Content Catalog Learning Item ID

  Read Only: true

  Unique identifier for the learning content item which is the internal primary key.
• learningItemNumber: string
  Title: Content Number

  Read Only: true

  Maximum Length: 30

  User-friendly number identifying the learning content item. It's a surrogate key which is shown in the UI.
• learningItemTitle: string
  Title: Content Title

  Read Only: true

  Maximum Length: 250

  Title of the learning content item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "elearnCoverArtLink":{
            "title":"eLearning Cover Art Link",
            "type":"string",
            "description":"URL of the content item's cover art.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnDisableReassignObserverChecklistToAnyone":{
            "title":"eLearning Disable Reassignment of the Observer Checklist to Anyone",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the reassignment of the observer checklist to any user who isn't a configured observer, as defined on the learning item, is disabled. Valid values are Y, N for the observation checklist e-learn type. Default value is Y.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnObserverTypeMeaning":{
            "title":"eLearning Observer Type Description",
            "maxLength":80,
            "type":"string",
            "description":"Description of the e-learn observer type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemNumber":{
            "title":"Content Number",
            "maxLength":30,
            "type":"string",
            "description":"User-friendly number identifying the learning content item. It's a surrogate key which is shown in the UI.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnTypeMeaning":{
            "title":"Content Type Description",
            "type":"string",
            "description":"Description of the e-learn type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnTimePERAttemptUnits":{
            "title":"eLearning Time per Attempt Units",
            "maxLength":30,
            "type":"string",
            "description":"Units for time limit per attempt on the learning content item such as Hour, or Minute. Valid values are defined in the list ELearnTimePerAttemptUnitsLOV.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "learningItemTitle":{
            "title":"Content Title",
            "maxLength":250,
            "type":"string",
            "description":"Title of the learning content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnRichMediaLink":{
            "title":"eLearning Rich Media Link",
            "type":"string",
            "description":"URL to open the rich media directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnObserverType":{
            "title":"eLearning Observer Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of observer for the observation checklist e-learn type such as Individuals or Representative. Valid values are defined in the list ELearnObserverTypeLOV.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnRouteUsingMeaning":{
            "title":"eLearning Route Using Description",
            "maxLength":80,
            "type":"string",
            "description":"Description of the elearnRouteUsing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnType":{
            "title":"Content Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of self-paced learning such as Video or SCORM. Valid values are defined in the list ContentTypeLOV.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "elearnDisableSelfAssessChecklist":{
            "title":"eLearning Disable Self-Assessment Checklist",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the self-assessment checklist for the observation checklist is disabled. Valid values are Y, N for the observation checklist elearnType. Default value is Y.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnRouteUsing":{
            "title":"eLearning Route Using",
            "maxLength":30,
            "type":"string",
            "description":"Approval routes for the observation checklist e-learn type. Valid values are defined in the list ELearnRouteUsingLOV.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemDescription":{
            "title":"Description",
            "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"
            }
        },
        "learningItemId":{
            "title":"Content Catalog Learning Item ID",
            "type":"integer",
            "description":"Unique identifier for the learning content item which is the internal primary key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "elearnTimePERAttempt":{
            "title":"eLearning Time per Attempt",
            "type":"number",
            "description":"Time limit per attempt on the learning content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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