CAT Configurations

CAT configurations represent the settings for a specific CAT tool. They contain information about the CAT tool and the mapping configuration between the CAT tool and LSP.expert.

The CAT configuration object

Properties

  • idstring

    Unique identifier for the object.

  • namestring

    The name of the configuration.

  • catToolobject

    The CAT tool for the configuration.

  • mappingsarray

    The mapping configurations between the CAT tool and LSP.expert.

  • quantityTypesobject

    The quantity types configuration.

CAT configuration object

{
  "id": "66cc27f8d263fd1bbb5e50d6",
  "name": "Trados Demo",
  "catTool": {
    "id": "trados",
    "name": "SDL Trados"
  },
  "quantityTypes": {
    "destination": { 
      "id": "6548c16d5136b418fd626e61", 
      "name": "Words" 
    },
    "conversionFactor": 1,
    "source": "words"
  },
  "mappings": [
    {
      "match": { 
        "id": "655c61aa0ecf6202a9edb710", 
        "name": "0%" 
      },
      "toolMatches": [
        "new", 
        "fuzzy5074"
      ]
    },
    {
      "match": { 
        "id": "655c61a70ecf6202a9edb70e", 
        "name": "100%" 
      },
      "toolMatches": [
        "perfect",
        "inContextExact",
        "exact",
        "crossFileRepeated",
        "repeated"
      ]
    },
    {
      "match": { 
        "id": "655c61af0ecf6202a9edb712", 
        "name": "Fuzzies" 
      },
      "toolMatches": [
        "fuzzy7584", 
        "fuzzy8594", 
        "fuzzy9599"
      ]
    }
  ]
}
GET/v2/account/cat-configurations

List all CAT configurations

This endpoint allows you to retrieve all the CAT configurations.

Request

GET
/v2/account/cat-configurations
curl -G https://api.lsp.expert/v2/account/cat-configurations \
  -u {key}:

Response

[
  {
    "id": "66cc27f8d263fd1bbb5e50d6",
    "name": "Trados Demo",
    "catTool": {
      "id": "trados",
      "name": "SDL Trados"
    },
    "quantityTypes": {
      "destination": { 
        "id": "6548c16d5136b418fd626e61", 
        "name": "Words" 
      },
      "conversionFactor": 1,
      "source": "words"
    },
    "mappings": [
      {
        "match": { 
          "id": "655c61aa0ecf6202a9edb710", 
          "name": "0%" 
        },
        "toolMatches": [
          "new", 
          "fuzzy5074"
        ]
      },
      {
        "match": { 
          "id": "655c61a70ecf6202a9edb70e", 
          "name": "100%" 
        },
        "toolMatches": [
          "perfect",
          "inContextExact",
          "exact",
          "crossFileRepeated",
          "repeated"
        ]
      },
      {
        "match": { 
          "id": "655c61af0ecf6202a9edb712", 
          "name": "Fuzzies" 
        },
        "toolMatches": [
          "fuzzy7584", 
          "fuzzy8594", 
          "fuzzy9599"
        ]
      }
    ]
  }
]
GET/v2/account/cat-configurations/cat-tools

List all CAT tools

This endpoint allows you to retrieve all the CAT tools that you can configure a CAT configuration with.

Request

GET
/v2/account/cat-configurations/cat-tools
curl -G https://api.lsp.expert/v2/account/cat-configurations/cat-tools \
  -u {key}:

Response

[
  {
    "id": "trados",
    "name": "SDL Trados",
    "matches": [
      "perfect",
      "inContextExact",
      "exact",
      "locked",
      "crossFileRepeated",
      "repeated",
      "new",
      "fuzzy5074",
      "fuzzy7584",
      "fuzzy8594",
      "fuzzy9599",
      "newBaseline",
      "newLearnings",
      "internalFuzzy5074",
      "internalFuzzy7584",
      "internalFuzzy8594",
      "internalFuzzy9599"
    ],
    "quantityTypes": { 
      "default": "words", 
      "list": ["words", "characters"] 
    }
  },
  {
    "id": "memoq",
    // ...
  }
]
POST/v2/account/cat-configurations

Create a CAT Configuration

This endpoint allows you to add a new CAT configuration.

Parameters

  • namestring Required

    The name of the configuration.

  • catToolstring Required

    The CAT tool id for the configuration.

  • conversionFactornumber Required

    The conversion factor between the source and destination quantity types (default is 1).

  • destinationQuantityTypestring Required

    The LSP.expert quantity type id.

  • sourceQuantityTypestring Required

    The CAT tool quantity type.

Request

POST
/v2/account/cat-configurations
curl https://api.lsp.expert/v2/account/cat-configurations \
  -u {key}: \
  -d name="Trados configuration" \
  -d catTool="trados" \
  -d conversionFactor=1
  -d destinationQuantityType="6548c16d5136b418fd626e61"
  -d sourceQuantityType="words"

Response

{
  "id": "66e7f69da9d8b6741f4a441d"
  "quantityTypes": {
    "destination": { 
        "id": "6548c16d5136b418fd626e61", 
        "name": "Words" 
    },
    "conversionFactor": 1,
    "source": "words"
  },
  "name": "Trados Configuration",
  "catTool": { 
    "id": "trados", 
    "name": "SDL Trados" 
  },
  "mappings": [],
}
GET/v2/account/cat-configurations/:id

Retrieve a CAT configuration

