AlgorithmInstanceDto

idstringrequired

Example: 123e4567-e89b-12d3-a456-426614174000

algorithmDefinition objectrequired

The definition for the algorithm

titlestringrequired

Title of the algorithm

descriptionstringrequired

Description of the algorithm

keywordsstring[]required

Keywords associated with the algorithm

imagestringrequired

Public image URL of the algorithm

imageCredentials object

Optional credentials for pulling the algorithm image

registrystringrequired

Registry hostname for pulling the algorithm image

usernamestringrequired

Username used to authenticate against the registry

passwordstringrequired

Password used to authenticate against the registry

algorithmEventsstring[]required

Algorithm event structure of the algorithm

roleDefinitionsstring[]required

Role definitions for the algorithm

internalEventsstring[]required

Internal event structure of the algorithm

uiTemplatestring[]required

UI template for visualizing internal events

participantsstring[]required

Participants for this algorithm

createdDatestring<date-time>required

Example: 2023-01-01T00:00:00.000Z

statusstringrequired

The current status of the algorithm instance

startedAtstring<date-time>required

finishedAtstring<date-time>

algorithmEvents object[]

Array [

idstringrequired

eventIdstringrequired

algorithmInstanceIdstringrequired

namestringrequired

numbernumberrequired

timestampstring<date-time>required

sequencenumberrequired

sizenumber

checksumstring

createdBystringrequired

recipientsstring[]

]

internalEvents object[]

Array [

idstringrequired

algorithmInstanceIdstringrequired

namestringrequired

numbernumberrequired

timestampstring<date-time>required

data object

property name*any

]

AlgorithmInstanceDto

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "algorithmDefinition": {
    "title": "string",
    "description": "string",
    "keywords": [
      "string"
    ],
    "image": "string",
    "imageCredentials": {
      "registry": "string",
      "username": "string",
      "password": "string"
    },
    "algorithmEvents": [
      "string"
    ],
    "roleDefinitions": [
      "string"
    ],
    "internalEvents": [
      "string"
    ],
    "uiTemplate": [
      "string"
    ]
  },
  "participants": [
    "string"
  ],
  "createdDate": "2023-01-01T00:00:00.000Z",
  "status": "string",
  "startedAt": "2024-07-29T15:51:28.071Z",
  "finishedAt": "2024-07-29T15:51:28.071Z",
  "algorithmEvents": [
    {
      "id": "string",
      "eventId": "string",
      "algorithmInstanceId": "string",
      "name": "string",
      "number": 0,
      "timestamp": "2024-07-29T15:51:28.071Z",
      "sequence": 0,
      "size": 0,
      "checksum": "string",
      "createdBy": "string",
      "recipients": [
        "string"
      ]
    }
  ],
  "internalEvents": [
    {
      "id": "string",
      "algorithmInstanceId": "string",
      "name": "string",
      "number": 0,
      "timestamp": "2024-07-29T15:51:28.071Z",
      "data": {}
    }
  ]
}