AlgorithmInstanceDto

idstringrequired

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

algorithmDefinition object

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

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>

transfers object[]

Array [

idstringrequired

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

rolestringrequired

Possible values: [provider, consumer]

Example: provider

processIdstringrequired

Example: process-001

remotePartystringrequired

Example: remote-system

secretstring

Example: secret-key

datasetIdstring

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

statestringrequired

Possible values: [REQUESTED, STARTED, TERMINATED, COMPLETED, SUSPENDED]

Example: REQUESTED

request object

@typestringrequired

Example: TransferRequestMessage

consumerPidstringrequired

Example: consumer-pid-123

agreementIdstringrequired

Example: agreement-id-456

formatstringrequired

Example: application/json

dataAddress object

@typestringrequired

Example: DataAddress

endpointTypestringrequired

Example: http

endpointstringrequired

Example: https://api.example.com

endpointProperties object[]

Array [

@typestringrequired

Example: EndpointProperty

namestringrequired

Example: endpointName

valuestringrequired

Example: endpointValue

]

callbackAddressstringrequired

Example: https://callback.example.com

response object

acceptedbooleanrequired

Example: true

identifierstringrequired

Example: req-identifier

dataAddress object

endpointstringrequired

Example: http://data-plane-endpoint

properties object[]required

Array [

namestringrequired

Example: propertyName

valuestringrequired

Example: propertyValue

]

callbackAddressstring

Example: http://callback-address

dataAddress object

@typestringrequired

Example: DataAddress

endpointTypestringrequired

Example: http

endpointstringrequired

Example: https://api.example.com

endpointProperties object[]

Array [

@typestringrequired

Example: EndpointProperty

namestringrequired

Example: endpointName

valuestringrequired

Example: endpointValue

]

createdDatestring<date-time>required

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

modifiedDatestring<date-time>required

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

deletedDatestring<date-time>required

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

]

algorithmEvents object[]

Array [

idstringrequired

eventIdstringrequired

algorithmInstanceIdstringrequired

namestringrequired

numbernumberrequired

timestampstring<date-time>required

createdBystringrequired

transferIdsstring[]

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",
    "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",
  "transfers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "role": "provider",
      "processId": "process-001",
      "remoteParty": "remote-system",
      "secret": "secret-key",
      "datasetId": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
      "state": "REQUESTED",
      "request": {},
      "response": {},
      "dataAddress": {},
      "createdDate": "2023-01-01T00:00:00.000Z",
      "modifiedDate": "2023-01-02T00:00:00.000Z",
      "deletedDate": "2023-01-03T00:00:00.000Z"
    }
  ],
  "algorithmEvents": [
    {
      "id": "string",
      "eventId": "string",
      "algorithmInstanceId": "string",
      "name": "string",
      "number": 0,
      "timestamp": "2024-07-29T15:51:28.071Z",
      "createdBy": "string",
      "transferIds": [
        "string"
      ],
      "recipients": [
        "string"
      ]
    }
  ],
  "internalEvents": [
    {
      "id": "string",
      "algorithmInstanceId": "string",
      "name": "string",
      "number": 0,
      "timestamp": "2024-07-29T15:51:28.071Z",
      "data": {}
    }
  ]
}