Aksio.Cratis.Kernel.Server v1.0
Scroll down for example requests and responses.
ClientObservers
post__.cratis_observers_{observerId}
POST /.cratis/observers/{observerId}
Action that is called for events to be handled.
Body parameter
{
"metadata": {
"sequenceNumber": {
"value": 0
},
"type": {
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
}
},
"context": {
"eventSourceId": {
"value": "string"
},
"sequenceNumber": {
"value": 0
},
"occurred": "2019-08-24T14:15:22Z",
"validFrom": "2019-08-24T14:15:22Z",
"tenantId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"correlationId": {
"value": "string"
},
"causationId": {
"value": "string"
},
"causedBy": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"observationState": 0
},
"content": {
"property1": null,
"property2": null
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
observerId | path | ObserverId | true | The Aksio.Cratis.Observation.ObserverId of the observer it is for. |
body | body | AppendedEvent | false | The Aksio.Cratis.Events.AppendedEvent. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
ConnectedClients
post__api_clients_{microserviceId}ping{connectionId}
POST /api/clients/{microserviceId}/ping/{connectionId}
A ping endpoint for clients to see if Kernel is available.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | The Aksio.Cratis.Execution.MicroserviceId that is connecting. |
connectionId | path | ConnectionId | true | The unique identifier of the connection that is pinging. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
post__api_clients_{microserviceId}connect{connectionId}
POST /api/clients/{microserviceId}/connect/{connectionId}
Accepts client connections over Web Sockets.
Body parameter
{
"clientVersion": "string",
"advertisedUri": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | The Aksio.Cratis.Execution.MicroserviceId that is connecting. |
connectionId | path | ConnectionId | true | The unique identifier of the connection. |
body | body | ClientInformation | false | Aksio.Cratis.Clients.ClientInformation to connect with. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
EventSequence
post__api_events_store_{microserviceId}_{tenantId}sequence{eventSequenceId}
POST /api/events/store/{microserviceId}/{tenantId}/sequence/{eventSequenceId}
Appends an event to the event log.
Body parameter
{
"eventSourceId": {
"value": "string"
},
"eventType": {
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
},
"content": {
"property1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
},
"property2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | The microservice to append for. |
eventSequenceId | path | EventSequenceId | true | The event sequence to append to. |
tenantId | path | TenantId | true | The tenant to append to. |
body | body | AppendEvent | false | The payload with the details about the event to append. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
get__api_events_store_{microserviceId}_{tenantId}sequence{eventSequenceId}
GET /api/events/store/{microserviceId}/{tenantId}/sequence/{eventSequenceId}
Get events for a specific event sequence in a microservice for a specific tenant.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
eventSequenceId | path | EventSequenceId | true | Event sequence to get for. |
microserviceId | query | MicroserviceId | false | Microservice to get for. |
tenantId | query | TenantId | false | Tenant to get for. |
microserviceId | path | string | true | none |
tenantId | path | string | true | none |
Example responses
200 Response
[{"metadata":{"sequenceNumber":{"value":0},"type":{"id":{"value":"a860a344-d7b2-406e-828e-8d442f23f344"},"generation":{"value":0},"isPublic":true}},"context":{"eventSourceId":{"value":"string","isSpecified":true},"sequenceNumber":{"value":0},"occurred":"2019-08-24T14:15:22Z","validFrom":"2019-08-24T14:15:22Z","tenantId":{"value":"a860a344-d7b2-406e-828e-8d442f23f344"},"correlationId":{"value":"string"},"causationId":{"value":"string"},"causedBy":{"value":"a860a344-d7b2-406e-828e-8d442f23f344"},"observationState":0},"content":{"options":{"propertyNameCaseInsensitive":true},"parent":{},"root":{}}}]
[
{
"metadata": {
"sequenceNumber": {
"value": 0
},
"type": {
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
}
},
"context": {
"eventSourceId": {
"value": "string",
"isSpecified": true
},
"sequenceNumber": {
"value": 0
},
"occurred": "2019-08-24T14:15:22Z",
"validFrom": "2019-08-24T14:15:22Z",
"tenantId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"correlationId": {
"value": "string"
},
"causationId": {
"value": "string"
},
"causedBy": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"observationState": 0
},
"content": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [AppendedEventWithJsonAsContent] | false | none | [Represents an event that has been appended to an event log with the content as JSON.] |
» metadata | EventMetadata | false | none | Represents the metadata related to an event. |
»» sequenceNumber | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
»»» value | integer(int64) | false | none | Gets or inits the underlying value for the instance. |
»» type | EventType | false | none | Represents the type of an event. |
»»» id | EventTypeId | false | none | Represents the concept of the unique identifier of a type of event. |
»»»» value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
»»» generation | EventGeneration | false | none | Represents the generation of an Aksio.Cratis.Events.EventType. |
»»»» value | integer(int32) | false | none | Gets or inits the underlying value for the instance. |
»»» isPublic | boolean | false | none | Whether or not the event type is considered a public event. |
» context | EventContext | false | none | Represents the context in which an event exists - typically what it was appended with. |
»» eventSourceId | EventSourceId | false | none | Represents the unique identifier of an instance of an event source. |
»»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»»» isSpecified | boolean | false | read-only | Check whether or not the Aksio.Cratis.Events.EventSourceId is specified. |
»» sequenceNumber | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
»» occurred | string(date-time) | false | none | |
»» validFrom | string(date-time) | false | none | |
»» tenantId | TenantId | false | none | Represents the unique identifier of a tenant in the system. |
»»» value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
»» correlationId | CorrelationId | false | none | Represents an identifier for correlation. |
»»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» causationId | CausationId | false | none | Represents an identifier for correlation. |
»»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» causedBy | CausedBy | false | none | Represents an identifier of an identity that was the root of a cause. |
»»» value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
»» observationState | EventObservationState(int32) | false | none | Represents the observation state for an event. |
» content | JsonNode | false | none | none |
»» options | JsonNodeOptions | false | none | none |
»»» propertyNameCaseInsensitive | boolean | false | none | none |
»» parent | JsonNode | false | none | none |
»» root | JsonNode | false | none | none |
Enumerated Values
Property | Value |
---|---|
observationState | 0 |
observationState | 1 |
observationState | 2 |
observationState | 4 |
observationState | 8 |
get__api_events_store_{microserviceId}_{tenantId}sequence{eventSequenceId}_histogram
GET /api/events/store/{microserviceId}/{tenantId}/sequence/{eventSequenceId}/histogram
Get a histogram of a specific event sequence. PS: Not implemented yet.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | string | true | none |
tenantId | path | string | true | none |
eventSequenceId | path | string | true | none |
Example responses
200 Response
[{"date":"2019-08-24T14:15:22Z","count":0}]
[
{
"date": "2019-08-24T14:15:22Z",
"count": 0
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [EventHistogramEntry] | false | none | none |
» date | string(date-time) | false | none | none |
» count | integer(int32) | false | none | none |
EventSequences
get__api_events_store_sequences
GET /api/events/store/sequences
Gets all event sequences.
Example responses
200 Response
[{"id":"string","name":"string"}]
[
{
"id": "string",
"name": "string"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [EventSequenceInformation] | false | none | none |
» id | string¦null | false | none | none |
» name | string¦null | false | none | none |
EventTypes
post__api_events_store_{microserviceId}_types
POST /api/events/store/{microserviceId}/types
Register schemas.
Body parameter
{
"types": [
{
"type": {
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
},
"friendlyName": "string",
"schema": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | Aksio.Cratis.Execution.MicroserviceId to register for. |
body | body | RegisterEventTypes | false | The payload. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
get__api_events_store_{microserviceId}_types
GET /api/events/store/{microserviceId}/types
Gets all event types.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | The Aksio.Cratis.Execution.MicroserviceId to get event types for. |
Example responses
200 Response
[{"identifier":"string","name":"string","generations":0}]
[
{
"identifier": "string",
"name": "string",
"generations": 0
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [EventTypeInformation] | false | none | none |
» identifier | string¦null | false | none | none |
» name | string¦null | false | none | none |
» generations | integer(int32) | false | none | none |
get__api_events_store_{microserviceId}types_schemas{eventTypeId}
GET /api/events/store/{microserviceId}/types/schemas/{eventTypeId}
Gets generation schema for type.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | query | MicroserviceId | false | The Aksio.Cratis.Execution.MicroserviceId to get event type for. |
eventTypeId | path | EventTypeId | true | Type to get for. |
microserviceId | path | string | true | none |
Example responses
200 Response
[null]
[
null
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Microservices
post__api_compliance_microservices
POST /api/compliance/microservices
Add a microservice.
Body parameter
{
"microserviceId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | AddMicroservice | false | M:Aksio.Cratis.Kernel.Domain.Compliance.Microservices.Microservices.AddMicroservice(Aksio.Cratis.Kernel.Domain.Compliance.Microservices.AddMicroservice) payload. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
get__api_configuration_microservices
GET /api/configuration/microservices
Returns all the tenants configured in the kernel.
Example responses
200 Response
[{"id":{"value":"a860a344-d7b2-406e-828e-8d442f23f344"},"name":"string"}]
[
{
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": "string"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [Microservice] | false | none | none |
» id | MicroserviceId | false | none | Represents the concept of the microservice identifier. |
»» value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
» name | string¦null | false | none | none |
get__api_configuration_microservices_{microserviceId}_storage
GET /api/configuration/microservices/{microserviceId}/storage
Get storage configuration for a specific microservice.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | Aksio.Cratis.Execution.MicroserviceId for the microservice. |
Example responses
200 Response
{"shared":{"property1":{"type":"string","connectionDetails":null},"property2":{"type":"string","connectionDetails":null}},"tenants":{"property1":{"property1":{"type":"string","connectionDetails":null},"property2":{"type":"string","connectionDetails":null}},"property2":{"property1":{"type":"string","connectionDetails":null},"property2":{"type":"string","connectionDetails":null}}}}
{
"shared": {
"property1": {
"type": "string",
"connectionDetails": null
},
"property2": {
"type": "string",
"connectionDetails": null
}
},
"tenants": {
"property1": {
"property1": {
"type": "string",
"connectionDetails": null
},
"property2": {
"type": "string",
"connectionDetails": null
}
},
"property2": {
"property1": {
"type": "string",
"connectionDetails": null
},
"property2": {
"type": "string",
"connectionDetails": null
}
}
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | StorageForMicroservice |
Observers
post__api_events_store_{microserviceId}observers_register{connectionId}
POST /api/events/store/{microserviceId}/observers/register/{connectionId}
Register client observers for a specific microservice and unique connection.
Body parameter
[
{
"observerId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": {
"value": "string"
},
"eventSequenceId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"eventTypes": [
{
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
}
]
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | Aksio.Cratis.Execution.MicroserviceId to register for. |
connectionId | path | ConnectionId | true | Aksio.Cratis.Clients.ConnectionId to register with. |
body | body | ClientObserverRegistration | false | Collection of Aksio.Cratis.Observation.ClientObserverRegistration. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
post__api_events_store_{microserviceId}observers{observerId}_rewind
POST /api/events/store/{microserviceId}/observers/{observerId}/rewind
Rewind a specific observer for a microservice and tenant.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | Aksio.Cratis.Execution.MicroserviceId the observer is for. |
tenantId | path | TenantId | true | Aksio.Cratis.Execution.TenantId the observer is for. |
observerId | path | ObserverId | true | Aksio.Cratis.Observation.ObserverId to rewind. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
get__api_events_store_{microserviceId}_{tenantId}_observers
GET /api/events/store/{microserviceId}/{tenantId}/observers
Get and observe all observers.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | Aksio.Cratis.Execution.MicroserviceId the observers are for. |
tenantId | path | TenantId | true | Aksio.Cratis.Execution.TenantId the observers are for. |
Example responses
200 Response
[[{"id":"string","eventTypes":[{"id":{"value":"a860a344-d7b2-406e-828e-8d442f23f344"},"generation":{"value":0},"isPublic":true}],"eventSequenceId":{"value":"a860a344-d7b2-406e-828e-8d442f23f344","isEventLog":true,"isOutbox":true,"isInbox":true},"observerId":{"value":"a860a344-d7b2-406e-828e-8d442f23f344"},"name":{"value":"string"},"type":0,"nextEventSequenceNumber":{"value":0},"lastHandled":{"value":0},"runningState":0,"failedPartitions":[{"eventSourceId":{"value":"string","isSpecified":true},"sequenceNumber":{"value":0},"occurred":"2019-08-24T14:15:22Z","lastAttempt":"2019-08-24T14:15:22Z","attempts":0,"messages":["string"],"stackTrace":"string"}],"recoveringPartitions":[{"eventSourceId":{"value":"string","isSpecified":true},"sequenceNumber":{"value":0},"startedRecoveryAt":"2019-08-24T14:15:22Z"}],"hasFailedPartitions":true,"isRecoveringAnyPartition":true,"isDisconnected":true}]]
[
[
{
"id": "string",
"eventTypes": [
{
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
}
],
"eventSequenceId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344",
"isEventLog": true,
"isOutbox": true,
"isInbox": true
},
"observerId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": {
"value": "string"
},
"type": 0,
"nextEventSequenceNumber": {
"value": 0
},
"lastHandled": {
"value": 0
},
"runningState": 0,
"failedPartitions": [
{
"eventSourceId": {
"value": "string",
"isSpecified": true
},
"sequenceNumber": {
"value": 0
},
"occurred": "2019-08-24T14:15:22Z",
"lastAttempt": "2019-08-24T14:15:22Z",
"attempts": 0,
"messages": [
"string"
],
"stackTrace": "string"
}
],
"recoveringPartitions": [
{
"eventSourceId": {
"value": "string",
"isSpecified": true
},
"sequenceNumber": {
"value": 0
},
"startedRecoveryAt": "2019-08-24T14:15:22Z"
}
],
"hasFailedPartitions": true,
"isRecoveringAnyPartition": true,
"isDisconnected": true
}
]
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Represents an implementation of Aksio.Cratis.Applications.Queries.IClientObservable.
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» id | string¦null | false | none | Gets or sets the identifier of the observer state. |
» eventTypes | [EventType]¦null | false | none | Gets or sets the event types the observer is observing. |
»» id | EventTypeId | false | none | Represents the concept of the unique identifier of a type of event. |
»»» value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
»» generation | EventGeneration | false | none | Represents the generation of an Aksio.Cratis.Events.EventType. |
»»» value | integer(int32) | false | none | Gets or inits the underlying value for the instance. |
»» isPublic | boolean | false | none | Whether or not the event type is considered a public event. |
» eventSequenceId | EventSequenceId | false | none | Represents the unique identifier of an event sequence. |
»» value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
»» isEventLog | boolean | false | read-only | Get whether or not this is the default log event sequence. |
»» isOutbox | boolean | false | read-only | Get whether or not this is the default outbox event sequence. |
»» isInbox | boolean | false | read-only | Get whether or not this is the default outbox event sequence. |
» observerId | ObserverId | false | none | Concept that represents the unique identifier of an observer. |
»» value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
» name | ObserverName | false | none | Concept that represents the name of an observer. |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
» type | ObserverType(int32) | false | none | Defines the different types of observers. |
» nextEventSequenceNumber | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
»» value | integer(int64) | false | none | Gets or inits the underlying value for the instance. |
» lastHandled | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
» runningState | ObserverRunningState(int32) | false | none | Defines the status of an observer. |
» failedPartitions | [FailedObserverPartition]¦null | false | none | Gets or sets the failed partitions for the observer. |
»» eventSourceId | EventSourceId | false | none | Represents the unique identifier of an instance of an event source. |
»»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»»» isSpecified | boolean | false | read-only | Check whether or not the Aksio.Cratis.Events.EventSourceId is specified. |
»» sequenceNumber | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
»» occurred | string(date-time) | false | none | Gets or sets the occurred time of the failure - if any. |
»» lastAttempt | string(date-time) | false | none | Gets or sets the occurred time of the failure - if any. |
»» attempts | integer(int32) | false | none | Gets or sets the number of retry attempts it has had. |
»» messages | [string]¦null | false | none | Gets or sets the message from the failure - if any. |
»» stackTrace | string¦null | false | none | Gets or sets the stack trace from the failure - if any. |
» recoveringPartitions | [RecoveringFailedObserverPartition]¦null | false | none | Gets or sets the failed partitions for the observer. |
»» eventSourceId | EventSourceId | false | none | Represents the unique identifier of an instance of an event source. |
»» sequenceNumber | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
»» startedRecoveryAt | string(date-time) | false | none | Gets or sets the occurred time of the failure - if any. |
» hasFailedPartitions | boolean | false | read-only | Gets whether or not there are any failed partitions. |
» isRecoveringAnyPartition | boolean | false | read-only | Gets whether or not there are any partitions being recovered. |
» isDisconnected | boolean | false | read-only | Gets whether or not the observer is in disconnected state. Meaning that there is no subscriber to it. |
Enumerated Values
Property | Value |
---|---|
type | 0 |
type | 1 |
type | 2 |
type | 3 |
runningState | 0 |
runningState | 1 |
runningState | 2 |
runningState | 3 |
runningState | 4 |
runningState | 5 |
runningState | 6 |
runningState | 7 |
runningState | 8 |
runningState | 9 |
runningState | 10 |
runningState | 11 |
PII
post__api_compliance_gdpr_pii
POST /api/compliance/gdpr/pii
Create and register a key.
Body parameter
{
"identifier": {
"value": "string"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | CreateAndRegisterKeyFor | false | M:Aksio.Cratis.Kernel.Domain.Compliance.GDPR.PII.CreateAndRegisterKeyFor(Aksio.Cratis.Kernel.Domain.Compliance.GDPR.CreateAndRegisterKeyFor) payload. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
post__api_compliance_gdpr_pii_delete
POST /api/compliance/gdpr/pii/delete
Delete PII for a person.
Body parameter
{
"personId": {
"value": "string"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | DeletePIIForPerson | false | M:Aksio.Cratis.Kernel.Domain.Compliance.GDPR.PII.DeletePIIForPerson(Aksio.Cratis.Kernel.Domain.Compliance.GDPR.DeletePIIForPerson) payload. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
People
get__api_compliance_gdpr_people
GET /api/compliance/gdpr/people
Get all people.
Example responses
200 Response
[[{"id":{"value":"string"},"socialSecurityNumber":{"value":"string","details":"string"},"firstName":{"value":"string","details":"string"},"lastName":{"value":"string","details":"string"},"address":{"value":"string","details":"string"},"city":{"value":"string","details":"string"},"postalCode":{"value":"string","details":"string"},"country":{"value":"string","details":"string"},"personalInformation":[{"identifier":{"value":"a860a344-d7b2-406e-828e-8d442f23f344"},"type":{"value":"string"},"value":{"value":"string","details":"string"}}]}]]
[
[
{
"id": {
"value": "string"
},
"socialSecurityNumber": {
"value": "string",
"details": "string"
},
"firstName": {
"value": "string",
"details": "string"
},
"lastName": {
"value": "string",
"details": "string"
},
"address": {
"value": "string",
"details": "string"
},
"city": {
"value": "string",
"details": "string"
},
"postalCode": {
"value": "string",
"details": "string"
},
"country": {
"value": "string",
"details": "string"
},
"personalInformation": [
{
"identifier": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"type": {
"value": "string"
},
"value": {
"value": "string",
"details": "string"
}
}
]
}
]
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Represents an implementation of Aksio.Cratis.Applications.Queries.IClientObservable.
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» id | PersonId | false | none | Represents the concept of a unique identifier that identifies a person. |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
» socialSecurityNumber | SocialSecurityNumber | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» firstName | FirstName | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» lastName | LastName | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» address | Address | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» city | City | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» postalCode | PostalCode | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» country | Country | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» personalInformation | [PersonalInformation]¦null | false | none | none |
»» identifier | PersonalInformationId | false | none | none |
»»» value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
»» type | PersonalInformationType | false | none | none |
»»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» value | PersonalInformationValue | false | none | none |
»»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»»» details | string¦null | false | read-only | Gets the details for the PII. |
get__api_compliance_gdpr_people_search
GET /api/compliance/gdpr/people/search
Search for people by an arbitrary string.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
query | query | string | false | String to search for. |
Example responses
200 Response
[{"id":{"value":"string"},"socialSecurityNumber":{"value":"string","details":"string"},"firstName":{"value":"string","details":"string"},"lastName":{"value":"string","details":"string"},"address":{"value":"string","details":"string"},"city":{"value":"string","details":"string"},"postalCode":{"value":"string","details":"string"},"country":{"value":"string","details":"string"},"personalInformation":[{"identifier":{"value":"a860a344-d7b2-406e-828e-8d442f23f344"},"type":{"value":"string"},"value":{"value":"string","details":"string"}}]}]
[
{
"id": {
"value": "string"
},
"socialSecurityNumber": {
"value": "string",
"details": "string"
},
"firstName": {
"value": "string",
"details": "string"
},
"lastName": {
"value": "string",
"details": "string"
},
"address": {
"value": "string",
"details": "string"
},
"city": {
"value": "string",
"details": "string"
},
"postalCode": {
"value": "string",
"details": "string"
},
"country": {
"value": "string",
"details": "string"
},
"personalInformation": [
{
"identifier": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"type": {
"value": "string"
},
"value": {
"value": "string",
"details": "string"
}
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [Person] | false | none | none |
» id | PersonId | false | none | Represents the concept of a unique identifier that identifies a person. |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
» socialSecurityNumber | SocialSecurityNumber | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» firstName | FirstName | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» lastName | LastName | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» address | Address | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» city | City | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» postalCode | PostalCode | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» country | Country | false | none | none |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» details | string¦null | false | read-only | Gets the details for the PII. |
» personalInformation | [PersonalInformation]¦null | false | none | none |
»» identifier | PersonalInformationId | false | none | none |
»»» value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
»» type | PersonalInformationType | false | none | none |
»»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»» value | PersonalInformationValue | false | none | none |
»»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
»»» details | string¦null | false | read-only | Gets the details for the PII. |
Projections
post__api_events_store_{microserviceId}_projections
POST /api/events/store/{microserviceId}/projections
Register projections with pipelines.
Body parameter
{
"projections": [
{
"projection": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
},
"pipeline": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | Aksio.Cratis.Execution.MicroserviceId to register for. |
body | body | RegisterProjections | false | The registrations. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
get__api_events_store_{microserviceId}_projections
GET /api/events/store/{microserviceId}/projections
Gets all projections.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | The Aksio.Cratis.Execution.MicroserviceId to get projections for. |
Example responses
200 Response
[{"id":{"value":"a860a344-d7b2-406e-828e-8d442f23f344"},"name":{"value":"string"},"modelName":{"value":"string"}}]
[
{
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": {
"value": "string"
},
"modelName": {
"value": "string"
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [Projection] | false | none | none |
» id | ProjectionId | false | none | Represents the unique identifier of a projection. |
»» value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
» name | ProjectionName | false | none | Represents the friendly display name of a projection. |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
» modelName | ModelName | false | none | Represents the friendly display name of a model. |
»» value | string¦null | false | none | Gets or inits the underlying value for the instance. |
post__api_events_store_{microserviceId}projections_immediate{tenantId}
POST /api/events/store/{microserviceId}/projections/immediate/{tenantId}
Perform an immediate projection.
Body parameter
{
"projectionId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"eventSequenceId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"modelKey": {
"value": "string"
},
"projection": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | path | MicroserviceId | true | Aksio.Cratis.Execution.MicroserviceId to perform for. |
tenantId | path | TenantId | true | Aksio.Cratis.Execution.TenantId to perform for. |
body | body | ImmediateProjection | false | The details about the Aksio.Cratis.Kernel.Domain.Projections.ImmediateProjection. |
Example responses
200 Response
{"model":{"property1":{"options":{"propertyNameCaseInsensitive":true},"parent":{},"root":{}},"property2":{"options":{"propertyNameCaseInsensitive":true},"parent":{},"root":{}}},"affectedProperties":[{"path":"string","segments":[{"value":"string"}],"lastSegment":{"value":"string"},"isRoot":true,"isSet":true}],"projectedEventsCount":0}
{
"model": {
"property1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
},
"property2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
},
"affectedProperties": [
{
"path": "string",
"segments": [
{
"value": "string"
}
],
"lastSegment": {
"value": "string"
},
"isRoot": true,
"isSet": true
}
],
"projectedEventsCount": 0
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | ImmediateProjectionResult |
get__api_events_store_{microserviceId}projections{projectionId}_collections
GET /api/events/store/{microserviceId}/projections/{projectionId}/collections
Get all collections for projection.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
microserviceId | query | MicroserviceId | false | The Aksio.Cratis.Execution.MicroserviceId to get projection collections for. |
projectionId | path | ProjectionId | true | Id of projection to get for. |
microserviceId | path | string | true | none |
Example responses
200 Response
[{"name":"string","documentCount":0}]
[
{
"name": "string",
"documentCount": 0
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [ProjectionCollection] | false | none | none |
» name | string¦null | false | none | none |
» documentCount | integer(int32) | false | none | none |
TenantConfiguration
post__api_configuration_tenants_{tenantId}
POST /api/configuration/tenants/{tenantId}
Set a key/value pair configuration for a specific tenant.
Body parameter
{
"key": "string",
"value": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
tenantId | path | TenantId | true | Aksio.Cratis.Execution.TenantId for the tenant to set for. |
body | body | StringStringKeyValuePair | false | The key value pair to set. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | None |
get__api_configuration_tenants_{tenantId}
GET /api/configuration/tenants/{tenantId}
Returns all the configuration key/value pairs associated with a specific tenant.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
tenantId | path | TenantId | true | Aksio.Cratis.Execution.TenantId for the tenant to get for. |
Example responses
200 Response
{"property1":"string","property2":"string"}
{
"property1": "string",
"property2": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» additionalProperties | string | false | none | none |
Tenants
get__api_configuration_tenants
GET /api/configuration/tenants
Get all the tenants.
Example responses
200 Response
[{"id":{"value":"a860a344-d7b2-406e-828e-8d442f23f344"},"name":"string"}]
[
{
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": "string"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [TenantInfo] | false | none | none |
» id | TenantId | false | none | Represents the unique identifier of a tenant in the system. |
»» value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
» name | string¦null | false | none | none |
Schemas
AddMicroservice
{
"microserviceId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
microserviceId | MicroserviceId | false | none | Represents the concept of the microservice identifier. |
name | string¦null | false | none | none |
Address
{
"value": "string",
"details": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
details | string¦null | false | read-only | Gets the details for the PII. |
AppendEvent
{
"eventSourceId": {
"value": "string",
"isSpecified": true
},
"eventType": {
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
},
"content": {
"property1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
},
"property2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
}
Represents the payload for appending an event.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
eventSourceId | EventSourceId | false | none | Represents the unique identifier of an instance of an event source. |
eventType | EventType | false | none | Represents the type of an event. |
content | object¦null | false | none | The content of the event represented as System.Text.Json.Nodes.JsonObject. |
» additionalProperties | JsonNode | false | none | none |
AppendedEvent
{
"metadata": {
"sequenceNumber": {
"value": 0
},
"type": {
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
}
},
"context": {
"eventSourceId": {
"value": "string",
"isSpecified": true
},
"sequenceNumber": {
"value": 0
},
"occurred": "2019-08-24T14:15:22Z",
"validFrom": "2019-08-24T14:15:22Z",
"tenantId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"correlationId": {
"value": "string"
},
"causationId": {
"value": "string"
},
"causedBy": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"observationState": 0
},
"content": {
"property1": null,
"property2": null
}
}
Represents an event that has been appended to an event log.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
metadata | EventMetadata | false | none | Represents the metadata related to an event. |
context | EventContext | false | none | Represents the context in which an event exists - typically what it was appended with. |
content | object¦null | false | none | The content in the form of an System.Dynamic.ExpandoObject. |
» additionalProperties | any | false | none | none |
AppendedEventWithJsonAsContent
{
"metadata": {
"sequenceNumber": {
"value": 0
},
"type": {
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
}
},
"context": {
"eventSourceId": {
"value": "string",
"isSpecified": true
},
"sequenceNumber": {
"value": 0
},
"occurred": "2019-08-24T14:15:22Z",
"validFrom": "2019-08-24T14:15:22Z",
"tenantId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"correlationId": {
"value": "string"
},
"causationId": {
"value": "string"
},
"causedBy": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"observationState": 0
},
"content": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
Represents an event that has been appended to an event log with the content as JSON.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
metadata | EventMetadata | false | none | Represents the metadata related to an event. |
context | EventContext | false | none | Represents the context in which an event exists - typically what it was appended with. |
content | JsonNode | false | none | none |
CausationId
{
"value": "string"
}
Represents an identifier for correlation.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
CausedBy
{
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
}
Represents an identifier of an identity that was the root of a cause.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
City
{
"value": "string",
"details": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
details | string¦null | false | read-only | Gets the details for the PII. |
ClientInformation
{
"clientVersion": "string",
"advertisedUri": "string"
}
Represents the information sent to the Kernel when connecting.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
clientVersion | string¦null | false | none | The version of the client. |
advertisedUri | string¦null | false | none | The URI that the client is advertised with. |
ClientObserverRegistration
{
"observerId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": {
"value": "string"
},
"eventSequenceId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344",
"isEventLog": true,
"isOutbox": true,
"isInbox": true
},
"eventTypes": [
{
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
}
]
}
Represents the registration of a single client observer.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
observerId | ObserverId | false | none | Concept that represents the unique identifier of an observer. |
name | ObserverName | false | none | Concept that represents the name of an observer. |
eventSequenceId | EventSequenceId | false | none | Represents the unique identifier of an event sequence. |
eventTypes | [EventType]¦null | false | none | The type of events the observer is interested in. |
ConnectionId
{
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
}
Represents the unique identifier for a connection for a client.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
CorrelationId
{
"value": "string"
}
Represents an identifier for correlation.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
Country
{
"value": "string",
"details": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
details | string¦null | false | read-only | Gets the details for the PII. |
CreateAndRegisterKeyFor
{
"identifier": {
"value": "string"
}
}
Encapsulation representing the creation and registration of a key for a specific identifier.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
identifier | EncryptionKeyIdentifier | false | none | Represents the unique identifier of an encryption key. |
DeletePIIForPerson
{
"personId": {
"value": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
personId | PersonId | false | none | Represents the concept of a unique identifier that identifies a person. |
EncryptionKeyIdentifier
{
"value": "string"
}
Represents the unique identifier of an encryption key.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
EventContext
{
"eventSourceId": {
"value": "string",
"isSpecified": true
},
"sequenceNumber": {
"value": 0
},
"occurred": "2019-08-24T14:15:22Z",
"validFrom": "2019-08-24T14:15:22Z",
"tenantId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"correlationId": {
"value": "string"
},
"causationId": {
"value": "string"
},
"causedBy": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"observationState": 0
}
Represents the context in which an event exists - typically what it was appended with.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
eventSourceId | EventSourceId | false | none | Represents the unique identifier of an instance of an event source. |
sequenceNumber | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
occurred | string(date-time) | false | none | |
validFrom | string(date-time) | false | none | |
tenantId | TenantId | false | none | Represents the unique identifier of a tenant in the system. |
correlationId | CorrelationId | false | none | Represents an identifier for correlation. |
causationId | CausationId | false | none | Represents an identifier for correlation. |
causedBy | CausedBy | false | none | Represents an identifier of an identity that was the root of a cause. |
observationState | EventObservationState | false | none | Represents the observation state for an event. |
EventGeneration
{
"value": 0
}
Represents the generation of an Aksio.Cratis.Events.EventType.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | integer(int32) | false | none | Gets or inits the underlying value for the instance. |
EventHistogramEntry
{
"date": "2019-08-24T14:15:22Z",
"count": 0
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
date | string(date-time) | false | none | none |
count | integer(int32) | false | none | none |
EventMetadata
{
"sequenceNumber": {
"value": 0
},
"type": {
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
}
}
Represents the metadata related to an event.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
sequenceNumber | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
type | EventType | false | none | Represents the type of an event. |
EventObservationState
0
Represents the observation state for an event.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integer(int32) | false | none | Represents the observation state for an event. |
Enumerated Values
Property | Value |
---|---|
anonymous | 0 |
anonymous | 1 |
anonymous | 2 |
anonymous | 4 |
anonymous | 8 |
EventSequenceId
{
"value": "a860a344-d7b2-406e-828e-8d442f23f344",
"isEventLog": true,
"isOutbox": true,
"isInbox": true
}
Represents the unique identifier of an event sequence.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
isEventLog | boolean | false | read-only | Get whether or not this is the default log event sequence. |
isOutbox | boolean | false | read-only | Get whether or not this is the default outbox event sequence. |
isInbox | boolean | false | read-only | Get whether or not this is the default outbox event sequence. |
EventSequenceInformation
{
"id": "string",
"name": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string¦null | false | none | none |
name | string¦null | false | none | none |
EventSequenceNumber
{
"value": 0
}
Represents the sequence number within an event log for an event.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | integer(int64) | false | none | Gets or inits the underlying value for the instance. |
EventSourceId
{
"value": "string",
"isSpecified": true
}
Represents the unique identifier of an instance of an event source.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
isSpecified | boolean | false | read-only | Check whether or not the Aksio.Cratis.Events.EventSourceId is specified. |
EventType
{
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
}
Represents the type of an event.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | EventTypeId | false | none | Represents the concept of the unique identifier of a type of event. |
generation | EventGeneration | false | none | Represents the generation of an Aksio.Cratis.Events.EventType. |
isPublic | boolean | false | none | Whether or not the event type is considered a public event. |
EventTypeId
{
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
}
Represents the concept of the unique identifier of a type of event.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
EventTypeInformation
{
"identifier": "string",
"name": "string",
"generations": 0
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
identifier | string¦null | false | none | none |
name | string¦null | false | none | none |
generations | integer(int32) | false | none | none |
EventTypeRegistration
{
"type": {
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
},
"friendlyName": "string",
"schema": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
Representation of an event type registration.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | EventType | false | none | Represents the type of an event. |
friendlyName | string¦null | false | none | A friendly name. |
schema | JsonNode | false | none | none |
FailedObserverPartition
{
"eventSourceId": {
"value": "string",
"isSpecified": true
},
"sequenceNumber": {
"value": 0
},
"occurred": "2019-08-24T14:15:22Z",
"lastAttempt": "2019-08-24T14:15:22Z",
"attempts": 0,
"messages": [
"string"
],
"stackTrace": "string"
}
Represents the state used for failed observers.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
eventSourceId | EventSourceId | false | none | Represents the unique identifier of an instance of an event source. |
sequenceNumber | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
occurred | string(date-time) | false | none | Gets or sets the occurred time of the failure - if any. |
lastAttempt | string(date-time) | false | none | Gets or sets the occurred time of the failure - if any. |
attempts | integer(int32) | false | none | Gets or sets the number of retry attempts it has had. |
messages | [string]¦null | false | none | Gets or sets the message from the failure - if any. |
stackTrace | string¦null | false | none | Gets or sets the stack trace from the failure - if any. |
FirstName
{
"value": "string",
"details": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
details | string¦null | false | read-only | Gets the details for the PII. |
IPropertyPathSegment
{
"value": "string"
}
Defines a segment within a Aksio.Cratis.Properties.PropertyPath.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | read-only | Gets the value that represents the segment. |
ImmediateProjection
{
"projectionId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"eventSequenceId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344",
"isEventLog": true,
"isOutbox": true,
"isInbox": true
},
"modelKey": {
"value": "string",
"isSpecified": true
},
"projection": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
Represents the payload for performing an immediate projection.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
projectionId | ProjectionId | false | none | Represents the unique identifier of a projection. |
eventSequenceId | EventSequenceId | false | none | Represents the unique identifier of an event sequence. |
modelKey | ModelKey | false | none | Represents the unique identifier of an instance of an event source. |
projection | JsonNode | false | none | none |
ImmediateProjectionResult
{
"model": {
"property1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
},
"property2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
},
"affectedProperties": [
{
"path": "string",
"segments": [
{
"value": "string"
}
],
"lastSegment": {
"value": "string"
},
"isRoot": true,
"isSet": true
}
],
"projectedEventsCount": 0
}
Represents the result of an Aksio.Cratis.Kernel.Grains.Projections.IImmediateProjection.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
model | object¦null | false | none | The Json representation of the model. |
» additionalProperties | JsonNode | false | none | none |
affectedProperties | [PropertyPath]¦null | false | none | Collection of properties that was set. |
projectedEventsCount | integer(int32) | false | none | Number of events that caused projection. |
JsonNode
{
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
},
"root": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
options | JsonNodeOptions | false | none | none |
parent | JsonNode | false | none | none |
root | JsonNode | false | none | none |
JsonNodeOptions
{
"propertyNameCaseInsensitive": true
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
propertyNameCaseInsensitive | boolean | false | none | none |
LastName
{
"value": "string",
"details": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
details | string¦null | false | read-only | Gets the details for the PII. |
Microservice
{
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | MicroserviceId | false | none | Represents the concept of the microservice identifier. |
name | string¦null | false | none | none |
MicroserviceId
{
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
}
Represents the concept of the microservice identifier.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
ModelKey
{
"value": "string",
"isSpecified": true
}
Represents the unique identifier of an instance of an event source.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
isSpecified | boolean | false | read-only | Check whether or not the Aksio.Cratis.Projections.ModelKey is specified. |
ModelName
{
"value": "string"
}
Represents the friendly display name of a model.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
ObserverId
{
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
}
Concept that represents the unique identifier of an observer.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
ObserverName
{
"value": "string"
}
Concept that represents the name of an observer.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
ObserverRunningState
0
Defines the status of an observer.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integer(int32) | false | none | Defines the status of an observer. |
Enumerated Values
Property | Value |
---|---|
anonymous | 0 |
anonymous | 1 |
anonymous | 2 |
anonymous | 3 |
anonymous | 4 |
anonymous | 5 |
anonymous | 6 |
anonymous | 7 |
anonymous | 8 |
anonymous | 9 |
anonymous | 10 |
anonymous | 11 |
ObserverState
{
"id": "string",
"eventTypes": [
{
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
}
],
"eventSequenceId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344",
"isEventLog": true,
"isOutbox": true,
"isInbox": true
},
"observerId": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": {
"value": "string"
},
"type": 0,
"nextEventSequenceNumber": {
"value": 0
},
"lastHandled": {
"value": 0
},
"runningState": 0,
"failedPartitions": [
{
"eventSourceId": {
"value": "string",
"isSpecified": true
},
"sequenceNumber": {
"value": 0
},
"occurred": "2019-08-24T14:15:22Z",
"lastAttempt": "2019-08-24T14:15:22Z",
"attempts": 0,
"messages": [
"string"
],
"stackTrace": "string"
}
],
"recoveringPartitions": [
{
"eventSourceId": {
"value": "string",
"isSpecified": true
},
"sequenceNumber": {
"value": 0
},
"startedRecoveryAt": "2019-08-24T14:15:22Z"
}
],
"hasFailedPartitions": true,
"isRecoveringAnyPartition": true,
"isDisconnected": true
}
Represents the state used for an observer.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string¦null | false | none | Gets or sets the identifier of the observer state. |
eventTypes | [EventType]¦null | false | none | Gets or sets the event types the observer is observing. |
eventSequenceId | EventSequenceId | false | none | Represents the unique identifier of an event sequence. |
observerId | ObserverId | false | none | Concept that represents the unique identifier of an observer. |
name | ObserverName | false | none | Concept that represents the name of an observer. |
type | ObserverType | false | none | Defines the different types of observers. |
nextEventSequenceNumber | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
lastHandled | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
runningState | ObserverRunningState | false | none | Defines the status of an observer. |
failedPartitions | [FailedObserverPartition]¦null | false | none | Gets or sets the failed partitions for the observer. |
recoveringPartitions | [RecoveringFailedObserverPartition]¦null | false | none | Gets or sets the failed partitions for the observer. |
hasFailedPartitions | boolean | false | read-only | Gets whether or not there are any failed partitions. |
isRecoveringAnyPartition | boolean | false | read-only | Gets whether or not there are any partitions being recovered. |
isDisconnected | boolean | false | read-only | Gets whether or not the observer is in disconnected state. Meaning that there is no subscriber to it. |
ObserverType
0
Defines the different types of observers.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integer(int32) | false | none | Defines the different types of observers. |
Enumerated Values
Property | Value |
---|---|
anonymous | 0 |
anonymous | 1 |
anonymous | 2 |
anonymous | 3 |
Person
{
"id": {
"value": "string"
},
"socialSecurityNumber": {
"value": "string",
"details": "string"
},
"firstName": {
"value": "string",
"details": "string"
},
"lastName": {
"value": "string",
"details": "string"
},
"address": {
"value": "string",
"details": "string"
},
"city": {
"value": "string",
"details": "string"
},
"postalCode": {
"value": "string",
"details": "string"
},
"country": {
"value": "string",
"details": "string"
},
"personalInformation": [
{
"identifier": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"type": {
"value": "string"
},
"value": {
"value": "string",
"details": "string"
}
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | PersonId | false | none | Represents the concept of a unique identifier that identifies a person. |
socialSecurityNumber | SocialSecurityNumber | false | none | none |
firstName | FirstName | false | none | none |
lastName | LastName | false | none | none |
address | Address | false | none | none |
city | City | false | none | none |
postalCode | PostalCode | false | none | none |
country | Country | false | none | none |
personalInformation | [PersonalInformation]¦null | false | none | none |
PersonId
{
"value": "string"
}
Represents the concept of a unique identifier that identifies a person.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
PersonalInformation
{
"identifier": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"type": {
"value": "string"
},
"value": {
"value": "string",
"details": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
identifier | PersonalInformationId | false | none | none |
type | PersonalInformationType | false | none | none |
value | PersonalInformationValue | false | none | none |
PersonalInformationId
{
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
PersonalInformationType
{
"value": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
PersonalInformationValue
{
"value": "string",
"details": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
details | string¦null | false | read-only | Gets the details for the PII. |
PostalCode
{
"value": "string",
"details": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
details | string¦null | false | read-only | Gets the details for the PII. |
Projection
{
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": {
"value": "string"
},
"modelName": {
"value": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | ProjectionId | false | none | Represents the unique identifier of a projection. |
name | ProjectionName | false | none | Represents the friendly display name of a projection. |
modelName | ModelName | false | none | Represents the friendly display name of a model. |
ProjectionCollection
{
"name": "string",
"documentCount": 0
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string¦null | false | none | none |
documentCount | integer(int32) | false | none | none |
ProjectionId
{
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
}
Represents the unique identifier of a projection.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
ProjectionName
{
"value": "string"
}
Represents the friendly display name of a projection.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
ProjectionRegistration
{
"projection": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
},
"pipeline": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
Represents a single projection registration.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
projection | JsonNode | false | none | none |
pipeline | JsonNode | false | none | none |
PropertyPath
{
"path": "string",
"segments": [
{
"value": "string"
}
],
"lastSegment": {
"value": "string"
},
"isRoot": true,
"isSet": true
}
Represents an encapsulation of a property in the system - used for accessing properties on objects.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
path | string¦null | false | none | Gets the full path of the property. |
segments | [IPropertyPathSegment]¦null | false | read-only | Gets the segments the full property path consists of. |
lastSegment | IPropertyPathSegment | false | none | Defines a segment within a Aksio.Cratis.Properties.PropertyPath. |
isRoot | boolean | false | read-only | Gets whether or not this is the root path. |
isSet | boolean | false | read-only | Gets whether or not the value is set. |
RecoveringFailedObserverPartition
{
"eventSourceId": {
"value": "string",
"isSpecified": true
},
"sequenceNumber": {
"value": 0
},
"startedRecoveryAt": "2019-08-24T14:15:22Z"
}
Represents the state used when recovering a failed observer partition.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
eventSourceId | EventSourceId | false | none | Represents the unique identifier of an instance of an event source. |
sequenceNumber | EventSequenceNumber | false | none | Represents the sequence number within an event log for an event. |
startedRecoveryAt | string(date-time) | false | none | Gets or sets the occurred time of the failure - if any. |
RegisterEventTypes
{
"types": [
{
"type": {
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"generation": {
"value": 0
},
"isPublic": true
},
"friendlyName": "string",
"schema": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
]
}
Payload for registering multiple event types.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
types | [EventTypeRegistration]¦null | false | none | Collection of Aksio.Cratis.Kernel.Domain.Projections.EventTypeRegistration. |
RegisterProjections
{
"projections": [
{
"projection": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
},
"pipeline": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
]
}
Represents the payload for registering projections.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
projections | [ProjectionRegistration]¦null | false | none | Collection of Aksio.Cratis.Kernel.Domain.Projections.ProjectionRegistration. |
SocialSecurityNumber
{
"value": "string",
"details": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string¦null | false | none | Gets or inits the underlying value for the instance. |
details | string¦null | false | read-only | Gets the details for the PII. |
StorageForMicroservice
{
"shared": {
"property1": {
"type": "string",
"connectionDetails": null
},
"property2": {
"type": "string",
"connectionDetails": null
}
},
"tenants": {
"property1": {
"property1": {
"type": "string",
"connectionDetails": null
},
"property2": {
"type": "string",
"connectionDetails": null
}
},
"property2": {
"property1": {
"type": "string",
"connectionDetails": null
},
"property2": {
"type": "string",
"connectionDetails": null
}
}
}
}
Represents all storage configurations for all
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
shared | object¦null | false | none | The shared database connection configurations for the microservice. |
» additionalProperties | StorageType | false | none | Represents the configuration for a specific shared storage type. |
tenants | object¦null | false | none | The tenant specific configuration. |
» additionalProperties | object | false | none | Represents the shared storage configuration for all |
»» additionalProperties | StorageType | false | none | Represents the configuration for a specific shared storage type. |
StorageType
{
"type": "string",
"connectionDetails": null
}
Represents the configuration for a specific shared storage type.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | string¦null | false | none | The type of storage used. |
connectionDetails | any | false | none | Gets the provider type specific connection details. |
StringStringKeyValuePair
{
"key": "string",
"value": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
key | string¦null | false | none | none |
value | string¦null | false | none | none |
TenantId
{
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
}
Represents the unique identifier of a tenant in the system.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string(uuid) | false | none | Gets or inits the underlying value for the instance. |
TenantInfo
{
"id": {
"value": "a860a344-d7b2-406e-828e-8d442f23f344"
},
"name": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | TenantId | false | none | Represents the unique identifier of a tenant in the system. |
name | string¦null | false | none | none |