Jump to

• Request
• Response

Update a candidate skill

patch

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills/{SkillId}

Request

Path Parameters

• CandidateNumber(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=
• SkillId(required): integer(int64)
  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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Comments: string (byte)
  Title: Comments

  Comments of a candidate skill.
• ContentItemId: integer (int64)
  Content item identifier of a candidate skill.
• DateAchieved: string (date)
  Title: Date Achieved

  Date when the candidate skill was achieved.
• Description: string (byte)
  Title: Description

  Description of a candidate skill.
• ProjectName: string
  Title: Project Name or Activities

  Maximum Length: 2000

  Project name of a candidate skill.
• SectionId: integer (int64)
  Section identifier of the candidate skills.
• Skill: string
  Title: Skill

  Maximum Length: 240

  Description of a candidate skill.
• Speciality: string
  Title: Skill Type

  Maximum Length: 30

  Specialty or skill type of a candidate skill.
• YearsOfExperience: integer (int64)
  Title: Years of Experience

  Years of experience of a candidate skill.

{
    "type":"object",
    "properties":{
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments of a candidate skill.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ContentItemId":{
            "type":"integer",
            "description":"Content item identifier of a candidate skill.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateAchieved":{
            "title":"Date Achieved",
            "type":"string",
            "description":"Date when the candidate skill was achieved.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of a candidate skill.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ProjectName":{
            "title":"Project Name or Activities",
            "maxLength":2000,
            "type":"string",
            "description":"Project name of a candidate skill.",
            "nullable":true
        },
        "SectionId":{
            "type":"integer",
            "description":"Section identifier of the candidate skills.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Skill":{
            "title":"Skill",
            "maxLength":240,
            "type":"string",
            "description":"Description of a candidate skill.",
            "nullable":true
        },
        "Speciality":{
            "title":"Skill Type",
            "maxLength":30,
            "type":"string",
            "description":"Specialty or skill type of a candidate skill.",
            "nullable":true
        },
        "YearsOfExperience":{
            "title":"Years of Experience",
            "type":"integer",
            "description":"Years of experience of a candidate skill.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "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 : recruitingJobSiteCandidates-skills-item-response

Type: object

Show Source

• Comments: string (byte)
  Title: Comments

  Comments of a candidate skill.
• ContentItemId: integer (int64)
  Content item identifier of a candidate skill.
• DateAchieved: string (date)
  Title: Date Achieved

  Date when the candidate skill was achieved.
• Description: string (byte)
  Title: Description

  Description of a candidate skill.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectName: string
  Title: Project Name or Activities

  Maximum Length: 2000

  Project name of a candidate skill.
• SectionId: integer (int64)
  Section identifier of the candidate skills.
• Skill: string
  Title: Skill

  Maximum Length: 240

  Description of a candidate skill.
• SkillId: integer (int64)
  Identifier of a candidate skill.
• Speciality: string
  Title: Skill Type

  Maximum Length: 30

  Specialty or skill type of a candidate skill.
• YearsOfExperience: integer (int64)
  Title: Years of Experience

  Years of experience of a candidate skill.

{
    "type":"object",
    "properties":{
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments of a candidate skill.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ContentItemId":{
            "type":"integer",
            "description":"Content item identifier of a candidate skill.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateAchieved":{
            "title":"Date Achieved",
            "type":"string",
            "description":"Date when the candidate skill was achieved.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of a candidate skill.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ProjectName":{
            "title":"Project Name or Activities",
            "maxLength":2000,
            "type":"string",
            "description":"Project name of a candidate skill.",
            "nullable":true,
            "x-queryable":true
        },
        "SectionId":{
            "type":"integer",
            "description":"Section identifier of the candidate skills.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Skill":{
            "title":"Skill",
            "maxLength":240,
            "type":"string",
            "description":"Description of a candidate skill.",
            "nullable":true,
            "x-queryable":true
        },
        "SkillId":{
            "type":"integer",
            "description":"Identifier of a candidate skill.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Speciality":{
            "title":"Skill Type",
            "maxLength":30,
            "type":"string",
            "description":"Specialty or skill type of a candidate skill.",
            "nullable":true,
            "x-queryable":true
        },
        "YearsOfExperience":{
            "title":"Years of Experience",
            "type":"integer",
            "description":"Years of experience of a candidate skill.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 : 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