Jump to

• Request
• Response
• Examples

Get All Part Translations

get

/rest/v16/partSetups/{id}/translations

Use this endpoint to retrieve all translations for the specified CPQ part.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  The unique identifier for the part.

Query Parameters

• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Allows to specify one or more filtering criteria. By default, no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Part Translation Collection Definitions

Type: object

Title: Part Translation Collection Definitions

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/partSetupTranslations"
            }
        }
    },
    "title":"Part Translation Collection Definitions"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Part Translation Setup Instance Definitions
  Title: Part Translation Setup Instance Definitions

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

Nested Schema : Part Translation Setup Instance Definitions

Type: object

Title: Part Translation Setup Instance Definitions

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: Translated description

  Translated description of the part.
• id: integer
  Title: Id

  Identifier for the resource
• language: object Language
  Title: Language

  The defined language of the rows translated columns.
• units: string
  Title: Translated Units

  Translated units of the part

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "description":{
            "type":"string",
            "description":"Translated description of the part.",
            "title":"Translated description"
        },
        "id":{
            "type":"integer",
            "description":"Identifier for the resource",
            "title":"Id"
        },
        "language":{
            "type":"object",
            "description":"The defined language of the rows translated columns.",
            "title":"Language",
            "properties":{
                "languageNumber":{
                    "type":"integer",
                    "description":"Unique language number.",
                    "title":"Language Number"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the language resource.",
                    "title":"Id"
                },
                "languageCode":{
                    "type":"string",
                    "description":"Unique language code",
                    "title":"Language Code"
                }
            }
        },
        "units":{
            "type":"string",
            "description":"Translated units of the part",
            "title":"Translated Units"
        }
    },
    "title":"Part Translation Setup Instance Definitions"
}

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.
• languageCode: string
  Title: Language Code

  Unique language code
• languageNumber: integer
  Title: Language Number

  Unique language number.

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

Back to Top

Examples

The following example shows how to retrieve all translations for the specified CPQ part 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"
http://sitename.oracle.com/rest/v16/partSetups/38644116/translations

Response Body

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116/translations"
    }
  ],
  "items": [{
      "description": "L'entretien Premium couvre les inspections multipoints, ainsi que les soins prventifs et le remplacement des lments normaux d'usure normale qui ncessitent une attention priodique.",
      "dateModified": "2023-03-02T21:31:55.000Z",
      "language": {
        "languageNumber": 1,
        "languageCode": "fr",
        "id": 36329904,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com/rest/v16/languages"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v16/languages/36329904"
          }
        ]
      },
      "id": 38818015,
      "units": null,
      "dateAdded": "2023-03-02T21:31:55.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116/translations/38818015"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116"
        }
      ]
    }, {
      "description": "Die Premium-Wartung umfasst Mehrpunktinspektionen sowie die vorbeugende Pflege und den Austausch normaler Verschleißteile, die regelmßig gewartet werden müssen.",
      "dateModified": "2023-03-02T21:31:55.000Z",
      "language": {
        "languageNumber": 0,
        "languageCode": "de",
        "id": 36329903,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com/rest/v16/languages"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v16/languages/36329903"
          }
        ]
      },
      "id": 38818016,
      "units": null,
      "dateAdded": "2023-03-02T21:31:55.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116/translations/38818016"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116"
        }
      ]
    }
  ]
}

Back to Top