Query data and display it with a given projection.
| Method and Path | Description | ||
|---|---|---|---|
| POST | /query | ||
| Method and Path | Description | ||
|---|---|---|---|
| GET | /views | ||
| GET | /views/:guid | ||
| POST | /views | ||
| PUT | /views/:guid | ||
| DELETE | /views/:guid | ||
| https://app.apibuilder.io/nccloud/common/latest/service.json |
A type for a topic's schema field.
| Name | Value | Description |
|---|---|---|
| boolean | boolean | |
| date-iso8601 | date-iso8601 | |
| date-time-iso8601 | date-time-iso8601 | |
| decimal | decimal | |
| double | double | |
| integer | integer | |
| long | long | |
| string | string | |
| uuid | uuid | |
| object | object | Note: when a type is set to |
Interfaces: None
Deletes a reporting entity defined by its tracking_id.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| tracking_id | string | Yes | - | A unique id, which identifies the association of multiple events. This can i.e. be a user guid, for events related to a user. It is important, that this id is unique and immutable.
|
| audit | de.nccloud.common.v0.models.audit:0.0.1 | Yes | - | Audit information about this event.
|
Interfaces: None
Single field of a topic schema. A field can be used for projecting, filtering and sorting in reports.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| type | scalar_type | Yes | - | The (scalar) type of the field. Fields can only be primitive types.
|
| is_array | boolean | Yes | - | Setting this to
|
| fields | map[field] | No | - | Nested fields for type
|
| label | string | No | - | A human-readable label for the field.
|
| description | string | No | - | A human-readable description of the field.
|
Interfaces: None
Defines a condition for values.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| expression | string | No | - | An SQL-like expression.
|
| variables | map[json] | No | - | A map of values, which can be used in the expression. Variables can be access by prepending them with
|
Interfaces: None
A single field of a projection schema.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| label | string | No | - | A human-readable label for the field.
|
| description | string | No | - | A human-readable description for the field.
|
| source | projection_field_source | No | - | The source of the field. Either
|
| fields | map[projection_field] | No | - | Defines nested fields for this projection. Either
|
Interfaces: None
Represents the source for a single projection field from a topic's schema.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| topic | string | Yes | - | Name of the originating topic.
|
| path | string | Yes | - | A slimmed down variant of JSON Path to point to a specific field in a topic's schema.
|
| filter | string | Yes | - | A conditional filter expression. The expression can contain variables, which will be passed in when evaluating the projection.
|
Interfaces: None
Form for querying and projecting data.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| view | string | No | - | The name of a defined
|
| projection | map[projection_field] | No | - | Projected fields to return. Either
|
| variables | map[json] | Yes | - | Variables to pass to the projection or the view.
|
| sort | [de.nccloud.common.v0.models.sort:0.0.1] | No | - | The defined properties refer to the fields of the projection.
|
Interfaces: None
The result of a query, returning data in a projected form.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| page | de.nccloud.common.v0.models.page_response:0.0.1 | Yes | - |
|
| data | object | Yes | - | The returned data in the projected form.
|
Interfaces: None
Represents a single topic, which will be consumed by the reporting service.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | Yes | - |
|
| service | de.nccloud.common.v0.models.service_info:0.0.1 | Yes | - | Info about the producing service.
|
| schema | map[field] | Yes | - | The schema of the topics' provided data.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| page | de.nccloud.common.v0.models.page_response:0.0.1 | Yes | - |
|
| data | [topic] | Yes | - |
|
Interfaces: None
Updates one or more data fields.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| tracking_id | string | Yes | - | A unique id, which identifies the association of multiple events. This can i.e. be a user guid, for events related to a user. It is important, that this id is unique and immutable.
|
| payload | object | Yes | - | One or more fields defined in the reporting schema, which will be updated.
|
| audit | de.nccloud.common.v0.models.audit:0.0.1 | Yes | - | Audit information about this event.
|
Interfaces: None
A stored view containing data from one or more topics.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| guid | uuid | Yes | - | Globally unique identifier of the projection.
|
| name | string | Yes | - | Name of this projection used to reference it in a human-friendly way. The name must be unique.
|
| projection | map[projection_field] | Yes | - | Projected fields of this view.
|
| variables | map[scalar_type] | Yes | - | Definition of variables which can be passed to the view. All
|
Interfaces: None
Form for creating a new view.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | Yes | - | Name of the view.
|
| projection | map[projection_field] | Yes | - | Projected fields of this view.
|
| variables | map[scalar_type] | Yes | - | Definition of variables which can be passed to the view. All
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| page | de.nccloud.common.v0.models.page_response:0.0.1 | Yes | - |
|
| data | [view] | Yes | - |
|
Interfaces: None
| Type | Discriminator Value | Example Json | Description |
|---|---|---|---|
| update_event | update_event | Minimal | Full |
|
| delete_event | delete_event | Minimal | Full |
|