Jump to

• Request
• Response
• Examples

Submit all recruiting job requisitions languages

post

/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/languages

Request

Path Parameters

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

Header Parameters

• 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

• IsDefaultFlag: boolean
  Maximum Length: 1

  Is Default indicator in recruiting job requisitions languages.
• LanguageCode: string
  Maximum Length: 4

  Language Code in recruiting job requisitions languages.
• LanguageId: integer (int64)
  Language ID in recruiting job requisitions languages.

{
    "type":"object",
    "properties":{
        "LanguageCode":{
            "maxLength":"4",
            "type":"string",
            "description":"Language Code in recruiting job requisitions languages.",
            "nullable":false
        },
        "IsDefaultFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Is Default indicator in recruiting job requisitions languages.",
            "nullable":true
        },
        "LanguageId":{
            "type":"integer",
            "description":"Language ID in recruiting job requisitions languages.",
            "format":"int64",
            "nullable":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 : recruitingJobRequisitions-languages-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Language used for creating the requisition.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Creation Date in recruiting job requisitions languages.
• IsDefaultFlag: boolean
  Maximum Length: 1

  Is Default indicator in recruiting job requisitions languages.
• LanguageCode: string
  Maximum Length: 4

  Language Code in recruiting job requisitions languages.
• LanguageId: integer (int64)
  Language ID in recruiting job requisitions languages.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Last Update Date in recruiting job requisitions languages.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Last Update using in recruiting job requisitions languages.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Last Update using in recruiting job requisitions languages.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation Date in recruiting job requisitions languages.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LanguageCode":{
            "maxLength":"4",
            "type":"string",
            "description":"Language Code in recruiting job requisitions languages.",
            "nullable":false,
            "x-queryable":true
        },
        "IsDefaultFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Is Default indicator in recruiting job requisitions languages.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Language used for creating the requisition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LanguageId":{
            "type":"integer",
            "description":"Language ID in recruiting job requisitions languages.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Last Update Date in recruiting job requisitions languages.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

Examples

The following example shows how to create a language for a job requisition by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>"  -X POST -d <payload> http://host:port/hcmCoreApi/resources/11.13.18.05/recruitingJobRequisitions/PR_REQ_501/child/languages

Example of Payload

The following is an example of the payload.

{
"LanguageCode": "KO3",
"IsDefaultFlag": false
}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK                                                      
Content-Type : application/octet-stream

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "LanguageId": 300100172451542,
    "LanguageCode": "KO3",
    "IsDefaultFlag": false,
    "CreatedBy": "ZFRCE001_Marian_ZBEN",
    "CreationDate": "2019-01-18T22:19:02+00:00",
    "LastUpdatedBy": "ZFRCE001_Marian_ZBEN",
    "LastUpdateDate": "2019-01-18T22:19:02.012+00:00",
    "links": [3]
        {...
	...}
}

Back to Top