REST API Services for CPQ Cloud

Get Attribute Translation

get

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

This service returns the specified language translation for an attribute.

Request

Path Parameters

attributeVarName: string

Attribute Variable Name
docVarName: string

Document Variable Name
languageCode: string

Language Code for the requested language
processVarName: string

Process Variable Name

Response

Default Response

Root Schema : CommerceAttributeTranslation

Type: object

Show Source

defaultData(optional): object Default

Title: Default

Default
description(optional): string

Title: Description

Description
label(optional): string

Title: Label

Label
language(optional): object language
links(optional): object attributeTranslationLinks

{
    "properties":{
        "defaultData":{
            "title":"Default",
            "description":"Default",
            "type":"object",
            "properties":{
                "userDefault":{
                    "title":"User Default",
                    "type":"string",
                    "description":"User Default"
                }
            }
        },
        "description":{
            "title":"Description",
            "description":"Description",
            "type":"string"
        },
        "label":{
            "title":"Label",
            "description":"Label",
            "type":"string"
        },
        "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/attributeTranslationLinks"
        }
    }
}

Nested Schema : Default

Type: object

Title: Default

Default

Show Source

userDefault(optional): string

Title: User Default

User Default

{
    "title":"Default",
    "description":"Default",
    "type":"object",
    "properties":{
        "userDefault":{
            "title":"User Default",
            "type":"string",
            "description":"User Default"
        }
    }
}

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 : attributeTranslationLinks

Type: object

Show Source

parent(optional): string

Link to parent Commerce process document attribute.

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

Examples

The following example shows how to retrieve the specified translation for an attribute 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/_customer_t_email/translations/de

Response Body Sample

{
   "language": {"languageCode": "fr", "languageNumber": 1},
   "links": [{
         "rel": "self",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/actionDefs/_update_line_items/translations/fr"
      }, {
         "rel": "parent",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/actionDefs/_update_line_items"
      }
   ],
   "label": "Mettre ?? jour les lignes de revenu",
   "description": "Action par d??faut de mise ?? jour des lignes de revenu"
}