Maintenance Endpoints

Maintenance Endpoints

@ d:swarm Backend

Copy Mapping Set to New Project (that follow the same schema)

• i.e. the input attribute paths need to be the same; however, they can be part of another schema
• e.g. an input schema that was generated by example should be replaced by an inbuilt schema, or mappings should be applied to other example data (that follow the same schema)

process:

• input: (existing) input data model + (existing) project (where the mappings and the output data model should be taken from)
• output: new project (with given input data model, (copied* (!)) mappings (from existing project) and output data model (from existing project))

*) each mapping is a copy of a mapping from the given project, i.e., there is no reference back to original one nor it is the same entity (i.e. the copy is a new entity (with another identifier) with the same attributes)

command:

POST [D:SWARM BACKEND BASE URI]/projects/createprojectwithhelpofexistingentities

request (JSON):

{
    "input_data_model" : "[IDENTIFIER OF THE INPUT DATA MODEL THAT SHOULD BE UTILISED IN THE NEW PROJECT]",
    "reference_project" : "[IDENTIFIER OF THE REFERENCE PROJECT WHERE THE MAPPINGS AND THE OUTPUT DATA MODEL SHOULD BE TAKEN FROM]"
}

note:

• the request parameter "input_data_model" is optional, if it is not set in the request, it tries to take the input data model from the reference project
• each mapping will be copied, i.e., there is no dependency to the mappings of the reference project

a request to this endpoint will return the new project (incl. the copied mappings etc.) completely right now

Copy Mapping Set to New Project (that follow a similar schema)

• i.e. it must be possible to map all attribute paths from one schema onto the other schemas attribute paths
• e.g. mapping from a project, where the input data model follows the OAI-PMH+MARCXML schema, shall be migrated to a new project, where the input data model follows the MARCXML schema

process:

• input: (existing) input data model (incl. a schema that is similar to that one of the input data model of the reference project) + (existing) project (where the mappings and the output data model should be taken from)
• output: new project (with given input data model, (copied and aligned** (!)) mappings (from existing project) and output data model (from existing project))

**) each mapping is an aligned (i.e. the input attribute paths are aligned to those of the new schema) copy of a mapping from the given project, i.e., there is no reference back to original one nor it is the same entity (i.e. the copy is a new entity (with another identifier) with the same attributes (expect of the aligned input attribute paths))

command:

POST [D:SWARM BACKEND BASE URI]/projects/migrateprojecttonewinputschema

request (JSON):

{
    "input_data_model" : "[IDENTIFIER OF THE INPUT DATA MODEL (WITH A SIMILAR SCHEMA TO THAT ONE OF THE INPUT DATA MODEL OF THE REFERENCE PROJECT) THAT SHOULD BE UTILISED IN THE NEW PROJECT]",
    "reference_project" : "[IDENTIFIER OF THE REFERENCE PROJECT WHERE THE MAPPINGS AND THE OUTPUT DATA MODEL SHOULD BE TAKEN FROM]"
}

note:

• both request parameters are mandatory
• each mapping will be copied and aligned, i.e., there is no dependency to the mappings of the reference project

a request to this endpoint will return the new project (incl. the copied and aligned mappings etc.) completely right now