Import, export & tags schemas
These definitions are generated from the downloadable OpenAPI contract. Required fields, validation constraints and additional-property policies are preserved.
ImportOptions
Section titled “ImportOptions”| Field | Type | Required | Constraints / description |
|---|---|---|---|
files |
Array of object | Yes | minItems: 1; maxItems: 20 |
strategy |
fill, overwrite |
No | default: "fill" |
clearEmpty |
boolean | No | default: false |
mappings |
object | No | default: {} |
parameterMappings |
object | No | default: {} |
contracts |
object | No | default: {} |
tagIds |
Array of string | No | maxItems: 20; default: [] |
confirmContracts |
boolean | No | default: false |
confirmWarnings |
boolean | No | default: false |
{ "type": "object", "properties": { "files": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "format": { "type": "string", "enum": [ "android", "apple-strings", "apple-stringsdict", "apple-xcstrings", "arb", "po", "pot", "xliff12", "xliff20", "json", "properties", "yaml", "resx", "csv", "xlsx", "xls" ] }, "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "group": { "default": "messages", "type": "string", "minLength": 1, "maxLength": 100 }, "encoding": { "default": "utf8", "type": "string", "enum": [ "utf8", "latin1" ] }, "sheet": { "type": "string", "maxLength": 100 }, "keyColumn": { "default": "key", "type": "string", "maxLength": 100 }, "columns": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "type": "string", "minLength": 2, "maxLength": 255 } }, "messageFormat": { "default": "plain", "type": "string", "enum": [ "plain", "icu" ] }, "csvProfile": { "default": "raw", "type": "string", "enum": [ "raw", "spreadsheet-safe" ] } }, "required": [ "fileId", "format" ], "additionalProperties": false } }, "strategy": { "default": "fill", "type": "string", "enum": [ "fill", "overwrite" ] }, "clearEmpty": { "default": false, "type": "boolean" }, "mappings": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 1000 }, "additionalProperties": { "type": "string", "maxLength": 1000 } }, "parameterMappings": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 1000 }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,99}$" }, "additionalProperties": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,99}$" } } }, "contracts": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 1000 }, "additionalProperties": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "plain", "icu" ] }, "parameters": { "maxItems": 32, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,99}$" }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ], "additionalProperties": false } } }, "required": [ "format", "parameters" ], "additionalProperties": false } }, "tagIds": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "confirmContracts": { "default": false, "type": "boolean" }, "confirmWarnings": { "default": false, "type": "boolean" } }, "required": [ "files" ], "additionalProperties": false}ExportOptions
Section titled “ExportOptions”| Field | Type | Required | Constraints / description |
|---|---|---|---|
format |
android, apple-strings, apple-stringsdict, apple-xcstrings, arb, po, pot, xliff12, xliff20, json, properties, yaml, resx, csv, xlsx, xls |
Yes | — |
locales |
Array of string | Yes | minItems: 1; maxItems: 50000 |
missing |
empty, omit, source |
No | default: "empty" |
status |
active, archived, all |
No | default: "active" |
includeInactive |
boolean | No | default: false |
includeTags |
Array of string | No | maxItems: 20; default: [] |
excludeTags |
Array of string | No | maxItems: 20; default: [] |
group |
string | No | minLength: 1; maxLength: 100; default: "messages" |
nested |
boolean | No | default: false |
nativeMappings |
object | No | default: {} |
mappings |
object | No | default: {} |
csvProfile |
raw, spreadsheet-safe |
No | default: "spreadsheet-safe" |
{ "type": "object", "properties": { "format": { "type": "string", "enum": [ "android", "apple-strings", "apple-stringsdict", "apple-xcstrings", "arb", "po", "pot", "xliff12", "xliff20", "json", "properties", "yaml", "resx", "csv", "xlsx", "xls" ] }, "locales": { "minItems": 1, "maxItems": 50000, "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 255 } }, "missing": { "default": "empty", "type": "string", "enum": [ "empty", "omit", "source" ] }, "status": { "default": "active", "type": "string", "enum": [ "active", "archived", "all" ] }, "includeInactive": { "default": false, "type": "boolean" }, "includeTags": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "excludeTags": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "group": { "default": "messages", "type": "string", "minLength": 1, "maxLength": 100 }, "nested": { "default": false, "type": "boolean" }, "nativeMappings": { "default": {}, "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 200 }, "additionalProperties": { "type": "object", "properties": { "argumentOrder": { "maxItems": 32, "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,99}$" } }, "pluralId": { "type": "string", "minLength": 1, "maxLength": 1000 }, "context": { "type": "string", "maxLength": 1000 } }, "required": [ "argumentOrder" ], "additionalProperties": false } }, "mappings": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 1000 }, "additionalProperties": { "type": "string", "maxLength": 1000 } }, "csvProfile": { "default": "spreadsheet-safe", "type": "string", "enum": [ "raw", "spreadsheet-safe" ] } }, "required": [ "format", "locales" ], "additionalProperties": false}Transfer
Section titled “Transfer”| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
workspaceId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
projectId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
branchId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
kind |
import, export |
Yes | — |
state |
mapping, queued, processing, ready, applying, completed, failed, conflict, cancelled, expired |
Yes | — |
revision |
integer | Yes | maximum: 9007199254740991 |
options |
See schema | Yes | — |
files |
Array of object | Yes | — |
discovery |
Array of object | Yes | — |
summary |
object | Yes | — |
artifact |
See schema | Yes | — |
errorCode |
string or null | Yes | — |
createdAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
updatedAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
expiresAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workspaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "branchId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": [ "import", "export" ] }, "state": { "type": "string", "enum": [ "mapping", "queued", "processing", "ready", "applying", "completed", "failed", "conflict", "cancelled", "expired" ] }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "options": {}, "files": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "name", "size" ] } }, "discovery": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sheets": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "string" } } }, "required": [ "fileId", "sheets", "columns" ] } }, "summary": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "artifact": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contentType": { "type": "string" } }, "required": [ "name", "size", "contentType" ] }, { "type": "null" } ] }, "errorCode": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "workspaceId", "projectId", "branchId", "kind", "state", "revision", "options", "files", "discovery", "summary", "artifact", "errorCode", "createdAt", "updatedAt", "expiresAt" ]}TransferPage
Section titled “TransferPage”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | — |
page |
integer | Yes | maximum: 9007199254740991 |
pageSize |
integer | Yes | maximum: 9007199254740991 |
hasMore |
boolean | Yes | — |
{ "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workspaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "branchId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": [ "import", "export" ] }, "state": { "type": "string", "enum": [ "mapping", "queued", "processing", "ready", "applying", "completed", "failed", "conflict", "cancelled", "expired" ] }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "options": {}, "files": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "name", "size" ] } }, "discovery": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sheets": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "string" } } }, "required": [ "fileId", "sheets", "columns" ] } }, "summary": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "artifact": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contentType": { "type": "string" } }, "required": [ "name", "size", "contentType" ] }, { "type": "null" } ] }, "errorCode": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "workspaceId", "projectId", "branchId", "kind", "state", "revision", "options", "files", "discovery", "summary", "artifact", "errorCode", "createdAt", "updatedAt", "expiresAt" ] } }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ]}| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
name |
string | Yes | — |
version |
integer | Yes | maximum: 9007199254740991 |
usageCount |
integer | Yes | minimum: 0; maximum: 9007199254740991 |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "usageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "name", "version", "usageCount" ]}TagPage
Section titled “TagPage”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | — |
page |
integer | Yes | maximum: 9007199254740991 |
pageSize |
integer | Yes | maximum: 9007199254740991 |
hasMore |
boolean | Yes | — |
{ "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "usageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "name", "version", "usageCount" ] } }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ]}Preview
Section titled “Preview”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | — |
page |
integer | Yes | maximum: 9007199254740991 |
pageSize |
integer | Yes | maximum: 9007199254740991 |
hasMore |
boolean | Yes | — |
revision |
integer | Yes | maximum: 9007199254740991 |
summary |
object | Yes | — |
{ "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "object", "properties": { "before": { "type": "object", "properties": { "description": { "type": "string" }, "notes": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200 }, "format": { "type": "string", "enum": [ "arb", "apple-xcstrings", "xliff12", "xliff20", "po", "pot", "resx", "android", "apple-strings", "apple-stringsdict", "properties", "yaml", "csv", "xlsx", "xls" ] }, "scope": { "type": "string", "enum": [ "file", "key", "locale", "parameter" ] }, "kind": { "type": "string", "minLength": 1, "maxLength": 100 }, "locale": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 255 }, { "type": "null" } ] }, "parameter": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "text": { "type": "string" }, "attributes": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.:-]*$" }, "additionalProperties": { "type": "string" } } }, "required": [ "id", "format", "scope", "kind", "locale", "parameter", "text" ], "additionalProperties": false } }, "images": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "id", "alt" ], "additionalProperties": false } } }, "required": [ "description", "notes" ], "additionalProperties": false }, "after": { "type": "object", "properties": { "description": { "type": "string" }, "notes": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200 }, "format": { "type": "string", "enum": [ "arb", "apple-xcstrings", "xliff12", "xliff20", "po", "pot", "resx", "android", "apple-strings", "apple-stringsdict", "properties", "yaml", "csv", "xlsx", "xls" ] }, "scope": { "type": "string", "enum": [ "file", "key", "locale", "parameter" ] }, "kind": { "type": "string", "minLength": 1, "maxLength": 100 }, "locale": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 255 }, { "type": "null" } ] }, "parameter": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "text": { "type": "string" }, "attributes": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.:-]*$" }, "additionalProperties": { "type": "string" } } }, "required": [ "id", "format", "scope", "kind", "locale", "parameter", "text" ], "additionalProperties": false } }, "images": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "id", "alt" ], "additionalProperties": false } } }, "required": [ "description", "notes" ], "additionalProperties": false } }, "required": [ "before", "after" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "definition": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "plain", "icu" ] }, "parameters": { "maxItems": 32, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,99}$" }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ], "additionalProperties": false } }, "name": { "type": "string" } }, "required": [ "format", "parameters", "name" ], "additionalProperties": false }, "version": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "tagIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tagSnapshot": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } }, "cells": { "type": "array", "items": { "type": "object", "properties": { "locale": { "type": "string" }, "before": { "type": [ "string", "null" ] }, "after": { "type": [ "string", "null" ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "action": { "type": "string", "enum": [ "new", "changed", "cleared", "unchanged", "skipped" ] } }, "required": [ "locale", "before", "after", "version", "action" ] } }, "bindings": { "type": "array", "items": { "type": "object", "properties": { "identity": { "type": "string" }, "binding": { "type": "object", "properties": { "externalId": { "type": "string" }, "context": { "type": "string" }, "group": { "type": "string" }, "format": { "type": "string", "enum": [ "android", "apple-strings", "apple-stringsdict", "apple-xcstrings", "arb", "po", "pot", "xliff12", "xliff20", "json", "properties", "yaml", "resx", "csv", "xlsx", "xls" ] }, "argumentOrder": { "type": "array", "items": { "type": "string" } }, "parameterNames": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "pluralId": { "type": "string" }, "placeholders": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "container": { "type": "string" } }, "required": [ "externalId", "context", "group", "format", "argumentOrder" ] } }, "required": [ "identity", "binding" ] } } }, "required": [ "id", "definition", "version", "tags", "tagIds", "tagSnapshot", "cells", "bindings" ] } }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "summary": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } } }, "required": [ "items", "page", "pageSize", "hasMore", "revision", "summary" ]}IssuePage
Section titled “IssuePage”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | — |
page |
integer | Yes | maximum: 9007199254740991 |
pageSize |
integer | Yes | maximum: 9007199254740991 |
hasMore |
boolean | Yes | — |
{ "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "error", "warning" ] }, "code": { "type": "string" }, "message": { "type": "string" }, "fileId": { "type": "string" }, "position": { "type": "string" }, "key": { "type": "string" }, "locale": { "type": "string" } }, "required": [ "severity", "code", "message" ] } }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ]}TagCreate
Section titled “TagCreate”| Field | Type | Required | Constraints / description |
|---|---|---|---|
name |
string | Yes | maxLength: 100 |
{ "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 } }, "required": [ "name" ], "additionalProperties": false}TagRename
Section titled “TagRename”| Field | Type | Required | Constraints / description |
|---|---|---|---|
name |
string | Yes | maxLength: 100 |
version |
integer | Yes | maximum: 9007199254740991 |
{ "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "version" ], "additionalProperties": false}Version
Section titled “Version”| Field | Type | Required | Constraints / description |
|---|---|---|---|
version |
integer | Yes | maximum: 9007199254740991 |
{ "type": "object", "properties": { "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "version" ], "additionalProperties": false}Revision
Section titled “Revision”| Field | Type | Required | Constraints / description |
|---|---|---|---|
revision |
integer | Yes | maximum: 9007199254740991 |
{ "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "revision" ], "additionalProperties": false}ImportConfiguration
Section titled “ImportConfiguration”| Field | Type | Required | Constraints / description |
|---|---|---|---|
revision |
integer | Yes | maximum: 9007199254740991 |
options |
object | Yes | — |
{ "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "options": { "type": "object", "properties": { "files": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "format": { "type": "string", "enum": [ "android", "apple-strings", "apple-stringsdict", "apple-xcstrings", "arb", "po", "pot", "xliff12", "xliff20", "json", "properties", "yaml", "resx", "csv", "xlsx", "xls" ] }, "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "group": { "default": "messages", "type": "string", "minLength": 1, "maxLength": 100 }, "encoding": { "default": "utf8", "type": "string", "enum": [ "utf8", "latin1" ] }, "sheet": { "type": "string", "maxLength": 100 }, "keyColumn": { "default": "key", "type": "string", "maxLength": 100 }, "columns": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "type": "string", "minLength": 2, "maxLength": 255 } }, "messageFormat": { "default": "plain", "type": "string", "enum": [ "plain", "icu" ] }, "csvProfile": { "default": "raw", "type": "string", "enum": [ "raw", "spreadsheet-safe" ] } }, "required": [ "fileId", "format" ], "additionalProperties": false } }, "strategy": { "default": "fill", "type": "string", "enum": [ "fill", "overwrite" ] }, "clearEmpty": { "default": false, "type": "boolean" }, "mappings": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 1000 }, "additionalProperties": { "type": "string", "maxLength": 1000 } }, "parameterMappings": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 1000 }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,99}$" }, "additionalProperties": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,99}$" } } }, "contracts": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 1000 }, "additionalProperties": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "plain", "icu" ] }, "parameters": { "maxItems": 32, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,99}$" }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ], "additionalProperties": false } } }, "required": [ "format", "parameters" ], "additionalProperties": false } }, "tagIds": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "confirmContracts": { "default": false, "type": "boolean" }, "confirmWarnings": { "default": false, "type": "boolean" } }, "required": [ "files" ], "additionalProperties": false } }, "required": [ "revision", "options" ], "additionalProperties": false}TagAssignment
Section titled “TagAssignment”| Field | Type | Required | Constraints / description |
|---|---|---|---|
version |
integer | Yes | maximum: 9007199254740991 |
tagIds |
Array of string | Yes | maxItems: 20 |
{ "type": "object", "properties": { "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "tagIds": { "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "version", "tagIds" ], "additionalProperties": false}BulkTags
Section titled “BulkTags”| Field | Type | Required | Constraints / description |
|---|---|---|---|
keys |
Array of object | Yes | minItems: 1; maxItems: 100 |
tagIds |
Array of string | Yes | maxItems: 20 |
mode |
add, remove |
Yes | — |
{ "type": "object", "properties": { "keys": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "keyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "keyId", "version" ] } }, "tagIds": { "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "mode": { "type": "string", "enum": [ "add", "remove" ] } }, "required": [ "keys", "tagIds", "mode" ], "additionalProperties": false}Assigned
Section titled “Assigned”| Field | Type | Required | Constraints / description |
|---|---|---|---|
updated |
Array of string | Yes | — |
{ "type": "object", "properties": { "updated": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "updated" ]}Deleted
Section titled “Deleted”| Field | Type | Required | Constraints / description |
|---|---|---|---|
deleted |
boolean | Yes | — |
{ "type": "object", "properties": { "deleted": { "type": "boolean", "const": true } }, "required": [ "deleted" ]}FormatCatalog
Section titled “FormatCatalog”| Field | Type | Required | Constraints / description |
|---|---|---|---|
formats |
Array of object | Yes | — |
limits |
object | Yes | — |
{ "type": "object", "properties": { "formats": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "android", "apple-strings", "apple-stringsdict", "apple-xcstrings", "arb", "po", "pot", "xliff12", "xliff20", "json", "properties", "yaml", "resx", "csv", "xlsx", "xls" ] }, "label": { "type": "string" }, "extensions": { "type": "array", "items": { "type": "string" } }, "multiLanguage": { "type": "boolean" } }, "required": [ "id", "label", "extensions", "multiLanguage" ] } }, "limits": { "type": "object", "properties": { "files": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "uploadBytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "expandedBytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "keys": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "values": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "previewHours": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "summaryDays": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "files", "uploadBytes", "expandedBytes", "keys", "values", "previewHours", "summaryDays" ] } }, "required": [ "formats", "limits" ]}| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
requestId |
string | Yes | — |
details |
See schema | No | — |
{ "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "details": {} }, "required": [ "error", "message", "requestId" ]}
Your privacy, your choice
Choose whether we remember appearance preferences and use Google Analytics on Localisync and its documentation. Optional storage stays off until you accept.
Read our cookie policy