AnalysisDto
idstringrequired
namestringrequired
statusstringrequired
participantIdsstring[]required
startedAtdate-timerequired
finishedAtdate-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
]
createdDatedate-timerequired
Example:
2023-01-01T00:00:00.000Z
modifiedDatedate-timerequired
Example:
2023-01-02T00:00:00.000Z
deletedDatedate-timerequired
Example:
2023-01-03T00:00:00.000Z
]
algorithmEvents object[]
Array [
idstringrequired
analysisIdstringrequired
namestringrequired
numbernumberrequired
timestampstringrequired
databinary
createdBystringrequired
]
internalEvents object[]
Array [
idstringrequired
analysisIdstringrequired
namestringrequired
numbernumberrequired
timestampstringrequired
data object
property name*any
]
AnalysisDto
{
"id": "string",
"name": "string",
"status": "string",
"participantIds": [
"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",
"analysisId": "string",
"name": "string",
"number": 0,
"timestamp": "string",
"data": "string",
"createdBy": "string"
}
],
"internalEvents": [
{
"id": "string",
"analysisId": "string",
"name": "string",
"number": 0,
"timestamp": "string",
"data": {}
}
]
}