Translation Properties

crossTank entries can have system attributes associated to them. Besides the pre-defined attributes Subjects, Projects, Relations and Paragraph structure attributes, users can define their own attributes. In the crossTank API attributes can be added to new translations or used as search criteria by passing them as parameters in the respective request body. This section describes the most common parameters for searching and storing translations and how to retrieve them via the coreAPI.

System attributes (except server contexts and users) are listed in the "Properties" collection of a translation. Each attribute has a "Type", which is a GUID, and a collection of values of that attribute, which are also GUIDs.

These are the pre-defined attributes and their GUIDs:

8698f741-f1c9-49c3-b551-1202da84b447

3d7a90c2-7604-4d71-99ed-a44e813d8909

aa325813-3578-458c-b05b-434fba9aa7ec

56cce4ce-de47-4459-a908-1da4b6890568

Resolving and enumerating translation properties

All system attributes used as translation properties, including server and user GUIDs, can be resolved and enumerated using a coreAPI controller. By default <API-base-url> is "<hostname>/across/core" where "hostname" is the URL of the server on which the coreAPI component is installed. In order to be authorized for this method your client needs to have the core.api scope set in Across Identity Server (see Authentication Basics for more information).

• Controllers:
• http://<API-base-URI>/api/v1/SystemAttributes (allows enumerating system attributes like Subject, Relation, Custom attributes, etc.)
• http://<API-base-URI>/api/v1/GridServers (allows enumerating registered grid servers)

These controllers are OData powered. OData allows passing parameters via the request URL, for more information please refer to the OData Version 3.0 documentation.

System attributes:

The following example shows how the Users category is read with all values expanded:

http://<API-base-URI>/across/core/api/v1/SystemAttributes?$filter=UniqueId eq '276261be-50a8-4871-9110-8c98ffc838a5'&$expand=Values

Response:

{
  "odata.metadata": "http://<API-base-URI>/api/v1/$metadata#SystemAttributes",
  "value": [
    {
      "Values": [
        {
          "Id": 2,
          "UniqueId": "062e42cc-6d5a-4cfa-baf7-f459b4c5e970",
          "IsDefault": false,
          "IsDeleted": false,
          "Value": "Default Supervisor",
          "SystemAttributeId": 2
        },
        {
          "Id": 10,
          "UniqueId": "a733795c-7cab-4625-85d9-e2bb4ec2751e",
          "IsDefault": false,
          "IsDeleted": false,
          "Value": "winuser Test",
          "SystemAttributeId": 2
        },
        {
          "Id": 29,
          "UniqueId": "e50e1644-f269-4bbf-baf6-ea17afcba39c",
          "IsDefault": false,
          "IsDeleted": false,
          "Value": "Machine Translation",
          "SystemAttributeId": 2
        }
      ],
      "Id": 2,
      "UniqueId": "276261be-50a8-4871-9110-8c98ffc838a5",
      "Name": "Users",
      "IsDeleted": false,
      "IsMultipleValue": true,
      "ServerId": null
    },
    {
      "Values": [
        {
          "Id": 31,
          "UniqueId": "5c97a1db-4df1-4fa6-b4fa-437ef03b9410",
          "IsDefault": false,
          "IsDeleted": false,
          "Value": "[Your company]",
          "SystemAttributeId": 17
        }
      ],
      "Id": 17,
      "UniqueId": "276261be-50a8-4871-9110-8c98ffc838a5",
      "Name": "Users",
      "IsDeleted": false,
      "IsMultipleValue": true,
      "ServerId": "5c97a1db-4df1-4fa6-b4fa-437ef03b9410"
    }
  ]
}

Server contexts:

Each translation belongs to an Across installation. It is defined by the ServerContextGuid property of a translation. Usually the server context is equal to the installation GUID. If the ServerContextGuid is not specified while creating a translation, it will be automatically bound to the local installation.

crossGrid Servers can be enumerated in the following way:

http://<API-base-URI>/across/core/api/v1/GridServers

Response:

{
  "odata.metadata": "http://<API-base-URI>/Across/Core/api/v1/$metadata#GridServers",
  "value": [
    {
      "Id": 3,
      "UniqueId": "299ec8a9-14fa-4f51-be70-6afee064a517",
      "Name": "Remote server",
      "Email": "",
      "Role": 0
    },
    {
      "Id": 4,
      "UniqueId": "5c97a1db-4df1-4fa6-b4fa-437ef03b9410",
      "Name": "Local server",
      "Email": "",
      "Role": 1
    }
  ]
}

Storing Modes

When creating new translations, duplicates can be prevented by setting the property PreventMultipleTranslations to true. In general with this setting, all new translations with the Released status will be added to crossTank, unless there is an already existing identical released translation. How exactly duplicates are treated when PreventMultipleTranslations is set depends on the value of PreventMultiTranslationMode: