@Path(value="/async")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
public interface AsynchronousProcessResource
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_PATH |
Modifier and Type | Method and Description |
---|---|
ProcessStatus |
getProcessStatus(String processId)
Obtains the status of a previously started process.
|
ProcessStatus |
startSourceDocCreation(String idNoSlash,
String projectSlug,
String iterationSlug,
Resource resource,
Set<String> extensions,
boolean copytrans)
Deprecated.
|
ProcessStatus |
startSourceDocCreationOrUpdate(String idNoSlash,
String projectSlug,
String iterationSlug,
Resource resource,
Set<String> extensions,
boolean copytrans)
Deprecated.
|
ProcessStatus |
startSourceDocCreationOrUpdateWithDocId(String projectSlug,
String iterationSlug,
Resource resource,
Set<String> extensions,
String docId)
Attempts to starts the creation or update of a source document.
|
ProcessStatus |
startTranslatedDocCreationOrUpdate(String idNoSlash,
String projectSlug,
String iterationSlug,
LocaleId locale,
TranslationsResource translatedDoc,
Set<String> extensions,
String merge,
boolean assignCreditToUploader)
Deprecated.
|
ProcessStatus |
startTranslatedDocCreationOrUpdateWithDocId(String projectSlug,
String iterationSlug,
LocaleId locale,
TranslationsResource translatedDoc,
String docId,
Set<String> extensions,
String merge,
boolean assignCreditToUploader)
Attempts to start the translation of a document.
|
static final String SERVICE_PATH
@POST @Path(value="/projects/p/{projectSlug}/iterations/i/{iterationSlug}/r") @Deprecated ProcessStatus startSourceDocCreation(@PathParam(value="id") String idNoSlash, @PathParam(value="projectSlug") String projectSlug, @PathParam(value="iterationSlug") String iterationSlug, Resource resource, @QueryParam(value="ext") Set<String> extensions, @QueryParam(value="copyTrans") @DefaultValue(value="true") boolean copytrans)
idNoSlash
- The document identifier. Some document ids could have forward
slashes ('/') in them which would cause conflicts with the
browser's own url interpreter. For this reason, the supplied
id must have all its '/' characters replaced with commas
(',').projectSlug
- Project identifier.iterationSlug
- Project Iteration identifier.resource
- The document information.extensions
- The document extensions to save with the document (e.g.
"gettext", "comment"). This parameter allows multiple values
e.g. "ext=gettext&ext=comment".copytrans
- Boolean value that indicates whether reasonably close
translations from other projects should be found to initially
populate this document's translations.@Deprecated @PUT @Path(value="/projects/p/{projectSlug}/iterations/i/{iterationSlug}/r/{id:[\\-_a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}") ProcessStatus startSourceDocCreationOrUpdate(@PathParam(value="id") String idNoSlash, @PathParam(value="projectSlug") String projectSlug, @PathParam(value="iterationSlug") String iterationSlug, Resource resource, @QueryParam(value="ext") Set<String> extensions, @QueryParam(value="copyTrans") @DefaultValue(value="true") boolean copytrans)
idNoSlash
- The document identifier. Some document ids could have forward
slashes ('/') in them which would cause conflicts with the
browser's own url interpreter. For this reason, the supplied
id must have all its '/' characters replaced with commas
(',').projectSlug
- Project identifier.iterationSlug
- Project Iteration identifier.resource
- The document information.extensions
- The document extensions to save with the document (e.g.
"gettext", "comment"). This parameter allows multiple values
e.g. "ext=gettext&ext=comment".copytrans
- Boolean value that indicates whether reasonably close
translations from other projects should be found to initially
populate this document's translations.
Deprecated. Use startSourceDocCreationOrUpdateWithDocId(java.lang.String, java.lang.String, org.zanata.rest.dto.resource.Resource, java.util.Set<java.lang.String>, java.lang.String)
@PUT @Path(value="/projects/p/{projectSlug}/iterations/i/{iterationSlug}/resource") ProcessStatus startSourceDocCreationOrUpdateWithDocId(@PathParam(value="projectSlug") String projectSlug, @PathParam(value="iterationSlug") String iterationSlug, Resource resource, @QueryParam(value="ext") Set<String> extensions, @QueryParam(value="docId") @DefaultValue(value="") String docId)
docId
- The document identifier.projectSlug
- Project identifier.iterationSlug
- Project Iteration identifier.resource
- The document information.extensions
- The document extensions to save with the document (e.g.
"gettext", "comment"). This parameter allows multiple values
e.g. "ext=gettext&ext=comment".@Deprecated @PUT @Path(value="/projects/p/{projectSlug}/iterations/i/{iterationSlug}/r/{id}/translations/{locale}") ProcessStatus startTranslatedDocCreationOrUpdate(@PathParam(value="id") String idNoSlash, @PathParam(value="projectSlug") String projectSlug, @PathParam(value="iterationSlug") String iterationSlug, @PathParam(value="locale") LocaleId locale, TranslationsResource translatedDoc, @QueryParam(value="ext") Set<String> extensions, @QueryParam(value="merge") String merge, @QueryParam(value="assignCreditToUploader") @DefaultValue(value="false") boolean assignCreditToUploader)
idNoSlash
- The document identifier. Some document ids could have forward
slashes ('/') in them which would cause conflicts with the
browser's own url interpreter. For this reason, the supplied
id must have all its '/' characters replaced with commas
(',').projectSlug
- Project identifier.iterationSlug
- Project Iteration identifier.locale
- The locale for which to get translations.translatedDoc
- The translations to modify.extensions
- The document extensions to save with the document (e.g.
"gettext", "comment"). This parameter allows multiple values
e.g. "ext=gettext&ext=comment".merge
- Indicates how to deal with existing translations (valid
options: 'auto', 'import'). Import will overwrite all current
values with the values being pushed (even empty ones), while
Auto will check the history of your translations and will not
overwrite any translations for which it detects a previous
value is being pushed.assignCreditToUploader
- The translator field for all uploaded translations will
be set to the user who performs the upload.
Deprecated. Use startTranslatedDocCreationOrUpdateWithDocId(java.lang.String, java.lang.String, org.zanata.common.LocaleId, org.zanata.rest.dto.resource.TranslationsResource, java.lang.String, java.util.Set<java.lang.String>, java.lang.String, boolean)
@PUT @Path(value="/projects/p/{projectSlug}/iterations/i/{iterationSlug}/resource/translations/{locale}") ProcessStatus startTranslatedDocCreationOrUpdateWithDocId(@PathParam(value="projectSlug") String projectSlug, @PathParam(value="iterationSlug") String iterationSlug, @PathParam(value="locale") LocaleId locale, TranslationsResource translatedDoc, @QueryParam(value="docId") @DefaultValue(value="") String docId, @QueryParam(value="ext") Set<String> extensions, @QueryParam(value="merge") String merge, @QueryParam(value="assignCreditToUploader") @DefaultValue(value="false") boolean assignCreditToUploader)
docId
- The document identifier.projectSlug
- Project identifier.iterationSlug
- Project Iteration identifier.locale
- The locale for which to get translations.translatedDoc
- The translations to modify.extensions
- The document extensions to save with the document (e.g.
"gettext", "comment"). This parameter allows multiple values
e.g. "ext=gettext&ext=comment".merge
- Indicates how to deal with existing translations (valid
options: 'auto', 'import'). Import will overwrite all current
values with the values being pushed (even empty ones), while
Auto will check the history of your translations and will not
overwrite any translations for which it detects a previous
value is being pushed.assignCreditToUploader
- The translator field for all uploaded translations will
be set to the user who performs the upload.@GET @Path(value="/{processId}") ProcessStatus getProcessStatus(@PathParam(value="processId") String processId)
processId
- The process Id (as returned by one of the endpoints that
starts an async process).Copyright © 2017 Zanata Project. All rights reserved.