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 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
      • 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 mapped
        toTagTypeId - 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
      • 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