@Path(value="/project/{projectSlug:[a-zA-Z0-9]+([a-zA-Z0-9_\\-{.}]*[a-zA-Z0-9]+)?}/version")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
public interface ProjectVersionResource
ProjectIterationResource.| Modifier and Type | Field and Description |
|---|---|
static String |
PROJECT_SERVICE_PATH |
static String |
SERVICE_PATH |
static String |
VERSION_SLUG_TEMPLATE |
| Modifier and Type | Method and Description |
|---|---|
javax.ws.rs.core.Response |
getContributors(String projectSlug,
String versionSlug,
String dateRange)
Get list of contributor (translator/review) for the given
project version in date range.
|
javax.ws.rs.core.Response |
getDocuments(String projectSlug,
String versionSlug)
Retrieve the List of Documents (Resources) belongs to a Project version.
|
javax.ws.rs.core.Response |
getLocales(String projectSlug,
String versionSlug)
Retrieves a full list of locales enabled in project version.
|
javax.ws.rs.core.Response |
getTransUnitStatus(String projectSlug,
String versionSlug,
String docId,
String localeId,
FilterFields filterFields)
Queries for a list of translation unit id with status in a document.
|
javax.ws.rs.core.Response |
getVersion(String projectSlug,
String versionSlug)
Returns data for a single Project iteration.
|
javax.ws.rs.core.Response |
head(String projectSlug,
String versionSlug)
Returns header information for a project iteration.
|
javax.ws.rs.core.Response |
put(String projectSlug,
String versionSlug,
ProjectIteration projectVersion)
Creates or modifies a Project iteration.
|
javax.ws.rs.core.Response |
sampleConfiguration(String projectSlug,
String versionSlug)
Get a project iteration's sample general configuration file(zanata.xml).
|
static final String PROJECT_SERVICE_PATH
static final String VERSION_SLUG_TEMPLATE
static final String SERVICE_PATH
@HEAD
@Produces(value={"application/vnd.zanata.project.iteration+xml","application/vnd.zanata.project.iteration+json","application/xml","application/json"})
@Path(value="/{versionSlug:[a-zA-Z0-9]+([a-zA-Z0-9_\\-{.}]*[a-zA-Z0-9]+)?}")
javax.ws.rs.core.Response head(@PathParam(value="projectSlug")
String projectSlug,
@PathParam(value="versionSlug")
String versionSlug)
projectSlug - Project identifierversionSlug - Project version identifier@PUT
@Consumes(value={"application/vnd.zanata.project.iteration+xml","application/vnd.zanata.project.iteration+json","application/xml","application/json"})
@Path(value="/{versionSlug:[a-zA-Z0-9]+([a-zA-Z0-9_\\-{.}]*[a-zA-Z0-9]+)?}")
javax.ws.rs.core.Response put(@PathParam(value="projectSlug")
String projectSlug,
@PathParam(value="versionSlug")
String versionSlug,
ProjectIteration projectVersion)
projectVersion - The project iteration information.@GET
@Path(value="/{versionSlug:[a-zA-Z0-9]+([a-zA-Z0-9_\\-{.}]*[a-zA-Z0-9]+)?}/config")
@Produces(value="application/xml")
javax.ws.rs.core.Response sampleConfiguration(@PathParam(value="projectSlug")
String projectSlug,
@PathParam(value="versionSlug")
String versionSlug)
projectSlug - Project identifierversionSlug - Project version identifier@GET
@Produces(value={"application/vnd.zanata.project.iteration+xml","application/vnd.zanata.project.iteration+json","application/xml","application/json"})
@Path(value="/{versionSlug:[a-zA-Z0-9]+([a-zA-Z0-9_\\-{.}]*[a-zA-Z0-9]+)?}")
javax.ws.rs.core.Response getVersion(@PathParam(value="projectSlug")
String projectSlug,
@PathParam(value="versionSlug")
String versionSlug)
projectSlug - Project identifierversionSlug - Project version identifier@GET
@Produces(value={"application/vnd.zanata.version+json","application/json"})
@Path(value="/{versionSlug:[a-zA-Z0-9]+([a-zA-Z0-9_\\-{.}]*[a-zA-Z0-9]+)?}/contributors/{dateRange}")
javax.ws.rs.core.Response getContributors(@PathParam(value="projectSlug")
String projectSlug,
@PathParam(value="versionSlug")
String versionSlug,
@PathParam(value="dateRange")
String dateRange)
projectSlug - project identifierversionSlug - version identifierdateRange - date range from..to (yyyy-mm-dd..yyyy-mm-dd)@GET
@Produces(value={"application/vnd.zanata.version.locales+json","application/json"})
@Path(value="/{versionSlug:[a-zA-Z0-9]+([a-zA-Z0-9_\\-{.}]*[a-zA-Z0-9]+)?}/locales")
javax.ws.rs.core.Response getLocales(@PathParam(value="projectSlug")
String projectSlug,
@PathParam(value="versionSlug")
String versionSlug)
projectSlug - Project identifierversionSlug - Project version identifierProjectIterationLocalesResource.get()@GET
@Produces(value="application/json")
@Path(value="/{versionSlug:[a-zA-Z0-9]+([a-zA-Z0-9_\\-{.}]*[a-zA-Z0-9]+)?}/docs")
javax.ws.rs.core.Response getDocuments(@PathParam(value="projectSlug")
String projectSlug,
@PathParam(value="versionSlug")
String versionSlug)
projectSlug - Project identifierversionSlug - Project version identifier@POST
@Produces(value={"application/vnd.zanata.tu.resource+json","application/json"})
@Consumes(value="application/json")
@Path(value="/{versionSlug:[a-zA-Z0-9]+([a-zA-Z0-9_\\-{.}]*[a-zA-Z0-9]+)?}/doc/{docId}/status/{localeId}")
javax.ws.rs.core.Response getTransUnitStatus(@PathParam(value="projectSlug")
String projectSlug,
@PathParam(value="versionSlug")
String versionSlug,
@PathParam(value="docId")
String docId,
@DefaultValue(value="en-US") @PathParam(value="localeId")
String localeId,
FilterFields filterFields)
filterConstraints - Optional filtering based on one or several fields.projectSlug - Project identifierversionSlug - Project version identifierdocId - The document identifier.localeId - target locale, default to 'en-US'Copyright © 2018 Zanata Project. All rights reserved.