Jump to

• Request
• Response

Create translatable attribute values

post

/fscmRestApi/resources/11.13.18.05/itemTemplates/{itemTemplatesUniqID}/child/itemTranslations

Request

Path Parameters

• itemTemplatesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Item Templates resource and used to uniquely identify an instance of Item Templates. The client should not generate the hash key value. Instead, the client should query on the Item Templates collection resource in order to navigate to a specific instance of Item Templates 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• HTMLLongDescription: string
  Title: Formatted Description

  Maximum Length: 2147483647

  Formatted description in rich text or in HTML.
• ItemDescription: string
  Title: Item Description

  Maximum Length: 240

  Description of the part, item, product, or service.
• ItemId: integer (int64)
  Value that uniquely identifies the part, item, product, or service.
• Language: string
  Maximum Length: 4

  Language associated with item long description.
• LongDescription: string
  Title: Long Description

  Maximum Length: 4000

  Text description of the item.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• SourceLanguage: string
  Maximum Length: 4

  Language from which the values are translated.
• TemplateName: string
  Maximum Length: 960

  Name of the template.

{
    "type":"object",
    "properties":{
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Language from which the values are translated.",
            "nullable":false
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "description":"Text description of the item.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language associated with item long description.",
            "nullable":false
        },
        "HTMLLongDescription":{
            "title":"Formatted Description",
            "maxLength":2147483647,
            "type":"string",
            "description":"Formatted description in rich text or in HTML.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "TemplateName":{
            "maxLength":960,
            "type":"string",
            "description":"Name of the template.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the part, item, product, or service.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the part, item, product, or service.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"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 : itemTemplates-itemTranslations-item-response

Type: object

Show Source

• CreationDateTime: string (date-time)
  Read Only: true

  Date and time when the user created the item template.
• HTMLLongDescription: string
  Title: Formatted Description

  Maximum Length: 2147483647

  Formatted description in rich text or in HTML.
• ItemDescription: string
  Title: Item Description

  Maximum Length: 240

  Description of the part, item, product, or service.
• ItemId: integer (int64)
  Value that uniquely identifies the part, item, product, or service.
• Language: string
  Maximum Length: 4

  Language associated with item long description.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the item template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongDescription: string
  Title: Long Description

  Maximum Length: 4000

  Text description of the item.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• SourceLanguage: string
  Maximum Length: 4

  Language from which the values are translated.
• TemplateName: string
  Maximum Length: 960

  Name of the template.

{
    "type":"object",
    "properties":{
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Language from which the values are translated.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the item template.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "description":"Text description of the item.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the item template.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language associated with item long description.",
            "nullable":false,
            "x-queryable":true
        },
        "HTMLLongDescription":{
            "title":"Formatted Description",
            "maxLength":2147483647,
            "type":"string",
            "description":"Formatted description in rich text or in HTML.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "TemplateName":{
            "maxLength":960,
            "type":"string",
            "description":"Name of the template.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the part, item, product, or service.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the part, item, product, or service.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"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