Jump to

• Request
• Response

Update a product group translation - Not Supported

patch

/crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/ProductGroupTranslation/{ProductGroupTranslationUniqID}

Request

Path Parameters

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

• Language: string
  Maximum Length: 4

  The language in which the product group is translated.
• ProdGroupDescription: string
  Title: Description

  Maximum Length: 1000

  The translated description of the product group.
• ProdGroupId: integer (int64)
  The unique identifier of the product group.
• ProdGroupName: string
  Title: Product Group

  Maximum Length: 250

  The translated name of the product group.

{
    "type":"object",
    "properties":{
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"The language in which the product group is translated.",
            "nullable":false
        },
        "ProdGroupDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The translated description of the product group.",
            "nullable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProdGroupName":{
            "title":"Product Group",
            "maxLength":250,
            "type":"string",
            "description":"The translated name of the product group.",
            "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 : catalogProductGroups-ProductGroupTranslation-item-response

Type: object

Show Source

• ISOLanguage: string
  Read Only: true

  Maximum Length: 2

  The ISO language associated with the product group like English or Danish.
• ISOTerritory: string
  Title: Territory

  Read Only: true

  Maximum Length: 2

  The code associated with the ISO territory.
• Language: string
  Maximum Length: 4

  The language in which the product group is translated.
• LanguageCode: string
  Title: Language Code

  Read Only: true

  Maximum Length: 4

  The language code associated with the product group like 639-1en (English) or 639-1da (Danish).
• links: array Links
  Title: Links

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

  Maximum Length: 1000

  The translated description of the product group.
• ProdGroupId: integer (int64)
  The unique identifier of the product group.
• ProdGroupName: string
  Title: Product Group

  Maximum Length: 250

  The translated name of the product group.

{
    "type":"object",
    "properties":{
        "ISOLanguage":{
            "maxLength":2,
            "type":"string",
            "description":"The ISO language associated with the product group like English or Danish.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ISOTerritory":{
            "title":"Territory",
            "maxLength":2,
            "type":"string",
            "description":"The code associated with the ISO territory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"The language in which the product group is translated.",
            "nullable":false,
            "x-queryable":true
        },
        "LanguageCode":{
            "title":"Language Code",
            "maxLength":4,
            "type":"string",
            "description":"The language code associated with the product group like 639-1en (English) or 639-1da (Danish).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGroupDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The translated description of the product group.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProdGroupName":{
            "title":"Product Group",
            "maxLength":250,
            "type":"string",
            "description":"The translated name of the product group.",
            "nullable":true,
            "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