Skip to content
localisyncDocs
Open panel

Translation workflow schemas

These definitions are generated from the downloadable OpenAPI contract. Required fields, validation constraints and additional-property policies are preserved.

Image

Section titled “Image”
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)$"
state reserved, uploading, queued, processing, ready, failed, deleting Yes —
width See schema Yes —
height See schema Yes —
size integer Yes minimum: 0; maximum: 9007199254740991
hash string or null Yes —
alt string Yes —
code string or null Yes — 
{
  "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)$"
    },
    "state": {
      "type": "string",
      "enum": [
        "reserved",
        "uploading",
        "queued",
        "processing",
        "ready",
        "failed",
        "deleting"
      ]
    },
    "width": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "height": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "size": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "hash": {
      "type": [
        "string",
        "null"
      ]
    },
    "alt": {
      "type": "string"
    },
    "code": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "state",
    "width",
    "height",
    "size",
    "hash",
    "alt",
    "code"
  ],
  "additionalProperties": false
}

Images

Section titled “Images”
Field Type Required Constraints / description
images Array of object Yes maxItems: 30
quota integer Yes minimum: 0; maximum: 9007199254740991
used integer Yes minimum: 0; maximum: 9007199254740991
reserved integer Yes minimum: 0; maximum: 9007199254740991
version integer Yes maximum: 2147483646 
{
  "type": "object",
  "properties": {
    "images": {
      "maxItems": 30,
      "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)$"
          },
          "state": {
            "type": "string",
            "enum": [
              "reserved",
              "uploading",
              "queued",
              "processing",
              "ready",
              "failed",
              "deleting"
            ]
          },
          "width": {
            "anyOf": [
              {
                "type": "integer",
                "exclusiveMinimum": 0,
                "maximum": 9007199254740991
              },
              {
                "type": "null"
              }
            ]
          },
          "height": {
            "anyOf": [
              {
                "type": "integer",
                "exclusiveMinimum": 0,
                "maximum": 9007199254740991
              },
              {
                "type": "null"
              }
            ]
          },
          "size": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "hash": {
            "type": [
              "string",
              "null"
            ]
          },
          "alt": {
            "type": "string"
          },
          "code": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "state",
          "width",
          "height",
          "size",
          "hash",
          "alt",
          "code"
        ],
        "additionalProperties": false
      }
    },
    "quota": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "used": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "reserved": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    }
  },
  "required": [
    "images",
    "quota",
    "used",
    "reserved",
    "version"
  ],
  "additionalProperties": false
}

ImageReserve

Section titled “ImageReserve”
Field Type Required Constraints / description
version integer Yes maximum: 2147483646
alt string Yes minLength: 1; maxLength: 500 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "alt": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "version",
    "alt"
  ],
  "additionalProperties": false
}

ImageQueued

Section titled “ImageQueued”
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)$"
state string Yes — 
{
  "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)$"
    },
    "state": {
      "type": "string",
      "const": "queued"
    }
  },
  "required": [
    "id",
    "state"
  ],
  "additionalProperties": false
}

ImageUpload

Section titled “ImageUpload”
Field Type Required Constraints / description
file string Yes — 
{
  "type": "object",
  "properties": {
    "file": {
      "type": "string"
    }
  },
  "required": [
    "file"
  ],
  "additionalProperties": false
}

ImageBytes

Section titled “ImageBytes”
{
  "type": "string"
}

KnowledgeFileInput

