Interface MigrationResource
-
- All Superinterfaces:
AuthenticatedResource
@Path("/migration") public interface MigrationResource extends AuthenticatedResource
Resource used for performing Tag Type Migrations and Template Migrations- Author:
- Taylor
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description GenericResponse
cancelMigration()
Cancel the current tag type migration job, if one is being executedConstructListResponse
getMigrationConstructs(MigrationTagsRequest request)
Get a list of constructs, that can be migrated for the given typeMigrationJobItemsResponse
getMigrationJobItems(int jobId)
Get the migration job items for the given jobMigrationGetLogResponse
getMigrationLog(int jobId)
Get the log for a given tag type migration jobMigrationGetLogsResponse
getMigrationLogs()
Get a list of all tag type migration logsMigrationStatusResponse
getMigrationStatus()
Get the migration status for a given tag type migration jobMigrationTagsResponse
getMigrationTagTypes(MigrationTagsRequest request)
Deprecated.usegetMigrationConstructs(MigrationTagsRequest)
insteadMigrationPartsResponse
getPartsForTagType(String id)
Get a list of parts for a single tag typePossiblePartMappingsResponse
getPossiblePartMappings(int fromTagTypeId, int toTagTypeId)
Get a response that contains maps and lists with possible part mappings between to both tagtypesMigrationResponse
performTagTypeMigration(TagTypeMigrationRequest request)
Perform tag migration processMigrationResponse
performTemplateMigration(TemplateMigrationRequest request)
MigrationResponse
reinvokeTagTypeMigration(MigrationReinvokeRequest request)
Reinvoke the tag type migration for the given object-
Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource
setSessionId
-
-
-
-
Method Detail
-
cancelMigration
@GET @Path("/cancelMigration") GenericResponse cancelMigration()
Cancel the current tag type migration job, if one is being executed- Returns:
- response object containing details about the cancellation
-
getMigrationStatus
@GET @Path("/getMigrationStatus") MigrationStatusResponse getMigrationStatus()
Get the migration status for a given tag type migration job- Returns:
- response object containing details about the status of the current migration
-
getMigrationJobItems
@GET @Path("/getMigrationJobItems/{jobId}") MigrationJobItemsResponse getMigrationJobItems(@PathParam("jobId") int jobId)
Get the migration job items for the given job- Parameters:
jobId
- The jobId for which the items should be loaded- Returns:
-
getMigrationLogs
@GET @Path("/getMigrationLogs") MigrationGetLogsResponse getMigrationLogs()
Get a list of all tag type migration logs- Returns:
-
getMigrationLog
@GET @Path("/getMigrationLog/{jobId}") MigrationGetLogResponse getMigrationLog(@PathParam("jobId") int jobId)
Get the log for a given tag type migration job- Parameters:
jobId
- the id of the migration job- Returns:
-
performTagTypeMigration
@POST @Path("/performMigration") MigrationResponse performTagTypeMigration(TagTypeMigrationRequest request)
Perform tag migration process- Parameters:
request
- migration request object- Returns:
- response object
-
performTemplateMigration
@POST @Path("/performTemplateMigration") MigrationResponse performTemplateMigration(TemplateMigrationRequest request)
-
reinvokeTagTypeMigration
@POST @Path("/reinvokeMigration") MigrationResponse reinvokeTagTypeMigration(MigrationReinvokeRequest request)
Reinvoke the tag type migration for the given object- Parameters:
request
-- Returns:
-
getPossiblePartMappings
@GET @Path("/getPossiblePartMappings") PossiblePartMappingsResponse getPossiblePartMappings(@QueryParam("fromTagTypeId") int fromTagTypeId, @QueryParam("toTagTypeId") int toTagTypeId)
Get a response that contains maps and lists with possible part mappings between to both tagtypes- Parameters:
fromTagTypeId
- TagTypeId of the tagtype that should be mappedtoTagTypeId
- TagTypeId of the desired target tagtype- Returns:
- response object
-
getPartsForTagType
@GET @Path("/getPartsForTagType/{id}") MigrationPartsResponse getPartsForTagType(@PathParam("id") String id)
Get a list of parts for a single tag type- Parameters:
id
- id of the tag type to return tags for- Returns:
- response object containing the parts for the requested tag type
-
getMigrationTagTypes
@POST @Path("/getMigrationTagTypes") MigrationTagsResponse getMigrationTagTypes(MigrationTagsRequest request)
Deprecated.usegetMigrationConstructs(MigrationTagsRequest)
insteadGet a list of Tag Types for possible migration by examining the given objects- Parameters:
request
- migration tags request object- Returns:
- response object containing the tags for the requested objects
-
getMigrationConstructs
@POST @Path("/getMigrationConstructs") ConstructListResponse getMigrationConstructs(MigrationTagsRequest request)
Get a list of constructs, that can be migrated for the given type- Parameters:
request
- request containing the migration type- Returns:
- list of constructs
-
-