Jump to

• Request
• Response

Get a certification content item

get

/hcmRestApi/resources/11.13.18.05/talentProviderCertificationItems/{talentProviderCertificationItemsUniqID}

Request

Path Parameters

• talentProviderCertificationItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Certification Content Items resource and used to uniquely identify an instance of Certification Content Items. The client should not generate the hash key value. Instead, the client should query on the Certification Content Items collection resource in order to navigate to a specific instance of Certification Content Items 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 : talentProviderCertificationItems-item-response

Type: object

Show Source

• ContentItemCode: string
  Title: Item Code

  Maximum Length: 30

  Code representing the certification content item.
• ContentItemId: integer (int64)
  Title: Content Item ID

  Unique identifier of the certification content item. Value for the attribute is derived internally.
• ContentSupplierCode: string
  Title: Supplier

  Maximum Length: 30

  Name of the source where the certification content Item came from.
• DateFrom: string (date)
  Title: From Date

  Date from which the certification content item is valid.
• DateTo: string (date)
  Title: To Date

  Date till the certification content item is valid.
• Description: string
  Title: Item Description

  Maximum Length: 2000

  Description about the certification content item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 700

  Name of the certification content item. The name must be unique with the content item catalog.
• Rank: number
  Rank for the certification content item.
• renewalLength: number
  Renewal length of certification content item.
• RenewalPeriod: string
  Maximum Length: 30

  Code representing the renewal period of the certification content item. A list of accepted values is defined in the lookup HRT_VALIDITY_PERIOD.
• RenewalRequired: string
  Maximum Length: 30

  Indicate whether the renewal is required for the certification content item. Valid values are Y and N. The attribute doesn't have a default value.
• ShortDescription: string
  Maximum Length: 240

  Short description about the certification content item.
• ThirdPartyVerificationFlag: boolean
  Maximum Length: 30

  Indicates whether third party verification is required for the certification item. Valid values are true and false.

{
    "type":"object",
    "properties":{
        "ContentItemCode":{
            "title":"Item Code",
            "maxLength":30,
            "type":"string",
            "description":"Code representing the certification content item.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentItemId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier of the certification content item. Value for the attribute is derived internally.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContentSupplierCode":{
            "title":"Supplier",
            "maxLength":30,
            "type":"string",
            "description":"Name of the source where the certification content Item came from.",
            "nullable":true,
            "x-queryable":true
        },
        "DateFrom":{
            "title":"From Date",
            "type":"string",
            "description":"Date from which the certification content item is valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DateTo":{
            "title":"To Date",
            "type":"string",
            "description":"Date till the certification content item is valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description about the certification content item.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of the certification content item. The name must be unique with the content item catalog.",
            "nullable":false,
            "x-queryable":true
        },
        "Rank":{
            "type":"number",
            "description":"Rank for the certification content item.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalPeriod":{
            "maxLength":30,
            "type":"string",
            "description":"Code representing the renewal period of the certification content item. A list of accepted values is defined in the lookup HRT_VALIDITY_PERIOD.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalRequired":{
            "maxLength":30,
            "type":"string",
            "description":"Indicate whether the renewal is required for the certification content item. Valid values are Y and N. The attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "ShortDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Short description about the certification content item.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdPartyVerificationFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether third party verification is required for the certification item. Valid values are true and false.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "renewalLength":{
            "type":"number",
            "description":"Renewal length of certification content item.",
            "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