Jump to

• Request
• Response

Update one translation

patch

/fscmRestApi/resources/11.13.18.05/unitsOfMeasure/{UOMCode}/child/translatedData/{translatedDataUniqID}

Request

Path Parameters

• UOMCode(required): string
  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=
• translatedDataUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Translated Data for Units of Measure resource and used to uniquely identify an instance of Translated Data for Units of Measure. The client should not generate the hash key value. Instead, the client should query on the Translated Data for Units of Measure collection resource in order to navigate to a specific instance of Translated Data for Units of Measure to get the hash key.

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

• Description: string
  Title: Description

  Maximum Length: 50

  Description of the unit of measure.
• Language: string
  Maximum Length: 4

  Indicates the code of the language into which the contents of the translatable columns are translated.
• SourceLang: string
  Maximum Length: 4

  Indicates the code of the language in which the contents of the translatable columns were originally created.
• UnitOfMeasure: string
  Title: UOM Name

  Maximum Length: 25

  Name of the unit of measure.
• UOMPluralDescription: string
  Title: Plural Description

  Maximum Length: 50

  Description of the plural value of the unit of measure. For example: Feet is the plural value for the Foot unit of measure.
• UOMReciprocalDescription: string
  Title: Reciprocal Description

  Maximum Length: 50

  Description of how to process the unit of measure so that the quantity that results from dividing it equals one. For example: Per Month is the reciprocal display for a service that uses the Month unit of measure.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":50,
            "type":"string",
            "description":"Description of the unit of measure.",
            "nullable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Indicates the code of the language into which the contents of the translatable columns are translated.",
            "nullable":false
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Indicates the code of the language in which the contents of the translatable columns were originally created.",
            "nullable":false
        },
        "UOMPluralDescription":{
            "title":"Plural Description",
            "maxLength":50,
            "type":"string",
            "description":"Description of the plural value of the unit of measure. For example: Feet is the plural value for the Foot unit of measure.",
            "nullable":true
        },
        "UOMReciprocalDescription":{
            "title":"Reciprocal Description",
            "maxLength":50,
            "type":"string",
            "description":"Description of how to process the unit of measure so that the quantity that results from dividing it equals one. For example: Per Month is the reciprocal display for a service that uses the Month unit of measure.",
            "nullable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":false
        }
    }
}

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 : unitsOfMeasure-translatedData-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 50

  Description of the unit of measure.
• Language: string
  Maximum Length: 4

  Indicates the code of the language into which the contents of the translatable columns are translated.
• links: array Links
  Title: Links

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

  Indicates the code of the language in which the contents of the translatable columns were originally created.
• UnitOfMeasure: string
  Title: UOM Name

  Maximum Length: 25

  Name of the unit of measure.
• UOMPluralDescription: string
  Title: Plural Description

  Maximum Length: 50

  Description of the plural value of the unit of measure. For example: Feet is the plural value for the Foot unit of measure.
• UOMReciprocalDescription: string
  Title: Reciprocal Description

  Maximum Length: 50

  Description of how to process the unit of measure so that the quantity that results from dividing it equals one. For example: Per Month is the reciprocal display for a service that uses the Month unit of measure.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":50,
            "type":"string",
            "description":"Description of the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Indicates the code of the language into which the contents of the translatable columns are translated.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Indicates the code of the language in which the contents of the translatable columns were originally created.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMPluralDescription":{
            "title":"Plural Description",
            "maxLength":50,
            "type":"string",
            "description":"Description of the plural value of the unit of measure. For example: Feet is the plural value for the Foot unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMReciprocalDescription":{
            "title":"Reciprocal Description",
            "maxLength":50,
            "type":"string",
            "description":"Description of how to process the unit of measure so that the quantity that results from dividing it equals one. For example: Per Month is the reciprocal display for a service that uses the Month unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":false,
            "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