Section titled “KnowledgeFileInput”
Field Type Required Constraints / description
format csv, tmx Yes —
text string Yes maxLength: 1048576
csvProfile raw, spreadsheet-safe Yes —
columns See schema Yes —
sourceLocale See schema Yes —
targetLocale See schema Yes — 
{
  "type": "object",
  "properties": {
    "format": {
      "type": "string",
      "enum": [
        "csv",
        "tmx"
      ]
    },
    "text": {
      "type": "string",
      "maxLength": 1048576
    },
    "csvProfile": {
      "type": "string",
      "enum": [
        "raw",
        "spreadsheet-safe"
      ]
    },
    "columns": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "concept": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "description": {
              "anyOf": [
                {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                {
                  "type": "null"
                }
              ]
            },
            "terms": {
              "minItems": 1,
              "maxItems": 100,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "locale": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 255
                  },
                  "preferred": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200
                  },
                  "alternatives": {
                    "anyOf": [
                      {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 200
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "caseSensitive": {
                    "anyOf": [
                      {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 200
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "doNotTranslate": {
                    "anyOf": [
                      {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 200
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "required": [
                  "locale",
                  "preferred",
                  "alternatives",
                  "caseSensitive",
                  "doNotTranslate"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "concept",
            "description",
            "terms"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "sourceLocale": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 2,
          "maxLength": 255
        },
        {
          "type": "null"
        }
      ]
    },
    "targetLocale": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 2,
          "maxLength": 255
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "format",
    "text",
    "csvProfile",
    "columns",
    "sourceLocale",
    "targetLocale"
  ],
  "additionalProperties": false
}

KnowledgeImportCreated

Section titled “KnowledgeImportCreated”
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)$"
version integer Yes maximum: 2147483646 
{
  "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)$"
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    }
  },
  "required": [
    "id",
    "version"
  ],
  "additionalProperties": false
}

KnowledgeImportApply

Section titled “KnowledgeImportApply”
Field Type Required Constraints / description
version integer Yes maximum: 9007199254740991
choices Array of object Yes minItems: 1; maxItems: 10000 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "choices": {
      "minItems": 1,
      "maxItems": 10000,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "row": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9999
          },
          "action": {
            "type": "string",
            "enum": [
              "create",
              "replace",
              "skip"
            ]
          },
          "targetId": {
            "anyOf": [
              {
                "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)$"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "row",
          "action",
          "targetId"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "version",
    "choices"
  ],
  "additionalProperties": false
}

KnowledgeImportResult

Section titled “KnowledgeImportResult”
Field Type Required Constraints / description
created integer Yes minimum: 0; maximum: 9007199254740991
replaced integer Yes minimum: 0; maximum: 9007199254740991
skipped integer Yes minimum: 0; maximum: 9007199254740991 
{
  "type": "object",
  "properties": {
    "created": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "replaced": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "skipped": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "created",
    "replaced",
    "skipped"
  ],
  "additionalProperties": false
}

KnowledgeFileExport

Section titled “KnowledgeFileExport”
Field Type Required Constraints / description
format csv, tmx Yes —
content string Yes —
csvProfile See schema Yes — 
{
  "type": "object",
  "properties": {
    "format": {
      "type": "string",
      "enum": [
        "csv",
        "tmx"
      ]
    },
    "content": {
      "type": "string"
    },
    "csvProfile": {
      "anyOf": [
        {
          "type": "string",
          "const": "spreadsheet-safe"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "format",
    "content",
    "csvProfile"
  ],
  "additionalProperties": false
}

KnowledgeImportPreview

Section titled “KnowledgeImportPreview”
Field Type Required Constraints / description
items Array of object Yes maxItems: 100
page integer Yes maximum: 2147483646
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes —
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)$"
version integer Yes maximum: 2147483646
resourceVersion integer Yes maximum: 2147483646
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))$"
appliedAt See schema Yes —
warnings Array of string Yes —
total integer Yes minimum: -9007199254740991; maximum: 9007199254740991
result See schema Yes — 
{
  "type": "object",
  "properties": {
    "items": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "row": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "content": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "memory"
                  },
                  "sourceLocale": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 255
                  },
                  "targetLocale": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 255
                  },
                  "source": {
                    "type": "string"
                  },
                  "target": {
                    "type": "string"
                  },
                  "format": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "icu"
                    ]
                  },
                  "parameters": {
                    "maxItems": 32,
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "text",
                            "number"
                          ]
                        }
                      },
                      "required": [
                        "name",
                        "type"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "kind",
                  "sourceLocale",
                  "targetLocale",
                  "source",
                  "target",
                  "format",
                  "parameters"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "glossary"
                  },
                  "concept": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200
                  },
                  "description": {
                    "type": "string"
                  },
                  "terms": {
                    "minItems": 1,
                    "maxItems": 100,
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "locale": {
                          "type": "string",
                          "minLength": 2,
                          "maxLength": 255
                        },
                        "preferred": {
                          "type": "string"
                        },
                        "alternatives": {
                          "maxItems": 20,
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "caseSensitive": {
                          "type": "boolean"
                        },
                        "doNotTranslate": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "locale",
                        "preferred",
                        "alternatives",
                        "caseSensitive",
                        "doNotTranslate"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "kind",
                  "concept",
                  "description",
                  "terms"
                ],
                "additionalProperties": false
              }
            ]
          },
          "duplicates": {
            "maxItems": 20,
            "type": "array",
            "items": {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            }
          },
          "duplicateCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "matches": {
            "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)$"
                },
                "version": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 2147483646
                },
                "content": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "kind": {
                          "type": "string",
                          "const": "memory"
                        },
                        "sourceLocale": {
                          "type": "string",
                          "minLength": 2,
                          "maxLength": 255
                        },
                        "targetLocale": {
                          "type": "string",
                          "minLength": 2,
                          "maxLength": 255
                        },
                        "source": {
                          "type": "string"
                        },
                        "target": {
                          "type": "string"
                        },
                        "format": {
                          "type": "string",
                          "enum": [
                            "plain",
                            "icu"
                          ]
                        },
                        "parameters": {
                          "maxItems": 32,
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 100
                              },
                              "type": {
                                "type": "string",
                                "enum": [
                                  "text",
                                  "number"
                                ]
                              }
                            },
                            "required": [
                              "name",
                              "type"
                            ],
                            "additionalProperties": false
                          }
                        }
                      },
                      "required": [
                        "kind",
                        "sourceLocale",
                        "targetLocale",
                        "source",
                        "target",
                        "format",
                        "parameters"
                      ],
                      "additionalProperties": false
                    },
                    {
                      "type": "object",
                      "properties": {
                        "kind": {
                          "type": "string",
                          "const": "glossary"
                        },
                        "concept": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 200
                        },
                        "description": {
                          "type": "string"
                        },
                        "terms": {
                          "minItems": 1,
                          "maxItems": 100,
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "locale": {
                                "type": "string",
                                "minLength": 2,
                                "maxLength": 255
                              },
                              "preferred": {
                                "type": "string"
                              },
                              "alternatives": {
                                "maxItems": 20,
                                "type": "array",
                                "items": {
                                  "type": "string"
                                }
                              },
                              "caseSensitive": {
                                "type": "boolean"
                              },
                              "doNotTranslate": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "locale",
                              "preferred",
                              "alternatives",
                              "caseSensitive",
                              "doNotTranslate"
                            ],
                            "additionalProperties": false
                          }
                        }
                      },
                      "required": [
                        "kind",
                        "concept",
                        "description",
                        "terms"
                      ],
                      "additionalProperties": false
                    }
                  ]
                },
                "origin": {
                  "type": "string",
                  "enum": [
                    "manual",
                    "review"
                  ]
                },
                "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))$"
                }
              },
              "required": [
                "id",
                "version",
                "content",
                "origin",
                "createdAt"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "row",
          "content",
          "duplicates",
          "duplicateCount",
          "matches"
        ],
        "additionalProperties": false
      }
    },
    "page": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "hasMore": {
      "type": "boolean"
    },
    "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)$"
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "resourceVersion": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "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))$"
    },
    "appliedAt": {
      "anyOf": [
        {
          "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))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "total": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "result": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "created": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "replaced": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "skipped": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "created",
            "replaced",
            "skipped"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore",
    "id",
    "version",
    "resourceVersion",
    "expiresAt",
    "appliedAt",
    "warnings",
    "total",
    "result"
  ],
  "additionalProperties": false
}

Notifications

Section titled “Notifications”
Field Type Required Constraints / description
items Array of object Yes maxItems: 100
page integer Yes maximum: 2147483646
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes — 
{
  "type": "object",
  "properties": {
    "items": {
      "maxItems": 100,
      "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": [
              "mentioned",
              "replied",
              "task_assigned",
              "task_changed",
              "task_completed",
              "task_reopened",
              "task_due"
            ]
          },
          "taskId": {
            "anyOf": [
              {
                "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)$"
              },
              {
                "type": "null"
              }
            ]
          },
          "keyId": {
            "anyOf": [
              {
                "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)$"
              },
              {
                "type": "null"
              }
            ]
          },
          "threadId": {
            "anyOf": [
              {
                "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)$"
              },
              {
                "type": "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))$"
          },
          "readAt": {
            "anyOf": [
              {
                "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))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "emailState": {
            "type": "string",
            "enum": [
              "pending",
              "sending",
              "sent",
              "skipped",
              "unknown"
            ]
          }
        },
        "required": [
          "id",
          "workspaceId",
          "projectId",
          "branchId",
          "kind",
          "taskId",
          "keyId",
          "threadId",
          "createdAt",
          "readAt",
          "emailState"
        ],
        "additionalProperties": false
      }
    },
    "page": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ],
  "additionalProperties": false
}

NotificationPreference

Section titled “NotificationPreference”
Field Type Required Constraints / description
emailEnabled boolean Yes —
version integer Yes minimum: 0; maximum: 2147483646 
{
  "type": "object",
  "properties": {
    "emailEnabled": {
      "type": "boolean"
    },
    "version": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483646
    }
  },
  "required": [
    "emailEnabled",
    "version"
  ],
  "additionalProperties": false
}

NotificationRead

Section titled “NotificationRead”
Field Type Required Constraints / description
read boolean Yes — 
{
  "type": "object",
  "properties": {
    "read": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "read"
  ],
  "additionalProperties": false
}

NotificationReadInput

Section titled “NotificationReadInput”
Field Type Required Constraints / description 
{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Task

Section titled “Task”
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)$"
title string Yes —
kind translate, review Yes —
creatorId 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)$"
version integer Yes maximum: 2147483646
dueAt See schema Yes —
timeZone string 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))$"
canManage boolean Yes —
total integer Yes minimum: -9007199254740991; maximum: 9007199254740991
completed integer Yes minimum: -9007199254740991; maximum: 9007199254740991
blocked integer Yes minimum: -9007199254740991; maximum: 9007199254740991
status open, complete, blocked Yes — 
{
  "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)$"
    },
    "title": {
      "type": "string"
    },
    "kind": {
      "type": "string",
      "enum": [
        "translate",
        "review"
      ]
    },
    "creatorId": {
      "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": 2147483646
    },
    "dueAt": {
      "anyOf": [
        {
          "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))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "timeZone": {
      "type": "string"
    },
    "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))$"
    },
    "canManage": {
      "type": "boolean"
    },
    "total": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "completed": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "blocked": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "status": {
      "type": "string",
      "enum": [
        "open",
        "complete",
        "blocked"
      ]
    }
  },
  "required": [
    "id",
    "title",
    "kind",
    "creatorId",
    "version",
    "dueAt",
    "timeZone",
    "createdAt",
    "canManage",
    "total",
    "completed",
    "blocked",
    "status"
  ],
  "additionalProperties": false
}

