Welcome to the Bureau Works API documentation. We're thrilled to have you here! Our API provides access to our localization and translation services, aiming to simplify your integration process and enhance your applications.
\nIn this documentation, you'll find straightforward information to get you started quickly. We've included details on endpoints, request parameters, and examples to guide you through the integration process smoothly.
\nWhether you're looking to expand your reach globally or improve your translation workflows, we're here to help. Our goal is to support you in achieving your objectives effectively and efficiently.
\nThank you for choosing Bureau Works API. Let's work together to create impactful multilingual experiences!
\nOur API can return a variety of error codes in different situations. Below, you'll find a list of possible errors and their respective codes that may be returned in response to requests.
\nUse this method to get the credentials necessary to access the API endpoints.
\nIf authentication is successful, returns a header X-AUTH-TOKEN that must be used in all subsequent API calls as a header with the same name.
Authentication endpoints.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"74966d37-af4d-40db-872a-420943bde2e6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"70dd582e-7adf-4718-af49-0860ec1d8f0f","type":"text/javascript","exec":[""]}}],"_postman_id":"9ad98d4f-55fc-4ce0-ac3b-64354a834cc9"},{"name":"Locale","item":[{"name":"Languages","event":[{"listen":"test","script":{"id":"3c92a859-75e5-4471-b3f9-c6d285e9fc5d","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"b0f746d7-488a-4a8c-b0e4-0e6e7fd15ac7","exec":[""],"type":"text/javascript"}}],"id":"27de623d-564e-4a38-827b-1d1570a53f7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/api/v3/language","description":"These are all available languages in Bureau Works. If your project demands a translation in a language that is not listed by this API, please contact us to resolve the issue.
\nYou must use the value in code field to populate requests with source or target languages.
Basic Metadata needed for managing projects in Bureau Works.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b335c59f-6e1a-4afc-98bb-80dcff726a6f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"af8f4eca-99e7-406e-b3db-5f62fe2243c9","type":"text/javascript","exec":[""]}}],"_postman_id":"0990497b-56b9-4fcf-aa4f-323bf0c26e12"},{"name":"Projects","item":[{"name":"List Projects","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a37aec8f-c310-4e14-825f-80d104e18e45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project?page=number&size=number&reference=string&name=string&status=&startCreateDate=string&endCreateDate=string&startDueDate=string&endDueDate=string&tags=&contactPersonUuid=string&projectManagerUuid=string&organizationUuid=string&orgUnitUuid=string&sourceQuery=string&fileName=string","description":"Multiple params project search
\n","urlObject":{"path":["api","v3","project"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. It's the page number. 0 for the first page. Default: 0
\n","type":"text/plain"},"key":"page","value":"number"},{"description":{"content":"Optional. It's the page size. Default: 50.
\n","type":"text/plain"},"key":"size","value":"number"},{"description":{"content":"Optional. It's the reference identifier.
\n","type":"text/plain"},"key":"reference","value":"string"},{"description":{"content":"Optional. It's the name of the entity.
\n","type":"text/plain"},"key":"name","value":"string"},{"description":{"content":"(array of string). Optional. It's the list of statuses.
\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"Optional. It's the start range for creation date. (YYYY-MM-DD)
\n","type":"text/plain"},"key":"startCreateDate","value":"string"},{"description":{"content":"Optional. It's the end range for creation date. (YYYY-MM-DD)
\n","type":"text/plain"},"key":"endCreateDate","value":"string"},{"description":{"content":"Optional. It's the start range for due date. (YYYY-MM-DD)
\n","type":"text/plain"},"key":"startDueDate","value":"string"},{"description":{"content":"Optional. It's the end range for due date. (YYYY-MM-DD)
\n","type":"text/plain"},"key":"endDueDate","value":"string"},{"description":{"content":"(array of string) Optional. It's the list of tags associated with the entity.
\n","type":"text/plain"},"key":"tags","value":""},{"description":{"content":"Optional. It's the UUID of the contact person.
\n","type":"text/plain"},"key":"contactPersonUuid","value":"string"},{"description":{"content":"Optional. It's the UUID of the project manager.
\n","type":"text/plain"},"key":"projectManagerUuid","value":"string"},{"description":{"content":"Optional. It's the UUID of the organization.
\n","type":"text/plain"},"key":"organizationUuid","value":"string"},{"description":{"content":"Optional. It's the UUID of the organizational unit.
\n","type":"text/plain"},"key":"orgUnitUuid","value":"string"},{"description":{"content":"Optional. It's the query string for the Source file content.
\n","type":"text/plain"},"key":"sourceQuery","value":"string"},{"description":{"content":"Optional. It's the name of the file.
\n","type":"text/plain"},"key":"fileName","value":"string"}],"variable":[]}},"response":[{"id":"16a31e8e-14ae-4efa-b21a-86e701b1a6db","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"string\",\n \"projectManagerUuid\": \"string\",\n \"orgUnitUuid\": \"string\",\n \"organizationUuid\": \"string\",\n \"startCreateDate\": \"YYYY-MM-DD\",\n \"endCreateDate\": \"YYYY-MM-DD\",\n \"startDueDate\": \"YYYY-MM-DD\",\n \"endDueDate\": \"YYYY-MM-DD\",\n \"tags\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/project?page&size&reference=&name=&status=&startCreateDate=&endCreateDate=&startDueDate=&endDueDate=&tags=&contactPersonUuid=&projectManagerUuid=&organizationUuid=&orgUnitUuid=&sourceQuery=&fileName=","host":["{{host}}"],"path":["api","v3","project"],"query":[{"key":"page","value":null,"description":"(number). Optional. It's the page number. 0 for the first page. Default: 0","type":"text"},{"key":"size","value":null,"description":"(number). Optional. It's the page size. Default: 50.","type":"text"},{"key":"reference","value":"","type":"text","description":"(string). Optional. It's the reference identifier."},{"key":"name","value":"","type":"text","description":"(string). Optional. It's the name of the entity."},{"key":"status","value":"","type":"text","description":"(array of string). Optional. It's the list of statuses."},{"key":"startCreateDate","value":"","type":"text","description":"(string). Optional. It's the start range for creation date. (YYYY-MM-DD)"},{"key":"endCreateDate","value":"","type":"text","description":"(string). Optional. It's the end range for creation date. (YYYY-MM-DD)"},{"key":"startDueDate","value":"","type":"text","description":"(string). Optional. It's the start range for due date. (YYYY-MM-DD)"},{"key":"endDueDate","value":"","type":"text","description":"(string). Optional. It's the end range for due date. (YYYY-MM-DD)"},{"key":"tags","value":"","type":"text","description":"(array of string). Optional. It's the list of tags associated with the entity."},{"key":"contactPersonUuid","value":"","type":"text","description":"(string). Optional. It's the UUID of the contact person."},{"key":"projectManagerUuid","value":"","type":"text","description":"(string). Optional. It's the UUID of the project manager."},{"key":"organizationUuid","value":"","type":"text","description":"(string). Optional. It's the UUID of the organization."},{"key":"orgUnitUuid","value":"","type":"text","description":"(string). Optional. It's the UUID of the organizational unit."},{"key":"sourceQuery","value":"","type":"text","description":"(string). Optional. It's the query string for the Source file content."},{"key":"fileName","value":"","type":"text","description":"(string). Optional. It's the name of the file."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 07 Dec 2020 14:11:11 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"uuid\": \"string\",\n \"name\": \"string\"\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"offset\": 0,\n \"pageNumber\": 0,\n \"pageSize\": 20,\n \"paged\": true,\n \"unpaged\": false\n },\n \"totalPages\": 1,\n \"totalElements\": 2,\n \"last\": true,\n \"size\": 20,\n \"number\": 0,\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"numberOfElements\": 2,\n \"first\": true,\n \"empty\": false\n}"}],"_postman_id":"a37aec8f-c310-4e14-825f-80d104e18e45"},{"name":"Get Project","event":[{"listen":"test","script":{"id":"b63a364e-b988-4147-96ef-742225fddec6","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"6922f0f2-d4c5-433a-b638-cd66ac435ae8","exec":[""],"type":"text/javascript","packages":{}}}],"id":"0e39eab1-f14e-4546-a809-e810073f2e0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID","description":"Retrieve single project
\n","urlObject":{"path":["api","v3","project",":projectUUID"],"host":["{{host}}"],"query":[{"disabled":true,"description":{"content":"Optional - The responseType parameter determines the format of the returned in the response. If responseType equals OVERVIEW_INFO (case-insensitive), the API enriches the response with additional overview information, such as progress, workflows, review files, and media file URLs and custom fields. Otherwise, it returns a standard response representation of the project.
Unique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"e2e6b360-50af-4f3f-9599-3af521dd28a5","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID","host":["{{host}}"],"path":["api","v3","project",":projectUUID"],"query":[{"key":"responseType","value":"string","description":"Optional - The `responseType` parameter determines the format of the returned in the response. If `responseType` equals `OVERVIEW_INFO` (case-insensitive), the API enriches the response with additional overview information, such as progress, workflows, review files, and media file URLs and custom fields. Otherwise, it returns a standard response representation of the project.","type":"text","disabled":true}],"variable":[{"key":"projectUUID","value":":projectUUID","description":"UUID of project to be retrieved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 07 Dec 2020 14:27:57 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"reference\": \"string\",\n \"timezone\": \"string\",\n \"genesisId\": \"string\",\n \"currency\": \"string\",\n \"sourceLocale\": \"string\",\n \"targetLocales\": [\n \"string\"\n ],\n \"createDate\": 0,\n \"status\": \"string\",\n \"client\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"contact\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"creator\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"assignee\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"tags\": [\n \"string\"\n ],\n \"resources\": [\n {\n \"uuid\": \"string\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"hash\": \"string\",\n \"notes\": \"string\",\n \"sourceLocale\": \"string\",\n \"creation\": 0,\n \"projectUuid\": \"string\",\n \"params\": {\n \"projectResourceId\": \"string\",\n \"applySourceSegmentation\": \"string\",\n \"parameters\": \"string\",\n \"parserFilter\": \"string\",\n \"tagRegex\": \"string\"\n },\n \"workflows\": [\n \"string\"\n ],\n \"targetLocales\": [\n \"string\"\n ]\n }\n ],\n \"workUnits\": [\n {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"string\",\n \"targetLanguage\": \"string\",\n \"filename\": \"string\",\n \"creationTimestamp\": 0,\n \"lastUpdate\": 0,\n \"sequence\": 1,\n \"workflow\": \"string\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n }\n ],\n \"costs\": [],\n \"referenceFiles\": [],\n \"dropFiles\": [],\n \"workflows\": [\n {\n \"name\": \"string\",\n \"index\": 0\n }\n ]\n}"}],"_postman_id":"0e39eab1-f14e-4546-a809-e810073f2e0a"},{"name":"Create Project","event":[{"listen":"test","script":{"id":"8f27655e-dbd7-464c-98ea-c0c8aa5e4f4b","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"50597471-82bb-42ca-8bb9-d77f5f60395b","exec":[""],"type":"text/javascript"}}],"id":"e0586332-d4f7-467e-a90a-c52285f551af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","type":"text","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"string\",\n \"orgUnitUUID\": \"string\",\n \"contactUUID\": \"string\",\n \"sourceLocale\": \"string\",\n \"notes\": \"string\",\n \"timezone\": \"string\",\n \"currency\": \"string\",\n \"tags\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project?inferDefaultSettings=true","description":"This will create a new Project in a DRAFT state. This means that the newly created project is ready to receive files associated with all workflows selected. You don’t need to upload files for all workflows, but usually, a Translation requires some files. Workflows that not necessarily require files are Interpretation, Consulting, Project Management, etc.
Optionally, you can set \"true\" as the value for the parameter inferDefaultSettings to automatically infer the default settings of a project based on its Organizational unit's settings, such as price list, currency, autopilot, and so on.
The DTO (Data Transfer Object) returned by this request is a simple representation of the Project. You will need some of this information in order to proceed.
\n","urlObject":{"path":["api","v3","project"],"host":["{{host}}"],"query":[{"key":"inferDefaultSettings","value":"true"}],"variable":[]}},"response":[{"id":"f912c4ed-e9cc-4900-a5a0-cbde3f882496","name":"201 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"string\",\n \"orgUnitUUID\": \"string\",\n \"contactUUID\": \"string\",\n \"sourceLocale\": \"string\",\n \"notes\": \"string\",\n \"timezone\": \"string\",\n \"currency\": \"string\",\n \"tags\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/project?inferDefaultSettings=true","host":["{{host}}"],"path":["api","v3","project"],"query":[{"key":"inferDefaultSettings","value":"true","type":"text"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 30 Nov 2020 16:56:52 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"reference\": \"string\",\n \"timezone\": \"string\",\n \"currency\": \"string\",\n \"sourceLocale\": \"string\",\n \"createDate\": 0,\n \"status\": \"string\",\n \"client\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"contact\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"creator\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"assignee\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"tags\": [],\n \"resources\": [],\n \"referenceFiles\": [],\n \"dropFiles\": []\n}"}],"_postman_id":"e0586332-d4f7-467e-a90a-c52285f551af"},{"name":"Create Project Resource","event":[{"listen":"test","script":{"id":"ae2ce2f7-ae22-42d5-9855-3f1feb4ff64c","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"eb4f3fec-2533-49c6-ac70-0fc3fc3bbdb6","exec":[""],"type":"text/javascript"}}],"id":"36e93e40-ee93-4a4c-9c30-cdf0621adbd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","type":"text","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"path\": \"string\",\n \"notes\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/resource","description":"Creates a project resource, which will allow uploading a file afterward.
\nThe name of the resource, specified in the body, must contain a file name with its extension. For example (but not limited to):
\nThe path should follow the file name standard.
\n","urlObject":{"path":["api","v3","project",":projectUUID","resource"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"69d70594-90af-457f-9bd9-11204b4e2ebb","name":"201 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","type":"text","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"path\": \"string\",\n \"notes\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/project/:projectUUID/resource","host":["{{host}}"],"path":["api","v3","project",":projectUUID","resource"],"variable":[{"key":"projectUUID","value":":projectUUID"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 30 Nov 2020 17:50:40 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"hash\": \"string\",\n \"notes\": \"string\",\n \"sourceLocale\": \"string\",\n \"creation\": 0,\n \"projectUuid\": \"string\",\n \"params\": {\n \"projectResourceId\": \"string\",\n \"applySourceSegmentation\": \"boolean\",\n \"parameters\": \"object\",\n \"parserFilter\": \"string\",\n \"tagRegex\": \"string\"\n },\n \"workflows\": [],\n \"targetLocales\": []\n}"}],"_postman_id":"36e93e40-ee93-4a4c-9c30-cdf0621adbd1"},{"name":"Get File Params","event":[{"listen":"test","script":{"id":"b63a364e-b988-4147-96ef-742225fddec6","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"6922f0f2-d4c5-433a-b638-cd66ac435ae8","exec":[""],"type":"text/javascript"}}],"id":"c3f20f2d-86a9-4257-b1c3-b4510aa6f316","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","type":"text","value":"{{token}}"}],"url":"{{host}}/api/v1/atlas/parser/file-params","description":"Retrieve the list of parameters for each type of file that will be used in the segmentation process.
\n","urlObject":{"path":["api","v1","atlas","parser","file-params"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"189804bf-ae8f-4e91-a0c0-50dd66a98754","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","type":"text","value":"{{token}}"}],"url":"{{host}}/api/v1/atlas/parser/file-params"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 07 Dec 2020 14:27:57 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"files\": {\n \"csv\": {\n \"label\": \"CSV\",\n \"filters\": {\n \"defaultFilter\": \"table_csv\",\n \"types\": {\n \"table_csv\": {\n \"name\": \"CSV (Comma-separated values files)\",\n \"order\": 0\n },\n \"table_fwc\": {\n \"name\": \"Fixed-Width Columns Table\",\n \"order\": 0\n }\n }\n },\n \"parameters\": {\n \"addQualifiers\": {\n \"type\": \"boolean\",\n \"value\": \"false\",\n \"title\": \"Add qualifiers to output when appropriate\",\n \"description\": \"If selected, upon output qualifiers will be added (if not already present) to any value that contains a field delimiter or line break as part of its textual content.\"\n },\n \"columnNamesLineNum\": {\n \"type\": \"int\",\n \"value\": \"1\",\n \"title\": \"Line with column names\",\n \"description\": \"Specify the number of the line containing column names (default 1, i.e. no line with column names).\"\n },\n \"commentColumns\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Comment Columns\",\n \"description\": \"Indicates which columns contain comments. Can be represented by one of the following string types: \\\"1\\\" - index (1-based) of the column, containing a comment or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns, containing a comment. Default: Empty\"\n },\n \"commentSourceRefs\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Comment Source Refs\",\n \"description\": \"Indicates which source columns the comment columns on the \\\"Comment Columns\\\" list correspond to. The comment extracted from a comment column will become a read-only NOTE property of the corresponding source column referred. If you need a comment translated, list its column on the \\\"Source Columns\\\" list. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing source text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns, containing source text. Default: Empty\"\n },\n \"detectColumnsMode\": {\n \"type\": \"int\",\n \"value\": \"0\",\n \"title\": \"Detect Columns Mode\",\n \"description\": \"Detect number of columns in the input. This option specifies the way of columns number detection: (0) - no detection is performed, if different rows contain different number of values, then different number of segments will be sent for different rows; (1) - number of columns is determined by the number of field names listed in the row. (2) - number of columns is explicitly specified by the \\\"Number of columns\\\" parameter. Default: 0\"\n },\n \"fieldDelimiter\": {\n \"type\": \"string\",\n \"value\": \",\",\n \"title\": \"Field Delimiter\",\n \"description\": \"Character separating fields in a row. Default is comma (,).\"\n },\n \"numColumns\": {\n \"type\": \"int\",\n \"value\": \"1\",\n \"title\": \"Number of columns\",\n \"description\": \"Number of columns in the input. This option is active only if \\\"Detect Columns Mode\\\" = 2. Extra columns are dropped, empty segments are created for missing columns. Default: 1\"\n },\n \"recordIdColumn\": {\n \"type\": \"int\",\n \"value\": \"0\",\n \"title\": \"Record Id Column\",\n \"description\": \"Index (1-based) of the column containing an optional record ID (or a key) of the current row in the table. Default: 0\"\n },\n \"removeQualifiers\": {\n \"type\": \"boolean\",\n \"value\": \"true\",\n \"title\": \"Exclude qualifiers from extracted text\",\n \"description\": \"If selected, qualifiers are removed from the text and go to the text units.\"\n },\n \"sendColumnsMode\": {\n \"type\": \"int\",\n \"value\": \"2\",\n \"title\": \"Send Columns Mode\",\n \"description\": \"Specifies values of which columns should be sent as text units: (0) - none of the columns are sent as text units; (1) - only values from the columns listed in \\\"Id Columns\\\", \\\"Source Columns\\\", \\\"Target Columns\\\", \\\"Comment Columns\\\" will be sent; (2) - values from all columns will be sent. Default: 2\"\n },\n \"sendHeaderMode\": {\n \"type\": \"int\",\n \"value\": \"1\",\n \"title\": \"Send Header Mode\",\n \"description\": \"If there are one or more lines containing description of the data, names of fields etc., and actual data don't start in the first line, then such first lines are considered a header, and this option specifies how to handle them: (0) - none of the header lines are sent as text units; (1) - only the values in the line specified by fieldNamesLineNum are sent as text units; (2) - values in all header lines are sent as text units. Default: 1\"\n },\n \"sourceColumns\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Source Columns\",\n \"description\": \"Indicates which columns contain source text. If this list is empty, then all columns of the table will be considered containing source text to be extracted. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing source text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns. Default: Empty\"\n },\n \"sourceIdColumns\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Source Id Columns\",\n \"description\": \"Indicates which columns contain source IDs. The source IDs become names of text units resources. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing source text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns. Default: Empty\"\n },\n \"sourceIdSourceRefs\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Source Id Suffixes\",\n \"description\": \"Indicates which source columns the source ID columns on this one list correspond to. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing source text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns, containing source text. Default: Empty\"\n },\n \"sourceIdSuffixes\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Source Id Suffixes\",\n \"description\": \"If there is the \\\"Record Id Column\\\" index, and a source ID for the given column is not specified in the \\\"Source Id Columns\\\", then the source ID for that column is compiled of the value in \\\"Record Id Column\\\" column, and the corresponding suffix in the \\\"Source Id Suffixes\\\". The source IDs become names of text unit resources. Default: Empty\"\n },\n \"targetColumns\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Target Columns\",\n \"description\": \"Indicates which columns contain target text. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing target text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns, containing target text. Default: Empty\"\n },\n \"targetSourceRefs\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Target Source Refs\",\n \"description\": \"Indicates which source columns the target columns on the \\\"Target Columns\\\" list correspond to. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing target text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns, containing target text. Default: Empty\"\n },\n \"textQualifier\": {\n \"type\": \"string\",\n \"value\": \"\\\"\",\n \"title\": \"Text Qualifier\",\n \"description\": \"Character before and after field value to allow field delimiters inside the field. For instance, this field will not be broken into parts though comma is a field delimiter: [\\\"Field, containing comma\\\"]. Default is the quotation mark (\\\").\"\n },\n \"trimMode\": {\n \"type\": \"int\",\n \"value\": \"1\",\n \"title\": \"Trim Mode\",\n \"description\": \"Specifies how field values are trimmed of spaces: (0) - field values are not trimmed; (1) - only non-qualified field values are trimmed, leading and trailing spaces remain in qualified fields; (2) - both non-qualified and qualified field values are trimmed of leading and trailing spaces. Default: 1\"\n },\n \"valuesStartLineNum\": {\n \"type\": \"int\",\n \"value\": \"2\",\n \"title\": \"Values start at line\",\n \"description\": \"Specify the line number of the first table row (default 2, the data start from the beginning of the file, no header presents).\"\n }\n },\n \"applySourceSegmentation\": true\n }\n }\n}"}],"_postman_id":"c3f20f2d-86a9-4257-b1c3-b4510aa6f316"},{"name":"Change Project Resource Params","event":[{"listen":"test","script":{"id":"ae2ce2f7-ae22-42d5-9855-3f1feb4ff64c","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"eb4f3fec-2533-49c6-ac70-0fc3fc3bbdb6","exec":[""],"type":"text/javascript","packages":{}}}],"id":"4d84725e-8d73-4a0c-adc7-bec60dc22e17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"applyAll\": \"boolean\",\n \"applySourceSegmentation\": \"boolean\",\n \"parameters\": \"object\",\n \"parserFilter\": \"string\",\n \"tagRegex\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/resource/:projectResourceUUID/file-params","description":"If you need to specify parameters for the parser process is needed to run this endpoint to update the project resource with the parameters that will be used to perform the segmentation of the file. To know which parameters can be used, just call the endpoint {{host}}/api/v1/atlas/parser/file-params (Get File Params) that retrieves the list of parameters for each type of file.
You can apply the change to a single file or to all files in the project with applyAll: true.
\nExample for a XLIFF2:
\n{\n \"applyAll\": true,\n \"applySourceSegmentation\": true,\n \"parserFilter\": \"xliff2\",\n \"parameters\": {\n \"forceUniqueIds\": true,\n ...\n \"escapeGT\": true,\n ...\n },\n \"tagRegex\": \"<[^>]+>\",\n \"extractTerms\": true,\n \"termsParams\": {\n \"minOccurrences\": 2,\n \"maxWordsPerTerm\": 3,\n ...\n },\n \"defaultFilterSettings\": true,\n \"extensionFile\": \"XLIFF\",\n \"segmentationParams\": null\n}\n\nWhen you upload a file using:POST {{host}}/api/v3/project/:projectUUID/resource
the response contains a params object that reflects the automatically detected parsing configuration for that file.
You can use this params object as a base to update the configuration using POST /file-params.
Simply modify the necessary fields (e.g. parserFilter, parameters, tagRegex) and send them back in the request body.
Unique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"},{"description":{"content":"Unique identifier of the Project Resource
\n","type":"text/plain"},"type":"any","value":"projectResourceUUID","key":"projectResourceUUID"}]}},"response":[{"id":"68ffd9aa-ed1c-45cf-927b-ca1d3d8d3d25","name":"201 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"applyAll\": \"boolean\",\n \"applySourceSegmentation\": \"boolean\",\n \"parameters\": \"object\",\n \"parserFilter\": \"string\",\n \"tagRegex\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/project/:projectUUID/resource/:projectResourceUUID/file-params","host":["{{host}}"],"path":["api","v3","project",":projectUUID","resource",":projectResourceUUID","file-params"],"variable":[{"key":"projectUUID","value":":projectUUID","description":"Unique identifier of the project"},{"key":"projectResourceUUID","value":":projectResourceUUID","description":"Unique identifier of the project resource"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 30 Nov 2020 17:50:40 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"hash\": \"string\",\n \"notes\": \"string\",\n \"sourceLocale\": \"string\",\n \"creation\": \"long\",\n \"projectUuid\": \"string\",\n \"params\": {\n \"applySourceSegmentation\": \"boolean\",\n \"extractTerms\": \"boolean\",\n \"termsParams\": \"object\",\n \"parameters\": \"object\",\n \"parserFilter\": \"string\",\n \"tagRegex\": \"string\",\n \"segmentationParams\": \"object\",\n \"extensionFile\": \"string\",\n \"defaultFilterSettings\": \"boolean\"\n },\n \"workflows\": [],\n \"targetLocales\": []\n}"}],"_postman_id":"4d84725e-8d73-4a0c-adc7-bec60dc22e17"},{"name":"Upload Project Resource Content","event":[{"listen":"test","script":{"id":"78d9b31d-75ff-45b7-973e-dcfd393a63f1","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"c0a5760e-02a9-42f4-bcbf-c93c5b2764ce","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f83f9301-fb61-4bac-9c05-f7236a9fbd35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"File whose content will be uploaded
\n","key":"file","type":"file","value":null}]},"url":"{{host}}/api/v3/project/:projectUUID/resource/:projectResourceUUID/content","description":"Uploads a file content and attaches it to a project resource.
\n","urlObject":{"path":["api","v3","project",":projectUUID","resource",":projectResourceUUID","content"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"},{"description":{"content":"Unique identifier of the Project Resource
\n","type":"text/plain"},"type":"string","value":"projectResourceUUID","key":"projectResourceUUID"}]}},"response":[{"id":"feb71d10-fe8a-42d5-8373-6e12102bd901","name":"200 - Success","originalRequest":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","type":"text","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[{"description":"File which content should be uploaded","key":"file","type":"file","value":null}]},"url":{"raw":"{{host}}/api/v3/project/:projectUUID/resource/:projectResourceUUID/content","host":["{{host}}"],"path":["api","v3","project",":projectUUID","resource",":projectResourceUUID","content"],"variable":[{"key":"projectUUID","type":"string","value":":projectUUID"},{"key":"projectResourceUUID","type":"string","value":":projectResourceUUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Mon, 30 Nov 2020 18:19:51 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f83f9301-fb61-4bac-9c05-f7236a9fbd35"},{"name":"Create Work Units","event":[{"listen":"test","script":{"id":"0646a08f-9f09-4805-a431-eea305ff4a12","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"a6a27a21-bcaa-41b0-90d3-ee805c573cb0","exec":[""],"type":"text/javascript","packages":{}}}],"id":"5f62a82f-a4b7-4321-ba1a-1885b9b02335","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"projectResourceUuid\": \"4092a2c0-782e-4709-a596-592f44ee3c3a\",\n \"workflows\": [\n \"TRANSLATION\",\n \"PROOFREADING\"\n ],\n \"targetLocales\": [\n \"pt_br\"\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/work-unit?bulk=true","description":"Creates work units for a number of project resources.
\nPossibles workflows:
\nTRANSCRIPTION \nTRANSLATION \nPROOFREADING \nREVIEW \nREVIEW_2 \nREVIEW_3 \nICR \nREGIONAL_APPROVAL \nICR_2 \nWEB_QA \nFEEDBACK_IMPLEMENTATION \nDTP \nQA \nSUBTITLING \nVIDEO_EDITING \nVOICEOVER \nSWORN \nINTERPRETATION \nDEVELOPMENT\n\nUnique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"e0223c32-8cc9-4d55-8023-b2fce3eb2004","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"projectResourceUuid\": \"string\",\n \"workflows\": [\n \"TRANSLATION\",\n \"PROOFREADING\"\n ],\n \"targetLocales\": [\n \"pt_br\",\n \"es_es\"\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/project/:projectUUID/work-unit?bulk=true","host":["{{host}}"],"path":["api","v3","project",":projectUUID","work-unit"],"query":[{"key":"bulk","value":"true"}],"variable":[{"key":"projectUUID","value":":projectUUID","description":"Unique identifier of the project"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 30 Nov 2020 21:04:49 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"en_us\",\n \"targetLanguage\": \"pt_br\",\n \"filename\": \"filename.txt\",\n \"creationTimestamp\": 1606770288509,\n \"lastUpdate\": 1606770288509,\n \"sequence\": 0,\n \"workflow\": \"TRANSLATION\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n },\n {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"en_us\",\n \"targetLanguage\": \"pt_br\",\n \"filename\": \"filename.txt\",\n \"creationTimestamp\": 1606770288513,\n \"lastUpdate\": 1606770288513,\n \"sequence\": 1,\n \"workflow\": \"PROOFREADING\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n },\n {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"en_us\",\n \"targetLanguage\": \"es_es\",\n \"filename\": \"filename.txt\",\n \"creationTimestamp\": 1606770288513,\n \"lastUpdate\": 1606770288513,\n \"sequence\": 0,\n \"workflow\": \"TRANSLATION\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n },\n {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"en_us\",\n \"targetLanguage\": \"es_es\",\n \"filename\": \"filename.txt\",\n \"creationTimestamp\": 1606770288513,\n \"lastUpdate\": 1606770288513,\n \"sequence\": 1,\n \"workflow\": \"PROOFREADING\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n }\n]"}],"_postman_id":"5f62a82f-a4b7-4321-ba1a-1885b9b02335"},{"name":"Change Project Status","event":[{"listen":"test","script":{"id":"ab91f606-edb4-4ddd-b445-4e1a8f977b9b","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"17df8bbf-63f7-4afa-ac52-3d69d5dd63c9","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"f95f4431-ff1b-4c85-969e-c04fd24e5c94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"string\",\n \"reason\": \"string\",\n \"calculateCosts\": true // optional: set to true on the first transition from DRAFT to PENDING to trigger cost calculation\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/status","description":"This will change the status of a project.
\nValid status and transitions are:
\nOptional body parameter
\ncalculateCosts (boolean, optional): set to true on the first transition from DRAFT to PENDING to trigger cost calculation.Unique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"3cf2efd5-5456-4258-8a04-c235a1f60823","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"newStatus\": \"PENDING\",\n \"reason\": \"string\",\n \"calculateCosts\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/project/:projectUUID/status","host":["{{host}}"],"path":["api","v3","project",":projectUUID","status"],"variable":[{"key":"projectUUID","value":":projectUUID","description":"Unique identifier of the project"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 07 Dec 2020 13:00:12 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"reference\": \"string\",\n \"timezone\": \"string\",\n \"currency\": \"string\",\n \"sourceLocale\": \"string\",\n \"createDate\": 0,\n \"status\": \"string\",\n \"client\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"contact\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"creator\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"assignee\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"tags\": [],\n \"resources\": [],\n \"costs\": [],\n \"referenceFiles\": [],\n \"dropFiles\": []\n}"}],"_postman_id":"f95f4431-ff1b-4c85-969e-c04fd24e5c94"},{"name":"Download Project Translations","id":"0585e61a-3ff2-4076-a14d-d16110f58744","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/download?resources=array&locales=array","description":"Download translated files from a project.
\n","urlObject":{"path":["api","v3","project",":projectUUID","download"],"host":["{{host}}"],"query":[{"description":{"content":"Optional - Filter download by list of project resources UUIDs. If empty, download translation results for all files.
\n","type":"text/plain"},"key":"resources","value":"array"},{"description":{"content":"Optional - Filter download by list of target languages. If empty, download translation results in all languages
\n","type":"text/plain"},"key":"locales","value":"array"}],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"d68940d7-07eb-40f2-8bcd-2dbc90104f95","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/download","host":["{{host}}"],"path":["api","v3","project",":projectUUID","download"],"variable":[{"key":"projectUUID","value":":projectUUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Content-Disposition","value":"form-data; name=\"translations.zip\"; filename=\"translations.zip\""},{"key":"Cache-Control","value":"must-revalidate, post-check=0, pre-check=0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/zip"},{"key":"Content-Length","value":"2928"},{"key":"Date","value":"Mon, 30 Nov 2020 20:22:17 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"File content"}],"_postman_id":"0585e61a-3ff2-4076-a14d-d16110f58744"},{"name":"Download Project Translations Async","id":"1455b727-0aba-4510-8b48-f8e5801ddfce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/download?resources=array&locales=array","description":"Asynchronously download translated files from a project, ensuring seamless handling of large files without timeouts.
\n","urlObject":{"path":["api","v3","project",":projectUUID","download"],"host":["{{host}}"],"query":[{"key":"resources","value":"array"},{"key":"locales","value":"array"}],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"1bbc3f70-9c00-4eed-90bb-06c3e8c504f1","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/download","host":["{{host}}"],"path":["api","v3","project",":projectUUID","download"],"variable":[{"key":"projectUUID","value":":projectUUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Disposition","value":"form-data; name=\"translations.zip\"; filename=\"translations.zip\""},{"key":"Cache-Control","value":"must-revalidate, post-check=0, pre-check=0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"2928"},{"key":"Date","value":"Mon, 30 Nov 2020 20:22:17 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"requestUuid\": \"uuid\",\n \"status\": \"STARTED\"\n}"}],"_postman_id":"1455b727-0aba-4510-8b48-f8e5801ddfce"},{"name":"Download Project Translations Async Status","id":"0b23e82d-1fe2-459f-8e4f-4eeea62c69d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/download/:requestUUID/status","description":"Endpoint for checking the status of an asynchronous request. Poll this endpoint until the status is 'COMPLETED' and the download URL becomes available.
\nPossible statuses: STARTED, COMPLETED, FAILED.
Unique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"},{"description":{"content":"Request UUID, obtained from the response of the download request endpoint
\n","type":"text/plain"},"type":"any","value":"requestUUID","key":"requestUUID"}]}},"response":[{"id":"ed92c99b-d035-49aa-8b36-9f72068c8bd3","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/download","host":["{{host}}"],"path":["api","v3","project",":projectUUID","download"],"variable":[{"key":"projectUUID","value":":projectUUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Disposition","value":"form-data; name=\"translations.zip\"; filename=\"translations.zip\""},{"key":"Cache-Control","value":"must-revalidate, post-check=0, pre-check=0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"2928"},{"key":"Date","value":"Mon, 30 Nov 2020 20:22:17 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"requestUuid\": \"uuid\",\n \"status\": \"COMPLETED\",\n \"downloadUrl\": \"URL\"\n}"}],"_postman_id":"0b23e82d-1fe2-459f-8e4f-4eeea62c69d2"},{"name":"Download Continuous Project Translations","id":"2b7acda4-996e-4b74-840a-6040bae7fb00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/ci/:orgUnitUUID/:productTag/download?projectStatus=string&locales=array&filenames=array","description":"Download translated files from a project created with the Continuous API.
\n","urlObject":{"path":["api","v3","project","ci",":orgUnitUUID",":productTag","download"],"host":["{{host}}"],"query":[{"description":{"content":"Optional - The status of the continuous project from which the files will be downloaded. Valid statuses are: DRAFT, PENDING, APPROVED, DELIVERED and INVOICED. Defaults to DRAFT
Optional - Filter download by list of target languages. If empty, download translation results in all languages
\n","type":"text/plain"},"key":"locales","value":"array"},{"description":{"content":"Optional - Filter download by list of filenames. If empty, download translation results for all files.
\n","type":"text/plain"},"key":"filenames","value":"array"}],"variable":[{"description":{"content":"Unique identifier of the Org. Unit
\n","type":"text/plain"},"type":"string","value":"orgUnitUUID","key":"orgUnitUUID"},{"description":{"content":"Unique identifier of the Product Tag
\n","type":"text/plain"},"type":"string","value":"string","key":"productTag"}]}},"response":[{"id":"f8ff9a0e-8336-41c2-9143-9321df3a5bb0","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/ci/:orgUnitUUID/:productTag/download?projectStatus=string&locales=array&filenames=array","host":["{{host}}"],"path":["api","v3","project","ci",":orgUnitUUID",":productTag","download"],"query":[{"key":"projectStatus","value":"string"},{"key":"locales","value":"array"},{"key":"filenames","value":"array"}],"variable":[{"key":"orgUnitUUID","value":":orgUnitUUID","description":"The UUID of the organizational unit under which this project exists"},{"key":"productTag","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Content-Disposition","value":"form-data; name=\"translations.zip\"; filename=\"translations.zip\""},{"key":"Cache-Control","value":"must-revalidate, post-check=0, pre-check=0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/zip"},{"key":"Content-Length","value":"2928"},{"key":"Date","value":"Mon, 30 Nov 2020 20:22:17 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"File content"}],"_postman_id":"2b7acda4-996e-4b74-840a-6040bae7fb00"},{"name":"Bind Glossaries to Project","id":"49806842-c7fd-4c03-9878-2fa346b93101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"glossaries","value":"string","description":"List of glossaries UUIDs to bind to project
\n","type":"text"}]},"url":"{{host}}/api/v3/project/:projectUUID/glossaries","description":"Select glossaries to be used in a project
\n","urlObject":{"path":["api","v3","project",":projectUUID","glossaries"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"b65ac5bf-2a57-4945-8fdf-87f849c053ea","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"glossaries","value":"string","description":"List of glossaries UUIDs to bind to project","type":"text"},{"key":"glossaries","value":"string","type":"text"}]},"url":{"raw":"{{host}}/api/v3/project/:projectUUID/glossaries","host":["{{host}}"],"path":["api","v3","project",":projectUUID","glossaries"],"variable":[{"key":"projectUUID","value":":projectUUID","description":"Unique identifier of the project"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Mon, 07 Dec 2020 16:45:44 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"49806842-c7fd-4c03-9878-2fa346b93101"},{"name":"Bind TM to Project","id":"b42ea657-ee0b-4b51-a0a3-e7d3df143972","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"atlasTmId","value":"number","description":"ID of translation memory in Atlas
\n","type":"text"},{"key":"threshold","value":"number","description":"Optional - Double number representing the match threshold as a percentage. Defaults to 0.75
\n","type":"text"},{"key":"maxHits","value":"number","description":"Optional - Amount of segments to be returned on search. Those with highest match score will be returned. Defaults to 5
\n","type":"text"},{"key":"readOnly","value":"boolean","description":"Optional - Determines whether the TM will be read only. Defaults to false
\n","type":"text"}]},"url":"{{host}}/api/v3/project/:projectUUID/translation-memory","description":"Select glossaries to be used in a project
\n","urlObject":{"path":["api","v3","project",":projectUUID","translation-memory"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"3243a724-8d64-4d7b-9169-800ae735bc5f","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"atlasTmId\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/project/:projectUUID/translation-memory","host":["{{host}}"],"path":["api","v3","project",":projectUUID","translation-memory"],"variable":[{"key":"projectUUID","value":":projectUUID","description":"Unique identifier of the project"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Mon, 07 Dec 2020 16:45:44 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b42ea657-ee0b-4b51-a0a3-e7d3df143972"},{"name":"Request Download Project Translated Files","id":"dd3b8332-b901-4d8a-ad81-edfd2f4d83d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"projectId\": \"string\", // Option B\r\n \"workflowLevel\": 3, // Option B\r\n \"addSourceAndTargetSuffix\": true, \r\n \"downloadDeliverables\": false,\r\n \"workUnitUuids\": [\"string\"] // Option A\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUuid/translation-kit-job/translated-files","description":"Creates an asynchronous request to generate and download translated files for a project.
\nThe download scope can be defined in two different ways:
\nBy specific Work Units (workUnitUuids)
By project workflow level (projectId + workflowLevel)
The response returns an id, which represents the asynchronous download request identifier.
\n\nNote: Even when
\nprojectIdis provided in the request body, the endpoint must still be called under/project/{projectUuid}/....
You must define the download scope using one of the following approaches:
\nprojectId (UUID, optional)
The UUID of the project (typically the same as {projectUuid} in the path).
workflowLevel (integer, optional)
Represents the workflow step to download, based on the configured workflow sequence.
Example:
\n1 = First workflow step (e.g., Translation)
2 = Second workflow step (e.g., Review/Proofreading)
\n\nImportant: Provide either
\nworkUnitUuidsor (projectId+workflowLevel).
Supplying both may result in a validation error or undefined behavior depending on backend validation rules.
addSourceAndTargetSuffix (boolean, default: false)
If true, appends source and target locale suffixes to the generated filenames.
downloadDeliverables (boolean, default: false)
If true, includes deliverables/exportable files in the generated package (when applicable).
Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUuid"}]}},"response":[{"id":"5896757d-3aba-4c86-a3c3-3f39e221cd74","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"projectId\": \"string\",\r\n \"workflowLevel\": 3,\r\n \"lockitTypeJob\": \"string\",\r\n \"workUnitUuids\": [\"string\"],\r\n \"addSourceAndTargetSuffix\": true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://app.bwx.io/api/v3/project/:projectUuid/translation-kit-job/translated-files","protocol":"https","host":["app","bwx","io"],"path":["api","v3","project",":projectUuid","translation-kit-job","translated-files"],"variable":[{"key":"projectUuid","value":null,"description":"Project UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"status\": \"string\",\n \"creationDate\": 0,\n \"type\": \"string\"\n}"}],"_postman_id":"dd3b8332-b901-4d8a-ad81-edfd2f4d83d5"},{"name":"Download Project Translated Files","id":"5177451f-8f20-46de-b32e-5be7c3835073","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/translation-kit-job/:requestUUID","description":"Get the URL to download the translated files for the given project by providing the request uuid and the project uuid. The URL will be available when the status is COMPLETED.
Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"},{"description":{"content":"Unique identifier of the Request
\n","type":"text/plain"},"type":"any","value":"requestUUID","key":"requestUUID"}]}},"response":[{"id":"d1ed3ec1-255f-441a-ba1d-a6fc439d198d","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/translation-kit-job/:requestUUID","host":["{{host}}"],"path":["api","v3","project",":projectUUID","translation-kit-job",":requestUUID"],"variable":[{"key":"projectUUID","value":"","description":"Project UUID"},{"key":"requestUUID","value":null,"description":"Request UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"status\": \"string\",\n \"downloadFileUrl\": \"string\",\n \"startTime\": 0,\n \"endTime\": 0,\n \"creationDate\": 0,\n \"totalFiles\": 0,\n \"completedFiles\": 0,\n \"type\": \"string\"\n}"}],"_postman_id":"5177451f-8f20-46de-b32e-5be7c3835073"},{"name":"Get Project Resources","id":"ccf82bb2-e01d-4ba6-8cc0-779af655684e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/resource/simple","description":"List Project Resources by providing its UUID.
\n","urlObject":{"path":["api","v3","project",":projectUUID","resource","simple"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"52e445d1-ad12-416c-bb75-c8ffb526b13e","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/resource/simple","host":["{{host}}"],"path":["api","v3","project",":projectUUID","resource","simple"],"variable":[{"key":"projectUUID","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"uuid\": \"string\",\n \"name\": \"string\"\n }\n]"}],"_postman_id":"ccf82bb2-e01d-4ba6-8cc0-779af655684e"},{"name":"List Project Work Units","id":"5fdc1c8c-c431-4466-92a7-c9af0ab01149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/work-unit?workflows=string&targetLanguages=string&status=string&filenames=string&size=int&page=int","description":"List Project Work Units.
\nBasic call:
\nGET {{host}}/api/v3/project/:projectUUID/work-unit
Optional. Workflow filter (e.g., TRANSLATION, PROOFREADING, REVIEW, ICR).
Optional. Target languages filter (e.g., pt_br, en_us, es_es).
\n","type":"text/plain"},"key":"targetLanguages","value":"string"},{"description":{"content":"Optional. Status filter (NEW, CREATED, IN_PROGRESS, COMPLETED, APPROVED, REJECTED, DELIVERED, CANCELLED, FAILED).
Optional. File name filter (e.g., file.csv).
Optional. Page Size | Default: 50.
Optional. Page number | Default: 0.
Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"7f5ec7a4-0c40-4485-90f1-b58713cdc8fb","name":"200 -Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/work-unit","host":["{{host}}"],"path":["api","v3","project",":projectUUID","work-unit"],"variable":[{"key":"projectUUID","value":null}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"uuid\": \"b80bbe5b-167f-4f09-a034-f5e0f3a10d50\",\n \"orgUnitId\": \"50471172-c374-45bc-8817-4a4c29190d2c\",\n \"sourceLanguage\": \"en_us\",\n \"targetLanguage\": \"pt_br\",\n \"filename\": \"file.csv\",\n \"workflow\": \"TRANSLATION\",\n \"projectResource\": {\n \"uuid\": \"691d26a5-9bb5-4121-ab65-43a126d20cee\",\n \"name\": \"file.csv\",\n \"path\": \"file.csv\"\n },\n \"workStatus\": \"NEW\"\n }\n ],\n \"totalElements\": 1,\n \"totalPages\": 1,\n \"last\": true,\n \"size\": 1,\n \"number\": 0,\n \"numberOfElements\": 1,\n \"first\": true,\n \"empty\": false\n}"},{"id":"5161bafd-a57f-43ed-922c-c41a81ee1986","name":"200 - Pagination params","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/work-unit?size=25&page=0","host":["{{host}}"],"path":["api","v3","project",":projectUUID","work-unit"],"query":[{"key":"size","value":"25","description":"Page Size"},{"key":"page","value":"0","description":"Page number"}],"variable":[{"key":"projectUUID","value":null}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"uuid\": \"6d880dbc-ae94-459f-8e6c-13919defe6ae\",\n \"orgUnitId\": \"50471172-c374-45bc-8817-4a4c29190d2c\",\n \"sourceLanguage\": \"en_us\",\n \"targetLanguage\": \"es_es\",\n \"filename\": \"file.csv\",\n \"workflow\": \"TRANSLATION\",\n \"projectResource\": {\n \"uuid\": \"691d26a5-9bb5-4121-ab65-43a126d20cee\",\n \"name\": \"file.csv\",\n \"path\": \"file.csv\"\n },\n \"workStatus\": \"NEW\"\n },\n {\n \"uuid\": \"b80bbe5b-167f-4f09-a034-f5e0f3a10d50\",\n \"orgUnitId\": \"50471172-c374-45bc-8817-4a4c29190d2c\",\n \"sourceLanguage\": \"en_us\",\n \"targetLanguage\": \"pt_br\",\n \"filename\": \"file.csv\",\n \"workflow\": \"TRANSLATION\",\n \"projectResource\": {\n \"uuid\": \"691d26a5-9bb5-4121-ab65-43a126d20cee\",\n \"name\": \"file.csv\",\n \"path\": \"file.csv\"\n },\n \"workStatus\": \"NEW\"\n },\n {\n \"uuid\": \"75547333-541d-4535-bf94-d9e04799a9a8\",\n \"orgUnitId\": \"50471172-c374-45bc-8817-4a4c29190d2c\",\n \"sourceLanguage\": \"en_us\",\n \"targetLanguage\": \"es_es\",\n \"filename\": \"file.csv\",\n \"workflow\": \"PROOFREADING\",\n \"projectResource\": {\n \"uuid\": \"691d26a5-9bb5-4121-ab65-43a126d20cee\",\n \"name\": \"file.csv\",\n \"path\": \"file.csv\"\n },\n \"workStatus\": \"NEW\"\n },\n {\n \"uuid\": \"9a9ea9d2-848f-426e-b73e-d0c69855dfc7\",\n \"orgUnitId\": \"50471172-c374-45bc-8817-4a4c29190d2c\",\n \"sourceLanguage\": \"en_us\",\n \"targetLanguage\": \"pt_br\",\n \"filename\": \"file.csv\",\n \"workflow\": \"PROOFREADING\",\n \"projectResource\": {\n \"uuid\": \"691d26a5-9bb5-4121-ab65-43a126d20cee\",\n \"name\": \"file.csv\",\n \"path\": \"file.csv\"\n },\n \"workStatus\": \"NEW\"\n }\n ],\n \"totalElements\": 4,\n \"totalPages\": 1,\n \"last\": true,\n \"size\": 25,\n \"number\": 0,\n \"numberOfElements\": 4,\n \"first\": true,\n \"empty\": false\n}"},{"id":"246da1cb-8a61-4c39-803b-f732b70a92e9","name":"200 - Extra filters","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/work-unit?workflows=TRANSLATION&targetLanguages=pt_br&status=NEW&filenames=file.csv","host":["{{host}}"],"path":["api","v3","project",":projectUUID","work-unit"],"query":[{"key":"workflows","value":"TRANSLATION","description":"Workflow filter (e.g, TRANSLATION, PROOFREADING, REVIEW, ICR)"},{"key":"targetLanguages","value":"pt_br","description":"Target languages filter (e.g., pt_br, en_us, es_es)"},{"key":"status","value":"NEW","description":"Status filter (NEW, CREATED, IN_PROGRESS, COMPLETED, APPROVED, REJECTED, DELIVERED, CANCELLED, FAILED)"},{"key":"filenames","value":"file.csv","description":"FIle name filter"}],"variable":[{"key":"projectUUID","value":null}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"uuid\": \"b80bbe5b-167f-4f09-a034-f5e0f3a10d50\",\n \"orgUnitId\": \"50471172-c374-45bc-8817-4a4c29190d2c\",\n \"sourceLanguage\": \"en_us\",\n \"targetLanguage\": \"pt_br\",\n \"filename\": \"file.csv\",\n \"workflow\": \"TRANSLATION\",\n \"projectResource\": {\n \"uuid\": \"691d26a5-9bb5-4121-ab65-43a126d20cee\",\n \"name\": \"file.csv\",\n \"path\": \"file.csv\"\n },\n \"workStatus\": \"NEW\"\n }\n ],\n \"totalElements\": 1,\n \"totalPages\": 1,\n \"last\": true,\n \"size\": 1,\n \"number\": 0,\n \"numberOfElements\": 1,\n \"first\": true,\n \"empty\": false\n}"}],"_postman_id":"5fdc1c8c-c431-4466-92a7-c9af0ab01149"},{"name":"Request Export Project","event":[{"listen":"test","script":{"id":"18794b4d-56ec-4135-a6cd-defa703a0426","exec":["let responseData = pm.response.json();\r","\r","pm.environment.set(\"exportId\", responseData.id);\r","\r","let url = pm.request.url.toString();\r","let projectUUID = url.match(/project\\/([^\\/]+)\\/translation-kit-job/);\r","\r","if (projectUUID && projectUUID[1]) {\r"," pm.environment.set(\"projectUUID\", projectUUID[1]);\r","} else {\r"," console.error(\"Erro: projectUUID nĂŁo encontrado na URL.\");\r"," return;\r","}\r","\r","function checkExportStatus() {\r"," let projectUUID = pm.environment.get(\"projectUUID\");\r","\r"," pm.sendRequest({\r"," url: `http://localhost:8090/api/v3/project/${projectUUID}/translation-kit-job/${pm.environment.get(\"exportId\")}`,\r"," method: 'GET',\r"," header: {\r"," 'Content-Type': 'application/json'\r"," }\r"," }, function (err, res) {\r"," if (err) {\r"," console.log(\"Error in status request:\", err);\r"," } else {\r"," let statusResponse = res.json();\r"," \r"," if (statusResponse.status === \"COMPLETED\") {\r"," console.log(\"Export completed! Download link:\", statusResponse.downloadFileUrl);\r"," } else {\r"," console.log(\"Export still in progress. Trying again...\");\r"," \r"," setTimeout(checkExportStatus, 500);\r"," }\r"," }\r"," });\r","}\r","\r","setTimeout(checkExportStatus, 500);"],"type":"text/javascript","packages":{}}}],"id":"8a266d13-c96f-4238-a634-e4f475b47323","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"locKitTypeJob\": \"XLIFF\",\r\n \"workUnitUuids\": [\r\n \"d0bb5555-af33-4558-b3d7-01b3434e15555\",\r\n \"d0bb3332-af63-4663-b3d7-01b1212be1444\"\r\n ],\r\n \"projectId\": \"d0bb3555-af63-4363-b3d7-01b1212be2121\",\r\n \"workflowLevel\": 1,\r\n \"addSourceAndTargetSuffix\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/translation-kit-job/loc-kit","description":"Create an asynchronous request to export project.
\nlocKitTypeJob (string, required): The type of kit job. ( XLIFF or XLSX ).
\nworkUnitUuids (array): An array of work unit UUIDs. ( If you intend to download separate work units, provide the UUID here.)
\nprojectId (string): The UUID of the project. ( Fill in if you want to download the entire project. )
\nworkflowLevel (integer): The level of the workflow you want to export. ( Fill in if you want to download the complete project )
\nUse addSourceAndTargetSuffix to add or not a suffix with source and target locale to filename.
The response \"id\" is your request identification. Use in Download Export Project
ProjectUUID
\n","type":"text/plain"},"type":"any","value":"string","key":"projectUUID"}]}},"response":[{"id":"20f545d3-c55c-4a8e-ba06-4e08c89fd457","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"locKitTypeJob\": \"XLIFF\",\r\n \"workUnitUuids\": [\r\n \"d0bb5555-af33-4558-b3d7-01b3434e15555\",\r\n \"d0bb3332-af63-4663-b3d7-01b1212be1444\"\r\n ],\r\n \"projectId\": \"d0bb3555-af63-4363-b3d7-01b1212be2121\",\r\n \"workflowLevel\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/project/:projectUUID/translation-kit-job/loc-kit","host":["{{host}}"],"path":["api","v3","project",":projectUUID","translation-kit-job","loc-kit"],"variable":[{"key":"projectUUID","value":"string","description":"ProjectUUID"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"creatinDate\": 1731091940000,\n \"id\": \"60b195a3-1fa7-4a5e-wq96-0ef555fcbaaa5\",\n \"status\": \"STARTING\",\n \"type\": \"LOC_KIT\"\n}"}],"_postman_id":"8a266d13-c96f-4238-a634-e4f475b47323"},{"name":"Download Export Project","id":"20a48942-d2ee-4a02-a5c9-2dd6c0921307","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/translation-kit-job/:requestUUID","description":"Get the URL to download the project workflow by providing the request UUID and project UUID. If the status is STARTED the user must continue polling the GET endpoint until it changes to COMPLETED Only once the status is COMPLETED will the download URL be available.
Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"},{"description":{"content":"Unique identifier of the Request
\n","type":"text/plain"},"type":"any","value":"requestUUID","key":"requestUUID"}]}},"response":[{"id":"b7050e75-e220-4103-97c5-b1037cf6742f","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/translation-kit-job/:requestUUID","host":["{{host}}"],"path":["api","v3","project",":projectUUID","translation-kit-job",":requestUUID"],"variable":[{"key":"projectUUID","value":"projectUUID","description":"Unique identifier of the Project"},{"key":"requestUUID","value":"requestUUID","description":"Unique identifier of the Request"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"0\",\r\n \"status\": \"COMPLETED\",\r\n \"downloadFileUrl\": \"string\",\r\n \"startTime\": 0,\r\n \"endTime\": 0,\r\n \"creationDate\": 0,\r\n \"type\": \"LOC_KIT\"\r\n}"}],"_postman_id":"20a48942-d2ee-4a02-a5c9-2dd6c0921307"},{"name":"Download Original File","id":"917108f4-0ba7-4bdf-a43b-65ee18f684cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUuid/work-unit/:workUnitUuid/translation?:isXliff=false","description":"Get the URL to download the original file for a specific work unit. The endpoint returns presigned URLs for immediate download of the source file. Optionally, you can request the XLIFF format instead of the original file format by simply changing the isXliff parameter to true. For downloading source files from multiple work units, see the documentation for the Bulk Source Files endpoint.
Project UUID
\n","type":"text/plain"},"type":"any","value":"","key":"projectUuid"},{"description":{"content":"Work Unit UUID
\n","type":"text/plain"},"type":"any","value":"","key":"workUnitUuid"}]}},"response":[{"id":"38f49ea3-2b47-4331-8eff-5fa9eedfe2bc","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"connection","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUuid/work-unit/:workUnitUuid/translation?:isXliff=false","host":["{{host}}"],"path":["api","v3","project",":projectUuid","work-unit",":workUnitUuid","translation"],"query":[{"key":":isXliff","value":"false"}],"variable":[{"key":"projectUuid","value":"","description":"Project UUID"},{"key":"workUnitUuid","value":"","description":"Work Unit UUID"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"originalFileUrl\": \"string\",\r\n \"translatedFileUrl\": null,\r\n \"translationStatus\": \"string\",\r\n \"fileName\": null,\r\n \"deliverableFileUrl\": null,\r\n \"translatedFileCreationDate\": null\r\n}"}],"_postman_id":"917108f4-0ba7-4bdf-a43b-65ee18f684cc"},{"name":"Bulk Source Files","id":"007a5ea8-2d90-4822-a74b-258a798ba7bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"projectId\": \"UUID\",\r\n \"workUnitUuids\": [\"UUID\", \"UUID\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/translation-kit-job/source-files","description":"{{host}}/api/v3/project/:projectUUID/translation-kit-job/source-files\n\nDownload the original source files from a project. You can download files from specific work units or from entire project. The endpoint creates an asynchronous job that packages the requested files and returns a job object that can be polled for completion status. Once completed, the job provides a presigned URL for downloading a ZIP file containing all source files.
\nOption 1: Download Specific Work Units
\n{\n \"workUnitUuids\": [\"UUID\", \"UUID\", ...]\n}\n\nOption 2: Download the Complete Project
\n{\n \"projectId\": \"UUID\"\n}\n### **Detailed Parameters:**\n| Parameter | Type | Required | Description |\n|-----------|------|----------|-------------|\n| `projectId` | UUID | Conditional | Project UUID. Required when downloading a full project. |\n| `workUnitUuids` | Array<UUID> | Conditional | List of selected work unit UUIDs. Required when downloading specific work units. Must be `null` when using `projectId` |\n### Example Request\n``` bash\ncurl --location '{{host}}/api/v3/project/{{projectUuid}}/work-unit/{{workUnitUuid}}/translation?isXliff=false' \\\n--header 'Accept: application/json' \\\n--header 'X-AUTH-TOKEN: {{token}}'\n\n{\n \"id\": \"UUID\",\n \"status\": \"string\",\n \"totalFiles\": \"integer\",\n \"completedFiles\": \"integer\",\n \"downloadFileUrl\": \"string (URL)\",\n \"isTransient\": \"boolean\",\n \"createdAt\": \"timestamp\",\n \"updatedAt\": \"timestamp\"\n}\n\nResponse Fields:
\nCreate the Job: Make a POST request with the desired parameters
\nPolling: Take the the returned ID and use the documented endpoint Check Bulk Source Files Status every 2 seconds to check the status.
Download: When status = \"COMPLETED\", use the URL in downloadFileUrl to download the ZIP file
Project UUID
\n","type":"text/plain"},"type":"any","value":"","key":"projectUUID"}]}},"response":[{"id":"0ab417f3-772c-4219-a832-05e7d054d98c","name":"201 - Success","originalRequest":{"method":"GET","header":[{"key":"connection","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUuid/work-unit/:workUnitUuid/translation?:isXliff=false","host":["{{host}}"],"path":["api","v3","project",":projectUuid","work-unit",":workUnitUuid","translation"],"query":[{"key":":isXliff","value":"false"}],"variable":[{"key":"projectUuid","value":"","description":"Project UUID"},{"key":"workUnitUuid","value":"","description":"Work Unit UUID"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"originalFileUrl\": \"string\",\r\n \"translatedFileUrl\": null,\r\n \"translationStatus\": \"string\",\r\n \"fileName\": null,\r\n \"deliverableFileUrl\": null,\r\n \"translatedFileCreationDate\": null\r\n}"}],"_postman_id":"007a5ea8-2d90-4822-a74b-258a798ba7bf"},{"name":"Check Bulk Source Files Status","id":"2042d79e-f9bd-49cb-a7bf-706a6e92bb33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/translation-kit-job/:translationKitJobUUID","description":"{{host}}/api/v3/project/:projectUUID/translation-kit-job/:translationKitJobStatus\nChecks the status of the job started at the endpoint for Bulk Source Files
\n","urlObject":{"path":["api","v3","project",":projectUUID","translation-kit-job",":translationKitJobUUID"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Project UUID
\n","type":"text/plain"},"type":"any","value":"","key":"projectUUID"},{"description":{"content":"Job UUID
\n","type":"text/plain"},"type":"any","value":"","key":"translationKitJobUUID"}]}},"response":[{"id":"d28c2b05-356c-4929-b704-57b7f7ba1599","name":"200 Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/project/:projectUUID/translation-kit-job/:translationKitJobUUID","host":["{{host}}"],"path":["api","v3","project",":projectUUID","translation-kit-job",":translationKitJobUUID"],"variable":[{"key":"projectUUID","value":"","description":"Project UUID"},{"key":"translationKitJobUUID","value":"","description":"Job UUID"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"string\",\r\n \"status\": \"string\",\r\n \"downloadFileUrl\": \"string\",\r\n \"startTime\": \"Long\",\r\n \"endTime\": \"Long\",\r\n \"creationDate\": \"Long\",\r\n \"totalFiles\": \"integer\",\r\n \"completedFiles\": \"integer\",\r\n \"type\": \"string\"\r\n}"}],"_postman_id":"2042d79e-f9bd-49cb-a7bf-706a6e92bb33"},{"name":"Update Project Info","id":"19417dab-bc1f-49ad-9135-86996b4cb94f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"4e8d20b4-38c8-454d-8c87-ef6b8c57affd\",\n \"name\": \"B-2676-47942-6EC6\",\n \"reference\": \"Instruction Or Note Field\",\n \"currency\": \"USD\",\n \"sourceLocale\": \"pt_br\",\n \"isContinuous\": false,\n \"instructions\": \"Some instruction here\",\n \"status\": \"APPROVED\",\n \"client\": {\n \"uuid\": \"1676aa9d-0262-41dd-b48a-e2c1a4e8abac\",\n \"organization\": {\n \"id\": null,\n \"uuid\": \"6bbc1617-8d2d-4f55-a128-ba67e40db988\",\n \"name\": null,\n \"country\": null\n } \n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:ProjectUUID/info","description":"Updates an existing project's metadata and settings.
\nPOST/api/v3/project/{projectUUID}/infoProjectInfoDtoProjectInfoDto)This endpoint supports partial updates. In practice, all body fields are optional, but some fields have validation/behavior rules described below.
\n* name and reference are not strictly required in every request, but validation can require them to be non-blank depending on user role/project status.
** These automation-related fields are applied in this flow when automationEnabled is sent (it triggers the internal export-template update branch).
{\n \"name\": \"ACME Website Update\",\n \"reference\": \"ACME-2026-03\",\n \"notes\": \"Please prioritize legal pages first.\",\n \"instructions\": \"Keep terminology consistent with Q1 glossary.\",\n \"clientUUID\": \"9f92eac7-1fe4-4f1d-8e9d-84e4f8f77014\",\n \"contactUUID\": \"9d3871dd-5556-4aca-802f-6b7f58fbc8f7\",\n \"assigneeUUID\": \"ffea2335-889f-4ec0-97cd-4b7f3f42d9e2\",\n \"sourceLocale\": \"en_us\",\n \"dueDate\": 1773782400000,\n \"tags\": [\"marketing\", \"website\"],\n \"tmMatchOverRepetitionEnabled\": true,\n \"ntMatchOverRepetitionEnabled\": false,\n \"automationEnabled\": true,\n \"autopilotEnabled\": true,\n \"spellCheckerIgnoreWordsEnabled\": true,\n \"inferDefaultSettings\": false\n}\nReturns a ProjectDto (thin representation) with the updated project data.
Project management related endpoints.
\n","_postman_id":"a6b3d4d3-09f5-4aa1-9a2a-64ceae110740"},{"name":"Project Routing","item":[{"name":"Project Routing Config","id":"3dec18a4-7ad9-4a83-a743-b4c43dcde52a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"uuid\": null,\r\n \"name\": \"string\",\r\n \"sourceLanguage\": \"en_us\",\r\n \"restrictLangPerOrgUnit\": false,\r\n \"configOrgUnits\": [\r\n {\r\n \"id\": 0,\r\n \"name\": \"string\",\r\n \"uuid\": \"string\",\r\n \"country\": \"BR\",\r\n \"targetLanguages\": [\"pt_br\", \"es_es\"],\r\n \"workflows\": [\"TRANSLATION\", \"REVIEW\"],\r\n \"defaultContactPerson\": null,\r\n \"instructions\": \"string\",\r\n \"priceList\": {\r\n \"uuid\": \"string\",\r\n \"name\": \"string\"\r\n },\r\n \"glossaryList\": [\r\n {\r\n \"bwGlossaryId\": 0\r\n }\r\n ],\r\n \"tmList\": [\r\n {\r\n \"atlasTmId\": 0\r\n }\r\n ],\r\n \"organizationUuid\": \"string\"\r\n },\r\n {\r\n \"id\": 0,\r\n \"name\": \"string\",\r\n \"uuid\": \"string\",\r\n \"country\": \"ES\",\r\n \"targetLanguages\": [\"es_es\", \"ca_es\"],\r\n \"workflows\": [\"TRANSLATION\", \"REVIEW\", \"REVIEW_3\"],\r\n \"instructions\": \"string\",\r\n \"priceList\": {\r\n \"uuid\": \"string\",\r\n \"name\": \"string\"\r\n },\r\n \"glossaryList\": [\r\n {\r\n \"bwGlossaryId\": 0\r\n }\r\n ],\r\n \"tmList\": [\r\n {\r\n \"atlasTmId\": 0\r\n }\r\n ],\r\n \"organizationUuid\": \"string\"\r\n }\r\n ]\r\n}\r\n"},"url":"{{host}}/api/v3/multi-project/config/upsert","description":"It is necessary to create or update a configuration before creating Multi-Projects.
\nRequired Fields
\nOptional Fields
\nNecessary Resources
\n","urlObject":{"path":["api","v3","multi-project","config","upsert"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"c47818c8-64bf-4f8f-b6b6-e471ea47114a","name":"200 - success","originalRequest":{"method":"POST","header":[],"url":"{{host}}/api/v3/multi-project/config/upsert"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Thu, 05 Jan 2026 19:46:32 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"3dec18a4-7ad9-4a83-a743-b4c43dcde52a"},{"name":"List Project Routing Configs","id":"c269f7a0-7b66-476b-8b1c-a5a186febb6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/api/v3/multi-project?name=string&sourceLanguage=string&orgUnit=string&targetLanguages=string&page=number&size=number","description":"List all Project Routing configurations.
\n","urlObject":{"path":["api","v3","multi-project"],"host":["{{host}}"],"query":[{"description":{"content":"Optional - Filter configuration by name
\n","type":"text/plain"},"key":"name","value":"string"},{"description":{"content":"Optional - Filter by source language
\n","type":"text/plain"},"key":"sourceLanguage","value":"string"},{"description":{"content":"Optional - Organizational Unit UUID
\n","type":"text/plain"},"key":"orgUnit","value":"string"},{"description":{"content":"Optional - Filter by target languages
\n","type":"text/plain"},"key":"targetLanguages","value":"string"},{"description":{"content":"Optional - Page number
\n","type":"text/plain"},"key":"page","value":"number"},{"description":{"content":"Optional - Page size
\n","type":"text/plain"},"key":"size","value":"number"}],"variable":[]}},"response":[{"id":"fdf2a5b8-db6b-488e-9f77-015c3c8a7319","name":"200 - success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/v3/multi-project?name=string&sourceLanguage=string&orgUnit=string&targetLanguages=string&page=number&size=number","host":["{{host}}"],"path":["api","v3","multi-project"],"query":[{"key":"name","value":"string","description":"Optional - Filter configuration by name"},{"key":"sourceLanguage","value":"string","description":"Optional - Filter by source language"},{"key":"orgUnit","value":"string","description":"Optional - Organizational Unit UUID"},{"key":"targetLanguages","value":"string","description":"Optional - Filter by target languages"},{"key":"page","value":"number","description":"Optional - Page number"},{"key":"size","value":"number","description":"Optional - Page size"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Thu, 05 Jan 2026 19:46:32 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"content\": [\r\n {\r\n \"uuid\": \"string\",\r\n \"name\": \"string\",\r\n \"sourceLanguage\": \"en_us\",\r\n \"orgUnits\": [\"string\", \"string\"],\r\n \"targetLanguages\": [\"pt_br\", \"es_es\", \"ca_es\"]\r\n }\r\n ],\r\n \"pageable\": {\r\n \"pageNumber\": 0,\r\n \"pageSize\": 20\r\n },\r\n \"totalElements\": 1,\r\n \"totalPages\": 1\r\n}"}],"_postman_id":"c269f7a0-7b66-476b-8b1c-a5a186febb6f"},{"name":"Search Project Routing Config","id":"0c45300e-d249-495a-9de1-820d31379faf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/api/v3/multi-project/:configUuid","description":"Search for complete configuration details before creating projects.
\n","urlObject":{"path":["api","v3","multi-project",":configUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Configuration UUID
\n","type":"text/plain"},"type":"any","value":"configUUID","key":"configUuid"}]}},"response":[{"id":"e101c4da-7c88-4c1c-85d5-e139da036c5e","name":"200 - success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/v3/multi-project/:configUuid","host":["{{host}}"],"path":["api","v3","multi-project",":configUuid"],"variable":[{"key":"configUuid","value":"UUID","description":"Configuration UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Thu, 05 Jan 2026 19:46:32 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"uuid\": \"string\",\r\n \"name\": \"string\",\r\n \"sourceLanguage\": \"en_us\",\r\n \"restrictLangPerOrgUnit\": false,\r\n \"configOrgUnits\": [\r\n {\r\n \"id\": 0,\r\n \"uuid\": \"string\",\r\n \"name\": \"string\",\r\n \"country\": \"BR\",\r\n \"targetLanguages\": [\"pt_br\", \"es_es\"],\r\n \"workflows\": [\"TRANSLATION\", \"REVIEW\"],\r\n \"defaultContactPerson\": {\r\n \"id\": 0,\r\n \"name\": \"string\"\r\n },\r\n \"instructions\": \"string\",\r\n \"priceList\": {\r\n \"uuid\": \"string\",\r\n \"name\": \"string\"\r\n },\r\n \"glossaryList\": [\r\n {\r\n \"bwGlossaryId\": 0\r\n }\r\n ],\r\n \"tmList\": [\r\n {\r\n \"atlasTmId\": 0\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": 0,\r\n \"uuid\": \"string\",\r\n \"name\": \"string\",\r\n \"country\": \"ES\",\r\n \"targetLanguages\": [\"es_es\", \"ca_es\"],\r\n \"workflows\": [\"TRANSLATION\", \"REVIEW\", \"REVIEW_3\"],\r\n \"defaultContactPerson\": {\r\n \"id\": 0,\r\n \"name\": \"string\"\r\n },\r\n \"instructions\": \"string\",\r\n \"priceList\": {\r\n \"uuid\": \"string\",\r\n \"name\": \"string\"\r\n }\r\n }\r\n ]\r\n}"}],"_postman_id":"0c45300e-d249-495a-9de1-820d31379faf"},{"name":"Project Routing Base Project","id":"e06943fe-3d9a-4b47-9266-30377b190dd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{host}}/api/v3/project?id-only=true&clientUuid=String&sourceLocale=String","description":"The base project is an empty project used as a foundation and is automatically deleted after the creation of multi-projects. Do not attempt to reuse it.
\nRequired Fileds
\n","urlObject":{"path":["api","v3","project"],"host":["{{host}}"],"query":[{"description":{"content":"Required for creating empty projects
\n","type":"text/plain"},"key":"id-only","value":"true"},{"description":{"content":"Org Unit UUID
\n","type":"text/plain"},"key":"clientUuid","value":"String"},{"description":{"content":"Optional - Source locale (e.g., en-us)
\n","type":"text/plain"},"key":"sourceLocale","value":"String"}],"variable":[]}},"response":[{"id":"b8fcf15b-e7f9-4610-9975-a25331b6661d","name":"200 - success","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/api/v3/project?id-only=Boolean&clientUuid=String&sourceLocale=String","host":["{{host}}"],"path":["api","v3","project"],"query":[{"key":"id-only","value":"Boolean","description":"Required for creating empty projects ´true´"},{"key":"clientUuid","value":"String","description":"Optional - Org Unit UUID"},{"key":"sourceLocale","value":"String","description":"Optional - Source locale (e.g., en-us)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Thu, 05 Jan 2026 19:46:32 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"uuid\": \"string\",\r\n \"name\": \"string\",\r\n \"status\": \"DRAFT\",\r\n \"createDate\": 1707580800000\r\n}"}],"_postman_id":"e06943fe-3d9a-4b47-9266-30377b190dd3"},{"name":"Base Project Resources","id":"cd80b402-54fe-4ed0-8416-768d4a02538a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"string\",\r\n \"path\": \"string\",\r\n \"notes\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/resource","description":"Creates a project resource, which will allow uploading a file afterward.
\nThe name of the resource, specified in the body, must contain a file name with its extension. For example (but not limited to):
\nfile.json
\ndocument.docx
\nsample.yml
\nother.txt
\nThe path should follow the file name standard.
\n","urlObject":{"path":["api","v3","project",":projectUUID","resource"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"b8cdd753-ed35-4046-bef8-338bfdb64a62","name":"200 - success","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/resource","host":["{{host}}"],"path":["api","v3","project",":projectUUID","resource"],"variable":[{"key":"projectUUID","value":"projectUUID","description":"Unique identifier of the Project"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Thu, 05 Jan 2026 19:46:32 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"uuid\": \"string\",\r\n \"type\": \"string\",\r\n \"name\": \"string\",\r\n \"path\": \"string\",\r\n \"hash\": \"string\",\r\n \"notes\": \"string\",\r\n \"sourceLocale\": \"string\",\r\n \"creation\": 0,\r\n \"projectUuid\": \"string\",\r\n \"params\": {\r\n \"projectResourceId\": \"string\",\r\n \"applySourceSegmentation\": \"boolean\",\r\n \"parameters\": \"object\",\r\n \"parserFilter\": \"string\",\r\n \"tagRegex\": \"string\"\r\n },\r\n \"workflows\": [],\r\n \"targetLocales\": []\r\n}"}],"_postman_id":"cd80b402-54fe-4ed0-8416-768d4a02538a"},{"name":"Get File Params","event":[{"listen":"test","script":{"id":"b63a364e-b988-4147-96ef-742225fddec6","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"6922f0f2-d4c5-433a-b638-cd66ac435ae8","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"3fa9d3ec-d708-4043-a25d-7b31e2af7678","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v1/atlas/parser/file-params","description":"Retrieve the list of parameters for each type of file that will be used in the segmentation process.
\n","urlObject":{"path":["api","v1","atlas","parser","file-params"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"27c5f667-4af5-499f-8bf9-38569bb25851","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v1/atlas/parser/file-params"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 05 Jan 2026 19:46:32 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"files\": {\n \"csv\": {\n \"label\": \"CSV\",\n \"filters\": {\n \"defaultFilter\": \"table_csv\",\n \"types\": {\n \"table_csv\": {\n \"name\": \"CSV (Comma-separated values files)\",\n \"order\": 0\n },\n \"table_fwc\": {\n \"name\": \"Fixed-Width Columns Table\",\n \"order\": 0\n }\n }\n },\n \"parameters\": {\n \"addQualifiers\": {\n \"type\": \"boolean\",\n \"value\": \"false\",\n \"title\": \"Add qualifiers to output when appropriate\",\n \"description\": \"If selected, upon output qualifiers will be added (if not already present) to any value that contains a field delimiter or line break as part of its textual content.\"\n },\n \"columnNamesLineNum\": {\n \"type\": \"int\",\n \"value\": \"1\",\n \"title\": \"Line with column names\",\n \"description\": \"Specify the number of the line containing column names (default 1, i.e. no line with column names).\"\n },\n \"commentColumns\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Comment Columns\",\n \"description\": \"Indicates which columns contain comments. Can be represented by one of the following string types: \\\"1\\\" - index (1-based) of the column, containing a comment or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns, containing a comment. Default: Empty\"\n },\n \"commentSourceRefs\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Comment Source Refs\",\n \"description\": \"Indicates which source columns the comment columns on the \\\"Comment Columns\\\" list correspond to. The comment extracted from a comment column will become a read-only NOTE property of the corresponding source column referred. If you need a comment translated, list its column on the \\\"Source Columns\\\" list. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing source text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns, containing source text. Default: Empty\"\n },\n \"detectColumnsMode\": {\n \"type\": \"int\",\n \"value\": \"0\",\n \"title\": \"Detect Columns Mode\",\n \"description\": \"Detect number of columns in the input. This option specifies the way of columns number detection: (0) - no detection is performed, if different rows contain different number of values, then different number of segments will be sent for different rows; (1) - number of columns is determined by the number of field names listed in the row. (2) - number of columns is explicitly specified by the \\\"Number of columns\\\" parameter. Default: 0\"\n },\n \"fieldDelimiter\": {\n \"type\": \"string\",\n \"value\": \",\",\n \"title\": \"Field Delimiter\",\n \"description\": \"Character separating fields in a row. Default is comma (,).\"\n },\n \"numColumns\": {\n \"type\": \"int\",\n \"value\": \"1\",\n \"title\": \"Number of columns\",\n \"description\": \"Number of columns in the input. This option is active only if \\\"Detect Columns Mode\\\" = 2. Extra columns are dropped, empty segments are created for missing columns. Default: 1\"\n },\n \"recordIdColumn\": {\n \"type\": \"int\",\n \"value\": \"0\",\n \"title\": \"Record Id Column\",\n \"description\": \"Index (1-based) of the column containing an optional record ID (or a key) of the current row in the table. Default: 0\"\n },\n \"removeQualifiers\": {\n \"type\": \"boolean\",\n \"value\": \"true\",\n \"title\": \"Exclude qualifiers from extracted text\",\n \"description\": \"If selected, qualifiers are removed from the text and go to the text units.\"\n },\n \"sendColumnsMode\": {\n \"type\": \"int\",\n \"value\": \"2\",\n \"title\": \"Send Columns Mode\",\n \"description\": \"Specifies values of which columns should be sent as text units: (0) - none of the columns are sent as text units; (1) - only values from the columns listed in \\\"Id Columns\\\", \\\"Source Columns\\\", \\\"Target Columns\\\", \\\"Comment Columns\\\" will be sent; (2) - values from all columns will be sent. Default: 2\"\n },\n \"sendHeaderMode\": {\n \"type\": \"int\",\n \"value\": \"1\",\n \"title\": \"Send Header Mode\",\n \"description\": \"If there are one or more lines containing description of the data, names of fields etc., and actual data don't start in the first line, then such first lines are considered a header, and this option specifies how to handle them: (0) - none of the header lines are sent as text units; (1) - only the values in the line specified by fieldNamesLineNum are sent as text units; (2) - values in all header lines are sent as text units. Default: 1\"\n },\n \"sourceColumns\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Source Columns\",\n \"description\": \"Indicates which columns contain source text. If this list is empty, then all columns of the table will be considered containing source text to be extracted. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing source text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns. Default: Empty\"\n },\n \"sourceIdColumns\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Source Id Columns\",\n \"description\": \"Indicates which columns contain source IDs. The source IDs become names of text units resources. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing source text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns. Default: Empty\"\n },\n \"sourceIdSourceRefs\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Source Id Suffixes\",\n \"description\": \"Indicates which source columns the source ID columns on this one list correspond to. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing source text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns, containing source text. Default: Empty\"\n },\n \"sourceIdSuffixes\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Source Id Suffixes\",\n \"description\": \"If there is the \\\"Record Id Column\\\" index, and a source ID for the given column is not specified in the \\\"Source Id Columns\\\", then the source ID for that column is compiled of the value in \\\"Record Id Column\\\" column, and the corresponding suffix in the \\\"Source Id Suffixes\\\". The source IDs become names of text unit resources. Default: Empty\"\n },\n \"targetColumns\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Target Columns\",\n \"description\": \"Indicates which columns contain target text. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing target text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns, containing target text. Default: Empty\"\n },\n \"targetSourceRefs\": {\n \"type\": \"string\",\n \"value\": \"\",\n \"title\": \"Target Source Refs\",\n \"description\": \"Indicates which source columns the target columns on the \\\"Target Columns\\\" list correspond to. Can be represented by one of the following strings: \\\"1\\\" - index (1-based) of the column, containing target text or \\\"1,2,5\\\" - comma-delimited list (1-based) of indexes of the columns, containing target text. Default: Empty\"\n },\n \"textQualifier\": {\n \"type\": \"string\",\n \"value\": \"\\\"\",\n \"title\": \"Text Qualifier\",\n \"description\": \"Character before and after field value to allow field delimiters inside the field. For instance, this field will not be broken into parts though comma is a field delimiter: [\\\"Field, containing comma\\\"]. Default is the quotation mark (\\\").\"\n },\n \"trimMode\": {\n \"type\": \"int\",\n \"value\": \"1\",\n \"title\": \"Trim Mode\",\n \"description\": \"Specifies how field values are trimmed of spaces: (0) - field values are not trimmed; (1) - only non-qualified field values are trimmed, leading and trailing spaces remain in qualified fields; (2) - both non-qualified and qualified field values are trimmed of leading and trailing spaces. Default: 1\"\n },\n \"valuesStartLineNum\": {\n \"type\": \"int\",\n \"value\": \"2\",\n \"title\": \"Values start at line\",\n \"description\": \"Specify the line number of the first table row (default 2, the data start from the beginning of the file, no header presents).\"\n }\n },\n \"applySourceSegmentation\": true\n }\n }\n}"}],"_postman_id":"3fa9d3ec-d708-4043-a25d-7b31e2af7678"},{"name":"Upload Project Routing Resource Content","event":[{"listen":"test","script":{"id":"78d9b31d-75ff-45b7-973e-dcfd393a63f1","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"c0a5760e-02a9-42f4-bcbf-c93c5b2764ce","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0ccd8b72-2c33-464a-ade9-8cd8ebf23bfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"File whose content will be uploaded
\n","key":"file","type":"file","value":null}]},"url":"{{host}}/api/v3/project/:projectUUID/resource/:projectResourceUUID/content","description":"Uploads a file content and attaches it to a project resource.
\n","urlObject":{"path":["api","v3","project",":projectUUID","resource",":projectResourceUUID","content"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"string","value":"projectUUID","key":"projectUUID"},{"description":{"content":"Unique identifier of the Project Resource
\n","type":"text/plain"},"type":"string","value":"projectResourceUUID","key":"projectResourceUUID"}]}},"response":[{"id":"b9b85ae2-eab1-4e83-94d0-868a1e005f34","name":"200 - Success","originalRequest":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","type":"text","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[{"description":"File which content should be uploaded","key":"file","type":"file","value":null}]},"url":{"raw":"{{host}}/api/v3/project/:projectUUID/resource/:projectResourceUUID/content","host":["{{host}}"],"path":["api","v3","project",":projectUUID","resource",":projectResourceUUID","content"],"variable":[{"key":"projectUUID","type":"string","value":":projectUUID"},{"key":"projectResourceUUID","type":"string","value":":projectResourceUUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Mon, 30 Nov 2020 18:19:51 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0ccd8b72-2c33-464a-ade9-8cd8ebf23bfc"},{"name":"Project Routing Preview","id":"88727351-7ed8-44b7-a109-7d306f11f24a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\"pt_br\", \"en_us\"]"},"url":"{{host}}/api/v3/multi-project/:configUuid/preview","description":"Returns a preview of the projects that will be created based on the specified configuration.
\n","urlObject":{"path":["api","v3","multi-project",":configUuid","preview"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Configuration UUID
\n","type":"text/plain"},"type":"any","value":"configUUID","key":"configUuid"}]}},"response":[{"id":"6f7d9766-75a9-4e0c-9396-01553db72f79","name":"200 - success","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/api/v3/multi-project/:configUuid/preview","host":["{{host}}"],"path":["api","v3","multi-project",":configUuid","preview"],"variable":[{"key":"configUuid","value":"UUID","description":"Configuration UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Thu, 05 Jan 2026 19:46:32 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"88727351-7ed8-44b7-a109-7d306f11f24a"},{"name":"Create Project Routing","id":"d6aec274-c221-4f8a-8cd9-57c15d9ea623","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"baseProjectUuid\": \"string\",\r\n \"reference\": \"string\",\r\n \"sourceLanguage\": \"en_us\",\r\n \"projects\": [\r\n {\r\n \"id\": 0,\r\n \"uuid\": \"string\",\r\n \"targetLanguages\": [\"pt_br\", \"es_es\"],\r\n \"workflows\": [\"TRANSLATION\", \"REVIEW\"],\r\n \"defaultContactPerson\": {\r\n \"id\": 0\r\n },\r\n \"instructions\": \"string\",\r\n \"priceList\": {\r\n \"uuid\": \"string\"\r\n },\r\n \"glossaryList\": [\r\n {\r\n \"bwGlossaryId\": 0\r\n }\r\n ],\r\n \"tmList\": [\r\n {\r\n \"atlasTmId\": 0\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": 0,\r\n \"uuid\": \"string\",\r\n \"targetLanguages\": [\"es_es\", \"ca_es\"],\r\n \"workflows\": [\"TRANSLATION\", \"REVIEW\", \"REVIEW_3\"],\r\n \"defaultContactPerson\": {\r\n \"id\": 0\r\n },\r\n \"instructions\": \"string\",\r\n \"priceList\": {\r\n \"uuid\": \"string\"\r\n }\r\n }\r\n ]\r\n}"},"url":"{{host}}/api/v3/multi-project/:configUuid/project-create","description":"Creates projects based on configuration. Asynchronous processing. Use the status endpoint to monitor progress.
\nRequired Fields
\n","urlObject":{"path":["api","v3","multi-project",":configUuid","project-create"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Configuration UUID
\n","type":"text/plain"},"type":"any","value":"configUUID","key":"configUuid"}]}},"response":[{"id":"1b641d47-2c43-4e91-a26c-7593a5d56107","name":"200 - success","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/api/v3/multi-project/:configUuid/project-create","host":["{{host}}"],"path":["api","v3","multi-project",":configUuid","project-create"],"variable":[{"key":"configUuid","value":"UUID","description":"Configuration UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Thu, 05 Jan 2026 19:46:32 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"d6aec274-c221-4f8a-8cd9-57c15d9ea623"},{"name":"Project Routing Status","id":"819c6d9e-6c75-4605-b684-f5ad33b5f873","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/api/v3/multi-project/:baseProjectUuid/status","description":"Monitors the progress of project creation.
\nPossible Statuses:CREATING - Creation in progressCOMPLETED - Creation completedERROR - Error during creation
UUID of the base project used in its creation.
\n","type":"text/plain"},"type":"any","value":"baseProjectUUID","key":"baseProjectUuid"}]}},"response":[{"id":"347c0a21-4d6d-48ce-aa64-58c2235da491","name":"200 - success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/v3/multi-project/:baseProjectUuid/status","host":["{{host}}"],"path":["api","v3","multi-project",":baseProjectUuid","status"],"variable":[{"key":"baseProjectUuid","value":"UUID","description":"UUID of the base project used in its creation."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Thu, 05 Jan 2026 19:46:32 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"current\": 3,\r\n \"total\": 5,\r\n \"status\": \"CREATING\"\r\n}"}],"_postman_id":"819c6d9e-6c75-4605-b684-f5ad33b5f873"}],"id":"49447d1f-04b3-45a2-9396-4b4653c1f5b0","description":"Multi-Project management related endpoints.
\n","_postman_id":"49447d1f-04b3-45a2-9396-4b4653c1f5b0"},{"name":"Continuous Project","item":[{"name":"Get Continuous Project","id":"591128ac-dd9d-4464-830a-53f70f701d29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/ci/:orgUnitUUID/:productTag?projectStatus=string","description":"Creates a project using the continuous API.
\n","urlObject":{"path":["api","v3","project","ci",":orgUnitUUID",":productTag"],"host":["{{host}}"],"query":[{"description":{"content":"Optional - Status of the continuous project to find. Defaults to DRAFT
Unique identifier of the Org. Unit
\n","type":"text/plain"},"type":"string","value":"orgUnitUUID","key":"orgUnitUUID"},{"description":{"content":"Unique identifier of the Product Tag
\n","type":"text/plain"},"type":"string","value":"productTag","key":"productTag"}]}},"response":[{"id":"7ddb6d80-92ec-4f44-b722-1d021278822c","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","type":"text","value":"{{token}}"}],"url":{"raw":"{{host}}/api/v3/project/ci/:orgUnitUUID/:productTag?projectStatus=DRAFT","host":["{{host}}"],"path":["api","v3","project","ci",":orgUnitUUID",":productTag"],"query":[{"key":"projectStatus","value":"DRAFT","description":"Optional - Status of the continuous project to find. Defaults to `DRAFT`"}],"variable":[{"description":"The UUID of the organizational unit under which this project exists","key":"orgUnitUUID","value":":orgUnitUUID"},{"description":"The identifier of this continuous project","key":"productTag","value":":productTag"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 08 Dec 2020 18:31:52 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"reference\": \"string\",\n \"timezone\": \"string\",\n \"genesisId\": \"string\",\n \"currency\": \"string\",\n \"sourceLocale\": \"string\",\n \"targetLocales\": [\n \"string\"\n ],\n \"createDate\": 1607450025068,\n \"status\": \"DRAFT\",\n \"client\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"contact\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"creator\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"assignee\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"tags\": [\n \"continuous\",\n \"my-tag\"\n ],\n \"resources\": [\n {\n \"uuid\": \"string\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"hash\": \"string\",\n \"notes\": \"string\",\n \"sourceLocale\": \"string\",\n \"creation\": 0,\n \"projectUuid\": \"string\",\n \"params\": {\n \"projectResourceId\": \"string\",\n \"applySourceSegmentation\": \"string\",\n \"parameters\": \"string\",\n \"parserFilter\": \"string\",\n \"tagRegex\": \"string\"\n },\n \"workflows\": [],\n \"targetLocales\": []\n }\n ],\n \"workUnits\": [\n {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"string\",\n \"targetLanguage\": \"string\",\n \"filename\": \"string\",\n \"creationTimestamp\": 0,\n \"lastUpdate\": 0,\n \"sequence\": 0,\n \"workflow\": \"string\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n },\n {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"string\",\n \"targetLanguage\": \"string\",\n \"filename\": \"string\",\n \"creationTimestamp\": 0,\n \"lastUpdate\": 0,\n \"sequence\": 1,\n \"workflow\": \"string\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n },\n {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"string\",\n \"targetLanguage\": \"string\",\n \"filename\": \"string\",\n \"creationTimestamp\": 0,\n \"lastUpdate\": 0,\n \"sequence\": 0,\n \"workflow\": \"string\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n },\n {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"string\",\n \"targetLanguage\": \"string\",\n \"filename\": \"string\",\n \"creationTimestamp\": 0,\n \"lastUpdate\": 0,\n \"sequence\": 1,\n \"workflow\": \"string\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n }\n ],\n \"costs\": [],\n \"referenceFiles\": [],\n \"dropFiles\": [],\n \"workflows\": [\n {\n \"name\": \"TRANSLATION\",\n \"index\": 1\n },\n {\n \"name\": \"PROOFREADING\",\n \"index\": 2\n }\n ],\n \"continuous\": true\n}"}],"_postman_id":"591128ac-dd9d-4464-830a-53f70f701d29"},{"name":"Create Continuous Project","event":[{"listen":"test","script":{"id":"8f27655e-dbd7-464c-98ea-c0c8aa5e4f4b","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"50597471-82bb-42ca-8bb9-d77f5f60395b","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ba1594d0-e6d8-4b78-91ce-ed4eb8ed0047","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"orgUnitUUID\": \"sring\",\r\n \"contactUUID\": \"string\",\r\n \"ciTag\": \"string\",\r\n \"source\": \"en-us\",\r\n \"tags\": [\"string\", \"string\"],\r\n \"reference\": \"string\",\r\n \"instructions\": \"string\",\r\n \"notes\": \"string\",\r\n \"totalExpectedWorkUnits\": 50\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/ci","description":"This will create a new project using one of our integration plugins.
\nFile
\n","type":"file","value":null},{"key":"locales","value":"","description":"Optional - A list (array) of languages for which the uploaded files will be translated to. If none provided, languages set up in your organizational unit profile will be used. E.g. \"en-us\" for (English, United States).
\n","type":"text"},{"key":"reference","value":"","description":"Optional - This is required when creating a new project.
\n","type":"text"},{"key":"workflows","value":"","description":"Optional - List of desired workflows. If list is empty, the system will recommend workflows for the filetype
\n","type":"text"},{"key":"source","value":"","description":"Optional - The source language of the uploaded files. If not provided, will use the default language of the organizational unit. E.g. \"en-us\" for (English, United States).
\n","type":"text"},{"key":"tags","value":"","description":"Optional - List of extra tags to be added to project
\n","type":"text"}]},"url":"{{host}}/api/v3/project/ci/:orgUnitUUID/:ciTag","description":"Uploads a file to a continuous integration project. Creates the project if it doesn't exist. Requires the organizational unit UUID and CI Tag (:tag) as path parameters to locate the project. The request body should contain the file and related metadata. Returns the updated project information.
\nPOST /api/v3/project/ci/{orgUnitUUID}/{ciTag}
orgUnitUUID and ciTag are required to locate the project in the database.
This endpoint is documented as an update to an existing continuous project.
\nciTag is returned in the response body when a new continuous project is created. This is the same ciTag provided when the project was created.
Content-Type: multipart/form-data
DTO fields:
\nfile (required)
source (optional, defaults to the org unit source if omitted)
locales (optional, defaults to the org unit targets if omitted)
workflows (optional)
reference (optional, not used to locate the project)
path, tags (optional)
The decision is based on the file name and the content hash:
\nCreates the file resource.
\nCreates work units for all locales in locales.
Replaces the existing resource.
\nRecreates work units for the locales in locales.
If the request includes new target locales not yet present for that file,
creates only the missing work units.
If there are no new targets, the upload is a no-op and the project is returned.
\nTo add a new target language after the initial upload, send a new request to the same path
with the same orgUnitUUID and ciTag, including the new locales in locales.
Existing targets are preserved and only missing work units are created.
Returns ProjectDto for the continuous project.
200 when changes are applied (new file or new targets).
202 when no changes are required (same file and same targets).
If locales is empty and the org unit has no default targets, the request fails.
A per-file lock prevents concurrent uploads of the same file; in that case the call is rejected.
\nNOTE: For more information on how to add/update instructions for a task, please refer to the documentation for the Create Or Update Instruction endpoint in the Task endpoints.
Unique identifier of the Org. Unit
\n","type":"text/plain"},"type":"any","value":"orgUnitUUID","key":"orgUnitUUID"},{"description":{"content":"Identifier for continuous project
\n","type":"text/plain"},"type":"any","value":"ciTag","key":"ciTag"}]}},"response":[{"id":"c7d5592b-fadf-4252-97e1-b7ae6d0015fb","name":"201 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"File","type":"file","value":null},{"key":"locales","value":"","description":"List of language codes, e.g. \"en-us\" for (English, United States).","type":"text"},{"key":"reference","value":"","description":"Project Reference","type":"text"},{"key":"workflows","value":"","description":"List of Workflows","type":"text"},{"key":"source","value":"","description":"Source Language. e.g. \"en-us\" for (English, United States).","type":"text"},{"key":"tags","value":"","description":"List of optional extra tags","type":"text"}]},"url":{"raw":"{{host}}/api/v3/project/ci/:orgUnitUUID/:ciTag","host":["{{host}}"],"path":["api","v3","project","ci",":orgUnitUUID",":ciTag"],"variable":[{"key":"orgUnitUUID","value":"","description":"Org.Unit UUID"},{"key":"ciTag","value":"","description":"Identifier for continuous project"}]}},"_postman_previewlanguage":null,"header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Tue, 08 Dec 2020 18:31:52 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"16e8ef39-82b4-49c2-8911-79795afffc07"}],"id":"b41f75e0-c949-4bcc-9eba-fdb406cb28be","description":"Continuous Project management related endpoints.
\n","_postman_id":"b41f75e0-c949-4bcc-9eba-fdb406cb28be"},{"name":"Project Costs","item":[{"name":"Costs Summary","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"561ee443-b76e-4a97-841b-5124dbf14cc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/costs-summary","description":"Get costs summary of project.
\n","urlObject":{"path":["api","v3","project",":projectUUID","costs-summary"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"8d8323da-2785-4f08-978f-d2826b8ad009","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/costs-summary","host":["{{host}}"],"path":["api","v3","project",":projectUUID","costs-summary"],"variable":[{"key":"projectUUID","value":"UUID","description":"UUID of project to be retrieved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 20 Sep 2024 16:43:41 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"langPairCosts\": [\n {\n \"sourceLang\": \"string\",\n \"targetLang\": \"string\",\n \"words\": 100,\n \"totalCost\": 10,\n \"wordsPerHour\": 100,\n \"chargeBy\": \"string\"\n }\n ],\n \"totalCost\": 10\n}"}],"_postman_id":"561ee443-b76e-4a97-841b-5124dbf14cc3"},{"name":"Total Costs","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"55f571de-d7a3-4716-a085-aa202c7c154d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/total-costs","description":"Get total costs of project.
\n","urlObject":{"path":["api","v3","project",":projectUUID","total-costs"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"9f668b87-4e8c-43bf-b811-6ed540bed290","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/total-costs","host":["{{host}}"],"path":["api","v3","project",":projectUUID","total-costs"],"variable":[{"key":"projectUUID","value":"","description":"UUID of project to be retrieved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 20 Sep 2024 16:43:41 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"grossCost\": 100,\n \"netCost\": 100,\n \"totalSavings\": 0.00,\n \"totalCalculatedCost\": 0.0,\n \"minimumFeeApplied\": false,\n \"costInfoDtoList\": [\n {\n \"uuid\": \"string\",\n \"costValue\": 0.01,\n \"costType\": \"string\",\n \"amount\": 1.0,\n \"costUnitType\": \"string\",\n \"description\": \"string\",\n \"calculatedCost\": 0.01,\n \"reason\": null,\n \"noPriceList\": true\n }\n ]\n}"}],"_postman_id":"55f571de-d7a3-4716-a085-aa202c7c154d"},{"name":"Costs Price Types","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"e7c31be2-43c8-46cf-99e7-564af272e213","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/cost/priceTypes?byLanguage=boolean","description":"Get costs associated with a pair of languages ​​in project.
\n","urlObject":{"path":["api","v3","project",":projectUUID","cost","priceTypes"],"host":["{{host}}"],"query":[{"description":{"content":"Determines how pricing factors are separated. Set to true to separate translation-related fees, or false to separate costs related to others.
Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"61d7bee2-e2f5-4eb1-a6dc-6c52871a1dec","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/cost/priceTypes?byLanguage=boolean","host":["{{host}}"],"path":["api","v3","project",":projectUUID","cost","priceTypes"],"query":[{"key":"byLanguage","value":"boolean","description":"Determines how pricing factors are separated. Set to `true` to separate translation-related fees, or `false` to separate costs related to others."}],"variable":[{"key":"projectUUID","value":"","description":"UUID of project to be retrieved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 20 Sep 2024 18:10:07 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 0,\n \"uuid\": \"string\",\n \"description\": \"string\",\n \"mapping\": [],\n \"rateType\": \"string\",\n \"priceUnit\": \"string\",\n \"type\": \"string\"\n }\n]"}],"_postman_id":"e7c31be2-43c8-46cf-99e7-564af272e213"},{"name":"Costs to Language Pair","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f2d414a1-dbe6-400f-b752-1c39b590a7d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/costs/lang-pair?sourceLang=string&targetLang=string","description":"Get costs associated with a pair of languages ​​in project.
\n","urlObject":{"path":["api","v3","project",":projectUUID","costs","lang-pair"],"host":["{{host}}"],"query":[{"description":{"content":"It's the language code for the source translation, e.g. \"en_us\" for English, United States.
\n","type":"text/plain"},"key":"sourceLang","value":"string"},{"description":{"content":"It's the language code for the target translation, e.g. \"pt_br\" for Portuguese, Brazil.
\n","type":"text/plain"},"key":"targetLang","value":"string"}],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"6af751e9-76e9-468b-99d5-7be39d9151c2","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/costs/lang-pair?sourceLang=string&targetLang=string","host":["{{host}}"],"path":["api","v3","project",":projectUUID","costs","lang-pair"],"query":[{"key":"sourceLang","value":"string","description":"It's the language code for the source translation, e.g. \"en_us\" for English, United States."},{"key":"targetLang","value":"string","description":"It's the language code for the target translation, e.g. \"pt_br\" for Portuguese, Brazil."}],"variable":[{"key":"projectUUID","value":"","description":"UUID of project to be retrieved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 20 Sep 2024 17:12:05 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"matchType\": \"string\",\n \"words\": 1000,\n \"costPerItem\": 0.2,\n \"totalCost\": 100,\n \"displayOrder\": null,\n \"isManualCost\": false\n }\n]"}],"_postman_id":"f2d414a1-dbe6-400f-b752-1c39b590a7d7"},{"name":"Create Cost","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a98b3a74-60c4-46b1-bf04-a0ab1364027f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/async/calculate/cost?projectUUID=string&requestId=string","description":"Add costs in the project.
\n","urlObject":{"path":["api","v3","project",":projectUUID","async","calculate","cost"],"host":["{{host}}"],"query":[{"description":{"content":"UUID of the project for which costs will be calculated.
\n","type":"text/plain"},"key":"projectUUID","value":"string"},{"description":{"content":"Optional. Async request ID, used to identify a previous request. If not provided, a new request will be created.
\n","type":"text/plain"},"key":"requestId","value":"string"}],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"b4e65e51-00f6-4166-a359-a1bad63354ba","name":"202 - Accepted","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/async/calculate/cost?projectUUID=string&requestId=string","host":["{{host}}"],"path":["api","v3","project",":projectUUID","async","calculate","cost"],"query":[{"key":"projectUUID","value":"string","description":"UUID of the project for which costs will be calculated."},{"key":"requestId","value":"string","description":"Optional. Async request ID, used to identify a previous request. If not provided, a new request will be created."}],"variable":[{"key":"projectUUID","value":"","description":"UUID of project to be retrieved"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 20 Sep 2024 19:31:46 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"status\": \"string\",\n \"data\": null,\n \"error\": null\n}"}],"_postman_id":"a98b3a74-60c4-46b1-bf04-a0ab1364027f"},{"name":"Costs Recalculate","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"63eb0736-6738-4cbc-8f03-58c014bd1f07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/recalculate/costs?projectUUID=string&requestId=string","description":"Recalculates the total project costs.
\n","urlObject":{"path":["api","v3","project",":projectUUID","recalculate","costs"],"host":["{{host}}"],"query":[{"description":{"content":"UUID of the project for which costs will be calculated.
\n","type":"text/plain"},"key":"projectUUID","value":"string"},{"description":{"content":"Optional. Async request ID, used to identify a previous request. If not provided, a new request will be created.
\n","type":"text/plain"},"key":"requestId","value":"string"}],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"22e543b1-4290-4101-90ca-1f69ace3b081","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/recalculate/costs?projectUUID=string&requestId=string","host":["{{host}}"],"path":["api","v3","project",":projectUUID","recalculate","costs"],"query":[{"key":"projectUUID","value":"string","description":"UUID of the project for which costs will be calculated.","type":"text"},{"key":"requestId","value":"string","description":"Optional. Async request ID, used to identify a previous request. If not provided, a new request will be created.","type":"text"}],"variable":[{"key":"projectUUID","value":"","description":"UUID of project to be retrieved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 20 Sep 2024 19:31:46 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"status\": \"string\",\n \"data\": null,\n \"error\": null\n}"}],"_postman_id":"63eb0736-6738-4cbc-8f03-58c014bd1f07"},{"name":"Add Costs Manually","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f9ab8df7-2649-45c0-9130-ff4d795b4ba3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"description\": \"string\",\r\n \"sourceLanguage\": null,\r\n \"targetLanguage\": null,\r\n \"filename\": null,\r\n \"reason\": null,\r\n \"costsLogfileId\": null,\r\n \"unitType\": \"string\",\r\n \"units\": 100.0000,\r\n \"costPerUnit\": 0.0100,\r\n \"rateType\": \"string\",\r\n \"costType\": \"string\",\r\n \"displayOrder\": null\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/cost/manual-cost","description":"Add all costs manually.
\n","urlObject":{"path":["api","v3","project",":projectUUID","cost","manual-cost"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"4cfbd53b-b8d0-45df-9281-0e4491e4b972","name":"202 - Accepted","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/cost/manual-cost","host":["{{host}}"],"path":["api","v3","project",":projectUUID","cost","manual-cost"],"variable":[{"key":"projectUUID","value":"","description":"UUID of project to be retrieved"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 20 Sep 2024 20:10:30 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"uuid\": \"string\",\n \"description\": \"string\",\n \"sourceLanguage\": null,\n \"targetLanguage\": null,\n \"filename\": null,\n \"reason\": null,\n \"costsLogfileId\": null,\n \"creationTimestamp\": 1727108190893,\n \"matchStart\": null,\n \"matchEnd\": null,\n \"displayOrder\": null,\n \"unitType\": \"string\",\n \"units\": 1.0000,\n \"costPerUnit\": 0.0100,\n \"total\": 0.01,\n \"rateType\": \"string\",\n \"costType\": \"string\",\n \"noPriceList\": null\n}"}],"_postman_id":"f9ab8df7-2649-45c0-9130-ff4d795b4ba3"},{"name":"Delete Costs","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"13dd2098-c7cb-4231-a046-63643b35872a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/cost/:costUUID","description":"Removing costs for project. Use CostUUID obtained when creating the cost.
Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"prjectUUID","key":"projectUUID"},{"description":{"content":"Cost UUID to be removed
\n","type":"text/plain"},"type":"any","value":"costUUID","key":"costUUID"}]}},"response":[{"id":"a3168bb4-25e8-4bae-92eb-10b555ec6c18","name":"200 - Success","originalRequest":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/cost/:costUUID","host":["{{host}}"],"path":["api","v3","project",":projectUUID","cost",":costUUID"],"variable":[{"key":"projectUUID","value":"","description":"UUID of project to be retrieved"},{"key":"costUUID","value":"","description":"Cost UUID to be removed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 20 Sep 2024 20:10:30 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"13dd2098-c7cb-4231-a046-63643b35872a"}],"id":"f30377ee-77d7-48b2-be8e-a74776fcf5b7","description":"Endpoints for managing project costs, including operations related to cost calculation, language pair pricing, and rate management for projects.
\n","_postman_id":"f30377ee-77d7-48b2-be8e-a74776fcf5b7"},{"name":"Tasks","item":[{"name":"List Tasks","id":"6cb5b924-806e-4f9c-8a46-e233fc7d14e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/task?projectUuid=uuid&size=number&page=number&sort=string","description":"This endpoint retrieves a paginated list of tasks based on the provided filters and sorting options.
\nprojectUuid (string):
Unique identifier of the Project. Required to specify the project whose tasks are being listed.
uuid (string):
Unique identifier of the task. Use this to retrieve a specific task within the project.
size (number):
Optional. Specifies the number of tasks per page. Default value is 50.
page (number):
Optional. Specifies the page number, where 0 represents the first page. Default value is 0.
sort (string):
Optional. Orders tasks based on a specific field and direction. The format is field,order, where:
field can be one of date, file, value, or deliveryDate.
order is either asc for ascending or desc for descending.
Example: sort: date,desc sorts tasks by date in descending order. If not specified, the API applies a default sorting order.
Unique identifier of the Project.
\n","type":"text/plain"},"key":"projectUuid","value":"uuid"},{"description":{"content":"Optional. It's the page size. Default: 50.
\n","type":"text/plain"},"key":"size","value":"number"},{"description":{"content":"Optional. It's the page number. 0 for the first page. Default: 0
\n","type":"text/plain"},"key":"page","value":"number"},{"description":{"content":"Optional. Orders tasks based on a specific field and direction.
\n","type":"text/plain"},"key":"sort","value":"string"}],"variable":[]}},"response":[{"id":"c3cadb7a-3b69-4a89-84ff-9493d7604bdd","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/task?projectUuid=uuid&size=number&page=number&sort=string","host":["{{host}}"],"path":["api","v3","task"],"query":[{"key":"projectUuid","value":"uuid","description":"Unique identifier of the Project"},{"key":"size","value":"number","description":"Optional. It's the page size. Default: 50."},{"key":"page","value":"number","description":"Optional. It's the page number. 0 for the first page. Default: 0"},{"key":"sort","value":"string","description":"Optional. Orders tasks based on a specific field and direction."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 07 Dec 2020 11:45:32 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"uuid\": \"uuid\",\n \"creationDate\": 1731441162596,\n \"assignDate\": 1731441235406,\n \"dueDate\": 1731729202929,\n \"sequence\": 1,\n \"currency\": \"USD\",\n \"assignee\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"email@email.com\",\n \"id\": 0,\n \"name\": \"string\",\n \"status\": \"ACTIVE\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"uuid\"\n },\n \"createdBy\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"email@email.com\",\n \"id\": 0,\n \"name\": \"string\",\n \"status\": \"ACTIVE\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"email@email.com\"\n },\n \"assignedBy\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"email@email.com\",\n \"id\": 0,\n \"name\": \"string\",\n \"status\": \"ACTIVE\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"uuid\"\n },\n \"client\": \"string\",\n \"project\": {\n \"uuid\": \"uuid\",\n \"name\": \"string\",\n \"reference\": \"string\",\n \"currency\": \"USD\",\n \"dueDate\": 1732132402973,\n \"organizationUuid\": \"uuid\",\n \"autopilotEnabled\": true\n },\n \"status\": \"ASSIGNED\",\n \"workUnit\": {\n \"uuid\": \"uuid\",\n \"workId\": \"uuid\",\n \"projectUUID\": \"uuid\",\n \"orgUnitId\": \"uuid\",\n \"name\": \"file.xml\",\n \"sourceLanguage\": \"string\",\n \"targetLanguage\": \"string\",\n \"filename\": \"file.xml\",\n \"creationTimestamp\": 1731441160146,\n \"lastUpdate\": 1731441160146,\n \"words\": 8,\n \"netWords\": 0,\n \"sequence\": 1,\n \"cost\": 0,\n \"savings\": 8.0,\n \"workflow\": \"TRANSLATION\",\n \"projectResource\": {\n \"uuid\": \"uuid\",\n \"name\": \"file.xml\",\n \"path\": \"file.xml\"\n },\n \"totalSegments\": 5,\n \"confirmedSegments\": 2,\n \"totalNonTranslatable\": 2,\n \"confirmedNonTranslatable\": 2,\n \"createdOnGenesis\": true,\n \"genesisCreationStatus\": \"CREATED\",\n \"genesisCreationDescription\": \"string\",\n \"workStatus\": \"NEW\",\n \"taskStatus\": \"ASSIGNED\",\n \"contentIsEmpty\": false\n },\n \"referenceFiles\": [],\n \"files\": [],\n \"categories\": [],\n \"dependencies\": [],\n \"customFields\": []\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"offset\": 0,\n \"pageNumber\": 0,\n \"pageSize\": 20,\n \"paged\": true,\n \"unpaged\": false\n },\n \"totalElements\": 3,\n \"totalPages\": 1,\n \"last\": true,\n \"size\": 20,\n \"number\": 0,\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"numberOfElements\": 3,\n \"first\": true,\n \"empty\": false\n}"}],"_postman_id":"6cb5b924-806e-4f9c-8a46-e233fc7d14e2"},{"name":"List Tasks by Work Unit","id":"5cb700e1-21da-47b9-a2c7-b4937e29b0e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/task/work-unit/:workUnitUUID","description":"This endpoint retrieves a list of tasks associated with a specific work unit, providing a quick reference to each task's unique identifiers and status. For full task metadata, you will need to call the Get Task endpoint using the uuid of the response.
\nThe unique identifier of the work unit. Required to specify which task to retrieve.
\n","type":"text/plain"},"type":"any","value":"workUnitUUID","key":"workUnitUUID"}]}},"response":[{"id":"7f9f74af-f50a-4478-b018-2f4044e63d20","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/task/work-unit/:workUnitUUID","host":["{{host}}"],"path":["api","v3","task","work-unit",":workUnitUUID"],"variable":[{"key":"workUnitUUID","value":"uuid","description":"The unique identifier of the work unit. Required to specify which task to retrieve."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 07 Dec 2020 11:45:32 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"uuid\": \"uuid\",\n \"name\": \"Task 01\",\n \"genesisWorkUnitId\": \"uuid\",\n \"status\": \"ASSIGNED\"\n },\n {\n \"uuid\": \"uuid\",\n \"name\": \"Task 02\",\n \"genesisWorkUnitId\": \"uuid\",\n \"status\": \"ASSIGNED\"\n }\n]"}],"_postman_id":"5cb700e1-21da-47b9-a2c7-b4937e29b0e0"},{"name":"Get Task","id":"37dc2508-1fd2-4545-9dca-ea7ebd4d0229","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/task/:taskUUID","description":"This endpoint retrieves detailed information for a specific task, providing a comprehensive view of all available metadata for the task.
\nThe unique identifier of the task.
\n","type":"text/plain"},"type":"any","value":"taskUUID","key":"taskUUID"}]}},"response":[{"id":"1b0d28d2-6505-4b4a-a61e-0568badb2020","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/task/:taskUUID","host":["{{host}}"],"path":["api","v3","task",":taskUUID"],"variable":[{"key":"taskUUID","value":"uuid","description":"The unique identifier of the task."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 07 Dec 2020 11:45:32 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"uuid\",\n \"creationDate\": 1731441162596,\n \"assignDate\": 1731441235406,\n \"dueDate\": 1731729202929,\n \"sequence\": 1,\n \"currency\": \"USD\",\n \"assignee\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"email@email.com\",\n \"id\": 0,\n \"name\": \"string\",\n \"status\": \"ACTIVE\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"uuid\"\n },\n \"createdBy\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"email@email.com\",\n \"id\": 0,\n \"name\": \"string\",\n \"status\": \"ACTIVE\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"email@email.com\"\n },\n \"assignedBy\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"email@email.com\",\n \"id\": 0,\n \"name\": \"string\",\n \"status\": \"ACTIVE\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"uuid\"\n },\n \"client\": \"string\",\n \"project\": {\n \"uuid\": \"uuid\",\n \"name\": \"string\",\n \"reference\": \"string\",\n \"currency\": \"USD\",\n \"dueDate\": 1732132402973,\n \"organizationUuid\": \"uuid\",\n \"autopilotEnabled\": true\n },\n \"status\": \"ASSIGNED\",\n \"workUnit\": {\n \"uuid\": \"uuid\",\n \"workId\": \"uuid\",\n \"projectUUID\": \"uuid\",\n \"orgUnitId\": \"uuid\",\n \"name\": \"file.xml\",\n \"sourceLanguage\": \"string\",\n \"targetLanguage\": \"string\",\n \"filename\": \"file.xml\",\n \"creationTimestamp\": 1731441160146,\n \"lastUpdate\": 1731441160146,\n \"words\": 8,\n \"netWords\": 0,\n \"sequence\": 1,\n \"cost\": 0,\n \"savings\": 8.0,\n \"workflow\": \"TRANSLATION\",\n \"projectResource\": {\n \"uuid\": \"uuid\",\n \"name\": \"file.xml\",\n \"path\": \"file.xml\"\n },\n \"totalSegments\": 5,\n \"confirmedSegments\": 2,\n \"totalNonTranslatable\": 2,\n \"confirmedNonTranslatable\": 2,\n \"createdOnGenesis\": true,\n \"genesisCreationStatus\": \"CREATED\",\n \"genesisCreationDescription\": \"string\",\n \"workStatus\": \"NEW\",\n \"taskStatus\": \"ASSIGNED\",\n \"contentIsEmpty\": false\n },\n \"referenceFiles\": [],\n \"files\": [],\n \"categories\": [],\n \"dependencies\": [],\n \"customFields\": []\n}"}],"_postman_id":"37dc2508-1fd2-4545-9dca-ea7ebd4d0229"},{"name":"Assign Task to User","id":"7e3b39b3-ff8c-4997-867b-bd42e99d5cda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/task/:taskUUID/assignment/:userUUID","description":"Assigns task to a user
\n","urlObject":{"path":["api","v3","task",":taskUUID","assignment",":userUUID"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"UUID of task which will be assigned to user
\n","type":"text/plain"},"type":"string","value":"taskUUID","key":"taskUUID"},{"description":{"content":"UUID of user which will have task assigned to
\n","type":"text/plain"},"type":"string","value":"userUUID","key":"userUUID"}]}},"response":[{"id":"8dc0accc-8b82-4e93-92fe-5284836ff983","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/task/:taskUUID/assignment/:userUUID","host":["{{host}}"],"path":["api","v3","task",":taskUUID","assignment",":userUUID"],"variable":[{"description":"UUID of task which will be assigned to user","key":"taskUUID","type":"string","value":":taskUUID"},{"description":"UUID of user which will have task assigned to","key":"userUUID","type":"string","value":":userUUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 07 Dec 2020 11:45:32 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"creationDate\": 0,\n \"assignDate\": 0,\n \"sequence\": 0,\n \"currency\": \"string\",\n \"assignee\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"createdBy\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"assignedBy\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"client\": \"string\",\n \"projectName\": \"string\",\n \"status\": \"string\",\n \"workUnit\": {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"string\",\n \"targetLanguage\": \"string\",\n \"filename\": \"string\",\n \"creationTimestamp\": 0,\n \"lastUpdate\": 0,\n \"sequence\": 0,\n \"workflow\": \"string\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n },\n \"referenceFiles\": [],\n \"files\": [],\n \"categories\": [],\n \"dependencies\": []\n}"}],"_postman_id":"7e3b39b3-ff8c-4997-867b-bd42e99d5cda"},{"name":"Bulk Assign Tasks to User","id":"1b0135bf-25c4-4043-b79f-470f87340996","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"UUID of user which will have tasks assigned to
\n","key":"userUuid","type":"text","value":"string"},{"description":"List of tasks UUIDs which will be assigned to user
\n","key":"tasksUuids","type":"text","value":"array"}]},"url":"{{host}}/api/v3/task/assignment?bulk=true","description":"Assigns multiple tasks to a single user
\n","urlObject":{"path":["api","v3","task","assignment"],"host":["{{host}}"],"query":[{"key":"bulk","value":"true"}],"variable":[]}},"response":[{"id":"1f9a0ef8-703d-4dd2-95d0-36a40e36fe55","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userUuid\": \"string\",\n \"tasksUuids\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/task/assignment?bulk=true","host":["{{host}}"],"path":["api","v3","task","assignment"],"query":[{"key":"bulk","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 07 Dec 2020 12:23:06 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"uuid\": \"string\",\n \"creationDate\": 0,\n \"assignDate\": 0,\n \"sequence\": 0,\n \"currency\": \"string\",\n \"assignee\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"createdBy\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"assignedBy\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"client\": \"string\",\n \"projectName\": \"string\",\n \"status\": \"string\",\n \"workUnit\": {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"string\",\n \"targetLanguage\": \"string\",\n \"filename\": \"string\",\n \"creationTimestamp\": 0,\n \"lastUpdate\": 0,\n \"sequence\": 0,\n \"workflow\": \"string\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n },\n \"referenceFiles\": [],\n \"files\": [],\n \"categories\": [],\n \"dependencies\": []\n },\n {\n \"uuid\": \"string\",\n \"creationDate\": 0,\n \"assignDate\": 0,\n \"sequence\": 0,\n \"currency\": \"string\",\n \"assignee\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"createdBy\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"assignedBy\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"client\": \"string\",\n \"projectName\": \"string\",\n \"status\": \"string\",\n \"workUnit\": {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"string\",\n \"targetLanguage\": \"string\",\n \"filename\": \"string\",\n \"creationTimestamp\": 0,\n \"lastUpdate\": 0,\n \"sequence\": 0,\n \"workflow\": \"string\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n },\n \"referenceFiles\": [],\n \"files\": [],\n \"categories\": [],\n \"dependencies\": []\n }\n]"}],"_postman_id":"1b0135bf-25c4-4043-b79f-470f87340996"},{"name":"Revoke Task Assignment","id":"501d56e5-a685-4ac3-9b4b-7f006cb6d512","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/task/:taskUUID/assignment","description":"Removes assignment from task
\n","urlObject":{"path":["api","v3","task",":taskUUID","assignment"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"UUID of task which will have its assignment revoked
\n","type":"text/plain"},"type":"string","value":"taskUUID","key":"taskUUID"}]}},"response":[{"id":"f8c2eb56-8f71-4e5f-b179-4e8da1077da6","name":"200 - Success","originalRequest":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/task/:taskUUID/assignment","host":["{{host}}"],"path":["api","v3","task",":taskUUID","assignment"],"variable":[{"description":"UUID of task which will have its assignment revoked","key":"taskUUID","type":"string","value":":taskUUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 07 Dec 2020 11:39:47 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"creationDate\": 0,\n \"assignDate\": 0,\n \"sequence\": 0,\n \"currency\": \"string\",\n \"createdBy\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"assignedBy\": {\n \"uuid\": \"string\",\n \"name\": \"string\"\n },\n \"client\": \"string\",\n \"projectName\": \"string\",\n \"status\": \"string\",\n \"workUnit\": {\n \"uuid\": \"string\",\n \"workId\": \"string\",\n \"name\": \"string\",\n \"sourceLanguage\": \"string\",\n \"targetLanguage\": \"string\",\n \"filename\": \"string\",\n \"creationTimestamp\": 0,\n \"lastUpdate\": 0,\n \"sequence\": 0,\n \"workflow\": \"string\",\n \"projectUUID\": \"string\",\n \"projectResourceUuid\": \"string\"\n },\n \"referenceFiles\": [],\n \"files\": [],\n \"categories\": [],\n \"dependencies\": []\n}"}],"_postman_id":"501d56e5-a685-4ac3-9b4b-7f006cb6d512"},{"name":"Create Or Update Instructions","id":"37ac4e28-5adf-4d07-9207-72966a12f35f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"UUID\",\n \"instructions\": \"Instructions Content
\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/task/:taskUUID","description":"This endpoint can be used to add or edit specific instructions per task. These instructions will be displayed in the Editor, in the right sidebar menu, in the Instructions section. If the task has no instructions, a new instruction will be added. If it already has instructions, the previous one will be overwritten.
Instructions can be sent wrapped in HTML tags and can be minimally customized. You can use a p or h1 tag, for example, add an inline style like color: red. Remember that this will directly impact how the instruction is displayed to the translator.
NOTE: The project must have the status APPROVED in order to have valid tasks eligible to receive instructions.
Unique task identifier
\n","type":"text/plain"},"type":"any","value":"","key":"taskUUID"}]}},"response":[{"id":"8402a7d7-1dac-4819-8b0d-bc2307ed9466","name":"200","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/api/v3/task/:taskUUID","host":["{{host}}"],"path":["api","v3","task",":taskUUID"],"variable":[{"key":"taskUUID","value":"","description":"Unique task identifier"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"73754a96-c9de-41b4-b2b4-3f8bdbe69430\",\n \"instructions\": \"Other content
\",\n \"creationDate\": 1773236039628,\n \"sequence\": 1,\n \"createdBy\": {\n \"accountOwner\": false,\n \"currency\": \"USD\",\n \"deleteAllLanguagePair\": false,\n \"email\": \"user.email@bureauworks.com\",\n \"id\": 1,\n \"name\": \"User\",\n \"status\": \"ACTIVE\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"bcf27d2a-093f-45d1-aa5a-b40e0f57e7ce\"\n },\n \"client\": \"Org.Unit Names\",\n \"project\": {\n \"uuid\": \"6fd1b700-4ed5-46e6-9d99-d162632d3948\",\n \"name\": \"B-2670-37980-1BAF\",\n \"reference\": \"Instructions Test\",\n \"currency\": \"USD\",\n \"dueDate\": 1773322439668,\n \"organizationUuid\": \"d1309242-9a37-4fc3-ae17-ef5153f165d8\",\n \"autopilotEnabled\": true,\n \"hasDataTransformation\": false\n },\n \"status\": \"PENDING\",\n \"workUnit\": {\n \"uuid\": \"f04b9b03-c196-4305-825c-ba15e32eb4bc\",\n \"workId\": \"64ecc69f-08bd-4bb7-97f4-46174b27418d\",\n \"projectUUID\": \"6fd1b700-4ed5-46e6-9d99-d162632d3948\",\n \"orgUnitId\": \"1676aa9d-0262-41dd-b48a-e2c1a4e8abac\",\n \"name\": \"test-file.txt\",\n \"sourceLanguage\": \"en_us\",\n \"targetLanguage\": \"pt_br\",\n \"filename\": \"test-file.txt\",\n \"creationTimestamp\": 1773235995117,\n \"lastUpdate\": 1773235995117,\n \"words\": 52,\n \"netWords\": 27,\n \"segments\": 8,\n \"sequence\": 1,\n \"cost\": 260,\n \"savings\": 0.0,\n \"workflow\": \"TRANSLATION\",\n \"workflowUuid\": \"d56221c1-eef4-4579-95e0-ffacfe66d5de\",\n \"projectResource\": {\n \"uuid\": \"0da924c5-85df-46a5-b78a-2102e661058d\",\n \"name\": \"misclassification-test.txt\",\n \"path\": \"misclassification-test.txt\"\n },\n \"hasDeliverable\": false,\n \"createdOnGenesis\": true,\n \"genesisCreationStatus\": \"CREATED\",\n \"genesisCreationDescription\": \"Work unit created successfully\",\n \"workStatus\": \"NEW\",\n \"taskStatus\": \"PENDING\",\n \"contentIsEmpty\": false,\n \"isSplit\": false,\n \"partiallyDelivered\": false\n },\n \"referenceFiles\": [],\n \"files\": [],\n \"categories\": [],\n \"dependencies\": [],\n \"customFields\": [],\n \"fromSplit\": false\n}"}],"_postman_id":"37ac4e28-5adf-4d07-9207-72966a12f35f"}],"id":"58194563-0c13-4ddc-a4c9-84a941297c36","description":"Task management related endpoints.
\n","_postman_id":"58194563-0c13-4ddc-a4c9-84a941297c36"},{"name":"Logfiles","item":[{"name":"Create Logfile for Project","id":"2638d0f4-7a7b-4fa0-b4dd-d7c57bb4c8f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/logfile?pre-analysis=boolean","description":"Create logfile for a project.
\n","urlObject":{"path":["api","v3","project",":projectUUID","logfile"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. Must be added as a parameter in the query string if the creation is specifically for pre-analysis.
\n","type":"text/plain"},"key":"pre-analysis","value":"boolean"}],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID ","key":"projectUUID"}]}},"response":[{"id":"86a193de-d5e6-4f02-a3e3-f1cb8433ba76","name":"Create Logfile for Project","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/logfile?pre-analysis=boolean","host":["{{host}}"],"path":["api","v3","project",":projectUUID","logfile"],"query":[{"key":"pre-analysis","value":"boolean","description":"Optional. Must be added as a parameter in the query string if the creation is specifically for pre-analysis."}],"variable":[{"key":"projectUUID","value":"projectUUID","description":"Unique identifier of the project"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Mon, 28 Oct 2024 17:19:34 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"PRE_ANALYSE\",\n \"projectId\": \"string\",\n \"creationDate\": 1730132435118,\n \"itemsByFile\": [],\n \"itemsByLangPair\": null,\n \"status\": \"string\",\n \"targetsLocales\": [],\n \"config\": {\n \"id\": null,\n \"calculateTranslationMemoryReuse\": true,\n \"calculateNonTranslatableReuse\": true,\n \"calculateMachineTranslationReuse\": false,\n \"includeNetRate\": null,\n \"ignoreConfirmedSegments\": false,\n \"ignoreLockedSegments\": false,\n \"ignoreNumbers\": false,\n \"analyzeByProvider\": null,\n \"analyzeByLanguage\": null\n },\n \"fileContent\": null,\n \"workUnitsAtProjectStepLevel\": null,\n \"analysisWorkflow\": null,\n \"isCostLogFile\": null\n}"}],"_postman_id":"2638d0f4-7a7b-4fa0-b4dd-d7c57bb4c8f7"},{"name":"Create Logfile for Work Unit","id":"c4406b2d-8b04-4f5e-a1bf-36eed9a4486b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"string\",\r\n \"projectId\": null,\r\n \"type\": \"PRE_ANALYSE\",\r\n \"calculateTranslationMemoryReuse\": true,\r\n \"calculateNonTranslatableReuse\": true,\r\n \"ntOverRepetition\": false,\r\n \"tmOverRepetition\": false,\r\n \"calculateMachineTranslationReuse\": true,\r\n \"ignoreLockedSegments\": true,\r\n \"ignoreConfirmedSegments\": false,\r\n \"genesisWorkflows\": [\r\n \"string\",\r\n \"string\",\r\n \"string\"\r\n ],\r\n \"workUnitIds\": [\r\n \"string\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/logfile","description":"Create logfile for a Work Unit.
\n","urlObject":{"path":["api","v3","project",":projectUUID","logfile"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"c097d8c5-9b58-4b94-b06d-ee211133850d","name":"Create Logfile for Work Unit","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/logfile","host":["{{host}}"],"path":["api","v3","project",":projectUUID","logfile"],"variable":[{"key":"projectUUID","value":"projectUUID","description":"Unique identifier of the project"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Mon, 28 Oct 2024 17:19:34 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"PRE_ANALYSE\",\n \"projectId\": \"string\",\n \"creationDate\": 1730136007971,\n \"itemsByFile\": [],\n \"itemsByLangPair\": null,\n \"status\": \"string\",\n \"targetsLocales\": [],\n \"config\": {\n \"id\": null,\n \"calculateTranslationMemoryReuse\": true,\n \"calculateNonTranslatableReuse\": true,\n \"calculateMachineTranslationReuse\": true,\n \"includeNetRate\": null,\n \"ignoreConfirmedSegments\": false,\n \"ignoreLockedSegments\": true,\n \"ignoreNumbers\": false,\n \"analyzeByProvider\": null,\n \"analyzeByLanguage\": null\n },\n \"fileContent\": null,\n \"workUnitsAtProjectStepLevel\": null,\n \"analysisWorkflow\": null,\n \"isCostLogFile\": null\n}"}],"_postman_id":"c4406b2d-8b04-4f5e-a1bf-36eed9a4486b"},{"name":"List Logfiles","id":"acde5145-d626-4c31-a47f-89a71ea7b2d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/logfile?page=integer&pageSize=integer&orderType=string&orderBy=string&rotated=boolean","description":"List logfiles for a project.
\n","urlObject":{"path":["api","v3","project",":projectUUID","logfile"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. It's the page number. 0 for the first page.
\n","type":"text/plain"},"key":"page","value":"integer"},{"description":{"content":"Optional. Sets the number of results per page.
\n","type":"text/plain"},"key":"pageSize","value":"integer"},{"description":{"content":"Optional. Controls the order of results, desc for descending.
Optional. Specifies the field to sort by.
\n","type":"text/plain"},"key":"orderBy","value":"string"},{"description":{"content":"Optional. Defines whether to show rotated logfiles or not.
\n","type":"text/plain"},"key":"rotated","value":"boolean"}],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"}]}},"response":[{"id":"34916a20-b052-48ff-9aeb-1d0b1dcf04f1","name":"Create for Work Unit","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/logfile?page=integer&pageSize=integer&orderType=string&orderBy=string&rotated=boolean","host":["{{host}}"],"path":["api","v3","project",":projectUUID","logfile"],"query":[{"key":"page","value":"integer","description":"Optional. It's the page number. 0 for the first page."},{"key":"pageSize","value":"integer","description":"Optional. Sets the number of results per page."},{"key":"orderType","value":"string","description":"Optional. Controls the order of results, `desc` for descending."},{"key":"orderBy","value":"string","description":"Optional. Specifies the field to sort by."},{"key":"rotated","value":"boolean","description":"Optional. Defines whether to show rotated logfiles or not."}],"variable":[{"key":"projectUUID","value":"projectUUID","description":"Unique identifier of the project"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Mon, 28 Oct 2024 17:19:34 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"POST_ANALYSE\",\n \"projectId\": \"string\",\n \"creationDate\": 1730136014770,\n \"itemsByFile\": null,\n \"itemsByLangPair\": null,\n \"status\": \"string\",\n \"targetsLocales\": [\n \"string\"\n ],\n \"config\": null,\n \"fileContent\": null,\n \"workUnitsAtProjectStepLevel\": 1,\n \"analysisWorkflow\": \"string\",\n \"isCostLogFile\": false\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"PRE_ANALYSE\",\n \"projectId\": \"string\",\n \"creationDate\": 1730136007971,\n \"itemsByFile\": null,\n \"itemsByLangPair\": null,\n \"status\": \"string\",\n \"targetsLocales\": [\n \"string\"\n ],\n \"config\": null,\n \"fileContent\": null,\n \"workUnitsAtProjectStepLevel\": 1,\n \"analysisWorkflow\": \"string\",\n \"isCostLogFile\": false\n }\n ],\n \"offset\": 0,\n \"pageSize\": 20,\n \"pageNumber\": 0,\n \"totalPages\": 1,\n \"totalElements\": 2,\n \"first\": true,\n \"last\": true,\n \"empty\": false\n}"}],"_postman_id":"acde5145-d626-4c31-a47f-89a71ea7b2d7"},{"name":"Logfile Summary","id":"25c66199-3aab-491d-bfd6-d0b00158f88c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/logfile/:logfileUUID/summary","description":"Get project logfile summary.
\n","urlObject":{"path":["api","v3","project",":projectUUID","logfile",":logfileUUID","summary"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"},{"description":{"content":"Unique identifier of the Logfile
\n","type":"text/plain"},"type":"any","value":"logfileUUID","key":"logfileUUID"}]}},"response":[{"id":"53828e55-4137-4ea6-b521-1be72c5e8cfe","name":"Logfile Summary","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/logfile/:logfileUUID/summary","host":["{{host}}"],"path":["api","v3","project",":projectUUID","logfile",":logfileUUID","summary"],"variable":[{"key":"projectUUID","value":"projectUUID","description":"Unique identifier of the project"},{"key":"logfileUUID","value":"logfileUUID","description":"Unique identifier of the logfile"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"language\": \"string\",\n \"totalWords\": 0,\n \"totalChars\": 0,\n \"totalSegments\": 0\n }\n]\n"}],"_postman_id":"25c66199-3aab-491d-bfd6-d0b00158f88c"},{"name":"Export Logfile","id":"7c1cd700-2207-4883-a626-d1a7a01369c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/project/:projectUUID/logfile/:logfileUUID/download-async?format=string&rebuild=boolean","description":"Download async logfile from project.
\n","urlObject":{"path":["api","v3","project",":projectUUID","logfile",":logfileUUID","download-async"],"host":["{{host}}"],"query":[{"description":{"content":"Defines the file format. Supported: CSV XLSX.
Defines whether the file will be reconstructed before downloading. Default: false.
Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"},{"description":{"content":"Unique identifier of the Logfile
\n","type":"text/plain"},"type":"any","value":"logfileUUID","key":"logfileUUID"}]}},"response":[{"id":"cbdda44d-e687-4917-97ed-4772e938a68c","name":"Export Logfile","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/logfile/:logfileUUID/download-async?format=string&rebuild=boolean","host":["{{host}}"],"path":["api","v3","project",":projectUUID","logfile",":logfileUUID","download-async"],"query":[{"key":"format","value":"string","description":"Defines the file format. Supported: `CSV` `XLSX`."},{"key":"rebuild","value":"boolean","description":"Defines whether the file will be reconstructed before downloading. Default: `false`."}],"variable":[{"key":"projectUUID","value":"projectUUID","description":"Unique identifier of the project"},{"key":"logfileUUID","value":"logfileUUID","description":"Unique identifier of the logfile"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"requestUuid\": \"string\",\n \"status\": \"string\",\n \"downloadUrl\": null,\n \"progress\": null\n}"}],"_postman_id":"7c1cd700-2207-4883-a626-d1a7a01369c8"},{"name":"Status Export Logfile","id":"f40e5022-1b13-4e58-b02a-5f774d054770","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/project/:projectUUID/logfile/:logfileUUID/download/:requestUUID/status","description":"Download status of logfile from project.
\n","urlObject":{"path":["api","v3","project",":projectUUID","logfile",":logfileUUID","download",":requestUUID","status"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Project
\n","type":"text/plain"},"type":"any","value":"projectUUID","key":"projectUUID"},{"description":{"content":"Unique identifier of the Logfile
\n","type":"text/plain"},"type":"any","value":"logfileUUID","key":"logfileUUID"},{"description":{"content":"Unique identifier of the Request
\n","type":"text/plain"},"type":"any","value":"requestUUID","key":"requestUUID"}]}},"response":[{"id":"7b699ac4-c230-4991-8285-fb1917caa5da","name":"Status Export Logfile","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/project/:projectUUID/logfile/:logfileUUID/download/:requestUUID/status","host":["{{host}}"],"path":["api","v3","project",":projectUUID","logfile",":logfileUUID","download",":requestUUID","status"],"variable":[{"key":"projectUUID","value":"projectUUID","description":"Unique identifier of the project"},{"key":"logfileUUID","value":"logfileUUID","description":"Unique identifier of the logfile"},{"key":"requestUUID","value":"requestUUID","description":"Unique identifier of the request"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"requestUuid\": \"string\",\n \"status\": \"string\",\n \"downloadUrl\": \"string\",\n \"progress\": 100.0\n}"}],"_postman_id":"f40e5022-1b13-4e58-b02a-5f774d054770"},{"name":"Task Logfile","id":"c36ff15c-758b-4aee-a96a-6522e69adb0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/task/:taskUUID/logfile","description":"Getting logfiles for a task.
\n","urlObject":{"path":["api","v3","task",":taskUUID","logfile"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Task
\n","type":"text/plain"},"type":"any","value":"taskUUID","key":"taskUUID"}]}},"response":[{"id":"d1e18502-35f9-4b3a-b9d3-d1e49a4f01f2","name":"Task Logfile","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/task/:taskUUID/logfile","host":["{{host}}"],"path":["api","v3","task",":taskUUID","logfile"],"variable":[{"key":"taskUUID","value":"taskUUID","description":"Unique identifier of the task"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"preAnalysis\": {\r\n \"id\": \"string\",\r\n \"name\": \"string\",\r\n \"type\": \"PRE_ANALYSE\",\r\n \"projectId\": \"string\",\r\n \"creationDate\": 1730131618511,\r\n \"itemsByFile\": [\r\n {\r\n \"fileName\": \"string\",\r\n \"sourceLocale\": \"string\",\r\n \"targetLocale\": \"string\",\r\n \"workUnitId\": \"string\",\r\n \"analysisTotals\": [\r\n {\r\n \"match\": null,\r\n \"matchEnd\": 49.0,\r\n \"matchLabel\": \"string\",\r\n \"totalWords\": 1341.0,\r\n \"totalSegments\": 157.0,\r\n \"totalChars\": 6646.0,\r\n \"netWords\": 1341.0,\r\n \"netSegments\": 157.0,\r\n \"netChars\": 6646.0,\r\n \"analysisItemType\": \"string\",\r\n \"matchOrZeroIfNull\": 0.0,\r\n \"netRateFactor\": null,\r\n \"isMissingMatch\": null\r\n }\r\n ],\r\n \"uuidFromWorkUnitId\": \"string\"\r\n }\r\n ],\r\n \"itemsByLangPair\": null,\r\n \"status\": \"string\",\r\n \"targetsLocales\": null,\r\n \"config\": {\r\n \"id\": null,\r\n \"calculateTranslationMemoryReuse\": true,\r\n \"calculateNonTranslatableReuse\": true,\r\n \"calculateMachineTranslationReuse\": false,\r\n \"includeNetRate\": null,\r\n \"ignoreConfirmedSegments\": false,\r\n \"ignoreLockedSegments\": false,\r\n \"ignoreNumbers\": false,\r\n \"analyzeByProvider\": null,\r\n \"analyzeByLanguage\": null\r\n },\r\n \"fileContent\": null,\r\n \"workUnitsAtProjectStepLevel\": null,\r\n \"analysisWorkflow\": null,\r\n \"isCostLogFile\": null\r\n }\r\n}"}],"_postman_id":"c36ff15c-758b-4aee-a96a-6522e69adb0a"},{"name":"Task Logfile Breakdown","id":"2adfc74d-99a1-4e56-b2f9-dcfbbd45982f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/task/:taskUUID/logfile/:logfileUUID/breakdown-by-workflow","description":"Getting logfile breakdown for a task.
\n","urlObject":{"path":["api","v3","task",":taskUUID","logfile",":logfileUUID","breakdown-by-workflow"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Task
\n","type":"text/plain"},"type":"any","value":"taskUUID","key":"taskUUID"},{"description":{"content":"Unique identifier of the Logfile
\n","type":"text/plain"},"type":"any","value":"logfileUUID","key":"logfileUUID"}]}},"response":[{"id":"64deeb85-380b-4026-b8cd-5fa91ef44900","name":"Task Logfile Breakdown","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/task/:taskUUID/logfile/:logfileUUID/breakdown-by-workflow","host":["{{host}}"],"path":["api","v3","task",":taskUUID","logfile",":logfileUUID","breakdown-by-workflow"],"variable":[{"key":"taskUUID","value":"taskUUID","description":"Unique identifier of the task"},{"key":"logfileUUID","value":"logfileUUID","description":"Unique identifier of the logfile"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"string\",\r\n \"name\": \"string\",\r\n \"type\": \"PRE_ANALYSE\",\r\n \"projectId\": \"string\",\r\n \"creationDate\": 1730131618511,\r\n \"itemsByFile\": null,\r\n \"itemsByLangPair\": [\r\n {\r\n \"sourceLocale\": \"string\",\r\n \"targetLocale\": \"string\",\r\n \"analysisTotals\": [\r\n {\r\n \"match\": null,\r\n \"matchEnd\": null,\r\n \"matchLabel\": \"string\",\r\n \"totalWords\": 1341.0,\r\n \"totalSegments\": 157.0,\r\n \"totalChars\": 6646.0,\r\n \"netWords\": 134.1,\r\n \"netSegments\": 15.7,\r\n \"netChars\": 664.6000000000001,\r\n \"analysisItemType\": \"string\",\r\n \"matchOrZeroIfNull\": 0.0,\r\n \"netRateFactor\": null,\r\n \"isMissingMatch\": null\r\n }\r\n ]\r\n }\r\n ],\r\n \"status\": \"string\",\r\n \"targetsLocales\": null,\r\n \"config\": {\r\n \"id\": null,\r\n \"calculateTranslationMemoryReuse\": true,\r\n \"calculateNonTranslatableReuse\": true,\r\n \"calculateMachineTranslationReuse\": false,\r\n \"includeNetRate\": null,\r\n \"ignoreConfirmedSegments\": false,\r\n \"ignoreLockedSegments\": false,\r\n \"ignoreNumbers\": false,\r\n \"analyzeByProvider\": null,\r\n \"analyzeByLanguage\": null\r\n },\r\n \"fileContent\": null,\r\n \"workUnitsAtProjectStepLevel\": 1,\r\n \"analysisWorkflow\": null,\r\n \"isCostLogFile\": null\r\n}"}],"_postman_id":"2adfc74d-99a1-4e56-b2f9-dcfbbd45982f"}],"id":"76e2250e-748f-4f48-8fec-bff71a5eba62","description":"Detailed logfiles of activities in a project, capturing essential data for performance monitoring and analysis.
\n","_postman_id":"76e2250e-748f-4f48-8fec-bff71a5eba62"},{"name":"TM","item":[{"name":"Fuzzy Search Translation Units","id":"c11d206d-abea-4603-a750-a6e2c7cdb939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v1/translation-memory/:tmUuid/translation-unit/fuzzy-search?sourceText=string&targetLocales=&threshold=number","description":"Returns a LIST of results.
It's the text of the source segment.
\n","type":"text/plain"},"key":"sourceText","value":"string"},{"description":{"content":"(array of strings). Optional. Those are language codes for the target translations, e.g. \"pt_br\" for Portuguese, Brazil. If none is specified, all target translations will be returned.
\n","type":"text/plain"},"key":"targetLocales","value":""},{"description":{"content":"Optional. It's the penalty applied when searching for a translation. The higher the value the more accuracy of the searched term. Range: 0 ≤ x ≤ 1. Default: 0.49.
\n","type":"text/plain"},"key":"threshold","value":"number"}],"variable":[{"description":{"content":"Unique identifier of the TM
\n","type":"text/plain"},"type":"any","value":"tmUUID","key":"tmUuid"}]}},"response":[{"id":"d187e5df-ce52-4c9a-a6d8-b350066e881e","name":"Fuzzy Search Translation Units","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v1/translation-memory/:tmUuid/translation-unit/fuzzy-search?page=&pageSize=&sourceText=&targetLocales=&threshold","host":["{{host}}"],"path":["api","v1","translation-memory",":tmUuid","translation-unit","fuzzy-search"],"query":[{"key":"page","value":"","description":"(number). It's the page number. 0 for the first page."},{"key":"pageSize","value":"","description":"(number). It's the page size."},{"key":"sourceText","value":"","description":"(string). It's the text of the source segment"},{"key":"targetLocales","value":"","description":"(array of strings). Optional. Those are language codes for the target translations, e.g. \"pt_br\" for Portuguese, Brazil. If none is specified, all target translations will be returned."},{"key":"threshold","value":null,"description":"(number, decimal). Optional. It's the penalty applied when searching for a translation. The higher the value the more accuracy of the searched term. Range: 0 ≤ x ≤ 1. Default: 0.49."}],"variable":[{"key":"tmUuid","value":null,"description":"(string). It's the identifier of a given TM."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"translationUnitId\": 0,\r\n \"match\": 1.0,\r\n \"segments\": [\r\n {\r\n \"id\": 0,\r\n \"tmId\": 0,\r\n \"translationUnitId\": 0,\r\n \"locale\": \"string\",\r\n \"isSourceSegment\": boolean,\r\n \"text\": \"string\",\r\n \"createdAt\": 0,\r\n \"createdBy\": object,\r\n \"modifiedAt\": 0,\r\n \"modifiedBy\": object\r\n },\r\n {\r\n \"id\": 0,\r\n \"tmId\": 0,\r\n \"translationUnitId\": 0,\r\n \"locale\": \"string\",\r\n \"isSourceSegment\": boolean,\r\n \"text\": \"string\",\r\n \"createdAt\": 0,\r\n \"createdBy\": object\r\n \"modifiedAt\": 0,\r\n \"modifiedBy\": object\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"c11d206d-abea-4603-a750-a6e2c7cdb939"},{"name":"Fuzzy Search Segments","id":"019e452a-11a0-454e-ba81-a0634e247250","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v1/translation-memory/:tmUuid/segment/fuzzy-search?sourceText=string&threshold=number&targetLocale=string&overviewOnly=boolean","description":"Returns a LIST of results.
It's the text of the source segment.
\n","type":"text/plain"},"key":"sourceText","value":"string"},{"description":{"content":"Optional. It's the penalty applied when searching for a translation. The higher the value the more accuracy of the searched term. Range: 0 ≤ x ≤ 1. Default: 0.49.
\n","type":"text/plain"},"key":"threshold","value":"number"},{"description":{"content":"It's the language code for the target translation, e.g. \"pt_br\" for Portuguese, Brazil. If none is specified, all target translations will be returned.
\n","type":"text/plain"},"key":"targetLocale","value":"string"},{"description":{"content":"Optional. If \"true\" a simplified version of the resource will be returned.
\n","type":"text/plain"},"key":"overviewOnly","value":"boolean"}],"variable":[{"description":{"content":"Unique identifier of the TM
\n","type":"text/plain"},"type":"any","value":"tmUUID","key":"tmUuid"}]}},"response":[{"id":"7771e920-94ad-437d-a7bc-46bd30ec3f0e","name":"Fuzzy Search Segments","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v1/translation-memory/:tmUuid/segment/fuzzy-search?sourceText=&threshold=&targetLocale=&overviewOnly=","host":["{{host}}"],"path":["api","v1","translation-memory",":tmUuid","segment","fuzzy-search"],"query":[{"key":"sourceText","value":"","description":"(string). It's the text of the source segment"},{"key":"threshold","value":"","description":"(number, decimal). Optional. It's the penalty applied when searching for a translation. The higher the value the more accuracy of the searched term. Range: 0 ≤ x ≤ 1. Default: 0.49."},{"key":"targetLocale","value":"","description":"(string). Optional. It's the language code for the target translation, e.g. \"pt_br\" for Portuguese, Brazil. If none is specified, all target translations will be returned."},{"key":"overviewOnly","value":"","description":"(boolean). Optional. If \"true\" a simplified version of the resource will be returned."}],"variable":[{"id":"595dbd5a-1025-4d1c-b101-b3852f6b8c34","key":"tmUuid","value":null,"description":"(string). It's the identifier of a given TM."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"match\": 1.0,\r\n \"translationUnitId\": 0,\r\n \"tmUuid\": \"string\",\r\n \"tmName\": \"string\",\r\n \"sourceSegmentId\": 0,\r\n \"sourceText\": \"string\",\r\n \"sourceLocale\": \"string\",\r\n \"targetSegmentId\": 0,\r\n \"targetText\": \"string\",\r\n \"targetLocale\": \"string\"\r\n }\r\n]"}],"_postman_id":"019e452a-11a0-454e-ba81-a0634e247250"},{"name":"List Translation Memory (TM)","id":"f72ea9ce-7c3c-4ceb-bee7-b483ce1b04d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v1/atlas-tm?page=number&pageSize=number&name=string&sourceLocales=&targetLocales=&idsOnly=boolean","urlObject":{"path":["api","v1","atlas-tm"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. It's the page number. 0 for the first page. Default: 0
\n","type":"text/plain"},"key":"page","value":"number"},{"description":{"content":"Optional. It's the page size. Default: 50. Max: 500
\n","type":"text/plain"},"key":"pageSize","value":"number"},{"description":{"content":"It's the name of the searched TM.
\n","type":"text/plain"},"key":"name","value":"string"},{"description":{"content":"(array of string). Those are the source languages of the searched TMs.
\n","type":"text/plain"},"key":"sourceLocales","value":""},{"description":{"content":"(array of string). Those are the target languages of the searched TMs.
\n","type":"text/plain"},"key":"targetLocales","value":""},{"description":{"content":"Optional. If \"true\" the list will return the results with ids and names only.
\n","type":"text/plain"},"key":"idsOnly","value":"boolean"}],"variable":[]}},"response":[{"id":"dbe19b02-b28c-47e5-b5d9-c9afa4d30f5e","name":"List Translation Memory (TM)","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v1/atlas-tm?page=0&pageSize=20&name=&sourceLocales=&targetLocales=&idsOnly=","host":["{{host}}"],"path":["api","v1","atlas-tm"],"query":[{"key":"page","value":"0","description":"(number). It's the page number. 0 for the first page."},{"key":"pageSize","value":"20","description":"(number). It's the page size."},{"key":"name","value":"","description":"(string). It's the name of the searched TM."},{"key":"sourceLocales","value":"","description":"(array of string). Those are the source languages of the searched TMs."},{"key":"targetLocales","value":"","description":"(array of string). Those are the target languages of the searched TMs."},{"key":"idsOnly","value":"","description":"(boolean). Optional. If \"true\" the list will return the results with ids and names only."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": [\r\n {\r\n \"uuid\": \"string\",\r\n \"name\": \"string\"\r\n }\r\n ],\r\n \"pageable\": {\r\n \"sort\": {\r\n \"empty\": true,\r\n \"sorted\": false,\r\n \"unsorted\": true\r\n },\r\n \"offset\": 0,\r\n \"pageNumber\": 0,\r\n \"pageSize\": 20,\r\n \"paged\": true,\r\n \"unpaged\": false\r\n },\r\n \"totalElements\": 1,\r\n \"totalPages\": 1,\r\n \"last\": true,\r\n \"size\": 20,\r\n \"number\": 0,\r\n \"sort\": {\r\n \"empty\": true,\r\n \"sorted\": false,\r\n \"unsorted\": true\r\n },\r\n \"numberOfElements\": 1,\r\n \"first\": true,\r\n \"empty\": false\r\n}"}],"_postman_id":"f72ea9ce-7c3c-4ceb-bee7-b483ce1b04d4"},{"name":"Search Translation Units","id":"9ee287aa-d6ec-4505-b1c0-51a41f34ef4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v1/translation-memory/:tmUuid/translation-unit/search?page=number&pageSize=number&sourceText=string&targetLocale=string","urlObject":{"path":["api","v1","translation-memory",":tmUuid","translation-unit","search"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. It's the page number. 0 for the first page. Default: 0
\n","type":"text/plain"},"key":"page","value":"number"},{"description":{"content":"Optional. It's the page size. Default: 50. Max: 250
\n","type":"text/plain"},"key":"pageSize","value":"number"},{"description":{"content":"It's the text of the source segment
\n","type":"text/plain"},"key":"sourceText","value":"string"},{"description":{"content":"It's the language code for the target translation, e.g. \"pt_br\" for Portuguese, Brazil. If none is specified, all target translations will be returned.
\n","type":"text/plain"},"key":"targetLocale","value":"string"}],"variable":[{"description":{"content":"Unique identifier of the TM
\n","type":"text/plain"},"type":"any","value":"tmUUID","key":"tmUuid"}]}},"response":[{"id":"32c042a6-bdf9-407f-91da-319f625084bc","name":"Search Translation Units","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v1/translation-memory/:tmUuid/translation-unit/search?page=&pageSize=&sourceText=&targetLocale=","host":["{{host}}"],"path":["api","v1","translation-memory",":tmUuid","translation-unit","search"],"query":[{"key":"page","value":"","description":"(number). It's the page number. 0 for the first page."},{"key":"pageSize","value":"","description":"(number). It's the page size."},{"key":"sourceText","value":"","description":"(string). It's the text of the source segment"},{"key":"targetLocale","value":"","description":"(string). Optional. It's the language code for the target translation, e.g. \"pt_br\" for Portuguese, Brazil. If none is specified, all target translations will be returned."}],"variable":[{"key":"tmUuid","value":null,"description":"(string). It's the identifier of a given TM."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": [\r\n {\r\n \"translationUnitId\": 0,\r\n \"match\": 1.0,\r\n \"segments\": [\r\n {\r\n \"id\": 0,\r\n \"tmId\": 0,\r\n \"translationUnitId\": 0,\r\n \"locale\": \"string\",\r\n \"isSourceSegment\": boolean,\r\n \"text\": \"string\",\r\n \"createdAt\": 0,\r\n \"createdBy\": object,\r\n \"modifiedAt\": 0,\r\n \"modifiedBy\": object\r\n },\r\n {\r\n \"id\": 0,\r\n \"tmId\": 0,\r\n \"translationUnitId\": 0,\r\n \"locale\": \"string\",\r\n \"isSourceSegment\": boolean,\r\n \"text\": \"string\",\r\n \"createdAt\": 0,\r\n \"createdBy\": object\r\n \"modifiedAt\": 0\r\n \"modifiedBy\": object\r\n }\r\n ]\r\n }\r\n ],\r\n \"offset\": 0,\r\n \"pageSize\": 20,\r\n \"pageNumber\": 0,\r\n \"totalPages\": 1,\r\n \"totalElements\": 1,\r\n \"first\": boolean,\r\n \"last\": boolean,\r\n \"empty\": boolean\r\n}"}],"_postman_id":"9ee287aa-d6ec-4505-b1c0-51a41f34ef4c"},{"name":"Upsert Translation in TU","id":"15c5b641-59db-4d51-81ff-0d8eb0d9a886","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"sourceText\": \"string\",\r\n \"sourceLocale\": \"string\",\r\n \"targetText\": \"string\",\r\n \"targetLocale\": \"string\",\r\n \"sourceContext\": {\r\n \"previousText\": \"string\",\r\n \"nextText\": \"string\",\r\n \"contextKey\": \"string\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v1/translation-memory/:tmUuid/translation-unit?override=boolean","description":"This will create a new translation unit or override an existing one by updating its target text for the given locale.
\n5.3 Context Key usage example:
\nkeyOne:\n keyTwo:\n keyThree: \"value\"\n\ncontextKey = keyOne.keyTwo.keyThree
Optional. Default = true. If \"false\" a new translation unit will be created regardless of existing ones with the same source text. Otherwise, the existing target text of a translation unit will be updated to the specified in the request.
\n","type":"text/plain"},"key":"override","value":"boolean"}],"variable":[{"description":{"content":"Unique identifier of the TM
\n","type":"text/plain"},"type":"any","value":"tmUUID","key":"tmUuid"}]}},"response":[{"id":"33add6cc-d501-402e-b05d-6174526d6105","name":"Upsert Translation in TU","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"sourceText\": \"string\",\r\n \"sourceLocale\": \"string\",\r\n \"targetText\": \"string\",\r\n \"targetLocale\": \"string\",\r\n \"sourceContext\": {\r\n \"previousText\": \"string\",\r\n \"nextText\": \"string\",\r\n \"contextKey\": \"string\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v1/translation-memory/:tmUuid/translation-unit?override","host":["{{host}}"],"path":["api","v1","translation-memory",":tmUuid","translation-unit"],"query":[{"key":"override","value":null,"description":"(boolean). Optional. Default = true. If \"false\" a new translation unit will be created regardless of existing ones with the same source text. Otherwise, the existing target text of a translation unit will be updated to the specified in the request. "}],"variable":[{"key":"tmUuid","value":null,"description":"(string). It's the identifier of a given TM."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 0,\r\n \"tmUuid\": \"string\"\r\n}"}],"_postman_id":"15c5b641-59db-4d51-81ff-0d8eb0d9a886"},{"name":"Update Translation in TU","id":"7855e279-3c0c-4b89-8677-feb0978d8cb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"text\": \"string\",\r\n \"locale\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v1/translation-memory/:tmUuid/translation-unit/:tuId","description":"This will update the text for the given locale in this Translation Unit.
\n","urlObject":{"path":["api","v1","translation-memory",":tmUuid","translation-unit",":tuId"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(string). Unique identifier of the TM
\n","type":"text/plain"},"type":"any","value":"tmUUID","key":"tmUuid"},{"description":{"content":"(number). Unique identifier of the Translation Unit (TU)
\n","type":"text/plain"},"type":"any","value":"tuID","key":"tuId"}]}},"response":[{"id":"c2f99939-ebfc-4bf0-8665-8c71897b65be","name":"Update Translation in TU","originalRequest":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"text\": \"string\",\r\n \"locale\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v1/translation-memory/:tmUuid/translation-unit/:tuId","host":["{{host}}"],"path":["api","v1","translation-memory",":tmUuid","translation-unit",":tuId"],"variable":[{"key":"tmUuid","value":null,"description":"(string). It's the identifier of a given TM."},{"key":"tuId","value":null,"description":"(number). It's the identifier of a given Translation Unit (TU)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 0,\r\n \"tmUuid\": \"string\"\r\n}"}],"_postman_id":"7855e279-3c0c-4b89-8677-feb0978d8cb7"},{"name":"Delete Translation Unit (TU)","id":"86b5cf81-38aa-4b22-a28c-167fc73c7d3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v1/translation-memory/:tmUuid/translation-unit/:tuId","description":"This will delete an entire translation unit and its segments.
\n","urlObject":{"path":["api","v1","translation-memory",":tmUuid","translation-unit",":tuId"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(string). Unique identifier of the TM
\n","type":"text/plain"},"type":"any","value":"tmUUID","key":"tmUuid"},{"description":{"content":"(number). Unique identifier of the Translation Unit (TU)
\n","type":"text/plain"},"type":"any","value":"tuID","key":"tuId"}]}},"response":[{"id":"c9a7d41e-a0ef-4c46-86bd-1d3245683012","name":"Delete Translation Unit (TU)","originalRequest":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v1/translation-memory/:tmUuid/translation-unit/:tuId","host":["{{host}}"],"path":["api","v1","translation-memory",":tmUuid","translation-unit",":tuId"],"variable":[{"key":"tmUuid","value":null,"description":"(string). It's the identifier of a given TM."},{"key":"tuId","value":null,"description":"(number). It's the identifier of a given Translation Unit (TU)."}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"86b5cf81-38aa-4b22-a28c-167fc73c7d3c"},{"name":"Delete Translation in TU","id":"91328030-07f2-4b63-942c-94426d767822","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v1/translation-memory/:tmUuid/:tuId/segment?locale=string","description":"This will delete a translation (segment) matching the given locale of a translation unit (TU).
\nNote: The source segment cannot be removed. Use Delete Translation Unit (TU) to remove an entire TU or Update Translation in TU to update its source text.
\n","urlObject":{"path":["api","v1","translation-memory",":tmUuid",":tuId","segment"],"host":["{{host}}"],"query":[{"description":{"content":"It's the language code of the translation (segment), e.g. \"pt_br\" for Portuguese, Brazil.
\n","type":"text/plain"},"key":"locale","value":"string"}],"variable":[{"description":{"content":"(string). Unique identifier of the TM
\n","type":"text/plain"},"type":"any","value":"tmUUID","key":"tmUuid"},{"description":{"content":"(number). Unique identifier of the Translation Unit (TU)
\n","type":"text/plain"},"type":"any","value":"tuID","key":"tuId"}]}},"response":[{"id":"81aeec82-3027-4456-8753-b150ef8472a6","name":"Delete Translation in TU","originalRequest":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v1/translation-memory/:tmUuid/translation-unit/:tuId","host":["{{host}}"],"path":["api","v1","translation-memory",":tmUuid","translation-unit",":tuId"],"variable":[{"key":"tmUuid","value":null,"description":"(string). It's the identifier of a given TM."},{"key":"tuId","value":null,"description":"(number). It's the identifier of a given Translation Unit (TU)."}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"91328030-07f2-4b63-942c-94426d767822"}],"id":"7cf4791c-cdd5-4cdb-924a-8dda9e5ef2f7","description":"Translation Memory (TM) management related endpoints.
\n","_postman_id":"7cf4791c-cdd5-4cdb-924a-8dda9e5ef2f7"},{"name":"Glossary","item":[{"name":"Terms","item":[{"name":"Create a New Term","id":"8d612e25-79c8-43ef-8994-e68c6ae95436","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"glossaryUuid\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"text\": \"Computer\",\r\n \"language\": \"EN\",\r\n \"definition\": \"A device that computes...\",\r\n \"conceptDefinition\": \"Conceptual framework for understanding computing devices\",\r\n \"status\": \"Active\",\r\n \"termType\": \"Noun\",\r\n \"part\": \"Hardware\",\r\n \"usage\": \"Commonly used\",\r\n \"forbidden\": false,\r\n \"writable\": true,\r\n \"dnt\": false,\r\n \"exactMatch\": true,\r\n \"rtl\": false,\r\n \"gender\": \"Neutral\",\r\n \"caseSensitive\": false,\r\n \"internal\": false,\r\n \"note\": \"No special instructions\",\r\n \"glossaryCustomAttributes\": [\r\n {\r\n \"name\": \"importance\",\r\n \"value\": \"high\",\r\n \"type\": \"TEXT\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/glossary/term","urlObject":{"path":["api","v3","glossary","term"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"68cc0e49-3351-4bf3-852d-a48714354ad7","name":"Create a New Term","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 101,\r\n \"glossaryUuid\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"text\": \"Computer\",\r\n \"language\": \"EN\",\r\n \"definition\": \"A device that computes...\",\r\n \"conceptDefinition\": \"Conceptual framework for understanding computing devices\",\r\n \"status\": \"Active\",\r\n \"termType\": \"Noun\",\r\n \"part\": \"Hardware\",\r\n \"usage\": \"Commonly used\",\r\n \"forbidden\": false,\r\n \"writable\": true,\r\n \"dnt\": false,\r\n \"exactMatch\": true,\r\n \"rtl\": false,\r\n \"gender\": \"Neutral\",\r\n \"caseSensitive\": false,\r\n \"internal\": false,\r\n \"note\": \"No special instructions\",\r\n \"glossaryCustomAttributes\": [\r\n {\r\n \"name\": \"importance\",\r\n \"value\": \"high\",\r\n \"type\": \"TEXT\"\r\n }\r\n ]\r\n}\r\n"}],"_postman_id":"8d612e25-79c8-43ef-8994-e68c6ae95436"},{"name":"Get Term","id":"4a70154f-ef72-4fd2-923b-f0810a6afec8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/term/:termUuid","urlObject":{"path":["api","v3","glossary","term",":termUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(UUID): Unique identifier of the Term
\n","type":"text/plain"},"type":"any","value":"termUuid","key":"termUuid"}]}},"response":[{"id":"2719cf4d-49cf-42b9-98ff-274661804593","name":"Get Term","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/v3/glossary/term/:termUuid","host":["{{host}}"],"path":["api","v3","glossary","term",":termUuid"],"variable":[{"key":"termUuid","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 101,\r\n \"uuid\": \"123e4555-e89b-12d3-a456-426614174000\",\r\n \"glossaryUuid\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"text\": \"Computer\",\r\n \"language\": \"EN\",\r\n \"definition\": \"A device that computes...\",\r\n \"conceptDefinition\": \"Conceptual framework for understanding computing devices\",\r\n \"status\": \"Active\",\r\n \"termType\": \"Noun\",\r\n \"part\": \"Hardware\",\r\n \"usage\": \"Commonly used\",\r\n \"forbidden\": false,\r\n \"writable\": true,\r\n \"dnt\": false,\r\n \"exactMatch\": true,\r\n \"rtl\": false,\r\n \"gender\": \"Neutral\",\r\n \"caseSensitive\": false,\r\n \"internal\": false,\r\n \"note\": \"No special instructions\",\r\n \"glossaryCustomAttributes\": [\r\n {\r\n \"name\": \"importance\",\r\n \"value\": \"high\",\r\n \"type\": \"TEXT\"\r\n }\r\n ]\r\n}\r\n"}],"_postman_id":"4a70154f-ef72-4fd2-923b-f0810a6afec8"},{"name":"Update a Term","id":"e561bbf5-b54a-4b93-a45b-8e76734a93dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"glossaryUuid\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"text\": \"Computer\",\r\n \"language\": \"EN\",\r\n \"definition\": \"An electronic device for storing and processing data, typically in binary form.\",\r\n \"status\": \"Updated\",\r\n \"termType\": \"Noun\",\r\n \"part\": \"Hardware\",\r\n \"usage\": \"Frequently used\",\r\n \"forbidden\": false,\r\n \"writable\": true,\r\n \"dnt\": false,\r\n \"exactMatch\": true,\r\n \"rtl\": false,\r\n \"gender\": \"Neutral\",\r\n \"caseSensitive\": false,\r\n \"internal\": false,\r\n \"note\": \"Updated information\",\r\n \"glossaryCustomAttributes\": [\r\n {\r\n \"name\": \"importance\",\r\n \"value\": \"critical\",\r\n \"type\": \"TEXT\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/glossary/term/:termUuid","urlObject":{"path":["api","v3","glossary","term",":termUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(UUID): Unique identifier of the Term
\n","type":"text/plain"},"type":"any","value":"termUuid","key":"termUuid"}]}},"response":[{"id":"7b1c8daa-cb30-4033-8c19-497813f6e529","name":"Update a Term","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/api/v3/glossary/term/:termUuid","host":["{{host}}"],"path":["api","v3","glossary","term",":termUuid"],"variable":[{"key":"termUuid","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"glossaryUuid\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"text\": \"Computer\",\r\n \"language\": \"EN\",\r\n \"definition\": \"An electronic device for storing and processing data, typically in binary form.\",\r\n \"status\": \"Updated\",\r\n \"termType\": \"Noun\",\r\n \"part\": \"Hardware\",\r\n \"usage\": \"Frequently used\",\r\n \"forbidden\": false,\r\n \"writable\": true,\r\n \"dnt\": false,\r\n \"exactMatch\": true,\r\n \"rtl\": false,\r\n \"gender\": \"Neutral\",\r\n \"caseSensitive\": false,\r\n \"internal\": false,\r\n \"note\": \"Updated information\",\r\n \"glossaryCustomAttributes\": [\r\n {\r\n \"name\": \"importance\",\r\n \"value\": \"critical\",\r\n \"type\": \"TEXT\"\r\n }\r\n ]\r\n}\r\n"}],"_postman_id":"e561bbf5-b54a-4b93-a45b-8e76734a93dc"},{"name":"Check for Duplicated Terms","id":"5aeb0b42-f2b5-458f-9e2e-d0dccf4fa798","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"targetTerm\": \"Computer\",\r\n \"sourceTerm\": \"Computadora\",\r\n \"glossaryIds\": [1, 2],\r\n \"targetLanguage\": \"EN\",\r\n \"sourceLanguage\": \"ES\",\r\n \"termType\": \"Technical\",\r\n \"part\": \"Noun\",\r\n \"overrideDuplicated\": false\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/glossary/term/check-duplicated","urlObject":{"path":["api","v3","glossary","term","check-duplicated"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"0d5bc91f-355a-451c-a9b3-7e25c8e74722","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{host}}/api/v3/glossary/term/check-duplicated"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"5aeb0b42-f2b5-458f-9e2e-d0dccf4fa798"},{"name":"Delete a Term","id":"8682389b-3613-4dda-be7f-c3be2c55603d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/term/:termUuid","urlObject":{"path":["api","v3","glossary","term",":termUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(UUID): Unique identifier of the Term
\n","type":"text/plain"},"type":"any","value":"termUuid","key":"termUuid"}]}},"response":[],"_postman_id":"8682389b-3613-4dda-be7f-c3be2c55603d"},{"name":"Get Translations for a Term","id":"2140f3a1-4a0e-4ab8-80dd-86229fefd491","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/term/:termUuid/translations","description":"Status: Under_Review, Approved and Published
\ntermArbitrationStatus: REQUESTED, IN_PROGRESS, CLOSED
part: Noun, Pronoun, Adjective, Determiner, Verb, Adverb, Preposition, Conjunction, Interjection
(UUID): Unique identifier of the Term
\n","type":"text/plain"},"type":"any","value":"termUuid","key":"termUuid"}]}},"response":[{"id":"fd55414d-8656-48a2-b7ea-05d583dffb90","name":"Get Translations for a Term","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/v3/glossary/term/:termUuid/translations","host":["{{host}}"],"path":["api","v3","glossary","term",":termUuid","translations"],"variable":[{"key":"termUuid","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 201,\r\n \"text\": \"Computer\",\r\n \"language\": \"EN\",\r\n \"definition\": \"An electronic device for storing and processing data.\",\r\n \"concept\": {\r\n \"id\": 101,\r\n \"name\": \"Technology Concepts\"\r\n },\r\n \"glossary\": {\r\n \"id\": 301,\r\n \"name\": \"Tech Glossary\",\r\n \"domain\": \"Technology\",\r\n \"subDomain\": \"Information Technology\"\r\n },\r\n \"status\": \"Approved\",\r\n \"exactMatch\": true,\r\n \"caseSensitive\": false,\r\n \"createdAt\": 1633033200000,\r\n \"lastModifiedAt\": 1633036800000,\r\n \"rtl\": false,\r\n \"writable\": true,\r\n \"termArbitrationStatus\": \"REQUESTED\",\r\n \"isRequestedReview\": false,\r\n \"requestReviewBy\": \"John Doe\",\r\n \"requestReviewAt\": 1633033200000,\r\n \"commentsAboutReview\": \"Needs further review for technical accuracy.\",\r\n \"usage\": \"Widely used in computing.\",\r\n \"dnt\": false,\r\n \"gender\": \"Neutral\",\r\n \"termType\": \"Technical\",\r\n \"internal\": false,\r\n \"legal\": false,\r\n \"part\": \"Noun\",\r\n \"note\": \"Critical term for IT documentation.\",\r\n \"termsLinked\": [\r\n {\r\n \"linkId\": 401,\r\n \"term\": {\r\n \"id\": 202,\r\n \"text\": \"Ordinateur\",\r\n \"language\": \"FR\"\r\n },\r\n \"linkType\": \"Synonym\"\r\n }\r\n ]\r\n }\r\n]\r\n"}],"_postman_id":"2140f3a1-4a0e-4ab8-80dd-86229fefd491"},{"name":"Search Terms Based on a Segment","id":"8a3b1de3-3915-4f63-8afa-45aa868b407b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/term/search/segment?segment=string&sourceLanguage=string&targetLanguage=string&workUnitId=string&statusList=string&glossaryIds=string&matchType=string","urlObject":{"path":["api","v3","glossary","term","search","segment"],"host":["{{host}}"],"query":[{"description":{"content":"The text segment to search for.
\n","type":"text/plain"},"key":"segment","value":"string"},{"description":{"content":"The source language code.
\n","type":"text/plain"},"key":"sourceLanguage","value":"string"},{"description":{"content":"Optional. The target language code.
\n","type":"text/plain"},"key":"targetLanguage","value":"string"},{"description":{"content":"Optional. UUID of the work unit for context-specific searches.
\n","type":"text/plain"},"key":"workUnitId","value":"string"},{"description":{"content":"Optional. List of term statuses to filter the results.
\n","type":"text/plain"},"key":"statusList","value":"string"},{"description":{"content":"Optional. List of glossary IDs to narrow down the search.
\n","type":"text/plain"},"key":"glossaryIds","value":"string"},{"description":{"content":"Optional. The type of match (e.g., Contains, StartsWith, EndsWith, ExactMatch, Expression).
\n","type":"text/plain"},"key":"matchType","value":"string"}],"variable":[]}},"response":[{"id":"a3d2b9e8-afdb-49de-b8c5-1b3c5d497e98","name":"Search Terms Based on a Segment","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"sourceTerm\": {\r\n \"text\": \"Computer\",\r\n \"language\": \"EN\"\r\n },\r\n \"targetTerm\": {\r\n \"text\": \"Ordinateur\",\r\n \"language\": \"FR\"\r\n },\r\n \"contextProjectId\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"contextWorkId\": \"123e4567-e89b-12d3-a456-426614174001\"\r\n }\r\n]\r\n"}],"_postman_id":"8a3b1de3-3915-4f63-8afa-45aa868b407b"},{"name":"Search Terms by Parameters","id":"d695945f-95ac-4c6f-b9b2-b2f1ba772ebb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/term/search/params?query=&queryLocale&targetLocale&domain&subDomain&statusList&glossaryIds&tmId&rtl&reviewed&aligned&projectId&workUnitId&matchType&ignoreCase&page&pageSize&orderBy&sortDirection","urlObject":{"path":["api","v3","glossary","term","search","params"],"host":["{{host}}"],"query":[{"description":{"content":"(required): The query string to search for.
\n","type":"text/plain"},"key":"query","value":""},{"description":{"content":"(required): The locale of the query.
\n","type":"text/plain"},"key":"queryLocale","value":null},{"description":{"content":"(required): The locale for target translations.
\n","type":"text/plain"},"key":"targetLocale","value":null},{"description":{"content":"Optional. The specific domain to which the terms belong.
\n","type":"text/plain"},"key":"domain","value":null},{"description":{"content":"Optional. The sub-domain within the larger domain.
\n","type":"text/plain"},"key":"subDomain","value":null},{"description":{"content":"Optional. List of term statuses to include in the search.
\n","type":"text/plain"},"key":"statusList","value":null},{"description":{"content":"Optional. List of glossary IDs to narrow down the search.
\n","type":"text/plain"},"key":"glossaryIds","value":null},{"description":{"content":"Optional. List of translation memory IDs to include.
\n","type":"text/plain"},"key":"tmId","value":null},{"description":{"content":"Optional. Boolean indicating if right-to-left languages should be included.
\n","type":"text/plain"},"key":"rtl","value":null},{"description":{"content":"Optional. Boolean indicating if only reviewed terms should be returned.
\n","type":"text/plain"},"key":"reviewed","value":null},{"description":{"content":"Optional. Boolean indicating if only aligned terms are to be included.
\n","type":"text/plain"},"key":"aligned","value":null},{"description":{"content":"Optional. UUID of the project for context-specific searching.
\n","type":"text/plain"},"key":"projectId","value":null},{"description":{"content":"Optional. UUID of the work unit.
\n","type":"text/plain"},"key":"workUnitId","value":null},{"description":{"content":"Optional. The type of match.
\n","type":"text/plain"},"key":"matchType","value":null},{"description":{"content":"Optional. Boolean indicating if the search should ignore case.
\n","type":"text/plain"},"key":"ignoreCase","value":null},{"description":{"content":"Optional. Page number for pagination.
\n","type":"text/plain"},"key":"page","value":null},{"description":{"content":"Optional. Default: 20. The number of results to return per page.
\n","type":"text/plain"},"key":"pageSize","value":null},{"description":{"content":"Optional. Fields to order the results by.
\n","type":"text/plain"},"key":"orderBy","value":null},{"description":{"content":"Optional. Direction of sorting, 'asc' or 'desc'.
\n","type":"text/plain"},"key":"sortDirection","value":null}],"variable":[]}},"response":[{"id":"25b87c0a-c7a9-4132-afdb-c08200f7309b","name":"Search Terms by Parameters","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": [\r\n {\r\n \"sourceTerm\": {\r\n \"text\": \"Computer\",\r\n \"language\": \"EN\"\r\n },\r\n \"targetTerm\": {\r\n \"text\": \"Computadora\",\r\n \"language\": \"ES\"\r\n }\r\n }\r\n ],\r\n \"pageable\": {\r\n \"sort\": {\r\n \"empty\": false,\r\n \"sorted\": true,\r\n \"unsorted\": false\r\n },\r\n \"offset\": 0,\r\n \"pageNumber\": 0,\r\n \"pageSize\": 20,\r\n \"paged\": true,\r\n \"unpaged\": false\r\n },\r\n \"totalElements\": 1,\r\n \"totalPages\": 1,\r\n \"last\": true,\r\n \"size\": 20,\r\n \"number\": 0,\r\n \"sort\": {\r\n \"empty\": false,\r\n \"sorted\": true,\r\n \"unsorted\": false\r\n },\r\n \"numberOfElements\": 1,\r\n \"first\": true,\r\n \"empty\": false\r\n}\r\n"}],"_postman_id":"d695945f-95ac-4c6f-b9b2-b2f1ba772ebb"}],"id":"0cad4fa3-9727-4e2f-b70c-f843edb646a9","description":"Endpoints to create/update and consult glossary terms.
\n","_postman_id":"0cad4fa3-9727-4e2f-b70c-f843edb646a9"},{"name":"Get Glossary","id":"46192aab-2303-4f04-ac2b-df50df963b16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/:glossaryUuid","urlObject":{"path":["api","v3","glossary",":glossaryUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Glossary
\n","type":"text/plain"},"type":"any","value":"glossaryUuid","key":"glossaryUuid"}]}},"response":[{"id":"1433d6e6-f0df-43ea-9e74-05f4dcb0e42c","name":"Get Glossary","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/glossary/:glossaryUuid","host":["{{host}}"],"path":["api","v3","glossary",":glossaryUuid"],"variable":[{"key":"glossaryUuid","value":"","description":"(required): UUID of the glossary. Type: UUID."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"name\": \"IT Glossary\",\n \"creationDate\": 1588291200000,\n \"createdBy\": {\n \"userId\": 1,\n \"username\": \"admin\"\n },\n \"orgUnits\": [\n {\n \"unitId\": 101,\n \"name\": \"IT Department\"\n }\n ],\n \"organization\": {\n \"orgId\": 1,\n \"name\": \"Company X\"\n },\n \"domain\": \"Technology\",\n \"subDomain\": \"Development\",\n \"note\": \"General notes\",\n \"isDefault\": true,\n \"totalConcepts\": 150,\n \"languages\": [\n \"EN\",\n \"PT\"\n ],\n \"allLanguages\": [\n \"EN\",\n \"PT\",\n \"ES\"\n ],\n \"lastImportJob\": {\n \"jobId\": 1,\n \"status\": \"Completed\"\n },\n \"customAttributes\": [\n {\n \"name\": \"Importance\",\n \"value\": \"High\",\n \"type\": \"TEXT\"\n }\n ],\n \"customFields\": [\n {\n \"fieldName\": \"ExtraInfo\",\n \"value\": \"Additional information\"\n }\n ]\n}"}],"_postman_id":"46192aab-2303-4f04-ac2b-df50df963b16"},{"name":"List Glossary","id":"bbe37633-e2aa-4e8e-bc53-db53a15d512d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary?page=number&size=number&idsOnly=boolean&name=string&organizationUuid=string","urlObject":{"path":["api","v3","glossary"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. It's the page number. 0 for the first page. Default: 0
\n","type":"text/plain"},"key":"page","value":"number"},{"description":{"content":"Optional. It's the page size. Default: 50.
\n","type":"text/plain"},"key":"size","value":"number"},{"description":{"content":"Optional. If \"true\" the list will return the results with ids and names only.
\n","type":"text/plain"},"key":"idsOnly","value":"boolean"},{"description":{"content":"Optional. It's the name of one or multiple searched glossaries.
\n","type":"text/plain"},"key":"name","value":"string"},{"description":{"content":"Optional. It's the uuid of an Organization.
\n","type":"text/plain"},"key":"organizationUuid","value":"string"}],"variable":[]}},"response":[{"id":"246d0871-8539-4273-8ec2-4443b04c1b97","name":"List Glossary","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/glossary?page=&size=&idsOnly=&name=&organizationUuid","host":["{{host}}"],"path":["api","v3","glossary"],"query":[{"key":"page","value":"","description":"(number). Optional. It's the page number. 0 for the first page. Default: 0"},{"key":"size","value":"","description":"(number). Optional. It's the page size. Default: 50."},{"key":"idsOnly","value":"","description":"(boolean). Optional. If \"true\" the list will return the results with ids and names only."},{"key":"name","value":"","description":"(string). Optional. It's the name of one or multiple searched glossaries."},{"key":"organizationUuid","value":null,"description":"(string). Optional. It's the uuid of an Organization."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": [\r\n {\r\n \"uuid\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"name\": \"IT Glossary\",\r\n \"totalConcepts\": 150\r\n }\r\n ],\r\n \"pageable\": {\r\n \"sort\": {\r\n \"empty\": false,\r\n \"sorted\": true,\r\n \"unsorted\": false\r\n },\r\n \"offset\": 0,\r\n \"pageNumber\": 0,\r\n \"pageSize\": 20,\r\n \"paged\": true,\r\n \"unpaged\": false\r\n },\r\n \"totalElements\": 1,\r\n \"totalPages\": 1,\r\n \"last\": true,\r\n \"size\": 20,\r\n \"number\": 0,\r\n \"sort\": {\r\n \"empty\": false,\r\n \"sorted\": true,\r\n \"unsorted\": false\r\n },\r\n \"numberOfElements\": 1,\r\n \"first\": true,\r\n \"empty\": false\r\n}"}],"_postman_id":"bbe37633-e2aa-4e8e-bc53-db53a15d512d"},{"name":"List Glossary Terms","id":"00f61a93-baf3-4a56-bb46-cf2f3e41323f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/:glossaryUuid/concept-entries?page=integer&size=integer&text=string","urlObject":{"path":["api","v3","glossary",":glossaryUuid","concept-entries"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. The page number to return.
\n","type":"text/plain"},"key":"page","value":"integer"},{"description":{"content":"Optional. The number of items per page.
\n","type":"text/plain"},"key":"size","value":"integer"},{"description":{"content":"Optional. Sorting criteria in the format field,direction (e.g., name,asc).
\n","type":"text/plain"},"key":"text","value":"string"}],"variable":[{"description":{"content":"Unique identifier of the Glossary
\n","type":"text/plain"},"type":"any","value":"glossaryUuid","key":"glossaryUuid"}]}},"response":[{"id":"f344755c-7124-4efc-abca-339853d13083","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/glossary/:glossaryUuid/concept-entries?page=0&size=20&text=searched+term","host":["{{host}}"],"path":["api","v3","glossary",":glossaryUuid","concept-entries"],"query":[{"key":"page","value":"0"},{"key":"size","value":"20"},{"key":"text","value":"searched+term"}],"variable":[{"key":"glossaryUuid","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 1,\n \"terms\": [\n {\n \"id\": 2,\n \"conceptId\": 5,\n \"glossaryUuid\": \"string\",\n \"text\": \"string\",\n \"language\": \"string\",\n \"status\": \"string\"\n }\n ]\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"offset\": 0,\n \"pageNumber\": 0,\n \"pageSize\": 20,\n \"paged\": true,\n \"unpaged\": false\n },\n \"totalElements\": 1,\n \"totalPages\": 1,\n \"last\": true,\n \"size\": 20,\n \"number\": 0,\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"numberOfElements\": 1,\n \"first\": true,\n \"empty\": false\n}"}],"_postman_id":"00f61a93-baf3-4a56-bb46-cf2f3e41323f"},{"name":"Search Terms (Term Recognition)","id":"399d7332-bfb9-42eb-9135-a35e01bd92e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/term/recognition?targetLanguage=string&text=string&glossaryUuids=&sourceLanguage=string","description":"Returns a LIST of results.
Optional. It's the language code of a translation, e.g. \"pt_br\" for Portuguese, Brazil.
\n","type":"text/plain"},"key":"targetLanguage","value":"string"},{"description":{"content":"It's the text to be searched.
\n","type":"text/plain"},"key":"text","value":"string"},{"description":{"content":"Those are the glossaries which will be searched.
\n","type":"text/plain"},"key":"glossaryUuids","value":""},{"description":{"content":"It's the language code of the source text, e.g. \"en_us\" for English, United States.
\n","type":"text/plain"},"key":"sourceLanguage","value":"string"}],"variable":[]}},"response":[{"id":"40fcf2fc-1e9c-45fd-baba-11d1c747a7a1","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/glossary/term/search/segment?segment=teste&sourceLanguage=pt_br&workUnitId=uuid","host":["{{host}}"],"path":["api","v3","glossary","term","search","segment"],"query":[{"key":"segment","value":"teste"},{"key":"sourceLanguage","value":"pt_br"},{"key":"workUnitId","value":"uuid"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"sourceTerm\": {\n \"id\": 2,\n \"text\": \"string\",\n \"language\": \"string\",\n \"glossaryName\": \"string\",\n \"forbidden\": false,\n \"exactMatch\": false,\n \"status\": \"string\",\n \"caseSensitive\": false,\n \"rtl\": null,\n \"writable\": null,\n \"usage\": null,\n \"definition\": null,\n \"dnt\": null,\n \"gender\": null,\n \"termType\": null,\n \"internal\": null,\n \"part\": null,\n \"note\": null,\n \"createdAt\": 1000000000000,\n \"lastModifiedAt\": 1000000000000,\n \"nameCreatedBy\": null,\n \"nameModifiedBy\": null\n },\n \"targetTerm\": {\n \"id\": 3,\n \"text\": \"string\",\n \"language\": \"string\",\n \"glossaryName\": \"string\",\n \"forbidden\": false,\n \"exactMatch\": false,\n \"status\": \"string\",\n \"caseSensitive\": false,\n \"rtl\": null,\n \"writable\": null,\n \"usage\": null,\n \"definition\": null,\n \"dnt\": null,\n \"gender\": null,\n \"termType\": null,\n \"internal\": null,\n \"part\": null,\n \"note\": null,\n \"createdAt\": 1000000000000,\n \"lastModifiedAt\": 1000000000000,\n \"nameCreatedBy\": null,\n \"nameModifiedBy\": null\n }\n }\n]"}],"_postman_id":"399d7332-bfb9-42eb-9135-a35e01bd92e1"},{"name":"Get a Concept Entry","id":"5a4f05b6-1ef1-4f2d-985a-a252d5047a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/concept-entries/:conceptId","description":"Returns a LIST of results.
Unique identifier of the Concept Entry
\n","type":"text/plain"},"type":"any","value":"conceptId","key":"conceptId"}]}},"response":[{"id":"b76f4b53-087a-4fdd-bf28-2db5087e3378","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/glossary/:glossaryUuid","host":["{{host}}"],"path":["api","v3","glossary",":glossaryUuid"],"variable":[{"key":"glossaryUuid","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"definition\": \"Detailed concept definition\",\n \"note\": \"Additional notes on the concept\",\n \"terms\": [\n {\n \"id\": 101,\n \"text\": \"Related term\",\n \"language\": \"EN\"\n }\n ],\n \"createdDate\": 1609459200000\n}"}],"_postman_id":"5a4f05b6-1ef1-4f2d-985a-a252d5047a88"},{"name":"Create Glossary","id":"33e313c3-dd52-439b-815a-b4ef67a974f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"New IT Glossary\",\r\n \"languages\": [\"da_dk\", \"en_us\"],\r\n \"note\": \"This glossary will contain all IT related terms.\",\r\n \"customAttributes\": [\r\n {\r\n \"name\": \"Accessibility\",\r\n \"value\": \"High\",\r\n \"type\": \"TEXT\"\r\n }\r\n ],\r\n \"orgUnits\": [\r\n {\r\n \"uuid\": \"b73a9920-59a2-49d0-998c-d60e915bb9ed\"\r\n }\r\n ],\r\n \"organization\": {\r\n \"uuid\": \"5fd58192-a8eb-4fb9-8b70-0a33ab081da3\"\r\n },\r\n \"domain\": \"Technology\",\r\n \"subDomain\": \"Software Development\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/glossary","description":"Returns a LIST of results.
Returns a LIST of results.
Returns a LIST of results.
Unique identifier of the Glossary
\n","type":"text/plain"},"type":"any","value":"glossaryUuid","key":"glossaryUuid"}]}},"response":[],"_postman_id":"2e66c1b4-686d-4baa-868e-6add377368c6"},{"name":"Delete Glossary","id":"72ce9857-89f7-4880-975c-a58c4d040b00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/:glossaryUuid","description":"Returns a LIST of results.
Unique identifier of the Glossary
\n","type":"text/plain"},"type":"any","value":"glossaryUuid","key":"glossaryUuid"}]}},"response":[],"_postman_id":"72ce9857-89f7-4880-975c-a58c4d040b00"},{"name":"Init Export Glossary","id":"7ff4935f-5750-4390-af12-8f44aedf540c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/export/:glossaryUuid/:fileType?languages","description":"Exports the specified glossary in the requested file type and optionally filters the export by specified languages. This operation is asynchronous
\n","urlObject":{"path":["api","v3","glossary","export",":glossaryUuid",":fileType"],"host":["{{host}}"],"query":[{"description":{"content":"(optional): A list of language codes to filter the export. If not provided, all languages may be included. Type: List of strings.
\n","type":"text/plain"},"key":"languages","value":null}],"variable":[{"description":{"content":"Unique identifier of the Glossary
\n","type":"text/plain"},"type":"any","value":"glossaryUuid","key":"glossaryUuid"},{"description":{"content":"The file type in which the glossary will be exported. Example types might include xlsx, xls, csv and tbx.
\n","type":"text/plain"},"type":"any","value":"string","key":"fileType"}]}},"response":[],"_postman_id":"7ff4935f-5750-4390-af12-8f44aedf540c"},{"name":"Export Glossary status","id":"3a309064-5b8d-43ee-8c21-1df61b1fb6bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/export/:glossaryUuid/:fileType/:requestUuid/status","description":"Exports the specified glossary in the requested file type and optionally filters the export by specified languages. This operation is asynchronous
\n","urlObject":{"path":["api","v3","glossary","export",":glossaryUuid",":fileType",":requestUuid","status"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Glossary
\n","type":"text/plain"},"type":"any","value":"glossaryUuid","key":"glossaryUuid"},{"description":{"content":"The file type in which the glossary will be exported. Example types might include xlsx, xls, csv and tbx.
\n","type":"text/plain"},"type":"any","value":"string","key":"fileType"},{"description":{"content":"Unique identifier of the Request
\n","type":"text/plain"},"type":"any","value":"requestUuid","key":"requestUuid"}]}},"response":[{"id":"adf0ae7e-5d41-4a5f-bd92-0e386238609b","name":"Export Glossary Started","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/glossary/export/:glossaryUuid/:fileType/:requestUuid/status","host":["{{host}}"],"path":["api","v3","glossary","export",":glossaryUuid",":fileType",":requestUuid","status"],"variable":[{"key":"glossaryUuid","value":"","description":"(required): The UUID of the glossary to export. Type: UUID."},{"key":"fileType","value":"","description":"(required): The file type in which the glossary will be exported. Example types might include xlsx, xls, csv and tbx. Type: String."},{"key":"requestUuid","value":"","description":"(Required): The UUID received from the first request to export the glossary. Type: UUID."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"requestUuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\r\n \"status\": \"STARTED\",\r\n \"downloadUrl\": \"\"\r\n}\r\n"},{"id":"9dd281c9-549e-41cb-8700-5b465d4e19eb","name":"Export Glossary Completed","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/glossary/export/:glossaryUuid/:fileType/:requestUuid/status","host":["{{host}}"],"path":["api","v3","glossary","export",":glossaryUuid",":fileType",":requestUuid","status"],"variable":[{"key":"glossaryUuid","value":"","description":"(required): The UUID of the glossary to export. Type: UUID."},{"key":"fileType","value":"","description":"(required): The file type in which the glossary will be exported. Example types might include xlsx, xls, csv and tbx. Type: String."},{"key":"requestUuid","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"requestUuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"status\": \"COMPLETED\",\n \"downloadUrl\": \"/downloads/glossary_export.csv\"\n}"},{"id":"30bab3d1-86b9-4bb2-b047-63475560dedf","name":"Export Glossary Failed","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/glossary/export/:glossaryUuid/:fileType/:requestUuid/status","host":["{{host}}"],"path":["api","v3","glossary","export",":glossaryUuid",":fileType",":requestUuid","status"],"variable":[{"key":"glossaryUuid","value":"","description":"(required): The UUID of the glossary to export. Type: UUID."},{"key":"fileType","value":"","description":"(required): The file type in which the glossary will be exported. Example types might include xlsx, xls, csv and tbx. Type: String."},{"key":"requestUuid","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"requestUuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"status\": \"FAILED\",\n \"downloadUrl\": \"\"\n}"}],"_postman_id":"3a309064-5b8d-43ee-8c21-1df61b1fb6bf"},{"name":"Import TBX","id":"cd5cf75e-8575-4d01-9f83-f9f0418c854b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"tbxFile","description":"(required): The TBX file to be imported. Type: MultipartFile.
\n","type":"file","value":null}]},"url":"{{host}}/api/v3/glossary/:glossaryUuid/import-tbx","description":"When an import or export job is initiated, the API returns a body with an initial status of \"Running\". As the job progresses, the body is updated with new information like endTime and status, allowing API users to monitor and retrieve the final results once the job completes.
\nThis mechanism is essential for managing and tracking long-running processes in the system effectively.
\n","urlObject":{"path":["api","v3","glossary",":glossaryUuid","import-tbx"],"host":["{{host}}"],"query":[{"disabled":true,"key":"","value":null}],"variable":[{"description":{"content":"Unique identifier of the Glossary
\n","type":"text/plain"},"type":"any","value":"glossaryUuid","key":"glossaryUuid"}]}},"response":[{"id":"692d7ac6-f3ab-48c2-91b8-46f4d9fefd38","name":"Import TBX","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/{glossaryUuid}/import-tbx"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1001,\r\n \"startTime\": null,\r\n \"endTime\": null,\r\n \"creationDate\": 1633033200000,\r\n \"jobExecutionId\": 163240,\r\n \"processingTime\": \"212154s\",\r\n \"status\": \"Initialized\",\r\n \"jobType\": \"IMPORT\",\r\n \"jobName\": \"TBX Import Job\",\r\n \"fileName\": \"example.tbx\",\r\n \"termsCount\": 0,\r\n \"glossaryId\": 1234\r\n}\r\n"}],"_postman_id":"cd5cf75e-8575-4d01-9f83-f9f0418c854b"},{"name":"List Imports","id":"9f800d03-5463-4b67-af33-880475f4a831","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/:glossaryUuid/jobs?jobType&status&startDate&endDate","urlObject":{"path":["api","v3","glossary",":glossaryUuid","jobs"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. Filters the jobs by type, such as IMPORT or EXPORT.
\n","type":"text/plain"},"key":"jobType","value":null},{"description":{"content":"Optional. Filters the jobs by their status, such as COMPLETED or RUNNING.
\n","type":"text/plain"},"key":"status","value":null},{"description":{"content":"Optional. Filters jobs that started on or after this date.
\n","type":"text/plain"},"key":"startDate","value":null},{"description":{"content":"Optional. Filters jobs that ended on or before this date.
\n","type":"text/plain"},"key":"endDate","value":null}],"variable":[{"description":{"content":"Unique identifier of the Glossary
\n","type":"text/plain"},"type":"any","value":"glossaryUuid","key":"glossaryUuid"}]}},"response":[{"id":"ba045aee-7a0d-42d6-8460-17dffacac2d1","name":"Get All imports for a Glossary","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/glossary/:glossaryUuid/jobs","host":["{{host}}"],"path":["api","v3","glossary",":glossaryUuid","jobs"],"query":[{"key":"jobType","value":null,"description":"(optional): Filters the jobs by type, such as IMPORT or EXPORT.","disabled":true},{"key":"status","value":null,"description":"(optional): Filters the jobs by their status, such as COMPLETED or RUNNING.","disabled":true},{"key":"startDate","value":null,"description":"(optional): Filters jobs that started on or after this date.","disabled":true},{"key":"endDate","value":null,"description":"(optional): Filters jobs that ended on or before this date.","disabled":true}],"variable":[{"key":"glossaryUuid","value":"","description":"(required): UUID of the glossary for which job records are being retrieved. Type: UUID."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 1001,\r\n \"startTime\": 1633036800000,\r\n \"endTime\": 1633040400000,\r\n \"creationDate\": 1633033200000,\r\n \"jobExecutionId\": 54321,\r\n \"processingTime\": \"212154s\",\r\n \"status\": \"COMPLETED\",\r\n \"jobType\": \"IMPORT\",\r\n \"jobName\": \"Daily Import\",\r\n \"fileName\": \"import_2023-10-01.tbx\",\r\n \"termsCount\": 500,\r\n \"glossaryId\": 123\r\n },\r\n]\r\n"}],"_postman_id":"9f800d03-5463-4b67-af33-880475f4a831"},{"name":"Last Import","id":"47b3d993-b735-4a9f-8434-adb9935b5e5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/glossary/:glossaryUuid/last-import-job","urlObject":{"path":["api","v3","glossary",":glossaryUuid","last-import-job"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Glossary
\n","type":"text/plain"},"type":"any","value":"glossaryUuid","key":"glossaryUuid"}]}},"response":[{"id":"d3f008fc-383c-40d9-9fdf-4a3972118c83","name":"Get Last Import for a Glossary","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1023,\r\n \"startTime\": 1635602400000,\r\n \"endTime\": 1635606000000,\r\n \"creationDate\": 1635598800000,\r\n \"jobExecutionId\": 55432,\r\n \"processingTime\": \"1 hour\",\r\n \"status\": \"COMPLETED\",\r\n \"jobType\": \"IMPORT\",\r\n \"jobName\": \"Monthly Import\",\r\n \"fileName\": \"import_2023-10-30.tbx\",\r\n \"termsCount\": 1500,\r\n \"glossaryId\": 123\r\n}\r\n"}],"_postman_id":"47b3d993-b735-4a9f-8434-adb9935b5e5d"}],"id":"edf5edfe-8b27-4002-b388-f1df7a87407c","description":"Glossary management related endpoints.
\n","_postman_id":"edf5edfe-8b27-4002-b388-f1df7a87407c"},{"name":"Org Units","item":[{"name":"List Org Units","event":[{"listen":"test","script":{"id":"564adda1-3e4b-4ba1-a7ef-796985195d18","exec":["function cleanup() {\r"," const clean = _.keys(pm.environment.toObject())\r"," _.each(clean, (arrItem) => {\r"," if (arrItem.startsWith(\"temp_\")) {\r"," pm.environment.unset(arrItem)\r"," }\r"," })\r","}\r","cleanup()"],"type":"text/javascript","packages":{}}}],"id":"b88d19d0-d6cf-4e68-aa32-7509e9ab263f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/client?page=number&size=number&sort=string&queryType=string","description":"List the org units with some filters.
\n","urlObject":{"path":["api","v3","client"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. It's the page number. 0 for the first page. Default: 0
\n","type":"text/plain"},"key":"page","value":"number"},{"description":{"content":"Optional. It's the page size. Default: 50.
\n","type":"text/plain"},"key":"size","value":"number"},{"description":{"content":"Optional. Specifies the sorting order of the results. Default: name, ASC.
\n","type":"text/plain"},"key":"sort","value":"string"},{"description":{"content":"Optional. Specifies the type of query to apply additional filtering conditions. Accepted values: NOTIFICATION, AUTOMATION, LLM, DEFAULT. Default: DEFAULT.
\n","type":"text/plain"},"key":"queryType","value":"string"}],"variable":[]}},"response":[{"id":"b693300b-2dab-4f93-bac4-c1a73864e9ff","name":"200 - Sucess","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/client?page&size&sort=&queryType=","host":["{{host}}"],"path":["api","v3","client"],"query":[{"key":"page","value":null,"description":"(number). Optional. It's the page number. 0 for the first page. Default: 0"},{"key":"size","value":null,"description":"(number). Optional. It's the page size. Default: 50."},{"key":"sort","value":"","description":"(string). Optional. Specifies the sorting order of the results. Default: name, ASC."},{"key":"queryType","value":"","description":"(string). Optional. Specifies the type of query to apply additional filtering conditions. Accepted values: NOTIFICATION, AUTOMATION, LLM, DEFAULT. Default: DEFAULT."}]}},"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Tue 10 Sep 2024 14:11:11 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": [\r\n {\r\n \"id\": 0,\r\n \"uuid\": \"string\",\r\n \"organization\": {\r\n \"id\": 0,\r\n \"uuid\": \"string\",\r\n \"name\": \"string\",\r\n \"country\": \"string\"\r\n },\r\n \"name\": \"string\",\r\n \"country\": \"string\",\r\n \"timezone\": \"string\",\r\n \"currency\": \"string\",\r\n \"clientLanguages\": \"string\",\r\n \"defaultSourceLanguage\": \"string\",\r\n \"daysUntilPaymentDue\": 0,\r\n \"invoicingType\": \"string\",\r\n \"chargingUnit\": \"string\",\r\n \"wordsPerUnit\": 0,\r\n \"customFields\": [\r\n {\r\n \"name\": \"string\",\r\n \"type\": \"string\",\r\n \"value\": [\r\n \"string\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"pageable\": {\r\n \"sort\": {\r\n \"empty\": false,\r\n \"sorted\": true,\r\n \"unsorted\": false\r\n },\r\n \"offset\": 0,\r\n \"pageNumber\": 0,\r\n \"pageSize\": 20,\r\n \"paged\": true,\r\n \"unpaged\": false\r\n },\r\n \"totalPages\": 1,\r\n \"totalElements\": 2,\r\n \"last\": true,\r\n \"size\": 20,\r\n \"number\": 0,\r\n \"sort\": {\r\n \"empty\": false,\r\n \"sorted\": true,\r\n \"unsorted\": false\r\n },\r\n \"numberOfElements\": 2,\r\n \"first\": true,\r\n \"empty\": false\r\n}\r\n"}],"_postman_id":"b88d19d0-d6cf-4e68-aa32-7509e9ab263f"},{"name":"Get Org Unit","event":[{"listen":"test","script":{"id":"4a74edf8-c348-4691-ac25-8d718cfc4120","exec":["function cleanup() {\r"," const clean = _.keys(pm.environment.toObject())\r"," _.each(clean, (arrItem) => {\r"," if (arrItem.startsWith(\"temp_\")) {\r"," pm.environment.unset(arrItem)\r"," }\r"," })\r","}\r","cleanup()"],"type":"text/javascript","packages":{}}}],"id":"08e70cae-e244-4ffd-b594-f1a6498e2663","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/client/:orgUnitUUID","description":"Retrieve single org unit
\n","urlObject":{"path":["api","v3","client",":orgUnitUUID"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Org. Unit
\n","type":"text/plain"},"type":"any","value":"orgUnitUUID","key":"orgUnitUUID"}]}},"response":[{"id":"bbf58531-a849-46bf-aa0e-27eb885e3baa","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/v3/client/:orgUnitUUID","host":["{{host}}"],"path":["api","v3","client",":orgUnitUUID"],"variable":[{"key":"orgUnitUUID","value":"","description":"UUID of org unit to be retrieved"}]}},"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Tue 10 Sep 2024 14:11:11 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 0,\r\n \"uuid\": \"string\",\r\n \"organization\": {\r\n \"id\": 0,\r\n \"uuid\": \"string\",\r\n \"name\": \"string\",\r\n \"country\": \"string\"\r\n },\r\n \"name\": \"string\",\r\n \"country\": \"string\",\r\n \"phone\": 9999999,\r\n \"mobile\": 9999999,\r\n \"timezone\": \"string\",\r\n \"currency\": \"string\",\r\n \"externalId\": \"string\",\r\n \"website\": \"string\",\r\n \"logo\": \"string\",\r\n \"memo\": \"string\",\r\n \"contactNotes\": \"string\",\r\n \"invoiceInfo\": \"string\",\r\n \"paymentMethod\": \"string\",\r\n \"taxpayerId\": \"string\",\r\n \"continuousPlatformTag\": \"string\",\r\n \"clientLanguages\": \"string\",\r\n \"defaultSourceLanguage\": \"string\",\r\n \"continuousProjectConfig\": \"string\",\r\n \"zendeskUser\": \"string\",\r\n \"zendeskUrl\": \"string\",\r\n \"xeroId\": \"string\",\r\n \"regex\": \"string\",\r\n \"overrideDefaultRegex\": false,\r\n \"contract\": false,\r\n \"showRequester\": false,\r\n \"splitLargeJobs\": \"string\",\r\n \"contractStartDate\": \"string\",\r\n \"contractEndDate\": \"string\",\r\n \"daysUntilPaymentDue\": 0,\r\n \"invoicingType\": \"string\",\r\n \"chargingUnit\": \"string\",\r\n \"wordsPerUnit\": 0,\r\n \"ignoreTranslationMemories\": false,\r\n \"showPaymentPolicy\": true,\r\n \"autopilotEnabled\": false,\r\n \"projectAutomationEnabled\": false,\r\n \"isClientTerminology\": false,\r\n \"status\": \"string\",\r\n \"sendQuoteSummary\": true,\r\n \"sendEmailNotifications\": true,\r\n \"sendAvailableTasksEmail\": true,\r\n \"disableMachineTranslate\": false,\r\n \"notifyProjectComments\": true,\r\n \"sendReceivableEmailNotification\": false,\r\n \"emails\": [],\r\n \"taxInfo\": {\r\n \"issueNfe\": \"string\",\r\n \"requirePurchaseOrder\": \"string\",\r\n \"simplesNacional\": \"string\",\r\n \"retainIss\": \"string\",\r\n \"retainIr\": \"string\",\r\n \"municipalRegistration\": \"string\"\r\n },\r\n \"address\": {\r\n \"state\": \"test\",\r\n \"city\": \"string\",\r\n \"zip\": \"string\",\r\n \"street\": \"string\",\r\n \"number\": \"string\",\r\n \"additionalInfo\": \"string\",\r\n \"neighborhood\": \"string\"\r\n },\r\n \"sendQuoteAuto\": false,\r\n \"autoBilling\": false,\r\n \"consolidateProjects\": false,\r\n \"sendInvoiceToRequester\": false,\r\n \"tmMatchOverRepetitionEnabled\": false,\r\n \"ntMatchOverRepetitionEnabled\": false,\r\n \"accountCode\": \"string\",\r\n \"trackingCategory\": \"string\",\r\n \"billingEmail\": \"string\",\r\n \"netRateSettings\": \"string\",\r\n \"tags\": [\r\n \"string\"\r\n ],\r\n \"mtSettings\": \"string\",\r\n \"notifyZendeskEnabled\": false,\r\n \"categorizationDisabled\": false,\r\n \"aiReviewEnabled\": false,\r\n \"webhookEnabled\": true,\r\n \"disabledQualityFilter\": false,\r\n \"disabledRateFilter\": false,\r\n \"disabledTagFilter\": false,\r\n \"isolatedTags\": false,\r\n \"customFields\": [\r\n {\r\n \"name\": \"string\",\r\n \"type\": \"string\",\r\n \"value\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"costsLogfileType\": \"string\"\r\n}"}],"_postman_id":"08e70cae-e244-4ffd-b594-f1a6498e2663"}],"id":"594f72b0-be20-4666-88b1-09f4e6f08cad","description":"Org Units management related endpoints.
\n","_postman_id":"594f72b0-be20-4666-88b1-09f4e6f08cad"},{"name":"Organization","item":[{"name":"List Organizations","event":[{"listen":"test","script":{"id":"d9dc3884-4cfd-481a-950e-c0f32d3fb38c","exec":["function cleanup() {\r"," const clean = _.keys(pm.environment.toObject())\r"," _.each(clean, (arrItem) => {\r"," if (arrItem.startsWith(\"temp_\")) {\r"," pm.environment.unset(arrItem)\r"," }\r"," })\r","}\r","cleanup()"],"type":"text/javascript","packages":{}}}],"id":"04c6ac5f-effd-4576-b6d6-a5a3564ebf5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v2/organization?page=number&size=number&sort=string","description":"List the organizations with some filters.
\n","urlObject":{"path":["api","v2","organization"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. It's the page number. 0 for the first page. Default: 0
\n","type":"text/plain"},"key":"page","value":"number"},{"description":{"content":"Optional. It's the page size. Default: 50.
\n","type":"text/plain"},"key":"size","value":"number"},{"description":{"content":"Optional. Specifies the sorting order of the results. Default: name, DESC.
\n","type":"text/plain"},"key":"sort","value":"string"}],"variable":[]}},"response":[{"id":"5b40f68f-3d88-4d64-a42a-e325408b4fe9","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v2/organization?page=&size=&sort=","host":["{{host}}"],"path":["api","v2","organization"],"query":[{"key":"page","value":"","description":"(number). Optional. It's the page number. 0 for the first page. Default: 0"},{"key":"size","value":"","description":"(number). Optional. It's the page size. Default: 50."},{"key":"sort","value":"","description":"(string). Optional. Specifies the sorting order of the results. Default: name, DESC."}]}},"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Tue 10 Sep 2024 14:11:11 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": [\r\n {\r\n \"id\": 0,\r\n \"uuid\": \"string\",\r\n \"name\": \"string\",\r\n \"country\": \"string\"\r\n }\r\n ],\r\n \"pageable\": {\r\n \"sort\": {\r\n \"empty\": false,\r\n \"sorted\": true,\r\n \"unsorted\": false\r\n },\r\n \"offset\": 0,\r\n \"pageNumber\": 0,\r\n \"pageSize\": 20,\r\n \"paged\": true,\r\n \"unpaged\": false\r\n },\r\n \"totalElements\": 0,\r\n \"totalPages\": 1,\r\n \"last\": false,\r\n \"size\": 20,\r\n \"number\": 0,\r\n \"sort\": {\r\n \"empty\": false,\r\n \"sorted\": true,\r\n \"unsorted\": false\r\n },\r\n \"numberOfElements\": 20,\r\n \"first\": true,\r\n \"empty\": false\r\n}"}],"_postman_id":"04c6ac5f-effd-4576-b6d6-a5a3564ebf5f"},{"name":"Get Organization","event":[{"listen":"test","script":{"id":"b2c41571-6e9f-4148-8b3d-ce6c15764ce6","exec":["function cleanup() {\r"," const clean = _.keys(pm.environment.toObject())\r"," _.each(clean, (arrItem) => {\r"," if (arrItem.startsWith(\"temp_\")) {\r"," pm.environment.unset(arrItem)\r"," }\r"," })\r","}\r","cleanup()"],"type":"text/javascript","packages":{}}}],"id":"23f6020d-083b-4fcb-a689-6f50eaa1242c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v2/organization/:organizationUUID","description":"Retrieve single organization
\n","urlObject":{"path":["api","v2","organization",":organizationUUID"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Organization
\n","type":"text/plain"},"type":"any","value":"organizationUUID","key":"organizationUUID"}]}},"response":[{"id":"c5973ff5-7a80-4b3f-a28e-7e3db23d06ff","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v2/organization/:organizationUUID","host":["{{host}}"],"path":["api","v2","organization",":organizationUUID"],"variable":[{"key":"organizationUUID","value":"","description":"UUID of organization to be retrieved"}]}},"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Tue 10 Sep 2024 14:11:11 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 0,\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"country\": \"string\",\n \"organizationalUnits\": [\n {\n \"uuid\": \"string\",\n \"organization\": {\n \"id\": 0,\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"country\": \"string\"\n },\n \"name\": \"string\",\n \"sourceLanguage\": \"string\",\n \"targetLanguages\": [\n \"string\"\n ]\n }\n ]\n}"}],"_postman_id":"23f6020d-083b-4fcb-a689-6f50eaa1242c"}],"id":"de11a0dc-f07b-4fbd-8bee-d7bcaae0826b","description":"Organization management related endpoints.
\n","_postman_id":"de11a0dc-f07b-4fbd-8bee-d7bcaae0826b"},{"name":"Users","item":[{"name":"List Users","event":[{"listen":"test","script":{"id":"dc20848e-e782-471a-8d7f-3e1f7dcf3230","exec":["function cleanup() {\r"," const clean = _.keys(pm.environment.toObject())\r"," _.each(clean, (arrItem) => {\r"," if (arrItem.startsWith(\"temp_\")) {\r"," pm.environment.unset(arrItem)\r"," }\r"," })\r","}\r","cleanup()"],"type":"text/javascript","packages":{}}}],"id":"1a56cfc5-3ad8-4085-9628-2825c1c9ee4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/user?page=number&size=number&sort=string&name=string&email=string&status=string&tags=string&sourceLanguage=string&targetLanguages=string&country=string&roles=string","description":"List the users with some filters.
\n","urlObject":{"path":["api","v3","user"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. It's the page number. 0 for the first page. Default: 0
\n","type":"text/plain"},"key":"page","value":"number"},{"description":{"content":"Optional. It's the page size. Default: 50.
\n","type":"text/plain"},"key":"size","value":"number"},{"description":{"content":"Optional. Specifies the sorting order of the results. Can be sorted by name, wordRate, or hourlyRate.\nDefault: name, DESC.
\n","type":"text/plain"},"key":"sort","value":"string"},{"description":{"content":"Optional. It's the name of the user.
\n","type":"text/plain"},"key":"name","value":"string"},{"description":{"content":"Optional. It's the email of the user.
\n","type":"text/plain"},"key":"email","value":"string"},{"description":{"content":"Optional. It's the status of the user.
\n","type":"text/plain"},"key":"status","value":"string"},{"description":{"content":"Optional. It's the tags of the user.
\n","type":"text/plain"},"key":"tags","value":"string"},{"description":{"content":"Optional. It's the source language of the user.
\n","type":"text/plain"},"key":"sourceLanguage","value":"string"},{"description":{"content":"Optional. It's the target languages of the user.
\n","type":"text/plain"},"key":"targetLanguages","value":"string"},{"description":{"content":"Optional. It's the country of the user.
\n","type":"text/plain"},"key":"country","value":"string"},{"description":{"content":"Optional. It's the roles of the user.
\n","type":"text/plain"},"key":"roles","value":"string"}],"variable":[]}},"response":[{"id":"7b16a025-07a1-4fb3-9696-3eb1043376ee","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/user?page=&size=&sort=&name=&email=&status=&tags=&sourceLanguage=&targetLanguages=&country=&roles=","host":["{{host}}"],"path":["api","v3","user"],"query":[{"key":"page","value":"","description":"(number). Optional. It's the page number. 0 for the first page. Default: 0"},{"key":"size","value":"","description":"(number). Optional. It's the page size. Default: 50."},{"key":"sort","value":"","description":"(string). Optional. Specifies the sorting order of the results. Can be sorted by name, wordRate, or hourlyRate.\nDefault: name, DESC."},{"key":"name","value":"","description":"(string). Optional. It's the name of the user."},{"key":"email","value":"","description":"(string). Optional. It's the email of the user."},{"key":"status","value":"","description":"(string). Optional. It's the status of the user."},{"key":"tags","value":"","description":"(string). Optional. It's the tags of the user."},{"key":"sourceLanguage","value":"","description":"(string). Optional. It's the source language of the user."},{"key":"targetLanguages","value":"","description":"(string). Optional. It's the target languages of the user."},{"key":"country","value":"","description":"(string). Optional. It's the country of the user."},{"key":"roles","value":"","description":"(string). Optional. It's the roles of the user."}]}},"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Tue 10 Sep 2024 14:11:11 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"city\": \"string\",\n \"country\": \"string\",\n \"currency\": \"string\",\n \"customFields\": [],\n \"dailyRate\": 0,\n \"deleteAllLanguagePair\": false,\n \"email\": \"string\",\n \"hourlyRate\": 0,\n \"id\": 0,\n \"name\": \"string\",\n \"nameEmail\": \"string\",\n \"pagesRate\": 0,\n \"roles\": [\n \"USER\"\n ],\n \"status\": \"string\",\n \"supportedLanguagePairs\": [],\n \"tags\": [],\n \"tasksCompletedCount\": 0,\n \"userQualityMetrics\": {},\n \"uuid\": \"string\",\n \"wordRate\": 0\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"offset\": 180,\n \"pageNumber\": 9,\n \"pageSize\": 20,\n \"paged\": true,\n \"unpaged\": false\n },\n \"last\": false,\n \"totalElements\": 42820,\n \"totalPages\": 2141,\n \"size\": 20,\n \"number\": 9,\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"first\": false,\n \"numberOfElements\": 20,\n \"empty\": false\n}"}],"_postman_id":"1a56cfc5-3ad8-4085-9628-2825c1c9ee4d"},{"name":"Get User","event":[{"listen":"test","script":{"id":"4693ec73-97fd-43c8-bdee-85eccd6eaa3d","exec":["function cleanup() {\r"," const clean = _.keys(pm.environment.toObject())\r"," _.each(clean, (arrItem) => {\r"," if (arrItem.startsWith(\"temp_\")) {\r"," pm.environment.unset(arrItem)\r"," }\r"," })\r","}\r","cleanup()"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"7d83d5e6-c03e-44d7-8a9b-96036fb96a04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/user/:userUUID","description":"Retrieve single user.
\n","urlObject":{"path":["api","v3","user",":userUUID"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the User
\n","type":"text/plain"},"type":"any","value":"userUUID","key":"userUUID"}]}},"response":[{"id":"e78a65b9-5d82-4e08-bbfb-9d9aaea0414f","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/user/:userUUID","host":["{{host}}"],"path":["api","v3","user",":userUUID"],"variable":[{"key":"userUUID","value":"","description":"UUID of user to be retrieved"}]}},"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","description":"","type":"text"},{"key":"Pragma","value":"no-cache","description":"","type":"text"},{"key":"Expires","value":"0","description":"","type":"text"},{"key":"X-Frame-Options","value":"DENY","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Date","value":"Tue 10 Sep 2024 14:11:11 GMT","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"admin\": false,\n \"avatar\": \"string\",\n \"country\": \"string\",\n \"currency\": \"string\",\n \"dailyRate\": 0,\n \"deleteAllLanguagePair\": false,\n \"email\": \"string\",\n \"enabled\": true,\n \"hourlyRate\": 0,\n \"id\": 0,\n \"invoicingDayOfMonth\": \"string\",\n \"invoicingPeriodicity\": 0,\n \"mfa\": 0,\n \"mfaEnabled\": true,\n \"name\": \"string\",\n \"nameEmail\": \"string\",\n \"orgUnits\": [],\n \"organizations\": [],\n \"pagesRate\": 0,\n \"permissionGroups\": [],\n \"state\": \"string\",\n \"city\": \"string\",\n \"status\": \"string\",\n \"subscriptions\": [],\n \"supportedLanguagePairs\": [\n {\n \"source\": \"string\",\n \"target\": \"string\",\n \"pair\": \"string\"\n }\n ],\n \"tags\": [\n \"string\"\n ],\n \"tasksCompletedCount\": 0,\n \"timezone\": \"string\",\n \"uuid\": \"string\",\n \"wordRate\": 0\n}"}],"_postman_id":"7d83d5e6-c03e-44d7-8a9b-96036fb96a04"},{"name":"Create User","id":"25cb6407-3758-491c-9d2f-b7a2e8d23293","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"New User\",\r\n \"email\": \"newUser@email.com\",\r\n \"status\": \"Active\",\r\n \"organizations\": [\r\n {\r\n \"uuid\": \"35b51513-998e-555e-1f77-f55331180001\"\r\n }\r\n ],\r\n \"country\": \"BR\",\r\n \"state\": \"SP\",\r\n \"city\": \"SĂŁo Paulo\",\r\n \"postalCode\": \"89504000\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/user","description":"This endpoint is used to create a new user with the provided details.
\nname (string, required): The name of the new user.
\nemail (string, required): The email address of the new user.
\nstatus (string, required): The status of the new user (e.g. Active, Inactive).
\norganizations (array, required): An array of organizations the user belongs to, each containing a UUID.
\ncountry (string): The country of the new user.
\nstate (string): The state of the new user.
\ncity (string): The city of the new user.
\npostalCode (string): The postal code of the new user's address.
\nThe response returns the user data, including the UUID that must be used to add a role in Add Role for User.
This endpoint allows you to add a role for a specific user identified by their UUID.
Returns status 200 OK indicating whether the role was successfully assigned.
\n","urlObject":{"path":["api","v3","user",":userUUID","role",":roleName"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the User
\n","type":"text/plain"},"type":"any","value":"userUUID","key":"userUUID"},{"description":{"content":"The role name of the user (VENDOR, CLIENT, ACCOUNT_ADMIN, PROJECT_MANAGER).
\n","type":"text/plain"},"type":"any","value":"","key":"roleName"}]}},"response":[{"id":"0408feea-13f3-4ce4-a745-82e95995c48e","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/user/:userUUID/role/:roleName","host":["{{host}}"],"path":["api","v3","user",":userUUID","role",":roleName"],"variable":[{"key":"userUUID","value":"","description":"Unique identifier of the User"},{"key":"roleName","value":"","description":"The role name of the user (VENDOR, CLIENT, ACCOUNT_ADMIN, PROJECT_MANAGER)."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"81931864-5938-46d7-a217-5f20d002552d"}],"id":"93f19243-8991-4116-a1a5-e63f2074a9fc","description":"User management related endpoints.
\n","_postman_id":"93f19243-8991-4116-a1a5-e63f2074a9fc"},{"name":"Custom Fields","item":[{"name":"List Custom Fields","id":"cc51c2e0-b5f3-414c-94df-9e7cd74b42fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/api/v3/custom-field/list?page=0&size=50","description":"Lists existing custom fields available in the Bureau Works API.
This endpoint supports pagination via query parameters and returns a paged list of custom field definitions.
Zero-based index of the results page to retrieve.
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Maximum number of items to return in a single page.
\n","type":"text/plain"},"key":"size","value":"50"}],"variable":[]}},"response":[{"id":"93e42f21-538f-4d92-8bf5-8aa4bcf8a4dd","name":"List Custom Fields","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/v3/custom-field/list?page=0&size=50","host":["{{host}}"],"path":["api","v3","custom-field","list"],"query":[{"key":"page","value":"0","description":"Zero-based index of the results page to retrieve."},{"key":"size","value":"50","description":"Maximum number of items to return in a single page."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 02 Feb 2026 19:29:43 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"content\": [\n {\n \"uuid\": \"b90e1d4d-8a94-41f8-a881-6a5cf0beba30\",\n \"name\": \"Interests\",\n \"type\": \"MULTIVALUE\",\n \"value\": null,\n \"entity\": \"com.bureauworks.works.user.model.User\",\n \"entityCode\": null,\n \"entities\": null,\n \"multivalueDefault\": [\n \"Technology\"\n ],\n \"values\": [\n \"Photography\",\n \"Technology\",\n \"Development\"\n ]\n },\n {\n \"uuid\": \"ddcbb4ea-e79b-4f7d-aa9b-d9f71a637ef6\",\n \"name\": \"Availability / Work Schedule\",\n \"type\": \"MULTIVALUE\",\n \"value\": null,\n \"entity\": \"com.bureauworks.works.user.model.User\",\n \"entityCode\": null,\n \"entities\": null,\n \"multivalueDefault\": [\n \"Full-time\"\n ],\n \"values\": [\n \"Freelancer\",\n \"Full-time\",\n \"Part-time\",\n \"Flexible hours\"\n ]\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"empty\": true,\n \"sorted\": false,\n \"unsorted\": true\n },\n \"offset\": 0,\n \"pageNumber\": 0,\n \"pageSize\": 50,\n \"unpaged\": false,\n \"paged\": true\n },\n \"last\": true,\n \"totalElements\": 2,\n \"totalPages\": 1,\n \"size\": 50,\n \"number\": 0,\n \"sort\": {\n \"empty\": true,\n \"sorted\": false,\n \"unsorted\": true\n },\n \"first\": true,\n \"numberOfElements\": 2,\n \"empty\": false\n}"}],"_postman_id":"cc51c2e0-b5f3-414c-94df-9e7cd74b42fe"},{"name":"Create Custom Fields","id":"6c1cf177-c192-456b-b139-735b7b3f055e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Departments\",\r\n \"type\": \"MULTIVALUE\",\r\n \"entityCode\": \"PROJECT\",\r\n \"multivalueDefault\": [\"BW\", \"Finance\"]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/custom-field","description":"Valid values for entityType
\nThe type of entity where the custom fields will be updated (e.g., Project, Task, User, etc)
\n","type":"text/plain"},"type":"any","value":"","key":"entityType"},{"description":{"content":"Unique identifier of the Entity where custom fields will be updated
\n","type":"text/plain"},"type":"any","value":"","key":"entityUUID"}]}},"response":[{"id":"632248ba-22f0-494e-86f9-b3cd58308802","name":"200 - Success","originalRequest":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/custom-field/entity/:entityType/:entityUUID","host":["{{host}}"],"path":["api","v3","custom-field","entity",":entityType",":entityUUID"],"variable":[{"key":"entityType","value":"","description":"The type of entity where the custom fields will be updated (e.g., Project, Task, User, etc)"},{"key":"entityUUID","value":"","description":"Unique identifier of the Entity where custom fields will be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 05 Aug 2025 19:45:18 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"Test 1\",\n \"type\": \"NUMERIC\",\n \"value\": \"10\",\n \"uuid\": \"d7b265ce-7cc1-40bb-861f-27dc123eca06\"\n },\n {\n \"name\": \"Test 2\",\n \"type\": \"TEXT\",\n \"value\": \"test\",\n \"uuid\": \"07821390-f123-321b-996a-751a2399efd6\"\n }\n]"}],"_postman_id":"91ead5d7-f1ec-4a53-b954-b97d640b9f7a"}],"id":"735341f2-7331-4549-83cb-601dbd49ebc7","description":"This endpoint allows you to create custom fields or update the values of custom fields associated with a specific system entity.
\n","_postman_id":"735341f2-7331-4549-83cb-601dbd49ebc7"},{"name":"Accounting","item":[{"name":"Payables","item":[{"name":"Payable Summary","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"23b5ed92-d387-4606-9b4c-0bbf242f03be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/payable/summary?vendorName=string&name=string&creationDate=string&dueDate=string&statuses=list&vendor=long&accountUuid=string&missingAccountingInfo=boolean&sort=string","description":"Payables summary, where you can see an overview of items based on specific statuses and milestones.
\n","urlObject":{"path":["api","v3","payable","summary"],"host":["{{host}}"],"query":[{"description":{"content":"Name of the vendor.
\n","type":"text/plain"},"key":"vendorName","value":"string"},{"description":{"content":"Name of the payable.
\n","type":"text/plain"},"key":"name","value":"string"},{"description":{"content":"Date range in which the payable was created. Includes a start date and an end date, in YYYY-MM-DD format.
Payable due date range. Also includes start and end date, in YYYY-MM-DD format.
List of possible statuses for payables. Examples may include statuses such as \"PAID\", \"PENDING\", etc.
\n","type":"text/plain"},"key":"statuses","value":"list"},{"description":{"content":"Vendor ID.
\n","type":"text/plain"},"key":"vendor","value":"long"},{"description":{"content":"Account ID associated with the payable.
\n","type":"text/plain"},"key":"accountUuid","value":"string"},{"description":{"content":"Defines whether there is any missing accounting information for the payable.
\n","type":"text/plain"},"key":"missingAccountingInfo","value":"boolean"},{"description":{"content":"Sets the ordering criteria for the results. The first value indicates the creationDate sort field, and the second value sets the order asc for ascending, desc for descending.
Query accounts payable information and provides flexibility in how this data is retrieved.
\n","urlObject":{"path":["api","v3","payable"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. It's the page number. 0 for the first page. Default: 0
\n","type":"text/plain"},"key":"page","value":"page"},{"description":{"content":"Optional. It's the page size. Default: 50.
\n","type":"text/plain"},"key":"size","value":"size"},{"description":{"content":"Optional. Sets the ordering criteria for the results. The first value indicates the creationDate sort field, and the second value sets the order asc for ascending, desc for descending. e.g.: creationDate,desc
Name of the vendor.
\n","type":"text/plain"},"key":"vendorName","value":"string"},{"description":{"content":"Name of the payable.
\n","type":"text/plain"},"key":"name","value":"string"},{"description":{"content":"Creation date start YYYY-MM-DD format
Creation date end YYYY-MM-DD format
Initial data YYYY-MM-DD format
End date YYYY-MM-DD format
List of possible statuses for payables. Examples may include statuses such as \"PAID\", \"PENDING\", etc.
\n","type":"text/plain"},"key":"statuses","value":"list"},{"description":{"content":"Vendor ID.
\n","type":"text/plain"},"key":"vendor","value":"long"},{"description":{"content":"Account ID associated with the payable.
\n","type":"text/plain"},"key":"accountUuid","value":"string"},{"description":{"content":"Defines whether there is any missing accounting information for the payable.
\n","type":"text/plain"},"key":"missingAccountingInfo","value":"boolean"}],"variable":[]}},"response":[{"id":"2726340b-8742-4673-bb8f-946ffdbc6dbe","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/payable?vendorName=string&name=string&creationDate=string&dueDate=string&statuses=list&vendor=long&accountUuid=string&missingAccountingInfo=boolean&sort=string","host":["{{host}}"],"path":["api","v3","payable"],"query":[{"key":"vendorName","value":"string","description":"Name of the vendor."},{"key":"name","value":"string","description":"Name of the payable."},{"key":"creationDate","value":"string","description":"Date range in which the payable was created. Includes a start date and an end date, in `YYYY-MM-DD` format."},{"key":"dueDate","value":"string","description":"Payable due date range. Also includes start and end date, in `YYYY-MM-DD` format."},{"key":"statuses","value":"list","description":"List of possible statuses for payables. Examples may include statuses such as \"PAID\", \"PENDING\", etc."},{"key":"vendor","value":"long","description":"Vendor ID."},{"key":"accountUuid","value":"string","description":"Account ID associated with the payable."},{"key":"missingAccountingInfo","value":"boolean","description":"Defines whether there is any missing accounting information for the payable."},{"key":"sort","value":"string","description":"Optional. Sets the ordering criteria for the results. The first value indicates the `creationDate` sort field, and the second value sets the order `asc` for ascending, `desc` for descending. e.g.: `creationDate,desc`"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 23 Sep 2024 14:15:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 1,\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"vendor\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"string\",\n \"id\": 1,\n \"name\": \"string\",\n \"status\": \"string\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"string\"\n },\n \"creationDate\": 1726836823589,\n \"dueDate\": 1730120023593,\n \"amount\": 2750.0,\n \"currency\": \"string\",\n \"status\": \"string\",\n \"totalTasks\": 3,\n \"payableFiles\": [],\n \"overallProfitability\": -900.0\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"offset\": 0,\n \"pageNumber\": 0,\n \"pageSize\": 20,\n \"paged\": true,\n \"unpaged\": false\n },\n \"totalElements\": 378,\n \"totalPages\": 19,\n \"last\": false,\n \"size\": 20,\n \"number\": 0,\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"numberOfElements\": 20,\n \"first\": true,\n \"empty\": false\n}"}],"_postman_id":"6effd418-0ebd-4a15-b8a1-6999453eb9c0"},{"name":"Get Payable","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"7f0ee3ae-0845-404e-891d-c15864d92c46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/payable/:payableUUID","description":"Query accounts payable information and provides flexibility in how this data is retrieved.
\n","urlObject":{"path":["api","v3","payable",":payableUUID"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Payable
\n","type":"text/plain"},"type":"any","value":"","key":"payableUUID"}]}},"response":[{"id":"ecca82ff-5adb-4a6f-8b12-846f5edc1618","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/payable/:payableUUID","host":["{{host}}"],"path":["api","v3","payable",":payableUUID"],"variable":[{"key":"payableUUID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 23 Sep 2024 14:15:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 0,\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"vendor\": {\n \"admin\": false,\n \"avatar\": \"string\",\n \"city\": \"string\",\n \"country\": \"BR\",\n \"currency\": \"BRL\",\n \"customFields\": [],\n \"dailyRate\": 0,\n \"deleteAllLanguagePair\": false,\n \"email\": \"string\",\n \"hourlyRate\": 0,\n \"id\": 46875,\n \"invoicingDayOfMonth\": \"DAY_30\",\n \"invoicingPeriodicity\": 30,\n \"mfa\": 0,\n \"mfaEnabled\": false,\n \"minimumFee\": 0,\n \"name\": \"string\",\n \"nameEmail\": \"string\",\n \"pagesRate\": 0,\n \"paymentMethod\": \"string\",\n \"payoneerId\": \"string\",\n \"paypalAccount\": \"string\",\n \"state\": \"string\",\n \"status\": \"string\",\n \"tags\": [],\n \"tasksCompletedCount\": 0,\n \"uuid\": \"string\",\n \"wordRate\": 10\n },\n \"creationDate\": 1751310390109,\n \"dueDate\": 1751396760000,\n \"amount\": 0,\n \"taxesAmount\": 0,\n \"amountBeforeTaxes\": 0,\n \"currency\": \"string\",\n \"status\": \"string\",\n \"payableFiles\": [],\n \"tasks\": [\n {\n \"uuid\": \"string\",\n \"payableAmount\": 12,\n \"currency\": \"USD\",\n \"receivableAmount\": 1341,\n \"project\": {\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"reference\": \"string\",\n \"currency\": \"USD\",\n \"dueDate\": 0,\n \"organizationUuid\": \"string\",\n \"autopilotEnabled\": true\n },\n \"status\": \"string\",\n \"profitability\": 99.10514541387025\n }\n ],\n \"taxes\": [],\n \"lastUpdate\": 1751312800364,\n \"payoutMethod\": \"string\",\n \"vendorMonthlyAverage\": 0\n}"}],"_postman_id":"7f0ee3ae-0845-404e-891d-c15864d92c46"},{"name":"Create Payable for a Account","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"6ede6445-c40a-4a54-83e8-54a822e144be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"dueDate\": 1727375400000,\r\n \"endDate\": 1726597800000,\r\n \"startDate\": 1726597800000\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/payable/create","description":"Create payable for a account.
\n","urlObject":{"path":["api","v3","payable","create"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"e79eb19a-4552-4d0b-a5cb-ebf06d5f0b9b","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/api/v3/payable/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 23 Sep 2024 14:15:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"dueDate\": 1727375400000,\n \"endDate\": 1726597800000,\n \"startDate\": 1726597800000\n}"}],"_postman_id":"6ede6445-c40a-4a54-83e8-54a822e144be"},{"name":"Create Payable for a Vendor","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"9904a294-e160-4141-9935-5a5b8244d5c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"vendorUuidList\": [\r\n \"5fec63f3-d1ad-49cf-888a-5d6ade9243af\"\r\n ],\r\n \"dueDate\": 1727375400000,\r\n \"endDate\": 1726597800000,\r\n \"startDate\": 1726597800000\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/payable/create","description":"Create payable for a vendor.
\n","urlObject":{"path":["api","v3","payable","create"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"cf39eed4-c0a9-47eb-a169-7be8b0dd5727","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/api/v3/payable/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 23 Sep 2024 14:15:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"vendorUuidList\": [\n \"5fec63f3-d1ad-49cf-888a-5d6ade9243af\"\n ],\n \"dueDate\": 1727375400000,\n \"endDate\": 1726597800000,\n \"startDate\": 1726597800000\n}"}],"_postman_id":"9904a294-e160-4141-9935-5a5b8244d5c6"},{"name":"Payable Approve","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"6ac807eb-036b-4a3a-a9eb-bbd25843aa0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/payable/:payableUuid/approve","description":"Approving payable.
\n","urlObject":{"path":["api","v3","payable",":payableUuid","approve"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Payable
\n","type":"text/plain"},"type":"any","value":"payableUuid","key":"payableUuid"}]}},"response":[{"id":"a054ae58-c859-4c84-86c3-d260f4801044","name":"200 - Success","originalRequest":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/payable/:payableUuid/approve","host":["{{host}}"],"path":["api","v3","payable",":payableUuid","approve"],"variable":[{"key":"payableUuid","value":"","description":"UUID of the payable to be retrieved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 23 Sep 2024 14:15:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"vendor\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"string\",\n \"id\": 1,\n \"name\": \"string\",\n \"status\": \"string\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"string\"\n },\n \"creationDate\": 1727131078083,\n \"dueDate\": 1730414278084,\n \"amount\": 0.0,\n \"currency\": \"string\",\n \"status\": \"string\",\n \"totalTasks\": 2,\n \"payableFiles\": []\n}"}],"_postman_id":"6ac807eb-036b-4a3a-a9eb-bbd25843aa0f"},{"name":"Cancel Payable","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"2ed2beee-5024-4b48-b349-a99cd492a3bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/payable/:payableUuid/cancel-payable","description":"Canceling payable.
\n","urlObject":{"path":["api","v3","payable",":payableUuid","cancel-payable"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Payable
\n","type":"text/plain"},"type":"any","value":"payableUuid","key":"payableUuid"}]}},"response":[{"id":"8d139a20-e533-4d83-8eec-1cc26293d268","name":"200 - Success","originalRequest":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/payable/:payableUuid/cancel-payable","host":["{{host}}"],"path":["api","v3","payable",":payableUuid","cancel-payable"],"variable":[{"key":"payableUuid","value":"","description":"UUID of the payable to be retrieved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 23 Sep 2024 14:15:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"vendor\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"string\",\n \"id\": 1,\n \"name\": \"string\",\n \"status\": \"string\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"string\"\n },\n \"creationDate\": 1702380541544,\n \"dueDate\": 1705663741553,\n \"amount\": 230.0,\n \"currency\": \"string\",\n \"status\": \"string\",\n \"totalTasks\": 1,\n \"payableFiles\": [],\n \"overallProfitability\": -475.0,\n \"oldTasksInvoiced\": [\n {\n \"taskId\": 1,\n \"uuid\": \"string\",\n \"payableAmount\": 230.0,\n \"receivableAmount\": 40.0,\n \"projectName\": \"string\",\n \"dueDate\": 1705663741553,\n \"creationDate\": 1702380541544,\n \"overallProfitability\": -475.0,\n \"profitability\": -475.0\n }\n ]\n}"}],"_postman_id":"2ed2beee-5024-4b48-b349-a99cd492a3bf"},{"name":"Delete Payable Attachment","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"12fd7cd9-0f8c-4891-a4b8-7985292faae5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/payable/:payableId/invoice-file","description":"Removing invoice file for payable.
\n","urlObject":{"path":["api","v3","payable",":payableId","invoice-file"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Payable ID to be removed
\n","type":"text/plain"},"type":"any","value":"payableId","key":"payableId"}]}},"response":[{"id":"0dc9ecf0-1d99-40d0-aeda-c2f9be620447","name":"200 - Success","originalRequest":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/payable/:payableId/invoice-file","host":["{{host}}"],"path":["api","v3","payable",":payableId","invoice-file"],"variable":[{"key":"payableId","value":"","description":"Payable ID to be removed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 23 Sep 2024 14:15:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 0,\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"vendor\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"string\",\n \"id\": 1,\n \"name\": \"string\",\n \"status\": \"string\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"string\"\n },\n \"creationDate\": 1654557306653,\n \"dueDate\": 1703274368573,\n \"amount\": 10.000000000000,\n \"currency\": \"string\",\n \"status\": \"string\",\n \"totalTasks\": 3\n}"}],"_postman_id":"12fd7cd9-0f8c-4891-a4b8-7985292faae5"}],"id":"d43c1db3-146f-4a30-ae75-d9533a8dedae","_postman_id":"d43c1db3-146f-4a30-ae75-d9533a8dedae","description":""},{"name":"Receivables","item":[{"name":"Receivables","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"371bf4d1-1bb6-43cc-a679-21e46c70e543","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/receivables?page=number&size=number&sort=string&orgUnitUuid=string&orgUnitName=string&projectName=string&id=long&creationDate=string&dueDate=string&statuses=list&purchaseOrder=string","description":"Getting receivable invoice.
\n","urlObject":{"path":["api","v3","receivables"],"host":["{{host}}"],"query":[{"description":{"content":"Optional. It's the page number. 0 for the first page. Default: 0
\n","type":"text/plain"},"key":"page","value":"number"},{"description":{"content":"Optional. It's the page size. Default: 50.
\n","type":"text/plain"},"key":"size","value":"number"},{"description":{"content":"Optional. Sets the ordering criteria for the results. The first value indicates the creationDate sort field, and the second value sets the order asc for ascending, desc for descending.
Organizational Unit ID.
\n","type":"text/plain"},"key":"orgUnitUuid","value":"string"},{"description":{"content":"Organizational unit name.
\n","type":"text/plain"},"key":"orgUnitName","value":"string"},{"description":{"content":"Name of the project associated with the receivable.
\n","type":"text/plain"},"key":"projectName","value":"string"},{"description":{"content":"Receivable ID.
\n","type":"text/plain"},"key":"id","value":"long"},{"description":{"content":"Date range in which the payable was created. Includes a start date and an end date, in YYYY-MM-DD format.
Payable due date range. Also includes start and end date, in YYYY-MM-DD format.
Invoice status list \"PENDING\", \"PAID\", etc.
\n","type":"text/plain"},"key":"statuses","value":"list"},{"description":{"content":"Purchase order number associated with the receivable.
\n","type":"text/plain"},"key":"purchaseOrder","value":"string"}],"variable":[]}},"response":[{"id":"cccaaa07-6987-48f2-a421-24b54a9794bb","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/api/v3/receivables?orgUnitUuid=string&orgUnitName=string&projectName=string&id=long&creationDate=string&dueDate=string&statuses=list&purchaseOrder=string","host":["{{host}}"],"path":["api","v3","receivables"],"query":[{"key":"orgUnitUuid","value":"string","description":"Organizational Unit ID.","type":"text"},{"key":"orgUnitName","value":"string","description":"Organizational unit name.","type":"text"},{"key":"projectName","value":"string","description":"Name of the project associated with the receivable.","type":"text"},{"key":"id","value":"long","description":"Receivable ID.","type":"text"},{"key":"creationDate","value":"string","description":"Date range in which the payable was created. Includes a start date and an end date, in `YYYY-MM-DD` format.","type":"text"},{"key":"dueDate","value":"string","description":"Payable due date range. Also includes start and end date, in `YYYY-MM-DD` format.","type":"text"},{"key":"statuses","value":"list","description":"Invoice status list \"PENDING\", \"PAID\", etc.","type":"text"},{"key":"purchaseOrder","value":"string","description":"Purchase order number associated with the receivable.","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 23 Sep 2024 14:15:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 1,\n \"uuid\": \"string\",\n \"status\": \"string\",\n \"total\": 355.5,\n \"netAmount\": 355.5,\n \"paidAmount\": 355.5,\n \"taxAmount\": 0.0,\n \"contact\": \"string\",\n \"contactUser\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"string\",\n \"id\": 1,\n \"name\": \"string\",\n \"status\": \"string\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"string\"\n },\n \"creationDate\": 1727123805313,\n \"paymentDate\": 1727123824603,\n \"dueDate\": 1727382960000,\n \"currency\": \"string\",\n \"organizationalUnit\": {\n \"id\": null,\n \"uuid\": \"string\",\n \"organization\": null,\n \"name\": \"string\",\n \"country\": null,\n \"sourceLanguage\": null,\n \"targetLanguages\": null\n },\n \"projects\": [],\n \"taxes\": [],\n \"multipleInstallments\": false,\n \"numInstallments\": 1,\n \"equally\": true,\n \"invoiceFirstOnly\": false,\n \"intervalBetweenDues\": 30\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"offset\": 0,\n \"pageNumber\": 0,\n \"pageSize\": 20,\n \"paged\": true,\n \"unpaged\": false\n },\n \"totalElements\": 292,\n \"totalPages\": 15,\n \"last\": false,\n \"size\": 20,\n \"number\": 0,\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"numberOfElements\": 20,\n \"first\": true,\n \"empty\": false\n}"}],"_postman_id":"371bf4d1-1bb6-43cc-a679-21e46c70e543"},{"name":"Create Receivable","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"7bf496e6-f821-44a1-9d02-7887401ece1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"creationDate\": 1728317316921,\r\n \"projects\": [\r\n {\r\n \"id\": 1,\r\n \"uuid\": \"string\",\r\n \"name\": \"string\",\r\n \"reference\": \"string\",\r\n \"currency\": \"string\",\r\n \"sourceLocale\": \"string\",\r\n \"targetLocales\": [\r\n \"string\"\r\n ],\r\n \"isContinuous\": false,\r\n \"createDate\": 1724787678154,\r\n \"deliveryDate\": 1724788281385,\r\n \"dueDate\": 1724960947113,\r\n \"status\": \"string\",\r\n \"client\": {\r\n \"id\": 1,\r\n \"uuid\": \"string\",\r\n \"organization\": {\r\n \"id\": 1,\r\n \"uuid\": \"string\",\r\n \"name\": \"string\",\r\n \"country\": \"string\"\r\n },\r\n \"name\": \"string\",\r\n \"country\": \"string\",\r\n \"sourceLanguage\": \"string\",\r\n \"targetLanguages\": [\r\n \"string\"\r\n ]\r\n },\r\n \"contact\": {\r\n \"deleteAllLanguagePair\": false,\r\n \"email\": \"string\",\r\n \"id\": 1,\r\n \"name\": \"string\",\r\n \"status\": \"string\",\r\n \"tasksCompletedCount\": 0,\r\n \"uuid\": \"string\"\r\n },\r\n \"totalSegments\": 314,\r\n \"confirmedSegments\": 314,\r\n \"costsStatus\": \"string\",\r\n \"costsCalculatedAt\": 1724788133362,\r\n \"progress\": 1,\r\n \"totalCost\": 36.46\r\n }\r\n ],\r\n \"organizationalUnit\": {\r\n \"uuid\": \"string\"\r\n },\r\n \"contactUser\": {\r\n \"deleteAllLanguagePair\": false,\r\n \"email\": \"string\",\r\n \"id\": 1,\r\n \"name\": \"string\",\r\n \"status\": \"string\",\r\n \"tasksCompletedCount\": 0,\r\n \"uuid\": \"string\"\r\n },\r\n \"currency\": \"string\",\r\n \"dueDate\": 1728576480000,\r\n \"taxes\": [],\r\n \"multipleInstallments\": true,\r\n \"numInstallments\": 2,\r\n \"equally\": true,\r\n \"invoiceFirstOnly\": false,\r\n \"intervalBetweenDues\": 30,\r\n \"firstInstallmentValue\": 0,\r\n \"purchaseOrder\": null,\r\n \"netAmount\": \"36.46\",\r\n \"taxAmount\": 0,\r\n \"total\": \"36.46\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/receivables","description":"Creating invoice for org unit.
\n","urlObject":{"path":["api","v3","receivables"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"1e3579ff-f698-4b6f-bf9c-e1a9fe1ec488","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/api/v3/receivables"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 23 Sep 2024 14:15:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"creationDate\": 1727728513953,\n \"projects\": [\n {\n \"id\": 1,\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"reference\": \"string\",\n \"currency\": \"string\",\n \"sourceLocale\": \"string\",\n \"targetLocales\": [\"string\"],\n \"isContinuous\": false,\n \"createDate\": 1724415652194,\n \"deliveryDate\": 1724416787678,\n \"dueDate\": 1725971019308,\n \"status\": \"string\",\n \"client\": {\n \"id\": 1,\n \"uuid\": \"string\",\n \"organization\": {\n \"id\": 2916,\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"country\": \"string\"\n },\n \"name\": \"string\",\n \"country\": \"string\"\n },\n \"contact\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"string\",\n \"id\": 1,\n \"name\": \"string\",\n \"status\": \"string\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"string\"\n },\n \"totalSegments\": 6,\n \"confirmedSegments\": 6,\n \"costsStatus\": \"string\",\n \"costsCalculatedAt\": 1724415813654,\n \"progress\": 1,\n \"totalCost\": 0.81\n }\n ],\n \"organizationalUnit\": {\n \"uuid\": \"string\"\n },\n \"contactUser\": {\n \"deleteAllLanguagePair\": false,\n \"email\": \"string\",\n \"id\": 1,\n \"name\": \"string\",\n \"status\": \"string\",\n \"tasksCompletedCount\": 0,\n \"uuid\": \"string\"\n },\n \"currency\": \"string\",\n \"dueDate\": 1728592440000,\n \"taxes\": [\n {\n \"id\": 1,\n \"name\": \"string\",\n \"base\": 1.5,\n \"checked\": true\n }\n ],\n \"multipleInstallments\": true,\n \"numInstallments\": 2,\n \"equally\": true,\n \"invoiceFirstOnly\": false,\n \"intervalBetweenDues\": 30,\n \"firstInstallmentValue\": 0,\n \"purchaseOrder\": null,\n \"netAmount\": \"0.80\",\n \"taxAmount\": \"0.01\",\n \"total\": \"0.81\"\n}"}],"_postman_id":"7bf496e6-f821-44a1-9d02-7887401ece1b"},{"name":"Cancel Receivable","event":[{"listen":"test","script":{"id":"b6c40d33-c390-4eb9-8f2f-3932c4dd4a87","exec":["function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"e5c3a224-df84-4bec-82ef-e756fbabb638","exec":[""],"type":"text/javascript","packages":{}}}],"id":"467c1fd4-5cb4-4494-956f-5268ba90e236","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"invoiceUuids\": [\r\n \"string\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/receivables/cancel-receivable","description":"Mark invoices as void.
\n","urlObject":{"path":["api","v3","receivables","cancel-receivable"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"9a5d2bb8-e902-48b1-993d-65ea7b29a5d7","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/api/v3/receivables/cancel-receivable"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 23 Sep 2024 14:15:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"invoiceUuids\": [\n \"string\"\n ]\n}"}],"_postman_id":"467c1fd4-5cb4-4494-956f-5268ba90e236"}],"id":"58f952b7-5ca9-4738-8c4a-ff00331f6167","_postman_id":"58f952b7-5ca9-4738-8c4a-ff00331f6167","description":""}],"id":"2e39a4ec-cb13-4a3a-a9ad-c6330bfec5a6","description":"Endpoints for managing payables and receivables.
\n","_postman_id":"2e39a4ec-cb13-4a3a-a9ad-c6330bfec5a6"},{"name":"Integrations","item":[{"name":"GitHub","item":[{"name":"Get Configuration","id":"bf278918-dfa0-4974-950b-9612326501ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/connector/github/config/:orgUnitUUID","urlObject":{"path":["api","v3","connector","github","config",":orgUnitUUID"],"host":["{{host}}"],"query":[],"variable":[{"id":"a7034c8f-4fe6-4b9a-8e21-96199aafa0d6","description":{"content":"The UUID of the Organizational Unit that holds the WordPress configuration
\n","type":"text/plain"},"type":"any","value":"string","key":"orgUnitUUID"}]}},"response":[{"id":"3262aa5d-c9f0-430e-8977-50b77a0fbe30","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/connector/wordpress/config/:orgUnitUUID","host":["{{host}}"],"path":["api","v3","connector","wordpress","config",":orgUnitUUID"],"variable":[{"key":"orgUnitUUID","value":"{{org-unit.uuid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 May 2021 19:26:10 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"orgUnitUuid\": \"string\",\n \"githubUrl\": \"string\",\n \"githubUser\": \"string\",\n \"githubToken\": \"encrypted\"\n}"}],"_postman_id":"bf278918-dfa0-4974-950b-9612326501ef"},{"name":"Create Configuration","id":"4c1820da-dd26-4d79-be32-acfb5147e709","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"githubUrl\": \"string\",\n \"githubUser\": \"string\",\n \"githubToken\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/github/config","urlObject":{"path":["api","v3","connector","github","config"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"7093fbdc-26e8-4d79-9a71-6c9359c472c7","name":"201 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"githubUser\": \"string\",\n \"githubToken\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/github/config"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 26 May 2021 14:33:40 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"orgUnitUuid\": \"string\",\n \"githubUrl\": \"string\",\n \"githubUser\": \"string\",\n \"githubToken\": \"encrypted\"\n}"}],"_postman_id":"4c1820da-dd26-4d79-be32-acfb5147e709"},{"name":"Update Configuration","id":"7211c4cf-95eb-4d7b-8a0d-597d4b001243","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"githubUrl\": \"string\",\n \"githubUser\": \"string\",\n \"githubToken\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/github/config","urlObject":{"path":["api","v3","connector","github","config"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"1a49d67f-0519-4652-baf0-51ac6b6ee24f","name":"200 - Success","originalRequest":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"githubUser\": \"string\",\n \"githubToken\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/github/config"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 26 May 2021 14:33:40 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"orgUnitUuid\": \"string\",\n \"githubUrl\": \"string\",\n \"githubUser\": \"string\",\n \"githubToken\": \"encrypted\"\n}"}],"_postman_id":"7211c4cf-95eb-4d7b-8a0d-597d4b001243"},{"name":"Get Repository Configurations","id":"3ac2de58-701f-4f8b-8e54-b5a849f55899","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/connector/github/config/:orgUnitUUID/repo","urlObject":{"path":["api","v3","connector","github","config",":orgUnitUUID","repo"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"The UUID of the Organizational Unit that holds the configurations
\n","type":"text/plain"},"type":"any","value":"{{org-unit.uuid}}","key":"orgUnitUUID"}]}},"response":[{"id":"dc9e0742-a55b-4644-8a04-383737c2ec07","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/connector/github/config/:orgUnitUUID/repo","host":["{{host}}"],"path":["api","v3","connector","github","config",":orgUnitUUID","repo"],"variable":[{"key":"orgUnitUUID","value":"{{org-unit.uuid}}","description":"The UUID of the Organizational Unit that holds the configurations"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 26 May 2021 17:47:57 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"string\",\n \"owner\": \"string\",\n \"configUUID\": \"string\",\n \"baseBranch\": \"string\",\n \"projectTag\": \"string\",\n \"configPath\": \"string\"\n }\n]"}],"_postman_id":"3ac2de58-701f-4f8b-8e54-b5a849f55899"},{"name":"Upsert Repository Configurations","id":"0352cd42-861a-41ab-8900-98a131ad6063","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"string\",\n \"owner\": \"string\",\n \"configUUID\": \"string\",\n \"baseBranch\": \"string\",\n \"projectTag\": \"string\",\n \"configPath\": \"string\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/github/config/:orgUnitUUID/repo","description":"This endpoint expects a list of objects in its request body.
The UUID of the Organizational Unit that holds the configuration
\n","type":"text/plain"},"type":"any","value":"{{org-unit.uuid}}","key":"orgUnitUUID"}]}},"response":[{"id":"31b5c084-d31b-477e-acf0-f3c0d2e05ac9","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"string\",\n \"owner\": \"string\",\n \"configPath\": \"string\",\n \"projectTag\": \"string\",\n \"baseBranch\": \"string\"\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/connector/github/config/:orgUnitUUID/repo","host":["{{host}}"],"path":["api","v3","connector","github","config",":orgUnitUUID","repo"],"variable":[{"key":"orgUnitUUID","value":"{{org-unit.uuid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 26 May 2021 16:02:02 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"string\",\n \"owner\": \"string\",\n \"configUUID\": \"string\",\n \"baseBranch\": \"string\",\n \"projectTag\": \"string\",\n \"configPath\": \"string\"\n }\n]"}],"_postman_id":"0352cd42-861a-41ab-8900-98a131ad6063"},{"name":"Delete Repository Configuration","id":"e5845dc6-1475-49c0-8e29-3eb2f6049ce4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/connector/github/config/:orgUnitUUID/repo/:name/owner/:owner","urlObject":{"path":["api","v3","connector","github","config",":orgUnitUUID","repo",":name","owner",":owner"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"The UUID of the Organizational Unit that holds the configuration
\n","type":"text/plain"},"type":"any","value":"{{org-unit.uuid}}","key":"orgUnitUUID"},{"description":{"content":"The name of the GitHub repository
\n","type":"text/plain"},"type":"any","value":"string","key":"name"},{"description":{"content":"The owner of the GitHub repository
\n","type":"text/plain"},"type":"any","value":"string","key":"owner"}]}},"response":[{"id":"22f118da-6728-4d0a-8403-a1a961817ce4","name":"200 - Success","originalRequest":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/connector/github/config/:orgUnitUUID/repo/:name/owner/:owner","host":["{{host}}"],"path":["api","v3","connector","github","config",":orgUnitUUID","repo",":name","owner",":owner"],"variable":[{"key":"orgUnitUUID","value":"{{org-unit.uuid}}","description":"The UUID of the Organizational Unit that holds the configuration"},{"key":"name","value":"string","description":"The name of the GitHub repository"},{"key":"owner","value":"string","description":"The owner of the GitHub repository"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 26 May 2021 17:50:28 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"string\",\n \"owner\": \"string\",\n \"configUUID\": \"string\",\n \"baseBranch\": \"string\",\n \"projectTag\": \"string\",\n \"configPath\": \"string\"\n}"}],"_postman_id":"e5845dc6-1475-49c0-8e29-3eb2f6049ce4"},{"name":"Create Project","id":"7b3d51d4-52eb-46e2-bf86-0b3243452266","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUUID\": \"string\", // required, to identify the target Organizational Unit\n \"repository\": \"string\", // required, the name of the repository inThis endpoint spawns an async process identified by the field id in the response body. In order to retrieve the status of the process this id must be passed as a request parameter in future calls to this endpoint.
Optional - The id of the async process. If provided this will return the current status of the async process
This endpoint spawns an async process identified by the field id in the response body. In order to retrieve the status of the process this id must be passed as a request parameter in future calls to this endpoint.
Optional - The id of the async process. If provided this will return the current status of the async process
The UUID of the project you wish to have the translations delivered
\n","type":"text/plain"},"type":"any","value":"string","key":"projectUUID"}]}},"response":[{"id":"0eaf3d84-d74d-43b1-8289-2b92ad1fcda3","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"languages\": [],\n \"filenames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/connector/github/translation/:projectUUID","host":["{{host}}"],"path":["api","v3","connector","github","translation",":projectUUID"],"variable":[{"key":"projectUUID","value":"{{project.uuid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 May 2021 20:20:02 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"status\": \"NEW\",\n \"data\": null,\n \"error\": null\n}"}],"_postman_id":"c085c14f-60b9-4081-9993-a6fd6bf28a94"}],"id":"415f80ee-4bb3-4c22-821c-cb514a054e61","_postman_id":"415f80ee-4bb3-4c22-821c-cb514a054e61","description":""},{"name":"Eloqua","item":[{"name":"Get Configuration","id":"3c421564-297c-4e7c-b384-28006686f0c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/connector/eloqua/config/:orgUnitUUID","urlObject":{"path":["api","v3","connector","eloqua","config",":orgUnitUUID"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"The UUID of the Organizational Unit that holds the WordPress configuration
\n","type":"text/plain"},"type":"any","value":"string","key":"orgUnitUUID"}]}},"response":[{"id":"484b6220-08eb-4e2d-81b8-986809bd7936","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/connector/eloqua/config/:orgUnitUUID","host":["{{host}}"],"path":["api","v3","connector","eloqua","config",":orgUnitUUID"],"variable":[{"key":"orgUnitUUID","value":"{{org-unit.uuid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 May 2021 19:26:10 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"orgUnitUuid\": \"string\",\n \"companyName\": \"string\",\n \"username\": \"string\",\n \"password\": \"encrypted\"\n}"}],"_postman_id":"3c421564-297c-4e7c-b384-28006686f0c9"},{"name":"Create Configuration","id":"065bdbd0-71ec-452e-ae87-578c32548fce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"companyName\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/eloqua/config","urlObject":{"path":["api","v3","connector","eloqua","config"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"0e1a8af6-9987-4f8a-880f-d8d572a21ace","name":"201 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"companyName\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/eloqua/config"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 May 2021 19:52:33 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"orgUnitUuid\": \"string\",\n \"companyName\": \"string\",\n \"username\": \"string\",\n \"password\": \"encrypted\"\n}"}],"_postman_id":"065bdbd0-71ec-452e-ae87-578c32548fce"},{"name":"Update Configuration","id":"c4ffbcc7-97cd-43ab-8124-0e0cb91ec2de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"companyName\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/eloqua/config","urlObject":{"path":["api","v3","connector","eloqua","config"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"111555b1-7b2c-4f16-8845-adfe85ca493a","name":"200 - Success","originalRequest":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"companyName\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/eloqua/config"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 May 2021 19:52:33 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"orgUnitUuid\": \"string\",\n \"companyName\": \"string\",\n \"username\": \"string\",\n \"password\": \"encrypted\"\n}"}],"_postman_id":"c4ffbcc7-97cd-43ab-8124-0e0cb91ec2de"},{"name":"Create Project","id":"785f36ac-a39b-4ba9-a5f9-2579cc5ca385","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUUID\": \"string\", // required, to identify the target Organizational Unit\n \"contactUUID\": \"string\", // required, this is the Project's POC in Bureau Works, the user UUID\n \"type\": \"string\", // required, the types in the Eloqua types, e.g., EMAIL, DYNAMIC_CONTENT\n \"sourceLanguage\": \"string\", // required, will assume Organizational Unit config - if empty, will fail\n \"targetLanguages\": [\"string\"], // required, will assume Organizational Unit config - if empty, will fail\n \"configUUID\": \"string\", // optional, if specified, will fetch a specific config regardless of the Organizational Unit\n \"workflows\": [\"string\"], // optional, defaults to Organizational Unit configuration - valid values are TRANSLATION, REVIEW, REVIEW_2, ICR, REGIONAL_APPROVAL, DTP, etc.\n \"assetIds\": [\"string\"], // optional, if specified will limit sync to the defined scope\n \"skipHashCheck\": \"boolean\" // optional, if true, will ignore hash check and create projects with all the entries found in the repository, default FALSE\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/eloqua/sync?requestId=string","description":"This endpoint spawns an async process identified by the field id in the response body. In order to retrieve the status of the process this id must be passed as a request parameter in future calls to this endpoint.
Optional - The id of the async process. If provided this will return the current status of the async process
This endpoint spawns an async process identified by the field id in the response body. In order to retrieve the status of the process this id must be passed as a request parameter in future calls to this endpoint.
Optional - The id of the async process. If provided this will return the current status of the async process
The UUID of the project you wish to have the translations delivered
\n","type":"text/plain"},"type":"any","value":"string","key":"projectUUID"}]}},"response":[{"id":"1751edd0-ca6f-4f7f-98b6-34ca11afd17b","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"languages\": [],\n \"filenames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/connector/eloqua/translation/:projectUUID","host":["{{host}}"],"path":["api","v3","connector","eloqua","translation",":projectUUID"],"variable":[{"key":"projectUUID","value":"{{project.uuid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 May 2021 20:20:02 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"status\": \"NEW\",\n \"data\": null,\n \"error\": null\n}"}],"_postman_id":"58780b3e-121e-41d6-8ff6-911f371d9e9e"}],"id":"3bbf5cd7-53ec-486a-a179-f5b335db32eb","_postman_id":"3bbf5cd7-53ec-486a-a179-f5b335db32eb","description":""},{"name":"WordPress","item":[{"name":"Get Configuration","id":"2bd8b18d-b95d-495d-95b9-07c1fb1339b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v3/connector/wordpress/config/:orgUnitUUID","urlObject":{"path":["api","v3","connector","wordpress","config",":orgUnitUUID"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"The UUID of the Organizational Unit that holds the WordPress configuration
\n","type":"text/plain"},"type":"any","value":"string","key":"orgUnitUUID"}]}},"response":[{"id":"1ac54baf-e691-4e88-baa2-4ebd92e5ea5c","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":{"raw":"{{host}}/api/v3/connector/wordpress/config/:orgUnitUUID","host":["{{host}}"],"path":["api","v3","connector","wordpress","config",":orgUnitUUID"],"variable":[{"key":"orgUnitUUID","value":"{{org-unit.uuid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 May 2021 19:26:10 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"orgUnitUuid\": \"string\",\n \"baseUrl\": \"string\",\n \"wpUser\": \"string\",\n \"wpPassword\": \"encrypted\",\n \"wpCookieUser\": \"string\",\n \"wpCookiePassword\": \"encrypted\",\n \"params\": \"object\"\n}"}],"_postman_id":"2bd8b18d-b95d-495d-95b9-07c1fb1339b9"},{"name":"Create Configuration","id":"6e67f6c8-242d-4e4b-b036-ea56ca17224a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"baseUrl\": \"string\",\n \"wpUser\": \"string\",\n \"wpPassword\": \"string\",\n \"wpCookieUser\": \"string\",\n \"wpCookiePassword\": \"string\",\n \"strategy\": \"string\",\n \"params\": \"object\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/wordpress/config","urlObject":{"path":["api","v3","connector","wordpress","config"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"81240e5e-db57-4587-9b63-f5568ac2cd7d","name":"201 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"baseUrl\": \"string\",\n \"wpUser\": \"string\",\n \"wpPassword\": \"string\",\n \"wpCookieUser\": \"string\",\n \"wpCookiePassword\": \"string\",\n \"strategy\": \"string\",\n \"params\": \"object\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/wordpress/config"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 May 2021 19:52:33 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"orgUnitUuid\": \"string\",\n \"baseUrl\": \"string\",\n \"wpUser\": \"string\",\n \"wpPassword\": \"encrypted\",\n \"wpCookieUser\": \"string\",\n \"wpCookiePassword\": \"encrypted\",\n \"strategy\": \"string\",\n \"params\": \"object\"\n}"}],"_postman_id":"6e67f6c8-242d-4e4b-b036-ea56ca17224a"},{"name":"Update Configuration","id":"ab0be380-354d-4d7a-98f7-68d98caea93d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"baseUrl\": \"string\",\n \"wpUser\": \"string\",\n \"wpPassword\": \"string\",\n \"wpCookieUser\": \"string\",\n \"wpCookiePassword\": \"string\",\n \"strategy\": \"string\",\n \"params\": \"object\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/wordpress/config","urlObject":{"path":["api","v3","connector","wordpress","config"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"85312339-40de-4e1d-a934-3543ad8cefd4","name":"200 - Success","originalRequest":{"method":"PUT","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUuid\": \"string\",\n \"baseUrl\": \"string\",\n \"wpUser\": \"string\",\n \"wpPassword\": \"string\",\n \"wpCookieUser\": \"string\",\n \"wpCookiePassword\": \"string\",\n \"strategy\": \"string\",\n \"params\": \"object\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/wordpress/config"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 May 2021 19:52:33 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"string\",\n \"orgUnitUuid\": \"string\",\n \"baseUrl\": \"string\",\n \"wpUser\": \"string\",\n \"wpPassword\": \"encrypted\",\n \"wpCookieUser\": \"string\",\n \"wpCookiePassword\": \"encrypted\",\n \"strategy\": \"string\",\n \"params\": \"object\"\n}"}],"_postman_id":"ab0be380-354d-4d7a-98f7-68d98caea93d"},{"name":"Create Project","id":"4e54d0dc-d489-4480-afe4-0a403d78db45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orgUnitUUID\": \"string\", // required, to identify the target Organizational Unit\n \"contactUUID\": \"string\", // required, this is the Project's POC in Bureau Works, the user UUID\n \"type\": \"string\", // required, the types in the Wordpress site, e.g., post, page\n \"configUUID\": \"string\", // required, if specified, will fetch a specific config regardless of the Organizational Unit\n \"sourceLanguage\": \"string\", // optional, will assume Organizational Unit config - if empty, will fail\n \"targetLanguages\": [\"string\"], // optional, will assume Organizational Unit config - if empty, will fail\n \"workflows\": [\"string\"], // optional, defaults to Organizational Unit configuration - valid values are TRANSLATION, REVIEW, REVIEW_2, ICR, REGIONAL_APPROVAL, DTP, etc.\n \"wpIds\": [\"integer\"], // optional, if specified will limit sync to the defined scope\n \"skipStatusCheck\": \"boolean\", // optional, if true, will create entries regardless of their previous statuses, default FALSE\n \"skipHashCheck\": \"boolean\" // optional, if true, will ignore hash check and create projects with all the entries found in the repository, default FALSE\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v3/connector/wordpress/sync?requestId=string","description":"This endpoint spawns an async process identified by the field id in the response body. In order to retrieve the status of the process this id must be passed as a request parameter in future calls to this endpoint.
Optional - The id of the async process. If provided this will return the current status of the async process
This endpoint spawns an async process identified by the field id in the response body. In order to retrieve the status of the process this id must be passed as a request parameter in future calls to this endpoint.
Optional - The id of the async process. If provided this will return the current status of the async process
The UUID of the project you wish to have the translations delivered
\n","type":"text/plain"},"type":"any","value":"string","key":"projectUUID"}]}},"response":[{"id":"42a92846-9b78-48c0-b02d-7cf76e1e6c87","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"languages\": [],\n \"filenames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/api/v3/connector/wordpress/translation/:projectUUID","host":["{{host}}"],"path":["api","v3","connector","wordpress","translation",":projectUUID"],"variable":[{"key":"projectUUID","value":"{{project.uuid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 May 2021 20:20:02 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"status\": \"NEW\",\n \"data\": null,\n \"error\": null\n}"}],"_postman_id":"657ef2d8-e33b-44ee-91a0-2154b35fa9c1"}],"id":"0a7e48c9-b8df-48c0-9150-ef939cf6a285","_postman_id":"0a7e48c9-b8df-48c0-9150-ef939cf6a285","description":""}],"id":"0b74a5d7-c795-4550-b3a2-a92ce0b9a073","description":"This endpoint retrieves details of the most recent import job for a specific glossary, identified by UUID. This is useful for checking the status and results of the latest import operation.
\n","_postman_id":"0b74a5d7-c795-4550-b3a2-a92ce0b9a073"},{"name":"Webhooks","item":[],"id":"3e7a67f7-0196-4c07-8934-959c9d74a53e","description":"Webhooks are a mechanism that allows applications to communicate with each other by sending HTTP requests. They are often used to notify an application when an event occurs in another application. For example, you could use a webhook to notify a project management application when a new task is created in a version control system.
\nBWX webhooks can be used to notify your application when a variety of events occur in our platform, including the creation of new projects, the change of task statuses, and the completion of work.
\nOnly endpoints that accept a POST request are allowed.
\nWe will attempt to validate the provided endpoint up to 3 times in the span of 10 seconds or less. Your endpoint must return an EMPTY response along with an HTTP Code 200 within 3 seconds.
\nWe will send a X-BWX-Webhook-ID header with each request. The ID can be retrieved when you create the configuration in BWX, and you can store it in your system for verification.
\nIf a secret is provided, we will securely store this information and send back to you in the X-BWX-Webhook-Secret header for additional validation. Otherwise, the header value will be empty or null.
\nFinally, a X-BWX-Event-ID will be sent with the unique, global event ID in BWX. This can be used to prevent duplicates from being processed and future analysis.
\nAll BWX webhook requests will include the following HTTP headers:
\nContent-Type: application/json; charset=UTF-8
X-Bwx-Event-Id: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
X-Bwx-Webhook-Id: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
X-Bwx-Webhook-Secret: secret
The following are the types of webhook events that BWX offers:
\nNEW_EMPTY_PROJECT: A new empty project was created.
NEW_PROJECT: A new project was created.
WORK_UNIT_STATUS_CHANGE: The status of a work unit was changed.
WORK_UNIT_TRANSLATION_FILE_READY: The translated file of work unit is ready to download.
PROJECT_STATUS_CHANGE: The status of a project was changed.
PROJECT_UPDATE: Changes in project information.
PROJECT_INGESTION_COMPLETED: Marks the completion of project data ingestion, triggered when files are uploaded.
PROJECT_TRANSLATION_FINISHED: The project's pre-translation is complete.
TASK_ASSIGNED: A task was assigned to a user.
TASK_STATUS_CHANGE: The status of a task was changed.
TASK_UPDATE: Changes in task information.
NEW_ORG: A new organization was created.
ORG_UPDATE: Changes in organization information.
NEW_ORG_UNIT: A new organizational unit was created.
ORG_UNIT_UPDATE: Changes in organizational unit information.
NEW_USER: A new user was created.
USER_UPDATE: Changes in user information.
WEBHOOK_VALIDATION: Sent upon webhook creation to validate the endpoint and confirm integration connectivity.
For each webhook event, we will provide a description of the event and an example payload.
\nDescription: This event is triggered when a new empty project is created.
\n{\n \"creation_timestamp\": 1699632126871, \n \"creator\": \"Person Name\", \n \"creator_email\": \"person@email.com\", \n \"event_type\": \"NEW_EMPTY_PROJECT\", \n \"id\": 111, \n \"instructions\": null, \n \"name\": \"B-1234-12345\", \n \"notes\": null, \n \"reference\": null, \n \"source_locale\": null, \n \"status\": \"Draft\", \n \"tags\": [], \n \"target_locales\": null, \n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", \n \"workflows\": null,\n \"custom_fields\": []\n}\n\nDescription: This event is triggered when a new project is created.
\n{\n \"creation_timestamp\": 1699632126871, \n \"creator\": \"Person Name\", \n \"creator_email\": \"person@email.com\", \n \"event_type\": \"NEW_PROJECT\", \n \"id\": 111, \n \"instructions\": null, \n \"name\": \"B-1234-12345\", \n \"notes\": null, \n \"reference\": \"Project Reference\", \n \"source_locale\": \"en_us\", \n \"status\": \"Draft\", \n \"tags\": [\n \"abc\"\n ], \n \"target_locales\": null, \n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", \n \"workflows\": null,\n \"custom_fields\": []\n}\n\nDescription: This event is triggered when there is a change in the status of a work unit within a project.
\n{\n \"id\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"source_locale\": \"pt_br\",\n \"target_locale\": \"en_us\",\n \"begin_index\": 0,\n \"end_index\": 41,\n \"org_unit_uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"project_uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"project_step_level\": 1,\n \"project_file_name\": \"file.txt\",\n \"project_file_id\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"confirmed_segments\": 42,\n \"confirmed_non_translatable\": 0,\n \"total_segments\": 42,\n \"total_non_translatable\": 0,\n \"chars\": 1466,\n \"words\": 297,\n \"translated_file_url\": null,\n \"extracted_content\": {},\n \"event_type\": \"WORK_UNIT_STATUS_CHANGE\",\n \"new_status\": \"DELIVERED\",\n \"previous_status\": \"TRANSLATED\",\n \"ci_tag\": \"tag\",\n \"workflow\": \"TRANSLATION\",\n \"is_last_workflow\": false\n}\n\nDescription: This event is triggered when the translated file for a work unit is ready for download.
\n{\n \"id\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"translation_status\": \"TRANSLATED\",\n \"translated_file_url\": \"https://bureauworks.com/ohplaces-es_es.txt\",\n \"original_file_url\": \"https://bureauworks.com/ohplaces.txt\",\n \"translated_file_creation_date\": 1717476034537,\n \"event_type\": \"WORK_UNIT_TRANSLATION_FILE_READY\",\n \"source_locale\": \"en_us\",\n \"target_locale\": \"es_es\",\n \"project_uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"project_file_name\": \"ohplaces.txt\",\n \"confirmed_segments\": 2,\n \"total_segments\": 2,\n \"status\": \"DELIVERED\",\n \"ci_tag\": \"xxxx\",\n \"workflow\": \"TRANSLATION\",\n \"is_last_workflow\": true,\n \"extracted_content:\": {}\n}\n\nDescription: This event is triggered when there is a change in the overall status of a project.
\n{\n \"creation_timestamp\": 1699632126871, \n \"creator\": \"Person Name\", \n \"creator_email\": \"person@email.com\", \n \"event_type\": \"PROJECT_STATUS_CHANGE\", \n \"id\": 111, \n \"instructions\": null, \n \"name\": \"B-12345-12345\", \n \"new_status\": \"PENDING\", \n \"notes\": null, \n \"previous_status\": \"DRAFT\", \n \"reference\": \"Project Reference\", \n \"source_locale\": \"en_us\", \n \"status\": \"Pending\", \n \"tags\": [\n \"abc\"\n ], \n \"target_locales\": [\"pt_br\", \"es_es\"], \n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", \n \"workflows\": [\"TRANSLATION\", \"REVIEW\"],\n \"custom_fields\": []\n}\n\nDescription: This event is triggered when certain project information changes.
\n{\n \"id\": 111,\n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"name\": \"B-2643-60523-40CC\",\n \"reference\": \"string\",\n \"status\": \"Pending\",\n \"creator\": \"Person Name\",\n \"creator_email\": \"person@email.com\",\n \"creation_timestamp\": 1770925723698,\n \"source_locale\": \"en_us\",\n \"target_locales\": [\n \"en_us\",\n \"pt_br\"\n ],\n \"instructions\": null,\n \"notes\": null,\n \"workflows\": [\n \"TRANSLATION\",\n \"REVIEW\"\n ],\n \"tags\": [],\n \"ci_tag\": null,\n \"custom_fields\": [\n {\n \"name\": \"Person Name\",\n \"type\": \"MULTIVALUE\",\n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"value\": []\n }\n ],\n \"org_unit_uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"account_uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"event_type\": \"PROJECT_UPDATE\"\n}\n\nDescription: This event is triggered upon completion of project data ingestion, signaling the upload of files.
\n{\n \"creation_timestamp\": 1699632126871, \n \"creator\": \"Person Name\", \n \"creator_email\": \"person@email.com\", \n \"event_type\": \"PROJECT_INGESTION_COMPLETED\", \n \"id\": 111, \n \"instructions\": null, \n \"name\": \"B-12345-12345\", \n \"new_status\": \"PENDING\", \n \"notes\": null, \n \"previous_status\": \"DRAFT\", \n \"reference\": \"Project Reference\", \n \"source_locale\": \"en_us\", \n \"status\": \"Pending\", \n \"tags\": [\n \"abc\"\n ], \n \"target_locales\": [\"pt_br\", \"es_es\"], \n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", \n \"workflows\": [\"TRANSLATION\", \"REVIEW\"],\n \"custom_fields\": []\n}\n\nDescription: This event is triggered upon the completion of the pre-translation phase for a project.
\n{\n \"project_id\": 111,\n \"project_uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"project_name\": \"B-12345-12345\",\n \"total_work_units_completed\": 10,\n \"total_work_units_failed\": 0,\n \"total_work_units\": 10,\n \"event_type\": \"PROJECT_TRANSLATION_FINISHED\"\n}\n\nDescription: This event is triggered when a task is assigned within a project.
\n{\n \"acceptance_date\": null, \n \"assign_date\": 1699632164745, \n \"assigned_by_email\": \"someone@bureauworks.com\", \n \"assigned_by_name\": \"Someone Lastname\", \n \"assignee\": \"Assignee Name\", \n \"assignee_email\": \"assignee@email.com\", \n \"assignee_word_rate\": 0.1, \n \"begin_index\": null, \n \"creation_timestamp\": 1699632157453, \n \"creator\": \"Task Creator Name\", \n \"creator_email\": \"someone@bureauworks.com\", \n \"delivery_date\": null, \n \"due_date\": 1699653757470, \n \"end_index\": null, \n \"event_type\": \"TASK_ASSIGNED\", \n \"files\": [], \n \"id\": 111, \n \"instructions\": null, \n \"minimum_score_required\": 80.0, \n \"name\": null, \n \"reference_files\": [], \n \"scheduled_date\": null, \n \"skip_date\": null, \n \"status\": \"ASSIGNED\", \n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", \n \"workflow\": \"TRANSLATION\",\n \"custom_fields\": []\n}\n\nDescription: This event is triggered when there is a change in the status of a task within a project.
\n{\n \"acceptance_date\": null, \n \"assign_date\": 1699632173088, \n \"assigned_by_email\": \"someone@bureauworks.com\", \n \"assigned_by_name\": \"Assigner Name\", \n \"assignee\": \"Assignee Name\", \n \"assignee_email\": \"assignee_email@email.com\", \n \"assignee_word_rate\": null, \n \"begin_index\": null, \n \"creation_timestamp\": 1699632157453, \n \"creator\": \"Task Creator Name\", \n \"creator_email\": \"someone@bureauworks.com\", \n \"delivery_date\": null, \n \"due_date\": 1699653757470,\n \"formatted_due_date\": \"MM/dd/yyyy HH:mm:ss z\",\n \"end_index\": null, \n \"event_type\": \"TASK_STATUS_CHANGE\", \n \"files\": [], \n \"id\": 111, \n \"instructions\": null, \n \"minimum_score_required\": 80.0, \n \"name\": null, \n \"new_status\": \"EXPIRED\", \n \"previous_status\": \"Assigned\", \n \"reference_files\": [], \n \"scheduled_date\": null, \n \"skip_date\": null, \n \"status\": \"EXPIRED\", \n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", \n \"workflow\": \"TRANSLATION\",\n \"custom_fields\": []\n}\n\nDescription: This event is triggered when certain task information changes.
\n{\n \"id\": 111,\n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"name\": null,\n \"creation_timestamp\": 1770058982102,\n \"status\": \"DELIVERED\",\n \"creator\": \"Creator Name\",\n \"creator_email\": \"someone@bureauworks.com\",\n \"assigned_by_name\": \"Assigneed Name\",\n \"assigned_by_email\": \"assignee_email@email.com\",\n \"assignee\": \"Assignee Name\",\n \"assignee_email\": \"assignee_email@email.com\",\n \"assignee_word_rate\": 0,\n \"workflow\": \"DTP\",\n \"instructions\": null,\n \"begin_index\": null,\n \"end_index\": null,\n \"due_date\": 1770095712922,\n \"delivery_date\": 1770060143350,\n \"skip_date\": null,\n \"scheduled_date\": null,\n \"acceptance_date\": null,\n \"assign_date\": 1770059726633,\n \"minimum_score_required\": null,\n \"files\": [],\n \"reference_files\": [],\n \"custom_fields\": [],\n \"project_uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"org_unit_uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"account_uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"event_type\": \"TASK_UPDATE\"\n}\n\nDescription: This event is triggered when a new organization is created.
\n{\n \"country\": \"DZ\", \n \"event_type\": \"NEW_ORG\", \n \"id\": 111, \n \"name\": \"Organization Name\", \n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"custom_fields\": []\n}\n\nDescription: This event is triggered when certain organizational information changes.
\n{\n \"id\": 111,\n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"name\": \"Organizational Name\",\n \"country\": \"US\",\n \"custom_fields\": null,\n \"event_type\": \"ORG_UPDATE\"\n}\n\nDescription: This event is triggered when a new organizational unit is created.
\n{\n \"country\": \"AI\", \n \"event_type\": \"NEW_ORG_UNIT\", \n \"id\": 111, \n \"name\": \"New Org. Unit\", \n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"custom_fields\": []\n}\n\nDescription: This event is triggered when certain organizational unit information changes.
\n{\n \"id\": 3592,\n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"name\": \"Org. Unit Name\",\n \"country\": \"DE\",\n \"timezone\": \"Europe/Berlin\",\n \"address_street\": null,\n \"address_number\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": null,\n \"address_neighborhood\": null,\n \"address_additional_info\": null,\n \"phone\": null,\n \"mobile\": null,\n \"website\": null,\n \"contact_notes\": null,\n \"default_contact_person_uuid\": null,\n \"default_contact_person_name\": null,\n \"default_contact_person_email\": null,\n \"default_project_manager_uuid\": null,\n \"default_project_manager_name\": null,\n \"default_project_manager_email\": null,\n \"tags\": [\n],\n \"autopilot_enabled\": false,\n \"project_automation_enabled\": true,\n \"categorization_disabled\": false,\n \"notify_zendesk_enabled\": false,\n \"default_source_language\": \"en_us\",\n \"client_languages\": \"de_de,pt_br,en_us\",\n \"regex\": null,\n \"override_default_regex\": null,\n \"continuous_platform_tag\": null,\n \"continuous_project_config\": null,\n \"send_quote_auto\": true,\n \"tm_match_over_repetition_enabled\": false,\n \"nt_match_over_repetition_enabled\": false,\n \"contact_person_email_notifications\": true,\n \"vendor_email_notifications\": true,\n \"project_manager_email_notifications\": true,\n \"notify_project_comments\": true,\n \"send_available_tasks_email\": true,\n \"send_receivable_email_notification\": null,\n \"currency\": \"USD\",\n \"xero_id\": null,\n \"billing_email\": null,\n \"auto_billing\": null,\n \"consolidate_projects\": null,\n \"send_invoice_to_requester\": null,\n \"invoicing_type\": \"MONTHLY\",\n \"payment_method\": null,\n \"account_code\": null,\n \"taxpayer_id\": null,\n \"tracking_category\": null,\n \"tracking_category_type\": null,\n \"days_until_payment_due\": 10,\n \"invoice_info\": null,\n \"isolated_tags\": false,\n \"costs_logfile_type\": \"POST_ANALYSE\",\n \"custom_receivable_by_user\": false,\n \"task_payment_type\": \"WORD\",\n \"task_count_words_from\": \"SOURCE\",\n \"project_count_words_from\": \"SOURCE\",\n \"locale_region\": {},\n \"notes\": null,\n \"quote_notes\": null,\n \"tax_info_issue_nfe\": null,\n \"tax_info_simples_nacional\": null,\n \"tax_info_require_purchase_order\": null,\n \"tax_info_retain_ir\": null,\n \"tax_info_municipal_registration\": null,\n \"settings\": {\n \"showGoToProjectButton\": true,\n \"disabledAutopilotPopup\": false,\n \"autopilotAssignmentRule\": \"SINGLE\",\n \"enableTaskFeedback\": false,\n \"useOrgUnitLogo\": null,\n \"useOrgUnitAddress\": null,\n \"showOrgUnitLogoOnEditor\": null,\n \"requireContextTmMatching\": null,\n \"spellCheckerIgnoreWordsEnabled\": null,\n \"alternativeTranslationsEnabled\": null,\n \"zenModeOverridesByWorkflow\": {\n \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\": true,\n \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\": false,\n },\n \"templateNotes\": {\n \"paymentNotes\": null\n }\n },\n \"custom_fields\": null,\n \"event_type\": \"ORG_UNIT_UPDATE\"\n}\n\nDescription: This event is triggered when a new user is added to your account.
\n{\n \"country\": \"AI\", \n \"event_type\": \"NEW_USER\", \n \"id\": 111, \n \"name\": \"New User Name\",\n \"email\": \"some@email.com\",\n \"role\": [\"TRANSLATOR\", \"REVIEWER\"],\n \"status\": \"ACTIVE\",\n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"custom_fields\": []\n}\n\nDescription: This event is triggered when certain user information changes.
\n{\n \"id\": 111,\n \"uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"name\": \"User Name\",\n \"email\": \"some@email.com\",\n \"cell_phone\": null,\n \"phone\": null,\n \"address\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"postal_code\": null,\n \"country\": null,\n \"timezone\": null,\n \"currency\": \"USD\",\n \"company_name\": null,\n \"bio\": null,\n \"notes\": null,\n \"payment_method\": null,\n \"role\": [\n \"USER\",\n \"ACCOUNT_ADMIN\"\n ],\n \"status\": \"ACTIVE\",\n \"account_uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"minimum_fee\": 0,\n \"word_rate\": 0,\n \"hourly_rate\": 0,\n \"daily_rate\": 0,\n \"pages_rate\": 0,\n \"supported_language_pairs\": [],\n \"birth_date\": null,\n \"under_review\": false,\n \"on_payoneer\": false,\n \"contract_signed\": false,\n \"use_project_currency\": false,\n \"custom_fields\": [],\n \"event_type\": \"USER_UPDATE\"\n}\n\nDescription: Sent upon webhook creation to validate the endpoint and confirm integration connectivity.
\n{\n \"webhook_uuid\": \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\n \"expected_response\": \"Please respond with HTTP 200 status to activate this webhook\",\n \"event_type\": \"WEBHOOK_VALIDATION\",\n \"message\": \"This is a test event to validate your webhook endpoint\",\n \"attempt\": 1,\n \"events\": [\n \"NEW_ORG_UNIT\"\n ],\n \"timestamp\": 1770939702062\n}\n\nThis endpoint returns a list of permission groups.
\nReturns a list containing the permission group data.
\n","urlObject":{"path":["api","v2","permission-group"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"73c38226-8770-464f-9f05-26ab411149f1","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{host}}/api/v2/permission-group"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"uuid\": \"123e4567-e89b-12d3-a456-4266b4174000\",\n \"accountUuid\": \"123e5556-e32b-12d3-a456-4266b4174000\",\n \"code\": \"PERMISSIONGROUP01\",\n \"name\": \"Permission Group 01\"\n },\n {\n \"id\": 2,\n \"uuid\": \"123e2345-e44b-12d3-a654-4266e4174000\",\n \"accountUuid\": \"123e4455-e65b-12d3-a654-4266e4174000\",\n \"code\": \"PERMISSIONGROUP02\",\n \"name\": \"Permission Group 02\"\n }\n]"}],"_postman_id":"f008399a-74a4-4b74-9fec-3aa5294cf0bc"},{"name":"Get Permission Group","id":"8af9c504-28bf-4c04-a474-0bd4bce5e5e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v2/permission-group/:permissionGroupUuid","description":"This endpoint returns a specific permission group based on its unique identifier.
\nReturns the data of a specific permission group.
\n","urlObject":{"path":["api","v2","permission-group",":permissionGroupUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Permission Group
\n","type":"text/plain"},"type":"any","value":"","key":"permissionGroupUuid"}]}},"response":[{"id":"db75c8c3-bce7-4946-9a0a-ad387cc9911c","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/v2/permission-group/:permissionGroupUuid","host":["{{host}}"],"path":["api","v2","permission-group",":permissionGroupUuid"],"variable":[{"key":"permissionGroupUuid","value":"123e4567-e89b-12d3-a456-4266b4174000","description":"Unique identifier of the Permission Group"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"uuid\": \"123e4567-e89b-12d3-a456-4266b4174000\",\r\n \"accountUuid\": \"123e5556-e32b-12d3-a456-4266b4174000\",\r\n \"code\": \"PERMISSIONGROUP01\",\r\n \"name\": \"Permission Group 01\"\r\n}"}],"_postman_id":"8af9c504-28bf-4c04-a474-0bd4bce5e5e0"},{"name":"Create Permission Group","id":"aad08eb8-e433-4451-995f-2bc03a27d2f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Permission Group 01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v2/permission-group/","description":"Returns the data of specific permission group.
\nname (string, required): The name of the new permission group.
\nThe response returns the permission group data.
\n","urlObject":{"path":["api","v2","permission-group",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"3140bb9c-cd88-460f-a87d-a59936f3f7cf","name":"200 - Success","originalRequest":{"method":"POST","header":[],"url":"{{host}}/api/v2/permission-group/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"uuid\": \"123e4567-e89b-12d3-a456-4266b4174000\",\r\n \"accountUuid\": \"123e5556-e32b-12d3-a456-4266b4174000\",\r\n \"name\": \"Permission Group 01\"\r\n}"}],"_postman_id":"aad08eb8-e433-4451-995f-2bc03a27d2f5"},{"name":"Update Permission Group","id":"ae84b765-6f4f-42ce-9441-3b1369bca57b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"New Name Permission Group\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v2/permission-group/:permissionGroupUuid","description":"This endpoint is used to update an existing permission group.
\nname (string, required): The new name of the permission group.
\nReturns HTTP 200 status code on success. The response body is empty.
\n","urlObject":{"path":["api","v2","permission-group",":permissionGroupUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Permission Group
\n","type":"text/plain"},"type":"any","value":"","key":"permissionGroupUuid"}]}},"response":[{"id":"a9470723-fa34-4d96-9545-c3c45e729fd6","name":"200 - Success","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/api/v2/permission-group/:permissionGroupUuid","host":["{{host}}"],"path":["api","v2","permission-group",":permissionGroupUuid"],"variable":[{"key":"permissionGroupUuid","value":"","description":"Unique identifier of the Permission Group"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ae84b765-6f4f-42ce-9441-3b1369bca57b"},{"name":"Add User to Permission Group","id":"025681bf-0ee0-42a5-91e1-b5b539ace751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v2/permission-group/:permissionGroupUuid/user/:userUuid","description":"This endpoint is used to add a specific user to a specific permission group. Both the user and the permission group are identified by their UUID.
Returns HTTP 200 status code on success. The response body is empty.
\n","urlObject":{"path":["api","v2","permission-group",":permissionGroupUuid","user",":userUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Permission Group
\n","type":"text/plain"},"type":"any","value":"","key":"permissionGroupUuid"},{"description":{"content":"Unique identifier of the User
\n","type":"text/plain"},"type":"any","value":"","key":"userUuid"}]}},"response":[{"id":"9dadc3ff-1479-4e86-9864-6318d74c2bb0","name":"200 - Success","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/api/v2/permission-group/:permissionGroupUuid/user/:userUuid","host":["{{host}}"],"path":["api","v2","permission-group",":permissionGroupUuid","user",":userUuid"],"variable":[{"key":"permissionGroupUuid","value":"","description":"Unique identifier of the Permission Group"},{"key":"userUuid","value":"","description":"Unique identifier of the User"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"025681bf-0ee0-42a5-91e1-b5b539ace751"},{"name":"Remove User from Permission Group","id":"70f9c840-52d6-4438-bf93-e6681a2531f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v2/permission-group/:permissionGroupUuid/user/:userUuid","description":"This endpoint is used to remove a specific user from a specific permission group. Both the user and the permission group are identified by their UUID.
Returns HTTP 200 status code on success. The response body is empty.
\n","urlObject":{"path":["api","v2","permission-group",":permissionGroupUuid","user",":userUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the Permission Group
\n","type":"text/plain"},"type":"any","value":"","key":"permissionGroupUuid"},{"description":{"content":"Unique identifier of the User
\n","type":"text/plain"},"type":"any","value":"","key":"userUuid"}]}},"response":[{"id":"c16761bf-03a4-4de9-b071-fffe3858448e","name":"200 - Success","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/api/v2/permission-group/:permissionGroupUuid/user/:userUuid","host":["{{host}}"],"path":["api","v2","permission-group",":permissionGroupUuid","user",":userUuid"],"variable":[{"key":"permissionGroupUuid","value":"","description":"Unique identifier of the Permission Group"},{"key":"userUuid","value":"","description":"Unique identifier of the User"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"70f9c840-52d6-4438-bf93-e6681a2531f0"}],"id":"10c972c1-5092-4609-8f48-720c3df96679","_postman_id":"10c972c1-5092-4609-8f48-720c3df96679","description":""},{"name":"List Permissions","id":"5b912cb3-83b1-497c-8029-be2a353f4398","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v2/permission/:granteeUuid","description":"This endpoint returns a list of permissions for a specific grantee.
\nReturns a list containing the permissions available to the specific grantee.
\n","urlObject":{"path":["api","v2","permission",":granteeUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the grantee
\n","type":"text/plain"},"type":"any","value":"","key":"granteeUuid"}]}},"response":[{"id":"4e21bd72-6e9d-405a-9e35-2ed772eec7dc","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/v2/permission/:granteeUuid","host":["{{host}}"],"path":["api","v2","permission",":granteeUuid"],"variable":[{"key":"granteeUuid","value":"","description":"Unique identifier of the grantee"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": \"PERMISSION_01\",\n \"name\": \"Permission 01\",\n \"description\": \"Permission 01 description\",\n \"module\": \"EXAMPLE\",\n \"permissionUuid\": \"aee71230-d2aa-334e-aaaa-e66fd332a044\",\n \"active\": false,\n \"type\": \"GROUP\",\n \"granteeUuid\": \"aeb71456-d2aa-774e-aaaa-e66fd332a998\",\n \"granteeIdentifier\": \"Permission Group 01\",\n \"inherited\": null,\n \"grantSources\": null\n },\n {\n \"code\": \"PERMISSION_02\",\n \"name\": \"Permission 02\",\n \"description\": \"Permission 02 description\",\n \"module\": \"EXAMPLE\",\n \"permissionUuid\": \"abb5555-d2aa-334e-aabb-e44fd332a063\",\n \"active\": false,\n \"type\": \"GROUP\",\n \"granteeUuid\": \"acc6666-d2aa-334e-aabb-e44fd332a063\",\n \"granteeIdentifier\": \"Permission Group 01\",\n \"inherited\": null,\n \"grantSources\": null\n }\n]"}],"_postman_id":"5b912cb3-83b1-497c-8029-be2a353f4398"},{"name":"Grant Permission for Grantee","id":"21464884-f311-41fe-b665-40e927f7042f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v2/permission/grantee/:granteeUuid/permission/:permissionUuid","description":"This endpoint is used to add a specific permission to a specific grantee. granteeUuid should be the unique ID of the grantee you want to add a permission to, and permissionUuid is the unique ID of the permission you want to add. You can get the ID from the endpoint: List Permissions
Returns HTTP 200 status code on success. The response body is empty.
\n","urlObject":{"path":["api","v2","permission","grantee",":granteeUuid","permission",":permissionUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the grantee
\n","type":"text/plain"},"type":"any","value":"","key":"granteeUuid"},{"description":{"content":"Unique identifier of the permission
\n","type":"text/plain"},"type":"any","value":"","key":"permissionUuid"}]}},"response":[{"id":"7a9b31be-0495-4efa-af51-389c19860555","name":"200 - Success","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/api/v2/permission/grantee/:granteeUuid/permission/:permissionUuid","host":["{{host}}"],"path":["api","v2","permission","grantee",":granteeUuid","permission",":permissionUuid"],"variable":[{"key":"granteeUuid","value":"","description":"Unique identifier of the grantee"},{"key":"permissionUuid","value":"","description":"Unique identifier of the permission"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"21464884-f311-41fe-b665-40e927f7042f"},{"name":"Revoke Permission for Grantee","id":"23d64387-e76c-44b1-bc63-9f8d1d02dc83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-AUTH-TOKEN","value":"{{token}}","type":"text"}],"url":"{{host}}/api/v2/permission/grantee/:granteeUuid/permission/:permissionUuid","description":"This endpoint is used to revoke a specific permission to a specific grantee. granteeUuid should be the unique ID of the grantee you want to remove a permission to, and permissionUuid is the unique ID of the permission you want to remove. You can get the ID from the endpoint: List Permissions
Returns HTTP 200 status code on success. The response body is empty.
\n","urlObject":{"path":["api","v2","permission","grantee",":granteeUuid","permission",":permissionUuid"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"Unique identifier of the grantee
\n","type":"text/plain"},"type":"any","value":"","key":"granteeUuid"},{"description":{"content":"Unique identifier of the permission
\n","type":"text/plain"},"type":"any","value":"","key":"permissionUuid"}]}},"response":[{"id":"6780165d-22b8-4baf-8b19-3f881a2142fc","name":"200 - Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/api/v2/permission/grantee/:granteeUuid/permission/:permissionUuid","host":["{{host}}"],"path":["api","v2","permission","grantee",":granteeUuid","permission",":permissionUuid"],"variable":[{"key":"granteeUuid","value":"","description":"Unique identifier of the grantee"},{"key":"permissionUuid","value":"","description":"Unique identifier of the permission"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"23d64387-e76c-44b1-bc63-9f8d1d02dc83"}],"id":"cfce0fde-a4f8-44f9-8edf-c3fe67385401","_postman_id":"cfce0fde-a4f8-44f9-8edf-c3fe67385401","description":""},{"name":"Portal","item":[{"name":"Translate (Context Sensitive)","id":"5526a06c-98d5-4c5a-9d35-89529cd6e3e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sourceLocale\": \"en-US\",\n \"targetLocale\": \"fr-FR\",\n \"originalContent\": \"Hello, world!\",\n \"instructions\": {\n \"tone\": \"friendly\",\n \"formality\": \"formal\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{bw.host}}/api/v3/portal/translate","urlObject":{"path":["api","v3","portal","translate"],"host":["{{bw.host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5526a06c-98d5-4c5a-9d35-89529cd6e3e2"}],"id":"83b30c90-8129-4037-b572-df5c35fa7009","description":"This endpoint translates text using context and returns the entire translated content in a single response. It is suitable for public API usage where streaming is not required.
\nPOST /api/v3/portal/translate Content-Type: application/json
The request body must be a JSON object with the following fields:
\nsourceLocale (string): Source language code (e.g., \"en-US\").
targetLocale (string): Target language code (e.g., \"fr-FR\").
originalContent (string): The text to be translated.
object): Custom translation instructions. See AIInstructions.If you provide the instructions object, it may include:
domain (string): Domain of the translation (e.g., \"legal\", \"medical\").
audience (string): Intended audience (e.g., \"children\", \"professionals\").
formality (string): Formality level (e.g., \"formal\", \"informal\").
tone (string): Tone of the translation (e.g., \"friendly\", \"neutral\").
creativity (string): Creativity level.
guideline (string): Custom guidelines for translation.
userPrompt (string): Additional user prompt.
{\n \"sourceLocale\": \"en-US\",\n \"targetLocale\": \"fr-FR\",\n \"originalContent\": \"Hello, world!\",\n \"instructions\": {\n \"tone\": \"friendly\",\n \"formality\": \"formal\"\n }\n}\n\nSuccess: Returns a JSON string containing the translated content.
\nError: Returns a JSON object with an \"error\" field describing the issue.
{\n \"translation\": \"Bonjour, le monde!\"\n}\n\n{\n \"error\": \"Invalid source locale\"\n}\n\nThe endpoint processes the entire content and returns the result in one response.
\nAll fields are case-sensitive.
\nFor support or questions, contact the Bureau Works API team.
\n","_postman_id":"83b30c90-8129-4037-b572-df5c35fa7009"}],"event":[{"listen":"prerequest","script":{"id":"f42993d3-1f31-42a5-a129-4333ce3a4a18","type":"text/javascript","exec":["// Authenticates the user for all requests","pm.sendRequest({"," url: pm.environment.get(\"host\") + '/api/pub/v1/login',"," method: 'POST',"," header: {"," 'content-type': 'application/json'"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({ accesskey: pm.environment.get(\"api-key\"), secretAccesskey: pm.environment.get(\"api-secret\") })"," }","}, function (err, res) {"," const headers = res.headers.all()"," headers.forEach(function (value, key, map) {"," if (value.key === \"X-AUTH-TOKEN\") {"," pm.environment.set(\"temp_token\", value.value);"," }"," })","})"]}},{"listen":"test","script":{"id":"224030b3-f581-408a-b4a4-cc9a957ab345","type":"text/javascript","exec":["// Cleans all variables that start with temp_ after all requests","function cleanup() {"," const clean = _.keys(pm.environment.toObject())"," _.each(clean, (arrItem) => {"," if (arrItem.startsWith(\"temp_\")) {"," pm.environment.unset(arrItem)"," }"," })","}","cleanup()"]}}]}