Jump to

• Request
• Response

Create a skill content item

post

/hcmRestApi/resources/11.13.18.05/talentProviderSkillItems

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ContentItemId: integer (int64)
  Title: Content Item ID

  Unique identifier of the skill content item. Value for the attribute is derived internally.
• DateFrom: string (date)
  Title: From Date

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

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

  Maximum Length: 2000

  Description about the skill content item.
• DomainCode: string
  Maximum Length: 30

  Code representing the domain of the skill content item.
• GlobalId: string
  Maximum Length: 30

  Unique identifier for the group item.
• Name(required): string
  Title: Name

  Maximum Length: 700

  Name of the skill content item.
• ShortDescription: string
  Maximum Length: 240

  Short description about the skill content item.
• skillClassifications: array Skill Classifications
  Title: Skill Classifications

  The skillClassifications resource helps to manage the classifications related to skill content item.
• skillSynonyms: array Skill Synonyms
  Title: Skill Synonyms

  The skillSynonyms resource helps to manage the synonyms related to skill content item.

{
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "ContentItemId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier of the skill content item. Value for the attribute is derived internally.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateFrom":{
            "title":"From Date",
            "type":"string",
            "description":"Date from which the skill content item is valid.",
            "format":"date",
            "nullable":false
        },
        "DateTo":{
            "title":"To Date",
            "type":"string",
            "description":"Date till which the skill content item is valid.",
            "format":"date",
            "nullable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description about the skill content item.",
            "nullable":true
        },
        "DomainCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code representing the domain of the skill content item.",
            "nullable":true
        },
        "GlobalId":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the group item.",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of the skill content item.",
            "nullable":false
        },
        "ShortDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Short description about the skill content item.",
            "nullable":true
        },
        "skillClassifications":{
            "title":"Skill Classifications",
            "type":"array",
            "description":"The skillClassifications resource helps to manage the classifications related to skill content item.",
            "items":{
                "$ref":"#/components/schemas/talentProviderSkillItems-skillClassifications-item-post-request"
            }
        },
        "skillSynonyms":{
            "title":"Skill Synonyms",
            "type":"array",
            "description":"The skillSynonyms resource helps to manage the synonyms related to skill content item.",
            "items":{
                "$ref":"#/components/schemas/talentProviderSkillItems-skillSynonyms-item-post-request"
            }
        }
    }
}

Nested Schema : Skill Classifications

Type: array

Title: Skill Classifications

The skillClassifications resource helps to manage the classifications related to skill content item.

Show Source

• Array of: object talentProviderSkillItems-skillClassifications-item-post-request

{
    "title":"Skill Classifications",
    "type":"array",
    "description":"The skillClassifications resource helps to manage the classifications related to skill content item.",
    "items":{
        "$ref":"#/components/schemas/talentProviderSkillItems-skillClassifications-item-post-request"
    }
}

Nested Schema : Skill Synonyms

Type: array

Title: Skill Synonyms

The skillSynonyms resource helps to manage the synonyms related to skill content item.

Show Source

• Array of: object schema

{
    "title":"Skill Synonyms",
    "type":"array",
    "description":"The skillSynonyms resource helps to manage the synonyms related to skill content item.",
    "items":{
        "$ref":"#/components/schemas/talentProviderSkillItems-skillSynonyms-item-post-request"
    }
}

Nested Schema : talentProviderSkillItems-skillClassifications-item-post-request

Type: object

Show Source

• ClassificationCode: string
  Maximum Length: 240

  Code representing the classification of skill content item.
• ClassificationType: string
  Maximum Length: 240

  Classification type of the skill content item.
• ContentItemClassificationId: integer (int64)
  Unique identifier for the skill classification.