Tasks

Section titled “Tasks”
Field Type Required Constraints / description
items Array of object Yes maxItems: 100
page integer Yes maximum: 2147483646
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes — 
{
  "type": "object",
  "properties": {
    "items": {
      "maxItems": 100,
      "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)$"
          },
          "title": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "translate",
              "review"
            ]
          },
          "creatorId": {
            "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": 2147483646
          },
          "dueAt": {
            "anyOf": [
              {
                "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))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "timeZone": {
            "type": "string"
          },
          "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))$"
          },
          "canManage": {
            "type": "boolean"
          },
          "total": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "completed": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "blocked": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "complete",
              "blocked"
            ]
          }
        },
        "required": [
          "id",
          "title",
          "kind",
          "creatorId",
          "version",
          "dueAt",
          "timeZone",
          "createdAt",
          "canManage",
          "total",
          "completed",
          "blocked",
          "status"
        ],
        "additionalProperties": false
      }
    },
    "page": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ],
  "additionalProperties": false
}

TaskDetail

Section titled “TaskDetail”
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)$"
title string Yes —
kind translate, review Yes —
creatorId 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)$"
version integer Yes maximum: 2147483646
dueAt See schema Yes —
timeZone string 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))$"
canManage boolean Yes —
total integer Yes minimum: -9007199254740991; maximum: 9007199254740991
completed integer Yes minimum: -9007199254740991; maximum: 9007199254740991
blocked integer Yes minimum: -9007199254740991; maximum: 9007199254740991
status open, complete, blocked Yes —
keys Array of string Yes maxItems: 10000
assignments Array of object Yes minItems: 1; maxItems: 1000
assigneeNames object Yes — 
{
  "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)$"
    },
    "title": {
      "type": "string"
    },
    "kind": {
      "type": "string",
      "enum": [
        "translate",
        "review"
      ]
    },
    "creatorId": {
      "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": 2147483646
    },
    "dueAt": {
      "anyOf": [
        {
          "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))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "timeZone": {
      "type": "string"
    },
    "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))$"
    },
    "canManage": {
      "type": "boolean"
    },
    "total": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "completed": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "blocked": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "status": {
      "type": "string",
      "enum": [
        "open",
        "complete",
        "blocked"
      ]
    },
    "keys": {
      "maxItems": 10000,
      "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)$"
      }
    },
    "assignments": {
      "minItems": 1,
      "maxItems": 1000,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "locale": {
            "type": "string",
            "minLength": 2,
            "maxLength": 255
          },
          "identityId": {
            "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": [
          "locale",
          "identityId"
        ],
        "additionalProperties": false
      }
    },
    "assigneeNames": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "id",
    "title",
    "kind",
    "creatorId",
    "version",
    "dueAt",
    "timeZone",
    "createdAt",
    "canManage",
    "total",
    "completed",
    "blocked",
    "status",
    "keys",
    "assignments",
    "assigneeNames"
  ],
  "additionalProperties": false
}

