List Schema Migrations - Serval Documentation

GET

entity-types

{entity_type_id}

schema-migrations

List Schema Migrations

curl --request GET \
  --url https://public.api.serval.com/v2/entity-types/{entity_type_id}/schema-migrations \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "entityTypeId": "<string>",
      "details": {
        "changeFieldType": {
          "fieldId": "<string>",
          "fieldKey": "<string>"
        }
      },
      "actorUserId": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "error": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

entity_type_id

string

required

The ID of the entity type whose migration history to list.

Query Parameters

pageSize

integer<int32>

Maximum number of results to return. Default is 50, maximum is 200.

pageToken

string

Token for pagination. Leave empty for the first request.

Response

Success

data

SchemaMigration · object[]

The migrations for the entity type, newest first.

Show child attributes

nextPageToken

string | null

Token for retrieving the next page of results. Empty if no more results.

List Schema Migrations

curl --request GET \
  --url https://public.api.serval.com/v2/entity-types/{entity_type_id}/schema-migrations \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "entityTypeId": "<string>",
      "details": {
        "changeFieldType": {
          "fieldId": "<string>",
          "fieldKey": "<string>"
        }
      },
      "actorUserId": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "error": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}