Skip to content

Latest commit

 

History

History
4178 lines (3179 loc) · 144 KB

File metadata and controls

4178 lines (3179 loc) · 144 KB

phrasetms_client.ProjectApi

All URIs are relative to https://cloud.memsource.com/web

Method HTTP request Description
add_target_language_to_project POST /api2/v1/projects/{projectUid}/targetLangs Add target languages
add_workflow_steps POST /api2/v1/projects/{projectUid}/workflowSteps Add workflow steps
assign_linguists_from_template POST /api2/v1/projects/{projectUid}/applyTemplate/{templateUid}/assignProviders Assigns providers from template
assign_linguists_from_template_to_job_parts POST /api2/v1/projects/{projectUid}/applyTemplate/{templateUid}/assignProviders/forJobParts Assigns providers from template (specific jobs)
assign_vendor_to_project POST /api2/v1/projects/{projectUid}/assignVendor Assign vendor
assignable_templates GET /api2/v1/projects/{projectUid}/assignableTemplates List assignable templates
clone_project POST /api2/v1/projects/{projectUid}/clone Clone project
create_custom_fields POST /api2/v1/projects/{projectUid}/customFields Create custom field instances
create_project_from_template_v2 POST /api2/v2/projects/applyTemplate/{templateUid} Create project from template
create_project_from_template_v2_async POST /api2/v2/projects/applyTemplate/async/{templateUid} Create project from template (async)
create_project_v3 POST /api2/v3/projects Create project
delete_custom_field1 DELETE /api2/v1/projects/{projectUid}/customFields/{fieldInstanceUid} Delete custom field of project
delete_project DELETE /api2/v1/projects/{projectUid} Delete project
edit_custom_field PUT /api2/v1/projects/{projectUid}/customFields/{fieldInstanceUid} Edit custom field of project
edit_custom_fields PUT /api2/v1/projects/{projectUid}/customFields Edit custom fields of the project (batch)
edit_import_settings1 PUT /api2/v1/projects/{projectUid}/importSettings Edit project import settings
edit_project_access_settings_v2 PUT /api2/v2/projects/{projectUid}/accessSettings Edit access and security settings
edit_project_pre_translate_settings2 PUT /api2/v3/projects/{projectUid}/preTranslateSettings Update Pre-translate settings
edit_project_v2 PUT /api2/v2/projects/{projectUid} Edit project
enabled_quality_checks GET /api2/v1/projects/{projectUid}/qaSettingsChecks Get QA checks
get_analyse_settings_for_project GET /api2/v1/projects/{projectUid}/analyseSettings Get analyse settings
get_custom_field1 GET /api2/v1/projects/{projectUid}/customFields/{fieldInstanceUid} Get custom field of project
get_custom_fields_page GET /api2/v1/projects/{projectUid}/customFields Get custom fields of project (page)
get_file_naming_settings GET /api2/v1/projects/{projectUid}/fileNamingSettings Get file naming settings for project
get_financial_settings GET /api2/v1/projects/{projectUid}/financialSettings Get financial settings
get_import_settings2 GET /api2/v1/projects/{projectUid}/importSettings Get projects's default import settings
get_mt_settings_for_project GET /api2/v1/projects/{projectUid}/mtSettings Get project machine translate settings
get_pre_translate_settings_for_project2 GET /api2/v3/projects/{projectUid}/preTranslateSettings Get Pre-translate settings
get_project GET /api2/v1/projects/{projectUid} Get project
get_project_access_settings_v2 GET /api2/v2/projects/{projectUid}/accessSettings Get access and security settings
get_project_assignments GET /api2/v1/projects/{projectUid}/providers List project providers
get_project_settings GET /api2/v1/projects/{projectUid}/lqaSettings Get LQA settings
get_project_term_bases GET /api2/v1/projects/{projectUid}/termBases Get term bases
get_project_trans_memories1 GET /api2/v3/projects/{projectUid}/transMemories Get translation memories
get_project_workflow_steps_v2 GET /api2/v2/projects/{projectUid}/workflowSteps Get workflow steps
get_quotes_for_project GET /api2/v1/projects/{projectUid}/quotes List quotes
list_assigned_projects GET /api2/v1/users/{userUid}/projects List assigned projects
list_by_project_v3 GET /api2/v3/projects/{projectUid}/analyses List analyses by project
list_projects GET /api2/v1/projects List projects
list_providers3 POST /api2/v2/projects/{projectUid}/providers/suggest Get suggested providers
patch_project PATCH /api2/v1/projects/{projectUid} Edit project
relevant_term_bases GET /api2/v1/projects/{projectUid}/termBases/relevant List project relevant term bases
relevant_trans_memories1 GET /api2/v1/projects/{projectUid}/transMemories/relevant List project relevant translation memories
search_segment1 POST /api2/v1/projects/{projectUid}/transMemories/searchSegmentInProject Search translation memory for segment in the project
set_financial_settings PUT /api2/v1/projects/{projectUid}/financialSettings Edit financial settings
set_mt_settings_for_project PUT /api2/v1/projects/{projectUid}/mtSettings Edit machine translate settings
set_mt_settings_per_language_for_project PUT /api2/v1/projects/{projectUid}/mtSettingsPerLanguage Edit machine translate settings per language
set_project_qa_settings_v2 PUT /api2/v2/projects/{projectUid}/qaSettings Edit quality assurance settings
set_project_status POST /api2/v1/projects/{projectUid}/setStatus Edit project status
set_project_term_bases PUT /api2/v1/projects/{projectUid}/termBases Edit term bases
set_project_trans_memories_v3 PUT /api2/v3/projects/{projectUid}/transMemories Edit translation memories
update_file_naming_settings PUT /api2/v1/projects/{projectUid}/fileNamingSettings Update file naming settings for project

