Skip to main content

Import keys (resolvable)

POST 

/v2/projects/:projectId/keys/import-resolvable

Import's new keys with translations. Translations can be updated, when specified.

Request

Path Parameters

    projectId int64required

Body

required
    keys object[]required
  • Array [
  • name stringrequired

    Key name to set translations for

    namespace string

    The namespace of the key. (When empty or null default namespace will be used)

    screenshots object[]
  • Array [
  • text string
    uploadedImageId int64required

    Ids of screenshot uploaded with /v2/image-upload endpoint

    positions object[]
  • Array [
  • x int32required
    y int32required
    width int32required
    height int32required
  • ]
  • ]
  • translations objectrequired

    Object mapping language tag to translation

    property name* ImportTranslationResolvableDto

    Object mapping language tag to translation

    text stringrequired

    Translation text

    resolution stringrequired

    Possible values: [KEEP, OVERRIDE, NEW]

    Determines, how conflict is resolved.

    • KEEP: Translation is not changed
    • OVERRIDE: Translation is overridden
    • NEW: New translation is created)
  • ]

Responses

OK

Schema
    keys object[]required

    List of keys

  • Array [
  • id int64required

    Id of key record

    name stringrequired

    Name of key

    namespace string

    Namespace of key

    description string

    Description of key

    custom object

    Custom values of the key

    property name* object

    Custom values of the key

  • ]
  • screenshots objectrequired

    Map uploadedImageId to screenshot

    property name* ScreenshotModel

    Screenshots of the key

    id int64required
    filename stringrequired

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

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

    thumbnail stringrequired

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

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

    fileUrl stringrequired
    thumbnailUrl stringrequired
    createdAt date-time
    keyReferences object[]required
  • Array [
  • keyId int64required
    position object
    x int32required
    y int32required
    width int32required
    height int32required
    keyName stringrequired
    keyNamespace string
    originalText string
  • ]
  • location string
    width int32
    height int32
Loading...