Jump to

• Request
• Response

Patch the language items

patch

/hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}

Request

Path Parameters

• LanguageId(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

• AbleToTeachFlag: boolean
  Title: Able to Teach

  Maximum Length: 30

  Indicates if the candidate can teach the language.
• AbleToTranslateFlag: boolean
  Title: Able to Translate

  Maximum Length: 30

  Indicates if the candidate can translate the language.
• Comments: string (byte)
  Title: Comments

  Comments on the language items.
• ContentItemId: integer (int64)
  Title: Language

  Content Item ID in for the language items.
• EvaluatedOn: string (date)
  Title: Evaluated On

  Date of evaluation of the language item.
• EvaluationLocation: string
  Title: Evaluation Location

  Maximum Length: 240

  Location of evaluation of the language item.
• FlowVersionId: integer
  FlowVersionId is used for all the services to return the corresponding service metadata information.
• Language: string
  Maximum Length: 240

  Language known to the candidate.
• NativeSpeakerFlag: boolean
  Title: Native

  Maximum Length: 30

  Indicates if the candidate is a native speaker of the language.
• ReadingLevelId: integer (int64)
  Title: Reading

  ID assigned to the language reading proficiency.
• ReadingModelId: integer (int64)
  Title: Reading Rating Model

  ID assigned to the reading model of the language.
• SectionId: integer (int64)
  Section ID in candidate language items.
• SpeakingLevelId: integer (int64)
  Title: Speaking

  ID assigned to the language speaking proficiency.
• SpeakingModelId: integer (int64)
  Title: Speaking Rating Model

  ID assigned to the speaking model of the language.
• SubmissionId: string
  Maximum Length: 255

  Unique ID which gets generated after the candidate submits a job request.
• WritingLevelId: integer (int64)
  Title: Writing

  ID assigned to the language writing proficiency.
• WritingModelId: integer (int64)
  Title: Writing Rating Model

  ID assigned to the writing model of the language.

{
    "type":"object",
    "properties":{
        "AbleToTeachFlag":{
            "title":"Able to Teach",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the candidate can teach the language.",
            "nullable":true
        },
        "AbleToTranslateFlag":{
            "title":"Able to Translate",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the candidate can translate the language.",
            "nullable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments on the language items.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ContentItemId":{
            "title":"Language",
            "type":"integer",
            "description":"Content Item ID in for the language items.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EvaluatedOn":{
            "title":"Evaluated On",
            "type":"string",
            "description":"Date of evaluation of the language item.",
            "format":"date",
            "nullable":true
        },
        "EvaluationLocation":{
            "title":"Evaluation Location",
            "maxLength":240,
            "type":"string",
            "description":"Location of evaluation of the language item.",
            "nullable":true
        },
        "FlowVersionId":{
            "type":"integer",
            "description":"FlowVersionId is used for all the services to return the corresponding service metadata information.",
            "nullable":true
        },
        "Language":{
            "maxLength":240,
            "type":"string",
            "description":"Language known to the candidate.",
            "nullable":true
        },
        "NativeSpeakerFlag":{
            "title":"Native",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the candidate is a native speaker of the language.",
            "nullable":true
        },
        "ReadingLevelId":{
            "title":"Reading",
            "type":"integer",
            "description":"ID assigned to the language reading proficiency.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReadingModelId":{
            "title":"Reading Rating Model",
            "type":"integer",
            "description":"ID assigned to the reading model of the language.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SectionId":{
            "type":"integer",
            "description":"Section ID in candidate language items.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SpeakingLevelId":{
            "title":"Speaking",
            "type":"integer",
            "description":"ID assigned to the language speaking proficiency.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SpeakingModelId":{
            "title":"Speaking Rating Model",
            "type":"integer",
            "description":"ID assigned to the speaking model of the language.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubmissionId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique ID which gets generated after the candidate submits a job request.",
            "nullable":true
        },
        "WritingLevelId":{
            "title":"Writing",
            "type":"integer",
            "description":"ID assigned to the language writing proficiency.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WritingModelId":{
            "title":"Writing Rating Model",
            "type":"integer",
            "description":"ID assigned to the writing model of the language.",
            "format":"int64",
            "nullable":true,
            "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 : recruitingCECandidateLanguageItems-item-response

Type: object

Show Source

• AbleToTeachFlag: boolean
  Title: Able to Teach

  Maximum Length: 30

  Indicates if the candidate can teach the language.
• AbleToTranslateFlag: boolean
  Title: Able to Translate

  Maximum Length: 30

  Indicates if the candidate can translate the language.
• Comments: string (byte)
  Title: Comments

  Comments on the language items.
• ContentItemId: integer (int64)
  Title: Language

  Content Item ID in for the language items.
• EvaluatedOn: string (date)
  Title: Evaluated On

  Date of evaluation of the language item.
• EvaluationLocation: string
  Title: Evaluation Location

  Maximum Length: 240

  Location of evaluation of the language item.
• FlowVersionId: integer
  FlowVersionId is used for all the services to return the corresponding service metadata information.
• Language: string
  Maximum Length: 240

  Language known to the candidate.
• LanguageId: integer (int64)
  ID assigned to the language known to the candidate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NativeSpeakerFlag: boolean
  Title: Native

  Maximum Length: 30

  Indicates if the candidate is a native speaker of the language.
• ReadingLevelId: integer (int64)
  Title: Reading

  ID assigned to the language reading proficiency.
• ReadingModelId: integer (int64)
  Title: Reading Rating Model

  ID assigned to the reading model of the language.
• SectionId: integer (int64)
  Section ID in candidate language items.
• SpeakingLevelId: integer (int64)
  Title: Speaking

  ID assigned to the language speaking proficiency.
• SpeakingModelId: integer (int64)
  Title: Speaking Rating Model

  ID assigned to the speaking model of the language.
• SubmissionId: string
  Maximum Length: 255

  Unique ID which gets generated after the candidate submits a job request.
• WritingLevelId: integer (int64)
  Title: Writing

  ID assigned to the language writing proficiency.
• WritingModelId: integer (int64)
  Title: Writing Rating Model

  ID assigned to the writing model of the language.

{
    "type":"object",
    "properties":{
        "AbleToTeachFlag":{
            "title":"Able to Teach",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the candidate can teach the language.",
            "nullable":true,
            "x-queryable":true
        },
        "AbleToTranslateFlag":{
            "title":"Able to Translate",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the candidate can translate the language.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments on the language items.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ContentItemId":{
            "title":"Language",
            "type":"integer",
            "description":"Content Item ID in for the language items.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EvaluatedOn":{
            "title":"Evaluated On",
            "type":"string",
            "description":"Date of evaluation of the language item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EvaluationLocation":{
            "title":"Evaluation Location",
            "maxLength":240,
            "type":"string",
            "description":"Location of evaluation of the language item.",
            "nullable":true,
            "x-queryable":true
        },
        "FlowVersionId":{
            "type":"integer",
            "description":"FlowVersionId is used for all the services to return the corresponding service metadata information.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":240,
            "type":"string",
            "description":"Language known to the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "LanguageId":{
            "type":"integer",
            "description":"ID assigned to the language known to the candidate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NativeSpeakerFlag":{
            "title":"Native",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the candidate is a native speaker of the language.",
            "nullable":true,
            "x-queryable":true
        },
        "ReadingLevelId":{
            "title":"Reading",
            "type":"integer",
            "description":"ID assigned to the language reading proficiency.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReadingModelId":{
            "title":"Reading Rating Model",
            "type":"integer",
            "description":"ID assigned to the reading model of the language.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SectionId":{
            "type":"integer",
            "description":"Section ID in candidate language items.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SpeakingLevelId":{
            "title":"Speaking",
            "type":"integer",
            "description":"ID assigned to the language speaking proficiency.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SpeakingModelId":{
            "title":"Speaking Rating Model",
            "type":"integer",
            "description":"ID assigned to the speaking model of the language.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubmissionId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique ID which gets generated after the candidate submits a job request.",
            "nullable":true,
            "x-queryable":true
        },
        "WritingLevelId":{
            "title":"Writing",
            "type":"integer",
            "description":"ID assigned to the language writing proficiency.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WritingModelId":{
            "title":"Writing Rating Model",
            "type":"integer",
            "description":"ID assigned to the writing model of the language.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "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"
    }
}

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