Jump to

• Request
• Response

Create a usage

post

/hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}/child/whereUsed

Request

Path Parameters

• digitalLearningUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the (digitalLearning) resource and used to uniquely identify an instance of (digitalLearning). The client should not generate the hash key value. Instead, the client should query on the (digitalLearning) collection resource in order to navigate to a specific instance of (digitalLearning) to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

  Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.

{
    "type":"object",
    "properties":{
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier for the learning item, it's the internal primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "learningItemNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : digitalLearning-whereUsed-item-response

Type: object

Show Source

• learningItemCoverArtLink: string
  Read Only: true

  Maximum Length: 255

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

  Maximum Length: 4000

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

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

  Maximum Length: 30

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

  Maximum Length: 30

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

  Maximum Length: 255

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

  Maximum Length: 250

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

  Maximum Length: 32

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

  Maximum Length: 255

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

  The link relations associated with the resource instance.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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