Get a dataset copy

GET /api/v1/dataset-copies/{id}

Get a dataset copy

cURL

curl --request GET \
  --url https://dev.simforge.ai/api/v1/dataset-copies/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "source": {
    "id": "<string>",
    "name": "<string>"
  },
  "target": {
    "id": "<string>",
    "name": "<string>"
  },
  "scope": "dataset",
  "state": "queued",
  "progress": {
    "total": 1,
    "done": 1,
    "copied": 1,
    "skipped": 1,
    "failed": 1,
    "estimateSeconds": 1
  },
  "failures": [
    {
      "scenarioId": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "subject": "<string>",
      "detail": {}
    }
  ],
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "finishedAt": "<string>"
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Path Parameters

id · string · required

Response

200

application/json

State, counts (copied, skipped as already copied, failed), the first failures and the time left.

id · string · required

source · object · required

Show child attributes

target · object · required

Show child attributes

scope · enum<string> · required

Available options: dataset, query, documents

state · enum<string> · required

Available options: queued, running, succeeded, failed

progress · object · required

Show child attributes

failures · object[] · required

Show child attributes

warnings · object[] · required

Show child attributes

error · object | null · required

Show child attributes

createdAt · string · required

updatedAt · string · required

finishedAt · string | null · required