com.gentics.contentnode.rest.resource.migration

Interface MigrationResource

All Superinterfaces:

AuthenticatedResource

@Path(value="/migration")
public interface MigrationResource
extends AuthenticatedResource

Resource used for performing Tag Type Migrations and Template Migrations

Author:

Taylor

Method Summary

Modifier and Type	Method and Description
GenericResponse	cancelMigration() Cancel the current tag type migration job, if one is being executed
ConstructListResponse	getMigrationConstructs(MigrationTagsRequest request) Get a list of constructs, that can be migrated for the given type
MigrationJobItemsResponse	getMigrationJobItems(int jobId) Get the migration job items for the given job
MigrationGetLogResponse	getMigrationLog(int jobId) Get the log for a given tag type migration job
MigrationGetLogsResponse	getMigrationLogs() Get a list of all tag type migration logs
MigrationStatusResponse	getMigrationStatus() Get the migration status for a given tag type migration job
MigrationTagsResponse	getMigrationTagTypes(MigrationTagsRequest request) Deprecated. use getMigrationConstructs(MigrationTagsRequest) instead
MigrationPartsResponse	getPartsForTagType(String id) Get a list of parts for a single tag type
PossiblePartMappingsResponse	getPossiblePartMappings(int fromTagTypeId, int toTagTypeId) Get a response that contains maps and lists with possible part mappings between to both tagtypes
MigrationResponse	performTagTypeMigration(TagTypeMigrationRequest request) Perform tag migration process
MigrationResponse	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(value="/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(value="/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(value="/getMigrationJobItems/{jobId}")
MigrationJobItemsResponse getMigrationJobItems(@PathParam(value="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(value="/getMigrationLogs")
MigrationGetLogsResponse getMigrationLogs()

Get a list of all tag type migration logs

Returns:

getMigrationLog

@GET
 @Path(value="/getMigrationLog/{jobId}")
MigrationGetLogResponse getMigrationLog(@PathParam(value="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(value="/performMigration")
MigrationResponse performTagTypeMigration(TagTypeMigrationRequest request)

Perform tag migration process

Parameters:

request - migration request object

Returns:

response object

performTemplateMigration

@POST
 @Path(value="/performTemplateMigration")
MigrationResponse performTemplateMigration(TemplateMigrationRequest request)

reinvokeTagTypeMigration

@POST
 @Path(value="/reinvokeMigration")
MigrationResponse reinvokeTagTypeMigration(MigrationReinvokeRequest request)

Reinvoke the tag type migration for the given object

Parameters:

request -

Returns:

getPossiblePartMappings

@GET
 @Path(value="/getPossiblePartMappings")
PossiblePartMappingsResponse getPossiblePartMappings(@QueryParam(value="fromTagTypeId")
                                                                                                   int fromTagTypeId,
                                                                                                   @QueryParam(value="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 mapped

toTagTypeId - TagTypeId of the desired target tagtype

Returns:

response object

getPartsForTagType

@GET
 @Path(value="/getPartsForTagType/{id}")
MigrationPartsResponse getPartsForTagType(@PathParam(value="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(value="/getMigrationTagTypes")
MigrationTagsResponse getMigrationTagTypes(MigrationTagsRequest request)

Deprecated. use getMigrationConstructs(MigrationTagsRequest) instead

Get 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(value="/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