Skip to main content

Create a migration

POST 

/v1/migrations

This route allows you to create a migration in your Port organization.

You can use this to migrate data from one blueprint to another, or to convert the data type of a property in a blueprint.

Request

Body

required

    sourceBlueprint stringrequired

    The identifier of the blueprint from which the migration will be performed.

    mapping

    object

    required

    The definition used to map the data from the source blueprint into the target blueprint.

    blueprint string

    The identifier of the target blueprint.

    filter string

    An optional set of conditions to filter the entities that will be migrated.

    itemsToParse string

    A jq query that evaluates to an array of items, used to create multiple entities at once. See more information here.

    entity

    object

    required

    identifier string

    A jq expression used to get data from the source blueprint, to be used as an identifier for the entity.

    title string

    A jq expression used to get data from the source blueprint, to be used as the title of the entity.

    icon string

    The icon of the entity.

    team string

    The team the entity belongs to.

    properties

    object

    An object containing the properties of the entity and their values, in "key":"value" pairs where the key is the property's identifier, and the value is its value.

    relations

    object

    An object containing the relations of the entity and their values, in "key":"value" pairs where the key is the relation's identifier, and the value is the related entity's identifier.

Responses

Default Response

Loading...