add_target_language_to_project

add_target_language_to_project(project_uid, body=body)

Add target languages

Add target languages to project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.add_target_lang_dto import AddTargetLangDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.AddTargetLangDto() # AddTargetLangDto |  (optional)

    try:
        # Add target languages
        api_instance.add_target_language_to_project(project_uid, body=body)
    except Exception as e:
        print("Exception when calling ProjectApi->add_target_language_to_project: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body AddTargetLangDto [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_workflow_steps

add_workflow_steps(project_uid, body=body)

Add workflow steps

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.add_workflow_steps_dto import AddWorkflowStepsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.AddWorkflowStepsDto() # AddWorkflowStepsDto |  (optional)

    try:
        # Add workflow steps
        api_instance.add_workflow_steps(project_uid, body=body)
    except Exception as e:
        print("Exception when calling ProjectApi->add_workflow_steps: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body AddWorkflowStepsDto [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

assign_linguists_from_template

JobPartsDto assign_linguists_from_template(template_uid, project_uid)

Assigns providers from template

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.job_parts_dto import JobPartsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    template_uid = 'template_uid_example' # str | 
    project_uid = 'project_uid_example' # str | 

    try:
        # Assigns providers from template
        api_response = api_instance.assign_linguists_from_template(template_uid, project_uid)
        print("The response of ProjectApi->assign_linguists_from_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->assign_linguists_from_template: %s\n" % e)

Parameters

Name Type Description Notes
template_uid str
project_uid str

Return type

JobPartsDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

assign_linguists_from_template_to_job_parts

JobPartsDto assign_linguists_from_template_to_job_parts(template_uid, project_uid, body=body)

Assigns providers from template (specific jobs)

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.job_part_references import JobPartReferences
from phrasetms_client.models.job_parts_dto import JobPartsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    template_uid = 'template_uid_example' # str | 
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.JobPartReferences() # JobPartReferences |  (optional)

    try:
        # Assigns providers from template (specific jobs)
        api_response = api_instance.assign_linguists_from_template_to_job_parts(template_uid, project_uid, body=body)
        print("The response of ProjectApi->assign_linguists_from_template_to_job_parts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->assign_linguists_from_template_to_job_parts: %s\n" % e)

Parameters

Name Type Description Notes
template_uid str
project_uid str
body JobPartReferences [optional]

Return type

JobPartsDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

assign_vendor_to_project

assign_vendor_to_project(project_uid, body=body)

Assign vendor

To unassign Vendor from Project, use empty body: {}

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.assign_vendor_dto import AssignVendorDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.AssignVendorDto() # AssignVendorDto |  (optional)

    try:
        # Assign vendor
        api_instance.assign_vendor_to_project(project_uid, body=body)
    except Exception as e:
        print("Exception when calling ProjectApi->assign_vendor_to_project: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body AssignVendorDto [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

assignable_templates

AssignableTemplatesDto assignable_templates(project_uid)

List assignable templates

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.assignable_templates_dto import AssignableTemplatesDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # List assignable templates
        api_response = api_instance.assignable_templates(project_uid)
        print("The response of ProjectApi->assignable_templates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->assignable_templates: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

AssignableTemplatesDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

clone_project

AbstractProjectDto clone_project(project_uid, body=body)

Clone project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.abstract_project_dto import AbstractProjectDto
from phrasetms_client.models.clone_project_dto import CloneProjectDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.CloneProjectDto() # CloneProjectDto |  (optional)

    try:
        # Clone project
        api_response = api_instance.clone_project(project_uid, body=body)
        print("The response of ProjectApi->clone_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->clone_project: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body CloneProjectDto [optional]

Return type

AbstractProjectDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_custom_fields

CustomFieldInstancesDto create_custom_fields(project_uid, body=body)

Create custom field instances

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.create_custom_field_instances_dto import CreateCustomFieldInstancesDto
from phrasetms_client.models.custom_field_instances_dto import CustomFieldInstancesDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.CreateCustomFieldInstancesDto() # CreateCustomFieldInstancesDto |  (optional)

    try:
        # Create custom field instances
        api_response = api_instance.create_custom_fields(project_uid, body=body)
        print("The response of ProjectApi->create_custom_fields:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->create_custom_fields: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body CreateCustomFieldInstancesDto [optional]

Return type

CustomFieldInstancesDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_project_from_template_v2

AbstractProjectDtoV2 create_project_from_template_v2(template_uid, body=body)

Create project from template

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.abstract_project_dto_v2 import AbstractProjectDtoV2
from phrasetms_client.models.create_project_from_template_v2_dto import CreateProjectFromTemplateV2Dto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    template_uid = 'template_uid_example' # str | 
    body = phrasetms_client.CreateProjectFromTemplateV2Dto() # CreateProjectFromTemplateV2Dto |  (optional)

    try:
        # Create project from template
        api_response = api_instance.create_project_from_template_v2(template_uid, body=body)
        print("The response of ProjectApi->create_project_from_template_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->create_project_from_template_v2: %s\n" % e)

Parameters

Name Type Description Notes
template_uid str
body CreateProjectFromTemplateV2Dto [optional]

Return type

AbstractProjectDtoV2

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_project_from_template_v2_async

AsyncRequestWrapperV2Dto create_project_from_template_v2_async(template_uid, body=body)

Create project from template (async)

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.async_request_wrapper_v2_dto import AsyncRequestWrapperV2Dto
from phrasetms_client.models.create_project_from_template_async_v2_dto import CreateProjectFromTemplateAsyncV2Dto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    template_uid = 'template_uid_example' # str | 
    body = phrasetms_client.CreateProjectFromTemplateAsyncV2Dto() # CreateProjectFromTemplateAsyncV2Dto |  (optional)

    try:
        # Create project from template (async)
        api_response = api_instance.create_project_from_template_v2_async(template_uid, body=body)
        print("The response of ProjectApi->create_project_from_template_v2_async:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->create_project_from_template_v2_async: %s\n" % e)

Parameters

Name Type Description Notes
template_uid str
body CreateProjectFromTemplateAsyncV2Dto [optional]

Return type

AsyncRequestWrapperV2Dto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_project_v3

AbstractProjectDtoV2 create_project_v3(body=body)

Create project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.abstract_project_dto_v2 import AbstractProjectDtoV2
from phrasetms_client.models.create_project_v3_dto import CreateProjectV3Dto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    body = phrasetms_client.CreateProjectV3Dto() # CreateProjectV3Dto |  (optional)

    try:
        # Create project
        api_response = api_instance.create_project_v3(body=body)
        print("The response of ProjectApi->create_project_v3:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->create_project_v3: %s\n" % e)

Parameters

Name Type Description Notes
body CreateProjectV3Dto [optional]

Return type

AbstractProjectDtoV2

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_custom_field1

delete_custom_field1(project_uid, field_instance_uid)

Delete custom field of project

Example

import time
import os
import phrasetms_client
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    field_instance_uid = 'field_instance_uid_example' # str | 

    try:
        # Delete custom field of project
        api_instance.delete_custom_field1(project_uid, field_instance_uid)
    except Exception as e:
        print("Exception when calling ProjectApi->delete_custom_field1: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
field_instance_uid str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_project

delete_project(project_uid, purge=purge)

Delete project

Example

import time
import os
import phrasetms_client
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    purge = False # bool |  (optional) (default to False)

    try:
        # Delete project
        api_instance.delete_project(project_uid, purge=purge)
    except Exception as e:
        print("Exception when calling ProjectApi->delete_project: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
purge bool [optional] [default to False]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_custom_field

CustomFieldInstanceDto edit_custom_field(project_uid, field_instance_uid, body=body)

Edit custom field of project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.custom_field_instance_dto import CustomFieldInstanceDto
from phrasetms_client.models.update_custom_field_instance_dto import UpdateCustomFieldInstanceDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    field_instance_uid = 'field_instance_uid_example' # str | 
    body = phrasetms_client.UpdateCustomFieldInstanceDto() # UpdateCustomFieldInstanceDto |  (optional)

    try:
        # Edit custom field of project
        api_response = api_instance.edit_custom_field(project_uid, field_instance_uid, body=body)
        print("The response of ProjectApi->edit_custom_field:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->edit_custom_field: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
field_instance_uid str
body UpdateCustomFieldInstanceDto [optional]

Return type

CustomFieldInstanceDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_custom_fields

CustomFieldInstancesDto edit_custom_fields(project_uid, body=body)

Edit custom fields of the project (batch)

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.custom_field_instances_dto import CustomFieldInstancesDto
from phrasetms_client.models.update_custom_field_instances_dto import UpdateCustomFieldInstancesDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.UpdateCustomFieldInstancesDto() # UpdateCustomFieldInstancesDto |  (optional)

    try:
        # Edit custom fields of the project (batch)
        api_response = api_instance.edit_custom_fields(project_uid, body=body)
        print("The response of ProjectApi->edit_custom_fields:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->edit_custom_fields: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body UpdateCustomFieldInstancesDto [optional]

Return type

CustomFieldInstancesDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_import_settings1

FileImportSettingsDto edit_import_settings1(project_uid, body=body)

Edit project import settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.file_import_settings_create_dto import FileImportSettingsCreateDto
from phrasetms_client.models.file_import_settings_dto import FileImportSettingsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.FileImportSettingsCreateDto() # FileImportSettingsCreateDto |  (optional)

    try:
        # Edit project import settings
        api_response = api_instance.edit_import_settings1(project_uid, body=body)
        print("The response of ProjectApi->edit_import_settings1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->edit_import_settings1: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body FileImportSettingsCreateDto [optional]

Return type

FileImportSettingsDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_project_access_settings_v2

ProjectSecuritySettingsDtoV2 edit_project_access_settings_v2(project_uid, body=body)

Edit access and security settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.edit_project_security_settings_dto_v2 import EditProjectSecuritySettingsDtoV2
from phrasetms_client.models.project_security_settings_dto_v2 import ProjectSecuritySettingsDtoV2
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.EditProjectSecuritySettingsDtoV2() # EditProjectSecuritySettingsDtoV2 |  (optional)

    try:
        # Edit access and security settings
        api_response = api_instance.edit_project_access_settings_v2(project_uid, body=body)
        print("The response of ProjectApi->edit_project_access_settings_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->edit_project_access_settings_v2: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body EditProjectSecuritySettingsDtoV2 [optional]

Return type

ProjectSecuritySettingsDtoV2

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_project_pre_translate_settings2

PreTranslateSettingsV3Dto edit_project_pre_translate_settings2(project_uid, body=body)

Update Pre-translate settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.pre_translate_settings_v3_dto import PreTranslateSettingsV3Dto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.PreTranslateSettingsV3Dto() # PreTranslateSettingsV3Dto |  (optional)

    try:
        # Update Pre-translate settings
        api_response = api_instance.edit_project_pre_translate_settings2(project_uid, body=body)
        print("The response of ProjectApi->edit_project_pre_translate_settings2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->edit_project_pre_translate_settings2: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body PreTranslateSettingsV3Dto [optional]

Return type

PreTranslateSettingsV3Dto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_project_v2

AbstractProjectDtoV2 edit_project_v2(project_uid, body=body)

Edit project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.abstract_project_dto_v2 import AbstractProjectDtoV2
from phrasetms_client.models.edit_project_v2_dto import EditProjectV2Dto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.EditProjectV2Dto() # EditProjectV2Dto |  (optional)

    try:
        # Edit project
        api_response = api_instance.edit_project_v2(project_uid, body=body)
        print("The response of ProjectApi->edit_project_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->edit_project_v2: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body EditProjectV2Dto [optional]

Return type

AbstractProjectDtoV2

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enabled_quality_checks

EnabledQualityChecksDto enabled_quality_checks(project_uid)

Get QA checks

Returns enabled quality assurance settings.

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.enabled_quality_checks_dto import EnabledQualityChecksDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # Get QA checks
        api_response = api_instance.enabled_quality_checks(project_uid)
        print("The response of ProjectApi->enabled_quality_checks:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->enabled_quality_checks: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

EnabledQualityChecksDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_analyse_settings_for_project

AnalyseSettingsDto get_analyse_settings_for_project(project_uid)

Get analyse settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.analyse_settings_dto import AnalyseSettingsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # Get analyse settings
        api_response = api_instance.get_analyse_settings_for_project(project_uid)
        print("The response of ProjectApi->get_analyse_settings_for_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_analyse_settings_for_project: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

AnalyseSettingsDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_custom_field1

CustomFieldInstanceDto get_custom_field1(project_uid, field_instance_uid)

Get custom field of project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.custom_field_instance_dto import CustomFieldInstanceDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    field_instance_uid = 'field_instance_uid_example' # str | 

    try:
        # Get custom field of project
        api_response = api_instance.get_custom_field1(project_uid, field_instance_uid)
        print("The response of ProjectApi->get_custom_field1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_custom_field1: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
field_instance_uid str

Return type

CustomFieldInstanceDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_custom_fields_page

PageDtoCustomFieldInstanceDto get_custom_fields_page(project_uid, page_number=page_number, page_size=page_size, created_by=created_by, modified_by=modified_by, sort_field=sort_field, sort_trend=sort_trend)

Get custom fields of project (page)

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_custom_field_instance_dto import PageDtoCustomFieldInstanceDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    page_number = 0 # int | Page number, starting with 0, default 0 (optional) (default to 0)
    page_size = 20 # int | Page size, accepts values between 1 and 50, default 20 (optional) (default to 20)
    created_by = ['created_by_example'] # List[str] | Filter by webhook creators UIDs (optional)
    modified_by = ['modified_by_example'] # List[str] | Filter by webhook updaters UIDs (optional)
    sort_field = 'sort_field_example' # str | Sort by this field (optional)
    sort_trend = 'ASC' # str | Sort direction (optional) (default to 'ASC')

    try:
        # Get custom fields of project (page)
        api_response = api_instance.get_custom_fields_page(project_uid, page_number=page_number, page_size=page_size, created_by=created_by, modified_by=modified_by, sort_field=sort_field, sort_trend=sort_trend)
        print("The response of ProjectApi->get_custom_fields_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_custom_fields_page: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
page_number int Page number, starting with 0, default 0 [optional] [default to 0]
page_size int Page size, accepts values between 1 and 50, default 20 [optional] [default to 20]
created_by List[str] Filter by webhook creators UIDs [optional]
modified_by List[str] Filter by webhook updaters UIDs [optional]
sort_field str Sort by this field [optional]
sort_trend str Sort direction [optional] [default to 'ASC']

Return type

PageDtoCustomFieldInstanceDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_file_naming_settings

FileNamingSettingsDto get_file_naming_settings(project_uid)

Get file naming settings for project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.file_naming_settings_dto import FileNamingSettingsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # Get file naming settings for project
        api_response = api_instance.get_file_naming_settings(project_uid)
        print("The response of ProjectApi->get_file_naming_settings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_file_naming_settings: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

FileNamingSettingsDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_financial_settings

FinancialSettingsDto get_financial_settings(project_uid)

Get financial settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.financial_settings_dto import FinancialSettingsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # Get financial settings
        api_response = api_instance.get_financial_settings(project_uid)
        print("The response of ProjectApi->get_financial_settings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_financial_settings: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

FinancialSettingsDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_import_settings2

FileImportSettingsDto get_import_settings2(project_uid)

Get projects's default import settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.file_import_settings_dto import FileImportSettingsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # Get projects's default import settings
        api_response = api_instance.get_import_settings2(project_uid)
        print("The response of ProjectApi->get_import_settings2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_import_settings2: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

FileImportSettingsDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_mt_settings_for_project

MTSettingsPerLanguageListDto get_mt_settings_for_project(project_uid)

Get project machine translate settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.mt_settings_per_language_list_dto import MTSettingsPerLanguageListDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # Get project machine translate settings
        api_response = api_instance.get_mt_settings_for_project(project_uid)
        print("The response of ProjectApi->get_mt_settings_for_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_mt_settings_for_project: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

MTSettingsPerLanguageListDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_pre_translate_settings_for_project2

PreTranslateSettingsV3Dto get_pre_translate_settings_for_project2(project_uid)

Get Pre-translate settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.pre_translate_settings_v3_dto import PreTranslateSettingsV3Dto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # Get Pre-translate settings
        api_response = api_instance.get_pre_translate_settings_for_project2(project_uid)
        print("The response of ProjectApi->get_pre_translate_settings_for_project2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_pre_translate_settings_for_project2: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

PreTranslateSettingsV3Dto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_project

AbstractProjectDto get_project(project_uid)

Get project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.abstract_project_dto import AbstractProjectDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # Get project
        api_response = api_instance.get_project(project_uid)
        print("The response of ProjectApi->get_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

AbstractProjectDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_project_access_settings_v2

ProjectSecuritySettingsDtoV2 get_project_access_settings_v2(project_uid)

Get access and security settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.project_security_settings_dto_v2 import ProjectSecuritySettingsDtoV2
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # Get access and security settings
        api_response = api_instance.get_project_access_settings_v2(project_uid)
        print("The response of ProjectApi->get_project_access_settings_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project_access_settings_v2: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

ProjectSecuritySettingsDtoV2

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_project_assignments

PageDtoProviderReference get_project_assignments(project_uid, provider_name=provider_name, page_number=page_number, page_size=page_size)

List project providers

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_provider_reference import PageDtoProviderReference
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    provider_name = 'provider_name_example' # str |  (optional)
    page_number = 0 # int | Page number, starting with 0, default 0 (optional) (default to 0)
    page_size = 50 # int | Page size, accepts values between 1 and 50, default 50 (optional) (default to 50)

    try:
        # List project providers
        api_response = api_instance.get_project_assignments(project_uid, provider_name=provider_name, page_number=page_number, page_size=page_size)
        print("The response of ProjectApi->get_project_assignments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project_assignments: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
provider_name str [optional]
page_number int Page number, starting with 0, default 0 [optional] [default to 0]
page_size int Page size, accepts values between 1 and 50, default 50 [optional] [default to 50]

Return type

PageDtoProviderReference

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_project_settings

LqaSettingsDto get_project_settings(project_uid, workflow_level=workflow_level)

Get LQA settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.lqa_settings_dto import LqaSettingsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    workflow_level = 1 # int |  (optional) (default to 1)

    try:
        # Get LQA settings
        api_response = api_instance.get_project_settings(project_uid, workflow_level=workflow_level)
        print("The response of ProjectApi->get_project_settings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project_settings: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
workflow_level int [optional] [default to 1]

Return type

LqaSettingsDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_project_term_bases

ProjectTermBaseListDto get_project_term_bases(project_uid)

Get term bases

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.project_term_base_list_dto import ProjectTermBaseListDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # Get term bases
        api_response = api_instance.get_project_term_bases(project_uid)
        print("The response of ProjectApi->get_project_term_bases:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project_term_bases: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

ProjectTermBaseListDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_project_trans_memories1

ProjectTransMemoryListDtoV3 get_project_trans_memories1(project_uid, target_lang=target_lang, wf_step_uid=wf_step_uid)

Get translation memories

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.project_trans_memory_list_dto_v3 import ProjectTransMemoryListDtoV3
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    target_lang = 'target_lang_example' # str | Filter project translation memories by target language (optional)
    wf_step_uid = 'wf_step_uid_example' # str | Filter project translation memories by workflow step (optional)

    try:
        # Get translation memories
        api_response = api_instance.get_project_trans_memories1(project_uid, target_lang=target_lang, wf_step_uid=wf_step_uid)
        print("The response of ProjectApi->get_project_trans_memories1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project_trans_memories1: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
target_lang str Filter project translation memories by target language [optional]
wf_step_uid str Filter project translation memories by workflow step [optional]

Return type

ProjectTransMemoryListDtoV3

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_project_workflow_steps_v2

ProjectWorkflowStepListDtoV2 get_project_workflow_steps_v2(project_uid, with_assigned_jobs=with_assigned_jobs)

Get workflow steps

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.project_workflow_step_list_dto_v2 import ProjectWorkflowStepListDtoV2
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    with_assigned_jobs = False # bool | Return only steps containing jobs assigned to the calling linguist. (optional) (default to False)

    try:
        # Get workflow steps
        api_response = api_instance.get_project_workflow_steps_v2(project_uid, with_assigned_jobs=with_assigned_jobs)
        print("The response of ProjectApi->get_project_workflow_steps_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_project_workflow_steps_v2: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
with_assigned_jobs bool Return only steps containing jobs assigned to the calling linguist. [optional] [default to False]

Return type

ProjectWorkflowStepListDtoV2

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_quotes_for_project

PageDtoQuoteDto get_quotes_for_project(project_uid, page_number=page_number, page_size=page_size)

List quotes

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_quote_dto import PageDtoQuoteDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    page_number = 0 # int |  (optional) (default to 0)
    page_size = 50 # int | Page size, accepts values between 1 and 50, default 50 (optional) (default to 50)

    try:
        # List quotes
        api_response = api_instance.get_quotes_for_project(project_uid, page_number=page_number, page_size=page_size)
        print("The response of ProjectApi->get_quotes_for_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->get_quotes_for_project: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
page_number int [optional] [default to 0]
page_size int Page size, accepts values between 1 and 50, default 50 [optional] [default to 50]

Return type

PageDtoQuoteDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_assigned_projects

PageDtoProjectReference list_assigned_projects(user_uid, status=status, target_lang=target_lang, workflow_step_id=workflow_step_id, due_in_hours=due_in_hours, filename=filename, project_name=project_name, page_number=page_number, page_size=page_size)

List assigned projects

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_project_reference import PageDtoProjectReference
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    user_uid = 'user_uid_example' # str | 
    status = ['status_example'] # List[str] |  (optional)
    target_lang = ['target_lang_example'] # List[str] |  (optional)
    workflow_step_id = 56 # int |  (optional)
    due_in_hours = 56 # int | -1 for jobs that are overdue (optional)
    filename = 'filename_example' # str |  (optional)
    project_name = 'project_name_example' # str |  (optional)
    page_number = 0 # int |  (optional) (default to 0)
    page_size = 50 # int |  (optional) (default to 50)

    try:
        # List assigned projects
        api_response = api_instance.list_assigned_projects(user_uid, status=status, target_lang=target_lang, workflow_step_id=workflow_step_id, due_in_hours=due_in_hours, filename=filename, project_name=project_name, page_number=page_number, page_size=page_size)
        print("The response of ProjectApi->list_assigned_projects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->list_assigned_projects: %s\n" % e)

Parameters

Name Type Description Notes
user_uid str
status List[str] [optional]
target_lang List[str] [optional]
workflow_step_id int [optional]
due_in_hours int -1 for jobs that are overdue [optional]
filename str [optional]
project_name str [optional]
page_number int [optional] [default to 0]
page_size int [optional] [default to 50]

Return type

PageDtoProjectReference

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_by_project_v3

PageDtoAnalyseReference list_by_project_v3(project_uid, name=name, uid=uid, page_number=page_number, page_size=page_size, sort=sort, order=order, only_owner_org=only_owner_org)

List analyses by project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_analyse_reference import PageDtoAnalyseReference
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    name = 'name_example' # str | Name to search by (optional)
    uid = 'uid_example' # str | Uid to search by (optional)
    page_number = 0 # int |  (optional) (default to 0)
    page_size = 50 # int | Page size, accepts values between 1 and 50, default 50 (optional) (default to 50)
    sort = 'DATE_CREATED' # str | Sorting field (optional) (default to 'DATE_CREATED')
    order = 'desc' # str | Sorting order (optional) (default to 'desc')
    only_owner_org = True # bool |  (optional)

    try:
        # List analyses by project
        api_response = api_instance.list_by_project_v3(project_uid, name=name, uid=uid, page_number=page_number, page_size=page_size, sort=sort, order=order, only_owner_org=only_owner_org)
        print("The response of ProjectApi->list_by_project_v3:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->list_by_project_v3: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
name str Name to search by [optional]
uid str Uid to search by [optional]
page_number int [optional] [default to 0]
page_size int Page size, accepts values between 1 and 50, default 50 [optional] [default to 50]
sort str Sorting field [optional] [default to 'DATE_CREATED']
order str Sorting order [optional] [default to 'desc']
only_owner_org bool [optional]

Return type

PageDtoAnalyseReference

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_projects

PageDtoAbstractProjectDto list_projects(name=name, client_id=client_id, client_name=client_name, business_unit_id=business_unit_id, business_unit_name=business_unit_name, statuses=statuses, target_langs=target_langs, domain_id=domain_id, domain_name=domain_name, sub_domain_id=sub_domain_id, sub_domain_name=sub_domain_name, cost_center_id=cost_center_id, cost_center_name=cost_center_name, due_in_hours=due_in_hours, created_in_last_hours=created_in_last_hours, source_langs=source_langs, owner_id=owner_id, job_statuses=job_statuses, job_status_group=job_status_group, buyer_id=buyer_id, page_number=page_number, page_size=page_size, name_or_internal_id=name_or_internal_id, include_archived=include_archived, archived_only=archived_only)

List projects

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_abstract_project_dto import PageDtoAbstractProjectDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    name = 'name_example' # str |  (optional)
    client_id = 56 # int |  (optional)
    client_name = 'client_name_example' # str |  (optional)
    business_unit_id = 56 # int |  (optional)
    business_unit_name = 'business_unit_name_example' # str |  (optional)
    statuses = ['statuses_example'] # List[str] |  (optional)
    target_langs = ['target_langs_example'] # List[str] |  (optional)
    domain_id = 56 # int |  (optional)
    domain_name = 'domain_name_example' # str |  (optional)
    sub_domain_id = 56 # int |  (optional)
    sub_domain_name = 'sub_domain_name_example' # str |  (optional)
    cost_center_id = 56 # int |  (optional)
    cost_center_name = 'cost_center_name_example' # str |  (optional)
    due_in_hours = 56 # int | -1 for projects that are overdue (optional)
    created_in_last_hours = 56 # int |  (optional)
    source_langs = ['source_langs_example'] # List[str] |  (optional)
    owner_id = 56 # int |  (optional)
    job_statuses = ['job_statuses_example'] # List[str] | Allowed for linguists only (optional)
    job_status_group = 'job_status_group_example' # str | Allowed for linguists only (optional)
    buyer_id = 56 # int |  (optional)
    page_number = 0 # int | Page number, starting with 0, default 0 (optional) (default to 0)
    page_size = 50 # int | Page size, accepts values between 1 and 50, default 50 (optional) (default to 50)
    name_or_internal_id = 'name_or_internal_id_example' # str | Name or internal ID of project (optional)
    include_archived = False # bool | List also archived projects (optional) (default to False)
    archived_only = False # bool | List only archived projects, regardless of `includeArchived` (optional) (default to False)

    try:
        # List projects
        api_response = api_instance.list_projects(name=name, client_id=client_id, client_name=client_name, business_unit_id=business_unit_id, business_unit_name=business_unit_name, statuses=statuses, target_langs=target_langs, domain_id=domain_id, domain_name=domain_name, sub_domain_id=sub_domain_id, sub_domain_name=sub_domain_name, cost_center_id=cost_center_id, cost_center_name=cost_center_name, due_in_hours=due_in_hours, created_in_last_hours=created_in_last_hours, source_langs=source_langs, owner_id=owner_id, job_statuses=job_statuses, job_status_group=job_status_group, buyer_id=buyer_id, page_number=page_number, page_size=page_size, name_or_internal_id=name_or_internal_id, include_archived=include_archived, archived_only=archived_only)
        print("The response of ProjectApi->list_projects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->list_projects: %s\n" % e)

Parameters

Name Type Description Notes
name str [optional]
client_id int [optional]
client_name str [optional]
business_unit_id int [optional]
business_unit_name str [optional]
statuses List[str] [optional]
target_langs List[str] [optional]
domain_id int [optional]
domain_name str [optional]
sub_domain_id int [optional]
sub_domain_name str [optional]
cost_center_id int [optional]
cost_center_name str [optional]
due_in_hours int -1 for projects that are overdue [optional]
created_in_last_hours int [optional]
source_langs List[str] [optional]
owner_id int [optional]
job_statuses List[str] Allowed for linguists only [optional]
job_status_group str Allowed for linguists only [optional]
buyer_id int [optional]
page_number int Page number, starting with 0, default 0 [optional] [default to 0]
page_size int Page size, accepts values between 1 and 50, default 50 [optional] [default to 50]
name_or_internal_id str Name or internal ID of project [optional]
include_archived bool List also archived projects [optional] [default to False]
archived_only bool List only archived projects, regardless of `includeArchived` [optional] [default to False]

Return type

PageDtoAbstractProjectDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_providers3

ProviderListDtoV2 list_providers3(project_uid)

Get suggested providers

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.provider_list_dto_v2 import ProviderListDtoV2
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 

    try:
        # Get suggested providers
        api_response = api_instance.list_providers3(project_uid)
        print("The response of ProjectApi->list_providers3:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->list_providers3: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str

Return type

ProviderListDtoV2

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_project

AbstractProjectDto patch_project(project_uid, body=body)

Edit project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.abstract_project_dto import AbstractProjectDto
from phrasetms_client.models.patch_project_dto import PatchProjectDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.PatchProjectDto() # PatchProjectDto |  (optional)

    try:
        # Edit project
        api_response = api_instance.patch_project(project_uid, body=body)
        print("The response of ProjectApi->patch_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->patch_project: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body PatchProjectDto [optional]

Return type

AbstractProjectDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

relevant_term_bases

PageDtoTermBaseDto relevant_term_bases(project_uid, name=name, domain_name=domain_name, client_name=client_name, sub_domain_name=sub_domain_name, target_langs=target_langs, strict_lang_matching=strict_lang_matching, page_number=page_number, page_size=page_size)

List project relevant term bases

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_term_base_dto import PageDtoTermBaseDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    name = 'name_example' # str |  (optional)
    domain_name = 'domain_name_example' # str |  (optional)
    client_name = 'client_name_example' # str |  (optional)
    sub_domain_name = 'sub_domain_name_example' # str |  (optional)
    target_langs = ['target_langs_example'] # List[str] |  (optional)
    strict_lang_matching = False # bool |  (optional) (default to False)
    page_number = 0 # int | Page number, starting with 0, default 0 (optional) (default to 0)
    page_size = 50 # int | Page size, accepts values between 1 and 50, default 50 (optional) (default to 50)

    try:
        # List project relevant term bases
        api_response = api_instance.relevant_term_bases(project_uid, name=name, domain_name=domain_name, client_name=client_name, sub_domain_name=sub_domain_name, target_langs=target_langs, strict_lang_matching=strict_lang_matching, page_number=page_number, page_size=page_size)
        print("The response of ProjectApi->relevant_term_bases:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->relevant_term_bases: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
name str [optional]
domain_name str [optional]
client_name str [optional]
sub_domain_name str [optional]
target_langs List[str] [optional]
strict_lang_matching bool [optional] [default to False]
page_number int Page number, starting with 0, default 0 [optional] [default to 0]
page_size int Page size, accepts values between 1 and 50, default 50 [optional] [default to 50]

Return type

PageDtoTermBaseDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

relevant_trans_memories1

PageDtoTransMemoryDto relevant_trans_memories1(project_uid, name=name, domain_name=domain_name, client_name=client_name, sub_domain_name=sub_domain_name, target_langs=target_langs, strict_lang_matching=strict_lang_matching, page_number=page_number, page_size=page_size)

List project relevant translation memories

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_trans_memory_dto import PageDtoTransMemoryDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    name = 'name_example' # str |  (optional)
    domain_name = 'domain_name_example' # str |  (optional)
    client_name = 'client_name_example' # str |  (optional)
    sub_domain_name = 'sub_domain_name_example' # str |  (optional)
    target_langs = ['target_langs_example'] # List[str] |  (optional)
    strict_lang_matching = False # bool |  (optional) (default to False)
    page_number = 0 # int | Page number, starting with 0, default 0 (optional) (default to 0)
    page_size = 50 # int | Page size, accepts values between 1 and 50, default 50 (optional) (default to 50)

    try:
        # List project relevant translation memories
        api_response = api_instance.relevant_trans_memories1(project_uid, name=name, domain_name=domain_name, client_name=client_name, sub_domain_name=sub_domain_name, target_langs=target_langs, strict_lang_matching=strict_lang_matching, page_number=page_number, page_size=page_size)
        print("The response of ProjectApi->relevant_trans_memories1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->relevant_trans_memories1: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
name str [optional]
domain_name str [optional]
client_name str [optional]
sub_domain_name str [optional]
target_langs List[str] [optional]
strict_lang_matching bool [optional] [default to False]
page_number int Page number, starting with 0, default 0 [optional] [default to 0]
page_size int Page size, accepts values between 1 and 50, default 50 [optional] [default to 50]

Return type

PageDtoTransMemoryDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_segment1

SearchResponseListTmDto search_segment1(project_uid, body=body)

Search translation memory for segment in the project

Returns at most maxSegments records with score >= scoreThreshold and at most maxSubsegments records which are subsegment, i.e. the source text is substring of the query text.

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.search_response_list_tm_dto import SearchResponseListTmDto
from phrasetms_client.models.search_tm_request_dto import SearchTMRequestDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.SearchTMRequestDto() # SearchTMRequestDto |  (optional)

    try:
        # Search translation memory for segment in the project
        api_response = api_instance.search_segment1(project_uid, body=body)
        print("The response of ProjectApi->search_segment1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->search_segment1: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body SearchTMRequestDto [optional]

Return type

SearchResponseListTmDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_financial_settings

FinancialSettingsDto set_financial_settings(project_uid, body=body)

Edit financial settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.financial_settings_dto import FinancialSettingsDto
from phrasetms_client.models.set_financial_settings_dto import SetFinancialSettingsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.SetFinancialSettingsDto() # SetFinancialSettingsDto |  (optional)

    try:
        # Edit financial settings
        api_response = api_instance.set_financial_settings(project_uid, body=body)
        print("The response of ProjectApi->set_financial_settings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->set_financial_settings: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body SetFinancialSettingsDto [optional]

Return type

FinancialSettingsDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_mt_settings_for_project

MTSettingsPerLanguageListDto set_mt_settings_for_project(project_uid, body=body)

Edit machine translate settings

This will erase all mtSettings per language for project. To remove all machine translate settings from project call without a machineTranslateSettings parameter.

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.edit_project_mt_settings_dto import EditProjectMTSettingsDto
from phrasetms_client.models.mt_settings_per_language_list_dto import MTSettingsPerLanguageListDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.EditProjectMTSettingsDto() # EditProjectMTSettingsDto |  (optional)

    try:
        # Edit machine translate settings
        api_response = api_instance.set_mt_settings_for_project(project_uid, body=body)
        print("The response of ProjectApi->set_mt_settings_for_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->set_mt_settings_for_project: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body EditProjectMTSettingsDto [optional]

Return type

MTSettingsPerLanguageListDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_mt_settings_per_language_for_project

MTSettingsPerLanguageListDto set_mt_settings_per_language_for_project(project_uid, body=body)

Edit machine translate settings per language

This will erase mtSettings for project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.edit_project_mt_sett_per_lang_list_dto import EditProjectMTSettPerLangListDto
from phrasetms_client.models.mt_settings_per_language_list_dto import MTSettingsPerLanguageListDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.EditProjectMTSettPerLangListDto() # EditProjectMTSettPerLangListDto |  (optional)

    try:
        # Edit machine translate settings per language
        api_response = api_instance.set_mt_settings_per_language_for_project(project_uid, body=body)
        print("The response of ProjectApi->set_mt_settings_per_language_for_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->set_mt_settings_per_language_for_project: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body EditProjectMTSettPerLangListDto [optional]

Return type

MTSettingsPerLanguageListDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_project_qa_settings_v2

QASettingsDtoV2 set_project_qa_settings_v2(project_uid, body=body)

Edit quality assurance settings

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.edit_qa_settings_dto_v2 import EditQASettingsDtoV2
from phrasetms_client.models.qa_settings_dto_v2 import QASettingsDtoV2
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.EditQASettingsDtoV2() # EditQASettingsDtoV2 |  (optional)

    try:
        # Edit quality assurance settings
        api_response = api_instance.set_project_qa_settings_v2(project_uid, body=body)
        print("The response of ProjectApi->set_project_qa_settings_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->set_project_qa_settings_v2: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body EditQASettingsDtoV2 [optional]

Return type

QASettingsDtoV2

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_project_status

set_project_status(project_uid, body=body)

Edit project status

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.set_project_status_dto import SetProjectStatusDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.SetProjectStatusDto() # SetProjectStatusDto |  (optional)

    try:
        # Edit project status
        api_instance.set_project_status(project_uid, body=body)
    except Exception as e:
        print("Exception when calling ProjectApi->set_project_status: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body SetProjectStatusDto [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_project_term_bases

ProjectTermBaseListDto set_project_term_bases(project_uid, body=body)

Edit term bases

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.project_term_base_list_dto import ProjectTermBaseListDto
from phrasetms_client.models.set_term_base_dto import SetTermBaseDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.SetTermBaseDto() # SetTermBaseDto |  (optional)

    try:
        # Edit term bases
        api_response = api_instance.set_project_term_bases(project_uid, body=body)
        print("The response of ProjectApi->set_project_term_bases:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->set_project_term_bases: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body SetTermBaseDto [optional]

Return type

ProjectTermBaseListDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_project_trans_memories_v3

ProjectTransMemoryListDtoV3 set_project_trans_memories_v3(project_uid, body=body)

Edit translation memories

If user wants to edit “All target languages” or "All workflow steps”, but there are already varied TM settings for individual languages or steps, then the user risks to overwrite these individual choices.

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.project_trans_memory_list_dto_v3 import ProjectTransMemoryListDtoV3
from phrasetms_client.models.set_project_trans_memories_v3_dto import SetProjectTransMemoriesV3Dto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.SetProjectTransMemoriesV3Dto() # SetProjectTransMemoriesV3Dto |  (optional)

    try:
        # Edit translation memories
        api_response = api_instance.set_project_trans_memories_v3(project_uid, body=body)
        print("The response of ProjectApi->set_project_trans_memories_v3:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->set_project_trans_memories_v3: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body SetProjectTransMemoriesV3Dto [optional]

Return type

ProjectTransMemoryListDtoV3

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_file_naming_settings

FileNamingSettingsDto update_file_naming_settings(project_uid, body=body)

Update file naming settings for project

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.file_naming_settings_dto import FileNamingSettingsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ProjectApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.FileNamingSettingsDto() # FileNamingSettingsDto |  (optional)

    try:
        # Update file naming settings for project
        api_response = api_instance.update_file_naming_settings(project_uid, body=body)
        print("The response of ProjectApi->update_file_naming_settings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectApi->update_file_naming_settings: %s\n" % e)

Parameters

Name Type Description Notes
project_uid str
body FileNamingSettingsDto [optional]

Return type

FileNamingSettingsDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request -
401 Not authorized -
403 Forbidden -
404 Resource not found -
405 Method not allowed -
408 Timeout -
410 Gone -
415 Unsupported media type -
429 Too many requests -
500 Internal server error -
501 Not implemented -

[Back to top] [Back to API list] [Back to Model list] [Back to README]