OntologyBulkDeletePreview

Side-effect-free preview for collection ontology reset.

collection_idCollection Id (string)required

relations object[]

Array [

idId (string)required

nameName (string)required

kindKind (string)required

Possible values: [relation_type, entity_type]

]

entities object[]

Array [

idId (string)required

nameName (string)required

kindKind (string)required

Possible values: [relation_type, entity_type]

]

totalTotal (integer)

Possible values: >= 0

Default value: 0

status object

anyOf

• OntologyBulkDeleteStatus
• null

collection_idCollection Id (string)required

stateState (string)

Possible values: [idle, pending, running, completed, partial, failed, cancelled]

Default value: idle

activeActive (boolean)

Default value: false

requested_by object

anyOf

• string
• null

string

run_id object

anyOf

• string
• null

string

started_at object

anyOf

• integer
• null

integer

updated_at object

anyOf

• integer
• null

integer

ended_at object

anyOf

• integer
• null

integer

expires_at object

anyOf

• integer
• null

integer

staleStale (boolean)

Default value: false

relations object

Aggregate progress by ontology resource kind.

totalTotal (integer)

Possible values: >= 0

Default value: 0

completedCompleted (integer)

Possible values: >= 0

Default value: 0

failedFailed (integer)

Possible values: >= 0

Default value: 0

skippedSkipped (integer)

Possible values: >= 0

Default value: 0

entities object

Aggregate progress by ontology resource kind.

totalTotal (integer)

Possible values: >= 0

Default value: 0

completedCompleted (integer)

Possible values: >= 0

Default value: 0

failedFailed (integer)

Possible values: >= 0

Default value: 0

skippedSkipped (integer)

Possible values: >= 0

Default value: 0

items object[]

Array [

idId (string)required

nameName (string)required

kindKind (string)required

Possible values: [relation_type, entity_type]

stateState (string)

Possible values: [pending, running, completed, failed, skipped]

Default value: pending

steps object

property name*string

error object

anyOf

• string
• null

string

]

failed_items object[]

Array [

idId (string)required

nameName (string)required

kindKind (string)required

Possible values: [relation_type, entity_type]

stateState (string)

Possible values: [pending, running, completed, failed, skipped]

Default value: pending

steps object

property name*string

error object

anyOf

• string
• null

string

]

current_item_id object

anyOf

• string
• null

string

message object

anyOf

• string
• null

string

OntologyBulkDeletePreview

{
  "collection_id": "string",
  "relations": [
    {
      "id": "string",
      "name": "string",
      "kind": "relation_type"
    }
  ],
  "entities": [
    {
      "id": "string",
      "name": "string",
      "kind": "relation_type"
    }
  ],
  "total": 0,
  "status": {
    "collection_id": "string",
    "state": "idle",
    "active": false,
    "requested_by": "string",
    "run_id": "string",
    "started_at": 0,
    "updated_at": 0,
    "ended_at": 0,
    "expires_at": 0,
    "stale": false,
    "relations": {
      "total": 0,
      "completed": 0,
      "failed": 0,
      "skipped": 0
    },
    "entities": {
      "total": 0,
      "completed": 0,
      "failed": 0,
      "skipped": 0
    },
    "items": [
      {
        "id": "string",
        "name": "string",
        "kind": "relation_type",
        "state": "pending",
        "steps": {},
        "error": "string"
      }
    ],
    "failed_items": [
      {
        "id": "string",
        "name": "string",
        "kind": "relation_type",
        "state": "pending",
        "steps": {},
        "error": "string"
      }
    ],
    "current_item_id": "string",
    "message": "string"
  }
}