public interface CloudwordsVendorAPI extends BaseCloudwordsAPI
This API is designed for translation vendors on the Cloudwords marketplace that are looking to:
Modifier and Type | Method and Description |
---|---|
VendorBid |
acceptBid(int projectId)
|
ChangeOrder |
acceptChangeOrder(ChangeOrder changeOrder)
Updates the specified
ChangeOrder by accepting the ChangeOrder . |
VendorTranslationRequest |
acceptTranslationRequest(int projectId,
VendorTranslationRequest transRequest)
Updates the specified
VendorTranslationRequest by accepting the VendorTranslationRequest . |
InputStream |
downloadCustomerTMFile(int projectId)
Download the customer TM binary for the specified
Project as an
InputStream . |
VendorBid |
getBid(int projectId)
|
ChangeOrder |
getChangeOrder(int projectId,
int changeOrderId)
Gets the
ChangeOrder associated with the unique ChangeOrder ID. |
ChangeOrderBid |
getChangeOrderBid(int projectId,
int changeOrderId)
Gets the specified
ChangeOrderBid for the specified Cloudwords ChangeOrder . |
List<ChangeOrder> |
getChangeOrders(int projectId)
Gets all
ChangeOrder s for a project. |
VendorTranslationRequest |
getCurrentTranslationRequestForProject(int projectId)
Get the current
VendorTranslationRequest for the specified Project . |
CloudwordsFile |
getProjectCustomerTM(int projectId)
Get the
Project 's customer TM data CloudwordsFile resource for the specified
Cloudwords . |
List<Task> |
getProjectTask(int projectId)
Get all
Task s for a project. |
List<Task> |
getProjectTaskByStatus(int projectId,
CodeAndDisplay taskStatus)
Get all
Task s for a project by status. |
Task |
getTask(int projectId,
int taskId)
|
List<Task> |
getTaskByStatus(CodeAndDisplay taskStatus)
Get all
Task s by status. |
List<Task> |
getTasks()
Get all
Task s available to the user. |
void |
rejectBid(int projectId)
|
ChangeOrder |
rejectChangeOrder(ChangeOrder changeOrder)
Updates the specified
ChangeOrder by rejecting the ChangeOrder . |
VendorTranslationRequest |
rejectTranslationRequest(int projectId,
VendorTranslationRequest transRequest)
Updates the specified
VendorTranslationRequest by rejecting the VendorTranslationRequest . |
VendorBid |
submitBid(int projectId,
VendorBid bid)
|
ChangeOrder |
submitChangeOrder(ChangeOrder changeOrder)
Updates the specified
ChangeOrder by submitting the ChangeOrder . |
VendorTranslationRequest |
submitTranslationRequest(int projectId,
VendorTranslationRequest transRequest)
Submit a
VendorTranslationRequest for the specified Cloudwords Project . |
ChangeOrderBid |
updateChangeOrderBid(int projectId,
int changeOrderId,
ChangeOrderBid changeOrderBid)
Updates the specified
ChangeOrderBid for the ChangeOrder before submitting. |
Task |
updateTask(Task task)
|
CloudwordsLanguageFile |
uploadProjectTranslatedFile(int projectId,
Language language,
File zipFile)
|
CloudwordsFile |
uploadProjectTranslationMemory(int projectId,
File zipFile)
Upload the translated memory for a given Cloudwords
Project . |
addTranslatedDocument, approveTranslatedFile, createWebhook, createWebhook, createWebhook, deleteWebhook, downloadChangeOrderFile, downloadFileFromMetadata, downloadMasterTranslatedFile, downloadProjectTranslationMemory, downloadReferenceFile, downloadSourceDocumentFile, downloadSourceDocumentXLIFF, downloadSourceFile, downloadTaskAttachment, downloadTranslatedDocumentFile, downloadTranslatedDocumentXLIFF, downloadTranslatedFile, getChangeOrderAttachment, getChangeOrderProjectWorkflow, getChangeOrderProjectWorkflows, getClosedProjects, getMasterProjectTranslatedFile, getOpenProjects, getProject, getProjectReference, getProjectReferences, getProjects, getProjectSource, getProjectTranslatedFile, getProjectTranslatedFiles, getProjectTranslationMemory, getProjectWorkflow, getProjectWorkflows, getSourceDocument, getSourceDocuments, getTaskAttachment, getTranslatedDocument, getTranslatedDocuments, getWebhook, getWebhooks, replaceTranslatedDocument, updateProject, updateTranslatedDocument, updateTranslatedDocuments
CloudwordsFile getProjectCustomerTM(int projectId) throws CloudwordsClientException
Project
's customer TM data CloudwordsFile
resource for the specified
Cloudwords . The metadata will contain a contentPath for downloading the actual binary file.projectId
- ID of the Project
to returnTM data forProject
source CloudwordsFile
resourceCloudwordsClientException
InputStream downloadCustomerTMFile(int projectId) throws CloudwordsClientException
Project
as an
InputStream
.
NOTE: clients utilizing this method must handle the closing of InputStream
after use.
projectId
- ID of Project
to download TM forInputStream
if source file exists, null otherwiseCloudwordsClientException
CloudwordsLanguageFile uploadProjectTranslatedFile(int projectId, Language language, File zipFile) throws CloudwordsClientException
Project
Language
deliverable. The provided
file must be a zip file.
Please note that this Project
must already exists in Cloudwords, and the
Project
must be in a state where translated file can be uploaded for the specified Language
.
Please refer to the API documentation for more information.
projectId
- ID of the Project
to upload reference materials forzipFile
- A single zip file to be uploaded for this Project
language
- The Project
Language
deliverable to upload this file forCloudwordsFile
resourceCloudwordsClientException
CloudwordsFile uploadProjectTranslationMemory(int projectId, File zipFile) throws CloudwordsClientException
Project
. The provided
file must be a zip file and it must contain a valid TMX file for the given Project
.
Please note that this Project
must already exists in Cloudwords, and the
Project
must be in a state where translated memory can be uploaded.
Please refer to the API documentation for more information.
projectId
- ID of the Project
to upload reference materials forzipFile
- A single zip file to be uploaded for this Project
CloudwordsFile
resourceCloudwordsClientException
Task getTask(int projectId, int taskId) throws CloudwordsClientException
projectId
- ID of the Project
to get Task
fortaskId
- ID of the Task
to returnTask
resourceCloudwordsClientException
List<Task> getTasks() throws CloudwordsClientException
Task
s available to the user.Task
sCloudwordsClientException
List<Task> getTaskByStatus(CodeAndDisplay taskStatus) throws CloudwordsClientException
Task
s by status.taskStatus
- The Task
status to filter byTask
sCloudwordsClientException
List<Task> getProjectTask(int projectId) throws CloudwordsClientException
Task
s for a project.projectId
- ID of the Project
to get Task
s forTask
sCloudwordsClientException
List<Task> getProjectTaskByStatus(int projectId, CodeAndDisplay taskStatus) throws CloudwordsClientException
Task
s for a project by status.projectId
- ID of the Project
to get Task
s fortaskStatus
- The Task
status to filter byTask
sCloudwordsClientException
Task updateTask(Task task) throws CloudwordsClientException
task
- Task
to updateTask
CloudwordsClientException
VendorBid getBid(int projectId) throws CloudwordsClientException
Vendor
provided VendorBid
for the specified Cloudwords Project
.CloudwordsClientException
VendorBid acceptBid(int projectId) throws CloudwordsClientException
projectId
- ID of the Project
to accept the bid forVendorBid
CloudwordsClientException
void rejectBid(int projectId) throws CloudwordsClientException
projectId
- ID of the Project
to reject the bid forCloudwordsClientException
VendorBid submitBid(int projectId, VendorBid bid) throws CloudwordsClientException
projectId
- ID of the Project
to submit the bid forbid
- The bid to submitVendorBid
CloudwordsClientException
ChangeOrder getChangeOrder(int projectId, int changeOrderId) throws CloudwordsClientException
ChangeOrder
associated with the unique ChangeOrder
ID. Please refer
to the API documentation for more information.projectId
- ID of the Project
of the associated ChangeOrder
changeOrderId
- ID of the ChangeOrder
to returnChangeOrder
resourceCloudwordsClientException
List<ChangeOrder> getChangeOrders(int projectId) throws CloudwordsClientException
ChangeOrder
s for a project. Please refer to the API documentation for more information.projectId
- ID of the Project
to get ChangeOrder
s forChangeOrder
sCloudwordsClientException
ChangeOrder acceptChangeOrder(ChangeOrder changeOrder) throws CloudwordsClientException
ChangeOrder
by accepting the ChangeOrder
. Accepting the ChangeOrder
doesn't submit any ChangeOrderBid
to the customer. Please refer to the API documentation for more
information.changeOrder
- ChangeOrder
to updateChangeOrder
updated resourceCloudwordsClientException
ChangeOrder rejectChangeOrder(ChangeOrder changeOrder) throws CloudwordsClientException
ChangeOrder
by rejecting the ChangeOrder
. Once you reject a
ChangeOrder
, you can no longer view/submit any existing/new ChangeOrderBid
to the customer.
Please refer to the API documentation for more information.changeOrder
- ChangeOrder
to updateChangeOrder
updated resourceCloudwordsClientException
ChangeOrder submitChangeOrder(ChangeOrder changeOrder) throws CloudwordsClientException
ChangeOrder
by submitting the ChangeOrder
. This action shall cause the
ChangeOrderBid
associated with the ChangeOrder
to be submitted to the customer. Please refer to
the API documentation for more information.changeOrder
- ChangeOrder
to updateChangeOrder
updated resourceCloudwordsClientException
ChangeOrderBid getChangeOrderBid(int projectId, int changeOrderId) throws CloudwordsClientException
ChangeOrderBid
for the specified Cloudwords ChangeOrder
. Please refer to the
API documentation for more information.projectId
- ID of the Project
of the associated ChangeOrder
changeOrderId
- ID of ChangeOrder
to get the bid forChangeOrderBid
for the specified Cloudwords ChangeOrder
.CloudwordsClientException
ChangeOrderBid updateChangeOrderBid(int projectId, int changeOrderId, ChangeOrderBid changeOrderBid) throws CloudwordsClientException
ChangeOrderBid
for the ChangeOrder
before submitting. The bid won't be
submitted until you submit the ChangeOrder
. You can update the update the ChangeOrderBid
as many
times as you want before doing the final ChangeOrder
. Please refer to the API documentation for more
information.projectId
- ID of the Project
of the associated ChangeOrder
changeOrderId
- ID of ChangeOrder
of the associated ChangeOrderBid
changeOrderBid
- ChangeOrderBid
to to be updatedChangeOrderBid
for the specified Cloudwords ChangeOrder
.CloudwordsClientException
VendorTranslationRequest getCurrentTranslationRequestForProject(int projectId) throws CloudwordsClientException
VendorTranslationRequest
for the specified Project
.projectId
- ID of the Project
to get the VendorTranslationRequest
forVendorTranslationRequest
resource for the Project
if requests have already been
requested for this Project
CloudwordsClientException
VendorTranslationRequest acceptTranslationRequest(int projectId, VendorTranslationRequest transRequest) throws CloudwordsClientException
VendorTranslationRequest
by accepting the VendorTranslationRequest
.
Please refer to the API documentation for more information.projectId
- ID of the Project
to request translation fortransRequest
- A VendorTranslationRequest
s to acceptCloudwordsClientException
VendorTranslationRequest rejectTranslationRequest(int projectId, VendorTranslationRequest transRequest) throws CloudwordsClientException
VendorTranslationRequest
by rejecting the VendorTranslationRequest
.
Please refer to the API documentation for more information.projectId
- ID of the Project
to request translation fortransRequest
- A VendorTranslationRequest
s to rejectCloudwordsClientException
VendorTranslationRequest submitTranslationRequest(int projectId, VendorTranslationRequest transRequest) throws CloudwordsClientException
VendorTranslationRequest
for the specified Cloudwords Project
.projectId
- ID of the Project
to submit the bid fortransRequest
- A VendorTranslationRequest
s containing the bid to submitVendorTranslationRequest
CloudwordsClientException
Copyright © 2016. All rights reserved.