TaskInput

Section titled “TaskInput”
Field Type Required Constraints / description
title string Yes minLength: 1; maxLength: 200
kind translate, review Yes —
keys Array of string Yes minItems: 1; maxItems: 10000
assignments Array of object Yes minItems: 1; maxItems: 1000
dueAt See schema Yes —
timeZone string Yes minLength: 1; maxLength: 100; pattern: "^[A-Za-z][A-Za-z0-9._+-]*(?:\\/[A-Za-z0-9._+-]+)*$" 
{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "kind": {
      "type": "string",
      "enum": [
        "translate",
        "review"
      ]
    },
    "keys": {
      "minItems": 1,
      "maxItems": 10000,
      "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)$"
      }
    },
    "assignments": {
      "minItems": 1,
      "maxItems": 1000,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "locale": {
            "type": "string",
            "minLength": 2,
            "maxLength": 255
          },
          "identityId": {
            "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": [
          "locale",
          "identityId"
        ],
        "additionalProperties": false
      }
    },
    "dueAt": {
      "anyOf": [
        {
          "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "timeZone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z][A-Za-z0-9._+-]*(?:\\/[A-Za-z0-9._+-]+)*$"
    }
  },
  "required": [
    "title",
    "kind",
    "keys",
    "assignments",
    "dueAt",
    "timeZone"
  ],
  "additionalProperties": false
}

TaskEdit

Section titled “TaskEdit”
Field Type Required Constraints / description
title string Yes minLength: 1; maxLength: 200
kind translate, review Yes —
keys Array of string Yes minItems: 1; maxItems: 10000
assignments Array of object Yes minItems: 1; maxItems: 1000
dueAt See schema Yes —
timeZone string Yes minLength: 1; maxLength: 100; pattern: "^[A-Za-z][A-Za-z0-9._+-]*(?:\\/[A-Za-z0-9._+-]+)*$"
version integer Yes maximum: 2147483646 
{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "kind": {
      "type": "string",
      "enum": [
        "translate",
        "review"
      ]
    },
    "keys": {
      "minItems": 1,
      "maxItems": 10000,
      "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)$"
      }
    },
    "assignments": {
      "minItems": 1,
      "maxItems": 1000,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "locale": {
            "type": "string",
            "minLength": 2,
            "maxLength": 255
          },
          "identityId": {
            "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": [
          "locale",
          "identityId"
        ],
        "additionalProperties": false
      }
    },
    "dueAt": {
      "anyOf": [
        {
          "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "timeZone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z][A-Za-z0-9._+-]*(?:\\/[A-Za-z0-9._+-]+)*$"
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    }
  },
  "required": [
    "title",
    "kind",
    "keys",
    "assignments",
    "dueAt",
    "timeZone",
    "version"
  ],
  "additionalProperties": false
}

TaskAssignees

Section titled “TaskAssignees”
Field Type Required Constraints / description
items Array of object Yes maxItems: 100
page integer Yes maximum: 2147483646
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes — 
{
  "type": "object",
  "properties": {
    "items": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "identityId": {
            "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)$"
          },
          "email": {
            "type": "string"
          }
        },
        "required": [
          "identityId",
          "email"
        ],
        "additionalProperties": false
      }
    },
    "page": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ],
  "additionalProperties": false
}

DiscussionThread

Section titled “DiscussionThread”
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)$"
locale See schema Yes —
authorId 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)$"
resolved boolean Yes —
version integer Yes maximum: 2147483646
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))$"
canResolve boolean Yes — 
{
  "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)$"
    },
    "locale": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 2,
          "maxLength": 255
        },
        {
          "type": "null"
        }
      ]
    },
    "authorId": {
      "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)$"
    },
    "resolved": {
      "type": "boolean"
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "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))$"
    },
    "canResolve": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "locale",
    "authorId",
    "resolved",
    "version",
    "createdAt",
    "canResolve"
  ],
  "additionalProperties": false
}

DiscussionThreads

