REST API Services for CPQ Cloud

Get Menu Item Translations

get

/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}/translations

This service returns all language translations for a menu item.

Request

Path Parameters

attributeVarName: string

Attribute Variable Name
docVarName: string

Document Variable Name
menuItemId: string

Menu Item Id
processVarName: string

Process Variable Name

Response

Default Response

Root Schema : CommerceMenuItemTranslations-collection

Type: object

Show Source

items(optional): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CommerceMenuItemTranslation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object CommerceMenuItemTranslation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CommerceMenuItemTranslation"
    }
}

Nested Schema : CommerceMenuItemTranslation

Type: object

Show Source

displayValue(optional): string

Title: Display Text

Menu Item Display Text
language(optional): object language
links(optional): object menuItemTranslationLinks

{
    "properties":{
        "displayValue":{
            "title":"Display Text",
            "type":"string",
            "description":"Menu Item Display Text"
        },
        "language":{
            "properties":{
                "languageNumber":{
                    "title":"Language Number",
                    "type":"integer",
                    "description":"Unique language number."
                },
                "languageCode":{
                    "title":"Language Code",
                    "type":"string",
                    "description":"Unique language code "
                }
            }
        },
        "links":{
            "$ref":"#/definitions/menuItemTranslationLinks"
        }
    }
}

Nested Schema : language

Type: object

Show Source

languageCode(optional): string

Title: Language Code

Unique language code
languageNumber(optional): integer

Title: Language Number

Unique language number.

{
    "properties":{
        "languageNumber":{
            "title":"Language Number",
            "type":"integer",
            "description":"Unique language number."
        },
        "languageCode":{
            "title":"Language Code",
            "type":"string",
            "description":"Unique language code "
        }
    }
}

Nested Schema : menuItemTranslationLinks

Type: object

Show Source

parent(optional): string

Link to parent Commerce process document attribute menu item.

{
    "properties":{
        "parent":{
            "description":"Link to parent Commerce process document attribute menu item.",
            "type":"string"
        }
    }
}

Examples

The following example shows how to retrieve translations for a menu item by submitting a GET request to the REST resource using cURl. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/paymentTerms_t/menuItems/36244405/translations