XTRF Home Portal API Server

{
  "server": {
    "url": "https://presentation.s.xtrf.eu/home-api"
  },
  "authentication": [
  {
    "schema_parameters": {
      "in": "header"
    },
    "type": "apiKey",
    "value": "API_KEY"
  }
],
  "operations": [
  {
    "description": "Searches for data (ie. customer, task, etc) and returns it in a CSV form.",
    "name": "browse_c_s_v"
  },
  {
    "description": "When a file is required by an operation (ie. task creation) it must be uploaded previously to the API. Uploading a file will result in a file token, which can be used to reference this file in other API calls.  Each file must be uploaded separately.  Keep in mind that file token has limited validity (ie. 10 minutes).  Therefore files must be uploaded just before issuing API call which reference them.",
    "name": "upload_file"
  },
  {
    "description": "Returns file metadata.",
    "name": "get_job_files_1"
  },
  {
    "description": "Downloads a file.",
    "name": "get_file_by_id"
  },
  {
    "description": "Returns several lists of files for a given task: input files divided by type, output files, bundles, files per job, preview files.",
    "name": "get_task_files"
  },
  {
    "description": "Adds files to a given task.",
    "name": "add_file"
  },
  {
    "description": "Returns list of files delivered in the job.",
    "name": "get_delivered_files"
  },
  {
    "description": "Uploads file to the project as a file delivered in the job. Only one file can be uploaded at once. When the upload is finished the file has to be added by specifying its category and languages (see \"PUT /jobs/{jobId}/files/add\" operation).",
    "name": "upload_file_1"
  },
  {
    "description": "Returns list of files shared with the job as Reference Files.",
    "name": "get_shared_reference_files"
  },
  {
    "description": "Returns list of files shared with the job as Work Files.",
    "name": "get_shared_work_files"
  },
  {
    "description": "Prepares a ZIP archive that contains the specified files.",
    "name": "archive"
  },
  {
    "description": "Returns details of a file.",
    "name": "get_file_by_id_2"
  },
  {
    "description": "Downloads a file content.",
    "name": "get_file_content_by_id"
  },
  {
    "description": "Returns list of files in a project. Only files added to the project (i.e. files that have assigned category and languages) are listed.",
    "name": "get_files"
  },
  {
    "description": "Adds files to the project as added by PM. The files have to be uploaded beforehand (see \"POST /v2/projects/{projectId}/files/upload\" operation). The following properties can be specified for each file:\u003cul\u003e\u003cli\u003ecategory (required, 400 Bad Request is returned otherwise)\u003c/li\u003e\u003cli\u003elanguageIds \u2013 when the file category depends on a list of languages\u003c/li\u003e\u003cli\u003elanguageCombinationIds \u2013 when the file category depends on a list of language combinations\u003c/li\u003e\u003c/ul\u003e",
    "name": "add_files_1"
  },
  {
    "description": "Returns list of files in a project, that are ready to be delivered to client. A file is considered deliverable to client when all of the following criteria are met:\u003cul\u003e\u003cli\u003ethe file was added to a job in the last step in the process\u003c/li\u003e\u003cli\u003ethe file is marked as verified (if it was added in a verification step and the file is verifiable, according to its category)\u003c/li\u003e\u003cli\u003ethe job is finished (has Ready status)\u003c/li\u003e\u003c/ul\u003e",
    "name": "get_deliverable_files"
  },
  {
    "description": "Uploads file to the project as a file uploaded by PM. Only one file can be uploaded at once. When the upload is finished the file has to be added by specifying its category and languages (see \"PUT /v2/projects/{projectId}/files/add\" operation",
    "name": "upload_file_2"
  },
  {
    "description": "Prepares a ZIP archive that contains the specified files.",
    "name": "archive_1"
  },
  {
    "description": "Returns details of a file.",
    "name": "get_file_by_id_3"
  },
  {
    "description": "Downloads a file content.",
    "name": "get_file_content_by_id_1"
  },
  {
    "description": "Uploads file to the quote as a file uploaded by PM. Only one file can be uploaded at once. When the upload is finished the file has to be added by specifying its category and languages (see \"PUT /v2/quotes/{quoteId}/files/add\" operation).",
    "name": "upload_file_3"
  }
]
}