Section titled “DiscussionThreads”
Field Type Required Constraints / description
items Array of object Yes maxItems: 100
page integer Yes maximum: 2147483646
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes — 
{
  "type": "object",
  "properties": {
    "items": {
      "maxItems": 100,
      "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)$"
          },
          "locale": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 2,
                "maxLength": 255
              },
              {
                "type": "null"
              }
            ]
          },
          "authorId": {
            "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)$"
          },
          "resolved": {
            "type": "boolean"
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 2147483646
          },
          "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))$"
          },
          "canResolve": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "locale",
          "authorId",
          "resolved",
          "version",
          "createdAt",
          "canResolve"
        ],
        "additionalProperties": false
      }
    },
    "page": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ],
  "additionalProperties": false
}

DiscussionInput

Section titled “DiscussionInput”
Field Type Required Constraints / description
text string Yes minLength: 1
mentions Array of string Yes maxItems: 20
locale See schema Yes — 
{
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "minLength": 1
    },
    "mentions": {
      "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)$"
      }
    },
    "locale": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 2,
          "maxLength": 255
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "text",
    "mentions",
    "locale"
  ],
  "additionalProperties": false
}

DiscussionResolve

Section titled “DiscussionResolve”
Field Type Required Constraints / description
version integer Yes maximum: 2147483646
resolved boolean Yes — 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "resolved": {
      "type": "boolean"
    }
  },
  "required": [
    "version",
    "resolved"
  ],
  "additionalProperties": false
}

DiscussionComment

Section titled “DiscussionComment”
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)$"
threadId 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)$"
replyToId See schema Yes —
authorId 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)$"
authorLabel string or null Yes —
text string or null Yes —
mentions Array of string Yes maxItems: 20
version integer Yes maximum: 2147483646
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))$"
removedAt See schema Yes —
canEdit boolean Yes — 
{
  "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)$"
    },
    "threadId": {
      "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)$"
    },
    "replyToId": {
      "anyOf": [
        {
          "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)$"
        },
        {
          "type": "null"
        }
      ]
    },
    "authorId": {
      "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)$"
    },
    "authorLabel": {
      "type": [
        "string",
        "null"
      ]
    },
    "text": {
      "type": [
        "string",
        "null"
      ]
    },
    "mentions": {
      "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)$"
      }
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "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))$"
    },
    "removedAt": {
      "anyOf": [
        {
          "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))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "canEdit": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "threadId",
    "replyToId",
    "authorId",
    "authorLabel",
    "text",
    "mentions",
    "version",
    "createdAt",
    "updatedAt",
    "removedAt",
    "canEdit"
  ],
  "additionalProperties": false
}

DiscussionComments

Section titled “DiscussionComments”
Field Type Required Constraints / description
items Array of object Yes maxItems: 100
page integer Yes maximum: 2147483646
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes — 
{
  "type": "object",
  "properties": {
    "items": {
      "maxItems": 100,
      "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)$"
          },
          "threadId": {
            "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)$"
          },
          "replyToId": {
            "anyOf": [
              {
                "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)$"
              },
              {
                "type": "null"
              }
            ]
          },
          "authorId": {
            "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)$"
          },
          "authorLabel": {
            "type": [
              "string",
              "null"
            ]
          },
          "text": {
            "type": [
              "string",
              "null"
            ]
          },
          "mentions": {
            "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)$"
            }
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 2147483646
          },
          "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))$"
          },
          "removedAt": {
            "anyOf": [
              {
                "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))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "canEdit": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "threadId",
          "replyToId",
          "authorId",
          "authorLabel",
          "text",
          "mentions",
          "version",
          "createdAt",
          "updatedAt",
          "removedAt",
          "canEdit"
        ],
        "additionalProperties": false
      }
    },
    "page": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ],
  "additionalProperties": false
}

DiscussionReply

Section titled “DiscussionReply”
Field Type Required Constraints / description
text string Yes minLength: 1
mentions Array of string Yes maxItems: 20
replyToId See schema No — 
{
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "minLength": 1
    },
    "mentions": {
      "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)$"
      }
    },
    "replyToId": {
      "anyOf": [
        {
          "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)$"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "text",
    "mentions"
  ],
  "additionalProperties": false
}

DiscussionEdit

Section titled “DiscussionEdit”
Field Type Required Constraints / description
text string Yes minLength: 1
mentions Array of string Yes maxItems: 20
version integer Yes maximum: 2147483646 
{
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "minLength": 1
    },
    "mentions": {
      "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)$"
      }
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    }
  },
  "required": [
    "text",
    "mentions",
    "version"
  ],
  "additionalProperties": false
}

DiscussionHistory

Section titled “DiscussionHistory”
Field Type Required Constraints / description
items Array of object Yes maxItems: 100
page integer Yes maximum: 2147483646
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes — 
{
  "type": "object",
  "properties": {
    "items": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 2147483646
          },
          "text": {
            "type": [
              "string",
              "null"
            ]
          },
          "mentions": {
            "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)$"
            }
          },
          "actorId": {
            "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)$"
          },
          "changedAt": {
            "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))$"
          },
          "removed": {
            "type": "boolean"
          }
        },
        "required": [
          "version",
          "text",
          "mentions",
          "actorId",
          "changedAt",
          "removed"
        ],
        "additionalProperties": false
      }
    },
    "page": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ],
  "additionalProperties": false
}

MemberAccessInput

Section titled “MemberAccessInput”
Field Type Required Constraints / description
version integer Yes minimum: 0; maximum: 2147483646
restricted boolean Yes —
grants Array of object Yes maxItems: 1000 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483646
    },
    "restricted": {
      "type": "boolean"
    },
    "grants": {
      "maxItems": 1000,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "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)$"
          },
          "locale": {
            "type": "string",
            "minLength": 2,
            "maxLength": 255
          },
          "write": {
            "type": "boolean"
          },
          "review": {
            "type": "boolean"
          }
        },
        "required": [
          "projectId",
          "locale",
          "write",
          "review"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "version",
    "restricted",
    "grants"
  ],
  "additionalProperties": false
}

