phrasetms_client.ProjectReferenceFileApi

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

Method	HTTP request	Description
batch_delete_reference_files	DELETE /api2/v1/projects/{projectUid}/references	Delete project reference files (batch)
batch_download_reference_files	POST /api2/v1/projects/{projectUid}/references/download	Download project reference files (batch)
create_note_ref	POST /api2/v1/projects/{projectUid}/references	Create project reference file
download_reference	GET /api2/v1/projects/{projectUid}/references/{referenceFileId}	Download project reference file
list_reference_file_creators	GET /api2/v1/projects/{projectUid}/references/creators	List project reference file creators
list_reference_files	GET /api2/v1/projects/{projectUid}/references	List project reference files

batch_delete_reference_files

batch_delete_reference_files(project_uid, body=body)

Delete project reference files (batch)

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.project_reference_files_request_dto import ProjectReferenceFilesRequestDto
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.ProjectReferenceFileApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.ProjectReferenceFilesRequestDto() # ProjectReferenceFilesRequestDto |  (optional)

    try:
        # Delete project reference files (batch)
        api_instance.batch_delete_reference_files(project_uid, body=body)
    except Exception as e:
        print("Exception when calling ProjectReferenceFileApi->batch_delete_reference_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_uid	str
body	ProjectReferenceFilesRequestDto		[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]

batch_download_reference_files

batch_download_reference_files(project_uid, body=body)

Download project reference files (batch)

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.project_reference_files_request_dto import ProjectReferenceFilesRequestDto
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.ProjectReferenceFileApi(api_client)
    project_uid = 'project_uid_example' # str | 
    body = phrasetms_client.ProjectReferenceFilesRequestDto() # ProjectReferenceFilesRequestDto |  (optional)

    try:
        # Download project reference files (batch)
        api_instance.batch_download_reference_files(project_uid, body=body)
    except Exception as e:
        print("Exception when calling ProjectReferenceFileApi->batch_download_reference_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_uid	str
body	ProjectReferenceFilesRequestDto		[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
200	application/octet-stream	-
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_note_ref

ReferenceFileReference create_note_ref(project_uid, content_disposition=content_disposition, x_memsource_note=x_memsource_note, body=body)

Create project reference file

Accepts application/octet-stream or application/json.
- application/json - note field will be converted to .txt.
- application/octet-stream - Content-Disposition header is required

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.create_reference_file_note_dto import CreateReferenceFileNoteDto
from phrasetms_client.models.reference_file_reference import ReferenceFileReference
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.ProjectReferenceFileApi(api_client)
    project_uid = 'project_uid_example' # str | 
    content_disposition = 'content_disposition_example' # str | Required for `application/octet-stream`.<br> Example: `filename*=UTF-8''YourFileName.txt` (optional)
    x_memsource_note = 'x_memsource_note_example' # str | For use with `application/octet-stream` (optional)
    body = phrasetms_client.CreateReferenceFileNoteDto() # CreateReferenceFileNoteDto |  (optional)

    try:
        # Create project reference file
        api_response = api_instance.create_note_ref(project_uid, content_disposition=content_disposition, x_memsource_note=x_memsource_note, body=body)
        print("The response of ProjectReferenceFileApi->create_note_ref:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectReferenceFileApi->create_note_ref: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_uid	str
content_disposition	str	Required for `application/octet-stream`.<br> Example: `filename*=UTF-8''YourFileName.txt`	[optional]
x_memsource_note	str	For use with `application/octet-stream`	[optional]
body	CreateReferenceFileNoteDto		[optional]

Return type

ReferenceFileReference

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/octet-stream
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]

download_reference

download_reference(project_uid, reference_file_id)

Download project reference file

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.ProjectReferenceFileApi(api_client)
    project_uid = 'project_uid_example' # str | 
    reference_file_id = 'reference_file_id_example' # str | 

    try:
        # Download project reference file
        api_instance.download_reference(project_uid, reference_file_id)
    except Exception as e:
        print("Exception when calling ProjectReferenceFileApi->download_reference: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_uid	str
reference_file_id	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
200	application/octet-stream	-
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_reference_file_creators

UserReferencesDto list_reference_file_creators(project_uid, user_name=user_name)

List project reference file creators

The result is not paged and returns up to 50 users. If the requested user is not included, the search can be narrowed down with the userName parameter.

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.user_references_dto import UserReferencesDto
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.ProjectReferenceFileApi(api_client)
    project_uid = 'project_uid_example' # str | 
    user_name = 'user_name_example' # str |  (optional)

    try:
        # List project reference file creators
        api_response = api_instance.list_reference_file_creators(project_uid, user_name=user_name)
        print("The response of ProjectReferenceFileApi->list_reference_file_creators:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectReferenceFileApi->list_reference_file_creators: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_uid	str
user_name	str		[optional]

Return type

UserReferencesDto

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_reference_files

ReferenceFilePageDto list_reference_files(project_uid, filename=filename, date_created_since=date_created_since, created_by=created_by, page_number=page_number, page_size=page_size, sort=sort, order=order)

List project reference files

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.reference_file_page_dto import ReferenceFilePageDto
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.ProjectReferenceFileApi(api_client)
    project_uid = 'project_uid_example' # str | 
    filename = 'filename_example' # str |  (optional)
    date_created_since = 'date_created_since_example' # str | date time in ISO 8601 UTC format (optional)
    created_by = 'created_by_example' # str | UID of user (optional)
    page_number = 0 # int |  (optional) (default to 0)
    page_size = 50 # int |  (optional) (default to 50)
    sort = 'DATE_CREATED' # str |  (optional) (default to 'DATE_CREATED')
    order = 'DESC' # str |  (optional) (default to 'DESC')

    try:
        # List project reference files
        api_response = api_instance.list_reference_files(project_uid, filename=filename, date_created_since=date_created_since, created_by=created_by, page_number=page_number, page_size=page_size, sort=sort, order=order)
        print("The response of ProjectReferenceFileApi->list_reference_files:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectReferenceFileApi->list_reference_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_uid	str
filename	str		[optional]
date_created_since	str	date time in ISO 8601 UTC format	[optional]
created_by	str	UID of user	[optional]
page_number	int		[optional] [default to 0]
page_size	int		[optional] [default to 50]
sort	str		[optional] [default to 'DATE_CREATED']
order	str		[optional] [default to 'DESC']

Return type

ReferenceFilePageDto

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]

Files

ProjectReferenceFileApi.md

Latest commit

History

ProjectReferenceFileApi.md

File metadata and controls

phrasetms_client.ProjectReferenceFileApi

batch_delete_reference_files

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

batch_download_reference_files

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_note_ref

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_reference

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_reference_file_creators

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_reference_files

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details