# dev.cartridge.claims.getMigrationStatus

> Published by [cartridge.dev](https://lexicon.garden/identity/did:plc:4mrwcmxk266itsdn33leqljq)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:4mrwcmxk266itsdn33leqljq/dev.cartridge.claims.getMigrationStatus)
- [Documentation](https://lexicon.garden/lexicon/did:plc:4mrwcmxk266itsdn33leqljq/dev.cartridge.claims.getMigrationStatus/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:4mrwcmxk266itsdn33leqljq/dev.cartridge.claims.getMigrationStatus/examples)

## Definitions

### `dev.cartridge.claims.getMigrationStatus`

**Type**: `query`

Get the status of a migration background job.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `jobId` | `string` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `error` | `string` | No |  |
| `jobId` | `string` | Yes |  |
| `status` | `string` | Yes |  |
| `results` | `array` | No |  |
| `progress` | `ref` → `#progressView` | No |  |

### `dev.cartridge.claims.getMigrationStatus#progressView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `total` | `integer` | No |  |
| `processed` | `integer` | No |  |
| `orgProfileDone` | `boolean` | No |  |

### `dev.cartridge.claims.getMigrationStatus#migrationResult`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `error` | `string` | No |  |
| `newUri` | `string` (at-uri) | No |  |
| `status` | `string` | Yes |  |
| `gameUri` | `string` (at-uri) | Yes |  |

## Raw Schema

```json
{
  "id": "dev.cartridge.claims.getMigrationStatus",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "jobId",
            "status"
          ],
          "properties": {
            "error": {
              "type": "string",
              "maxLength": 256
            },
            "jobId": {
              "type": "string",
              "maxLength": 128
            },
            "status": {
              "type": "string",
              "maxLength": 64,
              "knownValues": [
                "pending",
                "running",
                "completed",
                "failed",
                "paused",
                "cancelled"
              ]
            },
            "results": {
              "type": "array",
              "items": {
                "ref": "#migrationResult",
                "type": "ref"
              }
            },
            "progress": {
              "ref": "#progressView",
              "type": "ref"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "jobId"
        ],
        "properties": {
          "jobId": {
            "type": "string",
            "maxLength": 128
          }
        }
      },
      "description": "Get the status of a migration background job."
    },
    "progressView": {
      "type": "object",
      "properties": {
        "total": {
          "type": "integer"
        },
        "processed": {
          "type": "integer"
        },
        "orgProfileDone": {
          "type": "boolean"
        }
      }
    },
    "migrationResult": {
      "type": "object",
      "required": [
        "gameUri",
        "status"
      ],
      "properties": {
        "error": {
          "type": "string",
          "maxLength": 256
        },
        "newUri": {
          "type": "string",
          "format": "at-uri"
        },
        "status": {
          "type": "string",
          "maxLength": 64,
          "knownValues": [
            "success",
            "failed",
            "skipped"
          ]
        },
        "gameUri": {
          "type": "string",
          "format": "at-uri"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```