# Migration state of a schema

Migration state of a schema

Endpoint: POST /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/migrationstate
Version: 1.0
Security: x-api-key

## Path parameters:

  - `org` (string, required)
    Organization identifier

  - `project` (string, required)
    Project identifier

  - `dbschema` (string, required)
    Identifier of the database schema

## Header parameters:

  - `Harness-Account` (string)
    Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

## Query parameters:

  - `page` (integer)
    Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.

  - `limit` (integer)
    Pagination: Number of items to return.

  - `search_term` (string)
    This would be used to filter resources having attributes matching the search term.

## Request fields (application/json):

  - `instanceFilter` (object)
    Get migration state request instance input

  - `instanceFilter.instances` (array)

  - `instanceFilter.order` (string)
    order of instance entity
    Enum: "DESC", "ASC"

  - `instanceFilter.sort` (string)
    sort for instance entity
    Enum: "name", "updated", "created", "identifier"

## Response 200 fields (application/json):

  - `changeSets` (array)

  - `changeSets.author` (string, required)

  - `changeSets.changeSet` (string, required)
    Identifier of the Change Set

  - `changeSets.changeSetFQN` (string, required)
    changesetFQN is a unique identifier for database changesets in the format filename::changesetId::author

  - `changeSets.fileName` (string, required)

  - `changeSets.instances` (array, required)

  - `changeSets.instances.error` (string)

  - `changeSets.instances.instance` (string, required)
    Identfier of the instance

  - `changeSets.instances.pipeline` (string, required)

  - `changeSets.instances.planExecutionId` (string, required)

  - `changeSets.instances.stageExecutionId` (string, required)

  - `changeSets.instances.status` (string, required)
    Status of change set deployment
    Enum: "Rolled_Back", "Successfully_Deployed", "Not_Deployed", "Deployment_Failed"

  - `changeSets.instances.tag` (string)

  - `changeSets.instances.updated` (integer)
    Time of last Change Set Deployment/Rollback attempt

  - `changeSets.synced` (boolean, required)
    If Change Set is successfully deployed to all instances

  - `changeSets.updated` (integer, required)

  - `schema` (string, required)
    Identifier of the Schema

## Response 400 fields (application/json):

  - `message` (string, required)
    error message detail

## Response 403 fields (application/json):

  - `message` (string, required)
    error message detail

## Response 500 fields (application/json):

  - `message` (string, required)
    error message detail