{
    "type":"object",
    "properties":{
        "ClassificationCode":{
            "maxLength":240,
            "type":"string",
            "description":"Code representing the classification of skill content item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ClassificationType":{
            "maxLength":240,
            "type":"string",
            "description":"Classification type of the skill content item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ContentItemClassificationId":{
            "type":"integer",
            "description":"Unique identifier for the skill classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• SynonymName: string
  Maximum Length: 240

  Name of the synonym for the skill.
• SynonymRelationId: integer (int64)
  Unique identifier for the skill synonym relationship.

{
    "type":"object",
    "properties":{
        "SynonymName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the synonym for the skill.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "SynonymRelationId":{
            "type":"integer",
            "description":"Unique identifier for the skill synonym relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        }
    }
}

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 : talentProviderSkillItems-item-response

Type: object

Show Source

• ContentItemId: integer (int64)
  Title: Content Item ID

  Unique identifier of the skill content item. Value for the attribute is derived internally.
• DateFrom: string (date)
  Title: From Date

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

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

  Maximum Length: 2000

  Description about the skill content item.
• DomainCode: string
  Maximum Length: 30

  Code representing the domain of the skill content item.
• GlobalId: string
  Maximum Length: 30

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

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

  Maximum Length: 700

  Name of the skill content item.
• ShortDescription: string
  Maximum Length: 240

  Short description about the skill content item.
• skillClassifications: array Skill Classifications
  Title: Skill Classifications

  The skillClassifications resource helps to manage the classifications related to skill content item.
• skillSynonyms: array Skill Synonyms
  Title: Skill Synonyms

  The skillSynonyms resource helps to manage the synonyms related to skill content item.

{
    "type":"object",
    "properties":{
        "ContentItemId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier of the skill content item. Value for the attribute is derived internally.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DateFrom":{
            "title":"From Date",
            "type":"string",
            "description":"Date from which the skill content item is valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DateTo":{
            "title":"To Date",
            "type":"string",
            "description":"Date till which the skill content item is valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description about the skill content item.",
            "nullable":true,
            "x-queryable":true
        },
        "DomainCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code representing the domain of the skill content item.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalId":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the group item.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of the skill content item.",
            "nullable":false,
            "x-queryable":true
        },
        "ShortDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Short description about the skill content item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "skillClassifications":{
            "title":"Skill Classifications",
            "type":"array",
            "description":"The skillClassifications resource helps to manage the classifications related to skill content item.",
            "items":{
                "$ref":"#/components/schemas/talentProviderSkillItems-skillClassifications-item-response"
            }
        },
        "skillSynonyms":{
            "title":"Skill Synonyms",
            "type":"array",
            "description":"The skillSynonyms resource helps to manage the synonyms related to skill content item.",
            "items":{
                "$ref":"#/components/schemas/talentProviderSkillItems-skillSynonyms-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 : Skill Classifications

Type: array

Title: Skill Classifications

The skillClassifications resource helps to manage the classifications related to skill content item.

Show Source

• Array of: object talentProviderSkillItems-skillClassifications-item-response

{
    "title":"Skill Classifications",
    "type":"array",
    "description":"The skillClassifications resource helps to manage the classifications related to skill content item.",
    "items":{
        "$ref":"#/components/schemas/talentProviderSkillItems-skillClassifications-item-response"
    }
}

Nested Schema : Skill Synonyms

Type: array

Title: Skill Synonyms

The skillSynonyms resource helps to manage the synonyms related to skill content item.

Show Source

• Array of: object talentProviderSkillItems-skillSynonyms-item-response

{
    "title":"Skill Synonyms",
    "type":"array",
    "description":"The skillSynonyms resource helps to manage the synonyms related to skill content item.",
    "items":{
        "$ref":"#/components/schemas/talentProviderSkillItems-skillSynonyms-item-response"
    }
}

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."
        }
    }
}

Nested Schema : talentProviderSkillItems-skillClassifications-item-response

Type: object

Show Source

• Classification: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Description for the classification of skill content item.
• ClassificationCode: string
  Maximum Length: 240

  Code representing the classification of skill content item.
• ClassificationType: string
  Maximum Length: 240

  Classification type of the skill content item.
• ContentItemClassificationId: integer (int64)
  Unique identifier for the skill classification.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the classification for the skill.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the classification for the skill was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the classification for the skill was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the classification for the skill.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "Classification":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description for the classification of skill content item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ClassificationCode":{
            "maxLength":240,
            "type":"string",
            "description":"Code representing the classification of skill content item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ClassificationType":{
            "maxLength":240,
            "type":"string",
            "description":"Classification type of the skill content item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ContentItemClassificationId":{
            "type":"integer",
            "description":"Unique identifier for the skill classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the classification for the skill.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the classification for the skill was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the classification for the skill was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the classification for the skill.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : talentProviderSkillItems-skillSynonyms-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SynonymName: string
  Maximum Length: 240

  Name of the synonym for the skill.
• SynonymRelationId: integer (int64)
  Unique identifier for the skill synonym relationship.

{
    "type":"object",
    "properties":{
        "SynonymName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the synonym for the skill.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SynonymRelationId":{
            "type":"integer",
            "description":"Unique identifier for the skill synonym relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

skillClassifications

Operation: /hcmRestApi/resources/11.13.18.05/talentProviderSkillItems/{talentProviderSkillItemsUniqID}/child/skillClassifications

Parameters:

• talentProviderSkillItemsUniqID: $request.path.talentProviderSkillItemsUniqID

The skillClassifications resource helps to manage the classifications related to skill content item.

skillSynonyms

Operation: /hcmRestApi/resources/11.13.18.05/talentProviderSkillItems/{talentProviderSkillItemsUniqID}/child/skillSynonyms

Parameters:

• talentProviderSkillItemsUniqID: $request.path.talentProviderSkillItemsUniqID

The skillSynonyms resource helps to manage the synonyms related to skill content item.

Back to Top