Skip to main content

Get key info

POST 

/v2/projects/:projectId/keys/info

Returns information about keys. (KeyData, Screenshots, Translation in specified language)If key is not found, it's not included in the response.

Request

Path Parameters

    projectId int64required

Body

required
    keys object[]required
  • Array [
  • name stringrequired
    namespace string
  • ]
  • languageTags string[]required

    Tags to return language translations in

Responses

OK

Schema
    _embedded object
    keys object[]
  • Array [
  • custom objectrequired

    Custom values of the key

    property name* object

    Custom values of the key

    description string

    Description of key

    id int64required

    Id of key record

    isPlural booleanrequired

    If key is pluralized. If it will be reflected in the editor

    name stringrequired

    Name of key

    namespace string

    Namespace of key

    pluralArgName string

    The argument name for the plural

    screenshots object[]required

    Screenshots of the key

  • Array [
  • createdAt date-time
    fileUrl stringrequired
    filename stringrequired

    File name, which may be downloaded from the screenshot path.

    When images are secured. Encrypted timestamp is appended to the filename.

    height int32
    id int64required
    keyReferences object[]required
  • Array [
  • keyId int64required
    keyName stringrequired
    keyNamespace string
    originalText string
    position object
    height int32required
    width int32required
    x int32required
    y int32required
  • ]
  • location string
    middleSized string
    middleSizedUrl string
    thumbnail stringrequired

    Thumbnail file name, which may be downloaded from the screenshot path.

    When images are secured. Encrypted timestamp is appended to the filename.

    thumbnailUrl stringrequired
    width int32
  • ]
  • tags object[]required

    Tags of key

  • Array [
  • id int64required
    name stringrequired
  • ]
  • translations objectrequired

    Translations object containing values updated in this request

    property name* TranslationModel

    Translations object containing values updated in this request

    auto booleanrequired

    Was translated using Translation Memory or Machine translation service?

    id int64required

    Id of translation record

    mtProvider string

    Possible values: [GOOGLE, AWS, DEEPL, AZURE, BAIDU, TOLGEE]

    Which machine translation service was used to auto translate this

    outdated booleanrequired

    Whether base language translation was changed after this translation was updated

    state stringrequired

    Possible values: [UNTRANSLATED, TRANSLATED, REVIEWED, DISABLED]

    State of translation

    text string

    Translation text

  • ]
Loading...