This endpoint allows you to retrieve a CAT configuration by providing their id.

Request

GET
/v2/account/cat-configurations/:id
curl https://api.lsp.expert/v2/account/cat-configurations/66e7f69da9d8b6741f4a441d \
  -u {key}:

Response

{
  "id": "66e7f69da9d8b6741f4a441d"
  "quantityTypes": {
    "destination": { 
        "id": "6548c16d5136b418fd626e61", 
        "name": "Words" 
    },
    "conversionFactor": 1,
    "source": "words"
  },
  "name": "Trados Configuration",
  "catTool": { 
    "id": "trados", 
    "name": "SDL Trados" 
  },
  "mappings": [],
}
PUT/v2/account/cat-configurations/:id

Update a CAT configuration

This endpoint allows you to perform an update on a CAT Configuration. Any parameters not provided will be left unchanged.

Parameters

  • namestring

    The name of the configuration.

  • conversionFactornumber

    The conversion factor between the source and destination quantity types.

  • destinationQuantityTypestring

    The LSP.expert quantity type id.

  • sourceQuantityTypestring

    The CAT tool quantity type.

Request

PUT
/v2/account/cat-configurations/:id
curl -X PUT https://api.lsp.expert/v2/account/cat-configurations/66e7f69da9d8b6741f4a441d \
  -u {key}: \
  -d name="Trados"

Response

{
  "id": "66e7f69da9d8b6741f4a441d"
  "quantityTypes": {
    "destination": { 
        "id": "6548c16d5136b418fd626e61", 
        "name": "Words" 
    },
    "conversionFactor": 1,
    "source": "words"
  },
  "name": "Trados",
  "catTool": { 
    "id": "trados", 
    "name": "SDL Trados" 
  },
  "mappings": [],
}
DELETE/v2/account/cat-configurations/:id

Delete a CAT configuration

This endpoint allows you to delete a CAT configuration.

Request

DELETE
/v2/account/cat-configurations/:id
curl -X DELETE https://api.lsp.expert/v2/account/cat-configurations/66e7f69da9d8b6741f4a441d \
  -u {key}:
POST/v2/account/cat-configurations/:id/match/:matchId/cat-tool-match/:catToolMatchId

Add a match for a CAT configuration

This endpoint allows you to add a new mapping configuration between a LSP.expert match and a CAT tool match for a CAT Configuration.

Request

DEL
/v2/account/cat-configurations/:id/match/:matchId/cat-tool-match/:catToolMatchId
curl https://api.lsp.expert/v2/account/cat-configurations/66e7f69da9d8b6741f4a441d/match/655c61aa0ecf6202a9edb710/cat-tool-match/new \
  -u {key}: \

Response

{
  "id": "66e7f69da9d8b6741f4a441d",
  "name": "Trados Configuration",
  "catTool": { "id": "trados", "name": "SDL Trados" },
  "quantityTypes": {
    "destination": { "id": "6548c16d5136b418fd626e61", "name": "Words" },
    "conversionFactor": 1,
    "source": "words"
  },
  "mappings": [{
    "match": { 
      "id": "655c61aa0ecf6202a9edb710", 
      "name": "0%" 
    },
    "toolMatches": ["new"]
  }]
}
PUT/v2/account/cat-configurations/:id/match/:matchId/move/:newPosition

Move a match for a CAT configuration

This endpoint allows you to move a mapping configuration between a LSP.expert match and a CAT tool match for a CAT Configuration. Note that this order is used when importing a file from a CAT tool.

Request

PUT
/v2/account/cat-configurations/:id/match/:matchId/move/:newPosition
curl https://api.lsp.expert/v2/account/cat-configurations/66e7f69da9d8b6741f4a441d/match/655c61aa0ecf6202a9edb710/move/1 \
  -u {key}: \

Response

{
  "id": "66e7f69da9d8b6741f4a441d",
  "name": "Trados Configuration",
  "catTool": { "id": "trados", "name": "SDL Trados" },
  "quantityTypes": {
    "destination": { "id": "6548c16d5136b418fd626e61", "name": "Words" },
    "conversionFactor": 1,
    "source": "words"
  },
  "mappings": [{
    "match": { 
      "id": "655c61a70ecf6202a9edb70e", 
      "name": "100%" 
    },
    "toolMatches": ["perfect"]
  },
  {
    "match": { 
      "id": "655c61aa0ecf6202a9edb710", 
      "name": "0%" 
    },
    "toolMatches": ["new"]
  }]
}
DEL/v2/account/cat-configurations/:id/match/:matchId/cat-tool-match/:catToolMatchId

Remove a match for a CAT configuration

This endpoint allows you to remove a new mapping configuration between a LSP.expert match and a CAT tool match for a CAT Configuration.

Request

POST
/v2/account/cat-configurations/:id/match/:matchId/cat-tool-match/:catToolMatchId
curl https://api.lsp.expert/v2/account/cat-configurations/66e7f69da9d8b6741f4a441d/match/655c61aa0ecf6202a9edb710/cat-tool-match/new \
  -u {key}:

Response

{
  "id": "66e7f69da9d8b6741f4a441d",
  "name": "Trados Configuration",
  "catTool": { "id": "trados", "name": "SDL Trados" },
  "quantityTypes": {
    "destination": { "id": "6548c16d5136b418fd626e61", "name": "Words" },
    "conversionFactor": 1,
    "source": "words"
  },
  "mappings": []
}