MemberAccess

Section titled “MemberAccess”
Field Type Required Constraints / description
version integer Yes minimum: 0; maximum: 2147483646
restricted boolean Yes —
grants Array of object Yes maxItems: 1000
identityId 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)$" 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483646
    },
    "restricted": {
      "type": "boolean"
    },
    "grants": {
      "maxItems": 1000,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "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)$"
          },
          "locale": {
            "type": "string",
            "minLength": 2,
            "maxLength": 255
          },
          "write": {
            "type": "boolean"
          },
          "review": {
            "type": "boolean"
          }
        },
        "required": [
          "projectId",
          "locale",
          "write",
          "review"
        ],
        "additionalProperties": false
      }
    },
    "identityId": {
      "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",
    "restricted",
    "grants",
    "identityId"
  ],
  "additionalProperties": false
}

ReviewPolicy

Section titled “ReviewPolicy”
Field Type Required Constraints / description
version integer Yes maximum: 2147483646
required boolean Yes — 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "required": {
      "type": "boolean"
    }
  },
  "required": [
    "version",
    "required"
  ],
  "additionalProperties": false
}

ReviewInput

Section titled “ReviewInput”
Field Type Required Constraints / description
approve boolean Yes —
items Array of object Yes minItems: 1; maxItems: 100 
{
  "type": "object",
  "properties": {
    "approve": {
      "type": "boolean"
    },
    "items": {
      "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)$"
          },
          "locale": {
            "type": "string",
            "minLength": 2,
            "maxLength": 255
          },
          "keyVersion": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 2147483646
          },
          "valueVersion": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 2147483646
          },
          "evidenceId": {
            "anyOf": [
              {
                "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)$"
              },
              {
                "type": "null"
              }
            ]
          },
          "sourceLocale": {
            "type": "string",
            "minLength": 2,
            "maxLength": 255
          },
          "sourceVersion": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "keyId",
          "locale",
          "keyVersion",
          "valueVersion",
          "evidenceId"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "approve",
    "items"
  ],
  "additionalProperties": false
}

ReviewResult

Section titled “ReviewResult”
Field Type Required Constraints / description
items Array of object Yes — 
{
  "type": "object",
  "properties": {
    "items": {
      "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)$"
          },
          "locale": {
            "type": "string",
            "minLength": 2,
            "maxLength": 255
          },
          "evidenceId": {
            "anyOf": [
              {
                "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)$"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "keyId",
          "locale",
          "evidenceId"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}

Context

Section titled “Context”
Field Type Required Constraints / description
description string Yes —
notes Array of object Yes maxItems: 100
images Array of object No maxItems: 10
version integer Yes maximum: 2147483646 
{
  "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
      }
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    }
  },
  "required": [
    "description",
    "notes",
    "version"
  ],
  "additionalProperties": false
}

ContextInput

Section titled “ContextInput”
Field Type Required Constraints / description
version integer Yes maximum: 2147483646
context object Yes — 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "context": {
      "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": [
    "version",
    "context"
  ],
  "additionalProperties": false
}

ResourceInput

Section titled “ResourceInput”
Field Type Required Constraints / description
name string Yes minLength: 1; maxLength: 100
kind glossary, memory Yes — 
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "kind": {
      "type": "string",
      "enum": [
        "glossary",
        "memory"
      ]
    }
  },
  "required": [
    "name",
    "kind"
  ],
  "additionalProperties": false
}

Resource

Section titled “Resource”
Field Type Required Constraints / description
name string Yes minLength: 1; maxLength: 100
kind glossary, memory Yes —
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)$"
version integer Yes maximum: 2147483646
editable boolean Yes —
archivedAt See schema Yes — 
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "kind": {
      "type": "string",
      "enum": [
        "glossary",
        "memory"
      ]
    },
    "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)$"
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "editable": {
      "type": "boolean"
    },
    "archivedAt": {
      "anyOf": [
        {
          "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))$"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "name",
    "kind",
    "id",
    "version",
    "editable",
    "archivedAt"
  ],
  "additionalProperties": false
}

Resources

Section titled “Resources”
Field Type Required Constraints / description
items Array of object Yes maxItems: 100
page integer Yes maximum: 2147483646
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes — 
{
  "type": "object",
  "properties": {
    "items": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "kind": {
            "type": "string",
            "enum": [
              "glossary",
              "memory"
            ]
          },
          "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)$"
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 2147483646
          },
          "editable": {
            "type": "boolean"
          },
          "archivedAt": {
            "anyOf": [
              {
                "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))$"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "name",
          "kind",
          "id",
          "version",
          "editable",
          "archivedAt"
        ],
        "additionalProperties": false
      }
    },
    "page": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ],
  "additionalProperties": false
}

ResourceUpdate

Section titled “ResourceUpdate”
Field Type Required Constraints / description
version integer Yes maximum: 2147483646
name string Yes minLength: 1; maxLength: 100
archived boolean Yes — 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "archived": {
      "type": "boolean"
    }
  },
  "required": [
    "version",
    "name",
    "archived"
  ],
  "additionalProperties": false
}

ResourceEditors

Section titled “ResourceEditors”
Field Type Required Constraints / description
version integer Yes maximum: 2147483646
identities Array of string Yes maxItems: 100 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "identities": {
      "maxItems": 100,
      "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",
    "identities"
  ],
  "additionalProperties": false
}

Entry

Section titled “Entry”
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)$"
version integer Yes maximum: 2147483646
content See schema Yes —
origin manual, review 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))$" 
{
  "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)$"
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "content": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "const": "memory"
            },
            "sourceLocale": {
              "type": "string",
              "minLength": 2,
              "maxLength": 255
            },
            "targetLocale": {
              "type": "string",
              "minLength": 2,
              "maxLength": 255
            },
            "source": {
              "type": "string"
            },
            "target": {
              "type": "string"
            },
            "format": {
              "type": "string",
              "enum": [
                "plain",
                "icu"
              ]
            },
            "parameters": {
              "maxItems": 32,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "text",
                      "number"
                    ]
                  }
                },
                "required": [
                  "name",
                  "type"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "kind",
            "sourceLocale",
            "targetLocale",
            "source",
            "target",
            "format",
            "parameters"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "const": "glossary"
            },
            "concept": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "description": {
              "type": "string"
            },
            "terms": {
              "minItems": 1,
              "maxItems": 100,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "locale": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 255
                  },
                  "preferred": {
                    "type": "string"
                  },
                  "alternatives": {
                    "maxItems": 20,
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "caseSensitive": {
                    "type": "boolean"
                  },
                  "doNotTranslate": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "locale",
                  "preferred",
                  "alternatives",
                  "caseSensitive",
                  "doNotTranslate"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "kind",
            "concept",
            "description",
            "terms"
          ],
          "additionalProperties": false
        }
      ]
    },
    "origin": {
      "type": "string",
      "enum": [
        "manual",
        "review"
      ]
    },
    "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))$"
    }
  },
  "required": [
    "id",
    "version",
    "content",
    "origin",
    "createdAt"
  ],
  "additionalProperties": false
}

Entries

Section titled “Entries”
Field Type Required Constraints / description
items Array of object Yes maxItems: 100
page integer Yes maximum: 2147483646
pageSize integer Yes minimum: 1; maximum: 100
hasMore boolean Yes — 
{
  "type": "object",
  "properties": {
    "items": {
      "maxItems": 100,
      "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)$"
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 2147483646
          },
          "content": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "memory"
                  },
                  "sourceLocale": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 255
                  },
                  "targetLocale": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 255
                  },
                  "source": {
                    "type": "string"
                  },
                  "target": {
                    "type": "string"
                  },
                  "format": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "icu"
                    ]
                  },
                  "parameters": {
                    "maxItems": 32,
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "text",
                            "number"
                          ]
                        }
                      },
                      "required": [
                        "name",
                        "type"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "kind",
                  "sourceLocale",
                  "targetLocale",
                  "source",
                  "target",
                  "format",
                  "parameters"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "glossary"
                  },
                  "concept": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200
                  },
                  "description": {
                    "type": "string"
                  },
                  "terms": {
                    "minItems": 1,
                    "maxItems": 100,
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "locale": {
                          "type": "string",
                          "minLength": 2,
                          "maxLength": 255
                        },
                        "preferred": {
                          "type": "string"
                        },
                        "alternatives": {
                          "maxItems": 20,
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "caseSensitive": {
                          "type": "boolean"
                        },
                        "doNotTranslate": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "locale",
                        "preferred",
                        "alternatives",
                        "caseSensitive",
                        "doNotTranslate"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "kind",
                  "concept",
                  "description",
                  "terms"
                ],
                "additionalProperties": false
              }
            ]
          },
          "origin": {
            "type": "string",
            "enum": [
              "manual",
              "review"
            ]
          },
          "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))$"
          }
        },
        "required": [
          "id",
          "version",
          "content",
          "origin",
          "createdAt"
        ],
        "additionalProperties": false
      }
    },
    "page": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ],
  "additionalProperties": false
}

EntryInput

Section titled “EntryInput”
{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "memory"
        },
        "sourceLocale": {
          "type": "string",
          "minLength": 2,
          "maxLength": 255
        },
        "targetLocale": {
          "type": "string",
          "minLength": 2,
          "maxLength": 255
        },
        "source": {
          "type": "string"
        },
        "target": {
          "type": "string"
        },
        "format": {
          "type": "string",
          "enum": [
            "plain",
            "icu"
          ]
        },
        "parameters": {
          "maxItems": 32,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "type": {
                "type": "string",
                "enum": [
                  "text",
                  "number"
                ]
              }
            },
            "required": [
              "name",
              "type"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "kind",
        "sourceLocale",
        "targetLocale",
        "source",
        "target",
        "format",
        "parameters"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "glossary"
        },
        "concept": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "description": {
          "type": "string"
        },
        "terms": {
          "minItems": 1,
          "maxItems": 100,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "locale": {
                "type": "string",
                "minLength": 2,
                "maxLength": 255
              },
              "preferred": {
                "type": "string"
              },
              "alternatives": {
                "maxItems": 20,
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "caseSensitive": {
                "type": "boolean"
              },
              "doNotTranslate": {
                "type": "boolean"
              }
            },
            "required": [
              "locale",
              "preferred",
              "alternatives",
              "caseSensitive",
              "doNotTranslate"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "kind",
        "concept",
        "description",
        "terms"
      ],
      "additionalProperties": false
    }
  ]
}

EntryUpdate

