Jump to

• Request
• Response

Get List of Model Action Translations

get

/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions/{actionVarName}/translations

Use this endpoint to retrieve all translactions for the specified Model action.

Request

Supported Media Types

• application/json

Path Parameters

• actionVarName(required): string
  Variable Name of the action.
• modelVarName(required): string
  Variable Name of the Model.
• prodFamVarName(required): string
  Variable Name of the Product Family.
• prodLineVarName(required): string
  Variable Name of the Product Line
• varName(required): string
  Variable Name of All Product Families '_allProductFamilies'

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 : configActionTranslations-collection

Type: object

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/configActionTranslations"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Config Action Translations
  Title: Config Action Translations

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

Nested Schema : Config Action Translations

Type: object

Title: Config Action Translations

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 Config Action Description

  Translated Description of the Config action.
• id: integer
  Title: Id

  Identifier for the resource
• label: string
  Title: Translated Config Action Label

  Translated Label of the Config action.
• language: object Language
  Title: Language

  The defined language of the rows translated columns.

{
    "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 Config action.",
            "title":"Translated Config Action Description"
        },
        "id":{
            "type":"integer",
            "description":"Identifier for the resource",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Translated Label of the Config action.",
            "title":"Translated Config Action Label"
        },
        "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"
                }
            }
        }
    },
    "title":"Config Action Translations"
}

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