Jump to

• Request
• Response

Update a translated document type

patch

/hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/translations/{translationsUniqID}

Request

Path Parameters

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

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

• CommentsLabel: string
  Title: New Label for Issuing Comments

  Maximum Length: 200

  Translated label for the field that the user defines for the issuing comments.
• DateFromLabel: string
  Title: New Label for From Date

  Maximum Length: 200

  Translated label for the field that the user defines for the from date.
• DateToLabel: string
  Title: New Label for To Date

  Maximum Length: 200

  Translated label for the field that the user defines for the to date.
• Description: string
  Maximum Length: 4000

  Translated description for the document type.
• DocumentNameLabel: string
  Title: New Label for Name

  Maximum Length: 200

  Translated label for the field that the user defines for the document name.
• DocumentNumberLabel: string
  Title: New Label for Number

  Maximum Length: 200

  Translated label for the field that the user defines for the document number.
• DocumentType: string
  Maximum Length: 80

  Translated name to uniquely identify the document type.
• IssuedDateLabel: string
  Title: New Label for Issued Date

  Maximum Length: 200

  Translated label for the field that the user defines for the issued date.
• IssuingAuthorityLabel: string
  Title: New Label for Issuing Authority

  Maximum Length: 200

  Translated label for the field that the user defines for the issuing authority.
• IssuingCountryLabel: string
  Title: New Label for Issuing Country

  Maximum Length: 200

  Translated label for the field that the user defines for the issuing country.
• IssuingLocationLabel: string
  Title: New Label for Issuing Location

  Maximum Length: 200

  Translated label for the field that the user defines for the issuing location.
• Language: string
  Maximum Length: 4

  Translated language of the document type.
• SourceLang: string
  Maximum Length: 4

  Source language of the document type.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":4000,
            "type":"string",
            "description":"Translated description for the document type.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "CommentsLabel":{
            "title":"New Label for Issuing Comments",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing comments.",
            "nullable":true
        },
        "DocumentNameLabel":{
            "title":"New Label for Name",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the document name.",
            "nullable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language of the document type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "DocumentType":{
            "maxLength":80,
            "type":"string",
            "description":"Translated name to uniquely identify the document type.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "IssuedDateLabel":{
            "title":"New Label for Issued Date",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issued date.",
            "nullable":true
        },
        "IssuingLocationLabel":{
            "title":"New Label for Issuing Location",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing location.",
            "nullable":true
        },
        "IssuingCountryLabel":{
            "title":"New Label for Issuing Country",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing country.",
            "nullable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Translated language of the document type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "DateToLabel":{
            "title":"New Label for To Date",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the to date.",
            "nullable":true
        },
        "DocumentNumberLabel":{
            "title":"New Label for Number",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the document number.",
            "nullable":true
        },
        "DateFromLabel":{
            "title":"New Label for From Date",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the from date.",
            "nullable":true
        },
        "IssuingAuthorityLabel":{
            "title":"New Label for Issuing Authority",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing authority.",
            "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(required):
  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(required):
  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 : hrDocumentTypes-translations-item-response

Type: object

Show Source

• CommentsLabel: string
  Title: New Label for Issuing Comments

  Maximum Length: 200

  Translated label for the field that the user defines for the issuing comments.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the translated document type.
• CreationDate: string (date-time)
  Read Only: true

  Date on which the translated document type was created.
• DateFromLabel: string
  Title: New Label for From Date

  Maximum Length: 200

  Translated label for the field that the user defines for the from date.
• DateToLabel: string
  Title: New Label for To Date

  Maximum Length: 200

  Translated label for the field that the user defines for the to date.
• Description: string
  Maximum Length: 4000

  Translated description for the document type.
• DocumentNameLabel: string
  Title: New Label for Name

  Maximum Length: 200

  Translated label for the field that the user defines for the document name.
• DocumentNumberLabel: string
  Title: New Label for Number

  Maximum Length: 200

  Translated label for the field that the user defines for the document number.
• DocumentType: string
  Maximum Length: 80

  Translated name to uniquely identify the document type.
• DocumentTypeId: integer (int64)
  Surrogate ID for the translated document type which is available only when updating existing records.
• IssuedDateLabel: string
  Title: New Label for Issued Date

  Maximum Length: 200

  Translated label for the field that the user defines for the issued date.
• IssuingAuthorityLabel: string
  Title: New Label for Issuing Authority

  Maximum Length: 200

  Translated label for the field that the user defines for the issuing authority.
• IssuingCountryLabel: string
  Title: New Label for Issuing Country

  Maximum Length: 200

  Translated label for the field that the user defines for the issuing country.
• IssuingLocationLabel: string
  Title: New Label for Issuing Location

  Maximum Length: 200

  Translated label for the field that the user defines for the issuing location.
• Language: string
  Maximum Length: 4

  Translated language of the document type.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the translated document type was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the translated document type.
• links: array Links
  Title: Links

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

  Source language of the document type.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the translated document type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date on which the translated document type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the translated document type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":4000,
            "type":"string",
            "description":"Translated description for the document type.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "CommentsLabel":{
            "title":"New Label for Issuing Comments",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing comments.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNameLabel":{
            "title":"New Label for Name",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the document name.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language of the document type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":80,
            "type":"string",
            "description":"Translated name to uniquely identify the document type.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "IssuedDateLabel":{
            "title":"New Label for Issued Date",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issued date.",
            "nullable":true,
            "x-queryable":true
        },
        "IssuingLocationLabel":{
            "title":"New Label for Issuing Location",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing location.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentTypeId":{
            "type":"integer",
            "description":"Surrogate ID for the translated document type which is available only when updating existing records.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "IssuingCountryLabel":{
            "title":"New Label for Issuing Country",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing country.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Translated language of the document type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "DateToLabel":{
            "title":"New Label for To Date",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the to date.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNumberLabel":{
            "title":"New Label for Number",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the document number.",
            "nullable":true,
            "x-queryable":true
        },
        "DateFromLabel":{
            "title":"New Label for From Date",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the from date.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IssuingAuthorityLabel":{
            "title":"New Label for Issuing Authority",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing authority.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the translated document type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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."
        }
    }
}

Links

LanguageLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/languagesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: SourceLang; Target Attribute: LanguageCode
• Display Attribute: Description

Back to Top