Jump to

• Request
• Response

Update an event translation

patch

/hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails/{EventId}/child/eventTranslation/{eventTranslationUniqID}

Request

Path Parameters

• EventId(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=
• eventTranslationUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- EventId and Language ---for the Event Translations resource and used to uniquely identify an instance of Event Translations. The client should not generate the hash key value. Instead, the client should query on the Event Translations collection resource with a filter on the primary key values in order to navigate to a specific instance of Event Translations.
  
  For example: eventTranslation?q=EventId=<value1>;Language=<value2>

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

• EventDescHtml: string (byte)
  HTML description of the event translation.
• EventName: string
  Maximum Length: 240

  Name of the event in the translation.
• EventNotes: string
  Maximum Length: 1000

  Notes associated with the event translation.
• EventPurpose: string
  Maximum Length: 500

  Purpose of the event in the translation.
• EventShortDesc: string (byte)
  Short description of the event in the translation.
• SourceLang: string
  Maximum Length: 4

  Source language for the event translation.

{
    "type":"object",
    "properties":{
        "EventDescHtml":{
            "type":"string",
            "description":"HTML description of the event translation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language for the event translation.",
            "nullable":false
        },
        "EventName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the event in the translation.",
            "nullable":true
        },
        "EventShortDesc":{
            "type":"string",
            "description":"Short description of the event in the translation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "EventNotes":{
            "maxLength":1000,
            "type":"string",
            "description":"Notes associated with the event translation.",
            "nullable":true
        },
        "EventPurpose":{
            "maxLength":500,
            "type":"string",
            "description":"Purpose of the event in the translation.",
            "nullable":true
        }
    }
}

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 : recruitingUIEventDetails-eventTranslation-item-response

Type: object

Show Source

• EventDescHtml: string (byte)
  HTML description of the event translation.
• EventId: integer (int64)
  Unique identifier for the event in translations.
• EventName: string
  Maximum Length: 240

  Name of the event in the translation.
• EventNotes: string
  Maximum Length: 1000

  Notes associated with the event translation.
• EventPurpose: string
  Maximum Length: 500

  Purpose of the event in the translation.
• EventShortDesc: string (byte)
  Short description of the event in the translation.
• Language: string
  Maximum Length: 4

  Language code for the event translation.
• LanguageDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the language for the event translation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceLang: string
  Maximum Length: 4

  Source language for the event translation.
• SourceLanguageDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the source language for the event translation.

{
    "type":"object",
    "properties":{
        "EventDescHtml":{
            "type":"string",
            "description":"HTML description of the event translation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LanguageDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the language for the event translation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language code for the event translation.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language for the event translation.",
            "nullable":false,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Unique identifier for the event in translations.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "EventName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the event in the translation.",
            "nullable":true,
            "x-queryable":true
        },
        "EventShortDesc":{
            "type":"string",
            "description":"Short description of the event in the translation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "EventNotes":{
            "maxLength":1000,
            "type":"string",
            "description":"Notes associated with the event translation.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLanguageDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the source language for the event translation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventPurpose":{
            "maxLength":500,
            "type":"string",
            "description":"Purpose of the event in the translation.",
            "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