GraphQL API Reference¶
EXPERIMENTAL
All non documented attributes, types, queries and mutations have to be considered as EXPERIMENTAL.
Query¶
Field | Argument | Type | Description |
---|---|---|---|
resourceGroups | ResourceGroupConnection | List of ResourceGroups. | |
first | Int | Returns up to the first n elements from the list. | |
after | String | Returns the elements that come after the specified cursor. | |
parentId | String | EXPERIMENTAL: filter by parent ResourceGroup. | |
filterText | String | EXPERIMENTAL: filter by predicates. | |
privilege | PrivilegeType | EXPERIMENTAL: filter for privilege. | |
resourceEntity | ResourceEntityType | EXPERIMENTAL: filter for resource entity type (for permission). | |
resourceGroupById | ResourceGroup | Query for ResourceGroup by ID. | |
self | ResourceGroupRef | ||
transportTypes | TransportTypeConnection | List of Transport Types. | |
first | Int | Returns up to the first n elements from the list. | |
after | String | Returns the elements that come after the specified cursor. | |
transports | TransportConnection | List of Transports. | |
first | Int | Returns up to the first n elements from the list. | |
after | String | Returns the elements that come after the specified cursor. | |
path | String | filter by path | |
filterText | String | EXPERIMENTAL: filter by predicates. | |
privilege | PrivilegeType | EXPERIMENTAL: filter for privilege. | |
transportById | Transport | Query for Transport by ID. | |
self | BaseRef | ||
agents | AgentConnection | List of Agents. | |
first | Int | Returns up to the first n elements from the list. | |
after | String | Returns the elements that come after the specified cursor. | |
path | String | filter by path | |
filterText | String | EXPERIMENTAL: filter by predicates. | |
privilege | PrivilegeType | EXPERIMENTAL: filter for privilege. | |
agentById | Agent | One Agent | |
self | AgentRef | ||
dataPorts | DataPortConnection! | List of DataPort. | |
first | Int | Returns up to the first n elements from the list. | |
after | String | Returns the elements that come after the specified cursor. | |
path | String | filter by path | |
transportId | String | EXPERIMENTAL: filter by Transport ID. | |
filterText | String | EXPERIMENTAL: filter by predicates | |
privilege | PrivilegeType | EXPERIMENTAL: filter for privilege. | |
dataPortById | DataPort | Query for DataPort by ID. | |
self | DataPortRef | ||
dataItems | DataItemConnection! | EXPERIMENTAL: List of DataItem. | |
first | Int | Returns up to the first n elements from the list. | |
after | String | Returns the elements that come after the specified cursor. | |
dataPortRef | DataPortRef | filter by data port | |
dataItemById | DataItem | Query for DataItem by ID. | |
self | DataItemRef | ||
dataOffers | DataOffersConnection | List of DataOffers. | |
first | Int | Returns up to the first n elements from the list. | |
after | String | Returns the elements that come after the specified cursor. | |
path | String | filter by path | |
filterText | String | EXPERIMENTAL: filter by predicates. | |
filterPath | String | EXPERIMENTAL: filter by Path. | |
privilege | PrivilegeType | EXPERIMENTAL: filter for privilege. | |
filterOwnerRef | String | EXPERIMENTAL: filter by owner. | |
onlyFollowed | Boolean | ||
dataOfferById | DataOffer | Query for DataOffer by ID. | |
self | DataOfferRef | ||
dataSubscriptionStates | DataSubscriptionStatesConnection | List of DataSubscriptionStates. | |
first | Int | Returns up to the first n elements from the list. | |
after | String | Returns the elements that come after the specified cursor. | |
path | String | filter by path | |
transportId | String | EXPERIMENTAL: filter by Transport ID. | |
dataPortRef | DataPortRef | ||
withDataOfferOnly | Boolean | EXPERIMENTAL: filter for DataSubscriptionStates with a claimed DataPort () | |
filterText | String | EXPERIMENTAL: filter by predicates | |
privilege | PrivilegeType | EXPERIMENTAL: filter for privilege. | |
dataSubscriptionStateById | DataSubscriptionState | Query for DataSubscriptionState by ID. | |
self | DataSubscriptionStateRef | ||
history | HistoryConnection | ||
first | Int | ||
after | String | ||
entityIdList | [String] | ||
ownerIdList | [String] | ||
organizations | OrganizationsConnection | ||
first | Int | ||
after | String | ||
organizationByIdOrName | Organization | ||
id | String | ||
name | String | ||
subjects | SubjectsConnection | ||
organization | String | ||
filterText | String | ||
filterSubjectType | SubjectType | ||
first | Int | ||
after | String | ||
users | UsersConnection | ||
first | Int | ||
after | String | ||
organization | String! | ||
userById | User | ||
id | String! | ||
userGroups | UserGroupsConnection | ||
first | Int | ||
after | String | ||
organization | String! | ||
userGroupById | UserGroup | ||
id | String! | ||
technicalUsers | TechnicalUsersConnection | ||
first | Int | ||
after | String | ||
organization | String! | ||
currentUser | User | Query for current User. | |
permissions | PermissionConnection | List of Permissions. | |
first | Int | Returns up to the first n elements from the list. | |
after | String | Returns the elements that come after the specified cursor. | |
path | String | ||
subjectRef | SubjectRefInput | ||
dataSourceNodeById | DataSourceNode! | topology | |
id | String! | ||
dataSourceNodeByDataPortId | DataSourceNode! | ||
id | String! | ||
dataSinkNodeById | DataSinkNode! | ||
id | String! | ||
dataSinkNodeByDataSubscriptionStateId | DataSinkNode! | ||
id | String! | ||
applicationInfo | ApplicationInfo | ||
uiConfiguration | UiConfiguration | ||
organizationName | String! | ||
getFollowEntityByUser | FollowEntityConnection | ||
isUserFollowingEntity | Boolean | ||
entityRef | FollowEntityInput | ||
search | SearchItemsConnection | ||
search | SearchInput | ||
activities | ActivitiesConnection | ||
input | ActivitiesInput | ||
getNotificationChannelsConfiguration | [NotificationConfiguration!]! |
Mutation¶
Field | Argument | Type | Description |
---|---|---|---|
createResourceGroup | ResourceGroup | ||
input | ResourceGroupInput! | ||
updateResourceGroup | ResourceGroup | ||
input | ResourceGroupUpdate! | ||
deleteResourceGroup | String | ||
self | ResourceGroupRef | ||
createTransport | Transport | ||
input | TransportInput! | ||
deleteTransport | String | ||
self | BaseRef | ||
createAgent | SaveAgentResponse | ||
input | AgentInput! | ||
deleteAgent | String | ||
id | String! | ||
technicalUserId | String! | ||
saveDataPort | DataPort | ||
input | DataPortSave! | ||
deleteDataPort | String | ||
self | DataPortRef | ||
saveDataItem | DataItem | ||
input | DataItemSave! | ||
deleteDataItem | String | ||
self | DataItemRef | ||
createDataOffer | DataOffer | ||
input | DataOfferInput! | ||
updateDataOffer | DataOffer | ||
input | DataOfferUpdate! | ||
saveDataOffer | DataOffer! | ||
input | DataOfferChange! | ||
deleteDataOffer | String | ||
self | DataOfferRef | ||
followEntity | Boolean | ||
input | FollowEntityInput | ||
unFollowEntity | Boolean | ||
input | FollowEntityInput | ||
saveDataSubscriptionState | DataSubscriptionState | ||
input | DataSubscriptionStateSave! | ||
deleteDataSubscriptionState | String | ||
self | DataSubscriptionStateRef | ||
savePermission | Permission | ||
input | PermissionInput! | ||
unsetPermission | String | ||
input | PermissionUnsetInput! | ||
createIssue | Issue | ||
input | IssueInput! | ||
saveDataSourceNode | DataSourceNode | topology | |
id | ID | ||
input | DataSourceNodeInput | ||
deleteDataSourceNode | String | ||
id | ID | ||
saveDataSinkNode | DataSinkNode | ||
id | ID | ||
input | DataSinkNodeInput | ||
deleteDataSinkNode | String | ||
id | ID | ||
saveContainerNode | ContainerNode | ||
id | ID | ||
input | ContainerNodeInput | ||
deleteContainerNode | String | ||
id | ID | ||
saveOrganization | Organization! | organizations | |
input | OrganizationChangeInput | ||
saveUser | User! | users and groups | |
input | UserChangeInput! | ||
saveTechnicalUser | SaveTechnicalUserResponse! | ||
input | TechnicalUserChangeInput! | ||
deleteTechnicalUser | String | ||
id | String! | ||
saveUserGroup | UserGroup! | ||
input | UserGroupChangeInput! | ||
deleteUserGroup | String | ||
id | String! | ||
resetPasswordTechnicalUser | ResetPasswordTechnicalUserResponse! | ||
id | String! | ||
inviteUserToOrganization | String | ||
input | InviteUserToOrganizationInput! | ||
removeUserFromOrganization | String | ||
input | RemoveUserFromOrganizationInput! | ||
saveSchema | DataSchema! | schemas | |
input | SchemaInput! | ||
updateNotificationChannelsConfiguration | NotificationConfiguration | ||
input | UpdateNotificationChannelConfigurationInput | ||
deleteNotificationChannelConfiguration | Boolean | ||
id | String |
Objects¶
ActionMetaInfo¶
Field | Argument | Type | Description |
---|---|---|---|
username | String | ||
timestamp | GraphQLDateTime |
ActivitiesConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [Activity] |
Activity¶
Field | Argument | Type | Description |
---|---|---|---|
id | String! | ||
activityType | ActivityType! | ||
triggeredBy | Subject | ||
affectedEntityRef | ResourceEntityRef! | ||
affectedEntity | AffectedEntity | ||
message | String | ||
changeInfo | ChangeInfo | ||
timestamp | GraphQLDateTime! |
ActivityFilter¶
Field | Argument | Type | Description |
---|---|---|---|
activityType | ActivityType | ||
path | String | ||
entityType | ResourceEntityType |
Agent¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
label ⚠️ | String |
⚠️ DEPRECATED use name |
|
name | String! | ||
path | String! | ||
resourceGroup ⚠️ | ResourceGroup |
⚠️ DEPRECATED use path |
|
resourceGroupId ⚠️ | String |
⚠️ DEPRECATED use path |
|
privilegeInformation | PrivilegeInformation | ||
username | ID! | ||
technicalUserId | String | ||
lastSeen | GraphQLDateTime | ||
metrics | AgentMetrics | ||
from | GraphQLDateTime | ||
to | GraphQLDateTime |
AgentConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [Agent] |
AgentMetrics¶
Field | Argument | Type | Description |
---|---|---|---|
agentUptimeMs | Metrics | ||
loopTimeMs | Metrics | ||
loopPercent | Metrics | ||
memoryUsageBytes | Metrics | ||
cpuUsagePercent | Metrics | ||
loopsCounter | Metrics |
ApplicationInfo¶
Field | Argument | Type | Description |
---|---|---|---|
components | [ComponentVersion] |
ComponentVersion¶
Field | Argument | Type | Description |
---|---|---|---|
name | String | ||
version | String |
ContainerNode¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
label | String | ||
containerNodeId | ID | ||
containerNode | ContainerNode | ||
topologyNodes | TopologyNodeConnection |
DataItem¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String! | ||
label | String | ||
deleted | Boolean! | ||
metrics | DataPortMetrics | ||
from | GraphQLDateTime | ||
to | GraphQLDateTime | ||
dataProfile | DataProfile | ||
dataPortId | String | ||
dataPort | DataPort | ||
transportUrl | String | ||
tags | [String!] | ||
_properties | [KeyValuePair!] | ||
properties | [ResourceProperty!] | ||
typeFilter | [PropertyDataType] | ||
metaInfo | MetaInfo | ||
currentSchemas | [DataSchema!] |
DataItemConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [DataItem] |
DataOffer¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String! | ||
label | String | ||
description | String | ||
shortDescription | String | ||
owner | Subject | ||
ownerId | String | ||
ownerEmail | String | ||
metaInfo | MetaInfo | ||
_properties | [KeyValuePair!] | ||
properties | [ResourceProperty!] | ||
typeFilter | [PropertyDataType] | ||
dataPortId | ID | ||
dataPort | DataPort | ||
tags | [String!] | ||
path | String! | ||
resourceGroupId ⚠️ | ID |
⚠️ DEPRECATED use path |
|
resourceGroup ⚠️ | ResourceGroup |
⚠️ DEPRECATED use path |
|
privilegeInformation | PrivilegeInformation | ||
isFollowing | Boolean | ||
followEntityUsersCount | Int |
DataOffersConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [DataOffer] |
DataPoint¶
Field | Argument | Type | Description |
---|---|---|---|
dateTime | GraphQLDateTime! | ||
avg | Float! |
DataPort¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String! | ||
deleted | Boolean! | ||
label | String | ||
metrics | DataPortMetrics | ||
from | GraphQLDateTime | ||
to | GraphQLDateTime | ||
dataProfile | DataProfile | ||
transportUrl | String | ||
transportId | ID | ||
transport | Transport | ||
tags | [String!] | ||
_properties | [KeyValuePair!] | ||
properties | [ResourceProperty!] | ||
typeFilter | [PropertyDataType] | ||
dataOfferId | ID | ||
dataOffer | DataOffer | ||
path | String! | ||
resourceGroupId ⚠️ | ID |
⚠️ DEPRECATED use path |
|
resourceGroup ⚠️ | ResourceGroup |
⚠️ DEPRECATED use path |
|
metaInfo | MetaInfo | ||
currentSchemas | [DataSchema!] | ||
dataSourceNodeId | ID | ||
dataSourceNode | DataSourceNode | ||
privilegeInformation | PrivilegeInformation | ||
dataItems | [DataItem!] | ||
agent | Agent |
DataPortConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [DataPort] |
DataPortMetrics¶
Field | Argument | Type | Description |
---|---|---|---|
messagesPerSecond | Metrics | ||
bytesPerSecond | Metrics |
DataProfile¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
jsonSchema | JSONObject | ||
htmlBlobId | String | ||
reportingTimestamp | GraphQLDateTime | ||
samplesCount | Int | ||
error | DataProfilingError | ||
privilegeInformation | PrivilegeInformation |
DataProfilingError¶
Field | Argument | Type | Description |
---|---|---|---|
type | DataProfilingErrorType | ||
message | String |
DataSchema¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
source | SchemaSource | ||
encoding | SchemaEncoding | ||
content | String | ||
createdAt | String | ||
lastSeen | String | ||
entityRef | ResourceEntityRef | ||
entity | EntityWithSchema | ||
path | String! | ||
keyEncoding | SchemaEncoding | ||
keyContent | String |
DataSinkNode¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
label | String | ||
containerNodeId | ID | ||
containerNode | ContainerNode | ||
resourceId | ID | ||
resource | DataSubscriptionState | ||
dataSourceNodeId | ID | ||
dataSourceNode | DataSourceNode |
DataSinkNodeConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo! | ||
nodes | [DataSinkNode]! |
DataSourceNode¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
label | String | ||
containerNodeId | ID | ||
containerNode | ContainerNode | ||
resourceId | ID | ||
resource | DataPort | ||
dataSinkNodes | DataSinkNodeConnection |
DataSubscriptionState¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String! | ||
label | String | ||
_properties | [KeyValuePair!] | ||
properties | [ResourceProperty!] | ||
typeFilter | [PropertyDataType] | ||
transportUrl | String | ||
transportId | ID | ||
transport | Transport | ||
dataPortId | ID | ||
dataPort | DataPort | ||
metrics | DataSubscriptionStateMetrics | ||
from | GraphQLDateTime | ||
to | GraphQLDateTime | ||
deleted | Boolean | ||
metaInfo | MetaInfo | ||
path | String | ||
resourceGroupId ⚠️ | ID |
⚠️ DEPRECATED use path |
|
resourceGroup ⚠️ | ResourceGroup |
⚠️ DEPRECATED use path |
|
tags | [String!] | ||
dataSinkNodeId | ID | ||
dataSinkNode | DataSinkNode | ||
privilegeInformation | PrivilegeInformation |
DataSubscriptionStateMetrics¶
Field | Argument | Type | Description |
---|---|---|---|
messagesPerSecond | Metrics | ||
messagesLag | Metrics | Message lag between producer (DataPort) and consumer (DataSubscriptionState). The aggregation parameter is related to the grouping per partition (if any). | |
bytesPerSecond | Metrics |
DataSubscriptionStatesConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [DataSubscriptionState] |
EmailConfiguration¶
Field | Argument | Type | Description |
---|---|---|---|
String |
EntityConfiguration¶
Field | Argument | Type | Description |
---|---|---|---|
dataOffer | ResourceEntityConfiguration | ||
dataPort | ResourceEntityConfiguration | ||
dataSubscriptionState | ResourceEntityConfiguration |
FollowEntity¶
Field | Argument | Type | Description |
---|---|---|---|
id | String | ||
entityRef | ResourceEntityRef |
FollowEntityConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [FollowEntity] |
GenericTextChangeInfo¶
Field | Argument | Type | Description |
---|---|---|---|
previousValue | String | ||
newValue | String | ||
fieldName | String |
History¶
Field | Argument | Type | Description |
---|---|---|---|
source | HistoryEntity | ||
eventType | HistoryEventType | ||
timestamp | GraphQLDateTime | ||
username | String |
HistoryConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [History] |
HistoryEntity¶
Field | Argument | Type | Description |
---|---|---|---|
id | String | ||
entityType | ResourceEntityType |
Issue¶
Field | Argument | Type | Description |
---|---|---|---|
id | String | ||
key | String | ||
self | String |
KeyValuePair¶
Field | Argument | Type | Description |
---|---|---|---|
key | String! | ||
value | String |
MetaInfo¶
Field | Argument | Type | Description |
---|---|---|---|
created | ActionMetaInfo | ||
lastModification | ActionMetaInfo |
Metrics¶
Field | Argument | Type | Description |
---|---|---|---|
values | [DataPoint] | ||
avg | Float | ||
max | Float | ||
min | Float | ||
sum | Float |
NotificationConfiguration¶
Field | Argument | Type | Description |
---|---|---|---|
id | String! | ||
label | String! | ||
activityFilters | [ActivityFilter]! | ||
configuration | Configuration! |
Organization¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String | ||
properties | [KeyValuePair!] | ||
privilegeInformation | PrivilegeInformation |
OrganizationsConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [Organization] |
OwnerChangeInfo¶
Field | Argument | Type | Description |
---|---|---|---|
previousOwnerId | String | ||
previousOwner | Subject | ||
newOwnerId | String | ||
newOwner | Subject |
PageInfo¶
Field | Argument | Type | Description |
---|---|---|---|
endCursor | String |
Permission¶
Field | Argument | Type | Description |
---|---|---|---|
subjectRef | SubjectRef! | ||
path | String! | ||
privileges | [PrivilegeType!]! | ||
metaInfo | MetaInfo | ||
privilegeInformation | PrivilegeInformation |
PermissionConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo! | ||
nodes | [Permission!]! |
PermissionsOverview¶
Field | Argument | Type | Description |
---|---|---|---|
canWriteDataOffer | Boolean |
PrivilegeInformation¶
Field | Argument | Type | Description |
---|---|---|---|
privileges | [PrivilegeType!]! | ||
path | String! |
PropertyDefinition¶
Field | Argument | Type | Description |
---|---|---|---|
key | String | ||
label | String | ||
type | PropertyDataType | ||
showAlways | Boolean | ||
editable | Boolean | ||
blacklisted | Boolean |
RemovedSearchItem¶
Field | Argument | Type | Description |
---|---|---|---|
ref | ResourceEntityRef |
ResetPasswordTechnicalUserResponse¶
Field | Argument | Type | Description |
---|---|---|---|
technicalUser | TechnicalUser | ||
credentials | TechnicalUserCredentials |
ResourceEntityConfiguration¶
Field | Argument | Type | Description |
---|---|---|---|
propertyDefinitions | [ResourcePropertyValueDefinition!] |
ResourceEntityRef¶
Field | Argument | Type | Description |
---|---|---|---|
type | ResourceEntityType! | ||
id | ID! |
ResourceGroup¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String! | ||
path | String! | ||
parentId | ID | ||
parent | ResourceGroup | ||
privileges | [PrivilegeType!] | ||
privilegeInformation | PrivilegeInformation | ||
dataOffersCount | Int! | ||
filterText | String | ||
filterOwnerRef | String | ||
onlyFollowed | Boolean |
ResourceGroupChangeInfo¶
Field | Argument | Type | Description |
---|---|---|---|
previousResourceGroupId | String | ||
previousResourceGroup | ResourceGroup | ||
newResourceGroupId | String | ||
newResourceGroup | ResourceGroup |
ResourceGroupConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [ResourceGroup] |
ResourceProperty¶
Field | Argument | Type | Description |
---|---|---|---|
key | String! | ||
value | String | ||
label | String | ||
shortDescription | String | ||
icon | String | ||
type | PropertyDataType! | ||
editable | Boolean! | ||
transportMatching | Boolean! |
ResourcePropertyValueDefinition¶
Field | Argument | Type | Description |
---|---|---|---|
resourceEntityType | ResourceEntityType! | ||
key | String! | ||
label | String! | ||
shortDescription | String | ||
icon | String | ||
type | PropertyDataType! | ||
editable | Boolean! |
SaveAgentResponse¶
Field | Argument | Type | Description |
---|---|---|---|
agent | Agent | ||
technicalUser | SaveTechnicalUserResponse |
SaveTechnicalUserResponse¶
Field | Argument | Type | Description |
---|---|---|---|
technicalUser | TechnicalUser | ||
credentials | TechnicalUserCredentials |
SearchItem¶
Field | Argument | Type | Description |
---|---|---|---|
ref | ResourceEntityRef | ||
entity | SearchableEntity |
SearchItemsConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [SearchItem] |
SectionDefinition¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID | ||
title | String | ||
properties | [PropertyDefinition] |
SubjectRef¶
Field | Argument | Type | Description |
---|---|---|---|
id | String | ||
name | String! |
SubjectsConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [Subject] |
TechnicalUser¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
label | String | ||
username | String | ||
organization | String | ||
privilegeInformation | PrivilegeInformation |
TechnicalUserCredentials¶
Field | Argument | Type | Description |
---|---|---|---|
secret | String |
TechnicalUsersConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [TechnicalUser] |
TopologyNodeConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo! | ||
nodes | [TopologyNode]! |
Transport¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String! | ||
label ⚠️ | String |
⚠️ DEPRECATED use name |
|
path | String! | ||
resourceGroup ⚠️ | ResourceGroup |
⚠️ DEPRECATED use path |
|
resourceGroupId ⚠️ | String |
⚠️ DEPRECATED use path |
|
transportType | TransportType | ||
privilegeInformation | PrivilegeInformation | ||
properties | [KeyValuePair!] |
TransportConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [Transport] |
TransportType¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String! | ||
label | String | ||
dataType | TransportDataType | ||
configTemplateDockerCompose | String |
TransportTypeConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [TransportType] |
UiConfiguration¶
Field | Argument | Type | Description |
---|---|---|---|
entityConfiguration | EntityConfiguration |
User¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
firstName | String | ||
lastName | String | ||
String | |||
username | String | ||
organizations | [String!] | ||
groups | [UserGroup!] | ||
avatarUrl | String | ||
properties | [KeyValuePair!] | ||
permissionsOverview | PermissionsOverview | ||
permissions | [Permission!] |
UserGroup¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String | ||
label | String | ||
String | |||
organization | String | ||
avatarUrl | String | ||
properties | [KeyValuePair!] | ||
privilegeInformation | PrivilegeInformation | ||
users | [User!] |
UserGroupsConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [UserGroup] |
UsersConnection¶
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo | ||
nodes | [User] |
WebhookConfiguration¶
Field | Argument | Type | Description |
---|---|---|---|
webhookUrl | String | ||
webhookHeaders | [KeyValuePair] |
Inputs¶
ActivitiesInput¶
Field | Type | Description | |
---|---|---|---|
first | Int | ||
after | String | ||
resourceEntityRefIdList | [String] |
ActivityFilterInput¶
Field | Type | Description | |
---|---|---|---|
activityType | ActivityType | ||
path | String | ||
entityType | ResourceEntityType |
AgentInput¶
Field | Type | Description | |
---|---|---|---|
name | String! | ||
path | String! | ||
organization | String! |
AgentRef¶
Field | Type | Description | |
---|---|---|---|
idPath | IdPathRef | ||
username | String |
BaseRef¶
Field | Type | Description | |
---|---|---|---|
idPath | IdPathRef |
ContainerNodeInput¶
Field | Type | Description | |
---|---|---|---|
label | String | ||
containerNodeId | ID |
DataItemRef¶
Field | Type | Description | |
---|---|---|---|
idPath | IdPathRef | ||
properties | StateMatchingProperties |
DataItemSave¶
Field | Type | Description | |
---|---|---|---|
self | DataItemRef | ||
name | String | ||
label | String | ||
dataPortRef | DataPortRef | ||
transportUrl | String | ||
tags | [String!] | ||
path | String | ||
properties | [KeyValuePairInput] |
DataOfferChange¶
Field | Type | Description | |
---|---|---|---|
self | DataOfferRef! | ||
name | String | ||
label | String | ||
shortDescription | String | ||
description | String | ||
ownerRef | String | ||
dataPort | DataPortRef | ||
path | String | ||
tags | [String!] | ||
properties | [KeyValuePairInput] |
DataOfferInput¶
Field | Type | Description | |
---|---|---|---|
name | String | ||
label | String | ||
shortDescription | String | ||
description | String | ||
ownerRef | String | ||
dataPortRef | DataPortRef | ||
path | String | ||
tags | [String!] | ||
properties | [KeyValuePairInput] |
DataOfferRef¶
Field | Type | Description | |
---|---|---|---|
idPath | IdPathRef | ||
port | DataPortRef |
DataOfferStateRef¶
Deprecated use DataPortRef instead
Field | Type | Description | |
---|---|---|---|
idPath | IdPathRef | ||
properties | StateMatchingProperties |
DataOfferUpdate¶
Field | Type | Description | |
---|---|---|---|
id | String! | ||
name | String | ||
label | String | ||
shortDescription | String | ||
description | String | ||
ownerRef | String | ||
tags | [String!] | ||
properties | [KeyValuePairInput] | ||
path | String |
DataPortRef¶
Field | Type | Description | |
---|---|---|---|
idPath | IdPathRef | ||
properties | StateMatchingProperties |
DataPortSave¶
Field | Type | Description | |
---|---|---|---|
self | DataPortRef | ||
name | String | ||
label | String | ||
path | String | ||
transportUrl | String | ||
transportRef | BaseRef | ||
tags | [String!] | ||
properties | [KeyValuePairInput] |
DataSinkNodeInput¶
Field | Type | Description | |
---|---|---|---|
label | String | ||
containerNodeId | ID | ||
resourceId | ID | ||
dataSourceNodeId | ID |
DataSourceNodeInput¶
Field | Type | Description | |
---|---|---|---|
label | String | ||
containerNodeId | ID | ||
resourceId | ID |
DataSubscriptionStateRef¶
Field | Type | Description | |
---|---|---|---|
idPath | IdPathRef | ||
properties | StateMatchingProperties |
DataSubscriptionStateSave¶
Field | Type | Description | |
---|---|---|---|
self | DataSubscriptionStateRef | ||
name | String | ||
label | String | ||
transportUrl | String | ||
dataPortRef | DataPortRef | ||
tags | [String!] | ||
path | String | ||
properties | [KeyValuePairInput] |
EmailConfigurationInput¶
Field | Type | Description | |
---|---|---|---|
String! |
FollowEntityInput¶
Field | Type | Description | |
---|---|---|---|
entityType | ResourceEntityType! | ||
entityId | ID! |
IdPathRef¶
Field | Type | Description | |
---|---|---|---|
id | String | ||
path | String |
InviteUserToOrganizationInput¶
Field | Type | Description | |
---|---|---|---|
organizationName | String! | ||
String! | |||
privilege | PrivilegeType |
IssueInput¶
Field | Type | Description | |
---|---|---|---|
summary | String! | ||
description | String! | ||
reporter | String! | ||
labels | [String] |
KeyValuePairInput¶
Field | Type | Description | |
---|---|---|---|
key | String! | ||
value | String |
NotificationConfigurationInput¶
Field | Type | Description | |
---|---|---|---|
id | String | ||
label | String! | ||
activityFilters | [ActivityFilterInput] | ||
webhookConfiguration | WebhookConfigurationInput | ||
emailConfiguration | EmailConfigurationInput |
OrganizationChangeInput¶
Field | Type | Description | |
---|---|---|---|
id | String | ||
name | String | ||
properties | [KeyValuePairInput] |
PermissionInput¶
Field | Type | Description | |
---|---|---|---|
path | String! | ||
subjectRef | SubjectRefInput! | ||
privileges | [PrivilegeType!]! |
PermissionUnsetInput¶
Field | Type | Description | |
---|---|---|---|
path | String! | ||
subjectRef | SubjectRefInput! |
RemoveUserFromOrganizationInput¶
Field | Type | Description | |
---|---|---|---|
organizationName | String! | ||
String! |
ResourceGroupInput¶
Field | Type | Description | |
---|---|---|---|
name | String! | ||
parentRef | ResourceGroupRef |
ResourceGroupRef¶
Field | Type | Description | |
---|---|---|---|
idPath | IdPathRef |
ResourceGroupUpdate¶
Field | Type | Description | |
---|---|---|---|
self | ResourceGroupRef | ||
parentRef | ResourceGroupRef | ||
name | String |
SchemaInput¶
Field | Type | Description | |
---|---|---|---|
dataPortId | String! | ||
source | SchemaSource! | ||
encoding | SchemaEncoding! | ||
content | String! | ||
keyEncoding | SchemaEncoding | ||
keyContent | String |
SearchInput¶
Field | Type | Description | |
---|---|---|---|
first | Int | ||
after | String | ||
query | String! | ||
entityType | ResourceEntityType | ||
path | String |
StateMatchingProperties¶
Field | Type | Description | |
---|---|---|---|
transportRef | BaseRef | ||
properties | [KeyValuePairInput!]! |
SubjectRefInput¶
Field | Type | Description | |
---|---|---|---|
name | String! |
TechnicalUserChangeInput¶
Field | Type | Description | |
---|---|---|---|
id | ID | ||
label | String | ||
organization | String! |
TransportInput¶
Field | Type | Description | |
---|---|---|---|
name | String! | ||
path | String | ||
transportTypeRef | TransportTypeRef | ||
properties | [KeyValuePairInput] |
TransportTypeRef¶
Field | Type | Description | |
---|---|---|---|
idPath | IdPathRef |
UpdateNotificationChannelConfigurationInput¶
Field | Type | Description | |
---|---|---|---|
configuration | NotificationConfigurationInput! |
UserChangeInput¶
Field | Type | Description | |
---|---|---|---|
id | ID | ||
String | |||
firstName | String | ||
lastName | String | ||
organizations | [String!] | ||
groups | [ID!] | ||
properties | [KeyValuePairInput] |
UserGroupChangeInput¶
Field | Type | Description | |
---|---|---|---|
id | ID | ||
name | String | ||
label | String | ||
String | |||
organization | String | ||
properties | [KeyValuePairInput] | ||
users | [ID!] |
WebhookConfigurationInput¶
Field | Type | Description | |
---|---|---|---|
webhookUrl | String! | ||
webhookHeaders | [KeyValuePairInput]! |
Enums¶
ActivityType¶
Value | Description |
---|---|
UNKNOWN | |
FIRST_APPEARANCE | |
OWNER_CHANGE | |
OWNERSHIP_SELF_ASSIGNED | |
OWNERSHIP_ASSIGNED | |
OWNERSHIP_UNASSIGNED | |
RESOURCE_GROUP_CHANGE | |
GENERIC_TEXT_FIELD_CHANGE | |
TAGS_CHANGE | |
PROPERTIES_CHANGE | |
CONSUMER_GROUP_CHANGE | |
DATA_ITEM_CHANGE | |
SCHEMA_CHANGE |
DataProfilingErrorType¶
Value | Description |
---|---|
OPERATIONAL_ERROR | |
NO_DATA | |
UNKNOWN_ENCODING | |
TRANSPORT_UNAVAILABLE |
HistoryEventType¶
Value | Description |
---|---|
UNKNOWN | |
CREATED | |
MODIFIED | |
DELETED | |
LINKED | |
UNLINKED |
PrivilegeType¶
Value | Description |
---|---|
UNKNOWN | |
READ | |
WRITE | |
ADMIN | |
LINK | |
READ_INFO | |
NONE |
PropertyDataType¶
Value | Description |
---|---|
UNKNOWN | |
TEXT | |
UNIX_TIMESTAMP | |
LINK | |
ResourceEntityType¶
Value | Description |
---|---|
UNKNOWN | |
DATA_OFFER | |
DATA_PORT | |
DATA_ITEM | |
DATA_SUBSCRIPTION_STATE | |
TRANSPORT | |
RESOURCE_GROUP | |
PERMISSION | |
USER | |
USER_GROUP | |
DATA_PROFILE | |
SCHEMA | |
DATA_PROFILING_JOB | |
ORGANIZATION | |
DATA_SAMPLE | |
TECHNICAL_USER | |
AGENT |
SchemaEncoding¶
Value | Description |
---|---|
UNKNOWN | |
JSON | |
AVRO | |
JSON_ASYNCAPI |
SchemaSource¶
Value | Description |
---|---|
UNKNOWN | |
REGISTRY | |
INFERRED | |
USER_DEFINED |
SubjectType¶
Value | Description |
---|---|
USER | |
USER_GROUP |
TransportDataType¶
Value | Description |
---|---|
UNKNOWN | |
STREAM | |
DATA_SET |
Scalars¶
Boolean¶
The Boolean
scalar type represents true
or false
.
Float¶
The Float
scalar type represents signed double-precision fractional values as specified by IEEE 754.
GraphQLDateTime¶
ID¶
The ID
scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4"
) or integer (such as 4
) input value will be accepted as an ID.
Int¶
The Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
JSON¶
JSONObject¶
String¶
The String
scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Interfaces¶
Resource¶
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String | ||
metaInfo | MetaInfo |
Unions¶
AffectedEntity¶
Type | Description |
---|---|
DataOffer | |
DataPort | |
DataSubscriptionState | |
ResourceGroup | |
Transport | |
DataSchema |
ChangeInfo¶
Type | Description |
---|---|
OwnerChangeInfo | |
ResourceGroupChangeInfo | |
GenericTextChangeInfo |
Configuration¶
Type | Description |
---|---|
WebhookConfiguration | |
EmailConfiguration |
EntityWithSchema¶
Type | Description |
---|---|
DataPort | |
DataItem |
SearchableEntity¶
Type | Description |
---|---|
RemovedSearchItem | |
DataOffer | |
DataPort | |
DataItem | |
DataSubscriptionState | |
ResourceGroup | |
Transport | |
DataSchema |
Subject¶
Type | Description |
---|---|
User | |
UserGroup | |
TechnicalUser |
TopologyNode¶
Type | Description |
---|---|
ContainerNode | |
DataSourceNode | |
DataSinkNode |