Section titled “EntryUpdate”
Field Type Required Constraints / description
version integer Yes maximum: 2147483646
content See schema Yes — 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "content": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "const": "memory"
            },
            "sourceLocale": {
              "type": "string",
              "minLength": 2,
              "maxLength": 255
            },
            "targetLocale": {
              "type": "string",
              "minLength": 2,
              "maxLength": 255
            },
            "source": {
              "type": "string"
            },
            "target": {
              "type": "string"
            },
            "format": {
              "type": "string",
              "enum": [
                "plain",
                "icu"
              ]
            },
            "parameters": {
              "maxItems": 32,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "text",
                      "number"
                    ]
                  }
                },
                "required": [
                  "name",
                  "type"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "kind",
            "sourceLocale",
            "targetLocale",
            "source",
            "target",
            "format",
            "parameters"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "const": "glossary"
            },
            "concept": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "description": {
              "type": "string"
            },
            "terms": {
              "minItems": 1,
              "maxItems": 100,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "locale": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 255
                  },
                  "preferred": {
                    "type": "string"
                  },
                  "alternatives": {
                    "maxItems": 20,
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "caseSensitive": {
                    "type": "boolean"
                  },
                  "doNotTranslate": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "locale",
                  "preferred",
                  "alternatives",
                  "caseSensitive",
                  "doNotTranslate"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "kind",
            "concept",
            "description",
            "terms"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": [
    "version",
    "content"
  ],
  "additionalProperties": false
}
Section titled “Links”
Field Type Required Constraints / description
version integer Yes maximum: 2147483646
links Array of object Yes maxItems: 100 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    },
    "links": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "resourceId": {
            "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)$"
          },
          "automatic": {
            "type": "boolean"
          }
        },
        "required": [
          "resourceId",
          "automatic"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "version",
    "links"
  ],
  "additionalProperties": false
}

Version

Section titled “Version”
Field Type Required Constraints / description
version integer Yes maximum: 2147483646 
{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483646
    }
  },
  "required": [
    "version"
  ],
  "additionalProperties": false
}

Success

Section titled “Success”
Field Type Required Constraints / description
success boolean Yes — 
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "additionalProperties": false
}

Suggestions

Section titled “Suggestions”
Field Type Required Constraints / description
memories Array of object Yes maxItems: 25
glossaries Array of object Yes maxItems: 25 
{
  "type": "object",
  "properties": {
    "memories": {
      "maxItems": 25,
      "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)$"
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 2147483646
          },
          "content": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "memory"
                  },
                  "sourceLocale": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 255
                  },
                  "targetLocale": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 255
                  },
                  "source": {
                    "type": "string"
                  },
                  "target": {
                    "type": "string"
                  },
                  "format": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "icu"
                    ]
                  },
                  "parameters": {
                    "maxItems": 32,
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "text",
                            "number"
                          ]
                        }
                      },
                      "required": [
                        "name",
                        "type"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "kind",
                  "sourceLocale",
                  "targetLocale",
                  "source",
                  "target",
                  "format",
                  "parameters"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "glossary"
                  },
                  "concept": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200
                  },
                  "description": {
                    "type": "string"
                  },
                  "terms": {
                    "minItems": 1,
                    "maxItems": 100,
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "locale": {
                          "type": "string",
                          "minLength": 2,
                          "maxLength": 255
                        },
                        "preferred": {
                          "type": "string"
                        },
                        "alternatives": {
                          "maxItems": 20,
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "caseSensitive": {
                          "type": "boolean"
                        },
                        "doNotTranslate": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "locale",
                        "preferred",
                        "alternatives",
                        "caseSensitive",
                        "doNotTranslate"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "kind",
                  "concept",
                  "description",
                  "terms"
                ],
                "additionalProperties": false
              }
            ]
          },
          "origin": {
            "type": "string",
            "enum": [
              "manual",
              "review"
            ]
          },
          "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))$"
          },
          "match": {
            "type": "string",
            "enum": [
              "exact",
              "similar"
            ]
          },
          "similarity": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "version",
          "content",
          "origin",
          "createdAt",
          "match",
          "similarity"
        ],
        "additionalProperties": false
      }
    },
    "glossaries": {
      "maxItems": 25,
      "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)$"
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 2147483646
          },
          "content": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "memory"
                  },
                  "sourceLocale": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 255
                  },
                  "targetLocale": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 255
                  },
                  "source": {
                    "type": "string"
                  },
                  "target": {
                    "type": "string"
                  },
                  "format": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "icu"
                    ]
                  },
                  "parameters": {
                    "maxItems": 32,
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "text",
                            "number"
                          ]
                        }
                      },
                      "required": [
                        "name",
                        "type"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "kind",
                  "sourceLocale",
                  "targetLocale",
                  "source",
                  "target",
                  "format",
                  "parameters"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "glossary"
                  },
                  "concept": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200
                  },
                  "description": {
                    "type": "string"
                  },
                  "terms": {
                    "minItems": 1,
                    "maxItems": 100,
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "locale": {
                          "type": "string",
                          "minLength": 2,
                          "maxLength": 255
                        },
                        "preferred": {
                          "type": "string"
                        },
                        "alternatives": {
                          "maxItems": 20,
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "caseSensitive": {
                          "type": "boolean"
                        },
                        "doNotTranslate": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "locale",
                        "preferred",
                        "alternatives",
                        "caseSensitive",
                        "doNotTranslate"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "kind",
                  "concept",
                  "description",
                  "terms"
                ],
                "additionalProperties": false
              }
            ]
          },
          "origin": {
            "type": "string",
            "enum": [
              "manual",
              "review"
            ]
          },
          "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))$"
          }
        },
        "required": [
          "id",
          "version",
          "content",
          "origin",
          "createdAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "memories",
    "glossaries"
  ],
  "additionalProperties": false
}

Error

Section titled “Error”
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"
  ],
  "additionalProperties": false
}
Localisync byWetus

Cookie preferences

Your choice applies to localisync.com and docs.localisync.com. You can change it at any time using Cookie settings.

Cookie policyWebsite privacy