Jump to

• Request
• Response

Get a particular metric for a learning item

get

/hcmRestApi/resources/11.13.18.05/learningSelfPacedItems/{learningSelfPacedItemsUniqID}/child/metrics/{metricsUniqID}

Request

Path Parameters

• learningSelfPacedItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Learning Self-Paced Items resource and used to uniquely identify an instance of Learning Self-Paced Items. The client should not generate the hash key value. Instead, the client should query on the Learning Self-Paced Items collection resource in order to navigate to a specific instance of Learning Self-Paced Items to get the hash key.
• metricsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Learning Catalog Item Metrics resource and used to uniquely identify an instance of Learning Catalog Item Metrics. The client should not generate the hash key value. Instead, the client should query on the Learning Catalog Item Metrics collection resource in order to navigate to a specific instance of Learning Catalog Item Metrics to get the hash key.

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: string
  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: string
  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 : learningSelfPacedItems-metrics-item-response

Type: object

Show Source

• averageActualEffortPERAttempt: number
  Read Only: true

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

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

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

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

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

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

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

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

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

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

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

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

  Unique identifier for the learning item.
• links: array Links
  Title: Links

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

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

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

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

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

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

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

  Count of learning items, such as communities, journeys, user groups, and specializations that use the learning item.

{
    "type":"object",
    "properties":{
        "averageActualEffortPERAttempt":{
            "type":"number",
            "description":"Average of the actual effort per attempt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "futureCountEnrollments":{
            "type":"number",
            "description":"Count of future-dated enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currentCountLearners":{
            "type":"number",
            "description":"Count of unique learners whose enrollments are in either in active or preactive status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "notInterestedCount":{
            "type":"number",
            "description":"Count of learners who aren't interested in the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currentCountEnrollments":{
            "type":"number",
            "description":"Count of enrollments that are either in active or preactive status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "passCountEnrollments":{
            "type":"number",
            "description":"Count of enrollments with passed status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "totalRatings":{
            "type":"number",
            "description":"Rating count for the learning catalog item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "failCountLearners":{
            "type":"number",
            "description":"Count of learners who failed the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "completedCount":{
            "type":"number",
            "description":"Count of completed enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "inProgressCount":{
            "type":"number",
            "description":"Count of in-progress enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "futureCountLearners":{
            "type":"number",
            "description":"Count of learners with future-dated enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "viewCountInLastThirtyDays":{
            "type":"number",
            "description":"Count of views on the learning item in the past 30 days.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "totalViewCount":{
            "type":"number",
            "description":"Count of views on the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "whereUsedCount":{
            "type":"number",
            "description":"Count of learning items, such as communities, journeys, user groups, and specializations that use the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "averageAttemptsPERCompletion":{
            "type":"number",
            "description":"Average of the actual effort per completion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "failCountEnrollments":{
            "type":"number",
            "description":"Count of enrollments with failed status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "conversationCount":{
            "type":"number",
            "description":"Count of conversations on the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "averageRating":{
            "type":"number",
            "description":"Rating average for the learning catalog item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "passCountLearners":{
            "type":"number",
            "description":"Count of learners who passed the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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