Jump to

• Request
• Response
• Examples

Get Price Book Translation

get

/rest/v16/priceBooks/{variableName}/translations

This action retrieves translations for the specified Price Book.

Request

Path Parameters

• variableName(required): string
  Unique name for price book

Back to Top

Response

Default Response

Body ()

Root Schema : priceBookTranslations-collection

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object priceBookTranslations

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

Nested Schema : priceBookTranslations

Type: object

Show Source

• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• description: string
  Title: Description

  Translated description of the pricebook
• id: integer
  Title: Id

  Primary Key of pricebook translations
• language: object Language
  Title: Language

  The defined language of the rows translated columns.
• name: string
  Title: Name

  Translated name of the pricebook

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "title":"Date Added",
            "type":"string",
            "description":"System field indicating the date on which the Resource was created."
        },
        "dateModified":{
            "title":"Date Modified",
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified."
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"Translated description of the pricebook"
        },
        "id":{
            "title":"Id",
            "type":"integer",
            "description":"Primary Key of pricebook translations"
        },
        "language":{
            "title":"Language",
            "type":"object",
            "description":"The defined language of the rows translated columns.",
            "properties":{
                "languageNumber":{
                    "title":"Language Number",
                    "type":"integer",
                    "description":"Unique language number."
                },
                "id":{
                    "title":"Id",
                    "type":"integer",
                    "description":"Primary Key of the language resource."
                }
            }
        },
        "name":{
            "title":"Name",
            "type":"string",
            "description":"Translated name of the pricebook"
        }
    }
}

Nested Schema : Language

Type: object

Title: Language

The defined language of the rows translated columns.

Show Source

• id: integer
  Title: Id

  Primary Key of the language resource.
• languageNumber: integer
  Title: Language Number

  Unique language number.

{
    "title":"Language",
    "type":"object",
    "description":"The defined language of the rows translated columns.",
    "properties":{
        "languageNumber":{
            "title":"Language Number",
            "type":"integer",
            "description":"Unique language number."
        },
        "id":{
            "title":"Id",
            "type":"integer",
            "description":"Primary Key of the language resource."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve a specified Price Book translation 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 "Accept: application/json"
https://sitename.oracle.com/rest/v16/priceBooks/{variableName}/translations

Response Body Sample

{
   "hasMore": false,
   "links": [{
         "rel": "self",
         "href": "rest/v12/priceBooks"
      }
   ],
   "items": [{
         "orderNumber": 3,
         "variableName": "pricebook7",
         "name": "Pricebook 7: Inactive",
         "description": null,
         "dateModified": "2016-05-11T22:05:44.000Z",
         "id": 16266872,
         "dateAdded": "2013-09-20T20:21:02.000Z",
         "status": {
            "lookupCode": "3",
            "displayValue": "Inactive",
            "id": 21209454,
            "links": [{
                  "rel": "domain",
                  "href": "/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22PRICEBOOK_STATUS_TYPE%22%7D%7D"
               }, {
                  "rel": "canonical",
                  "href": "/rest/v16/lookupValues/21209454"
               }
            ]
         },
         "links": [{
               "rel": "self",
               "href": "/rest/v16/priceBooks/pricebook7"
            }, {
               "kind": "",
               "rel": "child",
               "name": "translations",
               "href": "/rest/v16/priceBooks/pricebook7/translations"
            }
         ]
      }, {
         "orderNumber": 2,
         ...
      }, {
         "orderNumber": 1,
         ...
      }
   ]
} 
         

Back to Top