Package com.gentics.contentnode.rest.resource.migration

Interface MigrationResource

@Path("/migration") public interface MigrationResource
Resource used for performing Tag Type Migrations and Template Migrations
Author:
Taylor

  • Method Details

    • cancelMigration

      @GET @Path("/cancelMigration") GenericResponse cancelMigration() throws Exception
      Cancel the current tag type migration job, if one is being executed
      Returns:
      response object containing details about the cancellation
      Throws:
      Exception

    • getMigrationStatus

      @GET @Path("/getMigrationStatus") MigrationStatusResponse getMigrationStatus() throws Exception
      Get the migration status for a given tag type migration job
      Returns:
      response object containing details about the status of the current migration
      Throws:
      Exception

    • getMigrationJobItems

      @GET @Path("/getMigrationJobItems/{jobId}") MigrationJobItemsResponse getMigrationJobItems(@PathParam("jobId") int jobId) throws Exception
      Get the migration job items for the given job
      Parameters:
      jobId - The jobId for which the items should be loaded
      Returns:
      Throws:
      Exception

    • getMigrationLogs

      @GET @Path("/getMigrationLogs") MigrationGetLogsResponse getMigrationLogs() throws Exception
      Get a list of all tag type migration logs
      Returns:
      Throws:
      Exception

    • getMigrationLog

      @GET @Path("/getMigrationLog/{jobId}") MigrationGetLogResponse getMigrationLog(@PathParam("jobId") int jobId) throws Exception
      Get the log for a given tag type migration job
      Parameters:
      jobId - the id of the migration job
      Returns:
      Throws:
      Exception

    • performTagTypeMigration

      @POST @Path("/performMigration") MigrationResponse performTagTypeMigration(TagTypeMigrationRequest request) throws Exception
      Perform tag migration process
      Parameters:
      request - migration request object
      Returns:
      response object
      Throws:
      Exception

    • performTemplateMigration

      @POST @Path("/performTemplateMigration") MigrationResponse performTemplateMigration(TemplateMigrationRequest request) throws Exception
      Throws:
      Exception

    • reinvokeTagTypeMigration

      @POST @Path("/reinvokeMigration") MigrationResponse reinvokeTagTypeMigration(MigrationReinvokeRequest request) throws Exception
      Reinvoke the tag type migration for the given object
      Parameters:
      request -
      Returns:
      Throws:
      Exception

    • getPossiblePartMappings

      @GET @Path("/getPossiblePartMappings") PossiblePartMappingsResponse getPossiblePartMappings(@QueryParam("fromTagTypeId") int fromTagTypeId, @QueryParam("toTagTypeId") int toTagTypeId) throws Exception
      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
      Throws:
      Exception

    • getPartsForTagType

      @GET @Path("/getPartsForTagType/{id}") MigrationPartsResponse getPartsForTagType(@PathParam("id") String id) throws Exception
      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
      Throws:
      Exception

    • getMigrationTagTypes

      @POST @Path("/getMigrationTagTypes") MigrationTagsResponse getMigrationTagTypes(MigrationTagsRequest request) throws Exception
      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
      Throws:
      Exception

    • getMigrationConstructs

      @POST @Path("/getMigrationConstructs") ConstructListResponse getMigrationConstructs(MigrationTagsRequest request) throws Exception
      Get a list of constructs, that can be migrated for the given type
      Parameters:
      request - request containing the migration type
      Returns:
      list of constructs
      Throws:
      Exception