{"openapi":"3.1.0","info":{"title":"XTM REST API","description":"# Introduction\n\nXTM Cloud has SOAP and REST APIs that are public-facing.\nThe XTM functionality covered by the two APIs is different. This document describes the\nREST API methods. You can find more information about the SOAP API at https://xtm.cloud/soap-api/.\n\nThe API methods described in this document mostly return HTTP code with body content in JSON format. When the response format is different,\nit is clearly indicated in the description. Obligatory fields are marked as Required.\n\nFor support with the REST API, please visit https://xtm-cloud.atlassian.net/servicedesk/customer/portals.\n\nREST API method responses include custom headers - `xtm-trace-id` and `xtm-span-id` -\nwhich help track user requests throughout the XTM system. Including these headers in Support requests facilitates query analysis.\n","version":"26.1","x-logo":{"url":"https://xtm.cloud/wp-content/themes/xtm/svg/logo.svg","backgroundColor":"#fafafa"}},"servers":[{"url":"/project-manager-api-rest"}],"security":[{"OAuth2-Password":[]}],"tags":[{"name":"Concordance","description":"This section contains methods that relate to concordance."},{"name":"Customer files","description":"This section contains methods that relate to customer files."},{"name":"User workflow steps","description":"This section contains methods that relate to user workflow steps."},{"name":"Project files","description":"This section contains methods that relate to project files."},{"name":"User subject matters","description":"This section contains methods that relate to user subject matters."},{"name":"Terminology import","description":"This section contains methods that relate to importing terminology data."},{"name":"Customer","description":"This section contains methods that relate to customers."},{"name":"User","description":"This section contains methods that relate to users."},{"name":"Project bundles","description":"This section contains methods that relate to bundles in projects."},{"name":"Project custom fields","description":"This section contains methods that relate to project custom fields. For a broader approach to custom fields, visit the custom fields section."},{"name":"Project links","description":"This section contains methods that relate to project links."},{"name":"Workflow","description":"This section contains methods that relate to workflows. For a project-related approach, visit the project workflows section."},{"name":"Project workflows","description":"This section contains methods that relate to project workflows. For a broader approach to workflow, visit the workflow section."},{"name":"Languages","description":"This section contains methods that relate to languages."},{"name":"External user","description":"This section contains methods that relate to external users."},{"name":"Custom field","description":"This section contains methods that relate to custom fields. For a project-related approach, visit the project custom fields section."},{"name":"Project templates","description":"This section contains methods that relate to project templates."},{"name":"Project jobs","description":"This section contains methods that relate to project jobs."},{"name":"Project costs","description":"This section contains methods that relate to project costs."},{"name":"Project activity","description":"This section contains methods that relate to project activity."},{"name":"User language combinations","description":"This section contains methods that relate to user language combinations."},{"name":"Project LQA","description":"This section contains methods that relate to project LQA."},{"name":"System","description":"This section contains methods that relate to system data."},{"name":"Callback properties","description":"This section contains methods that relate to callback properties. This callback configuration is applied to a project's settings whenever one is created."},{"name":"User access rights","description":"This section contains methods that relate to user access rights."},{"name":"LSP rate cards","description":"This section contains methods that relate to LSP rate cards"},{"name":"Terminology penalty profiles","description":"This section contains methods that relate to terminology penalty profiles."},{"name":"Translation memory import","description":"This section contains methods that relate to importing translation memory data."},{"name":"Project states","description":"This section contains methods that relate to project states."},{"name":"User rate cards","description":"This section contains methods that relate to user rate cards."},{"name":"Tag groups","description":"This section contains methods that relate to tag groups."},{"name":"Terminology export","description":"This section contains methods that relate to exporting terminology data."},{"name":"Tag","description":"This section contains methods that relate to tags."},{"name":"XTM Basic","description":"Access tokens are generated from user credentials. Token authentication occurs when an API request is received by XTM. Tokens grant permanent access."},{"name":"Translation memory penalty profiles","description":"This section contains methods that relate to translation memory penalty profiles."},{"name":"Project analytics","description":"This section contains methods that relate to projects analytics."},{"name":"Project","description":"This section contains methods that relate to projects."},{"name":"Roles","description":"This section contains methods that relate to roles. Roles reflect the naming and functionality of the application GUI."},{"name":"Translation memory export","description":"This section contains methods that relate to exporting translation memory data."},{"name":"Project callbacks","description":"This section contains methods that relate to project callbacks."},{"name":"Terminology","description":"This section contains methods that relate to terminology."},{"name":"Callback authentications","description":"This section contains methods that relate to the authentication of callbacks.\n\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n
Authentication typeDescritpion
BasicClient provides a username and a password, XTM inserts them in the request header\n\t\t\t
    \n\t\t\t\t
  • Header key: Authorization
    • \n\t\t\t\t
  • Header value: Basic Base64(username:password)
    • \n\t\t\t
\n\t\t
SignatureClient provides a key and a secret, XTM inserts them in the request headers:\n\t\t\t
    \n\t\t\t\t
  • Header key: x-api-key
    • \n\t\t\t\t
  • Header value: key
    • \n\t\t\t\t
  • Header key: x-signature
    • \n\t\t\t\t
  • Header value: SHA256(key + secret + x-timestamp) - this value is sent in UPPER CASE.
    • \n\t\t\t\t
  • Header key: x-timestamp
    • \n\t\t\t\t
  • Header value: real time in milliseconds, limited to 10 characters
    • \n\t\t\t
\n\t\t
OAuth 2.0Client provides credentials to obtain OAuth 2.0 token:\n\t\t\t
    \n\t\t\t\t
  • URL to the authorization server (required)
    • \n\t\t\t\t
  • client ID (required)
    • \n\t\t\t\t
  • client secret (required)
    • \n\t\t\t\t
  • username (required)
    • \n\t\t\t\t
  • password (required)
    • \n\t\t\t\t
  • scope
    • \n\t\t\t
\n\t\tXTM sends request to the OAuth 2.0 authorization server with the Password grant type parameter. The OAuth 2.0 authorization server response must contain at least an access token and token type. Based on these fields, a value is created for the authorization header, which XTM inserts in the request:\n\t\t\t
    \n\t\t\t\t
  • Header key: Authorization
    • \n\t\t\t\t
  • Header value: [token_type] [access_token]
    • \n\t\t\t
\n\t\tIf the access token is found to be expired when sending the callback, it is obtained from an OAuth 2.0 authorization server again and then callback is resent with a new token.\n\t\t
"},{"name":"Subject matter","description":"This section contains methods that relate to subject matters."},{"name":"Practice online","description":"Try out the XTM REST API using a dedicated online tool that will help you create REST API requests correctly. All you have to do is enter the details from your existing XTM account in the required fields. The tool will send real requests that will be processed on your XTM account.\n\n [Click here to get started](https://api-examples.xtm-intl.com/)"},{"name":"Definitions","description":"**Project**: Processing one or more files from one source language to one or more target languages.\n\n**Job**: Process one file in the source language to transform it into one target language.\n\n**Step**: Workflows are composed of steps. The available default steps are: translate, correct, review, approve TM and LQA.\n\n**Bundle**: The source text segments can split into sections which are called bundles. Bundles can be allocated to different Linguists.\n\n**Task**: Processing a bundle in one step is a task.\n\n
Match typeDescription
iceMatchIn-context exact match, a 100% match with the same source text segment below and above
leveragedMatchLeveraged match, a 100% match
highFuzzyMatch95-99% fuzzy match
mediumFuzzyMatch85-94% fuzzy match
lowFuzzyMatch75-84% fuzzy match
machineTranslationA match obtained from a machine translation engine
repeats100% internal matches
highFuzzyRepeats95-99% internal fuzzy matches
mediumFuzzyRepeats85-94% internal fuzzy matches
lowFuzzyRepeats75-84% internal fuzzy matches
nonTranslatableSegments that only contain numerical or alphanumeric characters or punctuation
"},{"name":"HTTP Codes","description":"**200** - OK\n\n The operation has been completed.\n\n**201** - Created\n\n The request object has been created.\n\n**202** - Accepted\n\n The request has been accepted for processing but the processing has not been completed.\n\n**400** - Bad Request\n\n The request is invalid. You can find more details in the reason.\n\n**401** - Unauthorized\n\n Authentication failed. This can be caused by an invalid or missing token or if access to the API has been disabled.\n\n**403** - Forbidden\n\n This operation is forbidden for the service in general or at the time of the request. You can try again later.\n\n**404** - Not Found\n\n The resource was not found.\n\n**405** - Method Not Allowed\n\n This API operation is not supported. Send a valid request.\n\n**406** - Not Acceptable\n\n The request is invalid. Specify valid request parameters.\n\n**415** - Unsupported Media Type\n\n This request probably contains an incorrect header. In most cases, XTM returns responses in app/json.\n\n**422** - Unprocessable Entity\n\n Specify values for all required parameter fields.\n\n**500** - Internal Server Error\n\n Contact XTM support.\n\n**503** - Service Unavailable\n\n The server temporarily cannot process the request. You can try again later.\n\n"},{"name":"Language codes","description":"The list of supported languages, with their corresponding language codes, can be found in the [XTM Cloud online help](https://help.xtm.cloud/en/xtm-cloud/26.1/en/language-codes.html).\n\n`ab, aa_ET, ak, af_ZA, sq_AL, am_ET, am_ER, ar_AA, ar_AE, ar_BH, ar_DZ, ar_EG, ar_EH, ar_IQ, ar_JO, ar_KW, ar_LB, ar_LY, ar_MA, ar_MR, ar_OM, ar_PS, ar_QA, ar_SA, ar_SD, ar_SY, ar_TD, ar_TN, ar_YE, anu, hy_AM, hy_AM_arevela, hy_AM_arevmda, as_IN, ast_ES, ay_BO, az_AZ_Cyrl, az_AZ_Latn, ba_RU, bal_IR, bh_IN, bi_VU, bam, bs_BA_Cyrl, bs_BA_Latn, br_FR, bsk, my_MM, be_BY, cal, ca_ES, ceb, cha, cja, cjm, ctd, ny_MW, zh_CN, zh_TW, zh_HK, zh_SG, zh_HK_Hans, chk, cpe, co_FR, hr_HR, hr_BA, cs_CZ, crk, crl, crm, crj, cwd, crg, eu_ES, bn_IN, bn_BD, bg_BG, ca_AD, dnj, da_DK, prs_AF, dv_IN, mis, nl_NL, en_US, en_GB, en_142, en_CA, en_AU, en_NZ, en_ZA, en_CH, en_HK, en_IN, en_IE, en_SG, en_AE, en_DE, en_NL, en_AT, en_NT, en_CY, en_KE, en_BS, en_MY, en_PK, en_PH, en_LU, en_NG, en_JP, en_TT, en_AW, en_BH, en_EG, en_ES, en_ID, en_JO, en_KR, en_KW, en_TH, eo, et_EE, ee_GH, eky, kyu, fo_FO, fj_FJ, fil_PH, fi_FI, nl_BE, fr_FR, fr_CA, fr_CH, fr_BE, fr_LU, fr_MA, fr_SN, fr_CM, fy, fu, fat, gl_ES, ka_GE, kar, de_DE, de_AT, de_BE, de_CH, de_LU, de_NL, lb_LU, kl_GL, el_GR, el_CY, grc_GR, gil, grn, gu_IN, ht_HT, cnh, ha_NG, ha_Latn, he_IL, hi_IN, hil, hmn, hmn_US, hu_HU, haw, is_IS, ig, ilo, id_ID, ia, ie, iu, ium, ik, ish, ga_IE, it_IT, it_CH, ja_JP, jv_ID, ks, kk_KZ, kg_CG, kik, kig, rw_RW, ky, rn, sw_KE, km_KH, kn_IN, kok_IN, tlh, ko_KR, kos, ku_TR, kmr, ckb, ku_IQ, lo_LA, la, lv_LV, ln_CG, lt_LT, mfe_MU, mk_MK, mg_MG, ms_MY, ms_SG, ml_IN, mt_MT, mi_NZ, mr_IN, mah, mn_MN, sla_ME, mo_MD, na_NR, nv, nd_ZW, ne_NP, no_NO, nb_NO, niu, nn_NO, nso_ZA, nus, oc_FR, or_IN, om_ET, ota, pag, pam, pau, ps, ps_PK, fa_IR, pon, pl_PL, pt_PT, pt_BR, pt_MZ, pt_AO, pa_PA, pa_IN, pa_PK, qu_PE, qya, xr_MM, rar, rm_CH, ro_RO, ro_MD, ru_RU, ru_AM, ru_AZ, ru_GE, ru_MD, ru_UA, sm_WS, sg, sa_IN, sc_IT, gd_GB, st, tn_ZA, sr_YU, sr_RS_Cyrl, sr_ME_Cyrl, sr_ME_Latn, sr_RS_Latn, sn, sjn, sd_PK, si_LK, ss, sk_SK, sl_SI, snk, so_SO, dsb_DE, hsb_DE, es_ES, es_AR, es_BO, es_CL, es_CO, es_CR, es_CU, es_DO, es_EC, es_SV, es_GT, es_HN, es_419, es_MX, es_NI, es_PA, es_PY, es_PE, es_PR, es_UY, es_US, es_VE, es_001, es_NT, swa, sw_SO, sw_TZ, sw_UG, sv_SE, sv_FI, apd_SD, apd_SD_Latn, sun, syr_TR, tl_PH, tg_TJ, ta_IN, ta_SG, ta_LK, tt_RU, te_IN, tet_ID, tet_TL, th_TH, bo, ti, tir_ER, tir_ET, to_TO, ts_ZA, tn_BW, tpi, tvl, tr_TR, tk_TM, tkl, tw, ty, uk_UA, ur_IN, ur_PK, ug_CN, uz_UZ_Cyrl, uz_UZ_Latn, uz_AF, cy_GB, vi_VN, vo, wo, war, xh_ZA, xz_AF, yao, yap, yi, yi_IL, yi_US, yo_NG, czt, zom, zu_ZA, kun, lua, sco_GB, sco_IE, fr_CG, zh_YUE, lug, ogo, bbc, ksw, cfm, cmn, goyu, aii, cld, pdc, ziw, pap, en_CN, din, fr_TN, fur, en_EU, mas, en_IL, en_QA, pis, lus, hif, zyp, sez, clt, mwq, mrh, sdh, tcz, rtm, bfa, shn, mnw, toq, ach, jam, rom, chr, bsq, cpf, kgp_BR, yrl_BR, bem, ts_ZA_changana, luo, xsm, mni, nag, quc, ton, bdx, doi, mai, sat, daw, krj, fr_001, pt_001, en_SA, mnk, kjb, keo, kjg, wbh, en_MA, en_BE, en_CZ, en_HU, en_SK, en_FI, en_HR, en_RO, en_SI, en_RS, en_UA, en_PT, en_DK, en_FR, en_IT, en_MX, en_NO, en_PL, en_RU, en_SE, en_OM, ms_AR, ru_IL, ber, en_CL, kri, hi_Latn, en_TR, en_TW, en_BN, en_PR, gaa, hz, ny, cgg, nyo, kj, mix, ha_Arab, hi_Latn_en, fr_DZ, ve, smn, sms, zne, bik, shk, mam, hi, bwu, aran_ES, vc_ES, zh_MO, xnr, sw_CG, zh_MY, gur, oj, fr_GN, mos, en_CO, en_PE, tl_EN, ase, asf, prl, apw, apa, bla, ckz, cak, efi, fon, fr_PF, fr_TY, iba, kek, kam, ktu, mkw, cuk, kvn, lkt, yua, meu, cag, kea, pt_CV, qu_EC, sto, tzo, tzj, ypk, de_LI, scl, qu, qu_BO, syl, nd, nr, fu_Latn, fu_Adlm, fu_Arab, zh_SH, arb, aba, abr, acr, ace, ada, ady, aa, agu, ajg, akl, alz, anw, njm, any, aed, aen, hyw, as, ati, awa, ay, azj, bba, bfq, bfy, bca, bjs, ban, bpd, bjn, bci, bas, ba, eu, bej, be, yun, bom, bew, btg, bhb, bib, brx, bvl, bs, pcc, brh, bzs, bfi, bug, bxk, bum, bns, wes, ca, tzm, cbk, ce, hne, csg, gan, hak, cjy, mnp, cdo, nan, czo, cpx, csp, wuu, hsn, csl, ctg, cjk, cce, cac, cv, chw, csn, csr, cyo, dga, dag, gud, dua, dse, dyu, dz, igb, ecs, bin, etu, eke, ebu, enq, en_EE, en_LV, en_LT, myv, ee, fan, psp, fip, sfb, fsl, fub, fuv, fuh, gl, gmv, gbm, grt, gej, de_001, gsg, nyf, toh, gdx, gog, gno, gux, grb, gsm, gu, guw, goa, guz, gwr, hdy, hoj, bgc, ha, hay, haz, heh, hds, ibg, ibb, idu, igl, ijs, ikw, ins, ga, its, iso, ise, ijc, jac, jv, kbp, kab, kac, kbr, ijn, ktb, bjj, knj, kr, kqn, kpg, kdj, kjp, khz, kha, kxm, kmb, sgc, kss, klu, bkm, kok, kno, xpe, ksd, kdi, kue, kdn, kuj, kru, leb, lam, lmn, laj, led, lok, lom, ngl, lon, loz, khb, lu, lgg, lun, lb, mzc, mad, mag, mak, vmw, mgh, xmm, mup, mgr, emk, mev, arn, mr, mrq, rwr, myx, msb, mdp, men, mer, wry, mtr, mfs, min, miq, mfe, unr, mui, sur, nah, nnb, niq, na, ndc, nzs, nij, sba, nga, nia, pcm, noe, tts, nup, nyy, nym, nyn, nzi, ory, plw, pif, poh, psr, quh, rkt, rap, rcf, rhg, ru_EE, ru_LV, ru_LT, rsl, sck, spv, stj, cri, sas, scd, gd, sgw, seh, srr, swv, shh, sid, sd, xog, so, sop, nso, kjd, ssp, srn, suk, sgd, sus, sgg, shi, tbw, tss, rif, tt, tsg, nzu, teo, tll, tdt, nod, sou, tig, tem, tiv, tqo, toi, ttj, ts, tum, tk, aoz, ukw, umb, urh, uzn, uzs, vai, vah, vsl, vls, vun, wbr, gxx, cy, lia, wal, yaf, sah, yog, yom, zap, dje, za, zun, pnb, pa, pan, skr, azb, ug, prs, tg, bal, he, fuc, hno, mey, phr, glk, mzn, lou, cab, fr_MG, fr_BF, fr_ML, sq_XK, en_IS, en_MT, en_BR, crs, fi_NO, fi_SE, st_ZA, ta_MY, uk_PL, ur_AU, vi_AU, vi_US, zh_AU, en_GR, mdh, ar_IL, aln, sq_ME, sq_MK, als, nds, ar_BE, ar_KAB, ceb_PH, dv_MV, nl_CW, en_JM, fr_CI, fr_HT, fr_MQ, fr_NC, fr_RE, ilo_PH, xh, it_MT, kik_KE, ku, ku_Arab, ku_Cyrl, ku_Latn, cnr, ru_BY, ru_KZ, ru_KG, sr_XK_Latn, sr_XK_Cyrl, sr_CS_Latn, nan_TW, bo_CN, tg_Cyrl, tg_Arab, tg_TJ_Cyrl, tr_CY`"},{"name":"Currencies","description":"The following is a list of [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency codes supported by XTM.\n\n`EUR, USD, GBP, MAD, JPY, AUD, CNY, NIS, DKK, NOK, SEK, CAD, MXN, AFN, ALL, DZD, AOA, ARS, AMD, AWG, AZN, BSD, BHD, BDT, BBD, BYR, BZD, BMD, BTN, BOB, BAM, BWP, BRL, BND, BGN, MMK, BIF, KHR, CVE, KYD, XAF, XPF, CLP, COP, KMF, CDF, CRC, HRK, CUC, CUP, CZK, DJF, DOP, XCD, EGP, ERN, ETB, FKP, FJD, GMD, GEL, GHS, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, HUF, ISK, INR, IDR, IRR, IQD, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LBP, LSL, LRD, LYD, LTL, MOP, MKD, MGA, MWK, MYR, MVR, MRO, MUR, MDL, MNT, MZN, NAD, NPR, ANG, TWD, NZD, NIO, NGN, KPW, OMR, PKR, PAB, PGK, PYG, PEN, PHP, PLN, QAR, RON, RUB, RWF, SHP, SVC, WST, STD, SAR, RSD, SCR, SLL, SGD, SBD, SOS, ZAR, KRW, SSP, LKR, SDG, SRD, SZL, CHF, SYP, TJS, TZS, THB, TOP, TTD, TND, TRY, TMT, UGX, UAH, AED, UYU, UZS, VUV, VEF, VND, XOF, YER, ZMK, ZWL`"},{"name":"Date formats","description":"Available date formats.\n\n`DAY_MONTH_LONGYEAR, MONTH_DAY_LONGYEAR, LONGYEAR_MONTH_DAY, SHORTYEAR_MONTH_DAY, DAY_MONTH_SHORTYEAR, MONTH_DAY_YEAR, DAY_MONTH_LONGYEAR_SLASH, MONTH_DAY_LONGYEAR_SLASH, LONGYEAR_MONTH_DAY_SLASH, SHORTYEAR_MONTH_DAY_SLASH, DAY_MONTH_SHORTYEAR_SLASH, MONTH_DAY_YEAR_SLASH, DAY_MEDIUMMONTH_LONGYEAR, MEDIUMMONTH_DAY_LONGYEAR, LONGYEAR_MEDIUMMONTH_DAY, SHORTYEAR_MEDIUMMONTH_DAY, DAY_MEDIUMMONTH_SHORTYEAR, MEDIUMMONTH_DAY_YEAR, DAY_MEDIUMMONTH_LONGYEAR_SLASH, MEDIUMMONTH_DAY_LONGYEAR_SLASH, LONGYEAR_MEDIUMMONTH_DAY_SLASH, SHORTYEAR_MEDIUMMONTH_DAY_SLASH, DAY_MEDIUMMONTH_SHORTYEAR_SLASH, MEDIUMMONTH_DAY_YEAR_SLASH, UTC, LONGYEAR_MONTH_DAY_TIME_UTC, PROJECT_ACTIONS_HISTORY_LOG, EDITOR_SIMPLE_DATE_FORMAT, FORMAT_LONG_DATE_FILE_SYSTEM_WRITABLE`"},{"name":"Time formats","description":"Available time formats.\n\n`SHORTHOUR_MINUTES, LONGHOUR_MINUTES, LONGHOUR_MINUTES_SECONDS, SHORTHOUR_MINUTES_AM_PM, LONGHOUR_MINUTES_AM_PM, LONGHOUR_MINUTES_SECONDS_AM_PM, UTC`"},{"name":"Time zones","description":"Available time zones.\n\n`UTC_1200_INTERNATIONAL_DATE_LINE_WEST, UTC_1100_COORDINATED_UNIVERSAL_TIME_11, UTC_1000_HAWAII, UTC_0900_ALASKA, UTC_0800_BAJA_CALIFORNIA, UTC_0800_PACIFIC_TIME_US_CANADA_, UTC_0700_ARIZONA, UTC_0700_CHIHUAHUA, UTC_0700_MOUNTAIN_TIME_US_CANADA_, UTC_0600_CENTRAL_AMERICA, UTC_0600_CENTRAL_TIME_US_CANADA_, UTC_0600_GUADALAJARA, UTC_0600_SASKATCHEWAN, UTC_0500_HAVANA, UTC_0500_BOGOTA, UTC_0500_EASTERN_TIME_US_CANADA_, UTC_0500_INDIANA_EAST_, UTC_0500_EIRUNEPE, UTC_0500_ATIKOKAN, UTC_0400_CARACAS, UTC_0400_ASUNCION, UTC_0400_ATLANTIC_TIME_CANADA_, UTC_0400_CUIABA, UTC_0400_GEORGETOWN, UTC_0400_SANTIAGO, UTC_0330_NEWFOUNDLAND, UTC_0300_BRASILIA, UTC_0300_BUENOS_AIRES, UTC_0300_COMODRIVADAVIA, UTC_0300_CAYENNE, UTC_0300_GREENLAND, UTC_0300_MONTEVIDEO, UTC_0300_SALVADOR, UTC_0200_COORDINATED_UNIVERSAL_TIME_02, UTC_0200_MID_ATLANTIC, UTC_0100_AZORES, UTC_0100_CAPE_VERDE_IS_, UTC_CASABLANCA, UTC_COORDINATED_UNIVERSAL_TIME, UTC_DUBLIN, UTC_MONROVIA, UTC0100_AMSTERDAM, UTC0100_BELGRADE, UTC0100_BRUSSELS, UTC0100_SARAJEVO, UTC0100_WEST_CENTRAL_AFRICA, UTC0100_WINDHOEK, UTC0200_AMMAN, UTC0200_ATHENS, UTC0200_BEIRUT, UTC0200_CAIRO, UTC0200_DAMASCUS, UTC0200_HARARE, UTC0200_HELSINKI, UTC0200_TIRASPOL, UTC0200_JERUSALEM, UTC0200_NICOSIA, UTC0200_KALININGRAD, UTC0300_BAGHDAD, UTC0300_ISTANBUL, UTC0300_MINSK, UTC0300_KUWAIT, UTC0300_NAIROBI, UTC0300_MOSCOW, UTC0300_VOLGOGRAD, UTC0330_TEHRAN, UTC0400_SAMARA, UTC0400_ABU_DHABI, UTC0400_BAKU, UTC0400_PORT_LOUIS, UTC0400_TBILISI, UTC0400_YEREVAN, UTC0430_KABUL, UTC0500_ISLAMABAD, UTC0500_TASHKENT, UTC_0500_CANCUN, UTC0530_CHENNAI, UTC0530_SRI_JAYAWARDENEPURA, UTC0545_KATHMANDU, UTC0600_ASTANA, UTC0600_URUMQI, UTC0600_DHAKA, UTC0600_THIMBU, UTC0600_EKATERINBURG, UTC0600_OMSK, UTC0600_KASHGAR, UTC0630_YANGON_RANGOON_, UTC0700_BANGKOK, UTC0700_JAKARTA, UTC0700_NOVOSIBIRSK, UTC0700_KRASNOYARSK, UTC0800_BEIJING, UTC0800_KUALA_LUMPUR, UTC0800_PERTH, UTC0800_TAIPEI, UTC0800_ULAANBAATAR, UTC0800_IRKUTSK, UTC0900_CHITA, UTC0900_OSAKA, UTC0830_PYONGYANG, UTC0900_SEOUL, UTC0900_YAKUTSK, UTC0930_ADELAIDE, UTC0930_DARWIN, UTC1000_BRISBANE, UTC1000_CANBERRA, UTC1000_GUAM, UTC1000_SAKHALIN, UTC1000_HOBART, UTC_1000_ADAK, UTC1100_SOLOMON_IS_, UTC1200_AUCKLAND, UTC1200_COORDINATED_UNIVERSAL_TIME_12, UTC1200_FIJI, UTC1200_KAMCHATKA, UTC1300_NUKU_ALOFA, UTC1300_SAMOA, UTC1000_VLADIVOSTOK, UTC1100_MAGAD`"},{"name":"ISO-8601 Date format","description":"**Date Format**\n\nFor all endpoints that require date information, our REST API accepts dates formatted in accordance with ISO-8601. This standard helps to avoid ambiguity and ensure that dates are understood regardless of the user's locale.\n\n**ISO-8601 Overview**\n\nISO-8601 is an international standard for representing date and time values issued by the International Organization for Standardization (ISO). The standard is designed to provide a clear and unambiguous way to represent dates and times.\n\n**Date and Time Formats**\n\n- Full Date: YYYY-MM-DD\n\n - Example: 2023-03-31\n\n- Date and Time in UTC: YYYY-MM-DDThh:mm:ssZ\n\n - Example: 2023-03-31T13:45:30Z\n\n- Date and Time with Time Zone: YYYY-MM-DDThh:mm:ss±hh:mm\n\n - Example: 2023-03-31T09:45:30-04:00\n\n**Extended and Basic Formats**\n\nISO-8601 specifies two formats for representing date and time: extended and basic. Our API supports the extended format, which includes separators (e.g. hyphen - or colon :) for enhanced readability.\n\n- Extended Format: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss±hh:mm\n\n- Basic Format: YYYYMMDDThhmmssZ or YYYYMMDDThhmmss±hhmm (Not supported by our API)\n\n**Additional Time Information**\n\nWhile not all endpoints might require such precision, ISO-8601 allows for additional time information such as fractional seconds:\n\n- Date and Time with Fractional Seconds: YYYY-MM-DDThh:mm:ss.sssZ\n\n - Example: 2023-03-31T13:45:30.123Z\n\nPlease ensure that all date and time information is provided in ISO-8601 format to guarantee compatibility with our system.\n"},{"name":"Cost generation error types","description":"NO_RATE_CARD - No rate card matches the language and subject matter.\n\nNO_RATE_CARD_STEP - Rate card values are missing for some steps.\n\nMANY_RATE_CARDS - User has many rate cards assigned.\n\nNO_CURRENCY_EXCHANGE - No currency exchange has been found to convert the user's billing currency.\n\nBILLING_CURRENCY_UNDEFINED - System billing currency has not been defined.\n\nNO_METRICS_OR_STATISTICS - Can't obtain metrics or statistics for project.\n\nPROJECT_NOT_ANALYSED - Can't analyze the project.\n\nNOTHING_CALCULATED - An unexpected error occurred. Contact XTM Support Team: support@xtm-intl.com\n\nNO_SUBJECT_MATTER_DEFINED_FOR_CLIENT - Can't generate costs: project subject matter is not in the list of subject matters defined in the system. Contact your Administrator.\n\nMULTIPLE_RATE_CARDS_PER_USER - Either user has many rate cards defined or no rate card has been defined for the user.\n\nDIFFERENT_VALUES_FOR_CORRECT_STEP - User's rate card values for matches in Correct workflow step differ.\n\nVALUES_FOR_MATCHES_NOT_ZERO - User's rate card values for ICE, leveraged, repetitions or non-translatable matches are not set to zero.\n\nDIFFERENT_FUZZY_MATCHES_VALUES - User's rate card values for fuzzy matches and fuzzy repeat matches differ.\n\n"},{"name":"Cost generation warning types","description":"NO_RATE_CARD - No rate card is available, but it is not required for calculation.\n\nNO_RATE_CARD_STEP - No rate card is available for this step, but it is not required for calculation.\n\nUSER_GROUP_ASSIGNED_TO_WORKFLOW_STEP - A workflow step has a group of users assigned, so the project costs cannot be calculated.\n\nNO_RATE_CARD_STEP_FOR_TIME - Time tracking is enabled, but the rate card values for time tracking are missing.\n\nNO_TIME_ENTERED - Manual time tracking is enabled, but the user has failed to enter the time they spent working.\n\nUSER_NOT_A_LINGUIST - User is not a Linguist, so no rate card is available.\n\nJOB_UNASSIGNED - Job has not been assigned.\n\nNO_STATISTICS_FOR_LANGUAGES - Can't obtain statistics for many languages in project.\n\nNO_STATISTICS_FOR_LANGUAGE - Can't obtain statistics for a given language in project.\n\n"},{"name":"Revision history","description":"\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n \n \n \n\n\t\n\t\n\t\n\n\t\n\t\n\t\n\n\t\n\t\n\n\t\n\t\n
VersionDateChange
\n 26.1\n \n 03/2026\n \n \n
25.612/2025\n
25.509/2025\n
\n 25.4\n \n 07/2025\n \n
    \n
  • New methods
    • \n \n
  • New request params
    • \n
      \n
    • \n GET /customers/{customerId}/language-combinations\n
        \n
      • New String value: 'en_US' has been added for header parameter: 'Accept-Language'; (in: header, type: string)
        • \n
      \n
      • \n
    • \n GET /languages/language-codes\n
        \n
      • New String value: 'en_US' has been added for header parameter: 'Accept-Language' (in: header, type: string)
        • \n
      \n
      • \n
    • \n GET /projects\n
        \n
      • New request param: creatorIds (in: query, type: array of integers)
        • \n
      • New request param: projectManagerIds (in: query, type: array of integers)
        • \n
      • New sort property: wordCount,(asc|desc) (in: parameter: sort, type: string)
        • \n
      • New sort property: totalWWC,(asc|desc) (in: parameter: sort, type: string)
        • \n
      • New sort property: remainingWWC,(asc|desc) (in: parameter: sort, type: string)
        • \n
      \n
      • \n
    • \n POST /projects/search\n
        \n
      • New request param: creatorIds (in: body, type: array of integers)
        • \n
      • New request param: projectManagerIds (in: body, type: array of integers)
        • \n
      \n
      • \n
    • \n POST /projects/{projectId}/reanalyze\n
        \n
      • New request param: jobIds (in: body, type: array of integers)
        • \n
      • New request param: targetLanguages (in: body, type: array of strings)
        • \n
      • New request param: sourceFileIds (in: body, type: array of integers)
        • \n
      \n
      • \n
    \n
  • New response attributes
    • \n
      \n
    • \n GET /projects\n
        \n
      • New response attribute: []/creatorId (in: body, type: integer)
        • \n
      • New response attribute: []/projectManagerId (in: body, type: integer)
        • \n
      • New response attribute: []/wordCount (in: body, type: integer)
        • \n
      • New response attribute: []/totalWWC (in: body, type: integer)
        • \n
      • New response attribute: []/remainingWWC (in: body, type: integer)
        • \n
      \n
      • \n
    • \n POST /projects/search\n
        \n
      • New response attribute: []/creatorId (in: body, type: integer)
        • \n
      • New response attribute: []/projectManagerId (in: body, type: integer)
        • \n
      • New response attribute: []/wordCount (in: body, type: integer)
        • \n
      • New response attribute: []/totalWWC (in: body, type: integer)
        • \n
      • New response attribute: []/remainingWWC (in: body, type: integer)
        • \n
      \n
      • \n
    • \n POST /projects/{projectId}/reanalyze\n
        \n
      • New response attribute: jobsInReanalysis (in: body, type: array of objects)
        • \n
      \n
      • \n
    • \n GET /projects/{projectId}/workflow
      • \n
        \n
      • New response attribute: steps[]/displayStepName (in: query, type: string)
        • \n
      • New response attribute: steps[]/stepReferenceName (in: query, type: string)
        • \n
      \n \n
    \n
  • Request param value deprecated
    • \n
      \n
    • GET /projects
      • \n
        \n
      • DELETED enum value for param activity has been deprecated and will be deleted in version 25.5
        • \n
      \n
    • POST /projects/search
      • \n
        \n
      • DELETED enum value for param activity has been deprecated and will be deleted in version 25.5
        • \n
      \n
    \n
25.305/2025\n
25.204/2025\n
13.1012/2024\n
    \n\t\t\t
  • New methods
    • \n\t\t\t\n\t\t\t
  • New request params
    • \n\t\t
      \n\t\t\t
    • POST /projects
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: customFields (in: formData, type: array of objects)
        • \n\t\t\t
      \n\t\t\t
    • GET /projects/{projectId}/status
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: displayStepNames (in: query, type: string)
        • \n\t\t\t\t
      • New request param: stepReferenceNames (in: query, type: string)
        • \n\t\t\t
      \n\t\t
    \n\t\t\t
  • New response attributes
    • \n\t\t
13.911/2024\n
13.808/2022\n
    \n\t\t\t
  • New request params
    • \n\t\t
      \n\t\t\t
    • GET /projects/{projectId}/files/sources/download
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: folderStructure (in: query, type: string)
        • \n\t\t\t
      \n\t\t\t
    • POST /projects/{projectId}/workflow/assign
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: workflowState (in: query, type: string)
        • \n\t\t\t
      \n\t\t\t
    • POST /projects/multi-create
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: projectsMultiCreationModelAttributeRequest.callbacks.projectLanguageChangedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: projectsMultiCreationModelAttributeRequest.callbacks.dueDateChangedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: projectsMultiCreationModelAttributeRequest.callbacks.sourceFileUpdatedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: projectsMultiCreationModelAttributeRequest.callbacks.projectActivityChangedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t
      \n\t\t\t
    • POST /projects
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: callbacks.projectLanguageChangedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: callbacks.dueDateChangedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: callbacks.sourceFileUpdatedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: callbacks.projectActivityChangedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t
      \n\t\t\t
    • GET /projects/{projectId}/status
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: displayStepNames (in: query, type: string)
        • \n\t\t\t\t
      • New request param: stepReferenceNames (in: query, type: string)
        • \n\t\t\t
      \n\t\t\t
    • PUT /projects/{projectId}/due-dates
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: steps[]/displayStepName (in: body, type: string)
        • \n\t\t\t\t
      • New request param: steps[]/stepReferenceName (in: body, type: string)
        • \n\t\t\t\t
      • New request param: jobs[]/displayStepName (in: body, type: string)
        • \n\t\t\t\t
      • New request param: jobs[]/stepReferenceName (in: body, type: string)
        • \n\t\t\t
      \n\t\t
    \n\t\t\t
  • New response attributes
    • \n\t\t
      \n\t\t\t
    • POST /projects/search
      • \n\t\t\t
        \n\t\t\t\t
      • New response attribute: modificationDate (in: body, type: string)
        • \n\t\t\t
      \n\t\t\t
    • GET /projects
      • \n\t\t\t
        \n\t\t\t\t
      • New response attribute: modificationDate (in: body, type: string)
        • \n\t\t\t
      \n\t\t\t
    • GET /projects/{projectId}
      • \n\t\t\t
        \n\t\t\t\t
      • New response attribute: modificationDate (in: body, type: string)
        • \n\t\t\t
      \n\t\t\t
    • GET /projects/{projectId}/status
      • \n\t\t\t
        \n\t\t\t\t
      • New response attribute: jobs[]/steps[]/displayStepName (in: body, type: string)
        • \n\t\t\t\t
      • New response attribute: jobs[]/steps[]/stepReferenceName (in: body, type: string)
        • \n\t\t\t
      \n\t\t\t
    • GET /projects/{projectId}/workflows/time-trackings/jobs
      • \n\t\t\t
        \n\t\t\t\t
      • New response attribute: jobs[]/steps[]/displayStepName (in: body, type: string)
        • \n\t\t\t\t
      • New response attribute: jobs[]/steps[]/stepReferenceName (in: body, type: string)
        • \n\t\t\t
      \n\t\t\t
    • GET /projects/{projectId}/statistics
      • \n\t\t\t
        \n\t\t\t\t
      • New response attribute: []/userStatistics[]/stepStatistics[]/stepReferenceName (in: body, type: string)
        • \n\t\t\t
      \n\t\t
    \n\t\t\t
  • New method
    • \n\t\t\t\n\t\t\t
  • Changed request params
    • \n\t\t\n\t\t\t
  • Changed response attributes
    • \n\t\t
      \n\t\t\t
    • GET /projects/{projectId}/workflow/assignment
      • \n\t\t\t
        \n\t\t\t\t
      • Changed response attribute: jobs[]/steps/name (in: body, type: string). Returns the step reference name instead of the step name
        • \n\t\t\t
      \n\t\t\t
    • GET /projects/{projectId}/workflow
      • \n\t\t\t
        \n\t\t\t\t
      • Changed response attribute: steps[]/name (in: body, type: string). Returns the step reference name instead of the step name
        • \n\t\t\t
      \n\t
13.706/2024\n
13.603/2024\n
    \n\t\t\t
  • New request params
    • \n\t\t
      \n\t\t\t
    • POST /projects
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: callbacks/analysisFinishedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: callbacks/jobFinishedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: callbacks/invoiceStatusChangedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: callbacks/projectAcceptedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: callbacks/projectCreatedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: callbacks/projectFinishedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: callbacks/workflowTransitionCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: customerSettings (in: formData, type: object)
        • \n\t\t\t
      \n\t\t\t
    • POST /projects/multi-create
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: projectsMultiCreationModelAttributeRequest/callbacks/analysisFinishedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: projectsMultiCreationModelAttributeRequest/callbacks/jobFinishedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: projectsMultiCreationModelAttributeRequest/callbacks/invoiceStatusChangedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: projectsMultiCreationModelAttributeRequest/callbacks/projectAcceptedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: projectsMultiCreationModelAttributeRequest/callbacks/projectCreatedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: projectsMultiCreationModelAttributeRequest/callbacks/projectFinishedCallbacks (in: formData, type: array of objects)
        • \n\t\t\t\t
      • New request param: projectsMultiCreationModelAttributeRequest/callbacks/workflowTransitionCallbacks (in: formData, type: array of objects)
        • \n\t\t\t
      \n\t\t\t
    • PUT /projects/{projectId}
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: customerSettings (in: body, type: object)
        • \n\t\t\t
      \n\t\t\t
    • PATCH /projects/{projectId}
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: customerSettings (in: body, type: object)
        • \n\t\t\t
      \n\t\t\t
    • GET /projects/{projectId}/status
      • \n\t\t\t
        \n\t\t\t\t
      • New request param: bundleIds (in: query, type: array of integers)
        • \n\t\t\t\t
      • New enum value BUNDLES has been added for param fetchLevel (in: query, type: string)
        • \n\t\t\t
      \n
    \n\t\t\t
  • New response attributes
    • \n\t\t
      \n\t\t\t
    • GET /projects/{projectId}/status
      • \n\t\t\t
        \n\t\t\t\t
      • New response attribute: finishDate (in: body, type: string)
        • \n\t\t\t\t
      • New response attribute: jobs/finishDate (in: body, type: string)
        • \n\t\t\t\t
      • New response attribute: jobs/steps/finishDate (in: body, type: string)
        • \n\t\t\t\t
      • New response attribute: jobs/steps/bundles (in: body, type: array of objects)
        • \n\t\t\t
      \n\t\t
    \n\t
13.501/2024\n \n\t\t\t
  • New request params
    • \n
      \n
    • PATCH /projects/{projectId}
      • \n
        \n\t\t
      • New request param: terminology/tagIds (in: body, type: array of integer)
        • \n
      \n
        \n\t\t
      • New request param: terminology/penaltyProfileId (in: body, type: integer)
        • \n
      \n
        \n\t\t
      • New request param: translationMemory/tagIds (in: body, type: array of integer)
        • \n
      \n
        \n\t\t
      • New request param: translationMemory/penaltyProfileId (in: body, type: integer)
        • \n
      \n
        \n\t\t
      • New request param: translationMemory/languageVariantsPenaltyProfileId (in: body, type: integer)
        • \n
      \n
    \n
      \n
    • PUT /projects/{projectId}
      • \n
        \n\t\t
      • New request param: terminology/tagIds (in: body, type: array of integer)
        • \n
      \n
        \n\t\t
      • New request param: terminology/penaltyProfileId (in: body, type: integer)
        • \n
      \n
        \n\t\t
      • New request param: translationMemory/tagIds (in: body, type: array of integer)
        • \n
      \n
        \n\t\t
      • New request param: translationMemory/penaltyProfileId (in: body, type: integer)
        • \n
      \n
        \n\t\t
      • New request param: translationMemory/languageVariantsPenaltyProfileId (in: body, type: integer)
        • \n
      \n
    \n
      \n
    • POST /projects
      • \n
        \n\t\t
      • New request param: terminology/tagIds (in: body, type: array of integer)
        • \n
      \n
        \n\t\t
      • New request param: terminology/penaltyProfileId (in: body, type: integer)
        • \n
      \n
        \n\t\t
      • New request param: translationMemory/tagIds (in: body, type: array of integer)
        • \n
      \n
        \n\t\t
      • New request param: translationMemory/penaltyProfileId (in: body, type: integer)
        • \n
      \n
        \n\t\t
      • New request param: translationMemory/languageVariantsPenaltyProfileId (in: body, type: integer)
        • \n
      \n
    \n \n
      \n
    \n\t\t\t
  • New methods
    • \n\t\t\t\n\t\t\n\t\t\t
      \n
    \n\t\t\t
  • Improved organisation of documentation
    • \n\t\t\t\n\t\t\n\t
    13.306/2023\n \n\t\t\t
  • New response
    • \n\t\t\t
      \n\t\t\t
    • POST /projects
      • \n\t\t\t\t
      • Resource not found. 404 HTTP code
      \t\t\t
    \n\t\t\n\t
    13.210/2022\n \n\t
    13.104/2022\n
      \n\t\t\t
    • New request params
      • \n\t\t
        \n\t\t\t
      • POST /projects
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: segmentLockingType (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: newSourceDueDate (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: workflowDueDate (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: workflowStartDate (in: formData, type: string)
          • \n\t\t\t
        \n\t\t\t
      • POST /projects/multi-create
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: segmentLockingType (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: workflowDueDate (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: workflowStartDate (in: formData, type: string)
          • \n\t\t\t
        \n\t\t\t
      • PUT /projects/{projectId}/due-dates
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: workflowDueDate (in: body, type: string)
          • \n\t\t\t\t
        • New request param: workflowStartDate (in: body, type: string)
          • \n\t\t\t
        \n\t\t\t
      • PUT /projects/{projectId}
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: segmentLockingType (in: body, type: string)
          • \n\t\t\t
        \n\t\t\t
      • PATCH /projects/{projectId}
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: segmentLockingType (in: body, type: string)
          • \n\t\t\t
        \n\t\t
      \n\t\t\t
    • New response attributes
      • \n\t\t
        \n\t\t\t
      • GET /projects/{projectId}
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: segmentLockingType (in: body, type: string)
          • \n\t\t\t
        \n\t\t\t
      • GET /projects/{projectId}/costs/{costId}
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: userCosts[]/priceWithDistance (in: body, type: number)
          • \n\t\t\t\t
        • New response attributes: userCosts[]/targetLanguageCosts[]/priceWithDistance (in: body, type: number)
          • \n\t\t\t
        \n\t\t
      \n\t
    13.003/2022\n
      \n\t\t\t
    • New request params
      • \n\t\t
        \n\t\t\t
      • POST /projects
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: callbacks.invoiceStatusChangedCallback (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: callbacks.projectAcceptedCallback (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: callbacks.projectCreatedCallback (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: newSourceType (in: formData, type: string)
          • \n\t\t\t
        \n\t\t\t
      • POST /projects/multi-create
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: callbacks.invoiceStatusChangedCallback (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: callbacks.projectAcceptedCallback (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: callbacks.projectCreatedCallback (in: formData, type: string)
          • \n\t\t\t
        \n\t\t\t
      • POST /projects/{projectId}/links/editor
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: generalSettings/taskManageType (in: body, type: string)
          • \n\t\t\t
        \n\t\t
      \n\t\t\t
    • New response attributes
      • \n\t\t
        \n\t\t\t
      • GET /projects/{projectId}
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: invoiceStatus (in: body, type: string)
          • \n\t\t\t\t
        • New response attributes: newSourceType (in: body, type: string)
          • \n\t\t\t
        \n\t\t\t
      • GET /projects/{projectId}/workflow/assignment
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: []/jobs[]/steps[]/bundles[]/acceptanceStatus (in: body, type: string)
          • \n\t\t\t
        \n\t\t
      \n\t\t\t
    • New methods
      • \n\t\t\t\n\t\t\t
    • Request param hidden
      • \n\t\t\t
        \n\t\t\t
      • PUT /projects/{projectId}
        • \n\t\t\t
          \n\t\t\t\t
        • Request param hidden: templateId (in: body, type: integer)
          • \n\t\t\t\t Optional param has been hidden from docs as adding it does not update the project as might be expected.\n\t\t\t\t Param can still be added as it is used by a client to change the XTM template name on the Project list.\n\t\t\t
        \n\t\t
      \n\t
    12.911/2021\n
      \n\t\t\t
    • New request params
      • \n\t\t
        \n\t\t\t
      • GET /projects
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: externalIds (in: query, type: array)
          • \n\t\t\t
        \n\t\t\t
      • POST /projects/search
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: externalIds (in: body, type: integer[])
          • \n\t\t\t
        \n\t\t\t\t
      • GET /projects/{projectId}/statistics
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: fetchType (in: query, type: string)
          • \n\t\t\t
        \t\n\t\t\t\t
      • GET /projects/{projectId}/status
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: jobIds (in: query, type: integer[])
          • \n\t\t\t\t
        • New request param: stepNames (in: query, type: string[])
          • \n\t\t\t\t
        • New request param: targetLanguages (in: query, type: string[])
          • \n\t\t\t
        \n\t\t\t\t
      • PUT /projects/{projectId}/due-dates
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: jobs[]/stepName (in: body, type: string)
          • \n\t\t\t
        \n\t\t
      \n\t\t\t
    • New response attributes
      • \n\t\t
        \n\t\t\t
      • GET /projects
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: []/externalId (in: body, type: integer)
          • \n\t\t\t
        \n\t\t\t
      • POST /projects/search
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: []/externalId (in: body, type: integer)
          • \n\t\t\t
        \n\t\t\t
      • GET /projects/{projectId}/status
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: dueDate (in: body, type: string)
          • \n\t\t\t\t
        • New response attributes: jobs[]/dueDate (in: body, type: string)
          • \n\t\t\t\t
        • New response attributes: jobs[]/steps[]/dueDate (in: body, type: string)
          • \n\t\t\t
        \n\t\t\t
      • GET /projects/templates/{templateId}
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: newSourceLanguage (in: body, type: string)
          • \n\t\t\t\t
        • New response attributes: newSourceType (in: body, type: string)
          • \n\t\t\t\t
        • New response attributes: newSourceWorkflowId (in: body, type: string)
          • \n\t\t\t
        \n\t\t\t
      • GET /projects/{projectId}
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: customerName (in: body, type: string)
          • \n\t\t\t
        \n\t\t\t
      • GET /projects/{projectId}/statistics
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/creationDate (in: body, type: string)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/lastCompletionDate (in: body, type: string)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/machineTranslationEDCWords (in: body, type: Object)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/sourceStatistics/noMatchingCharacters (in: body, type: integer)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/sourceStatistics/noMatchingSegments (in: body, type: integer)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/sourceStatistics/noMatchingWhitespaces (in: body, type: integer)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/sourceStatistics/noMatchingWords (in: body, type: integer)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/sourceStatistics/totalSegments (in: body, type: integer)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/targetStatistics/noMatchingCharacters (in: body, type: integer)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/targetStatistics/noMatchingSegments (in: body, type: integer)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/targetStatistics/noMatchingWhitespaces (in: body, type: integer)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/targetStatistics/noMatchingWords (in: body, type: integer)
          • \n\t\t\t\t
        • New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/targetStatistics/totalSegments (in: body, type: integer)
          • \n\t\t\t
        \n\t\t
      \n\t\t\t
    • New response
      • \n\t\t\t\n\t\t
    \n\t\t\t
  • New callbacks authentication type OAuth2
    • \n\t
    12.806/2021\n \n\t
    12.703/2021\n
      \n\t\t\t
    • New request params
      • \n\t\t
        \n\t\t\t
      • GET /projects
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: activity (in: body, type: array)
          • \n\t\t\t
        \n\t\t\t
      • POST /projects
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: filterTemplateId (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].metadata (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].metadataType (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].targetLanguagesV2[0].code (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].targetLanguagesV2[0].workflowId (in: formData, type: integer)
          • \n\t\t\t
        \n\t\t\t\t
      • POST /projects/multi-create
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: filterTemplateId (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].metadata (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].metadataType (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].targetLanguagesV2[0].code (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].targetLanguagesV2[0].workflowId (in: formData, type: integer)
          • \n\t\t\t
        \t\n\t\t\t\t
      • POST /projects/{projectId}/files/generate
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: extendedTableOptions/excelOptions/includeEditDistanceScore (in: body, type: string)
          • \n\t\t\t\t
        • New request param: extendedTableOptions/htmlOptions/includeEditDistanceScore (in: body, type: string)
          • \n\t\t\t\t
        • New request param: extendedTableOptions/pdfOptions/includeEditDistanceScore (in: body, type: string)
          • \n\t\t\t
        \n\t\t\t\t
      • POST /projects/{projectId}/files/translations/upload
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: translationFiles[0].targetLanguagesV2[0].code (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].targetLanguagesV2[0].workflowId (in: formData, type: integer)
          • \n\t\t\t
        \n\t\t\t\t
      • POST /projects/{projectId}/target-languages
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: jobsCreationType (in: body, type: string)
          • \n\t\t\t
        \n\t\t
      \n\t\t\t
    • New response attributes
      • \n\t\t
        \n\t\t\t
      • GET /projects/templates/{templateId}
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: filterTemplateId (in: body, type: string)
          • \n\t\t\t
        \n\t\t\t
      • GET /projects/{projectId}/costs/{costId}
        • \n\t\t\t
          \n\t\t\t\t
        • New response attributes: userCosts[]/extraCosts/additionalCost (in: body, type: number)
          • \n\t\t\t\t
        • New response attributes: userCosts[]/extraCosts/additionalCostPercent (in: body, type: number)
          • \n\t\t\t\t
        • New response attributes: userCosts[]/extraCosts/fixedPricesSum (in: body, type: number)
          • \n\t\t\t\t
        • New response attributes: userCosts[]/extraCosts/managementFeeSum (in: body, type: number)
          • \n\t\t\t\t
        • New response attributes: userCosts[]/extraCosts/minimalPricePadding (in: body, type: number)
          • \n\t\t\t\t
        • New response attributes: userCosts[]/extraCosts/nonAnalyzableCost (in: body, type: number)
          • \n\t\t\t\t
        • New response attributes: userCosts[]/extraCosts/nonAnalyzableCostsPercent (in: body, type: number)
          • \n\t\t\t
        \n\t\t
      \n\t\t\t
    • New methods
      • \n\t\t\t\n\t\t\t
    • Removed methods
      • \n\t\t\t
        \n\t\t\t
      • GET /projects/analysis-templates
        • \n\t\t\t
      \n\t\t
    \n\t
    12.612/2020\n
      \n\t\t\t
    • New request params
      • \n\t\t
        \n\t\t\t
      • POST /projects
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: groupFilesDitaLevel (in: formData, type: integer)
          • \n\t\t\t\t
        • New request param: groupFilesType (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: overrideFields.overrideFromRequest (in: formData, type: array)
          • \n\t\t\t\t
        • New request param: translationFiles[0].tagIds (in: formData, type: array)
          • \n\t\t\t\t
        • New request param: translationFiles[0].translationType (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].workflowId (in: formData, type: integer)
          • \n\t\t\t
        \n\t\t\t
      • POST /projects/multi-create
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: groupFilesDitaLevel (in: formData, type: integer)
          • \n\t\t\t\t
        • New request param: groupFilesType (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].tagIds (in: formData, type: array)
          • \n\t\t\t\t
        • New request param: translationFiles[0].translationType (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].workflowId (in: formData, type: integer)
          • \n\t\t\t
        \n\t\t\t\t
      • POST /projects/{projectId}/files/generate
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: extendedTableOptions/excelOptions/extendedReportType (in: body, type: string)
          • \n\t\t\t\t
        • New request param: extendedTableOptions/excelOptions/languagesType (in: body, type: string)
          • \n\t\t\t\t
        • New request param: extendedTableOptions/htmlOptions/extendedReportType (in: body, type: string)
          • \n\t\t\t\t
        • New request param: extendedTableOptions/htmlOptions/languagesType (in: body, type: string)
          • \n\t\t\t\t
        • New request param: extendedTableOptions/pdfOptions/extendedReportType (in: body, type: string)
          • \n\t\t\t\t
        • New request param: extendedTableOptions/pdfOptions/languagesType (in: body, type: string)
          • \n\t\t\t
        \t\n\t\t\t\t
      • POST /projects/{projectId}/files/upload
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: files[0].tagIds (in: formData, type: array)
          • \n\t\t\t\t
        • New request param: files[0].translationType (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: files[0].workflowId (in: formData, type: integer)
          • \n\t\t\t
        \n\t\t\t\t
      • POST /projects/{projectId}/links/editor
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: userSettings/overrideFields (in: body, type: string)
          • \n\t\t\t\t
        • New request param: userSettings/terminologyRights (in: body, type: string)
          • \n\t\t\t
        \n\t\t
      \n\t\t\t
    • New methods
      • \n\t\t\t\n\t\t
    \n\t
    12.510/2020\n
      \n\t\t\t
    • New responses
      • \n\t\t\t
        \n\t\t\t
      • GET /lsps/{lspId}/rate-cards
        • \n\t\t\t
          \n\t\t\t\t
        • New response attribute: rateCards[]/minChargePerLanguage (in: body, type: number)
          • \n\t\t\t\t
        • New response attribute: rateCards[]/rates[]/minChargePerLanguage (in: body, type: number)
          • \n\t\t\t
        \n\t\t\t
      • GET /projects/{projectId}/status
        • \n\t\t\t
          \n\t\t\t\t
        • New response attribute: subcontracted (in: body, type: boolean)
          • \n\t\t\t
        \n\t\t\t
      • GET /users/{userId}/rate-cards
        • \n\t\t\t
          \n\t\t\t\t
        • New response attribute: rateCards[]/minChargePerLanguage (in: body, type: number)
          • \n\t\t\t\t
        • New response attribute: rateCards[]/rates[]/minChargePerLanguage (in: body, type: number)
          • \n\t\t\t
        \n\t\t\t
      \n\t\t\t
    • New request params
      • \n\t\t
        \n\t\t\t
      • POST /projects
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: projectManagerType (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].targetLanguages (in: formData, type: array)
          • \n\t\t\t
        \n\t\t\t
      • POST /projects/multi-create
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: translationFiles[0].sourceLanguage (in: formData, type: string)
          • \n\t\t\t\t
        • New request param: translationFiles[0].targetLanguages (in: formData, type: array)
          • \n\t\t\t
        \n\t\t\t\t
      • POST /projects/{projectId}/costs/{costId}/pos
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: sendEmail (in: body, type: string)
          • \n\t\t\t
        \t\n\t\t\t\t
      • POST /projects/{projectId}/files/upload
        • \n\t\t\t
          \n\t\t\t\t
        • New request param: files[0].targetLanguages (in: formData, type: array)
          • \n\t\t\t
        \n\t\t
      \n\t\t\t
    • New methods
      • \n\t\t\t\n\t\t
    \n\t
    12.407/2020\n \n\t
    12.304/2020\n \n
    12.201/2020\n \n\t
    12.110/2019\n\t\t\n\t
    12.007/2019\n\t\t
      \n\t\t\t
    • New request params
      • \n\t\t\t
        \n\t\t\t\t
      • GET /projects
        • \n\t\t\t\t
          \n\t\t\t\t\t
        • New request param: createdDateFrom (in: query, type: string)
          • \n\t\t\t\t\t
        • New request param: createdDateTo (in: query, type: string)
          • \n\t\t\t\t\t
        • New request param: finishedDateFrom (in: query, type: string)
          • \n\t\t\t\t\t
        • New request param: finishedDateTo (in: query, type: string)
          • \n\t\t\t\t
        \n\t\t\t
      \n\t\t\t
    • New responses
      • \n\t\t\t
        \n\t\t\t\t
      • GET /lsps/{lspId}/rate-cards
        • \n\t\t\t\t
          \n\t\t\t\t\t
        • New response attribute: rateCards (in: body, type: array)
          • \n\t\t\t\t\t
            \n\t\t\t\t\t\t
          • New response attribute: []/languageCombinationsType (in: body, type: string))
            • \n\t\t\t\t\t\t
          • New response attribute: []/[]/subjectMattersType (in: body, type: string))
            • \n\t\t\t\t\t
          \n\t\t\t\t
        \n\t\t\t\t
      • GET /users/{userId}/rate-cards
        • \n\t\t\t\t
          \n\t\t\t\t\t
        • New response attribute: rateCards (in: body, type: array)
          • \n\t\t\t\t\t
            \n\t\t\t\t\t\t
          • New response attribute: []/languageCombinationsType (in: body, type: string))
            • \n\t\t\t\t\t\t
          • New response attribute: []/[]/subjectMattersType (in: body, type: string))
            • \n\t\t\t\t\t
          \n\t\t\t\t
        \n\t\t\t\t
      • GET projects/{projectId}
        • \n\t\t\t\t
          \n\t\t\t\t\t
        • New response attribute: finishDate (in: body, type: string)
          • \n\t\t\t\t
        \n\t\t\t
      \n\t\t\t
    • New methods
      • \n\t\t\t\n\t\t
    \n\t
    11.705/2019\n\t\t\n\t
    11.602/2019\n\t\t\n\t
    11.512/2018
    11.206/2018
    • New methods
    • New parameters
      • GET /customers
        • New request parameter: fetchAddress (in: query, type: string)
        • New response attribute: address/address1 (in: body, type: string)
        • New response attribute: address/address2 (in: body, type: string)
        • New response attribute: address/city (in: body, type: string)
        • New response attribute: address/country (in: body, type: string)
        • New response attribute: address/email (in: body, type: string)
        • New response attribute: address/mobilePhone (in: body, type: string)
        • New response attribute: address/phone (in: body, type: string)
        • New response attribute: address/postCode (in: body, type: string)
        • New response attribute: address/state (in: body, type: string)
        • New response attribute: address/vatNumber (in: body, type: string)
        • New response attribute: address/website (in: body, type: string)
      • GET /projects
        • New response attribute: activity (in: body, type: string)
      • PUT /projects/{projectId}/due-dates
        • New request parameter: jobs[]/dueDate (in: body, type: string)
        • New request parameter: jobs[]/id (in: body, type: integer)
        • New request parameter: projectDueDate (in: body, type: string)
        • New request parameter: targetLanguages[]/dueDate (in: body, type: string)
        • New request parameter: targetLanguages[]/languageCode (in: body, type: string)
    11.104/2018
    11.003/2018
    • New method: PUT /projects/{projectId}/due-dates
    • New fields in: GET /projects:
      • page
      • pageSize
    • New response headers in: GET /projects:
      • xtm-page
      • xtm-page-items-count
      • xtm-page-size
      • xtm-total-items-count
    • New fields in: POST /projects:
      • referenceFiles[0].file
      • referenceFiles[0].name
    • New field: targetLanguage in RSJobAnalysisResponse
    • New field: targetLanguage in RSJobStatusResponse
    • New field: sourceLanguage in RSProjectAnalysisResponse
    • New field: sourceLanguage in RSProjectStatusResponse
    • New responses:
      • RSProjectDueDateUpdateRequest
      • RSProjectDueDateUpdateResponse
      • RSProjectStepDueDateRequest
    10.701/2018
    "},{"name":"OAuth 2.0","description":"\n## Password flow (Resource Owner Password Credentials) ## \n\nThis is the one of the simplest OAuth 2.0 authorization flows, suitable for integrations used by single user accounts. User credentials are stored in the client application instead of redirecting users to the XTM website.\nIn this approach you need to take three steps:\n\n\n1. Register\n\n To register a client application in XTM, contact the Support Team (support@xtm-intl.com).\nYou will get your Client ID and Client Secret required to communicate with XTM REST API using the OAuth 2.0 standard.\n\n\n2. Get your access token\n\nIn the Password grant type, the client application makes a POST request to the server to exchange their username and password for an access token.\n\nThe POST request looks like this:\n\n\tPOST authentication-api/oauth/token HTTP/1.1\n\tAuthorization: Basic Base64(CLIENT_ID:CLIENT_SECRET)\n\tContent-Type: application/x-www-form-urlencoded\n\n\tForm parameters:\n\tgrant_type=password\n\tusername=CLIENTNAME:USERNAME\n\tpassword=PASSWORD\n\nHeaders:\n\n\nOther form parameters:\n\n\nA response contains two kinds of tokens:\n\n\n3. Apply the access token\n\nAccess tokens should be added to each call made to the XTM REST API using the following method:\n\n
  • as an Authorization header:
    • \n\n\tPOST /project-manager-api-rest/system\n\tAuthorization: Bearer ACCESS_TOKEN\n\n\n## Refresh Token flow ## \n\nAllows to obtain a new access token based on a valid refresh token. The POST request looks like this:\n\n\tPOST authentication-api/oauth/token HTTP/1.1\n\tAuthorization: Basic Base64(CLIENT_ID:CLIENT_SECRET)\n\tContent-Type: application/x-www-form-urlencoded\n\n\tForm parameters:\n\tgrant_type=refresh_token\n\trefresh_token=REFRESH_TOKEN\n"},{"name":"SAML","description":"A popular authentication standard using a third-party identity provider.\nYou can use a third-party system to authenticate and then get an OAuth 2.0 token, which you can use in our oauth flow available here: [link to OAuth 2.0 section](#tag/OAuth-2.0).\n\n1. Register\n\n To register a client application in XTM, contact the Support Team (support@xtm-intl.com).\nYou will get a list of required data to setup the connection with your Identity Provider.\n\n\n2. Get your access token\n\nYou need to send a POST request to initiate the authentication process.\n\nThe POST request looks like this:\n\n\tPOST authentication-api/saml HTTP/1.1\n\tclient=CLIENT_NAME\n\nHeaders:\n\n\n\n\nA response should contain Location header and 301 HTTP Status code. To move on with the process, you need to follow the redirection URL.\nAfter following the URL, you will need to authenticate in the Identity Provider. After doing it correctly, Identity Provider will redirect you back to XTM.\nThen, XTM will check your authentication status and return accessToken and expireIn fields in a JSON format.\n\nPossible exceptions:\n\n\t{\"message\":\"Client does not have external login service configured.\"} - When the IDP connection is not configured for the client.\n\t{\"message\":\"Could not match SAML user with XTM user.\"} - When the authentication in IDP was successfull, but XTM was not able to match the user with any of users existing in XTM.\n\t{\"message\":\"SAML User not authenticated for client %s, samlLoginResponseTO: %s\"} - When the IDP authentication failed, contains your client name and data from IDP.\n\t{\"message\":\"Client not provided.\"} - When client field has not been provided.\n\n"},{"name":"Callbacks","description":"Callbacks are sent to a previously defined URL. URLs can be passed in a Create Project request or defined as permanent URLs in our XML configuration (to do the latter, feel free to contact our support team support@xtm-intl.com). XTM tries to send a callback three times: with a 5000 ms timeout for responses and a 60000 ms timeout between consecutive failed attempts. However, the XTM Support Team can create custom callbacks and specify the timeout, the number of attempts or the intervals between consecutive attempts. If a protocol is missing, \"https\" will be added.\n\n **analysisFinishedCallback** - specifies a link to a call when project analysis is finished. The callback is sent as a POST request with an application/x-www-urlencoded content type and an 'additionalData' field in the request payload containing a JSON body ([open example](https://xtm.cloud/api-examples/analysis-finished-callback.txt)). XTM adds three request parameters to the URL, namely: xtmCustomerId, xtmProjectId and xtmUuid, for instance URL https://some.site/analysis/534-d345f-034r34r?xtmCustomerId=123&xtmProjectId=321&xtmUuid=1a2b584e-8b81-4319-a90f-196f54ea1717\n\n **workflowTransitionCallback** - specifies a link to a call in the event of any transition in active workflow steps. The callback is sent as a POST request with an application/x-www-urlencoded content type and an 'additionalData' field in the request payload containing a JSON body ([open example](https://xtm.cloud/api-examples/workflow-transition-callback.txt)). In this callback the sequence of sending is irrelevant, so it can be sent either before or after jobFinishedCallback or projectFinishedCallback. XTM adds three request parameters to the URL, namely: xtmCustomerId, xtmProjectId and xtmUuid, for instance URL https://some.site/workflow/534-d345f-034r34r?xtmCustomerId=123&xtmProjectId=321&xtmUuid=1a2b584e-8b81-4319-a90f-196f54ea1717\n\n **jobFinishedCallback** - specifies a link to a call when processing of one file in a single language combination is finished for the entire project. The callback is sent as a GET request. XTM adds four request parameters to the URL, namely: xtmCustomerId, xtmJobId, xtmProjectId and xtmUuid, for instance URL https://some.site/jobs/534-d345f-034r34r?xtmCustomerId=123&xtmJobId=222&xtmProjectId=321&xtmUuid=1a2b584e-8b81-4319-a90f-196f54ea1717\n\n **projectCreatedCallback** - specifies a link to a call when the project is created. The callback is sent as a POST request with an application/json content type and empty JSON as a payload. XTM adds two request parameters to the URL, namely: xtmProjectId and xtmUuid, for instance URL https://some.site/project/534-d345f-034r34r?xtmProjectId=321&xtmUuid=1a2b584e-8b81-4319-a90f-196f54ea1717\n\n **projectAcceptedCallback** - specifies a link to a call when the entire project is accepted. The callback is sent as a POST request with an application/json content type and empty JSON as a payload. XTM adds three request parameters to the URL, namely: xtmProjectId, xtmExternalProjectId and xtmUuid, for instance URL https://some.site/project/534-d345f-034r34r?xtmProjectExternalId=123&xtmProjectId=321&xtmUuid=1a2b584e-8b81-4319-a90f-196f54ea1717\n\n **projectFinishedCallback** - specifies a link to a call when the entire project is finished. The callback is sent as a GET request. XTM adds three request parameters to the URL, namely: xtmCustomerId, xtmProjectId and xtmUuid, for instance URL https://some.site/project/534-d345f-034r34r?xtmCustomerId=123&xtmProjectId=321&xtmUuid=1a2b584e-8b81-4319-a90f-196f54ea1717\n\n **invoiceStatusChangedCallback** - specifies a link to a call when the invoice changed has changed for any project. The callback is sent as a POST request with an application/json content type and empty JSON as a payload. XTM adds three request parameters to the URL, namely: xtmProjectId, xtmInvoiceStatus and xtmUuid, for instance URL https://some.site/project/534-d345f-034r34r?xtmProjectId=123&xtmInvoiceStatus=NOT_APPROVED&xtmUuid=1a2b584e-8b81-4319-a90f-196f54ea1717\n\n **sourceFileUpdatedCallback** - specifies a link to a call in the event of any change in the source files. The callback is sent as a POST request with an application/json content type and the payload containing a JSON body ([open example](https://xtm.cloud/api-examples/source-file-updated-callback.txt)). XTM adds two request parameters to the URL, namely: xtmProjectId and xtmUuid, for instance URL https://some.site/source-file/534-d345f-034r34r?xtmProjectId=321&xtmUuid=1a2b584e-8b81-4319-a90f-196f54ea1717\n\n **projectActivityChangedCallback** - specifies a link to a call when the activity of any project is changed. The callback is sent as a POST request with an application/json content type and the payload containing a JSON body ([open example](https://xtm.cloud/api-examples/project-activity-changed-callback.txt)). XTM adds two request parameters to the URL, namely: xtmProjectId and xtmUuid, for instance URL https://some.site/project/534-d345f-034r34r?xtmProjectId=321&xtmUuid=1a2b584e-8b81-4319-a90f-196f54ea1717\n\n **projectLanguageChangedCallback** - specifies a link to a call when a language of any project is whether deleted or added. The callback is sent as a POST request with an application/json content type and the payload containing a JSON body ([open example](https://xtm.cloud/api-examples/project-language-changed-callback.txt)). XTM adds two request parameters to the URL, namely: xtmProjectId and xtmUuid, for instance URL https://some.site/project/534-d345f-034r34r?xtmProjectId=321&xtmUuid=1a2b584e-8b81-4319-a90f-196f54ea1717\n\n **dueDateChangedCallback** - specifies a link to a call when due dates for jobs, workflow steps, target languages or the entire project are updated. The callback is sent as a POST request, content type application/json, with a payload that contains a JSON body ([open example](https://xtm.cloud/api-examples/due-date-changed-callback.txt)). If the project dates are modified, their values are reflected in these fields: newSourceDueDate, workflowStartDueDate, workflowDueDate and projectDueDate. The types of changes are reported in the changedProjectDueDates field. If project dates are removed, information about the changes are only shown in the 'changedProjectDueDates' field. XTM Cloud adds two request parameters to the URL: xtmProjectId and xtmUuid, Example URL https://some.site/project/534-d345f-034r34r?xtmProjectId=321&xtmUuid=1a2b584e-8b81-4319-a90f-196f54ea1717\n## Security ## \n\nCallbacks support authentication. XTM provides three types of authentication, see [API resources](#tag/Callback-authentications) for details."},{"name":"Translation memory.","description":"This section contains methods that relate to translation memory."}],"paths":{"/callbacks/authentications":{"get":{"tags":["Callback authentications"],"summary":"Obtain callback authentications","description":"This method returns callback authentications that match the specified search parameters.","operationId":"getCallbacksAuthentications","parameters":[{"name":"ids","in":"query","description":"Callback authentications IDs.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"names","in":"query","description":"Callback authentication names.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"domains","in":"query","description":"URL addresses of callback authentication domains.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"authenticationTypes","in":"query","description":"Authentication mechanisms that are used by callbacks.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["BASIC","SIGNATURE","OAUTH_2"]}}},{"name":"authenticationScopes","in":"query","description":"Scopes of authentication for callbacks. `CLIENT` indicates that an authentication has been set for the entire account and `DOMAIN` indicates that an authentication has only been set for a selected domain.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["CLIENT","DOMAIN"]}}},{"name":"page","in":"query","description":"Page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of elements listed on page.","required":false,"schema":{"type":"integer","format":"int32","default":100}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-page-size":{"description":"Returns the number of jobs that can be listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}},"xtm-total-items-count":{"description":"Returns the number of jobs matching the criteria.","style":"simple","schema":{"type":"integer "}},"xtm-page":{"description":"Returns the currently displayed page number.","style":"simple","schema":{"type":"integer "}},"xtm-page-items-count":{"description":"Returns the number of jobs listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSGetCallbackAuthenticationResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["administrator"]}]},"post":{"tags":["Callback authentications"],"summary":"Add a new callback authentication","description":"This method adds a new callback authentication.","operationId":"addCallbackAuthentications","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSAddCallbackAuthenticationRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSAddCallbackAuthenticationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["administrator"]}]}},"/callbacks/properties":{"get":{"tags":["Callback properties"],"summary":"Get callback properties","description":"This method returns callback properties that match the specified search parameters.","operationId":"getCallbackProperties","parameters":[{"name":"ids","in":"query","description":"Callback property IDs.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"callbackTypes","in":"query","description":"Callback type.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]}}},{"name":"customerIds","in":"query","description":"Customer IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"propertyScopes","in":"query","description":"Callback properties scope. `CLIENT` indicates that a property is applied for every project that is created. `CUSTOMER` indicates that a property is only applied for a project created for the specified customer.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["CUSTOMER","CLIENT"]}}},{"name":"urlsFilter","in":"query","description":"Callback URL addresses to filter by. Matching behavior is defined by urlsFilterType: exact match `EQUALS` or partial match `CONTAINS`.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"urlsFilterType","in":"query","description":"Defines how urlsFilter values are matched: `EQUALS` for exact match, `CONTAINS` for partial match.","required":false,"schema":{"type":"string","default":"EQUALS","enum":["EQUALS","CONTAINS"]}},{"name":"page","in":"query","description":"Page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of elements listed on page.","required":false,"schema":{"type":"integer","format":"int32","default":100}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-page-size":{"description":"Returns the number of jobs that can be listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}},"xtm-total-items-count":{"description":"Returns the number of jobs matching the criteria.","style":"simple","schema":{"type":"integer "}},"xtm-page":{"description":"Returns the currently displayed page number.","style":"simple","schema":{"type":"integer "}},"xtm-page-items-count":{"description":"Returns the number of jobs listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSGetCallbackPropertiesResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"501":{"description":"Method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"post":{"tags":["Callback properties"],"summary":"Add callback properties","description":"This method adds new callback properties.","operationId":"addCallbackProperties","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSAddCallbackPropertiesRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSAddCallbackPropertiesResponseWrapper"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"501":{"description":"Method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"delete":{"tags":["Callback properties"],"summary":"Delete callback properties","description":"This method deletes callback properties based on filters.","operationId":"deleteCallbackProperties","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteCallbackPropertiesRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteCallbackPropertiesResponseWrapper"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"501":{"description":"Method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/concordance":{"get":{"tags":["Concordance"],"summary":"Obtain concordance that match specific criteria","description":"This method returns concordance that match the specified search parameters.","operationId":"findConcordance","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"customerIds","in":"query","description":"Customer IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"exactMatch","in":"query","description":"EXACT - only returns results that consist exactly of the words in the search phrase. The order of words, punctuation and spaces have to be the same.\n\nYES - performs a phrase search. Returns results that include the same words in the same order.\n\nNO - performs a broad search. Returns results that include any of the words in the search phrase.","required":false,"schema":{"type":"string","default":"NO","enum":["YES","NO","EXACT"]}},{"name":"languageVariants","in":"query","description":"Enables/disables searching in all language variants instead of exact language.","required":false,"schema":{"type":"string","default":"NO","enum":["YES","NO"]}},{"name":"reverseMemory","in":"query","description":"Enables/disables searching in reverse memory.","required":false,"schema":{"type":"string","default":"NO","enum":["YES","NO"]}},{"name":"targetLanguage","in":"query","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes.","required":true,"schema":{"type":"string","example":"en_GB"}},{"name":"sourceLanguage","in":"query","description":"Source language code. See [API resources](#tag/Language-codes) for full list of available codes.","required":true,"schema":{"type":"string","example":"en_GB"}},{"name":"searchIn","in":"query","description":"Resource to search in.","required":true,"schema":{"type":"string","enum":["SOURCE","TARGET"]}},{"name":"phrase","in":"query","description":"Search phrase.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSFindConcordanceSegmentResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["linguist"]}]}},"/custom-fields/customer":{"get":{"tags":["Custom field"],"summary":"Obtain custom fields definitions for customer","description":"This method returns custom fields definitions that are related to a customer.","operationId":"findCustomFieldDefinitionsForCustomer","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSFindCustomFieldResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/customers":{"get":{"tags":["Customer"],"summary":"Obtain customers that match specific criteria","description":"This method returns customers that match the specified search parameters.","operationId":"getCustomers","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"activity","in":"query","description":"Customer activity.","required":false,"schema":{"type":"string","default":"ONLY_ACTIVE","description":"Finding customer by status options.","enum":["ONLY_ACTIVE","ALL"]}},{"name":"fetchAddress","in":"query","description":"Decision if Address data should be fetched.","required":false,"schema":{"type":"string","default":"NO","enum":["YES","NO"]}},{"name":"ids","in":"query","description":"Customer IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"names","in":"query","description":"Customer names.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSFindCustomerResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}],"x-code-samples":[{"lang":"JavaScript","source":"let customers;\nfunction getCustomers(token){\n const url = baseURL + '/customers';\n const params = {\n headers: {\"Authorization\": token},\n method: 'GET',\n };\n fetch(url, params)\n .then(response => response.json())\n .then(json => getCustomersInfo(json));\n}\nfunction getCustomersInfo(json) {\n customers = json;\n}\n"},{"lang":"C#","source":"public void GetCustomers(string token)\n{\n string URL = baseURL + \"/customers?fetchAddress=YES\";\n try\n {\n HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL);\n request.Method = \"GET\";\n request.Headers.Add(\"Authorization\", \"XTM-Basic \" + token);\n\n HttpWebResponse response = request.GetResponse() as HttpWebResponse;\n StreamReader reader = new StreamReader(response.GetResponseStream());\n List customers = JsonConvert.DeserializeObject>(reader.ReadToEnd());\n reader.Close();\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n }\n}\npublic class Customer\n{\n public string activity { get; set; }\n public int id { get; set; }\n public string name { get; set; }\n public Address address { get; set; }\n}\npublic class Address\n{\n public string address1 { get; set; }\n public string address2 { get; set; }\n public string city { get; set; }\n public string country { get; set; }\n public string email { get; set; }\n public string mobilePhone { get; set; }\n public string phone { get; set; }\n public string postCode { get; set; }\n public string state { get; set; }\n public string vatNumber { get; set; }\n public string website { get; set; }\n}"}]},"post":{"tags":["Customer"],"summary":"Create customer","operationId":"createCustomer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCreateCustomerTO"}}},"required":true},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCreateCustomerResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/customers/{customerId}/files/reference-materials/download":{"get":{"tags":["Customer files"],"summary":"Download Reference Materials","description":"This method downloads reference materials assigned to the customer.","operationId":"downloadReferenceMaterials_1","parameters":[{"name":"customerId","in":"path","description":"Customer ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-file-descrption":{"description":"Returns fileName in a JSON format.","style":"simple","schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Customer or files not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/externals/users":{"get":{"tags":["External user"],"summary":"Obtain external users","description":"This method returns external users.","operationId":"findExternalUsers","parameters":[{"name":"ids","in":"query","description":"List of IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"firstNames","in":"query","description":"List of first names.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"lastNames","in":"query","description":"List of last names.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"usernames","in":"query","description":"List of usernames.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"emails","in":"query","description":"List of emails.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"integrationIds","in":"query","description":"List of integration IDs.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSExternalUserFindResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"post":{"tags":["External user"],"summary":"Create external user","operationId":"createExternalUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSExternalUserCreateRequest"}}},"required":true},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSExternalUserCreateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/lsps/{lspId}/rate-cards":{"get":{"tags":["LSP rate cards"],"summary":"Obtain rate cards that match specific criteria","description":"This method returns rate cards that match the specified search parameters.","operationId":"getLspRateCards","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"fetchLevel","in":"query","description":"Fetch level of rate cards.","required":false,"schema":{"type":"string","enum":["MINIMAL","BASIC","EXTENDED"]}},{"name":"page","in":"query","description":"Page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of rate cards listed on page.","required":false,"schema":{"type":"integer","format":"int32","default":100}},{"name":"lspId","in":"path","description":"LSP ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-page-size":{"description":"Returns the number of jobs that can be listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}},"xtm-total-items-count":{"description":"Returns the number of jobs matching the criteria.","style":"simple","schema":{"type":"integer "}},"xtm-page":{"description":"Returns the currently displayed page number.","style":"simple","schema":{"type":"integer "}},"xtm-page-items-count":{"description":"Returns the number of jobs listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSFindRateCardsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/languages/language-codes":{"get":{"tags":["Languages"],"summary":"Get all language codes","description":"Returns all available language codes with their localized names.","operationId":"getLanguageCodes","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"Accept-Language","in":"header","description":"Fetch the localized version of the corresponding language name. Only supported for the following language codes: en_GB, en_US, de_DE, es_ES, fr_CA, ja_JP, pl_PL, ru_RU, tr_TR, zh_CN, pt_PT. If an unsupported language code is passed in the parameter or no language code is specified in the parameter, the default is en_GB.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSLanguageCodesToDescriptorsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects":{"get":{"tags":["Project"],"summary":"Simple obtain projects that match specific criteria","description":"This method returns projects that match the specified search parameters.","operationId":"getProjects","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"activity","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ACTIVE","ARCHIVED","AUTO_ARCHIVED","INACTIVE","ACTIVATING","ARCHIVING","AUTO_ARCHIVING"]},"uniqueItems":true}},{"name":"createdDateFrom","in":"query","description":"Minimum project creation date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","required":false,"schema":{"type":"string"}},{"name":"createdDateTo","in":"query","description":"Maximum project creation date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","required":false,"schema":{"type":"string"}},{"name":"creatorIds","in":"query","description":"IDs of Project Creators.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"customerIds","in":"query","description":"IDs of customers.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"externalIds","in":"query","description":"External IDs of projects.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"finishedDateFrom","in":"query","description":"Minimum project finish date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","required":false,"schema":{"type":"string"}},{"name":"finishedDateTo","in":"query","description":"Maximum project finish date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","required":false,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"IDs of projects.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"modifiedDateFrom","in":"query","description":"Minimum project last modified date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","required":false,"schema":{"type":"string"}},{"name":"modifiedDateTo","in":"query","description":"Maximum project last modified date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Project name.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of elements listed on page.","required":false,"schema":{"type":"integer","format":"int32","default":1000}},{"name":"projectManagerIds","in":"query","description":"IDs of Project Managers.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). You can use this property :id, name, createdDate, finishedDate, status, activity, totalWWC, remainingWWC, wordCount, lastUsageDate. ","schema":{"type":"string"},"example":"name,desc"},{"name":"status","in":"query","description":"Project status.","required":false,"schema":{"type":"string","enum":["NOT_STARTED","STARTED","FINISHED"]}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-page-size":{"description":"Returns the number of projects that can be listed on the currently displayed page.","style":"simple","schema":{"type":"integer "}},"xtm-total-items-count":{"description":"Returns the number of projects matching the criteria.","style":"simple","schema":{"type":"integer "}},"xtm-page":{"description":"Returns the currently displayed page number.","style":"simple","schema":{"type":"integer "}},"xtm-page-items-count":{"description":"Returns the number of projects listed on the currently displayed page.","style":"simple","schema":{"type":"integer "}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}],"x-code-samples":[{"lang":"JavaScript","source":"const baseURL = \"https://SERVER_URL/rest-api\";\nlet projectData;\n\nfunction getProjects(token){\n const url = baseURL + '/projects?status=NOT_STARTED';\n const params = {\n headers: {\"Authorization\": token},\n method: 'GET',\n };\n \n fetch(url, params)\n .then(response => response.json())\n .then(json => getProjectsData(json));\n}\n\nfunction getProjectsData(json) {\n projectsData = json;\n}"},{"lang":"C#","source":"static string baseURL = \"https://SERVER_URL/rest-api\";\npublic void GetProjects (string token)\n{\n string URL = baseURL + \"/projects?status=NOT_STARTED\"; \n try\n {\n HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL);\n request.Method = \"GET\"; \n request.Headers.Add(\"Authorization\", \"XTM-Basic \" + token);\n\n HttpWebResponse response = request.GetResponse() as HttpWebResponse;\n StreamReader reader = new StreamReader(response.GetResponseStream());\n List projects = JsonConvert.DeserializeObject>(reader.ReadToEnd());\n reader.Close();\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n }\n}\n\npublic class Project\n{\n public string activity { get; set; }\n public int id { get; set; }\n public string name { get; set; }\n public string status { get; set; }\n}"}]},"post":{"tags":["Project"],"summary":"Create project","description":"This method creates a new project.\n\nAll requests must include customerId and name. In addition to these two parameters, a valid project creation request must either include sourceLanguage, targetLanguages and workflowId or templateId of an existing template that specifies a workflow definition and the source and target languages.\n\nContent in the request body must be multipart/form-data.","operationId":"createProject","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RSProjectCreationModelAttributeRequest"}}}},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectCreationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}],"x-code-samples":[{"lang":"JavaScript","source":"function createProject(token){ \n const url = baseURL + '/projects';\n \n const formData = new FormData();\n formData.append('customerId', '0');\n formData.append('name', 'Name of the project');\n formData.append('sourceLanguage', 'en_GB');\n formData.append('targetLanguages', 'de_DE');\n formData.append('workflowName', 'TRANSLATE');\n \n const params = {\n headers: {\"Authorization\": token},\n method: 'POST',\n body: formData\n };\n fetch(url, params);\n}"},{"lang":"C#","source":"public void CreateProject (string token)\n{\n string URL = baseURL + \"/projects\";\n string formDataBoundary = String.Format(\"----WebKitFormBoundary{0:N}\", Guid.NewGuid());\n ProjectParams projectParams = new ProjectParams\n {\n customerId = 0,\n name = \"ProjectName\",\n templateId = 0\n };\n\n var dict = ToDictionary(projectParams);\n var parameters = Encoding.ASCII.GetBytes(GetFormDataString(dict, formDataBoundary));\n\n try\n {\n HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL);\n request.Method = \"POST\"; \n request.Headers.Add(\"Authorization\", \"XTM-Basic \" + token);\n \n request.ContentType = \"multipart/form-data; boundary=\" + formDataBoundary;\n \n request.ContentLength = parameters.Length;\n Stream newStream = request.GetRequestStream();\n newStream.Write(parameters, 0, parameters.Length);\n newStream.Close();\n HttpWebResponse response = request.GetResponse() as HttpWebResponse;\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n }\n}\npublic class ProjectParams\n{\n public int customerId { get; set; }\n public string name { get; set; }\n public int templateId { get; set; }\n} \npublic static Dictionary ToDictionary(object obj)\n{\n var json = JsonConvert.SerializeObject(obj);\n var dictionary = JsonConvert.DeserializeObject>(json);\n return dictionary;\n}\npublic string GetFormDataString(Dictionary parameters, string boundary)\n{\n string formDataStream = \"\";\n bool needsRN = false;\n foreach (var param in parameters)\n {\n if (needsRN)\n formDataStream += \"\\r\\n\";\n\n needsRN = true;\n\n string header = string.Format(\"--{0}\\r\\nContent-Disposition: form-data; name=\\\"{1}\\\"\\r\\n\\r\\n{2}\",\n boundary, param.Key, param.Value);\n\n formDataStream += header;\n }\n string footer = \"\\r\\n--\" + boundary + \"--\";\n formDataStream += footer;\n\n return formDataStream;\n}"}]}},"/projects/lqa":{"get":{"tags":["Project LQA"],"summary":"Obtain project LQA","description":"Obtain available project LQA json report.","operationId":"getLqa","parameters":[{"name":"projectIds","in":"query","description":"Projects ids","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"targetLanguages","in":"query","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","example":"en_GB","items":{"type":"string"}}},{"name":"evalueeIds","in":"query","description":"Evaluee ids","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"workflowStepIds","in":"query","description":"Workflow step ids","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"evaluatorIds","in":"query","description":"Evaluator ids","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"type","in":"query","description":"Type of LQA","required":false,"schema":{"type":"string","enum":["LANGUAGE","FILE"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSLqaGetResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/activate":{"post":{"tags":["Project activity"],"summary":"Project activate","description":"Project activate\n\nCan activate projects only in state:
      \n\t\t\t
    • ARCHIVED
      • \n\t\t\t
    • AUTO_ARCHIVED
      • \n\t\t\t
    \n","operationId":"activateProject","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSActivateProjectResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/statistics":{"get":{"tags":["Project analytics"],"summary":"Download statistics","description":"Download statistics for given process ID.","operationId":"downloadStatistics","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"processId","in":"query","description":"Process ID received from the generate statistic method.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSAggregatedStatisticsResponse"}}}},"202":{"description":"The request has been accepted for processing, but the processing has not been completed."},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"post":{"tags":["Project analytics"],"summary":"Generates statistics for projects or users","description":"Generates statistics for given input parameters. Parameters projectIds or linguistIds must be filled in request.","operationId":"generateStatistics","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End creation date of statistics in ISO-8601 date format.See [API resources](#tag/ISO-8601-Date-format) for details.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"linguistIds","in":"query","description":"List of Linguist IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"projectIds","in":"query","description":"IDs of projects.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"reportType","in":"query","description":"Type of aggregation. Look of response is available in GET /projects/statistics","required":false,"schema":{"type":"string","default":"PROJECT","enum":["PROJECT","USER"]}},{"name":"startDate","in":"query","description":"Start creation date of statistics in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"202":{"description":"The request has been accepted for processing, but the processing has not been completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSGenerateStatisticsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/jobs/bundles":{"get":{"tags":["Project bundles"],"summary":"Obtain project bundles that match specific criteria","description":"This method returns all tasks in chosen activity assigned to the Linguist.","operationId":"obtainBundles","parameters":[{"name":"tasksActivity","in":"query","description":"Task activity","required":false,"schema":{"type":"string","default":"ACTIVE","enum":["ACTIVE","PLANNED","CLOSED"]}},{"name":"userLicense","in":"query","description":"User license","required":false,"schema":{"type":"string","default":"INTERNAL","enum":["INTERNAL"]}},{"name":"page","in":"query","description":"Page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of elements listed on page.","required":false,"schema":{"type":"integer","format":"int32","default":100}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). You can use this property: name, dueDate, step ","schema":{"type":"string"},"example":"projectName,desc"},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectBundlesResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["linguist"]}]}},"/projects/{projectId}/callbacks":{"get":{"tags":["Project callbacks"],"summary":"Obtain project callbacks","description":"This method returns all project callbacks.","operationId":"obtainProjectCallbacks","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectCallbacksResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"post":{"tags":["Project callbacks"],"summary":"Add callbacks","description":"This method adds new callbacks to a project.","operationId":"addProjectCallbacks","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectAddCallbacksRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectAddCallbacksResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"delete":{"tags":["Project callbacks"],"summary":"Delete project callbacks","description":"This method can be used to delete multiple callbacks from a project.","operationId":"deleteProjectCallbacks","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteProjectCallbacksRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSDeleteProjectCallbackResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/costs":{"get":{"tags":["Project costs"],"summary":"Obtain project's costs","description":"Obtain project's costs","operationId":"obtainProjectCosts","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of elements listed on page.","required":false,"schema":{"type":"integer","format":"int32","default":100}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property, (asc|desc). You can use this property: id, createdDate, modifiedDate ","schema":{"type":"string"},"example":"createdDate,desc"},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-page-size":{"description":"Returns the number of projects that can be listed on the currently displayed page.","style":"simple","schema":{"type":"integer "}},"xtm-total-items-count":{"description":"Returns the number of projects matching the criteria.","style":"simple","schema":{"type":"integer "}},"xtm-page":{"description":"Returns the currently displayed page number.","style":"simple","schema":{"type":"integer "}},"xtm-page-items-count":{"description":"Returns the number of projects listed on the currently displayed page.","style":"simple","schema":{"type":"integer "}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectCost"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"post":{"tags":["Project costs"],"summary":"Generate costs","description":"Generates costs","operationId":"generateCosts","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCostsGenerateRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCostsGenerateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/custom-fields":{"get":{"tags":["Project custom fields"],"summary":"Obtain project custom fields","description":"This method returns project custom fields.","operationId":"findCustomFields","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"activity","in":"query","description":"Allowed custom field activity.","required":false,"schema":{"type":"string","default":"ACTIVE","enum":["ACTIVE","ALL"]}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectCustomFieldResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"post":{"tags":["Project custom fields"],"summary":"Set project custom fields","description":"This method allows to set values of project custom fields but only for existing custom field definitions.","operationId":"updateCustomFields","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Custom field's ids and values.","items":{"$ref":"#/components/schemas/RSProjectCustomField"}}}},"required":true},"responses":{"200":{"description":"Operation completed."},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/files/download":{"get":{"tags":["Project files"],"summary":"Download project files","description":"This method downloads project files which can include files for offline translation, target files, PDF previews, different kinds of Excel reports and LQA results.\n\nThe following types of files can be downloaded with the PROJECT value of the fileScope parameter: TIPP, LQA_REPORT, LQA_EXTENDED_TABLE_REPORT, MULTI_EXCEL.\n\nIn order to download any other type of file, the fileScope parameter must be set to JOB. In such case, PROJECT fileScope value specifies that a single file will be downloaded, whereas JOB fileScope value specifies that there will be multiple files, one for each job covered by the request.\n\nWhen files generated for the entire project are requested for download, then the responses do not include job IDs.\n\nParameters fileNameFilter and fileNameFilterType work only when fileScope \"JOB\" is used.\n\nThe response is generated in the application/octet-stream format as a ZIP file.\n\nUser with Linguist role can download only files of types XLIFF, XLIFF_NTP to which he is assigned to in the active projects. For Linguist role, jobIds is required parameter and fileScope JOB has to be used.\n","operationId":"downloadFiles","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"fetchTargetFileTypes","in":"query","description":"Option only for fileType = TARGET and fileScope = JOB. It allows to include empty, non-analysable and not-supported file types in the download, they are not included by default","required":false,"schema":{"type":"array","items":{"type":"string","enum":["NO_CONTENT","NON_ANALYSABLE","NOT_SUPPORTED"]}}},{"name":"fileIds","in":"query","description":"File IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"fileNameFilter","in":"query","description":"File name filter.","required":false,"schema":{"type":"string"}},{"name":"fileNameFilterType","in":"query","description":"Type of file name's filter.\n\nWhen \"CONTAINS\" is used, the file name has to contain provided value.\n\nWhen \"EQUALS\" is used, the file name has to be equal to provided value.\n\nWhen \"STARTS_WITH\" is used, the file name has to start with provided value.\n\nWhen \"ENDS_WITH\" is used, the file name has to end with provided value.\n\nIn case of uploading a ZIP file as a source, folders structure has to be respected.\n\nExample: For a file \"example.txt\" in a folder example, the file name is example/example.txt.","required":false,"schema":{"type":"string","default":"CONTAINS","enum":["CONTAINS","EQUALS","STARTS_WITH","ENDS_WITH"]}},{"name":"fileScope","in":"query","description":"Type of files scope.","required":true,"schema":{"type":"string","default":"JOB","enum":["PROJECT","JOB"]}},{"name":"fileType","in":"query","description":"Type of requested file download.","required":true,"schema":{"type":"string","enum":["TARGET","XLIFF","XLIFF_NTP","QA_REPORT","HTML","HTML_TABLE","PDF","PDF_TABLE","TIPP","HTML_EXTENDED_TABLE","HTML_COLOURED","HTML_COLOURED_BY_MATCH_RATE","PDF_EXTENDED_TABLE","PDF_COLOURED","PDF_COLOURED_BY_XLIFF_DOC_STATUS","PDF_COLOURED_BY_MATCH_RATE","TARGET_COLOURED_BY_MATCH_RATE","TARGET_COLOURED_BY_XLIFF_DOC_STATUS","XLIFF_DOC","LQA_REPORT","LQA_EXTENDED_TABLE_REPORT","TARGET_PSEUDO","MULTI_EXCEL","EXCEL_EXTENDED_TABLE"]}},{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"targetLanguages","in":"query","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","example":"en_GB","items":{"type":"string"}}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-file-descrption":{"description":"Returns file metadata such as fileName, fileId, jobId and targetLanguage in a JSON format.","style":"simple","schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm","linguist"]}]}},"/projects/{projectId}/jobs":{"put":{"tags":["Project jobs"],"summary":"Update project jobs","description":"Update project jobs details.","operationId":"updateJobsPut","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSUpdateJobsRequest"}}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUpdateJobsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"patch":{"tags":["Project jobs"],"summary":"Update project jobs","description":"Update project jobs details.","operationId":"updateJobsPatch","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSUpdateJobsRequest"}}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUpdateJobsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/links/project-editor":{"post":{"tags":["Project links"],"summary":"Obtain link to a Project Editor","description":"This method generates link to the Project Editor of given project.","operationId":"generateProjectEditorLink","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectEditorLinkRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectEditorLinkResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/analysis":{"get":{"tags":["Project states"],"summary":"Obtain status of analysis","description":"This method returns information about the project analysis status.","operationId":"checkProjectAnalysisCompletion","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"fetchLevel","in":"query","description":"Fetch level of analysis status.","required":false,"schema":{"type":"string","description":"Fetch levels for obtaining project statuses.","enum":["JOBS"]}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectAnalysisResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/filter-templates":{"get":{"tags":["Project templates"],"summary":"Obtain project filter templates that match specific criteria","description":"This method returns project filter templates that match the specified search parameters.","operationId":"getFilterTemplates","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"customerIds","in":"query","description":"IDs of customers.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectFilterTemplateResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/due-dates":{"put":{"tags":["Project workflows"],"summary":"Update due dates","description":"This method updates due dates for jobs, workflow steps, target languages or the entire project. If any of the due dates to be set is in the wrong format, the request will not be executed. When a new due date is not specified for a job/workflow step/target language, the existing due date will be reset, resulting in no due date set for the objects. When projectDueDate is empty in the request, the due date of the project will not be changed.","operationId":"updateDueDates","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"targetLanguages","in":"query","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","example":"en_GB","items":{"type":"string"}}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectDueDateUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectDueDateUpdateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/roles":{"get":{"tags":["Roles"],"summary":"Obtain roles","description":"This method returns roles details.","operationId":"getRoles","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSRolesGetResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/subject-matters":{"get":{"tags":["Subject matter"],"summary":"Obtain subject matters","description":"This method returns subject matters with can be filtered by ID, name and activity.","operationId":"getSubjectMatters_1","parameters":[{"name":"ids","in":"query","description":"List of subject matter IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}},{"name":"activity","in":"query","description":"List of subject matter activities.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DISABLED","ACTIVE","PM","DELETED"]},"uniqueItems":true}},{"name":"name","in":"query","description":"Subject matter name.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSSubjectMattersGetResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/system":{"get":{"tags":["System"],"summary":"Obtain system details","description":"This method returns the company name, logo, XTM version and website address.","operationId":"getXTMInfo","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSSystemInfoResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/tag-groups/{tagGroupId}/tags":{"get":{"tags":["Tag"],"summary":"Obtain tag by tag group","description":"This method returns tags from tag group.","operationId":"obtainGroupTags","parameters":[{"name":"tagGroupId","in":"path","description":"Tag group ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSTagFindResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"post":{"tags":["Tag"],"summary":"Create tag","operationId":"createTags","parameters":[{"name":"tagGroupId","in":"path","description":"Tag group ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCreateTagsRequest"}}},"required":true},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSTagCreateResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/tag-groups":{"get":{"tags":["Tag groups"],"summary":"Obtain tag groups that match specific criteria","description":"This method returns tag groups.","operationId":"findTagGroups","parameters":[{"name":"ids","in":"query","description":"List of IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSTagGroupFindResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"post":{"tags":["Tag groups"],"summary":"Create tag group","description":"This method creates a new tag group.","operationId":"createTagGroup","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagGroupCreateRequest"}}},"required":true},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagGroupCreateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/terminology/files/export":{"post":{"tags":["Terminology export"],"summary":"Export terminology file","description":"This method exports a terminology file with selected parameters.","operationId":"exportTerminology","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSExportTermRequest"}}},"required":true},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSExportTermResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["customer_pm","term_expert"]}]}},"/terminology/files/import":{"post":{"tags":["Terminology import"],"summary":"Import terminology file","description":"This method imports a terminology file with selected parameters.","operationId":"importTerminology","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RSImportTermRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSImportTermResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["term_expert","customer_pm"]}]}},"/terminology/penalty-profiles":{"get":{"tags":["Terminology penalty profiles"],"summary":"Obtain terminology penalty profiles","description":"Obtain terminology penalty profiles.","operationId":"getPenaltyProfiles_1","parameters":[{"name":"activity","in":"query","required":false,"schema":{"type":"string","default":"ACTIVE","enum":["ALL","ACTIVE","INACTIVE"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSPenaltyProfilesResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm","term_expert"]}]}},"/translation-memory/files/generate":{"post":{"tags":["Translation memory export"],"summary":"Generate TM file","description":"This method generates TM file for a specific customer.","operationId":"generateTMFile","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTMFileGenerateRequest"}}},"required":true},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTMFileGenerateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm","tm_expert"]}]}},"/translation-memory/files/import":{"post":{"tags":["Translation memory import"],"summary":"Import TM file","description":"This method imports a TM file with selected parameters. It returns a list of fields that should be used to check the import status and download the result files. For ZIP files, multiple fields will be returned.","operationId":"importTM","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RSTMFileImportRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSTMFileImportResult"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["customer_pm","tm_expert"]}]}},"/translation-memory/penalty-profiles":{"get":{"tags":["Translation memory penalty profiles"],"summary":"Obtain TM penalty profiles","description":"Obtain TM penalty profiles.","operationId":"getPenaltyProfiles","parameters":[{"name":"activity","in":"query","required":false,"schema":{"type":"string","default":"ACTIVE","enum":["ALL","ACTIVE","INACTIVE"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSPenaltyProfilesResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm","tm_expert"]}]}},"/users":{"get":{"tags":["User"],"summary":"Obtain users that match specific criteria","description":"This method returns users that match the specified search parameters.","operationId":"getUsers","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"fetchAddress","in":"query","description":"Decision if address details should be fetched.","required":false,"schema":{"type":"string","default":"YES","description":"Specification whether the user address should be fetched.","enum":["YES","NO"]}},{"name":"ids","in":"query","description":"User IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"usernames","in":"query","description":"Usernames.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSFindUserResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"post":{"tags":["User"],"summary":"Create user","description":"This method creates a new user.","operationId":"createUser","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUserCreationRequest"}}},"required":true},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUserCreationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"delete":{"tags":["User"],"summary":"Delete users","description":"Deletes users by IDs.","operationId":"deleteUsers","parameters":[{"name":"userIds","in":"query","description":"User IDs.","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUserDeleteResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","administrator"]}]}},"/users/{userId}/access-rights":{"get":{"tags":["User access rights"],"summary":"Obtain user's access rights","description":"This method returns the user's access rights.","operationId":"getUserAccessRights","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSGetUserAccessRightsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","linguist"]}]}},"/users/{userId}/language-combinations":{"get":{"tags":["User language combinations"],"summary":"Obtain user's language combinations","description":"This method returns the user's language combinations.","operationId":"obtainLanguageCombinations","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSGetUserLanguageCombinationsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"post":{"tags":["User language combinations"],"summary":"Add user language combinations","description":"This method adds language combinations for a user.","operationId":"postLanguageCombinations","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPostUserLanguageCombinationsRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPostUserLanguageCombinationsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"delete":{"tags":["User language combinations"],"summary":"Delete user language combinations","description":"This method deletes the user's language combinations.","operationId":"deleteLanguageCombinations","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteUserLanguageCombinationsRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteUserLanguageCombinationsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/users/{userId}/rate-cards":{"get":{"tags":["User rate cards"],"summary":"Obtain rate cards that match specific criteria","description":"This method returns rate cards that match the specified search parameters.","operationId":"getUserRateCards","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"fetchLevel","in":"query","description":"Fetch level of rate cards.","required":false,"schema":{"type":"string","enum":["MINIMAL","BASIC","EXTENDED"]}},{"name":"page","in":"query","description":"Page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of rate cards listed on page.","required":false,"schema":{"type":"integer","format":"int32","default":100}},{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-page-size":{"description":"Returns the number of jobs that can be listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}},"xtm-total-items-count":{"description":"Returns the number of jobs matching the criteria.","style":"simple","schema":{"type":"integer "}},"xtm-page":{"description":"Returns the currently displayed page number.","style":"simple","schema":{"type":"integer "}},"xtm-page-items-count":{"description":"Returns the number of jobs listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSFindRateCardsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/users/{userId}/subject-matters":{"get":{"tags":["User subject matters"],"summary":"Obtain the user's subject matters","description":"This method returns the user's subject matters.","operationId":"getSubjectMatters","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSGetUserSubjectMattersResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"User not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"post":{"tags":["User subject matters"],"summary":"Add subject matters","description":"This method adds subject matters for a user.","operationId":"postSubjectMatters","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPostUserSubjectMattersRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPostUserSubjectMattersResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"User or subject matters not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"delete":{"tags":["User subject matters"],"summary":"Delete subject matters","description":"This method deletes user's subject matters.","operationId":"deleteSubjectMatters","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteUserSubjectMattersRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteUserSubjectMattersResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"User or subject matters not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/users/{userId}/workflow-steps":{"get":{"tags":["User workflow steps"],"summary":"Obtain user's workflow steps","description":"This method returns user's workflow steps.","operationId":"getWorkflowSteps","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSGetUserWorkflowStepsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"post":{"tags":["User workflow steps"],"summary":"Add user workflow steps","description":"This method adds workflow steps for a user.","operationId":"postWorkflowSteps","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPostUserWorkflowStepsRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPostUserWorkflowStepsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"delete":{"tags":["User workflow steps"],"summary":"Delete user's workflow steps","description":"This method deletes user's workflow steps.","operationId":"deleteWorkflowSteps","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteUserWorkflowStepsRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteUserWorkflowStepsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/workflows":{"get":{"tags":["Workflow"],"summary":"Obtain workflows that match specific criteria","description":"This method returns workflows that match the specified search parameters.","operationId":"findWorkflows","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"ids","in":"query","description":"Workflow IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"name","in":"query","description":"Name of workflow definition.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSWorkflowResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/auth/token":{"post":{"tags":["XTM Basic"],"summary":"Generate token","description":"Tokens are generated based on user credentials that must include client name, user ID and user password.","operationId":"generateToken","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTokenGenerateRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTokenGenerateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"x-code-samples":[{"lang":"JavaScript","source":"const baseURL = \"https://SERVER_URL/rest-api\";\nlet token;\n\nfunction authentication(){\n const url = baseURL + '/auth/token';\n const params = {\n headers: {\"Content-Type\":\"application/json\"},\n method: 'POST',\n body: '{\"client\":\"CLIENT\",\"password\":\"password\",\"userId\":\"0\"}'\n };\n\n fetch(url, params).then(\n response => response.json())\n .then(data => getToken(data));\n}\n\nfunction getToken(data){\n token = \"XTM-Basic \" + data.token;\n console.info(token);\n}"},{"lang":"C#","source":"static string baseURL = \"https://SERVER_URL/rest-api\";\n\npublic string Authentication ()\n{ \n string URL = baseURL + \"/auth/token\";\n AuthorizationRequest userData = new AuthorizationRequest\n {\n client =\"CLIENT\",\n password = \"password\",\n userId = 0\n };\n \n var data = Encoding.ASCII.GetBytes(JsonConvert.SerializeObject(userData));\n\n try\n {\n HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL);\n request.Method = \"POST\";\n request.ContentType = \"application/json\";\n request.ContentLength = data.Length;\n \n Stream newStream = request.GetRequestStream();\n newStream.Write(data, 0, data.Length);\n newStream.Close();\n\n HttpWebResponse response = request.GetResponse() as HttpWebResponse;\n StreamReader reader = new StreamReader(response.GetResponseStream());\n \n string authJSONResponse = reader.ReadToEnd();\n AuthorizationResponse authResponse = JsonConvert.DeserializeObject(authJSONResponse);\n reader.Close();\n\n return authResponse.token;\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n return null;\n }\n}\n\npublic class AuthorizationRequest\n{\n public string client { get; set; }\n public string password { get; set; }\n public int userId { get; set; }\n}\n\npublic class AuthorizationResponse\n{\n public string token { get; set; }\n}"}]}},"/error":{"get":{"tags":["rs-error-resource"],"operationId":"error","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"put":{"tags":["rs-error-resource"],"operationId":"error_2","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"post":{"tags":["rs-error-resource"],"operationId":"error_1","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"delete":{"tags":["rs-error-resource"],"operationId":"error_3","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"options":{"tags":["rs-error-resource"],"operationId":"error_6","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"head":{"tags":["rs-error-resource"],"operationId":"error_5","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"patch":{"tags":["rs-error-resource"],"operationId":"error_4","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/callbacks/authentications/{authenticationId}":{"put":{"tags":["Callback authentications"],"summary":"Update callback authentication","description":"This method can be used to update a single callback authentication.","operationId":"updateCallbackAuthenticationsPut","parameters":[{"name":"authenticationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPutCallbackAuthenticationRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPutCallbackAuthenticationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["administrator"]}]},"delete":{"tags":["Callback authentications"],"summary":"Delete callback authentication","description":"Deletes a callback authentication by ID.","operationId":"deleteCallbackAuthentications","parameters":[{"name":"authenticationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteCallbackAuthenticationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["administrator"]}]},"patch":{"tags":["Callback authentications"],"summary":"Update callback authentication","description":"This method can be used to update a single callback authentication.","operationId":"updateCallbackAuthenticationsPatch","parameters":[{"name":"authenticationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPatchCallbackAuthenticationRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPatchCallbackAuthenticationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["administrator"]}]}},"/callbacks/properties/{propertyId}":{"put":{"tags":["Callback properties"],"summary":"Update callback property","description":"This method can be used to update a single callback property.","operationId":"putCallbackProperty","parameters":[{"name":"propertyId","in":"path","description":"Callback property ID.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPutCallbackPropertyRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUpdateCallbackPropertyResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"501":{"description":"Method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"delete":{"tags":["Callback properties"],"summary":"Delete callback property","description":"This method deletes a callback property by ID.","operationId":"deleteCallbackProperty","parameters":[{"name":"propertyId","in":"path","description":"Callback property ID.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteCallbackPropertyResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"501":{"description":"Method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"patch":{"tags":["Callback properties"],"summary":"Update callback property","description":"This method can be used to update a single callback property.","operationId":"patchCallbackProperty","parameters":[{"name":"propertyId","in":"path","description":"Callback property ID.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPatchCallbackPropertyRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUpdateCallbackPropertyResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"501":{"description":"Method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/custom-fields/project":{"get":{"tags":["Custom field"],"summary":"Obtain custom fields definitions for project","description":"This method returns custom fields definitions that are related to a project.","operationId":"findCustomFieldDefinitionsForProject","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSFindCustomFieldResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/custom-fields/terminology":{"get":{"tags":["Custom field"],"summary":"Obtain custom fields definitions for terminology","description":"This method returns custom fields definitions that are related to a terminology.","operationId":"findCustomFieldDefinitionsForTerminology","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSFindCustomFieldOfTerminologyResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/custom-fields/user":{"get":{"tags":["Custom field"],"summary":"Obtain custom fields definitions for user","description":"This method returns custom fields definitions that are related to a user.","operationId":"findCustomFieldDefinitionsForUser","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSFindCustomFieldResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/customers/{customerId}":{"get":{"tags":["Customer"],"summary":"Obtain customer","description":"This method return Customer","operationId":"getCustomer","parameters":[{"name":"customerId","in":"path","description":"Customer ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"fetchAddress","in":"query","description":"Decision if Address data should be fetched.","required":false,"schema":{"type":"string","default":"NO","enum":["YES","NO"]}},{"name":"fetchProjectWatchers","in":"query","description":"Decision if project watchers data should be fetched","required":false,"schema":{"type":"string","default":"NO","enum":["PM_ONLY","NO","ALL"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCustomerGetResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"put":{"tags":["Customer"],"summary":"Update customer","description":"This method replaces existing customer resource with the provided one.","operationId":"putUpdateCustomer","parameters":[{"name":"customerId","in":"path","description":"Customer ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCustomerUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCustomerUpdateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"delete":{"tags":["Customer"],"summary":"Delete customer","description":"This method delete Customer.","operationId":"deleteCustomer","parameters":[{"name":"customerId","in":"path","description":"Customer ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCustomerDeleteResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"patch":{"tags":["Customer"],"summary":"Update customer","description":"This method updates existing customer resource fields with provided ones.","operationId":"patchUpdateCustomer","parameters":[{"name":"customerId","in":"path","description":"Customer ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCustomerUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCustomerUpdateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/customers/{customerId}/language-combinations":{"get":{"tags":["Customer"],"summary":"Obtain customer language combinations","description":"This method returns Customers language combinations.","operationId":"customerLangCombinations","parameters":[{"name":"customerId","in":"path","description":"Customer ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"fetchLangDefinitions","in":"query","description":"Fetch language definitions.","required":false,"schema":{"type":"string","default":"NO","enum":["YES","NO"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"Accept-Language","in":"header","description":"Fetch the localized version of the corresponding language name. Only supported for the following language codes: en_GB, en_US, de_DE, es_ES, fr_CA, ja_JP, pl_PL, ru_RU, tr_TR, zh_CN, pt_PT. If an unsupported language code is passed in the parameter or no language code is specified in the parameter, the default is en_GB.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CUSTOMER_LANGUAGE_COMBINATIONS"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/customers/{customerId}/subject-matters":{"get":{"tags":["Customer"],"summary":"Obtain subject matters for customer","description":"This method returns subject matters for customer with can be filtered by ID, name and activity.","operationId":"getSubjectMattersForCustomer","parameters":[{"name":"ids","in":"query","description":"List of subject matter IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}},{"name":"activity","in":"query","description":"List of subject matter activities.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DISABLED","ACTIVE","PM","DELETED"]},"uniqueItems":true}},{"name":"name","in":"query","description":"Subject matter name.","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSSubjectMattersGetResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/externals/users/{externalUserId}":{"get":{"tags":["External user"],"summary":"Obtain external user","description":"This method returns external user.","operationId":"getExternalUser","parameters":[{"name":"externalUserId","in":"path","description":"External user ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSExternalUserGetResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"put":{"tags":["External user"],"summary":"Update external user","description":"This method replaces existing external user resource with the provided one. ","operationId":"putExternalUser","parameters":[{"name":"externalUserId","in":"path","description":"External user ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSExternalUserPutRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSExternalUserPutResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"delete":{"tags":["External user"],"summary":"Delete external user","description":"This method deletes external user.","operationId":"deleteExternalUser","parameters":[{"name":"externalUserId","in":"path","description":"External user ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSExternalUserDeleteResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"patch":{"tags":["External user"],"summary":"Update external user","description":"This method updates existing external user resource fields with provided ones. ","operationId":"patchExternalUser","parameters":[{"name":"externalUserId","in":"path","description":"External user ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSExternalUserPatchRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSExternalUserPatchResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/clone":{"post":{"tags":["Project"],"summary":"Create project from source project","description":"Creates a new project based on the provided project. \n\nImportant! After creating a project copy using a base project, reanalysis is executed.\n\nWorkflows states are set depending on the flag.\n\nOnly source files are copied from the base project. Preview and other files are not copied.\n\nContent in the request body must be multipart/form-data.","operationId":"cloneProject","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RSProjectCloneModelAttributeRequest"}}}},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectCloneResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/lqa/download":{"get":{"tags":["Project LQA"],"summary":"Download project LQA","description":"Download project LQA reports in json format.\n\nOnly LQA reports generated as of the XTM Cloud release of 13.0 are going to be returned from by method.","operationId":"downloadLqa","parameters":[{"name":"reportID","in":"query","description":"Report ids","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}},{"name":"projectIds","in":"query","description":"Projects ids","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"targetLanguages","in":"query","description":"Target languages","required":false,"schema":{"type":"array","example":"en_GB","items":{"type":"string"}}},{"name":"evalueeIds","in":"query","description":"Evaluee ids","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"evaluatorIds","in":"query","description":"Evaluator ids","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"workflowStepIds","in":"query","description":"Workflow step ids","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"completeDateFrom","in":"query","description":"Date of created from in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","required":false,"schema":{"type":"string"}},{"name":"completeDateTo","in":"query","description":"Date of created to in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Type of LQA","required":false,"schema":{"type":"string","enum":["LANGUAGE","FILE"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LQAJsonReportResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/multi-create":{"post":{"tags":["Project"],"summary":"Create multi projects","description":"Create multiple projects in one go using this method.\n\nRequests must include:
      \n\t\t\t
    • customerId
      • \n\t\t\t
    • name
      • \n\t\t\t
    • translation files.
      • \n\t\t\t
    \n\n\n A valid project creation request must either include either
      \n\t\t\t
    • workflowId
      • \n\t\t\t
    • templateId of an existing template that specifies a workflow definition.
      • \n\t\t\t
    \n\n\nEvery translation file must either:
      \n\t\t\t
    • contain source and target languages
      • \n\t\t\t
    • use the following pattern for all file names
      • \n\t\t\t
    \n\n\n source-language_target-language_rest-file-name\n\nExample en-GB_pl-PL_de-DE_file1.xml, de-DE_en-GB_file2.xml\n\n Content in the request body must be multipart/form-data.","operationId":"createMultiProjects","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RSProjectsMultiCreationModelAttributeRequest"}}}},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectsMultiCreationResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/search":{"post":{"tags":["Project"],"summary":"Advanced obtain projects that match specific criteria","description":"This method returns projects that match the specified search parameters.","operationId":"postProjectsSearch","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSFindProjectPostRequest"}}}},"responses":{"200":{"description":"Operation completed.","headers":{"xtm-page-size":{"description":"Returns the number of projects that can be listed on the currently displayed page.","style":"simple","schema":{"type":"integer "}},"xtm-total-items-count":{"description":"Returns the number of projects matching the criteria.","style":"simple","schema":{"type":"integer "}},"xtm-page":{"description":"Returns the currently displayed page number.","style":"simple","schema":{"type":"integer "}},"xtm-page-items-count":{"description":"Returns the number of projects listed on the currently displayed page.","style":"simple","schema":{"type":"integer "}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/templates":{"get":{"tags":["Project templates"],"summary":"Simple obtain project templates that match specific criteria","description":"This method returns project templates that match the specified search parameters.","operationId":"getTemplates","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"customerIds","in":"query","description":"IDs of customers.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"ids","in":"query","description":"IDs of templates.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"scope","in":"query","description":"Scope of templates.","required":false,"schema":{"type":"string","default":"ALL","enum":["ALL","GLOBAL","CUSTOMERS"]}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectTemplateResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/templates/search":{"post":{"tags":["Project templates"],"summary":"Advanced obtain project templates that match specific criteria","description":"This method returns project templates that match the specified search parameters.","operationId":"postTemplatesSearch","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSFindProjectTemplateRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectTemplateResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/templates/{templateId}":{"get":{"tags":["Project templates"],"summary":"Obtain project template","description":"This method returns project template.","operationId":"getTemplate","parameters":[{"name":"templateId","in":"path","description":"Project template ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSGetProjectTemplateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/templates/{templateId}/custom-fields":{"get":{"tags":["Project templates"],"summary":"Obtain project template custom fields","description":"This method returns project template custom fields.","operationId":"findCustomFields_1","parameters":[{"name":"templateId","in":"path","description":"Project template ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"activity","in":"query","description":"Allowed custom field activity.","required":false,"schema":{"type":"string","default":"ACTIVE","enum":["ACTIVE","ALL"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectTemplateCustomFieldResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}":{"get":{"tags":["Project"],"summary":"Obtain project","description":"This method returns project.","operationId":"getProject","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectGetResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"put":{"tags":["Project"],"summary":"Update project","description":"This method updates project details. ","operationId":"updateProject","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"updateFieldsType","in":"query","description":"Type of project update. If ALL is selected, the project will be updated with all fields from the request, even if they contain null values.","required":false,"schema":{"type":"string","default":"ONLY_PROVIDED","enum":["ALL","ONLY_PROVIDED"]}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectUpdateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"delete":{"tags":["Project"],"summary":"Delete project","description":"This method deletes a project. Projects can be deleted with or without the TM created from the project.","operationId":"deleteProject","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"option","in":"query","description":"Type of project deletion.","required":false,"schema":{"type":"string","default":"DELETE_LEAVING_TM","description":"Type of project deletion process.","enum":["DELETE_WITH_TM","DELETE_LEAVING_TM"]}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectDeletionResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}],"x-code-samples":[{"lang":"JavaScript","source":"function deleteProject(){\n const url = baseURL + '/projects/0';\n const params = {\n headers: {\"Authorization\": token},\n method: 'DELETE',\n };\n fetch(url, params);\n}"},{"lang":"C#","source":"public void DeleteProject (string token)\n{\n int projectId = 0;\n string URL = baseURL + \"/projects/\" + projectId;\n try\n {\n HttpWebRequest request = (HttpWebRequest) WebRequest.Create(URL);\n request.Method = \"DELETE\";\n request.Headers.Add(\"Authorization\", \"XTM-Basic \" + token);\n \n HttpWebResponse response = request.GetResponse() as HttpWebResponse;\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n }\n}"}]},"patch":{"tags":["Project"],"summary":"Update project","description":"This method updates project details. ","operationId":"updateProjectPatch","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectUpdateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/archive":{"post":{"tags":["Project activity"],"summary":"Project archive","description":"Project archive","operationId":"archiveProject","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSArchiveProjectResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/callbacks/{callbackId}":{"delete":{"tags":["Project callbacks"],"summary":"Delete project callback","description":"This method can be used to delete a single callback from a project.","operationId":"deleteProjectCallback","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"callbackId","in":"path","description":"Callback ID.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteProjectCallbackResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"patch":{"tags":["Project callbacks"],"summary":"Update project callback","description":"This method can be used to update callbacks in the project.","operationId":"updateProjectCallbacks","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"callbackId","in":"path","description":"Callback ID.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUpdatePatchProjectCallbackRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUpdatePatchProjectCallbackResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/costs/{costId}":{"get":{"tags":["Project costs"],"summary":"Obtain costs","description":"Obtains costs","operationId":"obtainCosts","parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"schema":{"type":"integer","format":"int64","description":"projectId"}},{"name":"costId","in":"path","description":"costId","required":true,"schema":{"type":"integer","format":"int64","description":"costId"}},{"name":"fetchLevel","in":"query","required":false,"schema":{"type":"string","enum":["TARGET_LANGUAGES"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCostsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project or costs not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/costs/{costId}/pos":{"get":{"tags":["Project costs"],"summary":"Download PO","description":"Download Purchase Order for given process ID.","operationId":"downloadPO","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"costId","in":"path","description":"Cost ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"processId","in":"query","description":"Process ID received from the generate purchase order method.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPOResponse"}}}},"202":{"description":"The request has been accepted for processing, but the processing has not been completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSAcceptedResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"post":{"tags":["Project costs"],"summary":"Generate PO","description":"Generates Purchase Order for the specified project and costs.","operationId":"generatePO","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"costId","in":"path","description":"Cost ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"userId","in":"query","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"costsBreakdown","in":"query","description":"Defines the way of breaking costs down.","required":true,"schema":{"type":"string","enum":["NO_BREAKDOWN","LANGUAGES","LANGUAGES_AND_WORKFLOW_STEP"]}},{"name":"calculationMethod","in":"query","description":"Defines the method of costs calculation.","required":true,"schema":{"type":"string","enum":["ADDITION","SUBTRACTION"]}},{"name":"includeRates","in":"query","description":"Defines if PO should include rates.","required":false,"schema":{"type":"string","default":"INCLUDE","enum":["INCLUDE","DO_NOT_INCLUDE"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSGeneratePORequest"}}}},"responses":{"202":{"description":"The request has been accepted for processing, but the processing has not been completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectCostsGeneratePOResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/deactivate":{"post":{"tags":["Project activity"],"summary":"Cancel project","description":"This method cancels processing of a project.","operationId":"deactivateProject","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectDeactivateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}],"x-code-samples":[{"lang":"JavaScript","source":"function cancelProject(){\n const url = baseURL + '/projects/0/deactivate';\n const params = {\n headers: {\"Authorization\": token},\n method: 'POST',\n };\n fetch(url, params);\n}"},{"lang":"C#","source":"public void CancelProject (string token)\n{\n int projectId = 0;\n string URL = baseURL + string.Format(\"/projects/{0}/deactivate\", projectId);\n try\n {\n HttpWebRequest request = (HttpWebRequest) WebRequest.Create(URL);\n request.Method = \"POST\";\n request.Headers.Add(\"Authorization\", \"XTM-Basic \" + token);\n\n HttpWebResponse response = request.GetResponse() \n as HttpWebResponse;\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n }\n}"}]}},"/projects/{projectId}/files":{"delete":{"tags":["Project files"],"summary":"Delete file","description":"This method deletes the source files for specific languages.","operationId":"deleteSourceFilesFromProject","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"reanalyseProjectDecision","in":"query","description":"Decision if project should be reanalysed.","required":false,"schema":{"type":"string","default":"NO","enum":["NO","YES"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"File names.","items":{"$ref":"#/components/schemas/RSProjectFileRemoveParameter"}}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectFileDeleteResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","headers":{"Location":{"description":"Points a resource with additional data of forbidden reason.","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/files/generate":{"post":{"tags":["Project files"],"summary":"Generate specific files","description":"Generates project files. Files can be generated for the whole project or a specified scope.\n\nFiles that can be generated for the entire project or language include: TIPP, LQA_REPORT, LQA_EXTENDED_TABLE_REPORT, MULTI_EXCEL, PDF, PDF_COLOURED_BY_MATCH_RATE, PDF_COLOURED_BY_XLIFF_DOC_STATUS, EXCEL_EXTENDED_TABLE, PDF_EXTENDED_TABLE, HTML_EXTENDED_TABLE.\n\nThe targetLanguage parameter only specifies the following files generated per one project: TIPP, LQA_REPORT, MULTI_EXCEL, PDF, PDF_COLOURED_BY_MATCH_RATE, PDF_COLOURED_BY_XLIFF_DOC_STATUS. It is not used to generate joblds-based files.\n\nWhen files are generated for a specific scope, then the jobIds parameter must be used. In such case, any type of file listed under fileTypes values can be generated with the exception of MULTI_EXCEL.\n\nGenerated files can be identified by their unique IDs.\n\nUser with Linguist role can generate only files of types XLIFF, XLIFF_NTP to which he is assigned to in the active projects.\n\n Providing displayStepName or stepReferenceName allows to generate target files after a selected step in the workflow. The translation in the generated target will reflect the changes made up to this specific step.","operationId":"generateFiles","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"displayStepName","in":"query","description":"Workflow display step name. This name is used as a label in the UI.","required":false,"schema":{"type":"string"}},{"name":"fileType","in":"query","description":"Type of requested file generation.","required":true,"schema":{"type":"string","enum":["TARGET","XLIFF","XLIFF_NTP","QA_REPORT","HTML","HTML_TABLE","PDF","PDF_TABLE","TIPP","HTML_EXTENDED_TABLE","HTML_COLOURED","HTML_COLOURED_BY_MATCH_RATE","PDF_EXTENDED_TABLE","PDF_COLOURED","PDF_COLOURED_BY_XLIFF_DOC_STATUS","PDF_COLOURED_BY_MATCH_RATE","TARGET_COLOURED_BY_MATCH_RATE","TARGET_COLOURED_BY_XLIFF_DOC_STATUS","XLIFF_DOC","LQA_REPORT","LQA_EXTENDED_TABLE_REPORT","TARGET_PSEUDO","MULTI_EXCEL","EXCEL_EXTENDED_TABLE"]}},{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"referenceStepName","in":"query","description":"Workflow reference step name.","required":false,"schema":{"type":"string"}},{"name":"targetLanguage","in":"query","description":"Target language code.","required":false,"schema":{"type":"string","example":"en_GB"}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/RSProjectFileGenerateRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectFileGenerateRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectFileGenerateResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm","linguist"]}]}},"/projects/{projectId}/files/preview-files/upload":{"post":{"tags":["Project files"],"summary":"Upload Preview Files to project","description":"Upload Preview Files to project","operationId":"uploadPreviewFile","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RSUploadPreviewFileRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUploadPreviewFileResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","headers":{"Location":{"description":"Points a resource with additional data of forbidden reason.","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/files/reference-materials/download":{"get":{"tags":["Project files"],"summary":"Download Reference Materials","description":"This method downloads project's reference materials.","operationId":"downloadReferenceMaterials","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-file-descrption":{"description":"Returns fileName in a JSON format.","style":"simple","schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project or files not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/files/reference-materials/upload":{"post":{"tags":["Project files"],"summary":"Upload Reference Materials to project","description":"Upload Reference Materials to project","operationId":"uploadReferenceMaterials","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RSUploadReferenceMaterialsRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUploadReferenceMaterialsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","headers":{"Location":{"description":"Points a resource with additional data of forbidden reason.","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/files/segment-id-images/upload":{"post":{"tags":["Project files"],"summary":"Upload Segment ID Images to project","description":"Upload Segment ID Images to project","operationId":"uploadSegmentIdImages","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RSUploadSegmentIdImagesRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUploadSegmentIdImageResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","headers":{"Location":{"description":"Points a resource with additional data of forbidden reason.","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/files/sources/download":{"get":{"tags":["Project files"],"summary":"Download source files","description":"This method downloads the source files for project or specific jobs.\n\nThe response is generated in the application/octet-stream format as a ZIP file. ","operationId":"downloadSourcesFile","parameters":[{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"folderStructure","in":"query","description":"Folder structure in which source files are downloaded.\n\nFLAT: flat file structure. All files are downloaded in the same folder. To distinguish between files with the same name, different suffixes are added to them. Example: If two files are both called test.txt, they are called test(file_id_1).txt and test(file_id_2).txt.\n\nORIGINAL: the file structure present in the original source ZIP file is recreated and the download files are placed in folders with the same names as before.","required":false,"schema":{"type":"string","default":"FLAT","enum":["FLAT","ORIGINAL"]}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-file-descrption":{"description":"Returns file metadata such as fileName, fileId, jobIds in a JSON format.","style":"simple","schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/files/sources/upload":{"post":{"tags":["Project files"],"summary":"Upload source files to project","description":"Uploads source files for a project.\n\nContent in the request body has to be multipart/form-data.","operationId":"uploadSourceFiles","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"matchType","in":"query","description":"When \"MATCH_NAMES\" is used, the source file uploaded to a project will be replaced with the new one.\n\nWhen \"NO_MATCH\" is used, the source file uploaded to a project will be added and renamed, if there is already a file with the same name.","required":false,"schema":{"type":"string","default":"NO_MATCH","enum":["MATCH_NAMES","NO_MATCH"]}},{"name":"reanalyseProject","in":"query","description":"Decision if project should be reanalysed.","required":false,"schema":{"type":"string","default":"NO","enum":["NO","YES"]}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RSProjectFileUploadRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectFileUploadResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","headers":{"Location":{"description":"Points a resource with additional data of forbidden reason.","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/files/status":{"get":{"tags":["Project files"],"summary":"Obtain status of generated files","description":"Returns information about the status of generated files.\n\n User with Linguist role can see only the status of file types XLIFF, XLIFF_NTP to which he is assigned to in the active projects. For linguist role jobIds is also required parameter and fileScope JOB has to be used.","operationId":"filesStatus","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"fileIds","in":"query","description":"File IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"fileScope","in":"query","description":"Type of files scope.","required":true,"schema":{"type":"string","default":"JOB","enum":["PROJECT","JOB"]}},{"name":"fileType","in":"query","description":"Type of requested file status.","required":false,"schema":{"type":"string","enum":["TARGET","XLIFF","XLIFF_NTP","QA_REPORT","HTML","HTML_TABLE","PDF","PDF_TABLE","TIPP","HTML_EXTENDED_TABLE","HTML_COLOURED","HTML_COLOURED_BY_MATCH_RATE","PDF_EXTENDED_TABLE","PDF_COLOURED","PDF_COLOURED_BY_XLIFF_DOC_STATUS","PDF_COLOURED_BY_MATCH_RATE","TARGET_COLOURED_BY_MATCH_RATE","TARGET_COLOURED_BY_XLIFF_DOC_STATUS","XLIFF_DOC","LQA_REPORT","LQA_EXTENDED_TABLE_REPORT","TARGET_PSEUDO","MULTI_EXCEL","EXCEL_EXTENDED_TABLE","TARGET_UPLOAD"]}},{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"targetLanguages","in":"query","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","example":"en_GB","items":{"type":"string"}}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectFileStatusResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm","linguist"]}]}},"/projects/{projectId}/files/translations/upload":{"post":{"tags":["Project files"],"summary":"Upload translation file to project","description":"Upload translation file to project. Exactly one of the fields `displayStepName` or `stepReferenceName` must be specified, unless the xliffOptions.autopopulation option is ENABLED.","operationId":"uploadTranslationFile","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RSProjectTranslationFilesUploadRequest"}}}},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTranslationFilesUploadResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","headers":{"Location":{"description":"Points a resource with additional data of forbidden reason.","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm","linguist"]}]}},"/projects/{projectId}/files/translations/{fileId}/status":{"get":{"tags":["Project files"],"summary":"Check translation file upload status","description":"Check translation file upload status.","operationId":"checkUploadStatus","parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"schema":{"type":"integer","format":"int64","description":"projectId"}},{"name":"fileId","in":"path","description":"fileId","required":true,"schema":{"type":"integer","format":"int64","description":"fileId"}},{"name":"fileType","in":"query","description":"fileType","required":true,"schema":{"type":"string","description":"fileType","enum":["XLIFF"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTranslationFileStatusResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","headers":{"Location":{"description":"Points a resource with additional data of forbidden reason.","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/files/{fileId}/docx/compare":{"get":{"tags":["Project files"],"summary":"Download the comparison file","description":"Use this method to download a the file containing the result from comparing the two docx files.","operationId":"downloadComparisonFile","parameters":[{"name":"projectId","in":"path","description":"Original project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"fileId","in":"path","description":"Original file ID. Must be a target file generated for a scope = “JOB“.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"processId","in":"query","description":"Process ID received from the compare docx files method.","required":true,"schema":{"type":"string"}},{"name":"revisedProjectId","in":"query","description":"Revised project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"revisedFileId","in":"query","description":"Revised file ID. Must be a target file generated for a scope = “JOB“.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed."},"202":{"description":"The request has been accepted for processing, but the processing has not been completed."},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"post":{"tags":["Project files"],"summary":"Compare docx files","description":"Use this method to compare two .docx files from two different XTM Cloud projects. Result: a file containing the differences is generated and this process is identified by the specified processId in the response.","operationId":"compareDocxFiles","parameters":[{"name":"projectId","in":"path","description":"Original project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"fileId","in":"path","description":"Original file ID. Must be a target file generated for a scope = “JOB“.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCompareDocxFilesGenerateRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCompareDocxFilesGenerateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/files/{fileId}/download":{"get":{"tags":["Project files"],"summary":"Download project file","description":"This method downloads a single, generated project file based on its ID.\n\nThe response is generated in the application/octet-stream format as a ZIP file. ","operationId":"downloadFile","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"fileScope","in":"query","description":"Type of files scope.","required":true,"schema":{"type":"string","default":"JOB","enum":["PROJECT","JOB"]}},{"name":"fileId","in":"path","description":"File ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-file-descrption":{"description":"Returns file metadata such as fileName, fileId, jobId and targetLanguage in a JSON format.","style":"simple","schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/files/{fileId}/status":{"get":{"tags":["Project files"],"summary":"Obtain status of generated file","description":"This method returns the status of a generated file.","operationId":"fileStatus","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"fileScope","in":"query","description":"Type of files scope.","required":true,"schema":{"type":"string","default":"JOB","enum":["PROJECT","JOB"]}},{"name":"fileId","in":"path","description":"File ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectFileStatusResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm","linguist"]}]}},"/projects/{projectId}/jobs/bundles/finish":{"post":{"tags":["Project bundles"],"summary":"Move bundles to next workflow step","description":"This method finishes bundles by IDs and moves workflow to the next workflow step. ","operationId":"finishBundles","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowBundleFinishRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowBundleFinishResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","linguist"]}]}},"/projects/{projectId}/jobs/bundles/reject":{"post":{"tags":["Project bundles"],"summary":"Move bundles to previous workflow step","description":"This method rejects bundles by IDs and moves workflow to the previous workflow step.","operationId":"rejectBundles","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowBundleRejectRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowBundlesRejectResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","linguist"]}]}},"/projects/{projectId}/jobs/cancel":{"post":{"tags":["Project activity"],"summary":"Cancel jobs","description":"This method cancels processing of jobs without removing them from the project.","operationId":"cancelJob","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"jobIds","in":"query","description":"Job IDs.","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectJobCancelResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/links/workbench":{"post":{"tags":["Project links"],"summary":"Obtain link to a Workbench","description":"This method generates link to the Workbench of given project jobs.","operationId":"generateWorkbenchLink","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSEditorLinkRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSEditorLinkResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/metrics":{"get":{"tags":["Project analytics"],"summary":"Obtain metrics that match specific criteria","description":"This method returns metrics for a single or multiple target languages. Project metrics list all the different types of matches with corresponding segment, word and character counts. Metrics are divided by languages and jobs, and include data about progress of each job in each workflow step. See [API resources](#tag/Definitions) for description of match types.","operationId":"findProjectMetrics","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"targetLanguages","in":"query","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSLanguageMetricsResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/metrics/bundles":{"get":{"tags":["Project analytics"],"summary":"Obtain bundle metrics that match specific criteria","description":"This method returns metrics for a single or multiple bundles in a project. Bundle metrics list all the different types of matches with corresponding segment, word and character counts. This method uses paging. The items are sorted first by bundle ID ascending and then by job ID ascending. See [API resources](#tag/Definitions) for description of match types.","operationId":"findBundlesMetrics","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}},{"name":"bundleIds","in":"query","description":"Bundle IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}},{"name":"targetLanguages","in":"query","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","uniqueItems":true,"items":{"type":"string"}}},{"name":"page","in":"query","description":"Page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of elements listed on page.","required":false,"schema":{"type":"integer","format":"int32","default":1000}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-page-size":{"description":"Returns the number of projects that can be listed on the currently displayed page.","style":"simple","schema":{"type":"integer "}},"xtm-total-items-count":{"description":"Returns the number of projects matching the criteria.","style":"simple","schema":{"type":"integer "}},"xtm-page":{"description":"Returns the currently displayed page number.","style":"simple","schema":{"type":"integer "}},"xtm-page-items-count":{"description":"Returns the number of projects listed on the currently displayed page.","style":"simple","schema":{"type":"integer "}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSBundleMetrics"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/metrics/files":{"get":{"tags":["Project analytics"],"summary":"Obtain metrics files list","description":"This method returns a list of metrics files for a project.","operationId":"findProjectMetricsFiles","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSMetricsFilesResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/metrics/files/download":{"get":{"tags":["Project analytics"],"summary":"Download metric file","description":"This method downloads metric file for project in .xlsx format.","operationId":"downloadProjectMetricsFiles","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"metricsFilesType","in":"query","description":"Metric file type.","required":true,"schema":{"type":"string","enum":["INITIAL","CURRENT"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-file-descrption":{"description":"Returns file metadata such as fileName, fileId in a JSON format.","style":"simple","schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/metrics/files/{fileId}/download":{"get":{"tags":["Project analytics"],"summary":"Download metric file by ID","description":"This method downloads a specific metric file for a project in .xlsx format.","operationId":"downloadProjectMetricsFile","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"fileId","in":"path","description":"Metrics file ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-file-descrption":{"description":"Returns file metadata such as fileName, fileId in a JSON format.","style":"simple","schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/metrics/jobs":{"get":{"tags":["Project analytics"],"summary":"Obtain job metrics that match specific criteria","description":"This method returns metrics for a single or multiple jobs in a project. Job metrics list all the different types of matches with corresponding segment, word and character counts, and are divided into workflow steps.See [API resources](#tag/Definitions) for description of match types.","operationId":"findJobsMetrics","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"jobIds","in":"query","description":"Job IDs.","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSJobMetricsResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/proposal":{"get":{"tags":["Project"],"summary":"Obtain project estimates","description":"This method returns estimates for a specified project.","operationId":"findProposal","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectEstimatesResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}],"x-code-samples":[{"lang":"JavaScript","source":"let projectEstimates;\nfunction getProjectEstimates(token){\n const projectId = 0;\n const url = baseURL + '/projects/' + projectId + '/proposal';\n const params = {\n headers: {\"Authorization\": token},\n method: 'GET',\n };\n \n fetch(url, params)\n .then(response => response.json())\n .then(json => getEstimates(json));\n}\nfunction getEstimates(json) {\n projectEstimates = json;\n}"},{"lang":"C#","source":"public void GetProjectEstimates(string token)\n{\n int projectId = 0;\n string URL = baseURL + string.Format(\"/projects/{0}/proposal\", projectId);\n try\n {\n HttpWebRequest request = (HttpWebRequest) WebRequest.Create(URL);\n request.Method = \"GET\";\n request.Headers.Add(\"Authorization\", \"XTM-Basic \" + token);\n\n HttpWebResponse response = request.GetResponse() as HttpWebResponse;\n \n StreamReader reader = new StreamReader(response.GetResponseStream());\n \n ProjectEstimates projEstimates = JsonConvert\n .DeserializeObject(reader.ReadToEnd());\n \n reader.Close();\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n }\n}\n\npublic class ProjectEstimates\n{\n public string currency { get; set; }\n public string deliveryDate { get; set; } \n public float price { get; set; }\n public int projectId { get; set; }\n public float taxPrice { get; set; }\n}"}]}},"/projects/{projectId}/reanalyze":{"post":{"tags":["Project activity"],"summary":"Reanalyze project","description":"This method starts the project reanalysis.\n

    Reanalysis can cause changes to the project:

    \n
      \n
    • Metrics and TM matching will be recalculated.
      • \n
    • Target segment comments added in XTM Workbench will be deleted.
      • \n
    • Workflow allocations will remain unchanged.
      • \n
    • Statistics will remain unchanged if the “Project is reanalysed” option is selected in Configuration > Data > Estimates > Cost settings > Automation of continuous projects.
      • \n
    • Any generated offline files will be deleted from the History.
      • \n
    • If machine translation has been enabled for the project, all segments that qualify for it will be resent to the MT engine.
      • \n
    \n","operationId":"reanalyzeProject","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64","description":"Project ID."}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectsReanalyzeRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectsReanalyzeResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/statistics":{"get":{"tags":["Project analytics"],"summary":"Obtain statistics that match specific criteria","description":"This method returns statistics for a single or multiple target languages. Project statistics list all the different types of matches processed by users in jobs divided by workflow steps. The method returns source and target statistics. Source statics are calculated as the number of words or characters processed compared to the source text. Target statics represent the number of the resultant words or characters. See [API resources](#tag/Definitions) for description of match types.","operationId":"findProjectStatistics","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"fetchType","in":"query","description":"Fetch type.","required":false,"schema":{"type":"string","default":"ALL","enum":["ALL","ONLY_COMPLETED_JOBS","COMPLETED_AND_DELETED_JOBS","ONLY_COMPLETED_STEPS","COMPLETED_AND_DELETED_STEPS"]}},{"name":"targetLanguages","in":"query","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","example":"en_GB","items":{"type":"string"}}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSLanguageStatisticsResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/statistics/edc":{"get":{"tags":["Project analytics"],"summary":"Obtain EDC score (Beta)","description":"This method returns an edit distance calculation for a finished project. The score is only calculated for the segments which have EDC set. Scores can also be returned at job level.\n\nThis method is currently in Beta. Your feedback is welcome!","operationId":"obtainEdcScore","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"fetchLevel","in":"query","description":"Indicates the EDC level that is fetched.","required":false,"schema":{"type":"string","enum":["JOBS"]}},{"name":"statisticsFetchType","in":"query","description":"Defines whether statistics removed by the phase costs mechanism should be included in the response.","required":false,"schema":{"type":"string","enum":["DELETED"]}},{"name":"edcScoreType","in":"query","description":"Indicates what type of EDC score should be returned in the response.","required":false,"schema":{"type":"string","default":"AVERAGE","enum":["AVERAGE"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSObtainEdcScoreResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/status":{"get":{"tags":["Project states"],"summary":"Obtain project status","description":"This method returns the status of a specified project. There are four levels of response: project, jobs and workflow steps.\n\nWhen the fetchLevel parameter is not set, only the project status is returned.\n\nWhen the fetchLevel parameter is set to **JOBS**, the project status is returned together with individual statuses for all jobs.\n\nWhen the fetchLevel parameter is set to **STEPS**, the project status is returned together with individual statuses for all jobs and their active workflow steps.\n\nWhen the fetchLevel parameter is set to **BUNDLES**, the project status is returned together with individual statuses for all jobs, their active workflow steps and bundles.","operationId":"checkProjectStatuses","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"bundleIds","in":"query","description":"Bundle IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"displayStepNames","in":"query","description":"Workflow display step names. This name is used as a label in the UI.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fetchLevel","in":"query","description":"Fetch level of statuses.","required":false,"schema":{"type":"string","description":"Fetch levels for obtaining project statuses.","enum":["JOBS","STEPS","BUNDLES"]}},{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"stepNames","in":"query","description":"Workflow step names. This field is deprecated. Use `displayStepNames` or `stepReferenceNames`.","required":false,"deprecated":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"stepReferenceNames","in":"query","description":"Workflow reference step names.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"targetLanguages","in":"query","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","example":"en_GB","items":{"type":"string"}}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectStatusResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}],"x-code-samples":[{"lang":"JavaScript","source":"let projectInfo;\n\nfunction getProjectStatus(token){\n const projectId = 0;\n const url = baseURL + '/projects/' + projectId + '/status';\n const params = {\n headers: {\"Authorization\": token},\n method: 'GET',\n };\n fetch(url, params)\n .then(response => response.json())\n .then(json => getProjectInfo(json));\n}\n\nfunction getProjectInfo(json) {\n projectInfo = json;\n}"},{"lang":"C#","source":"public void GetProjectStatus(string token)\n{\n int projectId = 0;\n string URL = baseURL + string.Format(\"/projects/{0}/status?fetchLevel=STEPS\", projectId);\n try\n {\n HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL);\n request.Method = \"GET\";\n request.Headers.Add(\"Authorization\", \"XTM-Basic \" + token);\n\n HttpWebResponse response = request.GetResponse() as HttpWebResponse;\n StreamReader reader = new StreamReader(response.GetResponseStream());\n ProjectInfo projInfo = JsonConvert.DeserializeObject(reader.ReadToEnd());\n reader.Close();\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n }\n}\npublic class ProjectInfo\n{\n public string activity { get; set; }\n public string completionStatus { get; set; }\n public List jobs { get; set; }\n public int projectId { get; set; }\n public string sourceLanguage { get; set; }\n}\npublic class JobInfo\n{\n public string completionStatus { get; set; }\n public string fileName { get; set; }\n public int jobId { get; set; }\n public List steps { get; set; }\n public string targetLanguage { get; set; }\n}\npublic class StepInfo\n{\n public string autoStatus { get; set; }\n public string status { get; set; }\n public string workflowStepName { get; set; }\n}"}]}},"/projects/{projectId}/target-languages":{"post":{"tags":["Project"],"summary":"Add target languages","description":"This method adds new target languages to project.","operationId":"addTargetLanguages","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectTargetLanguagesAddRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectTargetLanguagesAddResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}],"x-code-samples":[{"lang":"JavaScript","source":"function addTargetLanguages(token){\n const projectId = 0;\n const url = baseURL + '/projects/' + projectId + '/target-languages';\n var data = JSON.stringify({\n \"targetLanguages\": [\n \"fr_FR\",\"de_DE\"\n ]\n });\n const myHeaders = new Headers();\n myHeaders.append('Authorization', token);\n myHeaders.append('Content-Type','application/json');\n\n const params = {\n headers: myHeaders,\n method: 'POST',\n body: data\n };\n fetch(url, params);\n}"},{"lang":"C#","source":"public void AddTargetLanguages(string token)\n{\n int projectId = 0;\n string URL = baseURL + string.Format(\"/projects/{0}/target-languages\", projectId);\n TargetLanguages targetLangs = new TargetLanguages\n {\n targetLanguages = new string[] { \"fr_FR\" }\n };\n var data = Encoding.ASCII.GetBytes(JsonConvert.SerializeObject(targetLangs));\n\n try\n {\n HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL);\n request.Method = \"POST\";\n request.Headers.Add(\"Authorization\", \"XTM-Basic \" + token);\n request.ContentType = \"application/json\";\n request.ContentLength = data.Length;\n Stream newStream = request.GetRequestStream();\n newStream.Write(data, 0, data.Length);\n newStream.Close();\n\n HttpWebResponse response = request.GetResponse() as HttpWebResponse;\n StreamReader reader = new StreamReader(response.GetResponseStream());\n CreatedJobsInfo createdJobsInfo = JsonConvert.DeserializeObject(reader.ReadToEnd());\n reader.Close();\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n } \n}\npublic class TargetLanguages\n{\n public string[] targetLanguages { get; set; }\n} \npublic class CreatedJobsInfo\n{\n public List jobs { get; set; }\n public int projectId { get; set; }\n public string projectName { get; set; }\n}\npublic class Job\n{\n public string fileName { get; set; }\n public int jobId { get; set; }\n public string sourceLanguage { get; set; }\n public string targetLanguage { get; set; }\n}"}]},"delete":{"tags":["Project"],"summary":"Delete target languages","description":"This method deletes target languages from project. This method can not be used to delete: all target languages or preprocessing language.","operationId":"deleteTargetLanguages","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectTargetLanguagesDeleteRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectTargetLanguagesDeleteResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/users":{"get":{"tags":["Project workflows"],"summary":"Obtain project users","description":"This method returns users who take part in the project.","operationId":"getProjectUsers","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectUsersResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/word-count":{"get":{"tags":["Project analytics"],"summary":"Obtain total number of words deducted","description":"This method returns the total number of words deducted from the license for a project and the jobs in it.","operationId":"getTotalWordCount","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectWordCountResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/workflow":{"get":{"tags":["Project workflows"],"summary":"Obtain workflows","description":"This method can be used to obtain workflows used in a project.","operationId":"obtainWorkflows","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"targetLanguages","in":"query","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","example":"en_GB","items":{"type":"string"}}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectObtainWorkflowResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"put":{"tags":["Project workflows"],"summary":"Update workflow steps","description":"This method can be used to update steps in the workflow. Subcontractor has limited step options available, as described below. ","operationId":"updateWorkflowSteps","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowUpdatePutRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowUpdateStepsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"post":{"tags":["Project workflows"],"summary":"Add steps to workflow","description":"This method can be used to add new steps to the workflow. Subcontractor has limited step options available, as described below. ","operationId":"addWorkflowStep","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowAddStepsRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowAddStepsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"delete":{"tags":["Project workflows"],"summary":"Delete steps from workflow","description":"This method can be used to delete steps from the workflow.","operationId":"deleteWorkflowStep","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowDeleteStepsRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowDeleteStepsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"patch":{"tags":["Project workflows"],"summary":"Update workflow steps","description":"This method can be used to update steps in the workflow. Subcontractor has limited step options available, as described below. ","operationId":"updateWorkflowSteps_1","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowUpdatePatchRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowUpdateStepsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/workflow/assign":{"post":{"tags":["Project workflows"],"summary":"Assign users to workflow","description":"This method allows for user assignment to a single project at once, but will cover all levels on which the assignment can happen: language/job/step/bundle","operationId":"assignUser","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workflowState","in":"query","description":"Workflow state required for user assignment.\n\nACTIVE: Allows user assignment only for active workflows.\n\nACTIVE_AND_FINISHED: Allows user assignment for active and finished workflows.","required":false,"schema":{"type":"string","default":"ACTIVE","enum":["ACTIVE","ACTIVE_AND_FINISHED"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectWorkflowAssignment"}}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowUserAssignmentResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectWorkflowAssignmentResponse"}}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/workflow/assignment":{"get":{"tags":["Project workflows"],"summary":"Obtain workflow assignments that match specific criteria","description":"This method returns workflow assignments in the selected project.","operationId":"getAssignment","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"page","in":"query","description":"Page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of elements listed on page.","required":false,"schema":{"type":"integer","format":"int32","default":100,"maximum":1000}},{"name":"targetLanguages","in":"query","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","example":"en_GB","items":{"type":"string"}}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-page-size":{"description":"Returns the number of jobs that can be listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}},"xtm-total-items-count":{"description":"Returns the number of jobs matching the criteria.","style":"simple","schema":{"type":"integer "}},"xtm-page":{"description":"Returns the currently displayed page number.","style":"simple","schema":{"type":"integer "}},"xtm-page-items-count":{"description":"Returns the number of jobs listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSAssignmentResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/workflow/finish":{"post":{"tags":["Project workflows"],"summary":"Move jobs to next workflow step","description":"This method finishes active workflow steps and moves jobs to the next step. This happens regardless of whether the jobs are all in the same step or different workflow steps.\n\nWhen job Ids are specified, only the specified jobs are moved forward. When job Ids are not specified, all jobs are moved forward in the workflow.","operationId":"finishWorkflow","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"mailing","in":"query","description":"Specifies whether email notifications will be sent when an action has been completed.","required":false,"schema":{"type":"string","default":"ENABLED","enum":["ENABLED","DISABLED"]}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowFinishResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}],"x-code-samples":[{"lang":"JavaScript","source":"function moveJobsToNextStep(token){\n const projectId = 0;\n const url = baseURL + '/projects/' + projectId + '/workflow/finish';\n const params = {\n headers: {\"Authorization\": token},\n method: 'POST',\n };\n fetch(url, params);\n}"},{"lang":"C#","source":"public void MoveJobsToNextStep(string token)\n{\n int projectId = 0; \n string URL = baseURL + string.Format(\"/projects/{0}/workflow/finish\", projectId);\n \n try\n { \n HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL);\n request.Method = \"POST\";\n request.Headers.Add(\"Authorization\", \"XTM-Basic \" + token);\n \n HttpWebResponse response = request.GetResponse() as HttpWebResponse;\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n }\n}"}]}},"/projects/{projectId}/workflow/jobs":{"patch":{"tags":["Project workflows"],"summary":"Update workflow for project jobs","description":"This method can be used to update workflow definition for jobs.","operationId":"patchJobsWorkflow","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"JSON format data to update, contains objects with workflow and job id.","items":{"$ref":"#/components/schemas/RSProjectJobsWorkflowPatchRequest"}}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectJobsWorkflowPatchResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/workflow/reject":{"post":{"tags":["Project workflows"],"summary":"Move jobs to previous workflow step","description":"This method moves jobs from the active workflow step to the previous one.","operationId":"rejectWorkflow","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"mailing","in":"query","description":"Specifies whether email notifications will be sent when an action has been completed.","required":false,"schema":{"type":"string","default":"ENABLED","enum":["ENABLED","DISABLED"]}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowRejectResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}],"x-code-samples":[{"lang":"JavaScript","source":"function moveJobsToPrevStep(token){\n const projectId = 0;\n const url = baseURL + '/projects/' + projectId + '/workflow/reject';\n const params = {\n headers: {\"Authorization\": token},\n method: 'POST',\n };\n fetch(url, params);\n}"},{"lang":"C#","source":"public void MoveJobsToPrevStep(string token)\n{\n int projectId = 0;\n string URL = baseURL + string.Format(\"/projects/{0}/workflow/reject\", projectId);\n \n try\n { \n HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL);\n request.Method = \"POST\";\n request.Headers.Add(\"Authorization\", \"XTM-Basic \" + token);\n \n HttpWebResponse response = request.GetResponse() as HttpWebResponse;\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n } \n}"}]}},"/projects/{projectId}/workflow/reopen":{"post":{"tags":["Project workflows"],"summary":"Reopen workflow","description":"This method reopens workflows for finished projects, languages, or jobs","operationId":"reopenWorkflow","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSReopenWorkflowRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSReopenWorkflowResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/projects/{projectId}/workflow/start":{"post":{"tags":["Project workflows"],"summary":"Start workflow in project","description":"This method activates the first workflow step for all the jobs in the project. The translators can then start their tasks.","operationId":"startWorkflow","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"jobIds","in":"query","description":"Job IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"targetLanguages","in":"query","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","example":"en_GB","items":{"type":"string"}}},{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowStartResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}],"x-code-samples":[{"lang":"JavaScript","source":"function startWorkflow(token){\n const projectId = 0;\n const url = baseURL + '/projects/' + projectId + '/workflow/start';\n const params = {\n headers: {\"Authorization\": token},\n method: 'POST',\n };\n fetch(url, params);\n}"},{"lang":"C#","source":"public void StartWorkflow(string token)\n{\n int projectId = 0;\n string URL = baseURL + string.Format(\"/projects/{0}/workflow/start\", projectId);\n \n try\n { \n HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL);\n\t\trequest.Method = \"POST\";\n request.Headers.Add(\"Authorization\", \"XTM-Basic \" + token);\n\n HttpWebResponse response = request.GetResponse() as HttpWebResponse;\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex.Message);\n }\n}"}]}},"/projects/{projectId}/workflow/unassign":{"post":{"tags":["Project workflows"],"summary":"Unassign users from workflow","description":"This method allows for user unassignment from a single project at once, but will cover all levels on which the unassignment can happen: language/job/step/bundle","operationId":"unassignUser","parameters":[{"name":"projectId","in":"path","description":"Project ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workflowState","in":"query","description":"ACTIVE: Allows user unassignment only for active workflows.\n\nACTIVE_AND_FINISHED: Allows user unassignment for active and finished workflows.","required":false,"schema":{"type":"string","default":"ACTIVE","enum":["ACTIVE","ACTIVE_AND_FINISHED"]}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectWorkflowUnassignment"}}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSProjectWorkflowUserUnassignmentResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectWorkflowAssignmentResponse"}}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/projects/{projectId}/workflows/time-trackings/jobs":{"get":{"tags":["Project workflows"],"summary":"Manual time trackings jobs","description":"This method returns manual time trackings for all jobs in project.","operationId":"getTimeTrackingsJobs","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"targetLanguages","in":"query","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","required":false,"schema":{"type":"array","example":"en_GB","items":{"type":"string"}}},{"name":"page","in":"query","description":"Page number.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of elements listed on page.","required":false,"schema":{"type":"integer","format":"int32","default":100}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-page-size":{"description":"Returns the number of jobs that can be listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}},"xtm-total-items-count":{"description":"Returns the number of jobs matching the criteria.","style":"simple","schema":{"type":"integer "}},"xtm-page":{"description":"Returns the currently displayed page number.","style":"simple","schema":{"type":"integer "}},"xtm-page-items-count":{"description":"Returns the number of jobs listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTimeTrackingsJobsResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/tag-groups/{tagGroupId}":{"get":{"tags":["Tag groups"],"summary":"Obtain tag group","description":"This method returns tag group.","operationId":"getTagGroup","parameters":[{"name":"tagGroupId","in":"path","description":"Tag group ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagGroupGetResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"put":{"tags":["Tag groups"],"summary":"Update tag group","description":"This method replaces existing tag group resource with the provided one. ","operationId":"putTagGroup","parameters":[{"name":"tagGroupId","in":"path","description":"Tag group ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagGroupPutRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagGroupPutResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"delete":{"tags":["Tag groups"],"summary":"Delete tag group","description":"This method deletes tag group.","operationId":"deleteTagGroup","parameters":[{"name":"tagGroupId","in":"path","description":"Tag group ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagGroupDeleteResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"patch":{"tags":["Tag groups"],"summary":"Update tag group","description":"This method updates existing tag group resource fields with provided ones. ","operationId":"patchTagGroup","parameters":[{"name":"tagGroupId","in":"path","description":"Tag group ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagGroupPatchRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagGroupPatchResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/tag-groups/{tagGroupId}/tags/{tagId}":{"get":{"tags":["Tag"],"summary":"Obtain tags that match specific criteria","description":"This method returns tags.","operationId":"obtainTagGroup","parameters":[{"name":"tagGroupId","in":"path","description":"Tag group ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tagId","in":"path","description":"Tag ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagGetResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"put":{"tags":["Tag"],"summary":"Update tag","description":"This method replaces existing tag resource with the provided one. ","operationId":"putTag","parameters":[{"name":"tagGroupId","in":"path","description":"Tag group ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tagId","in":"path","description":"Tag ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagPutRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagPutResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"delete":{"tags":["Tag"],"summary":"Delete tag","description":"This method deletes tag.","operationId":"deleteTag","parameters":[{"name":"tagGroupId","in":"path","description":"Tag group ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tagId","in":"path","description":"Tag ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagDeleteResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]},"patch":{"tags":["Tag"],"summary":"Update tag","description":"This method updates existing tag resource fields with provided ones. ","operationId":"patchTagParam","parameters":[{"name":"tagGroupId","in":"path","description":"Tag group ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tagId","in":"path","description":"Tag ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagPatchRequest"}}}},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTagPatchResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}},"/templates":{"post":{"tags":["Project templates"],"summary":"Create new project template","operationId":"createTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCreateTemplateRequest"}}}},"responses":{"201":{"description":"Resource successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCreateTemplateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/terminology":{"delete":{"tags":["Terminology"],"summary":"Delete terminology","description":"This method starts the process of terminology deletion based on selected parameters. User has to provide a request body to perform the operation.","operationId":"deleteTerminology","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteTermRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteTermResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["customer_pm","term_expert"]}]}},"/terminology/files/export/{fileId}/download":{"get":{"tags":["Terminology export"],"summary":"Download exported terminology file","description":"This method downloads exported terminology file based on it's ID.\n\nThe response is generated in the application/octet-stream format as a ZIP file.","operationId":"downloadTerminologyFile","parameters":[{"name":"fileId","in":"path","description":"File ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-file-descrption":{"description":"Returns file metadata such as fileName, fileId in a JSON format.","style":"simple","schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"403":{"description":"Forbidden operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["customer_pm","term_expert"]}]}},"/terminology/files/export/{fileId}/status":{"get":{"tags":["Terminology export"],"summary":"Check terminology file export status","description":"This method checks the status of a terminology file export process.","operationId":"checkExportStatus","parameters":[{"name":"fileId","in":"path","description":"File ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCheckExportStatusResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["term_expert","customer_pm"]}]}},"/terminology/files/import/status":{"get":{"tags":["Terminology import"],"summary":"Check terminology file import status","description":"This method checks the status of a terminology file import process.","operationId":"checkImportStatus_1","parameters":[{"name":"fileIds","in":"query","description":"File IDs.","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCheckTermImportStatusResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["term_expert","customer_pm"]}]}},"/translation-memory/files/import/status":{"get":{"tags":["Translation memory import"],"summary":"Check TM files import statuses","description":"This method checks the statuses of a translation-memory file import process.","operationId":"checkImportStatus","parameters":[{"name":"fileIds","in":"query","description":"File ID's.","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSCheckTMImportStatusResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["customer_pm","tm_expert"]}]}},"/translation-memory/files/{fileId}/download":{"get":{"tags":["Translation memory export"],"summary":"Download generated TM file","description":"This method downloads a generated TM file based on its ID.\n\nThe response is generated in the application/octet-stream format as a ZIP file.","operationId":"downloadTMFile","parameters":[{"name":"fileId","in":"path","description":"File ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","headers":{"xtm-file-descrption":{"description":"Returns file metadata such as fileName, fileId in a JSON format.","style":"simple","schema":{"type":"string"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm","tm_expert"]}]}},"/translation-memory/files/{fileId}/status":{"get":{"tags":["Translation memory export"],"summary":"Check TM file status","description":"This method returns a TM file's generation status.","operationId":"getTmFileStatus","parameters":[{"name":"fileId","in":"path","description":"File ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSTMFileStatusResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm","tm_expert"]}]}},"/users/search":{"post":{"tags":["User"],"summary":"Advanced obtain users that match specific criteria","description":"This method returns users that match the specified advanced search parameters.","operationId":"advancedSearchUsers","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSAdvancedUserSearchRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","headers":{"xtm-page-size":{"description":"Returns the number of users that can be listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}},"xtm-total-items-count":{"description":"Returns the number of users matching the criteria.","style":"simple","schema":{"type":"integer "}},"xtm-page":{"description":"Returns the currently displayed page number.","style":"simple","schema":{"type":"integer "}},"xtm-page-items-count":{"description":"Returns the number of users listed in the currently displayed page.","style":"simple","schema":{"type":"integer "}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSAdvancedUserSearchResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","administrator"]}]}},"/users/{userId}":{"put":{"tags":["User"],"summary":"Update user","description":"This method replaces existing user with the provided one.","operationId":"putUser","parameters":[{"name":"userId","in":"path","description":"User's ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUserPutRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUserUpdateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"patch":{"tags":["User"],"summary":"Update user","description":"This method updates existing user fields with provided ones.","operationId":"patchUser","parameters":[{"name":"userId","in":"path","description":"User's ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUserPatchRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSUserUpdateResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/users/{userId}/access-rights/roles":{"get":{"tags":["User access rights"],"summary":"Obtain user's roles","description":"This method returns user's roles.","operationId":"getUserRoles","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSGetUserRolesResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"post":{"tags":["User access rights"],"summary":"Add user's roles","description":"This method adds roles for a user.","operationId":"postUserRoles","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPostUserRolesRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSPostUserRolesResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]},"delete":{"tags":["User access rights"],"summary":"Delete user's roles","description":"This method deletes user's roles.","operationId":"deleteUserRoles","parameters":[{"name":"userId","in":"path","description":"User ID.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteUserRolesRequest"}}},"required":true},"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSDeleteUserRolesResponse"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm"]}]}},"/workflows/steps":{"get":{"tags":["Workflow"],"summary":"Obtain workflow steps that match specific criteria","description":"This method returns workflow steps that match the specified search parameters.","operationId":"findWorkflowSteps","parameters":[{"name":"Authorization","in":"header","description":"The request header must contain one of these Authorization types:\n\n\"Authorization: XTM-Basic XXXXX\", where “XXXXX“ stands for your token. If you do not have a token, obtain it using the [authentication method.](#tag/XTM-Basic)\n\n\"Authorization: Bearer XXXXX\", where “XXXXX“ stands for your OAuth 2.0 token. For details about OAuth tokens, see [the OAuth 2.0 section.](#tag/OAuth-2.0)","required":true,"schema":{"type":"string"}},{"name":"activity","in":"query","description":"Allowed workflow steps activity.","required":false,"schema":{"type":"string","default":"ACTIVE","enum":["ACTIVE","ALL"]}},{"name":"ids","in":"query","description":"Workflow step IDs.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Operation completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RSWorkflowStepDefinitionResponse"}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RSErrorResponse"}}}}},"security":[{"Roles":["pm","customer_pm"]}]}}},"components":{"schemas":{"RSUserAddress":{"type":"object","description":"User's address","properties":{"address1":{"type":"string","description":"Address part 1."},"address2":{"type":"string","description":"Address part 2."},"city":{"type":"string","description":"City."},"state":{"type":"string","description":"State."},"postCode":{"type":"string","description":"Post code."},"country":{"type":"string","description":"Country 3-letter code.","enum":["AFG","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BIH","BWA","BRA","VGB","BRN","BGR","BFA","BDI","KHM","CMR","CAN","CPV","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COK","CRI","HRV","CUB","CYP","CZE","COG","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","ETH","FRO","FLK","FJI","FIN","FRA","GUF","PYF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GIN","GNB","GUY","HTI","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","ISR","ITA","CIV","JAM","JPN","JOR","KAZ","KEN","KIR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MKD","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","ANT","NCL","NZL","NIC","NER","NGA","NIU","NFK","PRK","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","POL","PRT","PRI","QAT","COD","REU","ROU","RUS","RWA","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SVK","SVN","SLB","SOM","ZAF","KOR","ESP","LKA","SHN","KNA","LCA","SPM","VCT","SDN","SUR","SWZ","SWE","CHE","SYR","TWN","TJK","TZA","THA","TGO","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","URY","UZB","VUT","VAT","VEN","VNM","WLF","ESH","YEM","ZMB","ZWE"]},"phone":{"type":"string","description":"Phone number."},"phone2":{"type":"string","description":"Second phone number"},"mobilePhone":{"type":"string","description":"Mobile phone number."},"website":{"type":"string","description":"Website url."},"vatNumber":{"type":"string","description":"Vat number"},"skype":{"type":"string","description":"Skype address"},"msn":{"type":"string","description":"Msn address."},"fax":{"type":"string","description":"Fax."}}},"RSUserPutRequest":{"type":"object","description":"Request fields for user update","properties":{"username":{"type":"string","description":"User's username."},"firstName":{"type":"string","description":"User's first name."},"lastName":{"type":"string","description":"User's last name."},"nickname":{"type":"string","description":"User's nickname."},"password":{"type":"string","description":"User's password."},"userTitle":{"type":"string","description":"User's title.","enum":["MR","MRS","MS","MISS","DR"]},"currency":{"type":"string","description":"User's currency. See [API resources](#tag/Currencies) for full list of available currencies.","x-example":"en_GB"},"email":{"type":"string","description":"User's email."},"availability":{"type":"string","description":"User's availability.","enum":["AVAILABLE","UNAVAILABLE"]},"address":{"$ref":"#/components/schemas/RSUserAddress"}},"required":["email","firstName","lastName","nickname","password","username"]},"RSUserUpdateResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User's ID."},"username":{"type":"string","description":"User's username."},"firstName":{"type":"string","description":"User's first name."},"lastName":{"type":"string","description":"User's last name."},"nickname":{"type":"string","description":"User's nickname."},"userTitle":{"type":"string","description":"User's title.","enum":["MR","MRS","MS","MISS","DR"]},"currency":{"type":"string","description":"User's currency. See [API resources](#tag/Currencies) for full list of available currencies.","x-example":"en_GB"},"email":{"type":"string","description":"User's email."},"availability":{"type":"string","description":"User's availability.","enum":["AVAILABLE","UNAVAILABLE"]},"address":{"$ref":"#/components/schemas/RSUserAddress"}}},"RSErrorResponse":{"type":"object","properties":{"reason":{"type":"string"}}},"RSTagGroupPutRequest":{"type":"object","description":"JSON format data with entity used to replace existing tag group.","properties":{"name":{"type":"string"},"customerSelectionType":{"type":"string","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"required":["name"]},"RSTagGroupPutResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"customerSelectionType":{"type":"string","description":"Type of customer selection. The `ALL_CUSTOMERS` value indicates that all available customers from your XTM Cloud instance are assigned to the relevant tag group.","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}},"tagIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"RSTagPutRequest":{"type":"object","description":"JSON format data with entity used to replace existing tag.","properties":{"name":{"type":"string"},"customerSelectionType":{"type":"string","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"required":["name"]},"RSTagPutResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"customerSelectionType":{"type":"string","description":"Type of customer selection. The `ALL_CUSTOMERS` value indicates that all customers from the tag group are assigned to the relevant tag.","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"RSCustomerSettings":{"type":"object","properties":{"selectionType":{"type":"string","description":"Specify which additional customer resources should be used: terminology, translation memory, or both.
    If you select one of the “ALL” options, the “ids” field values are not considered and all customers to whom the relevant PM has access are selected automatically.
    If you select one of the “SELECTED” options, enter their IDs in the “ids” field.
    Default customer’s ID is always provided for both terminology and translation memory.","enum":["TM_SELECTED","TM_ALL","TERM_SELECTED","TERM_ALL","TM_AND_TERM_SELECTED","TM_AND_TERM_ALL"]},"ids":{"type":"array","description":"IDs of customer(s) whose resources are to be used.","items":{"type":"integer","format":"int64"}}}},"RSProjectUpdateRequest":{"type":"object","description":"JSON format data to update project.","properties":{"name":{"type":"string","description":"Name\nProject name cannot contain any of the following characters: , /, :, *, ?, \", <, >, |, {, }, [TAB].","maxLength":100,"minLength":1},"description":{"type":"string","description":"Description"},"referenceId":{"type":"string","description":"Reference ID"},"paymentStatus":{"type":"string","description":"Payment status","enum":["NOT_REQUIRED","PAID","WAITING_FOR_PAYMENT"]},"proposalApprovalStatus":{"type":"string","description":"Proposal approval status","enum":["NOT_CONFIRMED","CONFIRMED","NOT_REQUIRED"]},"projectManagerId":{"type":"integer","format":"int64","description":"Project manager ID"},"subjectMatterId":{"type":"integer","format":"int64","description":"Subject matter ID"},"segmentLockingType":{"type":"string","description":"DISABLED - disables this option
    ANY_100_MATCH - segments with approved and not approved leveraged or ICE matches will be locked
    APPROVED_100_MATCH - segments with approved leveraged or ICE matches will be locked
    XLIFFDOC_TRANSLATED, XLIFFDOC_PROOFED, XLIFFDOC_VALIDATED - segments with a specific xliff:doc status will be locked","enum":["DISABLED","ANY_100_MATCH","APPROVED_100_MATCH","XLIFFDOC_TRANSLATED","XLIFFDOC_PROOFED","XLIFFDOC_VALIDATED"]},"translationMemory":{"$ref":"#/components/schemas/RSTranslationMemoryOptions","description":"Translation memory options."},"terminology":{"$ref":"#/components/schemas/RSTerminologyOptions","description":"Terminology options."},"customerSettings":{"$ref":"#/components/schemas/RSCustomerSettings","description":"Settings related to terminology and translation memory customers."}}},"RSTerminologyOptions":{"type":"object","properties":{"penaltyProfileId":{"type":"integer","format":"int64","description":"Terminology options penalty profile id."},"tagIds":{"type":"array","description":"List of terminology tag ids.","items":{"type":"integer","format":"int64"}}}},"RSTranslationMemoryOptions":{"type":"object","properties":{"penaltyProfileId":{"type":"integer","format":"int64","description":"Translation memory penalty profile id."},"languageVariantsPenaltyProfileId":{"type":"integer","format":"int64","description":"Translation memory language variant penalty profile id."},"tagIds":{"type":"array","description":"List of translation memory tag ids.","items":{"type":"integer","format":"int64"}}}},"RSProjectUpdateResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Informs whether project update was successful or not.","example":true}}},"RSProjectWorkflowUpdatePutRequest":{"type":"object","description":"JSON format data to update workflow steps.","properties":{"jobIds":{"type":"array","description":"Job ID.","items":{"type":"integer","format":"int64"}},"id":{"type":"string","description":"Workflow ID. The ID can be obtained from the [obtain workflows method](#tag/Project-workflows/operation/obtainWorkflows) response.","minLength":1},"targetLanguages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","example":["en_GB"],"items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}},"steps":{"type":"array","description":"Steps to update","items":{"$ref":"#/components/schemas/RSProjectWorkflowUpdateStepPutRequest"},"minItems":1}},"required":["id","steps"]},"RSProjectWorkflowUpdateStepPutRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Step ID."},"name":{"type":"string","description":"Workflow step name."},"dueDate":{"type":"string","description":"Due date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"tmApproval":{"type":"string","default":"DISABLED","description":"Type of TM Approval. Cannot be applied for automatic or offline steps.","enum":["ENABLED","DISABLED"]},"costsCalculationBasedOnManualTime":{"type":"string","default":"DISABLED","description":"Costs calculation based on manual time. Cannot be applied for automatic steps. Only available when manual time tracking is enabled in configuration.","enum":["ENABLED","DISABLED"]},"lqaType":{"type":"string","default":"DISABLED","description":"Type of LQA. Cannot be applied for automatic or offline steps.","enum":["ENABLED_SAVING_RESULTS_FOR_USER","ENABLED_NOT_SAVING_RESULTS_FOR_USER","DISABLED_BUT_SHOW_EXISTING_ERRORS","DISABLED"]},"finishTaskOption":{"type":"string","default":"NONE","description":"Finish task options. Can be specified by subcontractor. Cannot be applied for automatic or offline steps.","enum":["NONE","ALL_SEGMENT_DONE"]},"blockingType":{"type":"string","default":"FULL_BLOCKING","description":"Step blocking type. Can be specified by subcontractor.","enum":["FULL_BLOCKING","PART_BLOCKING","NO_BLOCKING"]}},"required":["id","name"]},"RSProjectWorkflowStepResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Step ID"},"name":{"type":"string","description":"Step name"},"minDueDate":{"type":"string","format":"epoch","description":"Min due date","example":1774765345570},"maxDueDate":{"type":"string","format":"epoch","description":"Max due date","example":1774765345570},"tmApproval":{"type":"string","description":"Type of TM Approval","enum":["ENABLED","DISABLED"]},"costsCalculationBasedOnManualTime":{"type":"string","description":"Costs calculation based on manual time","enum":["ENABLED","DISABLED"]},"lqaType":{"type":"string","description":"Type of LQA","enum":["ENABLED_SAVING_RESULTS_FOR_USER","ENABLED_NOT_SAVING_RESULTS_FOR_USER","DISABLED_BUT_SHOW_EXISTING_ERRORS","DISABLED"]},"finishTaskOption":{"type":"string","description":"Finish task options","enum":["NONE","ALL_SEGMENT_DONE"]},"blockingType":{"type":"string","description":"Step blocking type","enum":["FULL_BLOCKING","PART_BLOCKING","NO_BLOCKING"]}}},"RSProjectWorkflowUpdateStepsResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the workflow"},"name":{"type":"string","description":"Name of the workflow"},"steps":{"type":"array","description":"Descriptors of steps in the workflow","items":{"$ref":"#/components/schemas/RSProjectWorkflowStepResponse"}}}},"RSFileMetadata":{"type":"object","properties":{"value":{"type":"string","description":"Metadata value."},"type":{"type":"string","default":"JSON","description":"Type of metadata.","enum":["JSON"]}}},"RSUpdateJobsFilter":{"type":"object","properties":{"jobIds":{"type":"array","description":"List of project job IDs.","items":{"type":"integer","format":"int64"}},"sourceFileIds":{"type":"array","description":"List of source file IDs.","items":{"type":"integer","format":"int64"}}}},"RSUpdateJobsRequest":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/RSUpdateJobsFilter","description":"When in requested array insert json without jobIds and sourceFileIds, it will update all project jobs(without those specified in the request)."},"tagIds":{"type":"array","description":"List of tag IDs.","items":{"type":"integer","format":"int64"}},"metadata":{"$ref":"#/components/schemas/RSFileMetadata","description":"Metadata for file."}}},"RSUpdateJobsResponse":{},"RSProjectDueDateUpdateRequest":{"type":"object","description":"JSON format data to update, contains objects with step names and due dates.","properties":{"steps":{"type":"array","description":"List of objects that include step names and due dates. `displayStepNames` or `stepReferenceNames` must be provided.","items":{"$ref":"#/components/schemas/RSProjectStepDueDateRequest"}},"jobs":{"type":"array","description":"List of objects that include job ids and due dates. The due dates will be changed only for the job's last workflow step.","items":{"$ref":"#/components/schemas/RSProjectJobDueDateRequest"}},"targetLanguages":{"type":"array","description":"List of objects that include target language codes and due dates. The due dates will be changed only for the language's last workflow step.","items":{"$ref":"#/components/schemas/RSProjectTargetLanguageDueDateRequest"}},"projectDueDate":{"type":"string","description":"Due date of whole project in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details. This value will be changed for all job's last workflow step.","example":"2018-05-18 or 2018-05-18T23:00:00+01:00"},"newSourceDueDate":{"type":"string","description":"Pre processing due date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","example":"2018-05-18 or 2018-05-18T23:00:00+01:00"},"workflowStartDate":{"type":"string","description":"Workflow start date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","example":"2018-05-18 or 2018-05-18T23:00:00+01:00"},"workflowDueDate":{"type":"string","description":"Workflow due date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details.","example":"2018-05-18 or 2018-05-18T23:00:00+01:00"}}},"RSProjectJobDueDateRequest":{"type":"object","description":"Object that contains job ID to update and new due date.","properties":{"id":{"type":"integer","format":"int64","description":"Job ID."},"dueDate":{"type":"string","description":"Due date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"stepName":{"type":"string","deprecated":true,"description":"Step name. This field is deprecated. Use `displayStepName` or `stepReferenceName`"},"displayStepName":{"type":"string","description":"Workflow display step name. This name is used as a label in the UI."},"stepReferenceName":{"type":"string","description":"Workflow step reference name."}}},"RSProjectStepDueDateRequest":{"type":"object","description":"Object that contains name of step to update and new due date.","properties":{"name":{"type":"string","deprecated":true,"description":"Workflow step name, should be provide with order number. This field is deprecated. Use `displayStepName` or `stepReferenceName`."},"displayStepName":{"type":"string","description":"Workflow display step name. This name is used as a label in the UI."},"stepReferenceName":{"type":"string","description":"Workflow step reference name."},"dueDate":{"type":"string","description":"Due date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."}}},"RSProjectTargetLanguageDueDateRequest":{"type":"object","description":"Object that contains target language to update and new due date.","properties":{"languageCode":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."},"dueDate":{"type":"string","description":"Due date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."}},"required":["languageCode"]},"RSProjectDueDateUpdateResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Informs whether workflow step due dates update was successful or not.","example":true}}},"RSExternalUserPutRequest":{"type":"object","description":"JSON format data with entity used to replace existing external user.","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"username":{"type":"string"},"integrationId":{"type":"string"}},"required":["firstName","integrationId","lastName","username"]},"RSExternalUserPutResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"firstName":{"type":"string"},"lastName":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"integrationId":{"type":"string"}}},"RSCustomerAddress":{"type":"object","properties":{"Address part 1.":{"type":"string"},"Address part 2.":{"type":"string"},"City.":{"type":"string"},"State.":{"type":"string"},"Post code.":{"type":"string"},"Country 3-letter code.":{"type":"string","enum":["AFG","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BIH","BWA","BRA","VGB","BRN","BGR","BFA","BDI","KHM","CMR","CAN","CPV","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COK","CRI","HRV","CUB","CYP","CZE","COG","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","ETH","FRO","FLK","FJI","FIN","FRA","GUF","PYF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GIN","GNB","GUY","HTI","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","ISR","ITA","CIV","JAM","JPN","JOR","KAZ","KEN","KIR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MKD","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","ANT","NCL","NZL","NIC","NER","NGA","NIU","NFK","PRK","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","POL","PRT","PRI","QAT","COD","REU","ROU","RUS","RWA","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SVK","SVN","SLB","SOM","ZAF","KOR","ESP","LKA","SHN","KNA","LCA","SPM","VCT","SDN","SUR","SWZ","SWE","CHE","SYR","TWN","TJK","TZA","THA","TGO","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","URY","UZB","VUT","VAT","VEN","VNM","WLF","ESH","YEM","ZMB","ZWE"]},"Phone number.":{"type":"string"},"Mobile phone number.":{"type":"string"},"Website url.":{"type":"string"},"Email address.":{"type":"string"},"Skype address":{"type":"string"},"Msn address.":{"type":"string"},"Fax.":{"type":"string"}}},"RSCustomerUpdateRequest":{"type":"object","description":"JSON format data with fields used to update the resource.","properties":{"name":{"type":"string","maxLength":256,"minLength":1},"nickName":{"type":"string"},"projectManagerId":{"type":"integer","format":"int64"},"accessType":{"type":"string","enum":["ALL","TERM_AND_TM_ONLY"]},"address":{"$ref":"#/components/schemas/RSCustomerAddress"},"projectWatchers":{"type":"array","items":{"type":"integer","format":"int64"}},"vatNumber":{"type":"string"}},"required":["name"]},"RSCustomerUpdateResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"nickName":{"type":"string"},"activity":{"type":"string","enum":["ACTIVE","INACTIVE"]},"address":{"$ref":"#/components/schemas/RSCustomerAddress"},"projectManagerId":{"type":"integer","format":"int64"},"projectWatchers":{"type":"array","items":{"type":"integer","format":"int64"}},"accessType":{"type":"string","enum":["ALL","TERM_AND_TM_ONLY"]},"vatNumber":{"type":"string"}}},"RSPutCallbackPropertyRequest":{"type":"object","properties":{"callbackType":{"type":"string","description":"Callback type.","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]},"propertyScope":{"type":"string","default":"CLIENT","description":"Callback property scope. `CLIENT` indicates that a property is applied for every project that is created. `CUSTOMER` indicates that a property is only applied for a project created for the specified customer.","enum":["CUSTOMER","CLIENT"]},"customerId":{"type":"integer","format":"int64","description":"Customer ID. Required if CUSTOMER propertyScope is set."},"url":{"type":"string","description":"Callback URL address.","minLength":1}},"required":["callbackType","url"]},"RSUpdateCallbackPropertyResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback property ID."},"callbackType":{"type":"string","description":"Callback type.","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]},"propertyScope":{"type":"string","description":"Callback property scope. `CLIENT` indicates that a property is applied for every project that is created. `CUSTOMER` indicates that a property is only applied for a project created for the specified customer.","enum":["CUSTOMER","CLIENT"]},"customerId":{"type":"integer","format":"int64","description":"Customer ID."},"url":{"type":"string","description":"Callback URL address."}}},"RSCallbackBasicDetailsRequest":{"type":"object","properties":{"basicUsername":{"type":"string","description":"Username for basic authentication.","minLength":1},"basicPassword":{"type":"string","description":"Password for basic authentication.","minLength":1}},"required":["basicPassword","basicUsername"]},"RSCallbackOAuth2ClientDetails":{"type":"object","properties":{"clientId":{"type":"string","description":"Client ID for OAuth2 authentication.","minLength":1},"clientSecret":{"type":"string","description":"Client secret for OAuth2 authentication.","minLength":1}},"required":["clientId","clientSecret"]},"RSCallbackOAuth2DetailsRequest":{"type":"object","properties":{"authorizationServerURL":{"type":"string","description":"Authorization server URL for OAuth2 authentication.","minLength":1},"scope":{"type":"string","description":"Scope for OAuth2 authentication."},"clientDetails":{"$ref":"#/components/schemas/RSCallbackOAuth2ClientDetails","description":"Details related to `client_credentials` grant type. Required if CLIENT_CREDENTIALS grantType is set."},"passwordDetails":{"$ref":"#/components/schemas/RSCallbackOAuth2PasswordDetails","description":"Details related to `password` grant type. Required if PASSWORD grantType is set."},"grantType":{"type":"string","description":"Grant type for OAuth2 authentication.","enum":["PASSWORD","CLIENT_CREDENTIALS"]}},"required":["authorizationServerURL","grantType"]},"RSCallbackOAuth2PasswordDetails":{"type":"object","properties":{"username":{"type":"string","description":"Username for OAuth2 authentication.","minLength":1},"password":{"type":"string","description":"Password for OAuth2 authentication.","minLength":1}},"required":["password","username"]},"RSCallbackSignatureDetailsRequest":{"type":"object","properties":{"signatureKey":{"type":"string","description":"Signature key for authentication.","minLength":1},"signatureSecret":{"type":"string","description":"Signature secret for authentication.","minLength":1}},"required":["signatureKey","signatureSecret"]},"RSPutCallbackAuthenticationRequest":{"type":"object","properties":{"name":{"type":"string","description":"Callback authentication name.","minLength":1},"domain":{"type":"string","description":"Callback authentication domain URL address. Required if authenticationScope is DOMAIN."},"authenticationType":{"type":"string","description":" Authentication mechanism that is used by the callback.","enum":["BASIC","SIGNATURE","OAUTH_2"]},"authenticationScope":{"type":"string","default":"DOMAIN","description":"Scope of authentication used for the callback.","enum":["CLIENT","DOMAIN"]},"signatureDetails":{"$ref":"#/components/schemas/RSCallbackSignatureDetailsRequest","description":"Details for SIGNATURE authentication type. Required if SIGNATURE authenticationType is set."},"basicDetails":{"$ref":"#/components/schemas/RSCallbackBasicDetailsRequest","description":"Details for BASIC authentication type. Required if BASIC authenticationType is set."},"oauth2Details":{"$ref":"#/components/schemas/RSCallbackOAuth2DetailsRequest"}},"required":["authenticationType","name"]},"RSCallbackBasicDetails":{"type":"object","properties":{"basicUsername":{"type":"string"}}},"RSCallbackOAuth2Details":{"type":"object","description":"Details for OAUTH_2 authentication type.","properties":{"authorizationServerURL":{"type":"string"},"clientId":{"type":"string"},"username":{"type":"string"},"scope":{"type":"string"},"grantType":{"type":"string"}}},"RSPutCallbackAuthenticationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback authentication ID."},"name":{"type":"string","description":"Callback authentication name."},"domain":{"type":"string","description":"Callback authentication domain URL address."},"authenticationType":{"type":"string","description":" Authentication mechanism that is used by the callback.","enum":["BASIC","SIGNATURE","OAUTH_2"]},"authenticationScope":{"type":"string","description":"Scope of authentication used for the callback.","enum":["CLIENT","DOMAIN"]},"createDate":{"type":"string","format":"epoch","description":"Callback authentication creation date.","example":1774765345570},"basicDetails":{"$ref":"#/components/schemas/RSCallbackBasicDetails","description":"Details for BASIC authentication type."},"oauth2Details":{"$ref":"#/components/schemas/RSCallbackOAuth2Details"}}},"RSUserCreationRequest":{"type":"object","description":"Request fields for user creation","properties":{"username":{"type":"string","description":"User's username."},"firstName":{"type":"string","description":"User's first name."},"lastName":{"type":"string","description":"User's last name."},"nickname":{"type":"string","description":"User's nickname."},"password":{"type":"string","description":"User's password."},"userTitle":{"type":"string","description":"User's title.","enum":["MR","MRS","MS","MISS","DR"]},"currency":{"type":"string","description":"User's currency. See [API resources](#tag/Currencies) for full list of available currencies.","x-example":"en_GB"},"email":{"type":"string","format":"email","description":"User's email."},"availability":{"type":"string","default":"AVAILABLE","description":"User's availability.","enum":["AVAILABLE","UNAVAILABLE"]},"address":{"$ref":"#/components/schemas/RSUserAddress"},"subjectMatterIds":{"type":"array","description":"User's subject matters IDs.","items":{"type":"integer","format":"int64"}},"languageCombinations":{"type":"array","description":"User's language combinations","items":{"$ref":"#/components/schemas/RSUserLanguageCombination"}},"roleIds":{"type":"array","description":"User's roles IDs.","items":{"type":"integer","format":"int64"}},"termRights":{"type":"array","description":"User's terminology rights.","items":{"type":"string","enum":["EXPORT","IMPORT","ADD","VIEW","MODIFY","UPDATE_APPROVE","DELETE","SUGGEST"]}},"tmRights":{"type":"array","description":"User's TM rights.","items":{"type":"string","enum":["EXPORT","IMPORT","VIEW","MODIFY","MODIFY_UPDATE_ONLY","DELETE","ALIGN"]}},"projectVisibility":{"type":"string","default":"ALL","description":"Defines whether user can see projects created by other people.","enum":["OWN","ALL"]},"qualifications":{"type":"array","description":"User's qualifications.","items":{"$ref":"#/components/schemas/RSUserQualification"}},"workflowStepIds":{"type":"array","description":"User's worfklow steps IDs.","items":{"type":"integer","format":"int64"}},"customers":{"$ref":"#/components/schemas/RSUserCustomers"},"tmCustomers":{"$ref":"#/components/schemas/RSUserTmCustomers"},"termCustomers":{"$ref":"#/components/schemas/RSUserTermCustomers"}},"required":["currency","email","firstName","lastName","nickname","password","roleIds","username"]},"RSUserCustomers":{"type":"object","description":"User's customers.","properties":{"selectionType":{"type":"string","default":"ALL","description":"Defines whether all or selected customers should be chosen.","enum":["ALL","SELECTED"]},"ids":{"type":"array","description":"Customers' IDs.","items":{"type":"integer","format":"int64"}}}},"RSUserLanguageCombination":{"type":"object","properties":{"sourceLanguage":{"type":"string","description":"Source language code. See [API resources](#tag/Language-codes) for full list of available codes.","example":"en_GB"},"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes.","example":"en_GB"}}},"RSUserQualification":{"type":"object","properties":{"name":{"type":"string","description":"Qualification's name"},"languageCode":{"type":"string","description":"Qualification's language code. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"},"date":{"type":"string","description":"Qualification's date in ISO-8601 format. See [API resources](#tag/ISO-8601-Date-format) for details."},"description":{"type":"string","description":"Qualification's description"}},"required":["date","languageCode","name"]},"RSUserTermCustomers":{"type":"object","description":"User's Terminology customers.","properties":{"selectionType":{"type":"string","default":"ALL","description":"Defines whether all or selected customers should be chosen.","enum":["ALL","SELECTED"]},"ids":{"type":"array","description":"Terminology customers' IDs.","items":{"type":"integer","format":"int64"}}}},"RSUserTmCustomers":{"type":"object","description":"User's TM customers.","properties":{"selectionType":{"type":"string","default":"ALL","description":"Defines whether all or selected customers should be chosen.","enum":["ALL","SELECTED"]},"ids":{"type":"array","description":"TM customers' IDs.","items":{"type":"integer","format":"int64"}}}},"RSUserCreationResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User's ID."},"username":{"type":"string","description":"User's username."}}},"RSPostUserWorkflowStepsRequest":{"type":"object","properties":{"ids":{"type":"array","description":"Workflow step IDs.","items":{"type":"integer","format":"int64"}}}},"RSPostUserWorkflowStepsResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSPostUserSubjectMattersRequest":{"type":"object","properties":{"ids":{"type":"array","description":"IDs of subject matters.","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["ids"]},"RSPostUserSubjectMattersResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSPostUserLanguageCombinationsRequest":{"type":"object","properties":{"languageCombinations":{"type":"array","description":"Language combinations.","items":{"$ref":"#/components/schemas/RSUserLanguageCombination"},"minItems":1}},"required":["languageCombinations"]},"RSPostUserLanguageCombinationsResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSPostUserRolesRequest":{"type":"object","properties":{"ids":{"type":"array","description":"IDs of roles.","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["ids"]},"RSPostUserRolesResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSAdvancedUserSearchRequest":{"type":"object","description":"This method returns users that match the specified advanced search parameters.","properties":{"userIds":{"type":"array","description":"List of user IDs.","items":{"type":"integer","format":"int64"}},"usernames":{"type":"array","description":"List of usernames.","items":{"type":"string"}},"languageCombinations":{"type":"array","description":"Language combinations. When languageCombinations is specified, both sourceLanguage and targetLanguages must be provided.","items":{"$ref":"#/components/schemas/RSLanguageCombination"}},"subjectMatterIds":{"type":"array","description":"List of subject matter IDs.","items":{"type":"integer","format":"int64"}},"customerIds":{"type":"array","description":"List of customer IDs.","items":{"type":"integer","format":"int64"}},"userGroupFilter":{"$ref":"#/components/schemas/RSUserGroupFilter","description":"User group filter."},"workflowFilter":{"$ref":"#/components/schemas/RSWorkflowFilter","description":"Workflow filter."},"taskDetailsFilter":{"$ref":"#/components/schemas/RSTaskDetailsFilter","description":"Task details filter."},"roleIds":{"type":"array","description":"List of role IDs.","items":{"type":"integer","format":"int64"}},"availabilities":{"type":"array","description":"List of availability statuses.","items":{"type":"string","enum":["AVAILABLE","UNAVAILABLE"]}},"activities":{"type":"array","description":"List of activity statuses.","items":{"type":"string","enum":["ACTIVE","INACTIVE"]}},"timeZones":{"type":"array","description":"List of time zones. See [API resources](#tag/Time-zones) for all time zones.","items":{"type":"string","description":"List of time zones. See [API resources](#tag/Time-zones) for all time zones.","x-example":"en_GB"}},"page":{"type":"integer","format":"int32","default":1,"description":"Page number."},"pageSize":{"type":"integer","format":"int32","default":100,"description":"Page size."}}},"RSLanguageCombination":{"type":"object","description":"Language combination for filtering users","properties":{"sourceLanguage":{"type":"string","description":"Source language code. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"},"targetLanguages":{"type":"array","description":"List of target language codes. See [API resources](#tag/Language-codes) for full list of available codes.","items":{"type":"string","description":"List of target language codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}}}},"RSTaskDetailsFilter":{"type":"object","description":"Filter for task details","properties":{"statuses":{"type":"array","description":"Statues for tasks and word counts","items":{"type":"string","enum":["NOT_STARTED","STARTED","FINISHED","FINISHED_BY_AI"]}}}},"RSUserGroupFilter":{"type":"object","description":"Filter for user groups","properties":{"ids":{"type":"array","description":"List of user group IDs","items":{"type":"integer","format":"int64"}}}},"RSWorkflowFilter":{"type":"object","description":"Filter for workflow steps","properties":{"stepIds":{"type":"array","description":"List of workflow steps IDs","items":{"type":"integer","format":"int64"}}}},"RSAdvancedUserSearchDetail":{"type":"object","description":"Detailed user information","properties":{"id":{"type":"integer","format":"int64","description":"User's ID."},"username":{"type":"string","description":"User's username."},"subjectMatterIds":{"type":"array","description":"Subject matter IDs associated with the user","items":{"type":"integer","format":"int64"}},"rating":{"$ref":"#/components/schemas/RSUserRating","description":"User rating information"},"userGroupIds":{"type":"array","description":"User group IDs associated with the user","items":{"type":"integer","format":"int64"}},"workflowStepIds":{"type":"array","description":"Workflow step IDs associated with the user","items":{"type":"integer","format":"int64"}},"roleIds":{"type":"array","description":"Role IDs associated with the user","items":{"type":"integer","format":"int64"}},"availability":{"type":"string","description":"User availability status","enum":["AVAILABLE","UNAVAILABLE"]},"activity":{"type":"string","description":"User activity status","enum":["ACTIVE","INACTIVE"]},"taskDetails":{"$ref":"#/components/schemas/RSTaskDetails","description":"Task details"},"timeZone":{"type":"string","description":"User's time zone. See [API resources](#tag/Time-zones) for all time zones."}}},"RSAdvancedUserSearchResponse":{"type":"object","description":"Advanced user search response","properties":{"users":{"type":"array","description":"List of users matching the search criteria","items":{"$ref":"#/components/schemas/RSAdvancedUserSearchDetail"}}}},"RSTaskDetails":{"type":"object","description":"Task details","properties":{"taskCount":{"type":"integer","format":"int64","description":"Number of tasks assigned to the user."},"wordCount":{"type":"integer","format":"int64","description":"Total word count of tasks assigned to the user."}}},"RSUserRating":{"type":"object","description":"User quality and on-time ratings.","properties":{"qualityRatePercent":{"type":"number","format":"double","description":"Quality rate expressed as a percentage value","example":10.23},"onTimeRatePercent":{"type":"number","format":"double","description":"On-time rate expressed as a percentage value","example":12.5}}},"RSImportTermTagGroup":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Tag group ID"},"tags":{"type":"array","description":"Tags which will be associated with imported terms.","items":{"$ref":"#/components/schemas/RSTag"}}}},"RSTMFileImportRequest":{"type":"object","properties":{"customerId":{"type":"integer","format":"int64","description":"The customer's ID."},"file":{"type":"string","format":"binary","description":"TM file. Supported formats: [TMX, XLS, XLSX, XLIFF, XLF, SDLXLIFF, ZIP]"},"importProjectName":{"type":"string","description":"Specifies the name of the import project.","minLength":1},"sourceLanguage":{"type":"string","description":"Source language code. See [API resources](#tag/Language-codes) for full list of available codes.","example":"en_GB"},"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes.","example":"en_GB"},"tmStatus":{"type":"string","default":"NOT_APPROVED","description":"Specifies the status of imported TM entries.","enum":["APPROVED","NOT_APPROVED"]},"tmStatusImportType":{"type":"string","default":"NONE","description":"Specifies whether the statuses of TM entries should be extracted from the import file.","enum":["FROM_FILE","NONE"]},"whitespacesFormattingType":{"type":"string","default":"REMOVE_LEADING_AND_TRAILING_WHITESPACE","description":"Defines what action should be performed on whitespaces in imported entries.","enum":["REMOVE_LEADING_AND_TRAILING_WHITESPACE","REMOVE_REDUNDANT_INNER_WHITESPACE","REMOVE_REDUNDANT_INNER_LEADING_AND_TRAILING_WHITESPACE","KEEP_ALL_WHITESPACES"]},"altTransElementsImport":{"type":"string","default":"NONE","description":"Defines if Alt-Trans texts should be imported in the file.","enum":["FROM_XLIFF_FILE","NONE"]},"segmentsImportType":{"type":"string","default":"NONE","description":"Specifies which parts of TM entries should be imported.","enum":["SOURCE_AND_TARGET","NONE"]},"bilingualTerminologyAction":{"type":"string","default":"NONE","description":"Specifies if bilingual terminology extraction should be performed during the import.","enum":["EXTRACT","NONE"]},"tagGroups":{"type":"array","description":"Tags which will be associated with the imported TM data.","items":{"$ref":"#/components/schemas/RSImportTermTagGroup"}}},"required":["customerId","file","importProjectName","sourceLanguage","targetLanguage"]},"RSTag":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Tag ID"}}},"RSTMFileImportResult":{"type":"object","properties":{"fileId":{"type":"integer","format":"int64"},"fileName":{"type":"string"}}},"RSTMFileGenerateRequest":{"type":"object","description":"JSON format data to generate TM file export.","properties":{"fileType":{"type":"string","description":"Output file type.","enum":["TMX","XLS"]},"customerId":{"type":"integer","format":"int64","description":"Customer ID."},"projectId":{"type":"integer","format":"int64","description":"Project ID."},"sourceLanguage":{"type":"string","description":"Source language code. See [API resources](#tag/Language-codes) for full list of available codes."},"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."},"createdDateFrom":{"type":"string","description":"Date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"createdDateTo":{"type":"string","description":"Date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"changedDateFrom":{"type":"string","description":"Date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"changedDateTo":{"type":"string","description":"Date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"includeReverseMemory":{"type":"string","default":"DO_NOT_INCLUDE","description":"Defines whether TM file generation should include reverse memory.","enum":["INCLUDE","DO_NOT_INCLUDE"]},"approvalStatus":{"type":"string","default":"ALL","description":"Defines which approval status a segment must have, to be included in TM file generation.","enum":["APPROVED","NOT_APPROVED","ALL"]}},"required":["customerId"]},"RSTMFileGenerateResponse":{"type":"object","properties":{"fileId":{"type":"integer","format":"int64","description":"File ID."}}},"RSConceptOptions":{"type":"object","properties":{"additionType":{"type":"string","default":"CREATE_NEW","description":"Defines whether translations will be added to the existing concept or new one will be created. When ADD_TO_EXISTING value is selected then additionLanguage must be provided.","enum":["ADD_TO_EXISTING","CREATE_NEW"]},"additionLanguage":{"type":"string","description":"Existing concept's language code. See [API resources](#tag/Language-codes) for full list of available codes."}}},"RSImportTermRequest":{"type":"object","properties":{"customerId":{"type":"integer","format":"int64","description":"The customer's ID."},"file":{"type":"string","format":"binary","description":"Terminology file. Supported extensions: TBX, MTF, XLS, XLSX and ZIP.","minLength":1},"conceptOptions":{"$ref":"#/components/schemas/RSConceptOptions","description":"Settings related to the term's concept."},"termStatus":{"type":"string","default":"VALID","description":"Specifies which status imported terms will have.","enum":["FORBIDDEN","NOT_APPROVED","REJECTED","VALID"]},"termStatusImportType":{"type":"string","default":"FROM_FILE","description":"Defines whether term statuses should be set on the basis of data provided in the import file. If no status is provided for an imported term the value from the termStatus field will be set.","enum":["FROM_FILE","NONE"]},"tagGroups":{"type":"array","description":"Tag groups which will be associated with imported terms. Must be provided together with tags.","items":{"$ref":"#/components/schemas/RSImportTermTagGroup"}}},"required":["customerId","file"]},"RSImportTermResponse":{"type":"object","properties":{"fileName":{"type":"string"},"fileId":{"type":"integer","format":"int64"}}},"RSExportTermCustomFields":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Terminology custom field definition ID."},"valueIds":{"type":"array","description":"Custom Field value IDs.","items":{"type":"integer","format":"int64"}}}},"RSExportTermModificationFilter":{"type":"object","properties":{"from":{"type":"string","description":"Earliest terminology modification date in ISO-8601 date format. See [API resources](#tag/Date-formats) for all date formats."},"to":{"type":"string","description":"Latest terminology modification date in ISO-8601 date format. See [API resources](#tag/Date-formats) for all date formats."},"modifierIds":{"type":"array","description":"Modifier IDs.","items":{"type":"integer","format":"int64"}}}},"RSExportTermRequest":{"type":"object","description":"JSON format data to generate terminology file export.","properties":{"fileExtensionType":{"type":"string","description":"File type for terminology file export.","enum":["TBX","MTF","XLS","XLSX"]},"includeTermAndConceptIds":{"type":"string","default":"DO_NOT_INCLUDE","description":"Defines whether the terminology export result file should include term and concept IDs.","enum":["INCLUDE","DO_NOT_INCLUDE"]},"termFieldNames":{"type":"array","description":"Names of term fields to be included in the exported terminology file.","items":{"type":"string","enum":["STATUS","MODIFIED_BY","MODIFIED_DATE","ABBREVIATION","CONTEXT","REMARKS","NOTES"]}},"termCustomFieldIds":{"type":"array","description":"IDs of custom term fields to be included in the exported terminology file.","items":{"type":"integer","format":"int64"}},"conceptFieldNames":{"type":"array","description":"Names of concept fields to be included in the exported terminology file.","items":{"type":"string","enum":["DEFINITION","DOMAIN","REFERENCE"]}},"conceptCustomFieldIds":{"type":"array","description":"IDs of custom concept fields to be included in the exported terminology file.","items":{"type":"integer","format":"int64"}},"filter":{"$ref":"#/components/schemas/RSExportTermRequestFilter","description":"Filter containing criteria for terminology file export."}},"required":["fileExtensionType"]},"RSExportTermRequestFilter":{"type":"object","properties":{"customerIds":{"type":"array","description":"Customer IDs. If no identifiers are specified, export will be performed for all available customers.","items":{"type":"integer","format":"int64"}},"mainLanguage":{"type":"string","description":"Main language. If no value is specified, export will be performed for all available languages. See [API resources](#tag/Language-codes) for full list of available codes."},"termStatuses":{"type":"array","default":"[\"ALL\"]","description":"This parameter is used to specify which terms with selected statuses should be exported. The term status is not overwritten during export.","items":{"type":"string","enum":["ALL","VALID","NOT_APPROVED","REJECTED","FORBIDDEN"]}},"translationLanguages":{"type":"array","description":"Translation language codes. If no languages are specified, the export will be performed for all available translation languages. See [API resources](#tag/Language-codes) for full list of available codes.","items":{"type":"string","description":"Translation language codes. If no languages are specified, the export will be performed for all available translation languages. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}},"searchPhrase":{"type":"string","description":"Search phrase."},"tagGroups":{"type":"array","description":"Tag groups which will be associated with exported terms. Must be specified together with tags.","items":{"$ref":"#/components/schemas/RSExportTermTagGroup"}},"creationFilter":{"$ref":"#/components/schemas/RSTermCreationFilter","description":"A filter containing a list of creator identifiers and a range of creation dates."},"modificationFilter":{"$ref":"#/components/schemas/RSExportTermModificationFilter","description":"A filter containing a list of modifier identifiers and a range of modification dates."},"conceptId":{"type":"integer","format":"int64","description":"Concept ID."},"context":{"type":"string","description":"Context."},"abbreviation":{"type":"string","description":"Abbreviation."},"domains":{"type":"array","description":"List of domains.","items":{"type":"string"}},"notes":{"type":"string","description":"Notes."},"remarks":{"type":"string","description":"Remarks."},"definition":{"type":"string","description":"Definition."},"reference":{"type":"string","description":"Reference."},"suggestionType":{"type":"string","default":"YES","description":"Suggestion type. This criterion should match the filtering terms with a \"Suggested term\" field, exporting terms that have, or do not have suggestions.","enum":["YES","NO"]},"termId":{"type":"integer","format":"int64","description":"Terminology ID."},"customFields":{"type":"array","description":"Terminology custom field IDs and their value IDs.","items":{"$ref":"#/components/schemas/RSExportTermCustomFields"}}}},"RSExportTermTagGroup":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Tag group ID"},"tags":{"type":"array","description":"Tags which will be associated with exported terms.","items":{"$ref":"#/components/schemas/RSTag"}}}},"RSTermCreationFilter":{"type":"object","properties":{"from":{"type":"string","description":"Earliest terminology creation date in ISO-8601 date format. See [API resources](#tag/Date-formats) for all date formats."},"to":{"type":"string","description":"Latest terminology creation date in ISO-8601 date format. See [API resources](#tag/Date-formats) for all date formats."},"creatorIds":{"type":"array","description":"Creator IDs.","items":{"type":"integer","format":"int64"}}}},"RSExportTermResponse":{"type":"object","properties":{"fileId":{"type":"integer","format":"int64","description":"File ID."}}},"RSCreateTemplateRequest":{"type":"object","properties":{"sourceProjectId":{"type":"integer","format":"int64","description":"Source project ID for template"},"templateType":{"type":"string","description":"Type of template.","enum":["CUSTOMER","GLOBAL"]},"description":{"type":"string","description":"Description"},"name":{"type":"string","description":"Template name"},"customerId":{"type":"integer","format":"int64","description":"Customer id"}},"required":["name","sourceProjectId","templateType"]},"RSCreateTemplateResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"RSTagGroupCreateRequest":{"type":"object","description":"JSON format data with fields used to create tag group.","properties":{"name":{"type":"string","maxLength":50,"minLength":1},"customerSelectionType":{"type":"string","default":"ALL_CUSTOMERS","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"required":["name"]},"RSTagGroupCreateResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}},"customerSelectionType":{"type":"string","description":"Type of customer selection. The `ALL_CUSTOMERS` value indicates that all available customers from your XTM Cloud instance are assigned to the relevant tag group.","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]}}},"RSCreateTag":{"type":"object","properties":{"name":{"type":"string"},"customerSelectionType":{"type":"string","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"required":["name"]},"RSCreateTagsRequest":{"type":"object","description":"JSON format data with fields used to create tag.","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/RSCreateTag"}}}},"RSTagCreateResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"customerSelectionType":{"type":"string","description":"Type of customer selection. The `ALL_CUSTOMERS` value indicates that all customers from the tag group are assigned to the relevant tag.","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"RSAnalysisFinishedCallback":{"type":"object","properties":{"url":{"type":"string","description":"Callback's URL."}},"required":["url"]},"RSCreateProjectCustomField":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Custom Field definition ID."},"value":{"$ref":"#/components/schemas/RSCreateProjectCustomFieldValue"}}},"RSCreateProjectCustomFieldValue":{"type":"object","properties":{"ids":{"type":"array","description":"Custom Field value IDs only required for dropdown and multiselect. If a dropdown is selected, only one ID needs to be entered.","items":{"type":"integer","format":"int64"}},"value":{"type":"string","description":"String value for text field and number Custom fields. If a number is selected, only numeric characters are valid."},"dateValue":{"type":"string","description":"Date value in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"booleanValue":{"type":"boolean","description":"Boolean value for checkbox Custom Field."}}},"RSDueDateChangedCallback":{"type":"object","properties":{"url":{"type":"string","description":"Callback's URL."}},"required":["url"]},"RSErrorAction":{"type":"object","properties":{"duplicateName":{"type":"string","description":"Indicates how the system should act on the duplicated project name.","enum":["ADD_SUFFIX_NUMBER","THROW_EXCEPTION"]}}},"RSFileTargetLanguageRequest":{"type":"object","properties":{"code":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."},"workflowId":{"type":"integer","format":"int64","description":"Workflow definition ID. If a value is present it must be provided alongside the code."}}},"RSInvoiceStatusChangedCallback":{"type":"object","properties":{"url":{"type":"string","description":"Callback's URL."}},"required":["url"]},"RSJobFinishedCallback":{"type":"object","properties":{"url":{"type":"string","description":"Callback's URL."}},"required":["url"]},"RSProjectAcceptedCallback":{"type":"object","properties":{"url":{"type":"string","description":"Callback's URL."}},"required":["url"]},"RSProjectActivityChangedCallback":{"type":"object","properties":{"url":{"type":"string","description":"Callback's URL."}},"required":["url"]},"RSProjectCallbacks":{"type":"object","description":"Request object with callbacks.","properties":{"projectCreatedCallbacks":{"type":"array","description":"Callbacks after project is created.","items":{"$ref":"#/components/schemas/RSProjectCreatedCallback"}},"projectAcceptedCallbacks":{"type":"array","description":"Callbacks after project is accepted.","items":{"$ref":"#/components/schemas/RSProjectAcceptedCallback"}},"projectFinishedCallbacks":{"type":"array","description":"Callbacks after project is finished.","items":{"$ref":"#/components/schemas/RSProjectFinishedCallback"}},"jobFinishedCallbacks":{"type":"array","description":"Callbacks after job is finished.","items":{"$ref":"#/components/schemas/RSJobFinishedCallback"}},"analysisFinishedCallbacks":{"type":"array","description":"Callbacks after analysis ends.","items":{"$ref":"#/components/schemas/RSAnalysisFinishedCallback"}},"workflowTransitionCallbacks":{"type":"array","description":"Callbacks after workflow change.","items":{"$ref":"#/components/schemas/RSWorkflowTransitionCallback"}},"invoiceStatusChangedCallbacks":{"type":"array","description":"Callbacks after invoice status change.","items":{"$ref":"#/components/schemas/RSInvoiceStatusChangedCallback"}},"sourceFileUpdatedCallbacks":{"type":"array","description":"Callbacks after updating source files.","items":{"$ref":"#/components/schemas/RSSourceFileUpdatedCallback"}},"projectActivityChangedCallbacks":{"type":"array","description":"Callbacks after project activity change.","items":{"$ref":"#/components/schemas/RSProjectActivityChangedCallback"}},"projectLanguageChangedCallbacks":{"type":"array","description":"Callbacks after project language change.","items":{"$ref":"#/components/schemas/RSProjectLanguageChangedCallback"}},"dueDateChangedCallbacks":{"type":"array","description":"Callbacks after due date change.","items":{"$ref":"#/components/schemas/RSDueDateChangedCallback"}}}},"RSProjectCreatedCallback":{"type":"object","properties":{"url":{"type":"string","description":"Callback's URL."}},"required":["url"]},"RSProjectCreationModelAttributeRequest":{"type":"object","description":"Request fields for project creation.","properties":{"name":{"type":"string","description":"Name of the project. Project name cannot contain any of the following characters: , /, :, *, ?, \", <, >, |, {, }, [TAB].","maxLength":100,"minLength":1},"description":{"type":"string","description":"The description of project."},"referenceId":{"type":"string","description":"The reference ID of project."},"sourceLanguage":{"type":"string","description":"Source language code, see [API resources](#tag/Language-codes) for full list of available language codes."},"newSourceLanguage":{"type":"string","description":"New source (preprocessing) language code, see [API resources](#tag/Language-codes) for full list of available language codes."},"newSourceType":{"type":"string","description":"Preprocessing type.","enum":["SOURCE_SEGMENTATION","NEW_SOURCE_SEGMENTATION"]},"targetLanguages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available language codes.","items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}},"workflowId":{"type":"integer","format":"int64"},"newSourceWorkflowId":{"type":"integer","format":"int64"},"workflowName":{"type":"string","description":"Project's workflow name."},"newSourceWorkflowName":{"type":"string","description":"Preprocessing's workflow name."},"dueDate":{"type":"string","description":"Due date for project in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"customerId":{"type":"integer","format":"int64","description":"Customer ID."},"projectManagerId":{"type":"integer","format":"int64","description":"ID of Project Manager who has an access to a given Customer."},"templateId":{"type":"integer","format":"int64","description":"Template ID."},"filterTemplateId":{"type":"string","description":"Filter template ID"},"translationFiles":{"type":"array","description":"Files to translate.","items":{"$ref":"#/components/schemas/RSSourceFileRequest"}},"referenceFiles":{"type":"array","description":"Reference materials.","items":{"$ref":"#/components/schemas/RSReferenceFilesRequest"}},"callbacks":{"$ref":"#/components/schemas/RSProjectCallbacks","description":"Project's callbacks."},"externalCreatorId":{"type":"integer","format":"int64","description":"ID of an external user creating this project."},"overrideFields":{"$ref":"#/components/schemas/RSProjectOverrideFields","description":"These settings override the template settings."},"groupFilesDitaLevel":{"type":"integer","format":"int32","description":"If no values are provided for DITA_MAP, the system tries to retrieve them in the following order: 1) from XTM Templates 2) from Client settings. If no values are found in the two configurations, an error message is displayed."},"errorAction":{"$ref":"#/components/schemas/RSErrorAction","description":"Indicates how the system should act on the error action."},"segmentLockingType":{"type":"string","description":"DISABLED - disables this option
    ANY_100_MATCH - segments with approved and not approved leveraged or ICE matches will be locked
    APPROVED_100_MATCH - segments with approved leveraged or ICE matches will be locked
    XLIFFDOC_TRANSLATED, XLIFFDOC_PROOFED, XLIFFDOC_VALIDATED - segments with a specific xliff:doc status will be locked","enum":["DISABLED","ANY_100_MATCH","APPROVED_100_MATCH","XLIFFDOC_TRANSLATED","XLIFFDOC_PROOFED","XLIFFDOC_VALIDATED"]},"subjectMatterId":{"type":"integer","format":"int64","description":"Subject matter ID."},"fileProcessType":{"type":"string","description":"Type of files processing.","enum":["JOIN"]},"projectManagerType":{"type":"string","description":"Type of project manager to assign.","enum":["FROM_CUSTOMER"]},"groupFilesType":{"type":"string","description":"Activates file grouping in XTM, where you can specify the type of grouping in projects. If no values are provided, the system tries to retrieve them in the following order: 1) from XTM Templates; 2) from Client settings.","enum":["FILE_EXTENSION","DITA_MAP","NO_GROUP"]},"workflowDueDate":{"type":"string","description":"Workflow due date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"workflowStartDate":{"type":"string","description":"Workflow start date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"newSourceDueDate":{"type":"string","description":"Pre-processing due date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"translationMemory":{"$ref":"#/components/schemas/RSTranslationMemoryOptions","description":"Translation memory options."},"terminology":{"$ref":"#/components/schemas/RSTerminologyOptions","description":"Terminology options."},"customerSettings":{"$ref":"#/components/schemas/RSCustomerSettings","description":"Settings related to terminology and translation memory customers."},"customFields":{"type":"array","description":"Custom fields options.","items":{"$ref":"#/components/schemas/RSCreateProjectCustomField"}}}},"RSProjectFinishedCallback":{"type":"object","properties":{"url":{"type":"string","description":"Callback's URL."}},"required":["url"]},"RSProjectLanguageChangedCallback":{"type":"object","properties":{"url":{"type":"string","description":"Callback's URL."}},"required":["url"]},"RSProjectOverrideFields":{"type":"object","properties":{"overrideFromRequest":{"type":"array","description":"Specify which template settings are to be replaced by values set in the request body.","items":{"type":"string","enum":["NEW_SOURCE_LANGUAGE","TM_PENALTY_PROFILE","TM_LANGUAGE_VARIANTS_PENALTY_PROFILE","TERMINOLOGY_PENALTY_PROFILE","CUSTOM_FIELDS"]},"uniqueItems":true}}},"RSReferenceFilesRequest":{"type":"object","properties":{"name":{"type":"string","description":"Changes name of reference file."},"file":{"type":"string","format":"binary","description":"Specifies file that will be added to project as reference."}},"required":["file"]},"RSSourceFileRequest":{"type":"object","properties":{"name":{"type":"string","description":"Overrides original filename for uploaded preview file. It should include the file extension."},"file":{"type":"string","format":"binary","description":"Uploads source file to project."},"targetLanguages":{"type":"array","description":"File target language codes. See [API resources](#tag/Language-codes) for full list of available codes.","items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}},"targetLanguagesV2":{"type":"array","description":"File target languages object. Contains list of objects describing target languages.","items":{"$ref":"#/components/schemas/RSFileTargetLanguageRequest"}},"workflowId":{"type":"integer","format":"int64","description":"Workflow definition ID."},"tagIds":{"type":"array","description":"List of tag IDs.","items":{"type":"integer","format":"int64"}},"translationType":{"type":"string","description":"Value 'DO_NOT_TRANSLATE' Allows to add file without translation. Target languages must not be specified when 'DO_NOT_TRANSLATE' is used.","enum":["TRANSLATE","DO_NOT_TRANSLATE"]},"metadata":{"type":"string","description":"Metadata for file."},"metadataType":{"type":"string","description":"Type of metadata.","enum":["JSON"]}},"required":["file"]},"RSSourceFileUpdatedCallback":{"type":"object","properties":{"url":{"type":"string","description":"Callback's URL."}},"required":["url"]},"RSWorkflowTransitionCallback":{"type":"object","properties":{"url":{"type":"string","description":"Callback's URL."}},"required":["url"]},"RSProjectCreationResponse":{"type":"object","description":"Response from project creation.","properties":{"projectId":{"type":"integer","format":"int64","description":"Project ID."},"name":{"type":"string","description":"Project name."},"joinFilesType":{"type":"string","description":"Type of file joining.","enum":["EXTENSION","DITA_MAP","NOT_JOINED"]},"joinFilesDitaLevel":{"type":"integer","format":"int32","description":"DITA Map level when mapping by DITA Map is used."},"jobs":{"type":"array","description":"Job details.","items":{"$ref":"#/components/schemas/RSProjectJob"}}}},"RSProjectJob":{"type":"object","description":"Project job description.","properties":{"jobId":{"type":"integer","format":"int64","description":"Job ID."},"fileName":{"type":"string","description":"File name."},"sourceFileId":{"type":"integer","format":"int64","description":"Source file id."},"sourceLanguage":{"type":"string","description":"Source language code. See [API resources](#tag/Language-codes) for full list of available codes."},"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."},"joinFilesType":{"type":"string","description":"Type of file joining.","enum":["EXTENSION","DITA_MAP","NOT_JOINED"]},"joinFilesDitaLevel":{"type":"integer","format":"int32","description":"DITA Map level when mapping by DITA Map is used."}}},"RSProjectWorkflowAddStepRequest":{"type":"object","properties":{"previousStepName":{"type":"string","description":"Name of the step before the one that will be added."},"id":{"type":"integer","format":"int64","description":"Step ID."},"dueDate":{"type":"string","description":"Due date. Can be specified by subcontractor. Cannot be applied for automatic steps."},"tmApproval":{"type":"string","default":"DISABLED","description":"Type of TM Approval. Cannot be applied for automatic or offline steps.","enum":["ENABLED","DISABLED"]},"costsCalculationBasedOnManualTime":{"type":"string","default":"DISABLED","description":"Costs calculation based on manual time. Cannot be applied for automatic steps. Only available when manual time tracking is enabled in configuration.","enum":["ENABLED","DISABLED"]},"lqaType":{"type":"string","default":"DISABLED","description":"Type of LQA. Cannot be applied for automatic or offline steps.","enum":["ENABLED_SAVING_RESULTS_FOR_USER","ENABLED_NOT_SAVING_RESULTS_FOR_USER","DISABLED_BUT_SHOW_EXISTING_ERRORS","DISABLED"]},"finishTaskOption":{"type":"string","default":"NONE","description":"Finish task options. Can be specified by subcontractor. Cannot be applied for automatic or offline steps.","enum":["NONE","ALL_SEGMENT_DONE"]},"blockingType":{"type":"string","default":"FULL_BLOCKING","description":"Step blocking type. Can be specified by subcontractor.","enum":["FULL_BLOCKING","PART_BLOCKING","NO_BLOCKING"]}},"required":["id","previousStepName"]},"RSProjectWorkflowAddStepsRequest":{"type":"object","description":"JSON format data to add steps to workflow, contains objects with filter parameters and step descriptors.","properties":{"jobIds":{"type":"array","description":"Job ID.","items":{"type":"integer","format":"int64"}},"id":{"type":"string","description":"Workflow ID. The ID can be obtained from the [obtain workflows method](#tag/Project-workflows/operation/obtainWorkflows) response.","minLength":1},"targetLanguages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","example":["en_GB"],"items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}},"steps":{"type":"array","description":"Steps to add","items":{"$ref":"#/components/schemas/RSProjectWorkflowAddStepRequest"},"minItems":1}},"required":["id","steps"]},"RSProjectWorkflowAddStepsResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the workflow"},"name":{"type":"string","description":"Name of the workflow"},"steps":{"type":"array","description":"Descriptors of steps in the workflow","items":{"$ref":"#/components/schemas/RSProjectWorkflowStepResponse"}}}},"RSProjectWorkflowUnassignment":{"type":"object","properties":{"languages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"},"uniqueItems":true},"referenceStepNames":{"type":"array","description":"Workflow reference step names.","items":{"type":"string"},"uniqueItems":true},"displayStepNames":{"type":"array","description":"Workflow display step names. This name is used as a label in the UI.","items":{"type":"string"},"uniqueItems":true},"jobIds":{"type":"array","description":"Job IDs","items":{"type":"integer","format":"int64"},"uniqueItems":true},"bundleIds":{"type":"array","description":"Bundle IDs","items":{"type":"integer","format":"int64"},"uniqueItems":true}}},"RSProjectWorkflowUserUnassignmentResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSProjectWorkflowAssignmentResponse":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/RSProjectWorkflowAssignmentUser"},"languages":{"type":"array","items":{"type":"string","enum":["ab","aa_ET","ak","af_ZA","sq_AL","am_ET","am_ER","ar_AA","ar_AE","ar_BH","ar_DZ","ar_EG","ar_EH","ar_IQ","ar_JO","ar_KW","ar_LB","ar_LY","ar_MA","ar_MR","ar_OM","ar_PS","ar_QA","ar_SA","ar_SD","ar_SY","ar_TD","ar_TN","ar_YE","anu","hy_AM","hy_AM_arevela","hy_AM_arevmda","as_IN","ast_ES","ay_BO","az_AZ_Cyrl","az_AZ_Latn","ba_RU","bal_IR","bh_IN","bi_VU","bam","bs_BA_Cyrl","bs_BA_Latn","br_FR","bsk","my_MM","be_BY","cal","ca_ES","ceb","cha","cja","cjm","ctd","ny_MW","zh_CN","zh_TW","zh_HK","zh_SG","zh_HK_Hans","chk","cpe","co_FR","hr_HR","hr_BA","cs_CZ","crk","crl","crm","crj","cwd","crg","eu_ES","bn_IN","bn_BD","bg_BG","ca_AD","dnj","da_DK","prs_AF","dv_IN","mis","nl_NL","en_US","en_GB","en_142","en_CA","en_AU","en_NZ","en_ZA","en_CH","en_HK","en_IN","en_IE","en_SG","en_AE","en_DE","en_NL","en_AT","en_NT","en_CY","en_KE","en_BS","en_MY","en_PK","en_PH","en_LU","en_NG","en_JP","en_TT","en_AW","en_BH","en_EG","en_ES","en_ID","en_JO","en_KR","en_KW","en_TH","eo","et_EE","ee_GH","eky","kyu","fo_FO","fj_FJ","fil_PH","fi_FI","nl_BE","fr_FR","fr_CA","fr_CH","fr_BE","fr_LU","fr_MA","fr_SN","fr_CM","fy","fu","fat","gl_ES","ka_GE","kar","de_DE","de_AT","de_BE","de_CH","de_LU","de_NL","lb_LU","kl_GL","el_GR","el_CY","grc_GR","gil","grn","gu_IN","ht_HT","cnh","ha_NG","ha_Latn","he_IL","hi_IN","hil","hmn","hmn_US","hu_HU","haw","is_IS","ig","ilo","id_ID","ia","ie","iu","ium","ik","ish","ga_IE","it_IT","it_CH","ja_JP","jv_ID","ks","kk_KZ","kg_CG","kik","kig","rw_RW","ky","rn","sw_KE","km_KH","kn_IN","kok_IN","tlh","ko_KR","kos","ku_TR","kmr","ckb","ku_IQ","lo_LA","la","lv_LV","ln_CG","lt_LT","mfe_MU","mk_MK","mg_MG","ms_MY","ms_SG","ml_IN","mt_MT","mi_NZ","mr_IN","mah","mn_MN","sla_ME","mo_MD","na_NR","nv","nd_ZW","ne_NP","no_NO","nb_NO","niu","nn_NO","nso_ZA","nus","oc_FR","or_IN","om_ET","ota","pag","pam","pau","ps","ps_PK","fa_IR","pon","pl_PL","pt_PT","pt_BR","pt_MZ","pt_AO","pa_PA","pa_IN","pa_PK","qu_PE","qya","xr_MM","rar","rm_CH","ro_RO","ro_MD","ru_RU","ru_AM","ru_AZ","ru_GE","ru_MD","ru_UA","sm_WS","sg","sa_IN","sc_IT","gd_GB","st","tn_ZA","sr_YU","sr_RS_Cyrl","sr_ME_Cyrl","sr_ME_Latn","sr_RS_Latn","sn","sjn","sd_PK","si_LK","ss","sk_SK","sl_SI","snk","so_SO","dsb_DE","hsb_DE","es_ES","es_AR","es_BO","es_CL","es_CO","es_CR","es_CU","es_DO","es_EC","es_SV","es_GT","es_HN","es_419","es_MX","es_NI","es_PA","es_PY","es_PE","es_PR","es_UY","es_US","es_VE","es_001","es_NT","swa","sw_SO","sw_TZ","sw_UG","sv_SE","sv_FI","apd_SD","apd_SD_Latn","sun","syr_TR","tl_PH","tg_TJ","ta_IN","ta_SG","ta_LK","tt_RU","te_IN","tet_ID","tet_TL","th_TH","bo","ti","tir_ER","tir_ET","to_TO","ts_ZA","tn_BW","tpi","tvl","tr_TR","tk_TM","tkl","tw","ty","uk_UA","ur_IN","ur_PK","ug_CN","uz_UZ_Cyrl","uz_UZ_Latn","uz_AF","cy_GB","vi_VN","vo","wo","war","xh_ZA","xz_AF","yao","yap","yi","yi_IL","yi_US","yo_NG","czt","zom","zu_ZA","kun","lua","sco_GB","sco_IE","fr_CG","zh_YUE","lug","ogo","bbc","ksw","cfm","cmn","goyu","aii","cld","pdc","ziw","pap","en_CN","din","fr_TN","fur","en_EU","mas","en_IL","en_QA","pis","lus","hif","zyp","sez","clt","mwq","mrh","sdh","tcz","rtm","bfa","shn","mnw","toq","ach","jam","rom","chr","bsq","cpf","kgp_BR","yrl_BR","bem","ts_ZA_changana","luo","xsm","mni","nag","quc","ton","bdx","doi","mai","sat","daw","krj","fr_001","pt_001","en_SA","mnk","kjb","keo","kjg","wbh","en_MA","en_BE","en_CZ","en_HU","en_SK","en_FI","en_HR","en_RO","en_SI","en_RS","en_UA","en_PT","en_DK","en_FR","en_IT","en_MX","en_NO","en_PL","en_RU","en_SE","en_OM","ms_AR","ru_IL","ber","en_CL","kri","hi_Latn","en_TR","en_TW","en_BN","en_PR","gaa","hz","ny","cgg","nyo","kj","mix","ha_Arab","hi_Latn_en","fr_DZ","ve","smn","sms","zne","bik","shk","mam","hi","bwu","aran_ES","vc_ES","zh_MO","xnr","sw_CG","zh_MY","gur","oj","fr_GN","mos","en_CO","en_PE","tl_EN","ase","asf","prl","apw","apa","bla","ckz","cak","efi","fon","fr_PF","fr_TY","iba","kek","kam","ktu","mkw","cuk","kvn","lkt","yua","meu","cag","kea","pt_CV","qu_EC","sto","tzo","tzj","ypk","de_LI","scl","qu","qu_BO","syl","nd","nr","fu_Latn","fu_Adlm","fu_Arab","zh_SH","arb","aba","abr","acr","ace","ada","ady","aa","agu","ajg","akl","alz","anw","njm","any","aed","aen","hyw","as","ati","awa","ay","azj","bba","bfq","bfy","bca","bjs","ban","bpd","bjn","bci","bas","ba","eu","bej","be","yun","bom","bew","btg","bhb","bib","brx","bvl","bs","pcc","brh","bzs","bfi","bug","bxk","bum","bns","wes","ca","tzm","cbk","ce","hne","csg","gan","hak","cjy","mnp","cdo","nan","czo","cpx","csp","wuu","hsn","csl","ctg","cjk","cce","cac","cv","chw","csn","csr","cyo","dga","dag","gud","dua","dse","dyu","dz","igb","ecs","bin","etu","eke","ebu","enq","en_EE","en_LV","en_LT","myv","ee","fan","psp","fip","sfb","fsl","fub","fuv","fuh","gl","gmv","gbm","grt","gej","de_001","gsg","nyf","toh","gdx","gog","gno","gux","grb","gsm","gu","guw","goa","guz","gwr","hdy","hoj","bgc","ha","hay","haz","heh","hds","ibg","ibb","idu","igl","ijs","ikw","ins","ga","its","iso","ise","ijc","jac","jv","kbp","kab","kac","kbr","ijn","ktb","bjj","knj","kr","kqn","kpg","kdj","kjp","khz","kha","kxm","kmb","sgc","kss","klu","bkm","kok","kno","xpe","ksd","kdi","kue","kdn","kuj","kru","leb","lam","lmn","laj","led","lok","lom","ngl","lon","loz","khb","lu","lgg","lun","lb","mzc","mad","mag","mak","vmw","mgh","xmm","mup","mgr","emk","mev","arn","mr","mrq","rwr","myx","msb","mdp","men","mer","wry","mtr","mfs","min","miq","mfe","unr","mui","sur","nah","nnb","niq","na","ndc","nzs","nij","sba","nga","nia","pcm","noe","tts","nup","nyy","nym","nyn","nzi","ory","plw","pif","poh","psr","quh","rkt","rap","rcf","rhg","ru_EE","ru_LV","ru_LT","rsl","sck","spv","stj","cri","sas","scd","gd","sgw","seh","srr","swv","shh","sid","sd","xog","so","sop","nso","kjd","ssp","srn","suk","sgd","sus","sgg","shi","tbw","tss","rif","tt","tsg","nzu","teo","tll","tdt","nod","sou","tig","tem","tiv","tqo","toi","ttj","ts","tum","tk","aoz","ukw","umb","urh","uzn","uzs","vai","vah","vsl","vls","vun","wbr","gxx","cy","lia","wal","yaf","sah","yog","yom","zap","dje","za","zun","pnb","pa","pan","skr","azb","ug","prs","tg","bal","he","fuc","hno","mey","phr","glk","mzn","lou","cab","fr_MG","fr_BF","fr_ML","sq_XK","en_IS","en_MT","en_BR","crs","fi_NO","fi_SE","st_ZA","ta_MY","uk_PL","ur_AU","vi_AU","vi_US","zh_AU","en_GR","mdh","ar_IL","aln","sq_ME","sq_MK","als","nds","ar_BE","ar_KAB","ceb_PH","dv_MV","nl_CW","en_JM","fr_CI","fr_HT","fr_MQ","fr_NC","fr_RE","ilo_PH","xh","it_MT","kik_KE","ku","ku_Arab","ku_Cyrl","ku_Latn","cnr","ru_BY","ru_KZ","ru_KG","sr_XK_Latn","sr_XK_Cyrl","sr_CS_Latn","nan_TW","bo_CN","tg_Cyrl","tg_Arab","tg_TJ_Cyrl","tr_CY"]},"uniqueItems":true},"displayStepNames":{"type":"array","items":{"type":"string"},"uniqueItems":true},"referenceStepNames":{"type":"array","items":{"type":"string"},"uniqueItems":true},"stepNames":{"type":"array","items":{"type":"string"},"uniqueItems":true},"jobIds":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true},"bundleIds":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true},"reason":{"type":"string","enum":["USER_NOT_FOUND","USER_ID_AND_TYPE_ALWAYS_NEED_TO_BE_FILLED","USER_DOES_NOT_HAVE_ACCESS_TO_PROJECT_CUSTOMER","USER_DOES_NOT_HAVE_ACCESS_TO_REQUIRED_LANGUAGE_COMBINATION","USER_DOES_NOT_HAVE_ACCESS_TO_REQUIRED_WORKFLOW_STEP","USER_GROUP_DOES_NOT_HAVE_VALID_USER","PROJECT_IS_ALREADY_FINISHED","SOME_OF_THE_JOBS_ARE_ALREADY_FINISHED","SOME_TARGET_LANGUAGES_ARE_ALREADY_FINISHED","PROJECT_IS_ALREADY_ARCHIVED","PROJECT_IS_ALREADY_DELETED","PROJECT_IS_ALREADY_INACTIVE","PROJECT_IS_ALREADY_CANCELLED","SOME_PROJECT_JOBS_ARE_ALREADY_CANCELLED","SOME_TARGET_LANGUAGES_ARE_ALREADY_CANCELLED","COULDNT_FIND_ACTIVE_LANGUAGES_FROM_REQUEST_IN_PROJECT","COULDNT_FIND_ACTIVE_WORKFLOW_STEPS_FROM_REQUEST_IN_PROJECT","COULDNT_FIND_ACTIVE_JOB_OR_BUNDLE_FROM_REQUEST","LSP_CAN_BE_ASSIGN_ONLY_TO_FIRST_GANG_IN_STEP","COULDNT_ASSIGN_USER_TO_GANG_WHERE_IN_STEP_LSP_ASSIGNED"]}}},"RSProjectWorkflowAssignmentUser":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User ID"},"type":{"type":"string","description":"User type","enum":["INTERNAL_USER","LSP","USER_GROUP"]}},"required":["id","type"]},"RSJobStartStatus":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64","description":"Job ID."},"status":{"type":"boolean","description":"Status of job start.","example":true}}},"RSProjectWorkflowStartResponse":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64"},"status":{"type":"boolean"},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/RSJobStartStatus"}},"errorType":{"type":"string","enum":["PROJECT_INACTIVE","COST_NOT_APPROVED","TIME_TRACKING_NOT_ENTERED"]}}},"RSReopenWorkflowRequest":{"type":"object","properties":{"jobIds":{"type":"array","description":"Job IDs.","items":{"type":"integer","format":"int64"}},"targetLanguages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","example":["en_GB"],"items":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}}}},"RSReopenWorkflowResponse":{"type":"object","properties":{"reopenedJobs":{"type":"array","description":"Reopened jobs","items":{"$ref":"#/components/schemas/RSReopenedJob"}}}},"RSReopenedJob":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Job ID."}}},"RSJobWorkflowMoveResponse":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64","description":"Job ID."},"result":{"type":"boolean","description":"Result successful or not."}}},"RSProjectWorkflowRejectResponse":{"type":"object","properties":{"jobs":{"type":"array","description":"Response for each job meant to be pushed forward or back in the workflow.","items":{"$ref":"#/components/schemas/RSJobWorkflowMoveResponse"}}}},"RSProjectWorkflowFinishResponse":{"type":"object","properties":{"jobs":{"type":"array","description":"Response for each job meant to be pushed forward or back in the workflow.","items":{"$ref":"#/components/schemas/RSJobWorkflowMoveResponse"}}}},"RSProjectWorkflowAssignment":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/RSProjectWorkflowAssignmentUser"},"languages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"},"uniqueItems":true},"stepNames":{"type":"array","deprecated":true,"description":"Workflow step names. This field is deprecated. Use `displayStepNames` or `stepReferenceNames`.","items":{"type":"string"},"uniqueItems":true},"referenceStepNames":{"type":"array","description":"Workflow reference step names.","items":{"type":"string"},"uniqueItems":true},"displayStepNames":{"type":"array","description":"Workflow display step names. This name is used as a label in the UI.","items":{"type":"string"},"uniqueItems":true},"jobIds":{"type":"array","description":"Job IDs","items":{"type":"integer","format":"int64"},"uniqueItems":true},"bundleIds":{"type":"array","description":"Bundle IDs","items":{"type":"integer","format":"int64"},"uniqueItems":true}}},"RSProjectWorkflowUserAssignmentResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSProjectSourceFile":{"type":"object","properties":{"sourceFileId":{"type":"integer","format":"int64","description":"Id of source file."},"targetLanguages":{"type":"array","description":"Target languages to add. Workflow id is optional.","items":{"$ref":"#/components/schemas/RSFileTargetLanguageRequest"}},"workflowId":{"type":"integer","format":"int64","description":"Workflow id for all target languages without specified workflow. This is optional field. By default will be used project workflow."},"tagIds":{"type":"array","description":"List of tag IDs.","items":{"type":"integer","format":"int64"}},"metadata":{"type":"string","description":"Metadata for file."},"metadataType":{"type":"string","description":"Type of metadata.","enum":["JSON"]}}},"RSProjectTargetLanguagesAddRequest":{"type":"object","description":"JSON format data to add, contains target languages codes.","properties":{"targetLanguages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.\n\nCreates jobs for every passed target language for all project files existing in the project.","items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}},"files":{"type":"array","description":"Source files from project added to specified target languages.","items":{"$ref":"#/components/schemas/RSProjectSourceFile"}}}},"RSProjectTargetLanguagesAddResponse":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64","description":"Project ID."},"projectName":{"type":"string","description":"Project name."},"jobs":{"type":"array","description":"List of jobs created in this project.","items":{"$ref":"#/components/schemas/RSProjectJob"}}}},"RSProjectsReanalyzeRequest":{"type":"object","description":"Request to reanalyze the project","properties":{"jobIds":{"type":"array","description":"List of job IDs to be reanalyzed.","items":{"type":"integer","format":"int64"}},"targetLanguages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","example":["en_GB"],"items":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}},"sourceFileIds":{"type":"array","description":"List of source file IDs to be reanalyzed.","items":{"type":"integer","format":"int64"}}}},"RSProjectJobInReanalysisTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}}},"RSProjectsReanalyzeResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Informs if the project reanalysis has started or not.","example":true},"jobsInReanalysis":{"type":"array","description":"List of jobs the reanalysis will be performed for.","items":{"$ref":"#/components/schemas/RSProjectJobInReanalysisTO"}}}},"RSEditorBundle":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}}},"RSEditorExternalUser":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"preferredLanguage":{"type":"string","description":"Preferred user language. See [API resources](#tag/Language-codes) for full list of available codes."},"dateFormat":{"type":"string","description":"Date format. See [API resources](#tag/Date-formats) for all date formats."},"timeFormat":{"type":"string","description":"Time format. See [API resources](#tag/Time-formats) for all time formats."},"timeZone":{"type":"string","description":"Time zone. See [API resources](#tag/Time-zones) for all time zones."}}},"RSEditorGeneralSettings":{"type":"object","properties":{"visibilityOptions":{"$ref":"#/components/schemas/RSEditorVisibilityOptions"},"matchesSortOrder":{"type":"string","enum":["QUALIFIER_SCORE_DATE","SCORE_DATE_QUALIFIER","QUALIFIER_SCORE_XLIFFDOCSTATUS_DATE"]},"lockPreviousStep":{"type":"string","enum":["NONE","INFO","FULL"]},"terminologySettings":{"$ref":"#/components/schemas/RSEditorTerminologySettings"},"downloadType":{"type":"string","enum":["NOT_ZIPPED"]},"taskManageType":{"type":"string","description":"These options corresponds to the \"Finish or reject tasks in XTM Workbench\" options available in the XTM Cloud Configuration page (Settings > Translation > Workflow and access > Linguist workflow options). This feature gives Linguists the option of finishing or rejecting the task from within XTM Workbench by clicking the corresponding button.","enum":["DISABLED","MANUAL_FINISH","MANUAL_FINISH_REJECT","AUTO_FINISH_REJECT"]},"editorMode":{"type":"string","default":"STANDARD","enum":["STANDARD","VISUAL"]},"accessMode":{"type":"string","enum":["READ_ONLY"]}}},"RSEditorHiddenFeatures":{"type":"object","properties":{"comments":{"type":"string","enum":["YES","NO"]},"concordance":{"type":"string","enum":["YES","NO"]},"history":{"type":"string","enum":["YES","NO"]},"inlineTagsTab":{"type":"string","enum":["YES","NO"]},"matches":{"type":"string","enum":["YES","NO"]},"terminologyTab":{"type":"string","enum":["YES","NO"]},"previewExcelExtendedTable":{"type":"string","enum":["YES","NO"]},"previewExcelMultilingual":{"type":"string","enum":["YES","NO"]},"previewHtml":{"type":"string","enum":["YES","NO"]},"previewHtmlInteractive":{"type":"string","enum":["YES","NO"]},"previewHtmlSourceTargetTable":{"type":"string","enum":["YES","NO"]},"previewPdf":{"type":"string","enum":["YES","NO"]},"previewPdfSourceTargetTable":{"type":"string","enum":["YES","NO"]},"previewPdfInteractive":{"type":"string","enum":["YES","NO"]},"otherXliffDocStatuses":{"type":"string","enum":["YES","NO"]}}},"RSEditorJob":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64"},"unitRanges":{"type":"array","description":"Ranges of units to open in the editor. Cannot be specified together with bundles.","items":{"$ref":"#/components/schemas/RSUnitRange"}},"lqaDecisionType":{"type":"string","enum":["NO","YES_SAVING_RESULTS_FOR_USER","YES_NOT_SAVING_RESULTS_FOR_USER","NO_SHOW_EXISTING_ERRORS"]},"fileGenerationOptions":{"$ref":"#/components/schemas/RSEditorJobFileGenerationOptions"},"bundles":{"type":"array","description":"Bundles to open in the editor. Cannot be specified together with unitRanges.","items":{"$ref":"#/components/schemas/RSEditorBundle"}}},"required":["jobId"]},"RSEditorJobFileGenerationOptions":{"type":"object","properties":{"target":{"type":"string","enum":["SHOW","HIDE"]},"html":{"type":"string","enum":["SHOW","HIDE"]},"htmlSideBySide":{"type":"string","enum":["SHOW","HIDE"]},"htmlInteractive":{"type":"string","enum":["SHOW","HIDE"]},"pdf":{"type":"string","enum":["SHOW","HIDE"]},"pdfSideBySide":{"type":"string","enum":["SHOW","HIDE"]},"pdfInteractive":{"type":"string","enum":["SHOW","HIDE"]},"extendedTable":{"type":"string","enum":["SHOW","HIDE"]},"xbenchInteractive":{"type":"string","enum":["SHOW","HIDE"]},"xliff":{"type":"string","enum":["SHOW","HIDE"]},"excelMultilingual":{"type":"string","enum":["SHOW","HIDE"]},"showUserNameInReport":{"type":"string","enum":["SHOW","HIDE"]}}},"RSEditorLinkRequest":{"type":"object","description":"Editor request parameters","properties":{"stepName":{"type":"string"},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/RSEditorJob"},"minItems":1},"userId":{"type":"integer","format":"int64","description":"User ID. Required if `externalUser` is not provided."},"externalUser":{"$ref":"#/components/schemas/RSEditorExternalUser"},"translationProperties":{"$ref":"#/components/schemas/RSEditorTranslationProperties"},"generalSettings":{"$ref":"#/components/schemas/RSEditorGeneralSettings"},"hiddenFeatures":{"$ref":"#/components/schemas/RSEditorHiddenFeatures"},"userSettings":{"$ref":"#/components/schemas/RSEditorUserSettings"}},"required":["jobs","stepName"]},"RSEditorTerminologySettings":{"type":"object","properties":{"redecorateInReplaceAll":{"type":"string","enum":["YES","NO"]},"redecorateOnEachUpdate":{"type":"string","enum":["YES","NO"]}}},"RSEditorTranslationProperties":{"type":"object","properties":{"googleTranslation":{"type":"string","enum":["YES","NO"]},"googleAPIKey":{"type":"string"},"approvingTM":{"type":"string","enum":["YES","NO"]},"notEditableICE":{"type":"string","enum":["YES","NO"]},"notApprovedTM":{"type":"string","enum":["YES","NO"]}}},"RSEditorUserSettings":{"type":"object","properties":{"terminologyRights":{"type":"array","description":"Set of terminology rights. If overrideFields does not contain TERMINOLOGY_RIGHTS, you can only limit rights available in user's settings.","items":{"type":"string","enum":["ADD","VIEW","IMPORT","EXPORT","DELETE","UPDATE_APPROVE","SUGGEST"]},"uniqueItems":true},"privacySettings":{"type":"array","description":"Set of privacy settings. It will be ignored if overrideFields does not contain PRIVACY_SETTINGS. The supplied settings must respect the global privacy settings determining the display of user details.","items":{"type":"string","enum":["SHOW_USER_DETAILS_IN_COMMENTS","SHOW_USER_DETAILS_IN_MATCHES","SHOW_USER_DETAILS_IN_SEGMENT_FILTERS","SHOW_USER_DETAILS_IN_SEGMENT_HISTORY","SHOW_USER_DETAILS_IN_TERMS","SHOW_WHO_LOCKS_SEGMENTS"]},"uniqueItems":true},"overrideFields":{"type":"array","description":"Fields that will override UI settings with provided data.","items":{"type":"string","enum":["TERMINOLOGY_RIGHTS","PRIVACY_SETTINGS"]},"uniqueItems":true}}},"RSEditorVisibilityOptions":{"type":"object","properties":{"userDescription":{"type":"string","enum":["SHOW","HIDE"]},"segmentId":{"type":"string","enum":["SHOW","HIDE"]}}},"RSUnitRange":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"}}},"RSEditorLinkResponse":{"type":"object","properties":{"url":{"type":"string"}}},"RSProjectEditorLinkRequest":{"type":"object","description":"Project Editor options","properties":{"defaultSection":{"type":"string","description":"Default opened section of Project Editor.","enum":["GENERAL","METRICS","STATISTICS","WORKFLOW","FILES","ESTIMATES","LQA"]},"estimates":{"type":"string","default":"SHOW","description":"Specifies whether Estimates tab is displayed or not.","enum":["SHOW","HIDE"]},"files":{"type":"string","default":"SHOW","description":"Specifies whether Files tab is displayed or not.","enum":["SHOW","HIDE"]},"general":{"type":"string","default":"SHOW","description":"Specifies whether General tab is displayed or not.","enum":["SHOW","HIDE"]},"metrics":{"type":"string","default":"SHOW","description":"Specifies whether Metrics tab is displayed or not.","enum":["SHOW","HIDE"]},"statistics":{"type":"string","default":"SHOW","description":"Specifies whether Statistics tab is displayed or not.","enum":["SHOW","HIDE"]},"workflow":{"type":"string","default":"SHOW","description":"Specifies whether Workflow tab is displayed or not.","enum":["SHOW","HIDE"]},"lqa":{"type":"string","default":"SHOW","description":"Specifies whether LQA tab is displayed or not.","enum":["SHOW","HIDE"]}}},"RSProjectEditorLinkResponse":{"type":"object","description":"Project Editor URL.","properties":{"url":{"type":"string","description":"URL to the Project Editor."}}},"RSProjectJobCancelResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Informs whether canceling jobs was successful or not.","example":true}}},"RSProjectWorkflowBundleRejectRequest":{"type":"object","properties":{"bundleIds":{"type":"array","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["bundleIds"]},"RSProjectWorkflowBundlesRejectResponse":{"type":"object","properties":{"rejectedBundles":{"type":"array","items":{"$ref":"#/components/schemas/RSRejectedBundle"}}}},"RSRejectedBundle":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}}},"RSProjectWorkflowBundleFinishRequest":{"type":"object","properties":{"bundleIds":{"type":"array","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["bundleIds"]},"RSFinishedBundle":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}}},"RSProjectWorkflowBundleFinishResponse":{"type":"object","properties":{"finishedBundles":{"type":"array","items":{"$ref":"#/components/schemas/RSFinishedBundle"}}}},"RSCompareDocxFilesGenerateRequest":{"type":"object","description":"JSON-format data for comparing docx files.","properties":{"revisedProjectId":{"type":"integer","format":"int64","description":"Revised project ID."},"revisedFileId":{"type":"integer","format":"int64","description":"Revised file ID. Must be a target file generated for a scope = \"JOB\"."}},"required":["revisedFileId","revisedProjectId"]},"RSCompareDocxFilesGenerateResponse":{"type":"object","properties":{"processId":{"type":"string"}}},"RSProjectTranslationFilesUploadRequest":{"type":"object","description":"List request files with optional name.","properties":{"fileType":{"type":"string","description":"File type.","enum":["XLIFF"]},"jobId":{"type":"integer","format":"int64","description":"Job ID."},"workflowStepName":{"type":"string","deprecated":true,"description":"Workflow step name with orderNumber. Is not required if xliffOptions.autopopulation is ENABLED"},"displayStepName":{"type":"string","description":"Workflow display step name. This name is used as a label in the UI."},"stepReferenceName":{"type":"string","description":"Workflow reference step name."},"translationFile":{"$ref":"#/components/schemas/RSUploadTranslationFile"},"xliffOptions":{"$ref":"#/components/schemas/RSXliffUploadOptions"}},"required":["fileType","jobId"]},"RSUploadTranslationFile":{"type":"object","properties":{"name":{"type":"string","description":"Overrides original filename for uploaded file."},"file":{"type":"string","format":"binary","description":"Uploads translation file to project."}},"required":["file"]},"RSXliffUploadOptions":{"type":"object","properties":{"autopopulation":{"type":"string","description":"Option for autopopulation. If step translate exists in the workflow","enum":["ENABLED","DISABLED"]},"segmentStatusApproving":{"type":"string","description":"Option for approving segments","enum":["NONE","ACCORDINGLY_TO_STATE","ALL_UPDATED_SEGMENTS","ALL_SEGMENTS"]}},"required":["autopopulation","segmentStatusApproving"]},"RSTranslationFile":{"type":"object","description":"Translation file response model.","properties":{"jobId":{"type":"integer","format":"int64","description":"Job ID."},"fileId":{"type":"integer","format":"int64","description":"File ID."}}},"RSTranslationFilesUploadResponse":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/RSTranslationFile"}}},"RSProjectFileUploadRequest":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/RSSourceFileRequest"},"minItems":1}},"required":["files"]},"RSProjectFileUploadResponse":{"type":"object","description":"Response description.","properties":{"projectId":{"type":"integer","format":"int64","description":"Project ID."},"name":{"type":"string","description":"Project name."},"jobs":{"type":"array","description":"List of jobs created depending on languages and files.","items":{"$ref":"#/components/schemas/RSProjectJob"}}}},"RSSegmentIdImageFile":{"type":"object","properties":{"name":{"type":"string","description":"Overrides original filename for uploaded segment-id image."},"file":{"type":"string","format":"binary","description":"Uploads segment-id image files to project. Files have to be archived and attached as a ZIP file."}},"required":["file"]},"RSUploadSegmentIdImagesRequest":{"type":"object","properties":{"segmentIdImageFiles":{"type":"array","items":{"$ref":"#/components/schemas/RSSegmentIdImageFile"}}}},"RSUploadSegmentIdImageResponse":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64","description":"Project ID."}}},"RSReferenceMaterialsFile":{"type":"object","properties":{"name":{"type":"string","description":"Overrides original filename for reference file."},"file":{"type":"string","format":"binary","description":"Uploads reference file to project."}},"required":["file"]},"RSUploadReferenceMaterialsRequest":{"type":"object","properties":{"referenceMaterialsFiles":{"type":"array","items":{"$ref":"#/components/schemas/RSReferenceMaterialsFile"}}}},"RSUploadReferenceMaterialsResponse":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64","description":"Project ID."}}},"RSPreviewFiles":{"type":"object","properties":{"name":{"type":"string","description":"Overrides original filename for uploaded preview file."},"file":{"type":"string","format":"binary","description":"Uploads preview file to project."}},"required":["file"]},"RSUploadPreviewFileRequest":{"type":"object","properties":{"previewFiles":{"type":"array","items":{"$ref":"#/components/schemas/RSPreviewFiles"}}}},"RSUploadPreviewFileResponse":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64","description":"Project ID."}}},"RSExcelExtendedTableOptions":{"type":"object","description":"Options for generating Excel Extended Table.","properties":{"includeSegmentId":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeSegmentKey":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeSource":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeTarget":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeXTMStatus":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeXliffDocStatus":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeComments":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeRevisions":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeMatches":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeQaWarnings":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeOnlySegmentsWithQaWarnings":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeLQAErrors":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includePreTranslatedText":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includePostEditedText":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeFinalText":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeEditDistanceScore":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"populateTargetWithSource":{"type":"string","enum":["POPULATE","DO_NOT_POPULATE"]},"languagesType":{"type":"string","enum":["ALL_LANGUAGES","SELECTED_LANGUAGES"]},"extendedReportType":{"type":"string","enum":["ALL_PROJECT_FILES_SINGLE_REPORT","ALL_PROJECT_FILES_MULTIPLE_REPORTS"]}}},"RSExtendedTableOptions":{"type":"object","description":"Options for generating extended tables.","properties":{"excelOptions":{"$ref":"#/components/schemas/RSExcelExtendedTableOptions","description":"Options for generating Excel Extended Table."},"pdfOptions":{"$ref":"#/components/schemas/RSPDFExtendedTableOptions","description":"Options for generating PDF Extended Table."},"htmlOptions":{"$ref":"#/components/schemas/RSHTMLExtendedTableOptions","description":"Options for generating HTML Extended Table."}}},"RSHTMLExtendedTableOptions":{"type":"object","description":"Options for generating HTML Extended Table.","properties":{"includeSegmentId":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeSegmentKey":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeSource":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeTarget":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeXTMStatus":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeXliffDocStatus":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeComments":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeRevisions":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeMatches":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeQaWarnings":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeOnlySegmentsWithQaWarnings":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeLQAErrors":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includePreTranslatedText":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includePostEditedText":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeFinalText":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeEditDistanceScore":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"populateTargetWithSource":{"type":"string","enum":["POPULATE","DO_NOT_POPULATE"]},"languagesType":{"type":"string","enum":["ALL_LANGUAGES","SELECTED_LANGUAGES"]},"extendedReportType":{"type":"string","enum":["ALL_PROJECT_FILES_SINGLE_REPORT","ALL_PROJECT_FILES_MULTIPLE_REPORTS"]}}},"RSPDFExtendedTableOptions":{"type":"object","description":"Options for generating PDF Extended Table.","properties":{"includeSegmentId":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeSegmentKey":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeSource":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeTarget":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeXTMStatus":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeXliffDocStatus":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeComments":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeRevisions":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeMatches":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeQaWarnings":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeOnlySegmentsWithQaWarnings":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeLQAErrors":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includePreTranslatedText":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includePostEditedText":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeFinalText":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"includeEditDistanceScore":{"type":"string","enum":["INCLUDE","DO_NOT_INCLUDE"]},"populateTargetWithSource":{"type":"string","enum":["POPULATE","DO_NOT_POPULATE"]},"languagesType":{"type":"string","enum":["ALL_LANGUAGES","SELECTED_LANGUAGES"]},"extendedReportType":{"type":"string","enum":["ALL_PROJECT_FILES_SINGLE_REPORT","ALL_PROJECT_FILES_MULTIPLE_REPORTS"]}}},"RSProjectFileGenerateRequest":{"type":"object","description":"Additional options for extended tables.","properties":{"extendedTableOptions":{"$ref":"#/components/schemas/RSExtendedTableOptions","description":"Additional options for extended tables."}}},"RSProjectFileGenerateResponse":{"type":"object","properties":{"fileId":{"type":"integer","format":"int64","description":"File ID."},"jobId":{"type":"integer","format":"int64","description":"Job ID."},"fileType":{"type":"string","description":"Type of a generated file.","enum":["TARGET","XLIFF","XLIFF_NTP","QA_REPORT","HTML","HTML_TABLE","PDF","PDF_TABLE","TIPP","HTML_EXTENDED_TABLE","HTML_COLOURED","HTML_COLOURED_BY_MATCH_RATE","PDF_EXTENDED_TABLE","PDF_COLOURED","PDF_COLOURED_BY_XLIFF_DOC_STATUS","PDF_COLOURED_BY_MATCH_RATE","TARGET_COLOURED_BY_MATCH_RATE","TARGET_COLOURED_BY_XLIFF_DOC_STATUS","XLIFF_DOC","LQA_REPORT","LQA_EXTENDED_TABLE_REPORT","TARGET_PSEUDO","MULTI_EXCEL","EXCEL_EXTENDED_TABLE"]}}},"RSProjectDeactivateResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Informs whether deactivating project was successful or not.","example":true}}},"RSProjectCustomField":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Custom Field definition ID."},"value":{"$ref":"#/components/schemas/RSProjectCustomFieldValue"}}},"RSProjectCustomFieldValue":{"type":"object","properties":{"ids":{"type":"array","description":"Custom Field value IDs only for dropdown and multiselect.","items":{"type":"integer","format":"int64"}},"value":{"type":"string"},"date":{"type":"string","description":"Date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"booleanValue":{"type":"boolean"}}},"RSCostsAssignment":{"type":"object","properties":{"override":{"type":"string","enum":["OVERRIDE_MISSING","OVERRIDE_ALL"]},"userId":{"type":"integer","format":"int64"},"userType":{"type":"string","enum":["INTERNAL_LINGUIST","LSP"]}}},"RSCostsGenerateRequest":{"type":"object","properties":{"missingRates":{"type":"string","description":"Default from Client settings.","enum":["ZERO","NONE"]},"missingTime":{"type":"string","description":"Default from Client settings.","enum":["ZERO","NONE"]},"source":{"type":"string","enum":["INITIAL_METRICS","CURRENT_METRICS","STATISTICS_SOURCE","STATISTICS_TARGET","TIME_OR_STATISTICS_SOURCE","TIME_OR_STATISTICS_TARGET","TIME_OR_METRICS_INITIAL","TIME_OR_METRICS_CURRENT"]},"assignment":{"$ref":"#/components/schemas/RSCostsAssignment"}},"required":["source"]},"RSCostsGenerateResponse":{"type":"object","properties":{"costId":{"type":"integer","format":"int64"}}},"RSGeneratePORequest":{"type":"object","description":"JSON format data to generate PO.","properties":{"customFieldIds":{"type":"array","description":"Defines which custom fields should be printed in the response.","items":{"type":"integer","format":"int64"}},"sendEmail":{"type":"string","description":"The email with PO is sent only if Send PO to linguist or to its creator options are enabled in XTM under: Configuration->Data->Estimates->PO Settings.","enum":["SEND_EMAIL"]}}},"RSProjectCostsGeneratePOResponse":{"type":"object","properties":{"processId":{"type":"string"}}},"RSProjectAddCallbacksRequest":{"type":"object","description":"JSON request body used to add callbacks to a project.","properties":{"projectCreatedCallbacks":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectCreatedCallback"}},"projectAcceptedCallbacks":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectAcceptedCallback"}},"projectFinishedCallbacks":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectFinishedCallback"}},"jobFinishedCallbacks":{"type":"array","items":{"$ref":"#/components/schemas/RSJobFinishedCallback"}},"analysisFinishedCallbacks":{"type":"array","items":{"$ref":"#/components/schemas/RSAnalysisFinishedCallback"}},"workflowTransitionCallbacks":{"type":"array","items":{"$ref":"#/components/schemas/RSWorkflowTransitionCallback"}},"invoiceStatusChangedCallbacks":{"type":"array","items":{"$ref":"#/components/schemas/RSInvoiceStatusChangedCallback"}},"sourceFileUpdatedCallbacks":{"type":"array","items":{"$ref":"#/components/schemas/RSSourceFileUpdatedCallback"}},"projectActivityChangedCallbacks":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectActivityChangedCallback"}},"projectLanguageChangedCallbacks":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectLanguageChangedCallback"}},"dueDateChangedCallbacks":{"type":"array","items":{"$ref":"#/components/schemas/RSDueDateChangedCallback"}}}},"RSAddAnalysisFinishedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSAddDueDateChangedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSAddInvoiceStatusChangedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSAddJobFinishedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSAddProjectAcceptedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSAddProjectActivityChangedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSAddProjectCreatedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSAddProjectFinishedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSAddProjectLanguageChangedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSAddSourceFileUpdatedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSAddWorkflowTransitionCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSProjectAddCallbacksResponse":{"type":"object","properties":{"analysisFinishedCallbacks":{"type":"array","description":"Added analysisFinished callbacks.","items":{"$ref":"#/components/schemas/RSAddAnalysisFinishedCallbackResponse"}},"dueDateChangedCallbacks":{"type":"array","description":"Added dueDateChanged callbacks.","items":{"$ref":"#/components/schemas/RSAddDueDateChangedCallbackResponse"}},"invoiceStatusChangedCallbacks":{"type":"array","description":"Added invoiceStatusChanged callbacks.","items":{"$ref":"#/components/schemas/RSAddInvoiceStatusChangedCallbackResponse"}},"jobFinishedCallbacks":{"type":"array","description":"Added jobFinished callbacks.","items":{"$ref":"#/components/schemas/RSAddJobFinishedCallbackResponse"}},"projectAcceptedCallbacks":{"type":"array","description":"Added projectAccepted callbacks.","items":{"$ref":"#/components/schemas/RSAddProjectAcceptedCallbackResponse"}},"projectActivityChangedCallbacks":{"type":"array","description":"Added projectActivityChanged callbacks.","items":{"$ref":"#/components/schemas/RSAddProjectActivityChangedCallbackResponse"}},"projectCreatedCallbacks":{"type":"array","description":"Added projectCreated callbacks.","items":{"$ref":"#/components/schemas/RSAddProjectCreatedCallbackResponse"}},"projectFinishedCallbacks":{"type":"array","description":"Added projectFinished callbacks.","items":{"$ref":"#/components/schemas/RSAddProjectFinishedCallbackResponse"}},"projectLanguageChangedCallbacks":{"type":"array","description":"Added projectLanguageChanged callbacks.","items":{"$ref":"#/components/schemas/RSAddProjectLanguageChangedCallbackResponse"}},"sourceFileUpdatedCallbacks":{"type":"array","description":"Added sourceFileUpdated callbacks.","items":{"$ref":"#/components/schemas/RSAddSourceFileUpdatedCallbackResponse"}},"workflowTransitionCallbacks":{"type":"array","description":"Added workflowTransition callbacks.","items":{"$ref":"#/components/schemas/RSAddWorkflowTransitionCallbackResponse"}}}},"RSArchiveProjectResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSActivateProjectResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSFindProjectTemplateRequest":{"type":"object","properties":{"ids":{"type":"array","description":"IDs of templates.","items":{"type":"integer","format":"int64"}},"customerIds":{"type":"array","description":"IDs of customers.","items":{"type":"integer","format":"int64"}},"scope":{"type":"string","default":"ALL","description":"Scope of templates.","enum":["ALL","GLOBAL","CUSTOMERS"]},"customFields":{"type":"array","description":"Custom field's ids and values.","items":{"$ref":"#/components/schemas/RSProjectCustomField"}}}},"RSProjectTemplateResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Template ID."},"name":{"type":"string","description":"Template name."},"customerId":{"type":"integer","format":"int64","description":"ID of customer that owns template. Null if it is a global template."}}},"RSGenerateStatisticsResponse":{"type":"object","properties":{"processId":{"type":"string"}}},"RSFindProjectPostRequest":{"type":"object","properties":{"name":{"type":"string","description":"Project name."},"ids":{"type":"array","description":"IDs of projects.","items":{"type":"integer","format":"int64"}},"externalIds":{"type":"array","description":"External IDs of projects.","items":{"type":"integer","format":"int64"}},"customerIds":{"type":"array","description":"IDs of customers.","items":{"type":"integer","format":"int64"}},"status":{"type":"string","description":"Project status.","enum":["NOT_STARTED","STARTED","FINISHED"]},"createdDateFrom":{"type":"string","description":"Minimum project creation date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"createdDateTo":{"type":"string","description":"Maximum project creation date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"finishedDateFrom":{"type":"string","description":"Minimum project finish date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"finishedDateTo":{"type":"string","description":"Maximum project finish date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"modifiedDateFrom":{"type":"string","description":"Minimum project last modified date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"modifiedDateTo":{"type":"string","description":"Maximum project last modified date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"page":{"type":"integer","format":"int32","default":1,"description":"Page number."},"pageSize":{"type":"integer","format":"int32","default":1000,"description":"Number of elements listed on page."},"activity":{"type":"array","items":{"type":"string","enum":["ACTIVE","ARCHIVED","AUTO_ARCHIVED","INACTIVE","ACTIVATING","ARCHIVING","AUTO_ARCHIVING"]},"uniqueItems":true},"customFields":{"type":"array","description":"Custom field's ids and values.","items":{"$ref":"#/components/schemas/RSProjectCustomField"}},"creatorIds":{"type":"array","description":"IDs of Project Creators.","items":{"type":"integer","format":"int64"}},"projectManagerIds":{"type":"array","description":"IDs of Project Managers.","items":{"type":"integer","format":"int64"}}}},"RSProjectResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Project ID."},"externalId":{"type":"integer","format":"int64","description":"Project ID."},"name":{"type":"string","description":"Project name."},"status":{"type":"string","description":"Project status.","enum":["NOT_STARTED","STARTED","FINISHED"]},"activity":{"type":"string","description":"Project activity.","enum":["ACTIVE","ARCHIVED","AUTO_ARCHIVED","INACTIVE","ACTIVATING","ARCHIVING","AUTO_ARCHIVING"]},"joinFilesType":{"type":"string","description":"Type of file joining.","enum":["EXTENSION","DITA_MAP","NOT_JOINED"]},"joinFilesDitaLevel":{"type":"integer","format":"int32","description":"DITA Map level when mapping by DITA Map is used."},"modificationDate":{"type":"string","format":"epoch","description":"Date of project's last modification.","example":1774765345571},"lastUsageDate":{"type":"string","format":"epoch","description":"Date of project's last usage.","example":1774765345571},"wordCount":{"type":"integer","format":"int64","description":"Project's word count"},"totalWWC":{"type":"integer","format":"int64","description":"Project's total WWC (Weighted Word Count)"},"remainingWWC":{"type":"integer","format":"int64","description":"Project's remaining WWC (Weighted Word Count)"},"projectManagerId":{"type":"integer","format":"int64","description":"Project manager ID."},"creatorId":{"type":"integer","format":"int64","description":"Project creator ID."},"ditaMapLevel":{"type":"integer","format":"int32","writeOnly":true},"filesJoiningType":{"type":"string","enum":["EXTENSION","DITA_MAP","NOT_JOINED"],"writeOnly":true}}},"RSProjectsMultiCreationModelAttributeRequest":{"type":"object","description":"Request fields for project creation.","properties":{"name":{"type":"string","description":"Name for project. Project name cannot contain any of the following characters: , /, :, *, ?, \", <, >, |, {, }, [TAB].","maxLength":100,"minLength":1},"description":{"type":"string","description":"The description of project."},"workflowId":{"type":"integer","format":"int64","description":"ID of main workflow definition."},"workflowName":{"type":"string","description":"Project's workflow name."},"dueDate":{"type":"string","description":"Project's due date."},"customerId":{"type":"integer","format":"int64","description":"Customer ID."},"projectManagerId":{"type":"integer","format":"int64","description":"ID of Project Manager who has an access to a given Customer."},"templateId":{"type":"integer","format":"int64","description":"Template ID."},"filterTemplateId":{"type":"string","description":"Filter template ID"},"translationFiles":{"type":"array","description":"Files to translate.","items":{"$ref":"#/components/schemas/RSSourceFileMultiCreateRequest"}},"referenceFiles":{"type":"array","description":"Reference materials.","items":{"$ref":"#/components/schemas/RSReferenceFilesRequest"}},"callbacks":{"$ref":"#/components/schemas/RSProjectCallbacks","description":"Project's callbacks."},"externalCreatorId":{"type":"integer","format":"int64"},"groupFilesDitaLevel":{"type":"integer","format":"int32","description":"If no values are provided for DITA_MAP, the system tries to retrieve them in the following order: 1) from XTM Templates 2) from Client settings. If no values are found in the two configurations, an error message is displayed."},"segmentLockingType":{"type":"string","description":"DISABLED - disables this option
    ANY_100_MATCH - segments with approved and not approved leveraged or ICE matches will be locked
    APPROVED_100_MATCH - segments with approved leveraged or ICE matches will be locked
    XLIFFDOC_TRANSLATED, XLIFFDOC_PROOFED, XLIFFDOC_VALIDATED - segments with a specific xliff:doc status will be locked","enum":["DISABLED","ANY_100_MATCH","APPROVED_100_MATCH","XLIFFDOC_TRANSLATED","XLIFFDOC_PROOFED","XLIFFDOC_VALIDATED"]},"subjectMatterId":{"type":"integer","format":"int64","description":"Subject matter ID."},"workflowDueDate":{"type":"string","description":"Workflow due date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"workflowStartDate":{"type":"string","description":"Workflow start date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"filesTargetLanguagesGrouping":{"type":"string","enum":["BY_SOURCE_LANGUAGE","BY_LANGUAGE_COMBINATIONS"]},"fileProcessType":{"type":"string","enum":["JOIN"]},"groupFilesType":{"type":"string","description":"Activates file grouping in XTM, where you can specify the type of grouping in projects. If no values are provided, the system tries to retrieve them in the following order: 1) from XTM Templates; 2) from Client settings.","enum":["FILE_EXTENSION","DITA_MAP","NO_GROUP"]}},"required":["customerId","name"]},"RSSourceFileMultiCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"Overrides original filename for uploaded preview file. It should include the file extension."},"file":{"type":"string","format":"binary","description":"The file."},"targetLanguages":{"type":"array","description":"File target language codes. See [API resources](#tag/Language-codes) for full list of available codes.","items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}},"targetLanguagesV2":{"type":"array","description":"File target languages object. Contains list of objects describing target languages.","items":{"$ref":"#/components/schemas/RSFileTargetLanguageRequest"}},"sourceLanguage":{"type":"string","description":"File source language code. See [API resources](#tag/Language-codes) for full list of available codes."},"workflowId":{"type":"integer","format":"int64","description":"Workflow definition ID."},"tagIds":{"type":"array","description":"List of tag IDs.","items":{"type":"integer","format":"int64"}},"translationType":{"type":"string","description":"Value 'DO_NOT_TRANSLATE' Allows to add file without translation. Target languages must not be specified when 'DO_NOT_TRANSLATE' is used.","enum":["TRANSLATE","DO_NOT_TRANSLATE"]},"metadata":{"type":"string","description":"Metadata for file."},"metadataType":{"type":"string","description":"Type of metadata.","enum":["JSON"]}},"required":["file"]},"RSProjectsMultiCreationResponse":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectCreationResponse"}},"incorrectFiles":{"type":"array","items":{"type":"string"}}}},"RSProjectCloneModelAttributeRequest":{"type":"object","description":"Request fields for project creation.","properties":{"name":{"type":"string","description":"Name of the new project.\nProject name cannot contain any of the following characters: , /, :, *, ?, \", <, >, |, {, }, [TAB].","maxLength":100,"minLength":1},"originId":{"type":"integer","format":"int64","description":"ID of the project to be cloned."},"options":{"$ref":"#/components/schemas/RSProjectCloneOptions","description":"Cloning options."}},"required":["originId"]},"RSProjectCloneOptions":{"type":"object","properties":{"workflowState":{"type":"string","description":"\n\nKEEP_ORIGINAL - all workflow states are copied from the source project. Exception: Project analysis is triggered on the newly created project.\n\nRESET - all workflows are reset to the initial steps.\n\nRESET_EXCLUDING_FINISHED (default) - all workflows are reset to the initial steps. Exception: Finished workflows remain finished in the newly created cloned project.","enum":["KEEP_ORIGINAL","RESET","RESET_EXCLUDING_FINISHED"]}}},"RSProjectCloneResponse":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64","description":"Project ID."},"name":{"type":"string","description":"Project name."},"jobs":{"type":"array","description":"Job details.","items":{"$ref":"#/components/schemas/RSProjectJob"}}}},"RSExternalUserCreateRequest":{"type":"object","description":"JSON format data with fields used to create external user.","properties":{"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"username":{"type":"string","description":"Username"},"email":{"type":"string","description":"Email"},"integrationId":{"type":"string","description":"User's ID used in the integration"}},"required":["firstName","integrationId","lastName","username"]},"RSExternalUserCreateResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"firstName":{"type":"string"},"lastName":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"integrationId":{"type":"string"}}},"RSAddressInfo":{"type":"object","description":"AddressInformation.","properties":{"address1":{"type":"string","description":"Address part 1."},"address2":{"type":"string","description":"Address part 2."},"city":{"type":"string","description":"City."},"state":{"type":"string","description":"State."},"postCode":{"type":"string","description":"Post code."},"country":{"type":"string","description":"Country 3-letter code.","enum":["AFG","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BIH","BWA","BRA","VGB","BRN","BGR","BFA","BDI","KHM","CMR","CAN","CPV","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COK","CRI","HRV","CUB","CYP","CZE","COG","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","ETH","FRO","FLK","FJI","FIN","FRA","GUF","PYF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GIN","GNB","GUY","HTI","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","ISR","ITA","CIV","JAM","JPN","JOR","KAZ","KEN","KIR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MKD","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","ANT","NCL","NZL","NIC","NER","NGA","NIU","NFK","PRK","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","POL","PRT","PRI","QAT","COD","REU","ROU","RUS","RWA","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SVK","SVN","SLB","SOM","ZAF","KOR","ESP","LKA","SHN","KNA","LCA","SPM","VCT","SDN","SUR","SWZ","SWE","CHE","SYR","TWN","TJK","TZA","THA","TGO","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","URY","UZB","VUT","VAT","VEN","VNM","WLF","ESH","YEM","ZMB","ZWE"]},"phone":{"type":"string","description":"Phone number."},"phone2":{"type":"string","description":"Phone number."},"mobilePhone":{"type":"string","description":"Mobile phone number."},"website":{"type":"string","description":"Website url."},"vatNumber":{"type":"string","description":"VAT number."},"email":{"type":"string","description":"Email address."},"skype":{"type":"string","description":"Skype address"},"msn":{"type":"string","description":"Msn address."},"fax":{"type":"string","description":"Fax."}}},"RSCreateCustomerTO":{"type":"object","properties":{"name":{"type":"string","description":"Customer name."},"nickName":{"type":"string","description":"Customer nickname."},"tmAndTermOnly":{"type":"boolean","description":"TM and Terminology only."},"projectManagerId":{"type":"integer","format":"int64","description":"Project manager id."},"projectWatcherIds":{"type":"array","description":"List of Project watchers ids.","items":{"type":"integer","format":"int64"}},"address":{"$ref":"#/components/schemas/RSAddressInfo"}},"required":["name"]},"RSCreateCustomerResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"RSAddCallbackPropertiesRequest":{"type":"object","properties":{"callbackProperties":{"type":"array","description":"Callback properties.","items":{"$ref":"#/components/schemas/RSAddCallbackPropertyRequest"},"minItems":1}},"required":["callbackProperties"]},"RSAddCallbackPropertyRequest":{"type":"object","properties":{"callbackType":{"type":"string","description":"Callback type.","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]},"propertyScope":{"type":"string","default":"CLIENT","description":"Callback property scope. `CLIENT` indicates that a property is applied for every project that is created. `CUSTOMER` indicates that a property is only applied for a project created for the specified customer.","enum":["CUSTOMER","CLIENT"]},"customerId":{"type":"integer","format":"int64","description":"Customer ID. Required if CUSTOMER propertyScope is set."},"url":{"type":"string","description":"Callback URL address.","minLength":1}},"required":["callbackType","url"]},"RSAddCallbackPropertiesResponseWrapper":{"type":"object","properties":{"callbackProperties":{"type":"array","description":"Callback properties.","items":{"$ref":"#/components/schemas/RSAddCallbackPropertyResponse"}}}},"RSAddCallbackPropertyResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback property ID."},"callbackType":{"type":"string","description":"Callback type.","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]},"propertyScope":{"type":"string","description":"Callback property scope. `CLIENT` indicates that a property is applied for every project that is created. `CUSTOMER` indicates that a property is only applied for a project created for the specified customer.","enum":["CUSTOMER","CLIENT"]},"customerId":{"type":"integer","format":"int64","description":"Customer ID."},"url":{"type":"string","description":"Callback URL address."}}},"RSAddCallbackAuthenticationRequest":{"type":"object","properties":{"name":{"type":"string","description":"Callback authentication name.","minLength":1},"domain":{"type":"string","description":"Callback authentication domain URL address. Required if authenticationScope is DOMAIN."},"authenticationType":{"type":"string","description":" Authentication mechanism that is used by the callback.","enum":["BASIC","SIGNATURE","OAUTH_2"]},"authenticationScope":{"type":"string","default":"DOMAIN","description":"Scope of authentication used for the callback.","enum":["CLIENT","DOMAIN"]},"signatureDetails":{"$ref":"#/components/schemas/RSCallbackSignatureDetailsRequest","description":"Details for SIGNATURE authentication type. Required if SIGNATURE authenticationType is set."},"basicDetails":{"$ref":"#/components/schemas/RSCallbackBasicDetailsRequest","description":"Details for BASIC authentication type. Required if BASIC authenticationType is set."},"oauth2Details":{"$ref":"#/components/schemas/RSCallbackOAuth2DetailsRequest"}},"required":["authenticationType","name"]},"RSAddCallbackAuthenticationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback authentication ID."},"name":{"type":"string","description":"Callback authentication name."},"domain":{"type":"string","description":"Callback authentication domain URL address."},"authenticationType":{"type":"string","description":" Authentication mechanism that is used by the callback.","enum":["BASIC","SIGNATURE","OAUTH_2"]},"authenticationScope":{"type":"string","description":"Scope of authentication used for the callback.","enum":["CLIENT","DOMAIN"]},"createDate":{"type":"string","format":"epoch","description":"Callback authentication creation date.","example":1774765345571},"basicDetails":{"$ref":"#/components/schemas/RSCallbackBasicDetails","description":"Details for BASIC authentication type."},"oauth2Details":{"$ref":"#/components/schemas/RSCallbackOAuth2Details"}}},"RSTokenGenerateRequest":{"type":"object","description":"Request object for token generation.","properties":{"client":{"type":"string","description":"Your XTM Company name."},"password":{"type":"string","description":"User password."},"userId":{"type":"integer","format":"int64","description":"User ID."}},"required":["client","password","userId"]},"RSTokenGenerateResponse":{"type":"object","description":"AuthorizationResponse","properties":{"token":{"type":"string","description":"Authentication token."}}},"RSUserPatchRequest":{"type":"object","description":"Request fields for user update","properties":{"username":{"type":"string","description":"User's username."},"firstName":{"type":"string","description":"User's first name."},"lastName":{"type":"string","description":"User's last name."},"nickname":{"type":"string","description":"User's nickname."},"password":{"type":"string","description":"User's password."},"userTitle":{"type":"string","description":"User's title.","enum":["MR","MRS","MS","MISS","DR"]},"currency":{"type":"string","description":"User's currency. See [API resources](#tag/Currencies) for full list of available currencies.","x-example":"en_GB"},"email":{"type":"string","description":"User's email."},"availability":{"type":"string","description":"User's availability.","enum":["AVAILABLE","UNAVAILABLE"]},"address":{"$ref":"#/components/schemas/RSUserAddress"}}},"RSTagGroupPatchRequest":{"type":"object","description":"JSON format data with fields used to update the resource.","properties":{"name":{"type":"string"},"customerSelectionType":{"type":"string","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"RSTagGroupPatchResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"customerSelectionType":{"type":"string","description":"Type of customer selection. The `ALL_CUSTOMERS` value indicates that all available customers from your XTM Cloud instance are assigned to the relevant tag group.","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}},"tagIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"RSTagPatchRequest":{"type":"object","description":"JSON format data with fields used to update the resource.","properties":{"name":{"type":"string"},"customerSelectionType":{"type":"string","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"RSTagPatchResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"customerSelectionType":{"type":"string","description":"Type of customer selection. The `ALL_CUSTOMERS` value indicates that all customers from the tag group are assigned to the relevant tag.","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"RSProjectWorkflowUpdatePatchRequest":{"type":"object","description":"JSON format data to update workflow steps.","properties":{"jobIds":{"type":"array","description":"Job ID.","items":{"type":"integer","format":"int64"}},"id":{"type":"string","description":"Workflow ID. The ID can be obtained from the [obtain workflows method](#tag/Project-workflows/operation/obtainWorkflows) response.","minLength":1},"targetLanguages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","example":["en_GB"],"items":{"type":"string","description":"items","x-example":"en_GB"}},"steps":{"type":"array","description":"Steps to update","items":{"$ref":"#/components/schemas/RSProjectWorkflowUpdateStepPatchRequest"},"minItems":1}},"required":["id","steps"]},"RSProjectWorkflowUpdateStepPatchRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Step ID."},"name":{"type":"string","description":"Workflow step name."},"dueDate":{"type":"string","description":"Due date in ISO-8601 date format. See [API resources](#tag/ISO-8601-Date-format) for details."},"tmApproval":{"type":"string","description":"Type of TM Approval. Cannot be applied for automatic or offline steps.","enum":["ENABLED","DISABLED"]},"costsCalculationBasedOnManualTime":{"type":"string","description":"Costs calculation based on manual time. Cannot be applied for automatic steps. Only available when manual time tracking is enabled in configuration.","enum":["ENABLED","DISABLED"]},"lqaType":{"type":"string","description":"Type of LQA. Cannot be applied for automatic or offline steps.","enum":["ENABLED_SAVING_RESULTS_FOR_USER","ENABLED_NOT_SAVING_RESULTS_FOR_USER","DISABLED_BUT_SHOW_EXISTING_ERRORS","DISABLED"]},"finishTaskOption":{"type":"string","description":"Finish task options. Can be specified by subcontractor. Cannot be applied for automatic or offline steps.","enum":["NONE","ALL_SEGMENT_DONE"]},"blockingType":{"type":"string","description":"Step blocking type. Can be specified by subcontractor.","enum":["FULL_BLOCKING","PART_BLOCKING","NO_BLOCKING"]}},"required":["name"]},"RSProjectJobsWorkflowPatchRequest":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64","description":"Job ID."},"workflowId":{"type":"integer","format":"int64","description":"Workflow definition ID."}}},"RSProjectJobsWorkflowPatchResponse":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64","description":"Job ID."},"success":{"type":"boolean","description":"Result of workflow definition update."}}},"RSUpdatePatchProjectCallbackRequest":{"type":"object","description":"JSON format data to update project.","properties":{"url":{"type":"string","description":"URL to update.","minLength":1}},"required":["url"]},"RSUpdatePatchProjectCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback ID."},"projectId":{"type":"integer","format":"int64","description":"Project ID."},"url":{"type":"string","description":"Callback URL."},"type":{"type":"string","description":"Callback type.","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]}}},"RSExternalUserPatchRequest":{"type":"object","description":"JSON format data with fields used to update the resource.","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"integrationId":{"type":"string"}}},"RSExternalUserPatchResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"firstName":{"type":"string"},"lastName":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"integrationId":{"type":"string"}}},"RSPatchCallbackPropertyRequest":{"type":"object","properties":{"callbackType":{"type":"string","description":"Callback type.","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]},"propertyScope":{"type":"string","description":"Callback property scope. `CLIENT` indicates that a property is applied for every project that is created. `CUSTOMER` indicates that a property is only applied for a project created for the specified customer.","enum":["CUSTOMER","CLIENT"]},"customerId":{"type":"integer","format":"int64","description":"Customer ID. Required if CUSTOMER propertyScope is set."},"url":{"type":"string","description":"Callback URL address."}}},"RSPatchCallbackAuthenticationRequest":{"type":"object","properties":{"name":{"type":"string","description":"Callback authentication name."},"domain":{"type":"string","description":"Callback authentication domain URL address. Required if authenticationScope is DOMAIN."},"authenticationType":{"type":"string","description":" Authentication mechanism that is used by the callback.","enum":["BASIC","SIGNATURE","OAUTH_2"]},"authenticationScope":{"type":"string","description":"Scope of authentication used for the callback.","enum":["CLIENT","DOMAIN"]},"signatureDetails":{"$ref":"#/components/schemas/RSCallbackSignatureDetailsRequest","description":"Details for SIGNATURE authentication type. Required if SIGNATURE authenticationType is set."},"basicDetails":{"$ref":"#/components/schemas/RSCallbackBasicDetailsRequest","description":"Details for BASIC authentication type. Required if BASIC authenticationType is set."},"oauth2Details":{"$ref":"#/components/schemas/RSCallbackOAuth2DetailsRequest"}}},"RSPatchCallbackAuthenticationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback authentication ID."},"name":{"type":"string","description":"Callback authentication name."},"domain":{"type":"string","description":"Callback authentication domain URL address."},"authenticationType":{"type":"string","description":" Authentication mechanism that is used by the callback.","enum":["BASIC","SIGNATURE","OAUTH_2"]},"authenticationScope":{"type":"string","description":"Scope of authentication used for the callback.","enum":["CLIENT","DOMAIN"]},"createDate":{"type":"string","format":"epoch","description":"Callback authentication creation date.","example":1774765345571},"basicDetails":{"$ref":"#/components/schemas/RSCallbackBasicDetails","description":"Details for BASIC authentication type."},"oauth2Details":{"$ref":"#/components/schemas/RSCallbackOAuth2Details"}}},"RSWorkflowResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Workflow ID."},"name":{"type":"string","description":"Workflow name."},"steps":{"type":"array","description":"Workflow steps included in this workflow.","items":{"$ref":"#/components/schemas/RSWorkflowStep"}}}},"RSWorkflowStep":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["ONLINE_TRANSLATION","OFFLINE_PROCESSING_READ_ONLY","OFFLINE_PROCESSING","AUTOMATIC_ACTIONS","OUTER_AUTOMATIC","OUTER_MANUAL"]}}},"RSWorkflowStepDefinitionResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Workflow step ID."},"name":{"type":"string","description":"Workflow step name."},"role":{"type":"string","description":"Workflow step role.","enum":["TRANSLATE","REVIEW","CORRECT","NON_CAT_TOOL_PROCESS","MANAGEMENT_TASK","LQA"]},"activity":{"type":"string","description":"Workflow step activity.","enum":["ACTIVE","INACTIVE"]},"description":{"type":"string","description":"Workflow step description."},"type":{"type":"string","description":"Workflow step type.","enum":["ONLINE_TRANSLATION","OFFLINE_PROCESSING_READ_ONLY","OFFLINE_PROCESSING","AUTOMATIC_ACTIONS","EXTERNAL_AUTOMATIC","EXTERNAL_MANUAL"]},"creator":{"type":"string","description":"Workflow step creator.","enum":["INTERNAL","CONTRACTOR","SUBCONTRACTOR","API"]}}},"RSFindUserResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User's ID."},"username":{"type":"string","description":"Username of a user."},"firstName":{"type":"string","description":"First ame of a user."},"lastName":{"type":"string","description":"Last name of a user."},"address":{"$ref":"#/components/schemas/RSAddressInfo","description":"Address of a user."},"userType":{"type":"string","enum":["INTERNAL_USER","LSP","EXTERNAL_USER"]}}},"RSGetUserWorkflowStepsResponse":{"type":"object","properties":{"ids":{"type":"array","description":"Workflow step IDs.","items":{"type":"integer","format":"int64"}}}},"RSGetUserSubjectMattersResponse":{"type":"object","properties":{"ids":{"type":"array","description":"IDs of subject matters.","items":{"type":"integer","format":"int64"}}}},"RSFindRateCardsResponse":{"type":"object","properties":{"defaultCurrency":{"type":"string","description":"Default currency. See [API resources](#tag/Currencies) for all currency codes."},"rateCards":{"type":"array","items":{"$ref":"#/components/schemas/RSRateCard"}}}},"RSRateCard":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"activity":{"type":"string","enum":["ACTIVE","INACTIVE"]},"currency":{"type":"string","description":"Default currency. See [API resources](#tag/Currencies) for all currency codes."},"languageCombinations":{"type":"array","items":{"$ref":"#/components/schemas/RSRateCardLanguagePair"}},"languageCombinationsType":{"type":"string","enum":["ALL","CUSTOMISED"]},"subjectMatterIds":{"type":"array","items":{"type":"integer","format":"int64"}},"subjectMattersType":{"type":"string","enum":["ALL","CUSTOMISED"]},"description":{"type":"string"},"calculateType":{"type":"string","enum":["FACTORS","FIXED_PRICE"]},"chargingType":{"type":"string","enum":["PER_WORD","PER_CHARACTER"]},"baseRate":{"type":"number"},"unitsPerDay":{"type":"number"},"minCharge":{"type":"number"},"minChargePerLanguage":{"type":"number"},"fixedProjectPrice":{"type":"number"},"fixedLanguagePrice":{"type":"number"},"fixedFilePrice":{"type":"number"},"managementFeePercentage":{"type":"number"},"minManagementFee":{"type":"number"},"halvedManagementFee":{"type":"boolean"},"rushJobPremiumPercentage":{"type":"number"},"rates":{"type":"array","items":{"$ref":"#/components/schemas/RSRateCardRates"}}}},"RSRateCardLanguage":{"type":"object","properties":{"languageGroupId":{"type":"integer","format":"int64"},"languageCode":{"type":"string","description":"Language code. See [API resources](#tag/Language-codes) for full list of available codes."}}},"RSRateCardLanguagePair":{"type":"object","properties":{"fromLanguage":{"$ref":"#/components/schemas/RSRateCardLanguage"},"toLanguage":{"$ref":"#/components/schemas/RSRateCardLanguage"}}},"RSRateCardRates":{"type":"object","properties":{"minCharge":{"type":"number"},"minChargePerLanguage":{"type":"number"},"fixedProjectPrice":{"type":"number"},"fixedLanguagePrice":{"type":"number"},"fixedFilePrice":{"type":"number"},"managementFeePercentage":{"type":"number"},"rushJobPremiumPercentage":{"type":"number"},"stepName":{"type":"string"},"hourPrice":{"type":"number"},"noMatch":{"type":"number"},"iceMatch":{"type":"number"},"leveragedMatch":{"type":"number"},"nonTrans":{"type":"number"},"highFuzzyMatch":{"type":"number"},"mediumFuzzyMatch":{"type":"number"},"lowFuzzyMatch":{"type":"number"},"repeat":{"type":"number"},"highFuzzyRepeat":{"type":"number"},"mediumFuzzyRepeat":{"type":"number"},"lowFuzzyRepeat":{"type":"number"},"machineTranslation":{"type":"number"},"fixedTextUnitPrice":{"type":"number"}}},"RSGetUserLanguageCombinationsResponse":{"type":"object","properties":{"languageCombinations":{"type":"array","description":"User's language combinations","items":{"$ref":"#/components/schemas/RSUserLanguageCombination"}}}},"RSGetUserAccessRightsResponse":{"type":"object","properties":{"linguistOptions":{"$ref":"#/components/schemas/RSUserAccessRightsLinguistOptionsTO","description":"Linguist's options."}}},"RSUserAccessRightsDownloadAccessTO":{"type":"object","properties":{"source":{"type":"string","description":"Allowance for downloading a source file.","enum":["ALLOWED","NOT_ALLOWED"]},"target":{"type":"string","description":"Allowance for downloading a target file.","enum":["ALLOWED","NOT_ALLOWED"]},"pdf":{"type":"string","description":"Allowance for downloading a pdf file.","enum":["ALLOWED","NOT_ALLOWED"]},"html":{"type":"string","description":"Allowance for downloading an html file.","enum":["ALLOWED","NOT_ALLOWED"]},"tipp":{"type":"string","description":"Allowance for downloading a tipp file.","enum":["ALLOWED","NOT_ALLOWED"]},"xliff":{"type":"string","description":"Allowance for downloading an xliff file.","enum":["ALLOWED","NOT_ALLOWED"]},"xliffNoTargetPopulation":{"type":"string","description":"Allowance for downloading an xliff with not target population file.","enum":["ALLOWED","NOT_ALLOWED"]},"excel":{"type":"string","description":"Allowance for downloading an excel file.","enum":["ALLOWED","NOT_ALLOWED"]},"pdfReview":{"type":"string","description":"Allowance for downloading a pdf review file.","enum":["ALLOWED","NOT_ALLOWED"]},"excelTable":{"type":"string","description":"Allowance for downloading an excel table file.","enum":["ALLOWED","NOT_ALLOWED"]},"backTranslation":{"type":"string","description":"Allowance for downloading a back translation file.","enum":["ALLOWED","NOT_ALLOWED"]},"uncleanDoc":{"type":"string","description":"Allowance for downloading an unclean doc file.","enum":["ALLOWED","NOT_ALLOWED"]},"multiExcel":{"type":"string","description":"Allowance for downloading a multi excel file.","enum":["ALLOWED","NOT_ALLOWED"]},"tmx":{"type":"string","description":"TMX segments access type.\n\nALL_TRANSLATED_WITH_MATCHES - Allowance for downloading a TMX file with segments having matches.\n\nALL_TRANSLATED - Allowance for downloading a TMX file.\n\nUSER_TRANSLATED_WITH_MATCHES - Allowance for downloading a TMX file with segments translated by user and having matches.\n\nUSER_TRANSLATED - Allowance for downloading a TMX file with segments translated by user.\n\nUSER_TRANSLATED_MODIFIED_ONLY - Allowance for downloading a TMX file with segments modified by user.\n\nDO_NOT_ALLOW - No allowance for downloading a TMX file.","enum":["ALL_TRANSLATED_WITH_MATCHES","ALL_TRANSLATED","USER_TRANSLATED_WITH_MATCHES","USER_TRANSLATED","USER_TRANSLATED_MODIFIED_ONLY","DO_NOT_ALLOW"]}}},"RSUserAccessRightsLinguistOptionsTO":{"type":"object","properties":{"downloadAccess":{"$ref":"#/components/schemas/RSUserAccessRightsDownloadAccessTO","description":"Download access."}}},"RSGetUserRolesResponse":{"type":"object","properties":{"ids":{"type":"array","description":"IDs of roles.","items":{"type":"integer","format":"int64"}}}},"RSPenaltyProfilesResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Penalty profile ID."},"name":{"type":"string","description":"Penalty profile name."},"description":{"type":"string","description":"Penalty profile description."},"activity":{"type":"string","description":"Penalty profile activity status.","enum":["ACTIVE","INACTIVE","DELETED"]}}},"RSTMFileStatusResponse":{"type":"object","description":"TMFileStatus.","properties":{"message":{"type":"string"},"status":{"type":"string","enum":["IN_PROGRESS","FINISHED","ERROR"]}}},"RSCheckTMImportStatusResponse":{"type":"object","properties":{"fileId":{"type":"integer","format":"int64","description":"File ID."},"status":{"type":"string","description":"Status of imported TM file.","enum":["DONE","IN_PROGRESS","ERROR"]},"extractionError":{"type":"string","description":"Error during TM import."},"bilingualTermExtractionError":{"type":"string","description":"Error during extraction of bilingual terminology."}}},"RSCheckTermImportStatusResponse":{"type":"object","properties":{"fileId":{"type":"integer","format":"int64","description":"File ID."},"status":{"type":"string","description":"Import status of terminology file.","enum":["FINISHED","IN_PROGRESS","ERROR","DELETED"]}}},"RSCheckExportStatusResponse":{"type":"object","properties":{"status":{"type":"string","description":"Export status of terminology file.","enum":["FINISHED","IN_PROGRESS","ERROR"]}}},"RSTagGroupFindResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"RSTagGroupGetResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"tagIds":{"type":"array","items":{"type":"integer","format":"int64"}},"customerSelectionType":{"type":"string","description":"Type of customer selection. The `ALL_CUSTOMERS` value indicates that all available customers from your XTM Cloud instance are assigned to the relevant tag group.","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"RSTagFindResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"customerSelectionType":{"type":"string","description":"Type of customer selection. The `ALL_CUSTOMERS` value indicates that all customers from the tag group are assigned to the relevant tag.","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"RSTagGetResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"customerSelectionType":{"type":"string","description":"Type of customer selection. The `ALL_CUSTOMERS` value indicates that all customers from the tag group are assigned to the relevant tag.","enum":["ALL_CUSTOMERS","SELECTED_CUSTOMERS"]},"customerIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"RSSystemInfoResponse":{"type":"object","properties":{"companyName":{"type":"string","description":"Company name."},"website":{"type":"string","description":"URL to XTM website."},"logo":{"type":"string","description":"Logo."},"version":{"type":"string","description":"XTM version."}}},"RSSubjectMattersGetResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"activity":{"type":"string","enum":["DISABLED","ACTIVE","PM","DELETED"]},"name":{"type":"string"},"durationFactor":{"type":"number","format":"float"},"priceFactor":{"type":"number","format":"float"}}},"RSRolesGetResponse":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"integer","format":"int64"}}},"RSProjectGetResponse":{"type":"object","description":"Response object from project get method.","properties":{"id":{"type":"integer","format":"int64","description":"Project ID."},"name":{"type":"string","description":"Project name."},"referenceId":{"type":"string","description":"Project Reference ID."},"description":{"type":"string","description":"Project description."},"activity":{"type":"string","description":"Project activity.","enum":["ACTIVE","ARCHIVED","AUTO_ARCHIVED","INACTIVE","ACTIVATING","ARCHIVING","AUTO_ARCHIVING"]},"creatorId":{"type":"integer","format":"int64","description":"Project creator ID."},"customerId":{"type":"integer","format":"int64","description":"Project customer ID."},"customerName":{"type":"string","description":"Project customer name."},"projectManagerId":{"type":"integer","format":"int64","description":"Project manager ID."},"sourceLanguage":{"type":"string","description":"Project source language."},"newSourceLanguage":{"type":"string","description":"Project pre-translation language."},"newSourceType":{"type":"string","description":"Project pre-translation type.","enum":["SOURCE_SEGMENTATION","NEW_SOURCE_SEGMENTATION"]},"targetLanguages":{"type":"array","description":"Project target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}},"templateId":{"type":"integer","format":"int64","description":"Project template ID."},"filterTemplateId":{"type":"string","description":"Project filter template ID."},"createDate":{"type":"string","format":"epoch","description":"Project create date.","example":1774765345571},"startDate":{"type":"string","format":"epoch","description":"Project start date.","example":1774765345571},"finishDate":{"type":"string","format":"epoch","description":"Project finish date.","example":1774765345571},"workflowStartDate":{"type":"string","format":"epoch","description":"Project workflow start date.","example":1774765345571},"dueDate":{"type":"string","format":"epoch","description":"Project due date.","example":1774765345571},"workflowDueDate":{"type":"string","format":"epoch","description":"Project workflow due date.","example":1774765345571},"newSourceDueDate":{"type":"string","format":"epoch","description":"Project pre-translation due date.","example":1774765345571},"modificationDate":{"type":"string","format":"epoch","description":"Date of project's last modification.","example":1774765345571},"lastUsageDate":{"type":"string","format":"epoch","description":"Date of project's last usage.","example":1774765345571},"paymentStatus":{"type":"string","description":"Project payment status.","enum":["NOT_REQUIRED","PAID","WAITING_FOR_PAYMENT"]},"proposalApprovalStatus":{"type":"string","description":"Project proposal approval status.","enum":["NOT_CONFIRMED","CONFIRMED","NOT_REQUIRED"]},"invoiceStatus":{"type":"string","description":"Project invoice status.","enum":["APPROVED","TO_BE_APPROVED","NOT_REQUIRED"]},"costApprovalStatusType":{"type":"string","description":"Project cost approval status.","enum":["APPROVED","PENDING","REJECTED","NO_COSTS_AVAILABLE","OUTDATED","NOT_REQUIRED","COSTS_GENERATED"]},"subjectMatterId":{"type":"integer","format":"int64","description":"Project subject matter ID."},"subjectMatterName":{"type":"string","description":"Project subject matter name."},"tmPenaltyProfileId":{"type":"integer","format":"int64","description":"Project TM penalty profile ID."},"termPenaltyProfileId":{"type":"integer","format":"int64","description":"Project Term penalty profile ID."},"qaProfileId":{"type":"integer","format":"int64","description":"Project QA profile ID."},"tmTagIds":{"type":"array","description":"Translation memory tag ids.","items":{"type":"integer","format":"int64"}},"termTagIds":{"type":"array","description":"Terminology tag ids.","items":{"type":"integer","format":"int64"}},"tmCustomerIds":{"type":"array","description":"IDs of customers whose translation memory is used in the project.","items":{"type":"integer","format":"int64"}},"termCustomerIds":{"type":"array","description":"IDs of customers whose terminology is used in the project.","items":{"type":"integer","format":"int64"}},"externalCreatorId":{"type":"integer","format":"int64","description":"External creator ID."},"segmentLockingType":{"type":"string","description":"Project segment locking type.","enum":["DISABLED","ANY_100_MATCH","APPROVED_100_MATCH","XLIFFDOC_TRANSLATED","XLIFFDOC_PROOFED","XLIFFDOC_VALIDATED"]}}},"RSTimeTrackingsJob":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."},"fileName":{"type":"string"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/RSTimeTrackingsJobsStep"}}}},"RSTimeTrackingsJobsBundle":{"type":"object","properties":{"from":{"type":"integer","format":"int64"},"to":{"type":"integer","format":"int64"},"manualTime":{"type":"integer","format":"int64"}}},"RSTimeTrackingsJobsResponse":{"type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/RSTimeTrackingsJob"}}}},"RSTimeTrackingsJobsStep":{"type":"object","properties":{"name":{"type":"string","deprecated":true,"description":"Workflow step name. This field is deprecated. Use `displayStepName` or `stepReferenceName`."},"displayStepName":{"type":"string","description":"Workflow display step name. This name is used as a label in the UI."},"stepReferenceName":{"type":"string","description":"Workflow reference step name."},"bundles":{"type":"array","items":{"$ref":"#/components/schemas/RSTimeTrackingsJobsBundle"}}}},"RSProjectObtainWorkflowResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the workflow"},"name":{"type":"string","description":"Name of the workflow"},"steps":{"type":"array","description":"Descriptors of steps in the workflow","items":{"$ref":"#/components/schemas/RSProjectObtainWorkflowStepResponse"}}}},"RSProjectObtainWorkflowStepResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Step ID"},"name":{"type":"string","deprecated":true,"description":"Step name. This field is deprecated. Use `displayStepName` or `stepReferenceName`."},"displayStepName":{"type":"string","description":"Workflow display step name. This name is used as a label in the UI."},"stepReferenceName":{"type":"string","description":"Workflow step reference name."},"tmApproval":{"type":"string","description":"Type of TM Approval","enum":["ENABLED","DISABLED"]},"costsCalculationBasedOnManualTime":{"type":"string","description":"Costs calculation based on manual time","enum":["ENABLED","DISABLED"]},"lqaType":{"type":"string","description":"Type of LQA","enum":["ENABLED_SAVING_RESULTS_FOR_USER","ENABLED_NOT_SAVING_RESULTS_FOR_USER","DISABLED_BUT_SHOW_EXISTING_ERRORS","DISABLED"]},"finishTaskOption":{"type":"string","description":"Step finish requirements","enum":["NONE","ALL_SEGMENT_DONE"]},"blockingType":{"type":"string","description":"Step blocking type","enum":["FULL_BLOCKING","PART_BLOCKING","NO_BLOCKING"]},"minDueDate":{"type":"string","format":"epoch","description":"Min. due date","example":1774765345571},"maxDueDate":{"type":"string","format":"epoch","description":"Max. due date","example":1774765345571}}},"RSAssignmentResponse":{"type":"object","properties":{"jobs":{"type":"array","description":"Workflow assignment in project jobs.","items":{"$ref":"#/components/schemas/RSJobAssignment"}}}},"RSBundleAssignment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Bundle ID"},"from":{"type":"integer","format":"int32","description":"Describes the range of segments for the current bundle."},"to":{"type":"integer","format":"int32","description":"Describes the range of segments for the current bundle."},"userId":{"type":"integer","format":"int64","description":"User ID assigned to current workflow bundle."},"userName":{"type":"string","description":"User name assigned to current workflow bundle."},"lspId":{"type":"integer","format":"int64","description":"Lsp ID assigned to current workflow bundle."},"lspName":{"type":"string","description":"Lsp name assigned to current workflow bundle."},"userGroupId":{"type":"integer","format":"int64","description":"User group ID assigned to current workflow bundle."},"userGroupName":{"type":"string","description":"User group name assigned to current workflow bundle."},"acceptanceStatus":{"type":"string","description":"Task acceptance status.","enum":["WAITING","ACCEPTED","DECLINED"]}}},"RSJobAssignment":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64","description":"Job ID."},"steps":{"type":"array","description":"Workflow assignment in workflow steps.","items":{"$ref":"#/components/schemas/RSStepAssignment"}}}},"RSStepAssignment":{"type":"object","properties":{"name":{"type":"string","deprecated":true,"description":"Workflow step name. This field is deprecated. Use `displayStepName` or `stepReferenceName`."},"displayStepName":{"type":"string","description":"Workflow display step name. This name is used as a label in the UI."},"stepReferenceName":{"type":"string","description":"Workflow reference step name."},"bundles":{"type":"array","description":"Workflow assignment in workflow bundle.","items":{"$ref":"#/components/schemas/RSBundleAssignment"}}}},"RSJobWordCount":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Job ID."},"totalDeductedWords":{"type":"integer","format":"int64","description":"Total number of words deducted for a job."}}},"RSProjectWordCountResponse":{"type":"object","properties":{"totalDeductedWords":{"type":"integer","format":"int64","description":"Total number of words deducted for an entire project."},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/RSJobWordCount"}}}},"RSProjectUser":{"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"email":{"type":"string"}}},"RSProjectUsersResponse":{"type":"object","properties":{"linguists":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectUser"}},"projectManager":{"$ref":"#/components/schemas/RSProjectUser"},"projectCreator":{"$ref":"#/components/schemas/RSProjectUser"}}},"RSBundleStatus":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Bundle ID."},"from":{"type":"integer","format":"int32","description":"Describes the range of segments for the current bundle."},"to":{"type":"integer","format":"int32","description":"Describes the range of segments for the current bundle."},"finishDate":{"type":"string","format":"epoch","description":"Bundle finished date.","example":1774765345571}}},"RSJobStatusResponse":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64","description":"Job ID."},"completionStatus":{"type":"string","description":"Completion status of job.\n\nIN_PROGRESS - job is active in the workflow.\n\nFINISHED - job has been completed in all steps of the workflow.\n\nCANCELLED - job is cancelled in the project.\n\nDELETED - job is deleted from the project.\n\nERROR - error is returned for job status when none of the statuses above applies.","enum":["IN_PROGRESS","FINISHED","ERROR","CANCELLED","DELETED"]},"fileName":{"type":"string","description":"Job file name."},"sourceFileId":{"type":"integer","format":"int64","description":"Job source file name."},"targetLanguage":{"type":"string","description":"Job target language. See [API resources](#tag/Language-codes) for full list of available codes."},"dueDate":{"type":"string","format":"epoch","description":"Job due date.","example":1774765345571},"finishDate":{"type":"string","format":"epoch","description":"Job finished date.","example":1774765345571},"steps":{"type":"array","description":"Job steps statuses.","items":{"$ref":"#/components/schemas/RSStepStatusResponse"}},"joinFilesType":{"type":"string","description":"Type of file joining.","enum":["EXTENSION","DITA_MAP","NOT_JOINED"]},"joinFilesDitaLevel":{"type":"integer","format":"int32","description":"DITA Map level when mapping by DITA Map is used."}}},"RSProjectStatusResponse":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64","description":"Project ID."},"completionStatus":{"type":"string","description":"Project completion status.\n\nIN_PROGRESS - workflow has not been completed for any job in the project.\n\nPARTIALLY_FINISHED - workflow has been completed for at least one but not for all jobs in the project.\n\nFINISHED - workflow has been completed for all jobs in the project.","enum":["IN_PROGRESS","PARTIALLY_FINISHED","FINISHED"]},"activity":{"type":"string","description":"Project activity.","enum":["ACTIVE","ARCHIVED","AUTO_ARCHIVED","INACTIVE","ACTIVATING","ARCHIVING","AUTO_ARCHIVING"]},"sourceLanguage":{"type":"string","description":"Project source language. See [API resources](#tag/Language-codes) for full list of available codes."},"dueDate":{"type":"string","format":"epoch","description":"Project due date.","example":1774765345571},"joinFilesType":{"type":"string","description":"Type of file joining.","enum":["EXTENSION","DITA_MAP","NOT_JOINED"]},"joinFilesDitaLevel":{"type":"integer","format":"int32","description":"DITA Map level when mapping by DITA Map is used."},"finishDate":{"type":"string","format":"epoch","description":"Project finished date.","example":1774765345571},"jobs":{"type":"array","description":"Project jobs statuses.","items":{"$ref":"#/components/schemas/RSJobStatusResponse"}},"contractorType":{"type":"string","enum":["SUBCONTRACTOR","INTERNAL"]}}},"RSStepStatusResponse":{"type":"object","properties":{"workflowStepName":{"type":"string","deprecated":true,"description":"Workflow step name. This field is deprecated. Use `displayStepName` or `stepReferenceName`."},"displayStepName":{"type":"string","description":"Workflow display step name. This name is used as a label in the UI."},"stepReferenceName":{"type":"string","description":"Workflow step reference name."},"status":{"type":"string","description":"Step completion status.\n\nNOT_STARTED - workflow has not been started for the job.\n\nIN_PROGRESS - job is active in the workflow step.\n\nFINISHED - job has been completed in the workflow step.","enum":["IN_PROGRESS","FINISHED","NOT_STARTED"]},"autoStatus":{"type":"string","description":"Step auto status.","enum":["SUCCESS","ERROR"]},"dueDate":{"type":"string","format":"epoch","description":"Step due date.","example":1774765345571},"finishDate":{"type":"string","format":"epoch","description":"Step finished date.","example":1774765345571},"bundles":{"type":"array","description":"Step bundles.","items":{"$ref":"#/components/schemas/RSBundleStatus"}}}},"RSCoreStatistics":{"type":"object","description":"Statistic values","properties":{"totalSegments":{"type":"integer","format":"int32"},"totalWords":{"type":"integer","format":"int32"},"totalCharacters":{"type":"integer","format":"int32"},"totalWhitespaces":{"type":"integer","format":"int32"},"nonTranslatableSegments":{"type":"integer","format":"int32"},"nonTranslatableWords":{"type":"integer","format":"int32"},"nonTranslatableCharacters":{"type":"integer","format":"int32"},"nonTranslatableWhitespaces":{"type":"integer","format":"int32"},"nonTranslatableTrackedTime":{"type":"integer","format":"int64"},"iceMatchSegments":{"type":"integer","format":"int32"},"iceMatchWords":{"type":"integer","format":"int32"},"iceMatchCharacters":{"type":"integer","format":"int32"},"iceMatchWhitespaces":{"type":"integer","format":"int32"},"iceMatchTrackedTime":{"type":"integer","format":"int64"},"highFuzzyMatchSegments":{"type":"integer","format":"int32"},"highFuzzyMatchWords":{"type":"integer","format":"int32"},"highFuzzyMatchCharacters":{"type":"integer","format":"int32"},"highFuzzyMatchWhitespaces":{"type":"integer","format":"int32"},"highFuzzyMatchTrackedTime":{"type":"integer","format":"int64"},"mediumFuzzyMatchSegments":{"type":"integer","format":"int32"},"mediumFuzzyMatchWords":{"type":"integer","format":"int32"},"mediumFuzzyMatchCharacters":{"type":"integer","format":"int32"},"mediumFuzzyMatchWhitespaces":{"type":"integer","format":"int32"},"mediumFuzzyMatchTrackedTime":{"type":"integer","format":"int64"},"lowFuzzyMatchSegments":{"type":"integer","format":"int32"},"lowFuzzyMatchWords":{"type":"integer","format":"int32"},"lowFuzzyMatchCharacters":{"type":"integer","format":"int32"},"lowFuzzyMatchWhitespaces":{"type":"integer","format":"int32"},"lowFuzzyMatchTrackedTime":{"type":"integer","format":"int64"},"leveragedSegments":{"type":"integer","format":"int32"},"leveragedWords":{"type":"integer","format":"int32"},"leveragedCharacters":{"type":"integer","format":"int32"},"leveragedWhitespaces":{"type":"integer","format":"int32"},"leveragedTrackedTime":{"type":"integer","format":"int64"},"otherNonTranslatableWords":{"type":"integer","format":"int32"},"otherNonTranslatableCharacters":{"type":"integer","format":"int32"},"otherNonTranslatableWhitespaces":{"type":"integer","format":"int32"},"otherNonTranslatableTrackedTime":{"type":"integer","format":"int64"},"repeatsSegments":{"type":"integer","format":"int32"},"repeatsWords":{"type":"integer","format":"int32"},"repeatsCharacters":{"type":"integer","format":"int32"},"repeatsWhitespaces":{"type":"integer","format":"int32"},"repeatsTrackedTime":{"type":"integer","format":"int64"},"highFuzzyRepeatsSegments":{"type":"integer","format":"int32"},"highFuzzyRepeatsWords":{"type":"integer","format":"int32"},"highFuzzyRepeatsCharacters":{"type":"integer","format":"int32"},"highFuzzyRepeatsWhitespaces":{"type":"integer","format":"int32"},"highFuzzyRepeatsTrackedTime":{"type":"integer","format":"int64"},"mediumFuzzyRepeatsSegments":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsWords":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsCharacters":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsWhitespaces":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsTrackedTime":{"type":"integer","format":"int64"},"lowFuzzyRepeatsSegments":{"type":"integer","format":"int32"},"lowFuzzyRepeatsWords":{"type":"integer","format":"int32"},"lowFuzzyRepeatsCharacters":{"type":"integer","format":"int32"},"lowFuzzyRepeatsWhitespaces":{"type":"integer","format":"int32"},"lowFuzzyRepeatsTrackedTime":{"type":"integer","format":"int64"},"machineTranslationCharacters":{"type":"integer","format":"int32"},"machineTranslationSegments":{"type":"integer","format":"int32"},"machineTranslationWords":{"type":"integer","format":"int32"},"machineTranslationWhitespaces":{"type":"integer","format":"int32"},"machineTranslationTrackedTime":{"type":"integer","format":"int64"},"noMatchingTrackedTime":{"type":"integer","format":"int64"},"noMatchingSegments":{"type":"integer","format":"int32"},"noMatchingWords":{"type":"integer","format":"int32"},"noMatchingCharacters":{"type":"integer","format":"int32"},"noMatchingWhitespaces":{"type":"integer","format":"int32"},"totalTime":{"type":"integer","format":"int64"}}},"RSJobStatistics":{"type":"object","description":"Job statistics","properties":{"jobId":{"type":"integer","format":"int64"},"sourceStatistics":{"$ref":"#/components/schemas/RSCoreStatistics"},"targetStatistics":{"$ref":"#/components/schemas/RSCoreStatistics"},"lastCompletionDate":{"type":"string","format":"epoch","example":1774765345571},"creationDate":{"type":"string","format":"epoch","example":1774765345571},"machineTranslationEDCWords":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/XTMMachineTranslationEDCWordsCategoryAPI"}}}},"RSLanguageStatisticsResponse":{"type":"object","description":"ProjectStatistics.","properties":{"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."},"usersStatistics":{"type":"array","description":"User statistics","items":{"$ref":"#/components/schemas/RSUserStatistics"}}}},"RSStepStatistics":{"type":"object","properties":{"workflowStepName":{"type":"string","deprecated":true,"description":"This field is deprecated. Use `stepReferenceNames`."},"stepReferenceName":{"type":"string"},"jobsStatistics":{"type":"array","items":{"$ref":"#/components/schemas/RSJobStatistics"}}}},"RSUserStatistics":{"type":"object","properties":{"userDisplayName":{"type":"string"},"username":{"type":"string"},"userId":{"type":"integer","format":"int64"},"userType":{"type":"string","enum":["INTERNAL_USER","LSP","EXTERNAL_USER"]},"stepsStatistics":{"type":"array","items":{"$ref":"#/components/schemas/RSStepStatistics"}}}},"XTMMachineTranslationEDCRangeAPI":{"type":"object","properties":{"from":{"type":"number","format":"double"},"to":{"type":"number","format":"double"}}},"XTMMachineTranslationEDCWordsCategoryAPI":{"type":"object","properties":{"discount":{"type":"integer","format":"int64"},"wordCount":{"type":"integer","format":"int64"},"range":{"$ref":"#/components/schemas/XTMMachineTranslationEDCRangeAPI"}}},"JobEdcScore":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Job ID."},"score":{"type":"number","format":"double","description":"Job's EDC score."}}},"RSObtainEdcScoreResponse":{"type":"object","properties":{"score":{"type":"number","format":"double","description":"Project's EDC score."},"jobs":{"type":"array","description":"EDC scores for all finished jobs.","items":{"$ref":"#/components/schemas/JobEdcScore"}}}},"RSProjectEstimatesResponse":{"type":"object","description":"ProjectEstimates.","properties":{"projectId":{"type":"integer","format":"int64","description":"Project ID."},"price":{"type":"number","description":"Project cost."},"taxPrice":{"type":"number","description":"VAT calculated for the project cost."},"deliveryDate":{"type":"string","format":"epoch","description":"Project delivery date.","example":1774765345571},"currency":{"type":"string","description":"Currency of estimates. See [API resources](#tag/Currencies) for all currency codes."}}},"RSCoreMetrics":{"type":"object","description":"Metric values","properties":{"iceMatchCharacters":{"type":"integer","format":"int32"},"iceMatchSegments":{"type":"integer","format":"int32"},"iceMatchWords":{"type":"integer","format":"int32"},"iceMatchWhitespaces":{"type":"integer","format":"int32"},"lowFuzzyMatchCharacters":{"type":"integer","format":"int32"},"lowFuzzyMatchSegments":{"type":"integer","format":"int32"},"lowFuzzyMatchWords":{"type":"integer","format":"int32"},"lowFuzzyMatchWhitespaces":{"type":"integer","format":"int32"},"mediumFuzzyMatchCharacters":{"type":"integer","format":"int32"},"mediumFuzzyMatchSegments":{"type":"integer","format":"int32"},"mediumFuzzyMatchWords":{"type":"integer","format":"int32"},"mediumFuzzyMatchWhitespaces":{"type":"integer","format":"int32"},"highFuzzyMatchCharacters":{"type":"integer","format":"int32"},"highFuzzyMatchSegments":{"type":"integer","format":"int32"},"highFuzzyMatchWords":{"type":"integer","format":"int32"},"highFuzzyMatchWhitespaces":{"type":"integer","format":"int32"},"repeatsCharacters":{"type":"integer","format":"int32"},"repeatsSegments":{"type":"integer","format":"int32"},"repeatsWords":{"type":"integer","format":"int32"},"repeatsWhitespaces":{"type":"integer","format":"int32"},"leveragedCharacters":{"type":"integer","format":"int32"},"leveragedSegments":{"type":"integer","format":"int32"},"leveragedWords":{"type":"integer","format":"int32"},"leveragedWhitespaces":{"type":"integer","format":"int32"},"lowFuzzyRepeatsCharacters":{"type":"integer","format":"int32"},"lowFuzzyRepeatsSegments":{"type":"integer","format":"int32"},"lowFuzzyRepeatsWords":{"type":"integer","format":"int32"},"lowFuzzyRepeatsWhitespaces":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsCharacters":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsSegments":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsWords":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsWhitespaces":{"type":"integer","format":"int32"},"highFuzzyRepeatsCharacters":{"type":"integer","format":"int32"},"highFuzzyRepeatsSegments":{"type":"integer","format":"int32"},"highFuzzyRepeatsWords":{"type":"integer","format":"int32"},"highFuzzyRepeatsWhitespaces":{"type":"integer","format":"int32"},"nonTranslatableCharacters":{"type":"integer","format":"int32"},"nonTranslatableSegments":{"type":"integer","format":"int32"},"nonTranslatableWords":{"type":"integer","format":"int32"},"nonTranslatableWhitespaces":{"type":"integer","format":"int32"},"totalCharacters":{"type":"integer","format":"int32"},"totalSegments":{"type":"integer","format":"int32"},"totalWords":{"type":"integer","format":"int32"},"totalWhitespaces":{"type":"integer","format":"int32"},"machineTranslationCharacters":{"type":"integer","format":"int32"},"machineTranslationSegments":{"type":"integer","format":"int32"},"machineTranslationWords":{"type":"integer","format":"int32"},"machineTranslationWhitespaces":{"type":"integer","format":"int32"},"noMatchCharacters":{"type":"integer","format":"int32"},"noMatchSegments":{"type":"integer","format":"int32"},"noMatchWhitespaces":{"type":"integer","format":"int32"},"noMatchWords":{"type":"integer","format":"int32"}}},"RSJobMetricsResponse":{"type":"object","description":"Job metrics.","properties":{"jobId":{"type":"integer","format":"int64","description":"Job id"},"coreMetrics":{"$ref":"#/components/schemas/RSCoreMetrics","description":"Metric values"},"metricsProgress":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RSMetricsProgress"},"description":"Progress for workflow step"}}},"RSLanguageMetricsResponse":{"type":"object","description":"Project metrics.","properties":{"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."},"coreMetrics":{"$ref":"#/components/schemas/RSCoreMetrics","description":"Metric values."},"metricsProgress":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RSMetricsProgress"},"description":"Progress for workflow step."},"jobsMetrics":{"type":"array","description":"Job metrics.","items":{"$ref":"#/components/schemas/RSJobMetricsResponse"}}}},"RSMetricsProgress":{"type":"object","description":"Work progress values.","properties":{"wordsToBeDone":{"type":"integer","format":"int32"},"wordsDone":{"type":"integer","format":"int32"},"wordsToBeChecked":{"type":"integer","format":"int32"},"wordsToBeCorrected":{"type":"integer","format":"int32"},"charactersToBeDone":{"type":"integer","format":"int32"},"charactersDone":{"type":"integer","format":"int32"},"charactersToBeChecked":{"type":"integer","format":"int32"},"charactersToBeCorrected":{"type":"integer","format":"int32"},"spacesDone":{"type":"integer","format":"int32"},"spacesToBeDone":{"type":"integer","format":"int32"},"spacesToBeChecked":{"type":"integer","format":"int32"},"spacesToBeCorrected":{"type":"integer","format":"int32"},"unitsToBeDone":{"type":"integer","format":"int32"},"unitsDone":{"type":"integer","format":"int32"},"unitsToBeChecked":{"type":"integer","format":"int32"},"unitsToBeCorrected":{"type":"integer","format":"int32"},"totalUnitsCount":{"type":"integer","format":"int32"},"totalWordCount":{"type":"integer","format":"int32"},"totalCharactersCount":{"type":"integer","format":"int32"},"totalSpacesCharacters":{"type":"integer","format":"int32"},"factorCharactersToBeDone":{"type":"integer","format":"int32"},"factorCharactersDone":{"type":"integer","format":"int32"},"factorCharactersToBeChecked":{"type":"integer","format":"int32"},"factorCharactersToBeCorrected":{"type":"integer","format":"int32"},"factor":{"type":"number"}}},"RSMetricsFilesResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"File ID."},"eventType":{"type":"string","description":"Event type generating a file.","enum":["INITIAL_METRICS","CONTINUOUS_PROJECT_UPDATE","REANALYZE","ADD_FILE_TO_PROJECT","REMOVE_FILE_FROM_PROJECT","ADD_LANGUAGE_TO_PROJECT","REMOVE_LANGUAGE_TO_PROJECT","REANALYZE_ERROR_JOB","AFTER_PRETRANSLATION"]},"createDate":{"type":"string","format":"epoch","description":"Timestamp of the file creation date.","example":1774765345571}}},"RSBundleMetrics":{"type":"object","description":"Bundle metrics.","properties":{"jobId":{"type":"integer","format":"int64","description":"Job ID"},"stepName":{"type":"string","description":"Workflow step name"},"bundle":{"$ref":"#/components/schemas/RSBundleSimpleDescriptor","description":"Bundle descriptor"},"coreMetrics":{"$ref":"#/components/schemas/RSCoreMetrics","description":"Core metrics"},"metricsProgress":{"$ref":"#/components/schemas/RSMetricsProgress","description":"Metrics progress"}}},"RSBundleSimpleDescriptor":{"type":"object","description":"Simple bundle descriptor","properties":{"id":{"type":"integer","format":"int64","description":"Bundle ID"},"from":{"type":"integer","format":"int32","description":"Bundle's first segment"},"to":{"type":"integer","format":"int32","description":"Bundle's last segment"}}},"RSProjectFileStatusResponse":{"type":"object","description":"Response description.","properties":{"fileId":{"type":"integer","format":"int64","description":"File ID."},"jobId":{"type":"integer","format":"int64","description":"Job ID."},"projectId":{"type":"integer","format":"int64","description":"Project ID."},"status":{"type":"string","description":"File status.","enum":["IN_PROGRESS","FINISHED","ERROR","WARNING","UNKNOWN"]},"message":{"type":"string","description":"Error message."}}},"RSTranslationFileStatusResponse":{"type":"object","properties":{"fileId":{"type":"integer","format":"int64"},"errorDescription":{"type":"string"},"status":{"type":"string","enum":["IN_PROGRESS","FINISHED","ERROR"]}}},"RSProjectCustomFieldResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"},"definitionId":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"$ref":"#/components/schemas/RSProjectCustomFieldValue"}}},"RSProjectCost":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"source":{"type":"string","enum":["INITIAL_METRICS","CURRENT_METRICS","STATISTICS_SOURCE","STATISTICS_TARGET","TIME_OR_STATISTICS_SOURCE","TIME_OR_STATISTICS_TARGET","TIME_OR_METRICS_INITIAL","TIME_OR_METRICS_CURRENT"]},"createdDate":{"type":"string","format":"epoch","example":1774765345571},"modifiedDate":{"type":"string","format":"epoch","example":1774765345571}}},"RSCostError":{"type":"object","properties":{"type":{"type":"string","enum":["NO_RATE_CARD","NO_RATE_CARD_STEP","MANY_RATE_CARDS","NO_CURRENCY_EXCHANGE","BILLING_CURRENCY_UNDEFINED","NO_METRICS_OR_STATISTICS","PROJECT_NOT_ANALYSED","NOTHING_CALCULATED","CHECKED","NO_SUBJECT_MATTER_FOR_CLIENT","MULTIPLE_RATE_CARDS_PER_USER","DIFFERENT_VALUES_FOR_CORRECT_STEP","VALUES_FOR_MATCHES_NOT_ZERO","DIFFERENT_FUZZY_MATCHES_VALUES"]},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}},"RSCostWarning":{"type":"object","properties":{"type":{"type":"string","enum":["NO_RATE_CARD","NO_RATE_CARD_STEP","NO_STATISTICS_FOR_LANGUAGE","NO_STATISTICS_FOR_LANGUAGES","JOB_UNASSIGNED","USER_NOT_A_LINGUIST","USER_GROUP_ASSIGNED_TO_WORKFLOW_STEP","NO_TIME_ENTERED","NO_RATE_CARD_STEP_FOR_TIME"]},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}},"RSCostsResponse":{"type":"object","properties":{"costId":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"},"source":{"type":"string","enum":["INITIAL_METRICS","CURRENT_METRICS","STATISTICS_SOURCE","STATISTICS_TARGET","TIME_OR_STATISTICS_SOURCE","TIME_OR_STATISTICS_TARGET","TIME_OR_METRICS_INITIAL","TIME_OR_METRICS_CURRENT"]},"totalWords":{"type":"integer","format":"int64"},"currencyFactor":{"type":"number"},"pricePerSystemCurrency":{"type":"number"},"systemCurrency":{"type":"string","description":"System currency. See [API resources](#tag/Currencies) for all currency codes."},"userCosts":{"type":"array","items":{"$ref":"#/components/schemas/RSUserCost"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/RSCostError"},"uniqueItems":true},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/RSCostWarning"},"uniqueItems":true}}},"RSExtraCost":{"type":"object","properties":{"additionalCosts":{"type":"number"},"additionalCostsPercent":{"type":"number"},"nonAnalyzableCosts":{"type":"number"},"nonAnalyzableCostsPercent":{"type":"number"},"managementFeeSum":{"type":"number"},"minimalPricePadding":{"type":"number"},"fixedPricesSum":{"type":"number"}}},"RSTargetLanguageCost":{"type":"object","properties":{"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."},"pricePerUserCurrency":{"type":"number"},"priceWithDistance":{"type":"number"}}},"RSUserCost":{"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"username":{"type":"string"},"userType":{"type":"string","enum":["INTERNAL_LINGUIST","LSP"]},"systemCurrency":{"type":"string","description":"System currency. See [API resources](#tag/Currencies) for all currency codes."},"userCurrency":{"type":"string","description":"User currency. See [API resources](#tag/Currencies) for all currency codes."},"pricePerSystemCurrency":{"type":"number"},"pricePerUserCurrency":{"type":"number"},"priceWithDistance":{"type":"number"},"currencyFactor":{"type":"number"},"totalWords":{"type":"integer","format":"int64"},"targetLanguageCosts":{"type":"array","items":{"$ref":"#/components/schemas/RSTargetLanguageCost"}},"extraCosts":{"$ref":"#/components/schemas/RSExtraCost"}}},"REPPO":{"type":"object","properties":{"generalInfo":{"$ref":"#/components/schemas/REPPOGeneralInfo"},"vendor":{"$ref":"#/components/schemas/REPPOVendor"},"requestor":{"$ref":"#/components/schemas/REPPORequestor"},"totalCostWithFees":{"$ref":"#/components/schemas/REPPOTotalCostWithFees"},"costDetails":{"type":"array","items":{"$ref":"#/components/schemas/REPPOCostDetails"}},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/REPProjectCustomField"}}}},"REPPOCostDetails":{"type":"object","properties":{"languageToWorkflowSteps":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"},"uniqueItems":true}},"chargingType":{"type":"string","enum":["WORDS","CHARACTERS"]},"costsForTime":{"$ref":"#/components/schemas/REPPOCostsForTime"},"costsForWords":{"$ref":"#/components/schemas/REPPOCostPricesWithRates"},"costsForCharacters":{"$ref":"#/components/schemas/REPPOCostPricesWithRates"}}},"REPPOCostPricesWithRates":{"type":"object","properties":{"nonMatchPrice":{"type":"string"},"nonMatchRate":{"type":"string"},"machineTranslationPrice":{"type":"string"},"machineTranslationRate":{"type":"string"},"repeatsPrice":{"type":"string"},"repeatsRate":{"type":"string"},"nonTransPrice":{"type":"string"},"nonTransRate":{"type":"string"},"leveragePrice":{"type":"string"},"leverageRate":{"type":"string"},"icePrice":{"type":"string"},"iceRate":{"type":"string"},"lowFuzzyPrice":{"type":"string"},"lowFuzzyRate":{"type":"string"},"mediumFuzzyPrice":{"type":"string"},"mediumFuzzyRate":{"type":"string"},"highFuzzyPrice":{"type":"string"},"highFuzzyRate":{"type":"string"},"lowFuzzyRepeatsPrice":{"type":"string"},"lowFuzzyRepeatsRate":{"type":"string"},"mediumFuzzyRepeatsPrice":{"type":"string"},"mediumFuzzyRepeatsRate":{"type":"string"},"highFuzzyRepeatsPrice":{"type":"string"},"highFuzzyRepeatsRate":{"type":"string"}}},"REPPOCostsForTime":{"type":"object","properties":{"totalTimeInMinutes":{"type":"integer","format":"int64"},"totalTimePrice":{"type":"string"},"totalTimeRate":{"type":"string"}}},"REPPOGeneralInfo":{"type":"object","properties":{"number":{"type":"string"},"date":{"type":"string","format":"epoch","example":1774765345571},"currency":{"type":"string"},"project":{"$ref":"#/components/schemas/REPProjectGeneralInfo"},"calculationSource":{"type":"string","enum":["INITIAL_METRICS","CURRENT_METRICS","STATISTICS_SOURCE","STATISTICS_TARGET","TIME_OR_STATISTICS_SOURCE","TIME_OR_STATISTICS_TARGET","TIME_OR_METRICS_INITIAL","TIME_OR_METRICS_CURRENT"]}}},"REPPORequestor":{"type":"object","properties":{"username":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"}}},"REPPOTotalCostWithFees":{"type":"object","properties":{"managementFee":{"type":"string"},"minPricePadding":{"type":"string"},"fixedPrice":{"type":"string"},"total":{"type":"string"}}},"REPPOVendor":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postCode":{"type":"string"},"country":{"type":"string"}}},"REPProjectCustomField":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"},"definitionId":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"$ref":"#/components/schemas/REPProjectCustomFieldValue"}}},"REPProjectCustomFieldValue":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer","format":"int64"}},"value":{"type":"string"},"dateValue":{"type":"string","format":"epoch","example":1774765345571},"booleanValue":{"type":"boolean"}}},"REPProjectGeneralInfo":{"type":"object","properties":{"name":{"type":"string"},"sourceLanguage":{"type":"string"},"targetLanguages":{"type":"array","items":{"type":"string"}},"referenceId":{"type":"string"},"workflowSteps":{"type":"array","items":{"type":"string"}},"dueDate":{"type":"string","format":"epoch","example":1774765345571},"projectManager":{"$ref":"#/components/schemas/REPProjectManagerSimple"},"subjectMatter":{"type":"string"}}},"REPProjectManagerSimple":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"email":{"type":"string"}}},"RSPOResponse":{"type":"object","properties":{"po":{"$ref":"#/components/schemas/REPPO"}}},"RSAcceptedResponse":{"type":"object","properties":{"reason":{"type":"string"}}},"RSAnalysisFinishedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSDueDateChangedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSInvoiceStatusChangedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSJobFinishedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSProjectAcceptedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSProjectActivityChangedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSProjectCallbacksResponse":{"type":"object","properties":{"analysisFinishedCallbacks":{"type":"array","description":"AnalysisFinished callbacks.","items":{"$ref":"#/components/schemas/RSAnalysisFinishedCallbackResponse"}},"dueDateChangedCallbacks":{"type":"array","description":"DueDateChanged callbacks.","items":{"$ref":"#/components/schemas/RSDueDateChangedCallbackResponse"}},"invoiceStatusChangedCallbacks":{"type":"array","description":"InvoiceStatusChanged callbacks.","items":{"$ref":"#/components/schemas/RSInvoiceStatusChangedCallbackResponse"}},"jobFinishedCallbacks":{"type":"array","description":"JobFinished callbacks.","items":{"$ref":"#/components/schemas/RSJobFinishedCallbackResponse"}},"projectAcceptedCallbacks":{"type":"array","description":"ProjectAccepted callbacks.","items":{"$ref":"#/components/schemas/RSProjectAcceptedCallbackResponse"}},"projectActivityChangedCallbacks":{"type":"array","description":"ProjectActivityChanged callbacks.","items":{"$ref":"#/components/schemas/RSProjectActivityChangedCallbackResponse"}},"projectCreatedCallbacks":{"type":"array","description":"ProjectCreated callbacks.","items":{"$ref":"#/components/schemas/RSProjectCreatedCallbackResponse"}},"projectFinishedCallbacks":{"type":"array","description":"ProjectFinished callbacks.","items":{"$ref":"#/components/schemas/RSProjectFinishedCallbackResponse"}},"projectLanguageChangedCallbacks":{"type":"array","description":"ProjectLanguageChanged callbacks.","items":{"$ref":"#/components/schemas/RSProjectLanguageChangedCallbackResponse"}},"sourceFileUpdatedCallbacks":{"type":"array","description":"SourceFileUpdated callbacks.","items":{"$ref":"#/components/schemas/RSSourceFileUpdatedCallbackResponse"}},"workflowTransitionCallbacks":{"type":"array","description":"WorkflowTransition callbacks.","items":{"$ref":"#/components/schemas/RSWorkflowTransitionCallbackResponse"}}}},"RSProjectCreatedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSProjectFinishedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSProjectLanguageChangedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSSourceFileUpdatedCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSWorkflowTransitionCallbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback's ID."},"url":{"type":"string","description":"Callback's URL."}}},"RSJobAnalysisResponse":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64","description":"Job ID."},"status":{"type":"string","description":"Job analysis status.","enum":["IN_PROGRESS","FINISHED","ERROR","CANCELLED","DELETED"]},"fileName":{"type":"string","description":"Job file name."},"sourceFileId":{"type":"integer","format":"int64","description":"Job source file id."},"targetLanguage":{"type":"string","description":"Job target language. See [API resources](#tag/Language-codes) for full list of available codes."}}},"RSProjectAnalysisResponse":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64","description":"Project ID."},"status":{"type":"string","description":"Analysis status of project.","enum":["IN_PROGRESS","PARTIALLY_FINISHED","FINISHED"]},"activity":{"type":"string","description":"Project activity.","enum":["ACTIVE","ARCHIVED","DELETED","CANCELLED","AUTO_ARCHIVED","INACTIVE","ACTIVATING","ARCHIVING","AUTO_ARCHIVING"]},"sourceLanguage":{"type":"string","description":"Project source language. See [API resources](#tag/Language-codes) for full list of available codes."},"jobs":{"type":"array","description":"Project jobs analysis statuses.","items":{"$ref":"#/components/schemas/RSJobAnalysisResponse"}}}},"RSGetProjectTemplateResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"createDate":{"type":"string","format":"epoch","example":1774765345571},"creatorId":{"type":"integer","format":"int64"},"scope":{"type":"string","enum":["GLOBAL","CUSTOMER"]},"customerId":{"type":"integer","format":"int64"},"subjectMatterId":{"type":"integer","format":"int64"},"subjectMatterName":{"type":"string"},"newSourceLanguage":{"type":"string"},"newSourceWorkflowId":{"type":"integer","format":"int64"},"newSourceType":{"type":"string","enum":["SOURCE_SEGMENTATION","NEW_SOURCE_SEGMENTATION"]},"sourceLanguage":{"type":"string","description":"Source language code. See [API resources](#tag/Language-codes) for full list of available codes."},"targetLanguages":{"type":"array","items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}},"workflowId":{"type":"integer","format":"int64"},"filterTemplateId":{"type":"string"},"joinFilesType":{"type":"string","description":"Type of file joining.","enum":["EXTENSION","DITA_MAP","NOT_JOINED"]},"joinFilesDitaLevel":{"type":"integer","format":"int32","description":"DITA Map level when mapping by DITA Map is used."},"joinFilesOrigin":{"type":"string","description":"Specifies whether joining is populated from default global settings or is configured in the template itself.","enum":["TEMPLATE","CLIENT"]}}},"RSProjectTemplateCustomFieldResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"projectTemplateId":{"type":"integer","format":"int64"},"definitionId":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"$ref":"#/components/schemas/RSProjectCustomFieldValue"}}},"REPLanguageStatistics":{"type":"object","properties":{"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"},"workflowStatistics":{"type":"array","items":{"$ref":"#/components/schemas/REPWorkflowStatistics"}}}},"REPProjectAggregatedStatistics":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64"},"projectName":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"startDate":{"type":"string","format":"epoch","example":1774765345571},"endDate":{"type":"string","format":"epoch","example":1774765345571},"languageStatistics":{"type":"array","items":{"$ref":"#/components/schemas/REPLanguageStatistics"}}}},"REPProjectJobStatistics":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64"},"fileName":{"type":"string"},"user":{"$ref":"#/components/schemas/REPUser"},"sourcesStatistics":{"$ref":"#/components/schemas/REPStatistics"},"targetStatistics":{"$ref":"#/components/schemas/REPStatistics"}}},"REPProjectStatistics":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64"},"projectName":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"},"stepStatistics":{"type":"array","items":{"$ref":"#/components/schemas/REPStepStatistics"}}}},"REPStatistics":{"type":"object","properties":{"totalCharacters":{"type":"integer","format":"int32"},"totalWords":{"type":"integer","format":"int32"},"totalWhitespaces":{"type":"integer","format":"int32"},"totalTime":{"type":"integer","format":"int64"},"iceMatchCharacters":{"type":"integer","format":"int32"},"iceMatchSegments":{"type":"integer","format":"int32"},"iceMatchWords":{"type":"integer","format":"int32"},"iceMatchWhitespaces":{"type":"integer","format":"int32"},"iceMatchTrackedTime":{"type":"integer","format":"int64"},"lowFuzzyMatchCharacters":{"type":"integer","format":"int32"},"lowFuzzyMatchSegments":{"type":"integer","format":"int32"},"lowFuzzyMatchWords":{"type":"integer","format":"int32"},"lowFuzzyMatchWhitespaces":{"type":"integer","format":"int32"},"lowFuzzyMatchTrackedTime":{"type":"integer","format":"int64"},"mediumFuzzyMatchCharacters":{"type":"integer","format":"int32"},"mediumFuzzyMatchSegments":{"type":"integer","format":"int32"},"mediumFuzzyMatchWords":{"type":"integer","format":"int32"},"mediumFuzzyMatchWhitespaces":{"type":"integer","format":"int32"},"mediumFuzzyMatchTrackedTime":{"type":"integer","format":"int64"},"highFuzzyMatchCharacters":{"type":"integer","format":"int32"},"highFuzzyMatchSegments":{"type":"integer","format":"int32"},"highFuzzyMatchWords":{"type":"integer","format":"int32"},"highFuzzyMatchWhitespaces":{"type":"integer","format":"int32"},"highFuzzyMatchTrackedTime":{"type":"integer","format":"int64"},"repeatsCharacters":{"type":"integer","format":"int32"},"repeatsSegments":{"type":"integer","format":"int32"},"repeatsWords":{"type":"integer","format":"int32"},"repeatsWhitespaces":{"type":"integer","format":"int32"},"repeatsTrackedTime":{"type":"integer","format":"int64"},"leveragedCharacters":{"type":"integer","format":"int32"},"leveragedSegments":{"type":"integer","format":"int32"},"leveragedWords":{"type":"integer","format":"int32"},"leveragedWhitespaces":{"type":"integer","format":"int32"},"nonTranslatableCharacters":{"type":"integer","format":"int32"},"nonTranslatableSegments":{"type":"integer","format":"int32"},"nonTranslatableWords":{"type":"integer","format":"int32"},"nonTranslatableWhitespaces":{"type":"integer","format":"int32"},"nonTranslatableTrackedTime":{"type":"integer","format":"int64"},"otherNonTranslatableWords":{"type":"integer","format":"int32"},"otherNonTranslatableCharacters":{"type":"integer","format":"int32"},"otherNonTranslatableWhitespaces":{"type":"integer","format":"int32"},"otherNonTranslatableTrackedTime":{"type":"integer","format":"int64"},"highFuzzyRepeatsSegments":{"type":"integer","format":"int32"},"highFuzzyRepeatsWords":{"type":"integer","format":"int32"},"highFuzzyRepeatsCharacters":{"type":"integer","format":"int32"},"highFuzzyRepeatsWhitespaces":{"type":"integer","format":"int32"},"highFuzzyRepeatsTrackedTime":{"type":"integer","format":"int64"},"mediumFuzzyRepeatsSegments":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsWords":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsCharacters":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsWhitespaces":{"type":"integer","format":"int32"},"mediumFuzzyRepeatsTrackedTime":{"type":"integer","format":"int64"},"lowFuzzyRepeatsSegments":{"type":"integer","format":"int32"},"lowFuzzyRepeatsWords":{"type":"integer","format":"int32"},"lowFuzzyRepeatsCharacters":{"type":"integer","format":"int32"},"lowFuzzyRepeatsWhitespaces":{"type":"integer","format":"int32"},"lowFuzzyRepeatsTrackedTime":{"type":"integer","format":"int64"},"machineTranslationCharacters":{"type":"integer","format":"int32"},"machineTranslationSegments":{"type":"integer","format":"int32"},"machineTranslationWords":{"type":"integer","format":"int32"},"machineTranslationWhitespaces":{"type":"integer","format":"int32"},"machineTranslationTrackedTime":{"type":"integer","format":"int64"},"noMatchCharacters":{"type":"integer","format":"int32"},"noMatchSegments":{"type":"integer","format":"int32"},"noMatchWhitespaces":{"type":"integer","format":"int32"},"noMatchWords":{"type":"integer","format":"int32"},"noMatchTrackedTime":{"type":"integer","format":"int64"}}},"REPStepStatistics":{"type":"object","properties":{"step":{"type":"string"},"jobStatistics":{"type":"array","items":{"$ref":"#/components/schemas/REPUserJobStatistics"}}}},"REPUser":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}}},"REPUserAggregatedStatistics":{"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"userName":{"type":"string"},"startDate":{"type":"string","format":"epoch","example":1774765345571},"endDate":{"type":"string","format":"epoch","example":1774765345571},"projectStatistics":{"type":"array","items":{"$ref":"#/components/schemas/REPProjectStatistics"}}}},"REPUserJobStatistics":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64"},"fileName":{"type":"string"},"sourceStatistics":{"$ref":"#/components/schemas/REPStatistics"},"targetStatistics":{"$ref":"#/components/schemas/REPStatistics"}}},"REPWorkflowStatistics":{"type":"object","properties":{"step":{"type":"string"},"jobStatistics":{"type":"array","items":{"$ref":"#/components/schemas/REPProjectJobStatistics"}}}},"RSAggregatedStatisticsResponse":{"type":"object","properties":{"aggregatedByProject":{"type":"array","items":{"$ref":"#/components/schemas/REPProjectAggregatedStatistics"}},"aggregatedByUser":{"type":"array","items":{"$ref":"#/components/schemas/REPUserAggregatedStatistics"}}}},"RSEvaluator":{"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"userName":{"type":"string"}}},"RSEvaluee":{"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"userName":{"type":"string"}}},"RSLqaGetResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"},"testCompleteDate":{"type":"integer","format":"int64"},"words":{"type":"integer","format":"int32"},"score":{"type":"number"},"type":{"type":"string","enum":["LANGUAGE","FILE"]},"evaluee":{"$ref":"#/components/schemas/RSEvaluee"},"evaluator":{"$ref":"#/components/schemas/RSEvaluator"},"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."},"sourceLanguage":{"type":"string","description":"Source language code. See [API resources](#tag/Language-codes) for full list of available codes."},"workflowStep":{"type":"string"},"filename":{"type":"string"}}},"LQAJsonReportResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"severityMultipliers":{"$ref":"#/components/schemas/LqaSeverityMultipliers"},"completeDate":{"type":"integer","format":"int64"},"evaluee":{"$ref":"#/components/schemas/LqaLinguist"},"evaluator":{"$ref":"#/components/schemas/LqaLinguist"},"customer":{"$ref":"#/components/schemas/LqaCustomer"},"project":{"$ref":"#/components/schemas/LqaProject"},"language":{"$ref":"#/components/schemas/LqaLanguage"},"files":{"type":"array","items":{"$ref":"#/components/schemas/LqaFile"}}}},"LqaCustomer":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"LqaError":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"parentId":{"type":"integer","format":"int64"},"parentPath":{"type":"string"},"key":{"type":"string"},"weight":{"type":"number"},"issueCounts":{"$ref":"#/components/schemas/LqaIssueCounts"},"penalty":{"$ref":"#/components/schemas/LqaPenalty"},"targetSubscore":{"type":"string"}}},"LqaFile":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/LqaFileDescriptor"},"jobId":{"type":"integer","format":"int64"},"wordCount":{"type":"integer","format":"int32"},"total":{"$ref":"#/components/schemas/LqaTotalCount"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/LqaError"}}}},"LqaFileDescriptor":{"type":"object","properties":{"fileId":{"type":"integer","format":"int64"},"fileName":{"type":"string"}}},"LqaIssueCounts":{"type":"object","properties":{"neutral":{"type":"integer","format":"int32"},"minor":{"type":"integer","format":"int32"},"major":{"type":"integer","format":"int32"},"critical":{"type":"integer","format":"int32"}}},"LqaLanguage":{"type":"object","properties":{"code":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"},"wordCount":{"type":"integer","format":"int32"},"total":{"$ref":"#/components/schemas/LqaTotalCount"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/LqaError"}}}},"LqaLinguist":{"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"userName":{"type":"string"}}},"LqaPenalty":{"type":"object","properties":{"raw":{"type":"number"},"adj":{"type":"number"}}},"LqaProject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"subjectMatter":{"$ref":"#/components/schemas/ProjectSubjectMatter"},"wordCount":{"type":"integer","format":"int32"},"total":{"$ref":"#/components/schemas/LqaTotalCount"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/LqaError"}}}},"LqaSeverityMultipliers":{"type":"object","properties":{"neutral":{"type":"number"},"minor":{"type":"number"},"major":{"type":"number"},"critical":{"type":"number"}}},"LqaTotalCount":{"type":"object","properties":{"weight":{"type":"number"},"issueCounts":{"$ref":"#/components/schemas/LqaIssueCounts"},"penalty":{"$ref":"#/components/schemas/LqaPenalty"},"targetSubscore":{"type":"string"}}},"ProjectSubjectMatter":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"RSProjectBundles":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64"},"projectName":{"type":"string"},"id":{"type":"integer","format":"int64"},"jobId":{"type":"integer","format":"int64"},"wwc":{"type":"integer","format":"int64"},"customerId":{"type":"integer","format":"int64"},"fileName":{"type":"string"},"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."},"sourceLanguage":{"type":"string","description":"Source language code. See [API resources](#tag/Language-codes) for full list of available codes."},"dueDate":{"type":"string","format":"epoch","example":1774765345571},"step":{"$ref":"#/components/schemas/RSWorkflowStep"},"userType":{"type":"string","enum":["INTERNAL_USER","EXTERNAL_USER","LSP","USER_GROUP","EXTERNAL_CREATOR"]},"segmentsDetails":{"$ref":"#/components/schemas/RSSegmentTask"},"rush":{"type":"string","enum":["YES","NO"]},"time":{"type":"integer","format":"int64"},"words":{"type":"integer","format":"int64"}}},"RSProjectBundlesResponse":{"type":"object","properties":{"bundles":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectBundles"}}}},"RSSegmentTask":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"segmentsRangeType":{"type":"string","enum":["FULL","PARTIAL"]}}},"RSProjectFilterTemplateResponse":{"type":"object","properties":{"id":{"type":"string","description":"Analysis template ID."},"scope":{"type":"string","description":"Analysis template availability.","enum":["GLOBAL","CUSTOMER"]},"customerId":{"type":"integer","format":"int64","description":"ID of customer that owns filter template. Null if it is a global template."},"name":{"type":"string","description":"Analysis template name."}}},"RSLanguageCodeDescriptor":{"type":"object","description":"Language code descriptor.","properties":{"languageName":{"type":"string","description":"Language name."}}},"RSLanguageCodesToDescriptorsResponse":{"type":"object","description":"Map of language codes to language descriptors","properties":{"languageCodesToDescriptors":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RSLanguageCodeDescriptor"}}}},"RSExternalUserFindResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"}}},"RSExternalUserGetResponse":{"type":"object","description":"Response object from external user get method.","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"username":{"type":"string","description":"Username"},"email":{"type":"string","description":"Email address"},"integrationId":{"type":"string","description":"ID used in the integration"}}},"RSFindCustomerResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Customer ID."},"name":{"type":"string","description":"Name of customer."},"activity":{"type":"string","description":"Status of customer activity.","enum":["ACTIVE","INACTIVE"]},"address":{"$ref":"#/components/schemas/RSAddressInfo","description":"Address of a customer."}}},"RSCustomerGetResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"nickName":{"type":"string"},"activity":{"type":"string","enum":["ACTIVE","INACTIVE"]},"address":{"$ref":"#/components/schemas/RSAddressInfo"},"projectManagerId":{"type":"integer","format":"int64"},"projectWatchers":{"type":"array","items":{"$ref":"#/components/schemas/RSProjectWatchers"}},"accessType":{"type":"string","enum":["ALL","TERM_AND_TM_ONLY"]},"vatNumber":{"type":"string"}}},"RSProjectWatchers":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string","enum":["CUSTOMER_PM","PM"]}}},"CUSTOMER_LANGUAGE_COMBINATIONS":{"type":"object","properties":{"languageCombinationType":{"type":"string","enum":["DEFAULT","CUSTOMISED","CUSTOMISED_DEFAULT"]},"languageDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/RSLanguageDefinintions"}},"languagePairs":{"type":"array","items":{"$ref":"#/components/schemas/RSLanguagePairs"}}}},"RSLanguageDefinintions":{"type":"object","description":"CUSTOMER_LANGUAGE_DEFINITIONS","properties":{"languageCode":{"type":"string","description":"Language code. See [API resources](#tag/Language-codes) for full list of available codes."},"name":{"type":"string","description":"Name."}}},"RSLanguagePairs":{"type":"object","description":"LANGUAGE_PAIRS","properties":{"sourceLanguageCode":{"type":"string","description":"Source language code. See [API resources](#tag/Language-codes) for full list of available codes."},"targetLanguageCode":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."}}},"RSCustomFieldValue":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"value":{"type":"string"}}},"RSFindCustomFieldResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string","enum":["CHECKBOX","DATE","MULTIPLE_SELECTION","NUMBER","TEXTFIELD","DROPDOWN","HYPERLINK"]},"obligatory":{"type":"string","enum":["YES","NO"]},"activity":{"type":"string","enum":["ACTIVE","INACTIVE"]},"module":{"type":"string","enum":["PROJECT","TERMINOLOGY","CUSTOMER","USER"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/RSCustomFieldValue"}}}},"RSFindCustomFieldOfTerminologyResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string","enum":["CHECKBOX","DATE","MULTIPLE_SELECTION","NUMBER","TEXTFIELD","DROPDOWN","HYPERLINK"]},"obligatory":{"type":"string","enum":["YES","NO"]},"activity":{"type":"string","enum":["ACTIVE","INACTIVE"]},"module":{"type":"string","enum":["PROJECT","TERMINOLOGY","CUSTOMER","USER"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/RSCustomFieldValue"}},"tbxName":{"type":"string"},"section":{"type":"string","enum":["TERM","CONCEPT"]}}},"RSFindConcordanceSegmentContext":{"type":"object","description":"SegmentContextInformation","properties":{"sourcePrevious":{"type":"string","description":"Previous segment source."},"sourceNext":{"type":"string","description":"Next segment source."},"targetPrevious":{"type":"string","description":"Previous segment target."},"targetNext":{"type":"string","description":"Next segment target."}}},"RSFindConcordanceSegmentResponse":{"type":"object","description":"ConcordanceSegment.","properties":{"id":{"type":"integer","format":"int64","description":"Segment ID."},"context":{"type":"array","description":"Context details.","items":{"$ref":"#/components/schemas/RSFindConcordanceSegmentContext"}},"tags":{"type":"array","description":"Tags.","items":{"$ref":"#/components/schemas/RSTagInfo"}},"sourceLanguage":{"type":"string","description":"Source language code. See [API resources](#tag/Language-codes) for full list of available codes."},"targetLanguage":{"type":"string","description":"Target language code. See [API resources](#tag/Language-codes) for full list of available codes."},"sourceText":{"type":"string","description":"Segment source text."},"targetText":{"type":"string","description":"Segment target text."},"segmentId":{"type":"string","description":"Segment ID base matching ID."},"fileName":{"type":"string","description":"File name."},"xliffDocStatus":{"type":"string","description":"Segment xliff doc status.","enum":["NEEDS_REVIEW_TRANSLATION","NEW","TRANSLATED","FINAL","SIGNED_OFF"]},"status":{"type":"string","description":"Segment approving status.","enum":["APPROVED","NOT_APPROVED"]},"createDate":{"type":"string","format":"epoch","description":"Segment create date in timestamp.","example":1774765345571},"changeDate":{"type":"string","format":"epoch","description":"Segment change date in timestamp.","example":1774765345571},"createdByUserId":{"type":"integer","format":"int64","description":"Creator ID."},"createdByUsername":{"type":"string","description":"Creator username."},"changedByUserId":{"type":"integer","format":"int64","description":"ID of user who modify segment."},"changedByUsername":{"type":"string","description":"Username of user who modify segment."}}},"RSTagInfo":{"type":"object","description":"Tag.","properties":{"id":{"type":"integer","format":"int64","description":"Tag ID."},"name":{"type":"string","description":"Tag name."},"values":{"type":"array","description":"Tag values.","items":{"$ref":"#/components/schemas/RSTagValueInfo"}}}},"RSTagValueInfo":{"type":"object","description":"TagValue.","properties":{"id":{"type":"integer","format":"int64","description":"Tag value ID."},"name":{"type":"string","description":"Tag value name."}}},"RSGetCallbackPropertiesResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback type."},"callbackType":{"type":"string","description":"Callback type.","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]},"propertyScope":{"type":"string","description":"Callback property scope.","enum":["CUSTOMER","CLIENT"]},"customerId":{"type":"integer","format":"int64","description":"Customer ID."},"url":{"type":"string","description":"Callback URL address."}}},"RSGetCallbackAuthenticationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback authentication ID."},"name":{"type":"string","description":"Callback authentication name."},"domain":{"type":"string","description":"Callback authentication domain URL address."},"authenticationType":{"type":"string","description":" Authentication mechanism that is used by the callback.","enum":["BASIC","SIGNATURE","OAUTH_2"]},"authenticationScope":{"type":"string","description":"Scope of authentication used for the callback.","enum":["CLIENT","DOMAIN"]},"createDate":{"type":"string","format":"epoch","description":"Callback authentication creation date.","example":1774765345571},"basicDetails":{"$ref":"#/components/schemas/RSCallbackBasicDetails","description":"Details for BASIC authentication type."},"oauth2Details":{"$ref":"#/components/schemas/RSCallbackOAuth2Details","description":"Details for OAUTH_2 authentication type."}}},"RSDeletedUserTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User's ID."}}},"RSUserDeleteResponse":{"type":"object","properties":{"deletedUsers":{"type":"array","items":{"$ref":"#/components/schemas/RSDeletedUserTO"}}}},"RSDeleteUserWorkflowStepsRequest":{"type":"object","properties":{"ids":{"type":"array","description":"Workflow step IDs.","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["ids"]},"RSDeleteUserWorkflowStepsResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSDeleteUserSubjectMattersRequest":{"type":"object","properties":{"ids":{"type":"array","description":"IDs of subject matters.","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["ids"]},"RSDeleteUserSubjectMattersResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSDeleteUserLanguageCombinationsRequest":{"type":"object","properties":{"languageCombinations":{"type":"array","description":"Language combinations.","items":{"$ref":"#/components/schemas/RSUserLanguageCombination"},"minItems":1}},"required":["languageCombinations"]},"RSDeleteUserLanguageCombinationsResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSDeleteUserRolesRequest":{"type":"object","properties":{"ids":{"type":"array","description":"IDs of roles.","items":{"type":"integer","format":"int64"},"minItems":1}},"required":["ids"]},"RSDeleteUserRolesResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSDeleteTermRequest":{"type":"object","properties":{"customerIds":{"type":"array","description":"Customer IDs. If no identifiers are specified, the deletion process will be performed for all available customers.","items":{"type":"integer","format":"int64"}},"mainLanguage":{"type":"string","description":"Main language. If no value is specified, the deletion process will be performed for all available languages. See [API resources](#tag/Language-codes) for full list of available codes."},"creationFilter":{"$ref":"#/components/schemas/RSTermCreationFilter","description":"A filter containing a list of creator identifiers and a range of creation dates."}}},"RSDeleteTermResponse":{"type":"object","properties":{"status":{"type":"string","description":"Status of the delete term operation.","enum":["SUCCESS","ERROR"]}}},"RSTagGroupDeleteResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSTagDeleteResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSProjectDeletionResponse":{"type":"object","description":"Response object from project deletion method.","properties":{"success":{"type":"boolean","description":"Informs whether deletion was successful or not.","example":true}}},"RSProjectWorkflowDeleteStepsRequest":{"type":"object","description":"JSON format data to add steps to workflow, contains objects with filter parameters and step descriptors.","properties":{"jobIds":{"type":"array","description":"Job ID.","items":{"type":"integer","format":"int64"}},"id":{"type":"string","description":"Workflow ID. The ID can be obtained from the [obtain workflows method](#tag/Project-workflows/operation/obtainWorkflows) response.","minLength":1},"targetLanguages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","example":["en_GB"],"items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}},"stepNames":{"type":"array","description":"Steps to delete","items":{"type":"string"},"minItems":1}},"required":["id","stepNames"]},"RSProjectWorkflowDeleteStepsResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the workflow"},"name":{"type":"string","description":"Name of the workflow"},"steps":{"type":"array","description":"Descriptors of steps in the workflow","items":{"$ref":"#/components/schemas/RSProjectWorkflowStepResponse"}}}},"RSProjectTargetLanguagesDeleteRequest":{"type":"object","description":"JSON format data to delete, contains target languages codes.","properties":{"targetLanguages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"}}}},"RSProjectTargetLanguagesDeleteResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSProjectFileRemoveParameter":{"type":"object","description":"Request fields for delete files.","properties":{"fileName":{"type":"string","description":"The name of file."},"languages":{"type":"array","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available language codes.","items":{"type":"string","description":"Target languages codes. See [API resources](#tag/Language-codes) for full list of available codes.","x-example":"en_GB"},"uniqueItems":true}}},"RSProjectFileDeleteResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSDeleteProjectCallbacksRequest":{"type":"object","description":"JSON format data to delete callbacks from project.","properties":{"ids":{"type":"array","description":"Callback IDs.","items":{"type":"string"}},"urls":{"type":"array","description":"Callback URLs.","items":{"type":"string"}},"types":{"type":"array","description":"Callback types.","items":{"type":"string","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]}}}},"RSDeleteProjectCallbackResponse":{"type":"object","description":"Deleted callback's descriptor.","properties":{"id":{"type":"string","description":"Callback ID."},"projectId":{"type":"integer","format":"int64","description":"Project ID."},"url":{"type":"string","description":"Callback URL."},"type":{"type":"string","description":"Callback type.","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]}}},"RSExternalUserDeleteResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSCustomerDeleteResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"RSDeleteCallbackPropertiesRequest":{"type":"object","properties":{"ids":{"type":"array","description":"Callback property IDs.","items":{"type":"string"}},"callbackTypes":{"type":"array","description":"Callback types.","items":{"type":"string","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]}},"propertyScopes":{"type":"array","description":"Callback properties scope. `CLIENT` indicates that a property is applied for every project that is created. `CUSTOMER` indicates that a property is only applied for a project created for the specified customer.","items":{"type":"string","enum":["CUSTOMER","CLIENT"]}},"customerIds":{"type":"array","description":"Customer IDs.","items":{"type":"integer","format":"int64"}},"urls":{"type":"array","description":"Callback URL addresses.","items":{"type":"string"}}}},"RSDeleteCallbackPropertiesResponseWrapper":{"type":"object","properties":{"deletedProperties":{"type":"array","items":{"$ref":"#/components/schemas/RSDeleteCallbackPropertyResponse"}}}},"RSDeleteCallbackPropertyResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback type."},"callbackType":{"type":"string","description":"Callback type.","enum":["PROJECT_CREATED","PROJECT_ACCEPTED","PROJECT_FINISHED","JOB_FINISHED","ANALYSIS_FINISHED","WORKFLOW_TRANSITION","INVOICE_STATUS_CHANGED","SOURCE_FILE_UPDATED","PROJECT_ACTIVITY_CHANGED","PROJECT_LANGUAGE_CHANGED","DUE_DATE_CHANGED"]},"propertyScope":{"type":"string","description":"Callback property scope. `CLIENT` indicates that a property is applied for every project that is created. `CUSTOMER` indicates that a property is only applied for a project created for the specified customer.","enum":["CUSTOMER","CLIENT"]},"customerId":{"type":"integer","format":"int64","description":"Customer ID."},"url":{"type":"string","description":"Callback URL address."}}},"RSDeleteCallbackAuthenticationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Callback authentication ID."},"name":{"type":"string","description":"Callback authentication name."},"domain":{"type":"string","description":"Callback authentication domain URL address."},"authenticationType":{"type":"string","description":" Authentication mechanism that is used by the callback.","enum":["BASIC","SIGNATURE","OAUTH_2"]},"authenticationScope":{"type":"string","description":"Scope of authentication used for the callback.","enum":["CLIENT","DOMAIN"]},"createDate":{"type":"string","format":"epoch","description":"Callback authentication creation date.","example":1774765345571},"basicDetails":{"$ref":"#/components/schemas/RSCallbackBasicDetails","description":"Details for BASIC authentication type."},"oauth2Details":{"$ref":"#/components/schemas/RSCallbackOAuth2Details"}}}},"securitySchemes":{"xtm-basic":{"type":"apiKey","description":"XTM Basic – relies on user credentials to obtain an access token with permanent access.\n\nYou can find more information about the XTM Basic here: [link to XTM Basic section](#tag/XTM-Basic).\n","name":"Authorization","in":"header"},"bearer-token-oauth2":{"type":"oauth2","description":"OAuth 2.0 – a commonly used standard among the vast majority of API providers working in cloud applications. XTM supports the Password flow (Resource Owner Password Credentials) and the Refresh token flow to obtain access tokens. This method is preferred by XTM\n\nYou can find more information about OAuth tokens here: [link to OAuth 2.0 section](#tag/OAuth-2.0).\n","flows":{"password":{"tokenUrl":"https://www.xtm-cloud.com/authentication-api/oauth/token","refreshUrl":"https://www.xtm-cloud.com/authentication-api/oauth/token","scopes":{}}}},"saml":{"description":"A popular authentication standard using a third-party identity provider.\nYou can use a third-party system to authenticate and then get an OAuth 2.0 token, which you can use in our oauth flow available here: [link to OAuth 2.0 section](#tag/OAuth-2.0).\n","name":"SAML"},"Roles":{"type":"oauth2","description":"Access to the various methods in the XTM REST API is controlled by the login credentials. More details under [Roles section.](#tag/Roles)\n\n\t\n\t\t\n\t\t\n\t\n
    Roles\n\t\t\t
      \n\t\t\t\t
    • \n\t\t\t\t\tadministrator - Administrator. \nEquivalent of ADMINISTRATOR in Roles)\n\t\t\t\t
      • \n\t\t\t\t
    • \n\t\t\t\t\tpm - Internal Project manager. \nEquivalent of PROJECT_MANAGER in Roles)\n\t\t\t\t
      • \n\t\t\t\t
    • \n\t\t\t\t\tcustomer_pm - Customer Project manager. \nEquivalent of CUSTOMER_PM in Roles)\n\t\t\t\t
      • \n\t\t\t\t
    • \n\t\t\t\t\tlinguist - Linguist. \nEquivalent of LINGUIST in Roles)\n\t\t\t\t
      • \n\t\t\t\t
    • \n\t\t\t\t\tterm_expert - Terminology expert. \nEquivalent of TERMINOLOGY_EXPERT in Roles)\n\t\t\t\t
      • \n\t\t\t\t
    • \n\t\t\t\t\ttm_expert - Translation memory expert. \nEquivalent of TM_EXPERT in Roles)\n\t\t\t\t
      • \n\t\t\t
    \n\t\t
    ","flows":{"password":{"tokenUrl":"https://example.com/oauth/token","scopes":{"pm":"Internal Project manager","customer_pm":"Customer Project manager","linguist":"Linguist"}}}}}},"x-tagGroups":[{"name":"Authentication Methods","tags":["OAuth 2.0","XTM Basic","SAML"]},{"name":"API resources","tags":["Callbacks","Definitions","HTTP Codes","Practice online"]},{"name":"Projects","tags":["Project","Project activity","Project analytics","Project bundles","Project callbacks","Project costs","Project custom fields","Project files","Project jobs","Project links","Project LQA","Project states","Project templates","Project templates custom fields","Project workflows","Project workflows time trackings"]},{"name":"Callbacks","tags":["Callback authentications","Callback properties"]},{"name":"Workflows","tags":["Workflow"]},{"name":"Custom fields","tags":["Custom field"]},{"name":"Customers","tags":["Customer","Customer files"]},{"name":"Users","tags":["User","User access rights","User language combinations","User rate cards","User subject matters","User workflow steps","External user"]},{"name":"Languages","tags":["Languages"]},{"name":"LSPs","tags":["LSP rate cards"]},{"name":"Concordance","tags":["Concordance"]},{"name":"Translation memory","tags":["Translation memory penalty profiles","Translation memory export","Translation memory import"]},{"name":"Terminology","tags":["Terminology","Terminology penalty profiles","Terminology import","Terminology export"]},{"name":"Tags","tags":["Tag","Tag groups"]},{"name":"Subject matters","tags":["Subject matter"]},{"name":"Roles","tags":["Roles"]},{"name":"System","tags":["System"]},{"name":"References","tags":["Cost generation error types","Cost generation warning types","Currencies","Date formats","Language codes","Time formats","Time zones","ISO-8601 Date format"]},{"name":"Revisions","tags":["Revision history"]}]}