SDA GraphQL Assets API Reference
🚀 Welcome to the SDA GraphQL Assets API
The SDA GraphQL Assets API Reference contains the Queries, Mutations and Types you can use to interact with the SDA ASSETS API to manage your assets like projects, devices, gateways and many more.
⚠️ This website only contains the Schema reference. For examples and more information, please visit the SDA GraphQL API Examples repository.
Terms of Service
https://www.softwaredefinedautomation.io/terms-and-conditions/
API Endpoints
# Assets GraphQL API:
https://api.sdaconsole.io/assets/v1/graphql
Headers
# The token you received from the SDA Console or the API
Authorization: Bearer <YOUR_TOKEN_HERE>Queries
downloadDocumentVersion
Response
Returns an DocumentVersionDownloadURLResponseType!
Example
Query
query DownloadDocumentVersion(
$documentId: String!,
$versionId: String!
) {
downloadDocumentVersion(
documentId: $documentId,
versionId: $versionId
) {
downloadUrl
documentId
versionId
}
}
Variables
{
"documentId": "xyz789",
"versionId": "abc123"
}
Response
{
"data": {
"downloadDocumentVersion": {
"downloadUrl": "abc123",
"documentId": "abc123",
"versionId": "abc123"
}
}
}
downloadLicense
Response
Returns an LicenseDownloadURLResponseType!
Arguments
| Name | Description |
|---|---|
licenseId - String!
|
Example
Query
query DownloadLicense($licenseId: String!) {
downloadLicense(licenseId: $licenseId) {
downloadUrl
licenseId
}
}
Variables
{"licenseId": "abc123"}
Response
{
"data": {
"downloadLicense": {
"downloadUrl": "abc123",
"licenseId": "xyz789"
}
}
}
downloadProjectVersion
Response
Returns an ProjectVersionDownloadURLResponseType!
Example
Query
query DownloadProjectVersion(
$projectId: String!,
$versionId: String!
) {
downloadProjectVersion(
projectId: $projectId,
versionId: $versionId
) {
downloadUrl
projectId
versionId
}
}
Variables
{
"projectId": "xyz789",
"versionId": "abc123"
}
Response
{
"data": {
"downloadProjectVersion": {
"downloadUrl": "abc123",
"projectId": "xyz789",
"versionId": "xyz789"
}
}
}
health
Description
Health check endpoint
Response
Returns a HealthResponseType!
Example
Query
query Health {
health {
status
message
}
}
Response
{
"data": {
"health": {
"status": "abc123",
"message": "abc123"
}
}
}
readAccumulatedDeviceSyncStatus
Response
Returns an AccumulatedDeviceSyncStatusResponseType!
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
Example
Query
query ReadAccumulatedDeviceSyncStatus($deviceId: String!) {
readAccumulatedDeviceSyncStatus(deviceId: $deviceId) {
targetSyncStatus
previousSyncStatus
syncTimestamp
details {
syncType
targetSyncStatus
previousSyncStatus
syncTimestamp
syncErrorMessage
syncJobId
projectId
targetProjectVersionId
}
}
}
Variables
{"deviceId": "abc123"}
Response
{
"data": {
"readAccumulatedDeviceSyncStatus": {
"targetSyncStatus": "UNKNOWN",
"previousSyncStatus": "UNKNOWN",
"syncTimestamp": "2007-12-03T10:15:30Z",
"details": [DeviceSyncStatusResponseType]
}
}
}
readAllAssetLinksFromAsset
Response
Returns a PaginatedAssetLinkResponseType!
Arguments
| Name | Description |
|---|---|
sourceId - String!
|
|
sourceType - AssetTypeEnum!
|
|
filter - AssetLinkFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllAssetLinksFromAsset(
$sourceId: String!,
$sourceType: AssetTypeEnum!,
$filter: AssetLinkFilterInput,
$pagination: PaginationInput
) {
readAllAssetLinksFromAsset(
sourceId: $sourceId,
sourceType: $sourceType,
filter: $filter,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
sourceId
sourceType
destinationId
destinationType
metaData {
... on DocumentToAssetLinkMetaDataType {
...DocumentToAssetLinkMetaDataTypeFragment
}
... on TagToAssetLinkMetaDataType {
...TagToAssetLinkMetaDataTypeFragment
}
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
}
itemCount
}
}
Variables
{
"sourceId": "abc123",
"sourceType": "DEVICE",
"filter": null,
"pagination": null
}
Response
{
"data": {
"readAllAssetLinksFromAsset": {
"pages": 123,
"items": [AssetLinkResponseType],
"itemCount": 123
}
}
}
readAllAssetLinksToAsset
Response
Returns a PaginatedAssetLinkResponseType!
Arguments
| Name | Description |
|---|---|
destinationId - String!
|
|
destinationType - AssetTypeEnum!
|
|
filter - AssetLinkFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllAssetLinksToAsset(
$destinationId: String!,
$destinationType: AssetTypeEnum!,
$filter: AssetLinkFilterInput,
$pagination: PaginationInput
) {
readAllAssetLinksToAsset(
destinationId: $destinationId,
destinationType: $destinationType,
filter: $filter,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
sourceId
sourceType
destinationId
destinationType
metaData {
... on DocumentToAssetLinkMetaDataType {
...DocumentToAssetLinkMetaDataTypeFragment
}
... on TagToAssetLinkMetaDataType {
...TagToAssetLinkMetaDataTypeFragment
}
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
}
itemCount
}
}
Variables
{
"destinationId": "abc123",
"destinationType": "DEVICE",
"filter": null,
"pagination": null
}
Response
{
"data": {
"readAllAssetLinksToAsset": {
"pages": 987,
"items": [AssetLinkResponseType],
"itemCount": 123
}
}
}
readAllDevices
Response
Returns a PaginatedDeviceResponseType!
Arguments
| Name | Description |
|---|---|
filter - DeviceFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllDevices(
$filter: DeviceFilterInput,
$pagination: PaginationInput
) {
readAllDevices(
filter: $filter,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
deviceId
groupId
name
vendorId
ideConfigId
connectionConfiguration {
...ConnectionConfigurationTypeFragment
}
metaData
deviceType
description
secretId
ftpConfiguration {
...FtpConfigurationTypeFragment
}
smbConfiguration {
...SmbConfigurationTypeFragment
}
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedGateways {
...PaginatedGatewayResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedSubDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedParentDevices {
...PaginatedDeviceResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
syncStatus {
...DeviceSyncStatusTypeFragment
}
accumulatedSyncStatus {
...AccumulatedDeviceSyncStatusResponseTypeFragment
}
connectivityStatus {
...DeviceConnectivityStatusTypeFragment
}
}
itemCount
}
}
Variables
{"filter": null, "pagination": null}
Response
{
"data": {
"readAllDevices": {
"pages": 987,
"items": [DeviceResponseType],
"itemCount": 123
}
}
}
readAllDocuments
Response
Returns a PaginatedDocumentResponseType!
Arguments
| Name | Description |
|---|---|
filter - DocumentFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllDocuments(
$filter: DocumentFilterInput,
$pagination: PaginationInput
) {
readAllDocuments(
filter: $filter,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
documentId
groupId
name
lastVersionNumber
documentType
linkMetaData {
...DocumentToAssetLinkMetaDataTypeFragment
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
versions {
...PaginatedDocumentVersionResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
}
itemCount
}
}
Variables
{"filter": null, "pagination": null}
Response
{
"data": {
"readAllDocuments": {
"pages": 123,
"items": [DocumentResponseType],
"itemCount": 123
}
}
}
readAllGateways
Response
Returns a PaginatedGatewayResponseType!
Arguments
| Name | Description |
|---|---|
filter - GatewayFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllGateways(
$filter: GatewayFilterInput,
$pagination: PaginationInput
) {
readAllGateways(
filter: $filter,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
gatewayId
groupId
name
description
linkMetaData {
...DeviceToGatewayLinkMetaDataTypeFragment
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
state {
...GatewayStateResponseTypeFragment
}
metadata {
...GatewayMetadataResponseTypeFragment
}
publicIp {
...GatewayPublicIpResponseTypeFragment
}
setupCommands {
...GatewaySetupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
configReported {
...GatewayConfigResponseTypeFragment
}
configDesired {
...GatewayConfigResponseTypeFragment
}
updateRequest {
...GatewayUpdateRequestTypeFragment
}
}
itemCount
}
}
Variables
{"filter": null, "pagination": null}
Response
{
"data": {
"readAllGateways": {
"pages": 123,
"items": [GatewayResponseType],
"itemCount": 123
}
}
}
readAllLicenses
Response
Returns a PaginatedLicenseResponseType!
Arguments
| Name | Description |
|---|---|
filter - LicenseFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllLicenses(
$filter: LicenseFilterInput,
$pagination: PaginationInput
) {
readAllLicenses(
filter: $filter,
pagination: $pagination
) {
pages
items {
licenseId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
vendorId
serialId
product
type
status
quantity
name
ideConfigId
expirationTimestamp
family
companyName
productKey
containerId
firmCode
licenseServer
}
itemCount
}
}
Variables
{"filter": null, "pagination": null}
Response
{
"data": {
"readAllLicenses": {
"pages": 987,
"items": [LicenseResponseType],
"itemCount": 123
}
}
}
readAllProjects
Response
Returns a PaginatedProjectResponseType!
Arguments
| Name | Description |
|---|---|
filter - ProjectFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllProjects(
$filter: ProjectFilterInput,
$pagination: PaginationInput
) {
readAllProjects(
filter: $filter,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
projectId
groupId
name
vendorId
ideConfigId
projectType
lastVersionNumber
description
secretId
attachedLicenses
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedSubProjects {
...PaginatedProjectResponseTypeFragment
}
linkedParentProjects {
...PaginatedProjectResponseTypeFragment
}
versions {
...PaginatedProjectVersionResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
}
itemCount
}
}
Variables
{"filter": null, "pagination": null}
Response
{
"data": {
"readAllProjects": {
"pages": 123,
"items": [ProjectResponseType],
"itemCount": 987
}
}
}
readAllResourceGroups
Response
Returns a PaginatedResourceGroupResponseType!
Arguments
| Name | Description |
|---|---|
filter - ResourceGroupFilterInput
|
Default = null |
isRoot - Boolean
|
Default = false |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllResourceGroups(
$filter: ResourceGroupFilterInput,
$isRoot: Boolean,
$pagination: PaginationInput
) {
readAllResourceGroups(
filter: $filter,
isRoot: $isRoot,
pagination: $pagination
) {
pages
items {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
itemCount
}
}
Variables
{"filter": null, "isRoot": false, "pagination": null}
Response
{
"data": {
"readAllResourceGroups": {
"pages": 123,
"items": [ResourceGroupResponseType],
"itemCount": 987
}
}
}
readAllSecrets
Response
Returns a PaginatedSecretResponseType!
Arguments
| Name | Description |
|---|---|
filter - SecretFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllSecrets(
$filter: SecretFilterInput,
$pagination: PaginationInput
) {
readAllSecrets(
filter: $filter,
pagination: $pagination
) {
pages
items {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
vault {
...VaultResponseTypeFragment
}
versions {
...PaginatedSecretVersionResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
name
secretType
lastVersionNumber
username
secretValue
}
itemCount
}
}
Variables
{"filter": null, "pagination": null}
Response
{
"data": {
"readAllSecrets": {
"pages": 123,
"items": [SecretResponseType],
"itemCount": 987
}
}
}
readAllTags
Response
Returns a PaginatedTagResponseType!
Arguments
| Name | Description |
|---|---|
filter - TagFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllTags(
$filter: TagFilterInput,
$pagination: PaginationInput
) {
readAllTags(
filter: $filter,
pagination: $pagination
) {
pages
items {
name
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
color
icon
}
itemCount
}
}
Variables
{"filter": null, "pagination": null}
Response
{
"data": {
"readAllTags": {
"pages": 123,
"items": [TagResponseType],
"itemCount": 123
}
}
}
readAllVaults
Response
Returns a PaginatedVaultResponseType!
Arguments
| Name | Description |
|---|---|
filter - VaultFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllVaults(
$filter: VaultFilterInput,
$pagination: PaginationInput
) {
readAllVaults(
filter: $filter,
pagination: $pagination
) {
pages
items {
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
secrets {
...PaginatedSecretResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
name
description
}
itemCount
}
}
Variables
{"filter": null, "pagination": null}
Response
{
"data": {
"readAllVaults": {
"pages": 123,
"items": [VaultResponseType],
"itemCount": 123
}
}
}
readAllWorkstationsForUser
Response
Returns a PaginatedWorkstationResponseType!
Arguments
| Name | Description |
|---|---|
filter - WorkstationFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAllWorkstationsForUser(
$filter: WorkstationFilterInput,
$pagination: PaginationInput
) {
readAllWorkstationsForUser(
filter: $filter,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
workstationId
groupId
name
description
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
state {
...WorkstationStateResponseTypeFragment
}
metadata {
...WorkstationMetadataResponseTypeFragment
}
publicIp {
...WorkstationPublicIpResponseTypeFragment
}
setupCommands {
...WorkstationSetupResponseTypeFragment
}
deviceConnections {
...PaginatedWorkstationDeviceConnectionStatusResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
}
itemCount
}
}
Variables
{"filter": null, "pagination": null}
Response
{
"data": {
"readAllWorkstationsForUser": {
"pages": 987,
"items": [WorkstationResponseType],
"itemCount": 123
}
}
}
readAssetLink
Response
Returns an AssetLinkResponseType!
Arguments
| Name | Description |
|---|---|
sourceId - String!
|
|
sourceType - AssetTypeEnum!
|
|
destinationId - String!
|
|
destinationType - AssetTypeEnum!
|
Example
Query
query ReadAssetLink(
$sourceId: String!,
$sourceType: AssetTypeEnum!,
$destinationId: String!,
$destinationType: AssetTypeEnum!
) {
readAssetLink(
sourceId: $sourceId,
sourceType: $sourceType,
destinationId: $destinationId,
destinationType: $destinationType
) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
sourceId
sourceType
destinationId
destinationType
metaData {
... on DocumentToAssetLinkMetaDataType {
...DocumentToAssetLinkMetaDataTypeFragment
}
... on TagToAssetLinkMetaDataType {
...TagToAssetLinkMetaDataTypeFragment
}
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
}
}
Variables
{
"sourceId": "xyz789",
"sourceType": "DEVICE",
"destinationId": "abc123",
"destinationType": "DEVICE"
}
Response
{
"data": {
"readAssetLink": {
"objectVersion": 987,
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"sourceId": "xyz789",
"sourceType": "DEVICE",
"destinationId": "xyz789",
"destinationType": "DEVICE",
"metaData": DocumentToAssetLinkMetaDataType
}
}
}
readAssetsForResourceGroup
Response
Returns a PaginatedResourceGroupAssetResponseType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
|
filter - ResourceGroupAssetTypeFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
includeSubGroups - Boolean
|
Default = false |
Example
Query
query ReadAssetsForResourceGroup(
$groupId: String!,
$filter: ResourceGroupAssetTypeFilterInput,
$pagination: PaginationInput,
$includeSubGroups: Boolean
) {
readAssetsForResourceGroup(
groupId: $groupId,
filter: $filter,
pagination: $pagination,
includeSubGroups: $includeSubGroups
) {
pages
items {
... on DeviceResponseType {
...DeviceResponseTypeFragment
}
... on GatewayResponseType {
...GatewayResponseTypeFragment
}
... on ProjectResponseType {
...ProjectResponseTypeFragment
}
}
itemCount
}
}
Variables
{
"groupId": "xyz789",
"filter": null,
"pagination": null,
"includeSubGroups": false
}
Response
{
"data": {
"readAssetsForResourceGroup": {
"pages": 987,
"items": [DeviceResponseType],
"itemCount": 123
}
}
}
readAssetsWithoutResourceGroup
Response
Returns a PaginatedResourceGroupAssetResponseType!
Arguments
| Name | Description |
|---|---|
filter - ResourceGroupAssetTypeFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadAssetsWithoutResourceGroup(
$filter: ResourceGroupAssetTypeFilterInput,
$pagination: PaginationInput
) {
readAssetsWithoutResourceGroup(
filter: $filter,
pagination: $pagination
) {
pages
items {
... on DeviceResponseType {
...DeviceResponseTypeFragment
}
... on GatewayResponseType {
...GatewayResponseTypeFragment
}
... on ProjectResponseType {
...ProjectResponseTypeFragment
}
}
itemCount
}
}
Variables
{"filter": null, "pagination": null}
Response
{
"data": {
"readAssetsWithoutResourceGroup": {
"pages": 987,
"items": [DeviceResponseType],
"itemCount": 987
}
}
}
readDevice
Response
Returns a DeviceResponseType!
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
Example
Query
query ReadDevice($deviceId: String!) {
readDevice(deviceId: $deviceId) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
deviceId
groupId
name
vendorId
ideConfigId
connectionConfiguration {
ipAddress
port
subnetMask
gatewayIpAddress
}
metaData
deviceType
description
secretId
ftpConfiguration {
ipAddress
port
protocol
secretId
rootDirectory
}
smbConfiguration {
ipAddress
port
protocol
secretId
rootDirectory
}
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
linkedGateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
linkedProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedSubDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
linkedParentDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
secret {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
vault {
...VaultResponseTypeFragment
}
versions {
...PaginatedSecretVersionResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
name
secretType
lastVersionNumber
username
secretValue
}
syncStatus {
targetSyncStatus
previousSyncStatus
syncType
syncTimestamp
syncErrorMessage
syncJobId
}
accumulatedSyncStatus {
targetSyncStatus
previousSyncStatus
syncTimestamp
details {
...DeviceSyncStatusResponseTypeFragment
}
}
connectivityStatus {
deviceId
primaryGateway {
...DeviceConnectivityStatusReportTypeFragment
}
allGateways {
...DeviceConnectivityStatusReportTypeFragment
}
}
}
}
Variables
{"deviceId": "xyz789"}
Response
{
"data": {
"readDevice": {
"objectVersion": 987,
"creationUserId": "abc123",
"updateUserId": "xyz789",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"deviceId": "abc123",
"groupId": "xyz789",
"name": "xyz789",
"vendorId": "xyz789",
"ideConfigId": "abc123",
"connectionConfiguration": ConnectionConfigurationType,
"metaData": {},
"deviceType": "PLC",
"description": "abc123",
"secretId": "xyz789",
"ftpConfiguration": FtpConfigurationType,
"smbConfiguration": SmbConfigurationType,
"linkMetaData": ProjectToDeviceLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"linkedGateways": PaginatedGatewayResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedSubDevices": PaginatedDeviceResponseType,
"linkedParentDevices": PaginatedDeviceResponseType,
"secret": SecretResponseType,
"syncStatus": [DeviceSyncStatusType],
"accumulatedSyncStatus": AccumulatedDeviceSyncStatusResponseType,
"connectivityStatus": DeviceConnectivityStatusType
}
}
}
readDeviceConnectivityStatus
Response
Returns a DeviceConnectivityStatusType!
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
Example
Query
query ReadDeviceConnectivityStatus($deviceId: String!) {
readDeviceConnectivityStatus(deviceId: $deviceId) {
deviceId
primaryGateway {
gatewayId
reportedAt
deviceStatus
devicePingStatus
deviceNetcatStatus
ftpStatus
ftpPingStatus
ftpNetcatStatus
smbStatus
smbPingStatus
smbNetcatStatus
}
allGateways {
gatewayId
reportedAt
deviceStatus
devicePingStatus
deviceNetcatStatus
ftpStatus
ftpPingStatus
ftpNetcatStatus
smbStatus
smbPingStatus
smbNetcatStatus
}
}
}
Variables
{"deviceId": "xyz789"}
Response
{
"data": {
"readDeviceConnectivityStatus": {
"deviceId": "abc123",
"primaryGateway": DeviceConnectivityStatusReportType,
"allGateways": [DeviceConnectivityStatusReportType]
}
}
}
readDeviceProjectsSyncStatus
Response
Returns [DeviceSyncStatusType!]!
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
Example
Query
query ReadDeviceProjectsSyncStatus($deviceId: String!) {
readDeviceProjectsSyncStatus(deviceId: $deviceId) {
targetSyncStatus
previousSyncStatus
syncType
syncTimestamp
syncErrorMessage
syncJobId
}
}
Variables
{"deviceId": "xyz789"}
Response
{
"data": {
"readDeviceProjectsSyncStatus": [
{
"targetSyncStatus": "UNKNOWN",
"previousSyncStatus": "UNKNOWN",
"syncType": "IDE",
"syncTimestamp": "2007-12-03T10:15:30Z",
"syncErrorMessage": "abc123",
"syncJobId": "xyz789"
}
]
}
}
readDeviceSyncStatus
Response
Returns [DeviceSyncStatusResponseType!]!
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
Example
Query
query ReadDeviceSyncStatus($deviceId: String!) {
readDeviceSyncStatus(deviceId: $deviceId) {
syncType
targetSyncStatus
previousSyncStatus
syncTimestamp
syncErrorMessage
syncJobId
projectId
targetProjectVersionId
}
}
Variables
{"deviceId": "abc123"}
Response
{
"data": {
"readDeviceSyncStatus": [
{
"syncType": "IDE",
"targetSyncStatus": "UNKNOWN",
"previousSyncStatus": "UNKNOWN",
"syncTimestamp": "2007-12-03T10:15:30Z",
"syncErrorMessage": "abc123",
"syncJobId": "xyz789",
"projectId": "abc123",
"targetProjectVersionId": "xyz789"
}
]
}
}
readDevicesByIds
Response
Returns a PaginatedDeviceResponseType!
Arguments
| Name | Description |
|---|---|
deviceIds - [String!]!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadDevicesByIds(
$deviceIds: [String!]!,
$pagination: PaginationInput
) {
readDevicesByIds(
deviceIds: $deviceIds,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
deviceId
groupId
name
vendorId
ideConfigId
connectionConfiguration {
...ConnectionConfigurationTypeFragment
}
metaData
deviceType
description
secretId
ftpConfiguration {
...FtpConfigurationTypeFragment
}
smbConfiguration {
...SmbConfigurationTypeFragment
}
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedGateways {
...PaginatedGatewayResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedSubDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedParentDevices {
...PaginatedDeviceResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
syncStatus {
...DeviceSyncStatusTypeFragment
}
accumulatedSyncStatus {
...AccumulatedDeviceSyncStatusResponseTypeFragment
}
connectivityStatus {
...DeviceConnectivityStatusTypeFragment
}
}
itemCount
}
}
Variables
{
"deviceIds": ["abc123"],
"pagination": null
}
Response
{
"data": {
"readDevicesByIds": {
"pages": 987,
"items": [DeviceResponseType],
"itemCount": 987
}
}
}
readDevicesForResourceGroup
Response
Returns a PaginatedDeviceResponseType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
|
pagination - PaginationInput
|
Default = null |
includeSubGroups - Boolean
|
Default = false |
Example
Query
query ReadDevicesForResourceGroup(
$groupId: String!,
$pagination: PaginationInput,
$includeSubGroups: Boolean
) {
readDevicesForResourceGroup(
groupId: $groupId,
pagination: $pagination,
includeSubGroups: $includeSubGroups
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
deviceId
groupId
name
vendorId
ideConfigId
connectionConfiguration {
...ConnectionConfigurationTypeFragment
}
metaData
deviceType
description
secretId
ftpConfiguration {
...FtpConfigurationTypeFragment
}
smbConfiguration {
...SmbConfigurationTypeFragment
}
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedGateways {
...PaginatedGatewayResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedSubDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedParentDevices {
...PaginatedDeviceResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
syncStatus {
...DeviceSyncStatusTypeFragment
}
accumulatedSyncStatus {
...AccumulatedDeviceSyncStatusResponseTypeFragment
}
connectivityStatus {
...DeviceConnectivityStatusTypeFragment
}
}
itemCount
}
}
Variables
{
"groupId": "abc123",
"pagination": null,
"includeSubGroups": false
}
Response
{
"data": {
"readDevicesForResourceGroup": {
"pages": 123,
"items": [DeviceResponseType],
"itemCount": 123
}
}
}
readDocument
Response
Returns a DocumentResponseType!
Arguments
| Name | Description |
|---|---|
documentId - String!
|
Example
Query
query ReadDocument($documentId: String!) {
readDocument(documentId: $documentId) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
documentId
groupId
name
lastVersionNumber
documentType
linkMetaData {
assetVersionId
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
versions {
pages
items {
...DocumentVersionResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
}
}
Variables
{"documentId": "abc123"}
Response
{
"data": {
"readDocument": {
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documentId": "abc123",
"groupId": "abc123",
"name": "abc123",
"lastVersionNumber": 123,
"documentType": "PDF",
"linkMetaData": DocumentToAssetLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"versions": PaginatedDocumentVersionResponseType,
"linkedTags": PaginatedTagResponseType
}
}
}
readDocumentVersionsForDocument
Response
Returns a PaginatedDocumentVersionResponseType!
Arguments
| Name | Description |
|---|---|
documentId - String!
|
|
filter - DocumentVersionFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadDocumentVersionsForDocument(
$documentId: String!,
$filter: DocumentVersionFilterInput,
$pagination: PaginationInput
) {
readDocumentVersionsForDocument(
documentId: $documentId,
filter: $filter,
pagination: $pagination
) {
pages
items {
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
documentId
versionId
versionNumber
documentFile {
...DocumentVersionFileTypeFragment
}
commitMessage
}
itemCount
}
}
Variables
{
"documentId": "abc123",
"filter": null,
"pagination": null
}
Response
{
"data": {
"readDocumentVersionsForDocument": {
"pages": 987,
"items": [DocumentVersionResponseType],
"itemCount": 987
}
}
}
readDocumentsByIds
Response
Returns a PaginatedDocumentResponseType!
Arguments
| Name | Description |
|---|---|
documentIds - [String!]!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadDocumentsByIds(
$documentIds: [String!]!,
$pagination: PaginationInput
) {
readDocumentsByIds(
documentIds: $documentIds,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
documentId
groupId
name
lastVersionNumber
documentType
linkMetaData {
...DocumentToAssetLinkMetaDataTypeFragment
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
versions {
...PaginatedDocumentVersionResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
}
itemCount
}
}
Variables
{
"documentIds": ["xyz789"],
"pagination": null
}
Response
{
"data": {
"readDocumentsByIds": {
"pages": 987,
"items": [DocumentResponseType],
"itemCount": 123
}
}
}
readDocumentsForResourceGroup
Response
Returns a PaginatedDocumentResponseType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadDocumentsForResourceGroup(
$groupId: String!,
$pagination: PaginationInput
) {
readDocumentsForResourceGroup(
groupId: $groupId,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
documentId
groupId
name
lastVersionNumber
documentType
linkMetaData {
...DocumentToAssetLinkMetaDataTypeFragment
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
versions {
...PaginatedDocumentVersionResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
}
itemCount
}
}
Variables
{"groupId": "xyz789", "pagination": null}
Response
{
"data": {
"readDocumentsForResourceGroup": {
"pages": 123,
"items": [DocumentResponseType],
"itemCount": 123
}
}
}
readGateway
Response
Returns a GatewayResponseType!
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
Example
Query
query ReadGateway($gatewayId: String!) {
readGateway(gatewayId: $gatewayId) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
gatewayId
groupId
name
description
linkMetaData {
primary
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
state {
reportedAt
state
}
metadata {
reportedAt
version
latestVersion
latestVersionForMajor
architecture
operatingSystem
operatingSystemAttrs {
... on WindowsAttrsType {
...WindowsAttrsTypeFragment
}
... on LinuxAttrsType {
...LinuxAttrsTypeFragment
}
}
numCpu
isOutdated
isOutdatedForMajor
}
publicIp {
reportedAt
publicIp
publicIpLocation {
...LocationTypeFragment
}
}
setupCommands {
expiresAt
osCommands {
...GatewaySetupTypeFragment
}
byMajor {
...GatewaySetupByMajorTypeFragment
}
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
configReported {
objectVersion
reportedAt
requestedAt
values {
...GlueConfigTypeFragment
}
}
configDesired {
objectVersion
reportedAt
requestedAt
values {
...GlueConfigTypeFragment
}
}
updateRequest {
requestedAt
version
}
}
}
Variables
{"gatewayId": "abc123"}
Response
{
"data": {
"readGateway": {
"objectVersion": 987,
"creationUserId": "xyz789",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"gatewayId": "abc123",
"groupId": "xyz789",
"name": "abc123",
"description": "xyz789",
"linkMetaData": DeviceToGatewayLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"state": GatewayStateResponseType,
"metadata": GatewayMetadataResponseType,
"publicIp": GatewayPublicIpResponseType,
"setupCommands": GatewaySetupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"linkedTags": PaginatedTagResponseType,
"configReported": GatewayConfigResponseType,
"configDesired": GatewayConfigResponseType,
"updateRequest": GatewayUpdateRequestType
}
}
}
readGatewayConfigDesired
Response
Returns a GatewayConfigResponseType
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
Example
Query
query ReadGatewayConfigDesired($gatewayId: String!) {
readGatewayConfigDesired(gatewayId: $gatewayId) {
objectVersion
reportedAt
requestedAt
values {
metaVersion
updateAuto
updatePeriod
updateUnstable
proxyAll
proxyHttp
proxyHttps
iotTransport
natMode
sslTunnel
sslTunnelInsecure
webuiEnabled
webuiBase
webuiPort
}
}
}
Variables
{"gatewayId": "abc123"}
Response
{
"data": {
"readGatewayConfigDesired": {
"objectVersion": 123,
"reportedAt": "2007-12-03T10:15:30Z",
"requestedAt": "2007-12-03T10:15:30Z",
"values": GlueConfigType
}
}
}
readGatewayConfigReported
Response
Returns a GatewayConfigResponseType
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
Example
Query
query ReadGatewayConfigReported($gatewayId: String!) {
readGatewayConfigReported(gatewayId: $gatewayId) {
objectVersion
reportedAt
requestedAt
values {
metaVersion
updateAuto
updatePeriod
updateUnstable
proxyAll
proxyHttp
proxyHttps
iotTransport
natMode
sslTunnel
sslTunnelInsecure
webuiEnabled
webuiBase
webuiPort
}
}
}
Variables
{"gatewayId": "xyz789"}
Response
{
"data": {
"readGatewayConfigReported": {
"objectVersion": 123,
"reportedAt": "2007-12-03T10:15:30Z",
"requestedAt": "2007-12-03T10:15:30Z",
"values": GlueConfigType
}
}
}
readGatewayMetadata
Response
Returns a GatewayMetadataResponseType
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
Example
Query
query ReadGatewayMetadata($gatewayId: String!) {
readGatewayMetadata(gatewayId: $gatewayId) {
reportedAt
version
latestVersion
latestVersionForMajor
architecture
operatingSystem
operatingSystemAttrs {
... on WindowsAttrsType {
...WindowsAttrsTypeFragment
}
... on LinuxAttrsType {
...LinuxAttrsTypeFragment
}
}
numCpu
isOutdated
isOutdatedForMajor
}
}
Variables
{"gatewayId": "abc123"}
Response
{
"data": {
"readGatewayMetadata": {
"reportedAt": "2007-12-03T10:15:30Z",
"version": "xyz789",
"latestVersion": "abc123",
"latestVersionForMajor": "abc123",
"architecture": "ARM",
"operatingSystem": "WINDOWS",
"operatingSystemAttrs": WindowsAttrsType,
"numCpu": 123,
"isOutdated": false,
"isOutdatedForMajor": false
}
}
}
readGatewayPublicIp
Response
Returns a GatewayPublicIpResponseType
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
Example
Query
query ReadGatewayPublicIp($gatewayId: String!) {
readGatewayPublicIp(gatewayId: $gatewayId) {
reportedAt
publicIp
publicIpLocation {
latitudeE6
longitudeE6
country
state
city
horizontalAccuracy
horizontalConfidenceLevelPercentage
}
}
}
Variables
{"gatewayId": "xyz789"}
Response
{
"data": {
"readGatewayPublicIp": {
"reportedAt": "2007-12-03T10:15:30Z",
"publicIp": "abc123",
"publicIpLocation": LocationType
}
}
}
readGatewaySetup
Response
Returns a GatewaySetupResponseType
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
Example
Query
query ReadGatewaySetup($gatewayId: String!) {
readGatewaySetup(gatewayId: $gatewayId) {
expiresAt
osCommands {
osType
osName
installationCommand
configurationCommand
}
byMajor {
major
osCommands {
...GatewaySetupTypeFragment
}
}
}
}
Variables
{"gatewayId": "xyz789"}
Response
{
"data": {
"readGatewaySetup": {
"expiresAt": "2007-12-03T10:15:30Z",
"osCommands": [GatewaySetupType],
"byMajor": [GatewaySetupByMajorType]
}
}
}
readGatewayState
Response
Returns a GatewayStateResponseType
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
Example
Query
query ReadGatewayState($gatewayId: String!) {
readGatewayState(gatewayId: $gatewayId) {
reportedAt
state
}
}
Variables
{"gatewayId": "abc123"}
Response
{
"data": {
"readGatewayState": {
"reportedAt": "2007-12-03T10:15:30Z",
"state": "NOT_CONFIGURED"
}
}
}
readGatewayUpdateRequest
Response
Returns a GatewayUpdateRequestType
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
Example
Query
query ReadGatewayUpdateRequest($gatewayId: String!) {
readGatewayUpdateRequest(gatewayId: $gatewayId) {
requestedAt
version
}
}
Variables
{"gatewayId": "xyz789"}
Response
{
"data": {
"readGatewayUpdateRequest": {
"requestedAt": "2007-12-03T10:15:30Z",
"version": "xyz789"
}
}
}
readGatewaysByIds
Response
Returns a PaginatedGatewayResponseType!
Arguments
| Name | Description |
|---|---|
gatewayIds - [String!]!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadGatewaysByIds(
$gatewayIds: [String!]!,
$pagination: PaginationInput
) {
readGatewaysByIds(
gatewayIds: $gatewayIds,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
gatewayId
groupId
name
description
linkMetaData {
...DeviceToGatewayLinkMetaDataTypeFragment
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
state {
...GatewayStateResponseTypeFragment
}
metadata {
...GatewayMetadataResponseTypeFragment
}
publicIp {
...GatewayPublicIpResponseTypeFragment
}
setupCommands {
...GatewaySetupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
configReported {
...GatewayConfigResponseTypeFragment
}
configDesired {
...GatewayConfigResponseTypeFragment
}
updateRequest {
...GatewayUpdateRequestTypeFragment
}
}
itemCount
}
}
Variables
{
"gatewayIds": ["xyz789"],
"pagination": null
}
Response
{
"data": {
"readGatewaysByIds": {
"pages": 123,
"items": [GatewayResponseType],
"itemCount": 123
}
}
}
readGatewaysForResourceGroup
Response
Returns a PaginatedGatewayResponseType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
|
pagination - PaginationInput
|
Default = null |
includeSubGroups - Boolean
|
Default = false |
Example
Query
query ReadGatewaysForResourceGroup(
$groupId: String!,
$pagination: PaginationInput,
$includeSubGroups: Boolean
) {
readGatewaysForResourceGroup(
groupId: $groupId,
pagination: $pagination,
includeSubGroups: $includeSubGroups
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
gatewayId
groupId
name
description
linkMetaData {
...DeviceToGatewayLinkMetaDataTypeFragment
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
state {
...GatewayStateResponseTypeFragment
}
metadata {
...GatewayMetadataResponseTypeFragment
}
publicIp {
...GatewayPublicIpResponseTypeFragment
}
setupCommands {
...GatewaySetupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
configReported {
...GatewayConfigResponseTypeFragment
}
configDesired {
...GatewayConfigResponseTypeFragment
}
updateRequest {
...GatewayUpdateRequestTypeFragment
}
}
itemCount
}
}
Variables
{
"groupId": "abc123",
"pagination": null,
"includeSubGroups": false
}
Response
{
"data": {
"readGatewaysForResourceGroup": {
"pages": 123,
"items": [GatewayResponseType],
"itemCount": 123
}
}
}
readLicense
Response
Returns a LicenseResponseType!
Arguments
| Name | Description |
|---|---|
licenseId - String!
|
Example
Query
query ReadLicense($licenseId: String!) {
readLicense(licenseId: $licenseId) {
licenseId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
vendorId
serialId
product
type
status
quantity
name
ideConfigId
expirationTimestamp
family
companyName
productKey
containerId
firmCode
licenseServer
}
}
Variables
{"licenseId": "abc123"}
Response
{
"data": {
"readLicense": {
"licenseId": "abc123",
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"vendorId": "xyz789",
"serialId": "xyz789",
"product": "xyz789",
"type": "CORPORATE",
"status": "REQUESTED",
"quantity": 987,
"name": "abc123",
"ideConfigId": "abc123",
"expirationTimestamp": "2007-12-03T10:15:30Z",
"family": "xyz789",
"companyName": "xyz789",
"productKey": "abc123",
"containerId": "xyz789",
"firmCode": "abc123",
"licenseServer": "abc123"
}
}
}
readLicensesByIds
Response
Returns a PaginatedLicenseResponseType!
Arguments
| Name | Description |
|---|---|
licenseIds - [String!]!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLicensesByIds(
$licenseIds: [String!]!,
$pagination: PaginationInput
) {
readLicensesByIds(
licenseIds: $licenseIds,
pagination: $pagination
) {
pages
items {
licenseId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
vendorId
serialId
product
type
status
quantity
name
ideConfigId
expirationTimestamp
family
companyName
productKey
containerId
firmCode
licenseServer
}
itemCount
}
}
Variables
{
"licenseIds": ["xyz789"],
"pagination": null
}
Response
{
"data": {
"readLicensesByIds": {
"pages": 123,
"items": [LicenseResponseType],
"itemCount": 123
}
}
}
readLicensesForResourceGroup
Response
Returns a PaginatedLicenseResponseType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLicensesForResourceGroup(
$groupId: String!,
$pagination: PaginationInput
) {
readLicensesForResourceGroup(
groupId: $groupId,
pagination: $pagination
) {
pages
items {
licenseId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
vendorId
serialId
product
type
status
quantity
name
ideConfigId
expirationTimestamp
family
companyName
productKey
containerId
firmCode
licenseServer
}
itemCount
}
}
Variables
{"groupId": "xyz789", "pagination": null}
Response
{
"data": {
"readLicensesForResourceGroup": {
"pages": 123,
"items": [LicenseResponseType],
"itemCount": 987
}
}
}
readLinkedDevicesForGateway
Response
Returns a PaginatedDeviceResponseType!
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLinkedDevicesForGateway(
$gatewayId: String!,
$pagination: PaginationInput
) {
readLinkedDevicesForGateway(
gatewayId: $gatewayId,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
deviceId
groupId
name
vendorId
ideConfigId
connectionConfiguration {
...ConnectionConfigurationTypeFragment
}
metaData
deviceType
description
secretId
ftpConfiguration {
...FtpConfigurationTypeFragment
}
smbConfiguration {
...SmbConfigurationTypeFragment
}
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedGateways {
...PaginatedGatewayResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedSubDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedParentDevices {
...PaginatedDeviceResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
syncStatus {
...DeviceSyncStatusTypeFragment
}
accumulatedSyncStatus {
...AccumulatedDeviceSyncStatusResponseTypeFragment
}
connectivityStatus {
...DeviceConnectivityStatusTypeFragment
}
}
itemCount
}
}
Variables
{"gatewayId": "abc123", "pagination": null}
Response
{
"data": {
"readLinkedDevicesForGateway": {
"pages": 123,
"items": [DeviceResponseType],
"itemCount": 123
}
}
}
readLinkedDevicesForProject
Response
Returns a PaginatedDeviceResponseType!
Arguments
| Name | Description |
|---|---|
projectId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLinkedDevicesForProject(
$projectId: String!,
$pagination: PaginationInput
) {
readLinkedDevicesForProject(
projectId: $projectId,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
deviceId
groupId
name
vendorId
ideConfigId
connectionConfiguration {
...ConnectionConfigurationTypeFragment
}
metaData
deviceType
description
secretId
ftpConfiguration {
...FtpConfigurationTypeFragment
}
smbConfiguration {
...SmbConfigurationTypeFragment
}
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedGateways {
...PaginatedGatewayResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedSubDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedParentDevices {
...PaginatedDeviceResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
syncStatus {
...DeviceSyncStatusTypeFragment
}
accumulatedSyncStatus {
...AccumulatedDeviceSyncStatusResponseTypeFragment
}
connectivityStatus {
...DeviceConnectivityStatusTypeFragment
}
}
itemCount
}
}
Variables
{"projectId": "abc123", "pagination": null}
Response
{
"data": {
"readLinkedDevicesForProject": {
"pages": 123,
"items": [DeviceResponseType],
"itemCount": 987
}
}
}
readLinkedDocumentsForAsset
Response
Returns a PaginatedDocumentResponseType!
Arguments
| Name | Description |
|---|---|
assetId - String!
|
|
assetType - AssetTypeEnum!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLinkedDocumentsForAsset(
$assetId: String!,
$assetType: AssetTypeEnum!,
$pagination: PaginationInput
) {
readLinkedDocumentsForAsset(
assetId: $assetId,
assetType: $assetType,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
documentId
groupId
name
lastVersionNumber
documentType
linkMetaData {
...DocumentToAssetLinkMetaDataTypeFragment
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
versions {
...PaginatedDocumentVersionResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
}
itemCount
}
}
Variables
{
"assetId": "xyz789",
"assetType": "DEVICE",
"pagination": null
}
Response
{
"data": {
"readLinkedDocumentsForAsset": {
"pages": 987,
"items": [DocumentResponseType],
"itemCount": 987
}
}
}
readLinkedGatewaysForDevice
Response
Returns a PaginatedGatewayResponseType!
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLinkedGatewaysForDevice(
$deviceId: String!,
$pagination: PaginationInput
) {
readLinkedGatewaysForDevice(
deviceId: $deviceId,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
gatewayId
groupId
name
description
linkMetaData {
...DeviceToGatewayLinkMetaDataTypeFragment
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
state {
...GatewayStateResponseTypeFragment
}
metadata {
...GatewayMetadataResponseTypeFragment
}
publicIp {
...GatewayPublicIpResponseTypeFragment
}
setupCommands {
...GatewaySetupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
configReported {
...GatewayConfigResponseTypeFragment
}
configDesired {
...GatewayConfigResponseTypeFragment
}
updateRequest {
...GatewayUpdateRequestTypeFragment
}
}
itemCount
}
}
Variables
{"deviceId": "abc123", "pagination": null}
Response
{
"data": {
"readLinkedGatewaysForDevice": {
"pages": 123,
"items": [GatewayResponseType],
"itemCount": 123
}
}
}
readLinkedParentDevicesForDevice
Response
Returns a PaginatedDeviceResponseType!
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLinkedParentDevicesForDevice(
$deviceId: String!,
$pagination: PaginationInput
) {
readLinkedParentDevicesForDevice(
deviceId: $deviceId,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
deviceId
groupId
name
vendorId
ideConfigId
connectionConfiguration {
...ConnectionConfigurationTypeFragment
}
metaData
deviceType
description
secretId
ftpConfiguration {
...FtpConfigurationTypeFragment
}
smbConfiguration {
...SmbConfigurationTypeFragment
}
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedGateways {
...PaginatedGatewayResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedSubDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedParentDevices {
...PaginatedDeviceResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
syncStatus {
...DeviceSyncStatusTypeFragment
}
accumulatedSyncStatus {
...AccumulatedDeviceSyncStatusResponseTypeFragment
}
connectivityStatus {
...DeviceConnectivityStatusTypeFragment
}
}
itemCount
}
}
Variables
{"deviceId": "xyz789", "pagination": null}
Response
{
"data": {
"readLinkedParentDevicesForDevice": {
"pages": 123,
"items": [DeviceResponseType],
"itemCount": 123
}
}
}
readLinkedParentProjectsForProject
Response
Returns a PaginatedProjectResponseType!
Arguments
| Name | Description |
|---|---|
projectId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLinkedParentProjectsForProject(
$projectId: String!,
$pagination: PaginationInput
) {
readLinkedParentProjectsForProject(
projectId: $projectId,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
projectId
groupId
name
vendorId
ideConfigId
projectType
lastVersionNumber
description
secretId
attachedLicenses
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedSubProjects {
...PaginatedProjectResponseTypeFragment
}
linkedParentProjects {
...PaginatedProjectResponseTypeFragment
}
versions {
...PaginatedProjectVersionResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
}
itemCount
}
}
Variables
{"projectId": "xyz789", "pagination": null}
Response
{
"data": {
"readLinkedParentProjectsForProject": {
"pages": 123,
"items": [ProjectResponseType],
"itemCount": 123
}
}
}
readLinkedProjectsForDevice
Response
Returns a PaginatedProjectResponseType!
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLinkedProjectsForDevice(
$deviceId: String!,
$pagination: PaginationInput
) {
readLinkedProjectsForDevice(
deviceId: $deviceId,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
projectId
groupId
name
vendorId
ideConfigId
projectType
lastVersionNumber
description
secretId
attachedLicenses
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedSubProjects {
...PaginatedProjectResponseTypeFragment
}
linkedParentProjects {
...PaginatedProjectResponseTypeFragment
}
versions {
...PaginatedProjectVersionResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
}
itemCount
}
}
Variables
{"deviceId": "abc123", "pagination": null}
Response
{
"data": {
"readLinkedProjectsForDevice": {
"pages": 987,
"items": [ProjectResponseType],
"itemCount": 987
}
}
}
readLinkedSubDevicesForDevice
Response
Returns a PaginatedDeviceResponseType!
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLinkedSubDevicesForDevice(
$deviceId: String!,
$pagination: PaginationInput
) {
readLinkedSubDevicesForDevice(
deviceId: $deviceId,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
deviceId
groupId
name
vendorId
ideConfigId
connectionConfiguration {
...ConnectionConfigurationTypeFragment
}
metaData
deviceType
description
secretId
ftpConfiguration {
...FtpConfigurationTypeFragment
}
smbConfiguration {
...SmbConfigurationTypeFragment
}
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedGateways {
...PaginatedGatewayResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedSubDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedParentDevices {
...PaginatedDeviceResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
syncStatus {
...DeviceSyncStatusTypeFragment
}
accumulatedSyncStatus {
...AccumulatedDeviceSyncStatusResponseTypeFragment
}
connectivityStatus {
...DeviceConnectivityStatusTypeFragment
}
}
itemCount
}
}
Variables
{"deviceId": "xyz789", "pagination": null}
Response
{
"data": {
"readLinkedSubDevicesForDevice": {
"pages": 987,
"items": [DeviceResponseType],
"itemCount": 123
}
}
}
readLinkedSubProjectsForProject
Response
Returns a PaginatedProjectResponseType!
Arguments
| Name | Description |
|---|---|
projectId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLinkedSubProjectsForProject(
$projectId: String!,
$pagination: PaginationInput
) {
readLinkedSubProjectsForProject(
projectId: $projectId,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
projectId
groupId
name
vendorId
ideConfigId
projectType
lastVersionNumber
description
secretId
attachedLicenses
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedSubProjects {
...PaginatedProjectResponseTypeFragment
}
linkedParentProjects {
...PaginatedProjectResponseTypeFragment
}
versions {
...PaginatedProjectVersionResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
}
itemCount
}
}
Variables
{"projectId": "abc123", "pagination": null}
Response
{
"data": {
"readLinkedSubProjectsForProject": {
"pages": 123,
"items": [ProjectResponseType],
"itemCount": 123
}
}
}
readLinkedTagsForAsset
Response
Returns a PaginatedTagResponseType!
Arguments
| Name | Description |
|---|---|
assetId - String!
|
|
assetType - AssetTypeEnum!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadLinkedTagsForAsset(
$assetId: String!,
$assetType: AssetTypeEnum!,
$pagination: PaginationInput
) {
readLinkedTagsForAsset(
assetId: $assetId,
assetType: $assetType,
pagination: $pagination
) {
pages
items {
name
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
color
icon
}
itemCount
}
}
Variables
{
"assetId": "xyz789",
"assetType": "DEVICE",
"pagination": null
}
Response
{
"data": {
"readLinkedTagsForAsset": {
"pages": 987,
"items": [TagResponseType],
"itemCount": 123
}
}
}
readLock
Response
Returns a LockResponseType
Example
Query
query ReadLock(
$resourceType: String!,
$resourceId: String!
) {
readLock(
resourceType: $resourceType,
resourceId: $resourceId
) {
creationUserId
updateUserId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
}
Variables
{
"resourceType": "xyz789",
"resourceId": "abc123"
}
Response
{
"data": {
"readLock": {
"creationUserId": "xyz789",
"updateUserId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"objectVersion": 123,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"resourceId": "xyz789",
"resourceType": "abc123",
"ownerId": "xyz789",
"service": "abc123",
"message": "abc123"
}
}
}
readProject
Response
Returns a ProjectResponseType!
Arguments
| Name | Description |
|---|---|
projectId - String!
|
Example
Query
query ReadProject($projectId: String!) {
readProject(projectId: $projectId) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
projectId
groupId
name
vendorId
ideConfigId
projectType
lastVersionNumber
description
secretId
attachedLicenses
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
linkedSubProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedParentProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
versions {
pages
items {
...ProjectVersionResponseTypeFragment
}
itemCount
}
secret {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
vault {
...VaultResponseTypeFragment
}
versions {
...PaginatedSecretVersionResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
name
secretType
lastVersionNumber
username
secretValue
}
}
}
Variables
{"projectId": "xyz789"}
Response
{
"data": {
"readProject": {
"objectVersion": 987,
"creationUserId": "xyz789",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"projectId": "xyz789",
"groupId": "xyz789",
"name": "abc123",
"vendorId": "abc123",
"ideConfigId": "abc123",
"projectType": "STANDARD",
"lastVersionNumber": 987,
"description": "xyz789",
"secretId": "xyz789",
"attachedLicenses": ["abc123"],
"linkMetaData": ProjectToDeviceLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"linkedSubProjects": PaginatedProjectResponseType,
"linkedParentProjects": PaginatedProjectResponseType,
"versions": PaginatedProjectVersionResponseType,
"secret": SecretResponseType
}
}
}
readProjectVersionsCreatedAfter
Response
Returns a PaginatedProjectVersionResponseType!
Arguments
| Name | Description |
|---|---|
creationTimestamp - DateTime!
|
|
filter - ProjectVersionFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadProjectVersionsCreatedAfter(
$creationTimestamp: DateTime!,
$filter: ProjectVersionFilterInput,
$pagination: PaginationInput
) {
readProjectVersionsCreatedAfter(
creationTimestamp: $creationTimestamp,
filter: $filter,
pagination: $pagination
) {
pages
items {
projectId
versionId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
deviceInformation {
...DeviceInformationTypeFragment
}
downloadUrl
vendorId
ideConfigId
versionNumber
projectFile {
...ProjectVersionFileTypeFragment
}
source
commitMessage
commitId
}
itemCount
}
}
Variables
{
"creationTimestamp": "2007-12-03T10:15:30Z",
"filter": null,
"pagination": null
}
Response
{
"data": {
"readProjectVersionsCreatedAfter": {
"pages": 123,
"items": [ProjectVersionResponseType],
"itemCount": 987
}
}
}
readProjectVersionsForProject
Response
Returns a PaginatedProjectVersionResponseType!
Arguments
| Name | Description |
|---|---|
projectId - String!
|
|
filter - ProjectVersionFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadProjectVersionsForProject(
$projectId: String!,
$filter: ProjectVersionFilterInput,
$pagination: PaginationInput
) {
readProjectVersionsForProject(
projectId: $projectId,
filter: $filter,
pagination: $pagination
) {
pages
items {
projectId
versionId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
deviceInformation {
...DeviceInformationTypeFragment
}
downloadUrl
vendorId
ideConfigId
versionNumber
projectFile {
...ProjectVersionFileTypeFragment
}
source
commitMessage
commitId
}
itemCount
}
}
Variables
{
"projectId": "abc123",
"filter": null,
"pagination": null
}
Response
{
"data": {
"readProjectVersionsForProject": {
"pages": 987,
"items": [ProjectVersionResponseType],
"itemCount": 123
}
}
}
readProjectsByIds
Response
Returns a PaginatedProjectResponseType!
Arguments
| Name | Description |
|---|---|
projectIds - [String!]!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadProjectsByIds(
$projectIds: [String!]!,
$pagination: PaginationInput
) {
readProjectsByIds(
projectIds: $projectIds,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
projectId
groupId
name
vendorId
ideConfigId
projectType
lastVersionNumber
description
secretId
attachedLicenses
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedSubProjects {
...PaginatedProjectResponseTypeFragment
}
linkedParentProjects {
...PaginatedProjectResponseTypeFragment
}
versions {
...PaginatedProjectVersionResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
}
itemCount
}
}
Variables
{
"projectIds": ["xyz789"],
"pagination": null
}
Response
{
"data": {
"readProjectsByIds": {
"pages": 123,
"items": [ProjectResponseType],
"itemCount": 123
}
}
}
readProjectsForResourceGroup
Response
Returns a PaginatedProjectResponseType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
|
pagination - PaginationInput
|
Default = null |
includeSubGroups - Boolean
|
Default = false |
Example
Query
query ReadProjectsForResourceGroup(
$groupId: String!,
$pagination: PaginationInput,
$includeSubGroups: Boolean
) {
readProjectsForResourceGroup(
groupId: $groupId,
pagination: $pagination,
includeSubGroups: $includeSubGroups
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
projectId
groupId
name
vendorId
ideConfigId
projectType
lastVersionNumber
description
secretId
attachedLicenses
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
}
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
linkedDocuments {
...PaginatedDocumentResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
linkedSubProjects {
...PaginatedProjectResponseTypeFragment
}
linkedParentProjects {
...PaginatedProjectResponseTypeFragment
}
versions {
...PaginatedProjectVersionResponseTypeFragment
}
secret {
...SecretResponseTypeFragment
}
}
itemCount
}
}
Variables
{
"groupId": "xyz789",
"pagination": null,
"includeSubGroups": false
}
Response
{
"data": {
"readProjectsForResourceGroup": {
"pages": 987,
"items": [ProjectResponseType],
"itemCount": 123
}
}
}
readResourceGroup
Response
Returns a ResourceGroupResponseType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
Example
Query
query ReadResourceGroup($groupId: String!) {
readResourceGroup(groupId: $groupId) {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
devices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
documents {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
gateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
licenses {
pages
items {
...LicenseResponseTypeFragment
}
itemCount
}
projects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
tags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
subGroups {
pages
items {
...ResourceGroupResponseTypeFragment
}
itemCount
}
parentGroup {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
fullPath
groupDevicesSyncStatus {
groupSyncStatus
devicesSyncStatus {
...GroupDeviceSyncStatusTypeFragment
}
}
name
groupType
isSystemGroup
}
}
Variables
{"groupId": "abc123"}
Response
{
"data": {
"readResourceGroup": {
"groupId": "abc123",
"parentGroupId": "abc123",
"creationUserId": "xyz789",
"updateUserId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"devices": PaginatedDeviceResponseType,
"documents": PaginatedDocumentResponseType,
"gateways": PaginatedGatewayResponseType,
"licenses": PaginatedLicenseResponseType,
"projects": PaginatedProjectResponseType,
"tags": PaginatedTagResponseType,
"subGroups": PaginatedResourceGroupResponseType,
"parentGroup": ResourceGroupResponseType,
"fullPath": "xyz789",
"groupDevicesSyncStatus": ResourceGroupDevicesSyncStatusType,
"name": "abc123",
"groupType": "USER",
"isSystemGroup": false
}
}
}
readResourceGroupDevicesSyncStatus
Response
Returns a ResourceGroupDevicesSyncStatusType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
|
filter - ResourceGroupDevicesSyncStatusFilterInput
|
Default = null |
Example
Query
query ReadResourceGroupDevicesSyncStatus(
$groupId: String!,
$filter: ResourceGroupDevicesSyncStatusFilterInput
) {
readResourceGroupDevicesSyncStatus(
groupId: $groupId,
filter: $filter
) {
groupSyncStatus
devicesSyncStatus {
deviceId
deviceName
syncStatus
groupId
syncStatusTimestamp
}
}
}
Variables
{"groupId": "xyz789", "filter": null}
Response
{
"data": {
"readResourceGroupDevicesSyncStatus": {
"groupSyncStatus": "UNKNOWN",
"devicesSyncStatus": [GroupDeviceSyncStatusType]
}
}
}
readResourceGroupsByIds
Response
Returns a PaginatedResourceGroupResponseType!
Arguments
| Name | Description |
|---|---|
groupIds - [String!]!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadResourceGroupsByIds(
$groupIds: [String!]!,
$pagination: PaginationInput
) {
readResourceGroupsByIds(
groupIds: $groupIds,
pagination: $pagination
) {
pages
items {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
itemCount
}
}
Variables
{"groupIds": ["abc123"], "pagination": null}
Response
{
"data": {
"readResourceGroupsByIds": {
"pages": 123,
"items": [ResourceGroupResponseType],
"itemCount": 123
}
}
}
readSecret
Response
Returns a SecretResponseType!
Arguments
| Name | Description |
|---|---|
secretId - String!
|
Example
Query
query ReadSecret($secretId: String!) {
readSecret(secretId: $secretId) {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
vault {
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
secrets {
...PaginatedSecretResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
name
description
}
versions {
pages
items {
...SecretVersionResponseTypeFragment
}
itemCount
}
linkedProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
name
secretType
lastVersionNumber
username
secretValue
}
}
Variables
{"secretId": "xyz789"}
Response
{
"data": {
"readSecret": {
"secretId": "abc123",
"vaultId": "xyz789",
"creationUserId": "xyz789",
"updateUserId": "abc123",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"vault": VaultResponseType,
"versions": PaginatedSecretVersionResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"name": "abc123",
"secretType": "CREDENTIAL",
"lastVersionNumber": 987,
"username": "abc123",
"secretValue": "abc123"
}
}
}
readSecretUnceiled
Response
Returns a SecretUnceiledResponseType!
Arguments
| Name | Description |
|---|---|
secretId - String!
|
Example
Query
query ReadSecretUnceiled($secretId: String!) {
readSecretUnceiled(secretId: $secretId) {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
vault {
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
secrets {
...PaginatedSecretResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
name
description
}
versions {
pages
items {
...SecretVersionUnceiledResponseTypeFragment
}
itemCount
}
linkedProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
name
secretType
lastVersionNumber
username
secretValue
}
}
Variables
{"secretId": "xyz789"}
Response
{
"data": {
"readSecretUnceiled": {
"secretId": "abc123",
"vaultId": "xyz789",
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"vault": VaultResponseType,
"versions": PaginatedSecretVersionUnceiledResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"name": "xyz789",
"secretType": "CREDENTIAL",
"lastVersionNumber": 123,
"username": "xyz789",
"secretValue": "abc123"
}
}
}
readSecretVersionsForSecret
Response
Returns a PaginatedSecretVersionResponseType!
Arguments
| Name | Description |
|---|---|
secretId - String!
|
|
filter - SecretFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadSecretVersionsForSecret(
$secretId: String!,
$filter: SecretFilterInput,
$pagination: PaginationInput
) {
readSecretVersionsForSecret(
secretId: $secretId,
filter: $filter,
pagination: $pagination
) {
pages
items {
secretId
versionNumber
username
secretValue
}
itemCount
}
}
Variables
{
"secretId": "xyz789",
"filter": null,
"pagination": null
}
Response
{
"data": {
"readSecretVersionsForSecret": {
"pages": 123,
"items": [SecretVersionResponseType],
"itemCount": 987
}
}
}
readSecretVersionsUnceiledForSecret
Response
Arguments
| Name | Description |
|---|---|
secretId - String!
|
|
filter - SecretFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadSecretVersionsUnceiledForSecret(
$secretId: String!,
$filter: SecretFilterInput,
$pagination: PaginationInput
) {
readSecretVersionsUnceiledForSecret(
secretId: $secretId,
filter: $filter,
pagination: $pagination
) {
pages
items {
secretId
versionNumber
username
secretValue
}
itemCount
}
}
Variables
{
"secretId": "abc123",
"filter": null,
"pagination": null
}
Response
{
"data": {
"readSecretVersionsUnceiledForSecret": {
"pages": 123,
"items": [SecretVersionUnceiledResponseType],
"itemCount": 987
}
}
}
readSecretsForVault
Response
Returns a PaginatedSecretResponseType!
Arguments
| Name | Description |
|---|---|
vaultId - String!
|
|
filter - SecretFilterInput
|
Default = null |
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadSecretsForVault(
$vaultId: String!,
$filter: SecretFilterInput,
$pagination: PaginationInput
) {
readSecretsForVault(
vaultId: $vaultId,
filter: $filter,
pagination: $pagination
) {
pages
items {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
vault {
...VaultResponseTypeFragment
}
versions {
...PaginatedSecretVersionResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
name
secretType
lastVersionNumber
username
secretValue
}
itemCount
}
}
Variables
{
"vaultId": "xyz789",
"filter": null,
"pagination": null
}
Response
{
"data": {
"readSecretsForVault": {
"pages": 123,
"items": [SecretResponseType],
"itemCount": 123
}
}
}
readSubGroupsForResourceGroup
Response
Returns a PaginatedResourceGroupResponseType!
Arguments
| Name | Description |
|---|---|
parentGroupId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadSubGroupsForResourceGroup(
$parentGroupId: String!,
$pagination: PaginationInput
) {
readSubGroupsForResourceGroup(
parentGroupId: $parentGroupId,
pagination: $pagination
) {
pages
items {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
itemCount
}
}
Variables
{
"parentGroupId": "xyz789",
"pagination": null
}
Response
{
"data": {
"readSubGroupsForResourceGroup": {
"pages": 123,
"items": [ResourceGroupResponseType],
"itemCount": 987
}
}
}
readTag
Response
Returns a TagResponseType!
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query ReadTag($name: String!) {
readTag(name: $name) {
name
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
documents {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
devices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
gateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
projects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
color
icon
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"readTag": {
"name": "xyz789",
"creationUserId": "abc123",
"updateUserId": "xyz789",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documents": PaginatedDocumentResponseType,
"devices": PaginatedDeviceResponseType,
"gateways": PaginatedGatewayResponseType,
"projects": PaginatedProjectResponseType,
"color": "abc123",
"icon": "abc123"
}
}
}
readTagsForResourceGroup
Response
Returns a PaginatedTagResponseType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadTagsForResourceGroup(
$groupId: String!,
$pagination: PaginationInput
) {
readTagsForResourceGroup(
groupId: $groupId,
pagination: $pagination
) {
pages
items {
name
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
color
icon
}
itemCount
}
}
Variables
{"groupId": "xyz789", "pagination": null}
Response
{
"data": {
"readTagsForResourceGroup": {
"pages": 987,
"items": [TagResponseType],
"itemCount": 123
}
}
}
readVault
Response
Returns a VaultResponseType!
Arguments
| Name | Description |
|---|---|
vaultId - String!
|
Example
Query
query ReadVault($vaultId: String!) {
readVault(vaultId: $vaultId) {
vaultId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
secrets {
pages
items {
...SecretResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
name
description
}
}
Variables
{"vaultId": "abc123"}
Response
{
"data": {
"readVault": {
"vaultId": "xyz789",
"creationUserId": "xyz789",
"updateUserId": "abc123",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"secrets": PaginatedSecretResponseType,
"linkedTags": PaginatedTagResponseType,
"name": "abc123",
"description": "xyz789"
}
}
}
readWorkstation
Response
Returns a WorkstationResponseType!
Arguments
| Name | Description |
|---|---|
workstationId - String!
|
Example
Query
query ReadWorkstation($workstationId: String!) {
readWorkstation(workstationId: $workstationId) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
workstationId
groupId
name
description
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
state {
reportedAt
state
}
metadata {
reportedAt
version
latestVersion
latestVersionForMajor
architecture
operatingSystem
operatingSystemAttrs {
... on WindowsAttrsType {
...WindowsAttrsTypeFragment
}
... on LinuxAttrsType {
...LinuxAttrsTypeFragment
}
}
numCpu
isOutdated
isOutdatedForMajor
}
publicIp {
reportedAt
publicIp
publicIpLocation {
...LocationTypeFragment
}
}
setupCommands {
expiresAt
osCommands {
...WorkstationSetupTypeFragment
}
}
deviceConnections {
pages
items {
...WorkstationDeviceConnectionTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
}
}
Variables
{"workstationId": "xyz789"}
Response
{
"data": {
"readWorkstation": {
"objectVersion": 123,
"creationUserId": "xyz789",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"workstationId": "abc123",
"groupId": "xyz789",
"name": "xyz789",
"description": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"state": WorkstationStateResponseType,
"metadata": WorkstationMetadataResponseType,
"publicIp": WorkstationPublicIpResponseType,
"setupCommands": WorkstationSetupResponseType,
"deviceConnections": PaginatedWorkstationDeviceConnectionStatusResponseType,
"linkedTags": PaginatedTagResponseType
}
}
}
readWorkstationDeviceConnections
Response
Returns a PaginatedWorkstationDeviceConnectionStatusResponseType!
Arguments
| Name | Description |
|---|---|
workstationId - String!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadWorkstationDeviceConnections(
$workstationId: String!,
$pagination: PaginationInput
) {
readWorkstationDeviceConnections(
workstationId: $workstationId,
pagination: $pagination
) {
pages
items {
connectionType
connectionId
connectionState
connectionReason
deviceId
deviceStatus
workstationId
workstationStatus
gatewayId
gatewayStatus
serverId
serverStatus
}
itemCount
}
}
Variables
{
"workstationId": "abc123",
"pagination": null
}
Response
{
"data": {
"readWorkstationDeviceConnections": {
"pages": 123,
"items": [WorkstationDeviceConnectionType],
"itemCount": 123
}
}
}
readWorkstationMetadata
Response
Returns a WorkstationMetadataResponseType
Arguments
| Name | Description |
|---|---|
workstationId - String!
|
Example
Query
query ReadWorkstationMetadata($workstationId: String!) {
readWorkstationMetadata(workstationId: $workstationId) {
reportedAt
version
latestVersion
latestVersionForMajor
architecture
operatingSystem
operatingSystemAttrs {
... on WindowsAttrsType {
...WindowsAttrsTypeFragment
}
... on LinuxAttrsType {
...LinuxAttrsTypeFragment
}
}
numCpu
isOutdated
isOutdatedForMajor
}
}
Variables
{"workstationId": "xyz789"}
Response
{
"data": {
"readWorkstationMetadata": {
"reportedAt": "2007-12-03T10:15:30Z",
"version": "xyz789",
"latestVersion": "abc123",
"latestVersionForMajor": "xyz789",
"architecture": "ARM",
"operatingSystem": "WINDOWS",
"operatingSystemAttrs": WindowsAttrsType,
"numCpu": 987,
"isOutdated": true,
"isOutdatedForMajor": true
}
}
}
readWorkstationPublicIp
Response
Returns a WorkstationPublicIpResponseType
Arguments
| Name | Description |
|---|---|
workstationId - String!
|
Example
Query
query ReadWorkstationPublicIp($workstationId: String!) {
readWorkstationPublicIp(workstationId: $workstationId) {
reportedAt
publicIp
publicIpLocation {
latitudeE6
longitudeE6
country
state
city
horizontalAccuracy
horizontalConfidenceLevelPercentage
}
}
}
Variables
{"workstationId": "xyz789"}
Response
{
"data": {
"readWorkstationPublicIp": {
"reportedAt": "2007-12-03T10:15:30Z",
"publicIp": "abc123",
"publicIpLocation": LocationType
}
}
}
readWorkstationSetup
Response
Returns a WorkstationSetupResponseType
Arguments
| Name | Description |
|---|---|
workstationId - String!
|
Example
Query
query ReadWorkstationSetup($workstationId: String!) {
readWorkstationSetup(workstationId: $workstationId) {
expiresAt
osCommands {
osType
osName
installationCommand
configurationCommand
}
}
}
Variables
{"workstationId": "abc123"}
Response
{
"data": {
"readWorkstationSetup": {
"expiresAt": "2007-12-03T10:15:30Z",
"osCommands": [WorkstationSetupType]
}
}
}
readWorkstationState
Response
Returns a WorkstationStateResponseType
Arguments
| Name | Description |
|---|---|
workstationId - String!
|
Example
Query
query ReadWorkstationState($workstationId: String!) {
readWorkstationState(workstationId: $workstationId) {
reportedAt
state
}
}
Variables
{"workstationId": "xyz789"}
Response
{
"data": {
"readWorkstationState": {
"reportedAt": "2007-12-03T10:15:30Z",
"state": "NOT_CONFIGURED"
}
}
}
readWorkstationsByIds
Response
Returns a PaginatedWorkstationResponseType!
Arguments
| Name | Description |
|---|---|
workstationIds - [String!]!
|
|
pagination - PaginationInput
|
Default = null |
Example
Query
query ReadWorkstationsByIds(
$workstationIds: [String!]!,
$pagination: PaginationInput
) {
readWorkstationsByIds(
workstationIds: $workstationIds,
pagination: $pagination
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
workstationId
groupId
name
description
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
state {
...WorkstationStateResponseTypeFragment
}
metadata {
...WorkstationMetadataResponseTypeFragment
}
publicIp {
...WorkstationPublicIpResponseTypeFragment
}
setupCommands {
...WorkstationSetupResponseTypeFragment
}
deviceConnections {
...PaginatedWorkstationDeviceConnectionStatusResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
}
itemCount
}
}
Variables
{
"workstationIds": ["xyz789"],
"pagination": null
}
Response
{
"data": {
"readWorkstationsByIds": {
"pages": 987,
"items": [WorkstationResponseType],
"itemCount": 987
}
}
}
readWorkstationsForResourceGroup
Response
Returns a PaginatedWorkstationResponseType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
|
pagination - PaginationInput
|
Default = null |
includeSubGroups - Boolean
|
Default = false |
Example
Query
query ReadWorkstationsForResourceGroup(
$groupId: String!,
$pagination: PaginationInput,
$includeSubGroups: Boolean
) {
readWorkstationsForResourceGroup(
groupId: $groupId,
pagination: $pagination,
includeSubGroups: $includeSubGroups
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
workstationId
groupId
name
description
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
state {
...WorkstationStateResponseTypeFragment
}
metadata {
...WorkstationMetadataResponseTypeFragment
}
publicIp {
...WorkstationPublicIpResponseTypeFragment
}
setupCommands {
...WorkstationSetupResponseTypeFragment
}
deviceConnections {
...PaginatedWorkstationDeviceConnectionStatusResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
}
itemCount
}
}
Variables
{
"groupId": "xyz789",
"pagination": null,
"includeSubGroups": false
}
Response
{
"data": {
"readWorkstationsForResourceGroup": {
"pages": 123,
"items": [WorkstationResponseType],
"itemCount": 123
}
}
}
Mutations
completeDocumentVersionMultipartUpload
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
documentId - String!
|
|
versionId - String!
|
|
uploadId - String!
|
|
completeUploadInput - CompleteMultipartUploadInput!
|
Example
Query
mutation CompleteDocumentVersionMultipartUpload(
$documentId: String!,
$versionId: String!,
$uploadId: String!,
$completeUploadInput: CompleteMultipartUploadInput!
) {
completeDocumentVersionMultipartUpload(
documentId: $documentId,
versionId: $versionId,
uploadId: $uploadId,
completeUploadInput: $completeUploadInput
)
}
Variables
{
"documentId": "xyz789",
"versionId": "xyz789",
"uploadId": "xyz789",
"completeUploadInput": CompleteMultipartUploadInput
}
Response
{"data": {"completeDocumentVersionMultipartUpload": null}}
completeLicenseMultipartUpload
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
licenseId - String!
|
|
uploadId - String!
|
|
completeUploadInput - CompleteMultipartUploadInput!
|
Example
Query
mutation CompleteLicenseMultipartUpload(
$licenseId: String!,
$uploadId: String!,
$completeUploadInput: CompleteMultipartUploadInput!
) {
completeLicenseMultipartUpload(
licenseId: $licenseId,
uploadId: $uploadId,
completeUploadInput: $completeUploadInput
)
}
Variables
{
"licenseId": "xyz789",
"uploadId": "xyz789",
"completeUploadInput": CompleteMultipartUploadInput
}
Response
{"data": {"completeLicenseMultipartUpload": null}}
completeProjectVersionMultipartUpload
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
projectId - String!
|
|
versionId - String!
|
|
uploadId - String!
|
|
completeUploadInput - CompleteMultipartUploadInput!
|
Example
Query
mutation CompleteProjectVersionMultipartUpload(
$projectId: String!,
$versionId: String!,
$uploadId: String!,
$completeUploadInput: CompleteMultipartUploadInput!
) {
completeProjectVersionMultipartUpload(
projectId: $projectId,
versionId: $versionId,
uploadId: $uploadId,
completeUploadInput: $completeUploadInput
)
}
Variables
{
"projectId": "abc123",
"versionId": "abc123",
"uploadId": "xyz789",
"completeUploadInput": CompleteMultipartUploadInput
}
Response
{"data": {"completeProjectVersionMultipartUpload": null}}
createAssetLink
Response
Returns an AssetLinkResponseType!
Arguments
| Name | Description |
|---|---|
sourceId - String!
|
|
sourceType - AssetTypeEnum!
|
|
destinationId - String!
|
|
destinationType - AssetTypeEnum!
|
|
input - CreateAssetLinkInput!
|
Example
Query
mutation CreateAssetLink(
$sourceId: String!,
$sourceType: AssetTypeEnum!,
$destinationId: String!,
$destinationType: AssetTypeEnum!,
$input: CreateAssetLinkInput!
) {
createAssetLink(
sourceId: $sourceId,
sourceType: $sourceType,
destinationId: $destinationId,
destinationType: $destinationType,
input: $input
) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
sourceId
sourceType
destinationId
destinationType
metaData {
... on DocumentToAssetLinkMetaDataType {
...DocumentToAssetLinkMetaDataTypeFragment
}
... on TagToAssetLinkMetaDataType {
...TagToAssetLinkMetaDataTypeFragment
}
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
}
}
Variables
{
"sourceId": "xyz789",
"sourceType": "DEVICE",
"destinationId": "xyz789",
"destinationType": "DEVICE",
"input": CreateAssetLinkInput
}
Response
{
"data": {
"createAssetLink": {
"objectVersion": 987,
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"sourceId": "abc123",
"sourceType": "DEVICE",
"destinationId": "xyz789",
"destinationType": "DEVICE",
"metaData": DocumentToAssetLinkMetaDataType
}
}
}
createDevice
Response
Returns a DeviceResponseType!
Arguments
| Name | Description |
|---|---|
device - CreateDeviceInput!
|
Example
Query
mutation CreateDevice($device: CreateDeviceInput!) {
createDevice(device: $device) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
deviceId
groupId
name
vendorId
ideConfigId
connectionConfiguration {
ipAddress
port
subnetMask
gatewayIpAddress
}
metaData
deviceType
description
secretId
ftpConfiguration {
ipAddress
port
protocol
secretId
rootDirectory
}
smbConfiguration {
ipAddress
port
protocol
secretId
rootDirectory
}
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
linkedGateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
linkedProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedSubDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
linkedParentDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
secret {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
vault {
...VaultResponseTypeFragment
}
versions {
...PaginatedSecretVersionResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
name
secretType
lastVersionNumber
username
secretValue
}
syncStatus {
targetSyncStatus
previousSyncStatus
syncType
syncTimestamp
syncErrorMessage
syncJobId
}
accumulatedSyncStatus {
targetSyncStatus
previousSyncStatus
syncTimestamp
details {
...DeviceSyncStatusResponseTypeFragment
}
}
connectivityStatus {
deviceId
primaryGateway {
...DeviceConnectivityStatusReportTypeFragment
}
allGateways {
...DeviceConnectivityStatusReportTypeFragment
}
}
}
}
Variables
{"device": CreateDeviceInput}
Response
{
"data": {
"createDevice": {
"objectVersion": 987,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"deviceId": "abc123",
"groupId": "xyz789",
"name": "abc123",
"vendorId": "xyz789",
"ideConfigId": "abc123",
"connectionConfiguration": ConnectionConfigurationType,
"metaData": {},
"deviceType": "PLC",
"description": "abc123",
"secretId": "xyz789",
"ftpConfiguration": FtpConfigurationType,
"smbConfiguration": SmbConfigurationType,
"linkMetaData": ProjectToDeviceLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"linkedGateways": PaginatedGatewayResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedSubDevices": PaginatedDeviceResponseType,
"linkedParentDevices": PaginatedDeviceResponseType,
"secret": SecretResponseType,
"syncStatus": [DeviceSyncStatusType],
"accumulatedSyncStatus": AccumulatedDeviceSyncStatusResponseType,
"connectivityStatus": DeviceConnectivityStatusType
}
}
}
createDocument
Response
Returns a CreateDocumentResponseType!
Arguments
| Name | Description |
|---|---|
document - CreateDocumentInput!
|
Example
Query
mutation CreateDocument($document: CreateDocumentInput!) {
createDocument(document: $document) {
uploadUrls {
partNumber
uploadUrl
}
uploadId
documentId
versionId
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
groupId
name
lastVersionNumber
documentType
linkMetaData {
assetVersionId
}
}
}
Variables
{"document": CreateDocumentInput}
Response
{
"data": {
"createDocument": {
"uploadUrls": [S3MultipartUploadUrlType],
"uploadId": "abc123",
"documentId": "abc123",
"versionId": "abc123",
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"groupId": "abc123",
"name": "abc123",
"lastVersionNumber": 987,
"documentType": "PDF",
"linkMetaData": DocumentToAssetLinkMetaDataType
}
}
}
createDocumentVersion
Response
Returns an DocumentVersionUploadURLResponseType!
Arguments
| Name | Description |
|---|---|
documentId - String!
|
|
documentVersion - CreateDocumentVersionInput!
|
Example
Query
mutation CreateDocumentVersion(
$documentId: String!,
$documentVersion: CreateDocumentVersionInput!
) {
createDocumentVersion(
documentId: $documentId,
documentVersion: $documentVersion
) {
uploadUrls {
partNumber
uploadUrl
}
uploadId
documentId
versionId
}
}
Variables
{
"documentId": "xyz789",
"documentVersion": CreateDocumentVersionInput
}
Response
{
"data": {
"createDocumentVersion": {
"uploadUrls": [S3MultipartUploadUrlType],
"uploadId": "xyz789",
"documentId": "abc123",
"versionId": "xyz789"
}
}
}
createGateway
Response
Returns a GatewayResponseType!
Arguments
| Name | Description |
|---|---|
gateway - CreateGatewayInput!
|
Example
Query
mutation CreateGateway($gateway: CreateGatewayInput!) {
createGateway(gateway: $gateway) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
gatewayId
groupId
name
description
linkMetaData {
primary
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
state {
reportedAt
state
}
metadata {
reportedAt
version
latestVersion
latestVersionForMajor
architecture
operatingSystem
operatingSystemAttrs {
... on WindowsAttrsType {
...WindowsAttrsTypeFragment
}
... on LinuxAttrsType {
...LinuxAttrsTypeFragment
}
}
numCpu
isOutdated
isOutdatedForMajor
}
publicIp {
reportedAt
publicIp
publicIpLocation {
...LocationTypeFragment
}
}
setupCommands {
expiresAt
osCommands {
...GatewaySetupTypeFragment
}
byMajor {
...GatewaySetupByMajorTypeFragment
}
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
configReported {
objectVersion
reportedAt
requestedAt
values {
...GlueConfigTypeFragment
}
}
configDesired {
objectVersion
reportedAt
requestedAt
values {
...GlueConfigTypeFragment
}
}
updateRequest {
requestedAt
version
}
}
}
Variables
{"gateway": CreateGatewayInput}
Response
{
"data": {
"createGateway": {
"objectVersion": 987,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"gatewayId": "abc123",
"groupId": "abc123",
"name": "abc123",
"description": "abc123",
"linkMetaData": DeviceToGatewayLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"state": GatewayStateResponseType,
"metadata": GatewayMetadataResponseType,
"publicIp": GatewayPublicIpResponseType,
"setupCommands": GatewaySetupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"linkedTags": PaginatedTagResponseType,
"configReported": GatewayConfigResponseType,
"configDesired": GatewayConfigResponseType,
"updateRequest": GatewayUpdateRequestType
}
}
}
createLicense
Response
Returns a CreateLicenseResponseType!
Arguments
| Name | Description |
|---|---|
license - CreateLicenseInput!
|
Example
Query
mutation CreateLicense($license: CreateLicenseInput!) {
createLicense(license: $license) {
uploadUrls {
partNumber
uploadUrl
}
uploadId
licenseId
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
groupId
vendorId
serialId
product
type
status
quantity
name
ideConfigId
expirationTimestamp
family
companyName
productKey
containerId
firmCode
licenseServer
}
}
Variables
{"license": CreateLicenseInput}
Response
{
"data": {
"createLicense": {
"uploadUrls": [S3MultipartUploadUrlType],
"uploadId": "abc123",
"licenseId": "xyz789",
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "xyz789",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"groupId": "xyz789",
"vendorId": "xyz789",
"serialId": "xyz789",
"product": "abc123",
"type": "CORPORATE",
"status": "REQUESTED",
"quantity": 123,
"name": "abc123",
"ideConfigId": "xyz789",
"expirationTimestamp": "2007-12-03T10:15:30Z",
"family": "xyz789",
"companyName": "xyz789",
"productKey": "abc123",
"containerId": "xyz789",
"firmCode": "abc123",
"licenseServer": "xyz789"
}
}
}
createLock
Response
Returns a LockResponseType!
Arguments
| Name | Description |
|---|---|
lock - CreateLockInput!
|
Example
Query
mutation CreateLock($lock: CreateLockInput!) {
createLock(lock: $lock) {
creationUserId
updateUserId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
}
Variables
{"lock": CreateLockInput}
Response
{
"data": {
"createLock": {
"creationUserId": "xyz789",
"updateUserId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"objectVersion": 987,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"resourceId": "abc123",
"resourceType": "xyz789",
"ownerId": "xyz789",
"service": "xyz789",
"message": "abc123"
}
}
}
createProject
Response
Returns a CreateProjectResponseType!
Arguments
| Name | Description |
|---|---|
project - CreateProjectInput!
|
Example
Query
mutation CreateProject($project: CreateProjectInput!) {
createProject(project: $project) {
uploadUrls {
partNumber
uploadUrl
}
uploadId
projectId
versionId
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
groupId
name
vendorId
ideConfigId
projectType
lastVersionNumber
description
secretId
attachedLicenses
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
}
}
}
Variables
{"project": CreateProjectInput}
Response
{
"data": {
"createProject": {
"uploadUrls": [S3MultipartUploadUrlType],
"uploadId": "abc123",
"projectId": "xyz789",
"versionId": "abc123",
"objectVersion": 987,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"groupId": "abc123",
"name": "abc123",
"vendorId": "abc123",
"ideConfigId": "xyz789",
"projectType": "STANDARD",
"lastVersionNumber": 987,
"description": "abc123",
"secretId": "abc123",
"attachedLicenses": ["xyz789"],
"linkMetaData": ProjectToDeviceLinkMetaDataType
}
}
}
createProjectVersion
Response
Returns an ProjectVersionUploadURLResponseType!
Arguments
| Name | Description |
|---|---|
projectId - String!
|
|
projectVersion - CreateProjectVersionInput!
|
Example
Query
mutation CreateProjectVersion(
$projectId: String!,
$projectVersion: CreateProjectVersionInput!
) {
createProjectVersion(
projectId: $projectId,
projectVersion: $projectVersion
) {
uploadUrls {
partNumber
uploadUrl
}
uploadId
projectId
versionId
}
}
Variables
{
"projectId": "abc123",
"projectVersion": CreateProjectVersionInput
}
Response
{
"data": {
"createProjectVersion": {
"uploadUrls": [S3MultipartUploadUrlType],
"uploadId": "xyz789",
"projectId": "xyz789",
"versionId": "abc123"
}
}
}
createResourceGroup
Response
Returns a ResourceGroupResponseType!
Arguments
| Name | Description |
|---|---|
resourceGroup - CreateResourceGroupInput!
|
Example
Query
mutation CreateResourceGroup($resourceGroup: CreateResourceGroupInput!) {
createResourceGroup(resourceGroup: $resourceGroup) {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
devices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
documents {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
gateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
licenses {
pages
items {
...LicenseResponseTypeFragment
}
itemCount
}
projects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
tags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
subGroups {
pages
items {
...ResourceGroupResponseTypeFragment
}
itemCount
}
parentGroup {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
fullPath
groupDevicesSyncStatus {
groupSyncStatus
devicesSyncStatus {
...GroupDeviceSyncStatusTypeFragment
}
}
name
groupType
isSystemGroup
}
}
Variables
{"resourceGroup": CreateResourceGroupInput}
Response
{
"data": {
"createResourceGroup": {
"groupId": "xyz789",
"parentGroupId": "xyz789",
"creationUserId": "abc123",
"updateUserId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"devices": PaginatedDeviceResponseType,
"documents": PaginatedDocumentResponseType,
"gateways": PaginatedGatewayResponseType,
"licenses": PaginatedLicenseResponseType,
"projects": PaginatedProjectResponseType,
"tags": PaginatedTagResponseType,
"subGroups": PaginatedResourceGroupResponseType,
"parentGroup": ResourceGroupResponseType,
"fullPath": "abc123",
"groupDevicesSyncStatus": ResourceGroupDevicesSyncStatusType,
"name": "abc123",
"groupType": "USER",
"isSystemGroup": false
}
}
}
createSecret
Response
Returns a SecretResponseType!
Arguments
| Name | Description |
|---|---|
secret - CreateSecretInput!
|
Example
Query
mutation CreateSecret($secret: CreateSecretInput!) {
createSecret(secret: $secret) {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
vault {
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
secrets {
...PaginatedSecretResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
name
description
}
versions {
pages
items {
...SecretVersionResponseTypeFragment
}
itemCount
}
linkedProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
name
secretType
lastVersionNumber
username
secretValue
}
}
Variables
{"secret": CreateSecretInput}
Response
{
"data": {
"createSecret": {
"secretId": "xyz789",
"vaultId": "abc123",
"creationUserId": "xyz789",
"updateUserId": "abc123",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"vault": VaultResponseType,
"versions": PaginatedSecretVersionResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"name": "abc123",
"secretType": "CREDENTIAL",
"lastVersionNumber": 987,
"username": "abc123",
"secretValue": "abc123"
}
}
}
createTag
Response
Returns a TagResponseType!
Arguments
| Name | Description |
|---|---|
tag - CreateTagInput!
|
Example
Query
mutation CreateTag($tag: CreateTagInput!) {
createTag(tag: $tag) {
name
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
documents {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
devices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
gateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
projects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
color
icon
}
}
Variables
{"tag": CreateTagInput}
Response
{
"data": {
"createTag": {
"name": "xyz789",
"creationUserId": "xyz789",
"updateUserId": "abc123",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documents": PaginatedDocumentResponseType,
"devices": PaginatedDeviceResponseType,
"gateways": PaginatedGatewayResponseType,
"projects": PaginatedProjectResponseType,
"color": "abc123",
"icon": "abc123"
}
}
}
createVault
Response
Returns a VaultResponseType!
Arguments
| Name | Description |
|---|---|
vault - CreateVaultInput!
|
Example
Query
mutation CreateVault($vault: CreateVaultInput!) {
createVault(vault: $vault) {
vaultId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
secrets {
pages
items {
...SecretResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
name
description
}
}
Variables
{"vault": CreateVaultInput}
Response
{
"data": {
"createVault": {
"vaultId": "abc123",
"creationUserId": "abc123",
"updateUserId": "xyz789",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"secrets": PaginatedSecretResponseType,
"linkedTags": PaginatedTagResponseType,
"name": "abc123",
"description": "abc123"
}
}
}
createWorkstation
Response
Returns a WorkstationResponseType!
Arguments
| Name | Description |
|---|---|
workstation - CreateWorkstationInput!
|
Example
Query
mutation CreateWorkstation($workstation: CreateWorkstationInput!) {
createWorkstation(workstation: $workstation) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
workstationId
groupId
name
description
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
state {
reportedAt
state
}
metadata {
reportedAt
version
latestVersion
latestVersionForMajor
architecture
operatingSystem
operatingSystemAttrs {
... on WindowsAttrsType {
...WindowsAttrsTypeFragment
}
... on LinuxAttrsType {
...LinuxAttrsTypeFragment
}
}
numCpu
isOutdated
isOutdatedForMajor
}
publicIp {
reportedAt
publicIp
publicIpLocation {
...LocationTypeFragment
}
}
setupCommands {
expiresAt
osCommands {
...WorkstationSetupTypeFragment
}
}
deviceConnections {
pages
items {
...WorkstationDeviceConnectionTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
}
}
Variables
{"workstation": CreateWorkstationInput}
Response
{
"data": {
"createWorkstation": {
"objectVersion": 987,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"workstationId": "xyz789",
"groupId": "xyz789",
"name": "abc123",
"description": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"state": WorkstationStateResponseType,
"metadata": WorkstationMetadataResponseType,
"publicIp": WorkstationPublicIpResponseType,
"setupCommands": WorkstationSetupResponseType,
"deviceConnections": PaginatedWorkstationDeviceConnectionStatusResponseType,
"linkedTags": PaginatedTagResponseType
}
}
}
createWorkstationDeviceConnection
Response
Returns a WorkstationDeviceConnectionType!
Example
Query
mutation CreateWorkstationDeviceConnection(
$workstationId: String!,
$deviceId: String!
) {
createWorkstationDeviceConnection(
workstationId: $workstationId,
deviceId: $deviceId
) {
connectionType
connectionId
connectionState
connectionReason
deviceId
deviceStatus
workstationId
workstationStatus
gatewayId
gatewayStatus
serverId
serverStatus
}
}
Variables
{
"workstationId": "xyz789",
"deviceId": "abc123"
}
Response
{
"data": {
"createWorkstationDeviceConnection": {
"connectionType": "abc123",
"connectionId": "xyz789",
"connectionState": "CONNECT_REQUESTED",
"connectionReason": "xyz789",
"deviceId": "abc123",
"deviceStatus": "NOT_CONFIGURED",
"workstationId": "abc123",
"workstationStatus": "NOT_CONFIGURED",
"gatewayId": "xyz789",
"gatewayStatus": "NOT_CONFIGURED",
"serverId": "xyz789",
"serverStatus": "NOT_CONFIGURED"
}
}
}
defineAssetLinksFromAsset
Response
Returns a PaginatedAssetLinkResponseType!
Arguments
| Name | Description |
|---|---|
sourceId - String!
|
|
sourceType - AssetTypeEnum!
|
|
destinationType - AssetTypeEnum!
|
|
input - [DefineAssetLinkFromAssetInput!]!
|
Example
Query
mutation DefineAssetLinksFromAsset(
$sourceId: String!,
$sourceType: AssetTypeEnum!,
$destinationType: AssetTypeEnum!,
$input: [DefineAssetLinkFromAssetInput!]!
) {
defineAssetLinksFromAsset(
sourceId: $sourceId,
sourceType: $sourceType,
destinationType: $destinationType,
input: $input
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
sourceId
sourceType
destinationId
destinationType
metaData {
... on DocumentToAssetLinkMetaDataType {
...DocumentToAssetLinkMetaDataTypeFragment
}
... on TagToAssetLinkMetaDataType {
...TagToAssetLinkMetaDataTypeFragment
}
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
}
itemCount
}
}
Variables
{
"sourceId": "xyz789",
"sourceType": "DEVICE",
"destinationType": "DEVICE",
"input": [DefineAssetLinkFromAssetInput]
}
Response
{
"data": {
"defineAssetLinksFromAsset": {
"pages": 123,
"items": [AssetLinkResponseType],
"itemCount": 123
}
}
}
defineAssetLinksToAsset
Response
Returns a PaginatedAssetLinkResponseType!
Arguments
| Name | Description |
|---|---|
sourceType - AssetTypeEnum!
|
|
destinationId - String!
|
|
destinationType - AssetTypeEnum!
|
|
input - [DefineAssetLinkToAssetInput!]!
|
Example
Query
mutation DefineAssetLinksToAsset(
$sourceType: AssetTypeEnum!,
$destinationId: String!,
$destinationType: AssetTypeEnum!,
$input: [DefineAssetLinkToAssetInput!]!
) {
defineAssetLinksToAsset(
sourceType: $sourceType,
destinationId: $destinationId,
destinationType: $destinationType,
input: $input
) {
pages
items {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
sourceId
sourceType
destinationId
destinationType
metaData {
... on DocumentToAssetLinkMetaDataType {
...DocumentToAssetLinkMetaDataTypeFragment
}
... on TagToAssetLinkMetaDataType {
...TagToAssetLinkMetaDataTypeFragment
}
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
}
itemCount
}
}
Variables
{
"sourceType": "DEVICE",
"destinationId": "xyz789",
"destinationType": "DEVICE",
"input": [DefineAssetLinkToAssetInput]
}
Response
{
"data": {
"defineAssetLinksToAsset": {
"pages": 987,
"items": [AssetLinkResponseType],
"itemCount": 123
}
}
}
deleteAssetLink
Response
Returns an AssetLinkResponseType!
Arguments
| Name | Description |
|---|---|
sourceId - String!
|
|
sourceType - AssetTypeEnum!
|
|
destinationId - String!
|
|
destinationType - AssetTypeEnum!
|
Example
Query
mutation DeleteAssetLink(
$sourceId: String!,
$sourceType: AssetTypeEnum!,
$destinationId: String!,
$destinationType: AssetTypeEnum!
) {
deleteAssetLink(
sourceId: $sourceId,
sourceType: $sourceType,
destinationId: $destinationId,
destinationType: $destinationType
) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
sourceId
sourceType
destinationId
destinationType
metaData {
... on DocumentToAssetLinkMetaDataType {
...DocumentToAssetLinkMetaDataTypeFragment
}
... on TagToAssetLinkMetaDataType {
...TagToAssetLinkMetaDataTypeFragment
}
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
}
}
Variables
{
"sourceId": "xyz789",
"sourceType": "DEVICE",
"destinationId": "xyz789",
"destinationType": "DEVICE"
}
Response
{
"data": {
"deleteAssetLink": {
"objectVersion": 123,
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"sourceId": "abc123",
"sourceType": "DEVICE",
"destinationId": "xyz789",
"destinationType": "DEVICE",
"metaData": DocumentToAssetLinkMetaDataType
}
}
}
deleteDevice
Response
Returns a DeviceResponseType!
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
Example
Query
mutation DeleteDevice($deviceId: String!) {
deleteDevice(deviceId: $deviceId) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
deviceId
groupId
name
vendorId
ideConfigId
connectionConfiguration {
ipAddress
port
subnetMask
gatewayIpAddress
}
metaData
deviceType
description
secretId
ftpConfiguration {
ipAddress
port
protocol
secretId
rootDirectory
}
smbConfiguration {
ipAddress
port
protocol
secretId
rootDirectory
}
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
linkedGateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
linkedProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedSubDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
linkedParentDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
secret {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
vault {
...VaultResponseTypeFragment
}
versions {
...PaginatedSecretVersionResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
name
secretType
lastVersionNumber
username
secretValue
}
syncStatus {
targetSyncStatus
previousSyncStatus
syncType
syncTimestamp
syncErrorMessage
syncJobId
}
accumulatedSyncStatus {
targetSyncStatus
previousSyncStatus
syncTimestamp
details {
...DeviceSyncStatusResponseTypeFragment
}
}
connectivityStatus {
deviceId
primaryGateway {
...DeviceConnectivityStatusReportTypeFragment
}
allGateways {
...DeviceConnectivityStatusReportTypeFragment
}
}
}
}
Variables
{"deviceId": "xyz789"}
Response
{
"data": {
"deleteDevice": {
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"deviceId": "abc123",
"groupId": "xyz789",
"name": "abc123",
"vendorId": "abc123",
"ideConfigId": "xyz789",
"connectionConfiguration": ConnectionConfigurationType,
"metaData": {},
"deviceType": "PLC",
"description": "abc123",
"secretId": "abc123",
"ftpConfiguration": FtpConfigurationType,
"smbConfiguration": SmbConfigurationType,
"linkMetaData": ProjectToDeviceLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"linkedGateways": PaginatedGatewayResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedSubDevices": PaginatedDeviceResponseType,
"linkedParentDevices": PaginatedDeviceResponseType,
"secret": SecretResponseType,
"syncStatus": [DeviceSyncStatusType],
"accumulatedSyncStatus": AccumulatedDeviceSyncStatusResponseType,
"connectivityStatus": DeviceConnectivityStatusType
}
}
}
deleteDocument
Response
Returns a DocumentResponseType!
Arguments
| Name | Description |
|---|---|
documentId - String!
|
Example
Query
mutation DeleteDocument($documentId: String!) {
deleteDocument(documentId: $documentId) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
documentId
groupId
name
lastVersionNumber
documentType
linkMetaData {
assetVersionId
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
versions {
pages
items {
...DocumentVersionResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
}
}
Variables
{"documentId": "abc123"}
Response
{
"data": {
"deleteDocument": {
"objectVersion": 987,
"creationUserId": "xyz789",
"updateUserId": "abc123",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documentId": "abc123",
"groupId": "abc123",
"name": "xyz789",
"lastVersionNumber": 123,
"documentType": "PDF",
"linkMetaData": DocumentToAssetLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"versions": PaginatedDocumentVersionResponseType,
"linkedTags": PaginatedTagResponseType
}
}
}
deleteDocumentVersion
Response
Returns a DocumentVersionResponseType!
Example
Query
mutation DeleteDocumentVersion(
$documentId: String!,
$versionId: String!
) {
deleteDocumentVersion(
documentId: $documentId,
versionId: $versionId
) {
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
documentId
versionId
versionNumber
documentFile {
fileName
fileExtension
fileSize
}
commitMessage
}
}
Variables
{
"documentId": "abc123",
"versionId": "abc123"
}
Response
{
"data": {
"deleteDocumentVersion": {
"creationUserId": "abc123",
"updateUserId": "xyz789",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documentId": "abc123",
"versionId": "xyz789",
"versionNumber": 123,
"documentFile": DocumentVersionFileType,
"commitMessage": "abc123"
}
}
}
deleteGateway
Response
Returns a GatewayResponseType!
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
Example
Query
mutation DeleteGateway($gatewayId: String!) {
deleteGateway(gatewayId: $gatewayId) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
gatewayId
groupId
name
description
linkMetaData {
primary
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
state {
reportedAt
state
}
metadata {
reportedAt
version
latestVersion
latestVersionForMajor
architecture
operatingSystem
operatingSystemAttrs {
... on WindowsAttrsType {
...WindowsAttrsTypeFragment
}
... on LinuxAttrsType {
...LinuxAttrsTypeFragment
}
}
numCpu
isOutdated
isOutdatedForMajor
}
publicIp {
reportedAt
publicIp
publicIpLocation {
...LocationTypeFragment
}
}
setupCommands {
expiresAt
osCommands {
...GatewaySetupTypeFragment
}
byMajor {
...GatewaySetupByMajorTypeFragment
}
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
configReported {
objectVersion
reportedAt
requestedAt
values {
...GlueConfigTypeFragment
}
}
configDesired {
objectVersion
reportedAt
requestedAt
values {
...GlueConfigTypeFragment
}
}
updateRequest {
requestedAt
version
}
}
}
Variables
{"gatewayId": "xyz789"}
Response
{
"data": {
"deleteGateway": {
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"gatewayId": "abc123",
"groupId": "abc123",
"name": "xyz789",
"description": "xyz789",
"linkMetaData": DeviceToGatewayLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"state": GatewayStateResponseType,
"metadata": GatewayMetadataResponseType,
"publicIp": GatewayPublicIpResponseType,
"setupCommands": GatewaySetupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"linkedTags": PaginatedTagResponseType,
"configReported": GatewayConfigResponseType,
"configDesired": GatewayConfigResponseType,
"updateRequest": GatewayUpdateRequestType
}
}
}
deleteLicense
Response
Returns a LicenseResponseType!
Arguments
| Name | Description |
|---|---|
licenseId - String!
|
Example
Query
mutation DeleteLicense($licenseId: String!) {
deleteLicense(licenseId: $licenseId) {
licenseId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
vendorId
serialId
product
type
status
quantity
name
ideConfigId
expirationTimestamp
family
companyName
productKey
containerId
firmCode
licenseServer
}
}
Variables
{"licenseId": "xyz789"}
Response
{
"data": {
"deleteLicense": {
"licenseId": "xyz789",
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"vendorId": "xyz789",
"serialId": "abc123",
"product": "xyz789",
"type": "CORPORATE",
"status": "REQUESTED",
"quantity": 987,
"name": "abc123",
"ideConfigId": "abc123",
"expirationTimestamp": "2007-12-03T10:15:30Z",
"family": "abc123",
"companyName": "abc123",
"productKey": "abc123",
"containerId": "abc123",
"firmCode": "xyz789",
"licenseServer": "abc123"
}
}
}
deleteLock
Response
Returns a LockResponseType!
Example
Query
mutation DeleteLock(
$resourceType: String!,
$resourceId: String!
) {
deleteLock(
resourceType: $resourceType,
resourceId: $resourceId
) {
creationUserId
updateUserId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
}
Variables
{
"resourceType": "xyz789",
"resourceId": "xyz789"
}
Response
{
"data": {
"deleteLock": {
"creationUserId": "abc123",
"updateUserId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"objectVersion": 123,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"resourceId": "abc123",
"resourceType": "abc123",
"ownerId": "abc123",
"service": "xyz789",
"message": "xyz789"
}
}
}
deleteProject
Response
Returns a ProjectResponseType!
Arguments
| Name | Description |
|---|---|
projectId - String!
|
Example
Query
mutation DeleteProject($projectId: String!) {
deleteProject(projectId: $projectId) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
projectId
groupId
name
vendorId
ideConfigId
projectType
lastVersionNumber
description
secretId
attachedLicenses
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
linkedSubProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedParentProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
versions {
pages
items {
...ProjectVersionResponseTypeFragment
}
itemCount
}
secret {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
vault {
...VaultResponseTypeFragment
}
versions {
...PaginatedSecretVersionResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
name
secretType
lastVersionNumber
username
secretValue
}
}
}
Variables
{"projectId": "xyz789"}
Response
{
"data": {
"deleteProject": {
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "xyz789",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"projectId": "abc123",
"groupId": "xyz789",
"name": "xyz789",
"vendorId": "xyz789",
"ideConfigId": "abc123",
"projectType": "STANDARD",
"lastVersionNumber": 123,
"description": "xyz789",
"secretId": "xyz789",
"attachedLicenses": ["xyz789"],
"linkMetaData": ProjectToDeviceLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"linkedSubProjects": PaginatedProjectResponseType,
"linkedParentProjects": PaginatedProjectResponseType,
"versions": PaginatedProjectVersionResponseType,
"secret": SecretResponseType
}
}
}
deleteProjectVersion
Response
Returns a ProjectVersionResponseType!
Example
Query
mutation DeleteProjectVersion(
$projectId: String!,
$versionId: String!
) {
deleteProjectVersion(
projectId: $projectId,
versionId: $versionId
) {
projectId
versionId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
deviceInformation {
name
description
deviceType
ethernetCommunication {
...EthernetCommunicationTypeFragment
}
originDeviceType
nameAndType
}
downloadUrl
vendorId
ideConfigId
versionNumber
projectFile {
fileName
fileExtension
fileSize
}
source
commitMessage
commitId
}
}
Variables
{
"projectId": "xyz789",
"versionId": "abc123"
}
Response
{
"data": {
"deleteProjectVersion": {
"projectId": "xyz789",
"versionId": "xyz789",
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"deviceInformation": [DeviceInformationType],
"downloadUrl": "xyz789",
"vendorId": "xyz789",
"ideConfigId": "abc123",
"versionNumber": 123,
"projectFile": ProjectVersionFileType,
"source": "UPLOAD",
"commitMessage": "abc123",
"commitId": "abc123"
}
}
}
deleteResourceGroup
Response
Returns a ResourceGroupResponseType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
Example
Query
mutation DeleteResourceGroup($groupId: String!) {
deleteResourceGroup(groupId: $groupId) {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
devices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
documents {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
gateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
licenses {
pages
items {
...LicenseResponseTypeFragment
}
itemCount
}
projects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
tags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
subGroups {
pages
items {
...ResourceGroupResponseTypeFragment
}
itemCount
}
parentGroup {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
fullPath
groupDevicesSyncStatus {
groupSyncStatus
devicesSyncStatus {
...GroupDeviceSyncStatusTypeFragment
}
}
name
groupType
isSystemGroup
}
}
Variables
{"groupId": "abc123"}
Response
{
"data": {
"deleteResourceGroup": {
"groupId": "abc123",
"parentGroupId": "xyz789",
"creationUserId": "abc123",
"updateUserId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"devices": PaginatedDeviceResponseType,
"documents": PaginatedDocumentResponseType,
"gateways": PaginatedGatewayResponseType,
"licenses": PaginatedLicenseResponseType,
"projects": PaginatedProjectResponseType,
"tags": PaginatedTagResponseType,
"subGroups": PaginatedResourceGroupResponseType,
"parentGroup": ResourceGroupResponseType,
"fullPath": "xyz789",
"groupDevicesSyncStatus": ResourceGroupDevicesSyncStatusType,
"name": "abc123",
"groupType": "USER",
"isSystemGroup": true
}
}
}
deleteSecret
Response
Returns a SecretResponseType!
Arguments
| Name | Description |
|---|---|
secretId - String!
|
Example
Query
mutation DeleteSecret($secretId: String!) {
deleteSecret(secretId: $secretId) {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
vault {
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
secrets {
...PaginatedSecretResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
name
description
}
versions {
pages
items {
...SecretVersionResponseTypeFragment
}
itemCount
}
linkedProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
name
secretType
lastVersionNumber
username
secretValue
}
}
Variables
{"secretId": "abc123"}
Response
{
"data": {
"deleteSecret": {
"secretId": "abc123",
"vaultId": "xyz789",
"creationUserId": "abc123",
"updateUserId": "abc123",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"vault": VaultResponseType,
"versions": PaginatedSecretVersionResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"name": "abc123",
"secretType": "CREDENTIAL",
"lastVersionNumber": 987,
"username": "xyz789",
"secretValue": "xyz789"
}
}
}
deleteTag
Response
Returns a TagResponseType!
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
mutation DeleteTag($name: String!) {
deleteTag(name: $name) {
name
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
documents {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
devices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
gateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
projects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
color
icon
}
}
Variables
{"name": "xyz789"}
Response
{
"data": {
"deleteTag": {
"name": "xyz789",
"creationUserId": "abc123",
"updateUserId": "xyz789",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documents": PaginatedDocumentResponseType,
"devices": PaginatedDeviceResponseType,
"gateways": PaginatedGatewayResponseType,
"projects": PaginatedProjectResponseType,
"color": "abc123",
"icon": "xyz789"
}
}
}
deleteVault
Response
Returns a VaultResponseType!
Arguments
| Name | Description |
|---|---|
vaultId - String!
|
Example
Query
mutation DeleteVault($vaultId: String!) {
deleteVault(vaultId: $vaultId) {
vaultId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
secrets {
pages
items {
...SecretResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
name
description
}
}
Variables
{"vaultId": "xyz789"}
Response
{
"data": {
"deleteVault": {
"vaultId": "xyz789",
"creationUserId": "xyz789",
"updateUserId": "abc123",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"secrets": PaginatedSecretResponseType,
"linkedTags": PaginatedTagResponseType,
"name": "xyz789",
"description": "abc123"
}
}
}
deleteWorkstation
Response
Returns a WorkstationResponseType!
Arguments
| Name | Description |
|---|---|
workstationId - String!
|
Example
Query
mutation DeleteWorkstation($workstationId: String!) {
deleteWorkstation(workstationId: $workstationId) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
workstationId
groupId
name
description
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
state {
reportedAt
state
}
metadata {
reportedAt
version
latestVersion
latestVersionForMajor
architecture
operatingSystem
operatingSystemAttrs {
... on WindowsAttrsType {
...WindowsAttrsTypeFragment
}
... on LinuxAttrsType {
...LinuxAttrsTypeFragment
}
}
numCpu
isOutdated
isOutdatedForMajor
}
publicIp {
reportedAt
publicIp
publicIpLocation {
...LocationTypeFragment
}
}
setupCommands {
expiresAt
osCommands {
...WorkstationSetupTypeFragment
}
}
deviceConnections {
pages
items {
...WorkstationDeviceConnectionTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
}
}
Variables
{"workstationId": "abc123"}
Response
{
"data": {
"deleteWorkstation": {
"objectVersion": 987,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"workstationId": "xyz789",
"groupId": "xyz789",
"name": "abc123",
"description": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"state": WorkstationStateResponseType,
"metadata": WorkstationMetadataResponseType,
"publicIp": WorkstationPublicIpResponseType,
"setupCommands": WorkstationSetupResponseType,
"deviceConnections": PaginatedWorkstationDeviceConnectionStatusResponseType,
"linkedTags": PaginatedTagResponseType
}
}
}
deleteWorkstationDeviceConnection
Response
Returns a WorkstationDeviceConnectionType!
Example
Query
mutation DeleteWorkstationDeviceConnection(
$workstationId: String!,
$deviceId: String!
) {
deleteWorkstationDeviceConnection(
workstationId: $workstationId,
deviceId: $deviceId
) {
connectionType
connectionId
connectionState
connectionReason
deviceId
deviceStatus
workstationId
workstationStatus
gatewayId
gatewayStatus
serverId
serverStatus
}
}
Variables
{
"workstationId": "xyz789",
"deviceId": "xyz789"
}
Response
{
"data": {
"deleteWorkstationDeviceConnection": {
"connectionType": "xyz789",
"connectionId": "abc123",
"connectionState": "CONNECT_REQUESTED",
"connectionReason": "abc123",
"deviceId": "abc123",
"deviceStatus": "NOT_CONFIGURED",
"workstationId": "xyz789",
"workstationStatus": "NOT_CONFIGURED",
"gatewayId": "abc123",
"gatewayStatus": "NOT_CONFIGURED",
"serverId": "xyz789",
"serverStatus": "NOT_CONFIGURED"
}
}
}
requestGatewayUpdate
Response
Returns a GatewayUpdateRequestType!
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
Example
Query
mutation RequestGatewayUpdate($gatewayId: String!) {
requestGatewayUpdate(gatewayId: $gatewayId) {
requestedAt
version
}
}
Variables
{"gatewayId": "xyz789"}
Response
{
"data": {
"requestGatewayUpdate": {
"requestedAt": "2007-12-03T10:15:30Z",
"version": "xyz789"
}
}
}
updateAssetLink
Response
Returns an AssetLinkResponseType!
Arguments
| Name | Description |
|---|---|
sourceId - String!
|
|
sourceType - AssetTypeEnum!
|
|
destinationId - String!
|
|
destinationType - AssetTypeEnum!
|
|
input - UpdateAssetLinkInput!
|
Example
Query
mutation UpdateAssetLink(
$sourceId: String!,
$sourceType: AssetTypeEnum!,
$destinationId: String!,
$destinationType: AssetTypeEnum!,
$input: UpdateAssetLinkInput!
) {
updateAssetLink(
sourceId: $sourceId,
sourceType: $sourceType,
destinationId: $destinationId,
destinationType: $destinationType,
input: $input
) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
sourceId
sourceType
destinationId
destinationType
metaData {
... on DocumentToAssetLinkMetaDataType {
...DocumentToAssetLinkMetaDataTypeFragment
}
... on TagToAssetLinkMetaDataType {
...TagToAssetLinkMetaDataTypeFragment
}
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
}
}
Variables
{
"sourceId": "xyz789",
"sourceType": "DEVICE",
"destinationId": "abc123",
"destinationType": "DEVICE",
"input": UpdateAssetLinkInput
}
Response
{
"data": {
"updateAssetLink": {
"objectVersion": 987,
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"sourceId": "abc123",
"sourceType": "DEVICE",
"destinationId": "abc123",
"destinationType": "DEVICE",
"metaData": DocumentToAssetLinkMetaDataType
}
}
}
updateDevice
Response
Returns a DeviceResponseType!
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
|
device - UpdateDeviceInput!
|
Example
Query
mutation UpdateDevice(
$deviceId: String!,
$device: UpdateDeviceInput!
) {
updateDevice(
deviceId: $deviceId,
device: $device
) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
deviceId
groupId
name
vendorId
ideConfigId
connectionConfiguration {
ipAddress
port
subnetMask
gatewayIpAddress
}
metaData
deviceType
description
secretId
ftpConfiguration {
ipAddress
port
protocol
secretId
rootDirectory
}
smbConfiguration {
ipAddress
port
protocol
secretId
rootDirectory
}
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on DeviceToDeviceLinkMetaDataType {
...DeviceToDeviceLinkMetaDataTypeFragment
}
... on DeviceToGatewayLinkMetaDataType {
...DeviceToGatewayLinkMetaDataTypeFragment
}
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
linkedGateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
linkedProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedSubDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
linkedParentDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
secret {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
vault {
...VaultResponseTypeFragment
}
versions {
...PaginatedSecretVersionResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
name
secretType
lastVersionNumber
username
secretValue
}
syncStatus {
targetSyncStatus
previousSyncStatus
syncType
syncTimestamp
syncErrorMessage
syncJobId
}
accumulatedSyncStatus {
targetSyncStatus
previousSyncStatus
syncTimestamp
details {
...DeviceSyncStatusResponseTypeFragment
}
}
connectivityStatus {
deviceId
primaryGateway {
...DeviceConnectivityStatusReportTypeFragment
}
allGateways {
...DeviceConnectivityStatusReportTypeFragment
}
}
}
}
Variables
{
"deviceId": "abc123",
"device": UpdateDeviceInput
}
Response
{
"data": {
"updateDevice": {
"objectVersion": 987,
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"deviceId": "abc123",
"groupId": "abc123",
"name": "xyz789",
"vendorId": "abc123",
"ideConfigId": "xyz789",
"connectionConfiguration": ConnectionConfigurationType,
"metaData": {},
"deviceType": "PLC",
"description": "xyz789",
"secretId": "abc123",
"ftpConfiguration": FtpConfigurationType,
"smbConfiguration": SmbConfigurationType,
"linkMetaData": ProjectToDeviceLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"linkedGateways": PaginatedGatewayResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedSubDevices": PaginatedDeviceResponseType,
"linkedParentDevices": PaginatedDeviceResponseType,
"secret": SecretResponseType,
"syncStatus": [DeviceSyncStatusType],
"accumulatedSyncStatus": AccumulatedDeviceSyncStatusResponseType,
"connectivityStatus": DeviceConnectivityStatusType
}
}
}
updateDocument
Response
Returns a DocumentResponseType!
Arguments
| Name | Description |
|---|---|
documentId - String!
|
|
document - UpdateDocumentInput!
|
Example
Query
mutation UpdateDocument(
$documentId: String!,
$document: UpdateDocumentInput!
) {
updateDocument(
documentId: $documentId,
document: $document
) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
documentId
groupId
name
lastVersionNumber
documentType
linkMetaData {
assetVersionId
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
versions {
pages
items {
...DocumentVersionResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
}
}
Variables
{
"documentId": "xyz789",
"document": UpdateDocumentInput
}
Response
{
"data": {
"updateDocument": {
"objectVersion": 987,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documentId": "xyz789",
"groupId": "xyz789",
"name": "xyz789",
"lastVersionNumber": 987,
"documentType": "PDF",
"linkMetaData": DocumentToAssetLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"versions": PaginatedDocumentVersionResponseType,
"linkedTags": PaginatedTagResponseType
}
}
}
updateDocumentVersion
Response
Returns a DocumentVersionResponseType!
Arguments
| Name | Description |
|---|---|
documentId - String!
|
|
versionId - String!
|
|
documentVersion - UpdateDocumentVersionInput!
|
Example
Query
mutation UpdateDocumentVersion(
$documentId: String!,
$versionId: String!,
$documentVersion: UpdateDocumentVersionInput!
) {
updateDocumentVersion(
documentId: $documentId,
versionId: $versionId,
documentVersion: $documentVersion
) {
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
documentId
versionId
versionNumber
documentFile {
fileName
fileExtension
fileSize
}
commitMessage
}
}
Variables
{
"documentId": "xyz789",
"versionId": "abc123",
"documentVersion": UpdateDocumentVersionInput
}
Response
{
"data": {
"updateDocumentVersion": {
"creationUserId": "xyz789",
"updateUserId": "abc123",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documentId": "abc123",
"versionId": "abc123",
"versionNumber": 123,
"documentFile": DocumentVersionFileType,
"commitMessage": "abc123"
}
}
}
updateGateway
Response
Returns a GatewayResponseType!
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
|
gateway - UpdateGatewayInput!
|
Example
Query
mutation UpdateGateway(
$gatewayId: String!,
$gateway: UpdateGatewayInput!
) {
updateGateway(
gatewayId: $gatewayId,
gateway: $gateway
) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
gatewayId
groupId
name
description
linkMetaData {
primary
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
state {
reportedAt
state
}
metadata {
reportedAt
version
latestVersion
latestVersionForMajor
architecture
operatingSystem
operatingSystemAttrs {
... on WindowsAttrsType {
...WindowsAttrsTypeFragment
}
... on LinuxAttrsType {
...LinuxAttrsTypeFragment
}
}
numCpu
isOutdated
isOutdatedForMajor
}
publicIp {
reportedAt
publicIp
publicIpLocation {
...LocationTypeFragment
}
}
setupCommands {
expiresAt
osCommands {
...GatewaySetupTypeFragment
}
byMajor {
...GatewaySetupByMajorTypeFragment
}
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
configReported {
objectVersion
reportedAt
requestedAt
values {
...GlueConfigTypeFragment
}
}
configDesired {
objectVersion
reportedAt
requestedAt
values {
...GlueConfigTypeFragment
}
}
updateRequest {
requestedAt
version
}
}
}
Variables
{
"gatewayId": "abc123",
"gateway": UpdateGatewayInput
}
Response
{
"data": {
"updateGateway": {
"objectVersion": 123,
"creationUserId": "xyz789",
"updateUserId": "abc123",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"gatewayId": "abc123",
"groupId": "xyz789",
"name": "xyz789",
"description": "xyz789",
"linkMetaData": DeviceToGatewayLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"state": GatewayStateResponseType,
"metadata": GatewayMetadataResponseType,
"publicIp": GatewayPublicIpResponseType,
"setupCommands": GatewaySetupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"linkedTags": PaginatedTagResponseType,
"configReported": GatewayConfigResponseType,
"configDesired": GatewayConfigResponseType,
"updateRequest": GatewayUpdateRequestType
}
}
}
updateGatewayConfig
Response
Returns a GatewayConfigResponseType!
Arguments
| Name | Description |
|---|---|
gatewayId - String!
|
|
config - GatewayConfigUpdateInput!
|
Example
Query
mutation UpdateGatewayConfig(
$gatewayId: String!,
$config: GatewayConfigUpdateInput!
) {
updateGatewayConfig(
gatewayId: $gatewayId,
config: $config
) {
objectVersion
reportedAt
requestedAt
values {
metaVersion
updateAuto
updatePeriod
updateUnstable
proxyAll
proxyHttp
proxyHttps
iotTransport
natMode
sslTunnel
sslTunnelInsecure
webuiEnabled
webuiBase
webuiPort
}
}
}
Variables
{
"gatewayId": "xyz789",
"config": GatewayConfigUpdateInput
}
Response
{
"data": {
"updateGatewayConfig": {
"objectVersion": 987,
"reportedAt": "2007-12-03T10:15:30Z",
"requestedAt": "2007-12-03T10:15:30Z",
"values": GlueConfigType
}
}
}
updateLicense
Response
Returns a LicenseResponseType!
Arguments
| Name | Description |
|---|---|
licenseId - String!
|
|
license - UpdateLicenseInput!
|
Example
Query
mutation UpdateLicense(
$licenseId: String!,
$license: UpdateLicenseInput!
) {
updateLicense(
licenseId: $licenseId,
license: $license
) {
licenseId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
vendorId
serialId
product
type
status
quantity
name
ideConfigId
expirationTimestamp
family
companyName
productKey
containerId
firmCode
licenseServer
}
}
Variables
{
"licenseId": "abc123",
"license": UpdateLicenseInput
}
Response
{
"data": {
"updateLicense": {
"licenseId": "xyz789",
"creationUserId": "abc123",
"updateUserId": "xyz789",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"vendorId": "abc123",
"serialId": "abc123",
"product": "abc123",
"type": "CORPORATE",
"status": "REQUESTED",
"quantity": 987,
"name": "xyz789",
"ideConfigId": "xyz789",
"expirationTimestamp": "2007-12-03T10:15:30Z",
"family": "xyz789",
"companyName": "xyz789",
"productKey": "abc123",
"containerId": "xyz789",
"firmCode": "xyz789",
"licenseServer": "abc123"
}
}
}
updateProject
Response
Returns a ProjectResponseType!
Arguments
| Name | Description |
|---|---|
projectId - String!
|
|
project - UpdateProjectInput!
|
Example
Query
mutation UpdateProject(
$projectId: String!,
$project: UpdateProjectInput!
) {
updateProject(
projectId: $projectId,
project: $project
) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
projectId
groupId
name
vendorId
ideConfigId
projectType
lastVersionNumber
description
secretId
attachedLicenses
linkMetaData {
... on ProjectToDeviceLinkMetaDataType {
...ProjectToDeviceLinkMetaDataTypeFragment
}
... on ProjectToProjectLinkMetaDataType {
...ProjectToProjectLinkMetaDataTypeFragment
}
}
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
linkedDocuments {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
linkedSubProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedParentProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
versions {
pages
items {
...ProjectVersionResponseTypeFragment
}
itemCount
}
secret {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
vault {
...VaultResponseTypeFragment
}
versions {
...PaginatedSecretVersionResponseTypeFragment
}
linkedProjects {
...PaginatedProjectResponseTypeFragment
}
linkedDevices {
...PaginatedDeviceResponseTypeFragment
}
name
secretType
lastVersionNumber
username
secretValue
}
}
}
Variables
{
"projectId": "abc123",
"project": UpdateProjectInput
}
Response
{
"data": {
"updateProject": {
"objectVersion": 987,
"creationUserId": "abc123",
"updateUserId": "xyz789",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"projectId": "xyz789",
"groupId": "xyz789",
"name": "abc123",
"vendorId": "xyz789",
"ideConfigId": "xyz789",
"projectType": "STANDARD",
"lastVersionNumber": 987,
"description": "xyz789",
"secretId": "abc123",
"attachedLicenses": ["abc123"],
"linkMetaData": ProjectToDeviceLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"linkedSubProjects": PaginatedProjectResponseType,
"linkedParentProjects": PaginatedProjectResponseType,
"versions": PaginatedProjectVersionResponseType,
"secret": SecretResponseType
}
}
}
updateProjectVersion
Response
Returns a ProjectVersionResponseType!
Arguments
| Name | Description |
|---|---|
projectId - String!
|
|
versionId - String!
|
|
projectVersion - UpdateProjectVersionInput!
|
Example
Query
mutation UpdateProjectVersion(
$projectId: String!,
$versionId: String!,
$projectVersion: UpdateProjectVersionInput!
) {
updateProjectVersion(
projectId: $projectId,
versionId: $versionId,
projectVersion: $projectVersion
) {
projectId
versionId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
deviceInformation {
name
description
deviceType
ethernetCommunication {
...EthernetCommunicationTypeFragment
}
originDeviceType
nameAndType
}
downloadUrl
vendorId
ideConfigId
versionNumber
projectFile {
fileName
fileExtension
fileSize
}
source
commitMessage
commitId
}
}
Variables
{
"projectId": "abc123",
"versionId": "abc123",
"projectVersion": UpdateProjectVersionInput
}
Response
{
"data": {
"updateProjectVersion": {
"projectId": "abc123",
"versionId": "abc123",
"creationUserId": "abc123",
"updateUserId": "abc123",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"deviceInformation": [DeviceInformationType],
"downloadUrl": "abc123",
"vendorId": "abc123",
"ideConfigId": "xyz789",
"versionNumber": 987,
"projectFile": ProjectVersionFileType,
"source": "UPLOAD",
"commitMessage": "xyz789",
"commitId": "xyz789"
}
}
}
updateResourceGroup
Response
Returns a ResourceGroupResponseType!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
|
resourceGroup - UpdateResourceGroupInput!
|
Example
Query
mutation UpdateResourceGroup(
$groupId: String!,
$resourceGroup: UpdateResourceGroupInput!
) {
updateResourceGroup(
groupId: $groupId,
resourceGroup: $resourceGroup
) {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
devices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
documents {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
gateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
licenses {
pages
items {
...LicenseResponseTypeFragment
}
itemCount
}
projects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
tags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
subGroups {
pages
items {
...ResourceGroupResponseTypeFragment
}
itemCount
}
parentGroup {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
fullPath
groupDevicesSyncStatus {
groupSyncStatus
devicesSyncStatus {
...GroupDeviceSyncStatusTypeFragment
}
}
name
groupType
isSystemGroup
}
}
Variables
{
"groupId": "abc123",
"resourceGroup": UpdateResourceGroupInput
}
Response
{
"data": {
"updateResourceGroup": {
"groupId": "abc123",
"parentGroupId": "xyz789",
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"devices": PaginatedDeviceResponseType,
"documents": PaginatedDocumentResponseType,
"gateways": PaginatedGatewayResponseType,
"licenses": PaginatedLicenseResponseType,
"projects": PaginatedProjectResponseType,
"tags": PaginatedTagResponseType,
"subGroups": PaginatedResourceGroupResponseType,
"parentGroup": ResourceGroupResponseType,
"fullPath": "abc123",
"groupDevicesSyncStatus": ResourceGroupDevicesSyncStatusType,
"name": "abc123",
"groupType": "USER",
"isSystemGroup": false
}
}
}
updateSecret
Response
Returns a SecretResponseType!
Arguments
| Name | Description |
|---|---|
secretId - String!
|
|
secret - UpdateSecretInput!
|
Example
Query
mutation UpdateSecret(
$secretId: String!,
$secret: UpdateSecretInput!
) {
updateSecret(
secretId: $secretId,
secret: $secret
) {
secretId
vaultId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
vault {
vaultId
creationUserId
updateUserId
groupId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
secrets {
...PaginatedSecretResponseTypeFragment
}
linkedTags {
...PaginatedTagResponseTypeFragment
}
name
description
}
versions {
pages
items {
...SecretVersionResponseTypeFragment
}
itemCount
}
linkedProjects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
linkedDevices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
name
secretType
lastVersionNumber
username
secretValue
}
}
Variables
{
"secretId": "xyz789",
"secret": UpdateSecretInput
}
Response
{
"data": {
"updateSecret": {
"secretId": "xyz789",
"vaultId": "abc123",
"creationUserId": "xyz789",
"updateUserId": "abc123",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"vault": VaultResponseType,
"versions": PaginatedSecretVersionResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"name": "abc123",
"secretType": "CREDENTIAL",
"lastVersionNumber": 987,
"username": "abc123",
"secretValue": "xyz789"
}
}
}
updateTag
Response
Returns a TagResponseType!
Arguments
| Name | Description |
|---|---|
name - String!
|
|
tag - UpdateTagInput!
|
Example
Query
mutation UpdateTag(
$name: String!,
$tag: UpdateTagInput!
) {
updateTag(
name: $name,
tag: $tag
) {
name
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
documents {
pages
items {
...DocumentResponseTypeFragment
}
itemCount
}
devices {
pages
items {
...DeviceResponseTypeFragment
}
itemCount
}
gateways {
pages
items {
...GatewayResponseTypeFragment
}
itemCount
}
projects {
pages
items {
...ProjectResponseTypeFragment
}
itemCount
}
color
icon
}
}
Variables
{
"name": "abc123",
"tag": UpdateTagInput
}
Response
{
"data": {
"updateTag": {
"name": "xyz789",
"creationUserId": "abc123",
"updateUserId": "xyz789",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documents": PaginatedDocumentResponseType,
"devices": PaginatedDeviceResponseType,
"gateways": PaginatedGatewayResponseType,
"projects": PaginatedProjectResponseType,
"color": "xyz789",
"icon": "abc123"
}
}
}
updateVault
Response
Returns a VaultResponseType!
Arguments
| Name | Description |
|---|---|
vaultId - String!
|
|
vault - UpdateVaultInput!
|
Example
Query
mutation UpdateVault(
$vaultId: String!,
$vault: UpdateVaultInput!
) {
updateVault(
vaultId: $vaultId,
vault: $vault
) {
vaultId
creationUserId
updateUserId
groupId
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
secrets {
pages
items {
...SecretResponseTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
name
description
}
}
Variables
{
"vaultId": "abc123",
"vault": UpdateVaultInput
}
Response
{
"data": {
"updateVault": {
"vaultId": "abc123",
"creationUserId": "abc123",
"updateUserId": "xyz789",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"secrets": PaginatedSecretResponseType,
"linkedTags": PaginatedTagResponseType,
"name": "xyz789",
"description": "abc123"
}
}
}
updateWorkstation
Response
Returns a WorkstationResponseType!
Arguments
| Name | Description |
|---|---|
workstationId - String!
|
|
workstation - UpdateWorkstationInput!
|
Example
Query
mutation UpdateWorkstation(
$workstationId: String!,
$workstation: UpdateWorkstationInput!
) {
updateWorkstation(
workstationId: $workstationId,
workstation: $workstation
) {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
lock {
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
resourceId
resourceType
ownerId
service
message
}
workstationId
groupId
name
description
creationUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
updateUser {
objectVersion
creationUserId
updateUserId
deleteUserId
creationTimestamp
updateTimestamp
userId
groupId
firstName
lastName
email
}
group {
groupId
parentGroupId
creationUserId
updateUserId
creationUser {
...UserResponseTypeFragment
}
updateUser {
...UserResponseTypeFragment
}
group {
...ResourceGroupResponseTypeFragment
}
objectVersion
deleteUserId
creationTimestamp
updateTimestamp
lock {
...LockResponseTypeFragment
}
devices {
...PaginatedDeviceResponseTypeFragment
}
documents {
...PaginatedDocumentResponseTypeFragment
}
gateways {
...PaginatedGatewayResponseTypeFragment
}
licenses {
...PaginatedLicenseResponseTypeFragment
}
projects {
...PaginatedProjectResponseTypeFragment
}
tags {
...PaginatedTagResponseTypeFragment
}
subGroups {
...PaginatedResourceGroupResponseTypeFragment
}
parentGroup {
...ResourceGroupResponseTypeFragment
}
fullPath
groupDevicesSyncStatus {
...ResourceGroupDevicesSyncStatusTypeFragment
}
name
groupType
isSystemGroup
}
state {
reportedAt
state
}
metadata {
reportedAt
version
latestVersion
latestVersionForMajor
architecture
operatingSystem
operatingSystemAttrs {
... on WindowsAttrsType {
...WindowsAttrsTypeFragment
}
... on LinuxAttrsType {
...LinuxAttrsTypeFragment
}
}
numCpu
isOutdated
isOutdatedForMajor
}
publicIp {
reportedAt
publicIp
publicIpLocation {
...LocationTypeFragment
}
}
setupCommands {
expiresAt
osCommands {
...WorkstationSetupTypeFragment
}
}
deviceConnections {
pages
items {
...WorkstationDeviceConnectionTypeFragment
}
itemCount
}
linkedTags {
pages
items {
...TagResponseTypeFragment
}
itemCount
}
}
}
Variables
{
"workstationId": "abc123",
"workstation": UpdateWorkstationInput
}
Response
{
"data": {
"updateWorkstation": {
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"workstationId": "xyz789",
"groupId": "abc123",
"name": "abc123",
"description": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"state": WorkstationStateResponseType,
"metadata": WorkstationMetadataResponseType,
"publicIp": WorkstationPublicIpResponseType,
"setupCommands": WorkstationSetupResponseType,
"deviceConnections": PaginatedWorkstationDeviceConnectionStatusResponseType,
"linkedTags": PaginatedTagResponseType
}
}
}
Types
AccumulatedDeviceSyncStatusResponseType
Fields
| Field Name | Description |
|---|---|
targetSyncStatus - DeviceSyncStatusEnum!
|
|
previousSyncStatus - DeviceSyncStatusEnum!
|
|
syncTimestamp - DateTime
|
|
details - [DeviceSyncStatusResponseType!]!
|
Example
{
"targetSyncStatus": "UNKNOWN",
"previousSyncStatus": "UNKNOWN",
"syncTimestamp": "2007-12-03T10:15:30Z",
"details": [DeviceSyncStatusResponseType]
}
ArchEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ARM"
AssetBaseResponseInterface
Possible Types
| AssetBaseResponseInterface Types |
|---|
Example
{
"creationUserId": "abc123",
"updateUserId": "xyz789",
"groupId": "xyz789"
}
AssetLinkFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
sourceType - StringFilterInput
|
|
destinationType - StringFilterInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"sourceType": StringFilterInput,
"destinationType": StringFilterInput
}
AssetLinkResponseType
Fields
| Field Name | Description |
|---|---|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
sourceId - String!
|
The source ID of the asset link. This is the ID of the asset (resource) from which the link is created. |
sourceType - AssetTypeEnum!
|
The source type of the asset link. This is the type of the asset (resource) from which the link is created. |
destinationId - String!
|
The destination ID of the asset link. This is the ID of the asset (resource) to which the link is created. |
destinationType - AssetTypeEnum!
|
The destination type of the asset link. This is the type of the asset (resource) to which the link is created. |
metaData - AssetMetaData!
|
The meta data for the asset link. The type is dependent on the asset types to link. |
Example
{
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"sourceId": "abc123",
"sourceType": "DEVICE",
"destinationId": "abc123",
"destinationType": "DEVICE",
"metaData": DocumentToAssetLinkMetaDataType
}
AssetMetaData
Example
DocumentToAssetLinkMetaDataType
AssetMetaDataCombinedInput
Fields
| Input Field | Description |
|---|---|
primary - Boolean
|
A flag indicating if this is the primary gateway for the device. Default = false |
interface - String
|
The interface used for the link between the two devices. Default = null |
protocol - String
|
The protocol used for the link between the two devices. Default = null |
sourceVersionId - String
|
Specific version ID of the source project. Default = null |
destinationVersionId - String
|
Specific version ID of the destination project. Default = null |
deviceName - String
|
The name of the device within the project. Default = null |
deviceType - String
|
The type of the device within the project. Default = null |
deviceIpAddress - String
|
The IP address of the device within the project. Default = null |
deviceSubnet - String
|
The subnet mask of the device within the project. Default = null |
targetProjectVersionId - String
|
Version ID of the target project for the linked device. Default = null |
targetProjectSyncStatus - ProjectToDeviceSyncStatusEnum
|
Sync status of the target project for the linked device. Default = null |
targetProjectSyncStatusTimestamp - DateTime
|
Sync timestamp of the target project for the linked device. Default = null |
previousProjectSyncStatus - ProjectToDeviceSyncStatusEnum
|
Sync status of the previous sync check (backup) for the linked device. Default = null |
projectSyncType - ProjectToDeviceSyncTypeEnum
|
Sync type used for the status check (IDE, FTP, NETWORK). Default = null |
projectSyncErrorMessage - String
|
Error message if any during sync check. Default = null |
projectSyncJobId - String
|
The related job ID for the sync operation, if applicable. Default = null |
assetVersionId - String
|
Example
{
"primary": true,
"interface": "xyz789",
"protocol": "abc123",
"sourceVersionId": "abc123",
"destinationVersionId": "abc123",
"deviceName": "xyz789",
"deviceType": "abc123",
"deviceIpAddress": "abc123",
"deviceSubnet": "abc123",
"targetProjectVersionId": "abc123",
"targetProjectSyncStatus": "UNKNOWN",
"targetProjectSyncStatusTimestamp": "2007-12-03T10:15:30Z",
"previousProjectSyncStatus": "UNKNOWN",
"projectSyncType": "IDE",
"projectSyncErrorMessage": "xyz789",
"projectSyncJobId": "xyz789",
"assetVersionId": "xyz789"
}
AssetTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DEVICE"
BigInt
Description
BigInt field
Example
{}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
CompleteMultipartUploadInput
Fields
| Input Field | Description |
|---|---|
parts - [S3MultipartCompleteInfoInput!]!
|
|
fileName - String!
|
Example
{
"parts": [S3MultipartCompleteInfoInput],
"fileName": "xyz789"
}
ConnectionConfigurationInput
ConnectionConfigurationType
ConnectionConfigurationUpdateInput
ConnectionNodeStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NOT_CONFIGURED"
ConnectionState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONNECT_REQUESTED"
CreateAssetLinkInput
Fields
| Input Field | Description |
|---|---|
metaData - AssetMetaDataCombinedInput
|
The meta data for the asset link. The type is dependent on the asset types to link. Default = null |
Example
{"metaData": AssetMetaDataCombinedInput}
CreateDeviceInput
Fields
| Input Field | Description |
|---|---|
groupId - String
|
|
name - String!
|
|
vendorId - String!
|
|
ideConfigId - String!
|
|
connectionConfiguration - ConnectionConfigurationInput!
|
|
metaData - JSON
|
|
deviceType - DeviceTypeEnum!
|
|
description - String
|
|
secretId - String
|
|
ftpConfiguration - FtpConfigurationInput
|
|
smbConfiguration - SmbConfigurationInput
|
Example
{
"groupId": "xyz789",
"name": "xyz789",
"vendorId": "abc123",
"ideConfigId": "xyz789",
"connectionConfiguration": ConnectionConfigurationInput,
"metaData": {},
"deviceType": "PLC",
"description": "xyz789",
"secretId": "abc123",
"ftpConfiguration": FtpConfigurationInput,
"smbConfiguration": SmbConfigurationInput
}
CreateDocumentInput
Example
{
"groupId": "abc123",
"name": "abc123",
"documentType": "PDF",
"commitMessage": "xyz789",
"fileName": "abc123",
"parts": 123,
"fileSize": {}
}
CreateDocumentResponseType
Fields
| Field Name | Description |
|---|---|
uploadUrls - [S3MultipartUploadUrlType!]!
|
|
uploadId - String!
|
|
documentId - String!
|
|
versionId - String!
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
groupId - String
|
|
name - String!
|
|
lastVersionNumber - Int!
|
|
documentType - DocumentTypeEnum!
|
|
linkMetaData - DocumentToAssetLinkMetaDataType
|
Example
{
"uploadUrls": [S3MultipartUploadUrlType],
"uploadId": "abc123",
"documentId": "xyz789",
"versionId": "xyz789",
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"groupId": "abc123",
"name": "xyz789",
"lastVersionNumber": 123,
"documentType": "PDF",
"linkMetaData": DocumentToAssetLinkMetaDataType
}
CreateDocumentVersionInput
CreateGatewayInput
CreateLicenseInput
Fields
| Input Field | Description |
|---|---|
groupId - String
|
|
vendorId - String!
|
The vendor ID of the license |
serialId - String!
|
|
product - String!
|
|
type - LicenseTypeEnum!
|
|
status - LicenseStatusEnum!
|
|
quantity - Int!
|
|
name - String
|
|
ideConfigId - String
|
|
expirationTimestamp - DateTime
|
|
family - String
|
|
companyName - String
|
|
productKey - String
|
|
containerId - String
|
|
firmCode - String
|
|
licenseServer - String
|
|
fileName - String
|
|
parts - Int
|
Example
{
"groupId": "abc123",
"vendorId": "abc123",
"serialId": "xyz789",
"product": "xyz789",
"type": "CORPORATE",
"status": "REQUESTED",
"quantity": 987,
"name": "abc123",
"ideConfigId": "abc123",
"expirationTimestamp": "2007-12-03T10:15:30Z",
"family": "xyz789",
"companyName": "xyz789",
"productKey": "abc123",
"containerId": "abc123",
"firmCode": "xyz789",
"licenseServer": "abc123",
"fileName": "abc123",
"parts": 987
}
CreateLicenseResponseType
Fields
| Field Name | Description |
|---|---|
uploadUrls - [S3MultipartUploadUrlType!]!
|
|
uploadId - String!
|
|
licenseId - String!
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
groupId - String
|
|
vendorId - String!
|
The vendor ID of the license |
serialId - String!
|
|
product - String!
|
|
type - LicenseTypeEnum!
|
|
status - LicenseStatusEnum!
|
|
quantity - Int!
|
|
name - String
|
|
ideConfigId - String
|
|
expirationTimestamp - DateTime
|
|
family - String
|
|
companyName - String
|
|
productKey - String
|
|
containerId - String
|
|
firmCode - String
|
|
licenseServer - String
|
Example
{
"uploadUrls": [S3MultipartUploadUrlType],
"uploadId": "xyz789",
"licenseId": "xyz789",
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"groupId": "xyz789",
"vendorId": "abc123",
"serialId": "xyz789",
"product": "xyz789",
"type": "CORPORATE",
"status": "REQUESTED",
"quantity": 123,
"name": "abc123",
"ideConfigId": "abc123",
"expirationTimestamp": "2007-12-03T10:15:30Z",
"family": "abc123",
"companyName": "xyz789",
"productKey": "abc123",
"containerId": "xyz789",
"firmCode": "abc123",
"licenseServer": "abc123"
}
CreateLockInput
CreateProjectInput
Example
{
"groupId": "abc123",
"name": "abc123",
"vendorId": "abc123",
"ideConfigId": "abc123",
"projectType": "STANDARD",
"description": "abc123",
"secretId": "xyz789",
"attachedLicenses": ["xyz789"],
"fileName": "abc123",
"parts": 123,
"fileSize": {}
}
CreateProjectResponseType
Fields
| Field Name | Description |
|---|---|
uploadUrls - [S3MultipartUploadUrlType!]!
|
|
uploadId - String!
|
|
projectId - String!
|
|
versionId - String!
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
groupId - String
|
|
name - String!
|
|
vendorId - String!
|
|
ideConfigId - String!
|
|
projectType - ProjectTypeEnum!
|
|
lastVersionNumber - Int!
|
|
description - String
|
|
secretId - String
|
|
attachedLicenses - [String!]
|
|
linkMetaData - ProjectLinkMetaDataType
|
Example
{
"uploadUrls": [S3MultipartUploadUrlType],
"uploadId": "xyz789",
"projectId": "abc123",
"versionId": "abc123",
"objectVersion": 123,
"creationUserId": "xyz789",
"updateUserId": "abc123",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"groupId": "xyz789",
"name": "abc123",
"vendorId": "abc123",
"ideConfigId": "abc123",
"projectType": "STANDARD",
"lastVersionNumber": 123,
"description": "xyz789",
"secretId": "abc123",
"attachedLicenses": ["xyz789"],
"linkMetaData": ProjectToDeviceLinkMetaDataType
}
CreateProjectVersionInput
CreateResourceGroupInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
groupType - ResourceGroupTypeEnum!
|
|
parentGroupId - String
|
Example
{
"name": "abc123",
"groupType": "USER",
"parentGroupId": "xyz789"
}
CreateSecretInput
Fields
| Input Field | Description |
|---|---|
vaultId - String!
|
|
name - String!
|
|
secretType - SecretTypeEnum!
|
|
username - String
|
|
secretValue - String!
|
Example
{
"vaultId": "abc123",
"name": "xyz789",
"secretType": "CREDENTIAL",
"username": "xyz789",
"secretValue": "abc123"
}
CreateTagInput
CreateVaultInput
CreateWorkstationInput
DateTime
Description
Date with time (isoformat)
Example
"2007-12-03T10:15:30Z"
DefineAssetLinkFromAssetInput
Fields
| Input Field | Description |
|---|---|
metaData - AssetMetaDataCombinedInput
|
The meta data for the asset link. The type is dependent on the asset types to link. Default = null |
destinationId - String!
|
The destination ID of the asset link. This is the ID of the asset (resource) to which the link is created. |
Example
{
"metaData": AssetMetaDataCombinedInput,
"destinationId": "xyz789"
}
DefineAssetLinkToAssetInput
Fields
| Input Field | Description |
|---|---|
metaData - AssetMetaDataCombinedInput
|
The meta data for the asset link. The type is dependent on the asset types to link. Default = null |
sourceId - String!
|
The source ID of the asset link. This is the ID of the asset (resource) from which the link is created. |
Example
{
"metaData": AssetMetaDataCombinedInput,
"sourceId": "abc123"
}
DeviceConnectivityStatusReportType
Fields
| Field Name | Description |
|---|---|
gatewayId - String!
|
|
reportedAt - DateTime!
|
|
deviceStatus - DeviceInterfaceStatusEnum!
|
|
devicePingStatus - PingStatusEnum
|
|
deviceNetcatStatus - NetcatStatusEnum
|
|
ftpStatus - DeviceInterfaceStatusEnum
|
|
ftpPingStatus - PingStatusEnum
|
|
ftpNetcatStatus - NetcatStatusEnum
|
|
smbStatus - DeviceInterfaceStatusEnum
|
|
smbPingStatus - PingStatusEnum
|
|
smbNetcatStatus - NetcatStatusEnum
|
Example
{
"gatewayId": "abc123",
"reportedAt": "2007-12-03T10:15:30Z",
"deviceStatus": "ONLINE",
"devicePingStatus": "OK",
"deviceNetcatStatus": "OK",
"ftpStatus": "ONLINE",
"ftpPingStatus": "OK",
"ftpNetcatStatus": "OK",
"smbStatus": "ONLINE",
"smbPingStatus": "OK",
"smbNetcatStatus": "OK"
}
DeviceConnectivityStatusType
Fields
| Field Name | Description |
|---|---|
deviceId - String!
|
|
primaryGateway - DeviceConnectivityStatusReportType
|
|
allGateways - [DeviceConnectivityStatusReportType!]!
|
Example
{
"deviceId": "abc123",
"primaryGateway": DeviceConnectivityStatusReportType,
"allGateways": [DeviceConnectivityStatusReportType]
}
DeviceFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
name - StringFilterInput
|
|
nameLower - StringFilterInput
|
|
groupId - StringFilterInput
|
|
tag - StringFilterIgnoreDdbInput
|
|
vendorId - StringFilterInput
|
|
ideConfigId - StringFilterInput
|
|
deviceType - StringFilterInput
|
|
secretId - StringFilterInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"name": StringFilterInput,
"nameLower": StringFilterInput,
"groupId": StringFilterInput,
"tag": StringFilterIgnoreDdbInput,
"vendorId": StringFilterInput,
"ideConfigId": StringFilterInput,
"deviceType": StringFilterInput,
"secretId": StringFilterInput
}
DeviceInformationType
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
description - String
|
|
deviceType - DeviceTypeEnum!
|
|
ethernetCommunication - [EthernetCommunicationType!]!
|
|
originDeviceType - String
|
|
nameAndType - String
|
Example
{
"name": "xyz789",
"description": "abc123",
"deviceType": "PLC",
"ethernetCommunication": [EthernetCommunicationType],
"originDeviceType": "xyz789",
"nameAndType": "abc123"
}
DeviceInterfaceStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ONLINE"
DeviceLinkMetaDataType
Example
ProjectToDeviceLinkMetaDataType
DeviceResponseType
Fields
| Field Name | Description |
|---|---|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
deviceId - String!
|
|
groupId - String
|
|
name - String!
|
|
vendorId - String!
|
|
ideConfigId - String!
|
|
connectionConfiguration - ConnectionConfigurationType!
|
|
metaData - JSON
|
|
deviceType - DeviceTypeEnum!
|
|
description - String
|
|
secretId - String
|
|
ftpConfiguration - FtpConfigurationType
|
|
smbConfiguration - SmbConfigurationType
|
|
linkMetaData - DeviceLinkMetaDataType
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
linkedDocuments - PaginatedDocumentResponseType!
|
|
Arguments
|
|
linkedTags - PaginatedTagResponseType!
|
|
Arguments
|
|
linkedGateways - PaginatedGatewayResponseType!
|
|
Arguments
|
|
linkedProjects - PaginatedProjectResponseType!
|
|
Arguments
|
|
linkedSubDevices - PaginatedDeviceResponseType!
|
|
Arguments
|
|
linkedParentDevices - PaginatedDeviceResponseType!
|
|
Arguments
|
|
secret - SecretResponseType
|
|
syncStatus - [DeviceSyncStatusType!]!
|
|
accumulatedSyncStatus - AccumulatedDeviceSyncStatusResponseType!
|
|
connectivityStatus - DeviceConnectivityStatusType!
|
|
Example
{
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "abc123",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"deviceId": "xyz789",
"groupId": "abc123",
"name": "abc123",
"vendorId": "xyz789",
"ideConfigId": "xyz789",
"connectionConfiguration": ConnectionConfigurationType,
"metaData": {},
"deviceType": "PLC",
"description": "abc123",
"secretId": "abc123",
"ftpConfiguration": FtpConfigurationType,
"smbConfiguration": SmbConfigurationType,
"linkMetaData": ProjectToDeviceLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"linkedGateways": PaginatedGatewayResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedSubDevices": PaginatedDeviceResponseType,
"linkedParentDevices": PaginatedDeviceResponseType,
"secret": SecretResponseType,
"syncStatus": [DeviceSyncStatusType],
"accumulatedSyncStatus": AccumulatedDeviceSyncStatusResponseType,
"connectivityStatus": DeviceConnectivityStatusType
}
DeviceSyncStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
DeviceSyncStatusResponseType
Fields
| Field Name | Description |
|---|---|
syncType - DeviceSyncTypeEnum!
|
|
targetSyncStatus - DeviceSyncStatusEnum
|
|
previousSyncStatus - DeviceSyncStatusEnum
|
|
syncTimestamp - DateTime
|
|
syncErrorMessage - String
|
|
syncJobId - String
|
|
projectId - String
|
|
targetProjectVersionId - String
|
Example
{
"syncType": "IDE",
"targetSyncStatus": "UNKNOWN",
"previousSyncStatus": "UNKNOWN",
"syncTimestamp": "2007-12-03T10:15:30Z",
"syncErrorMessage": "abc123",
"syncJobId": "xyz789",
"projectId": "abc123",
"targetProjectVersionId": "abc123"
}
DeviceSyncStatusType
Fields
| Field Name | Description |
|---|---|
targetSyncStatus - ProjectToDeviceSyncStatusEnum
|
|
previousSyncStatus - ProjectToDeviceSyncStatusEnum
|
|
syncType - ProjectToDeviceSyncTypeEnum
|
|
syncTimestamp - DateTime
|
|
syncErrorMessage - String
|
|
syncJobId - String
|
Example
{
"targetSyncStatus": "UNKNOWN",
"previousSyncStatus": "UNKNOWN",
"syncType": "IDE",
"syncTimestamp": "2007-12-03T10:15:30Z",
"syncErrorMessage": "abc123",
"syncJobId": "abc123"
}
DeviceSyncTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"IDE"
DeviceToDeviceLinkMetaDataType
DeviceToGatewayLinkMetaDataType
Fields
| Field Name | Description |
|---|---|
primary - Boolean
|
A flag indicating if this is the primary gateway for the device. |
Example
{"primary": true}
DeviceTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PLC"
DocumentFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
name - StringFilterInput
|
|
nameLower - StringFilterInput
|
|
groupId - StringFilterInput
|
|
tag - StringFilterIgnoreDdbInput
|
|
documentType - StringFilterInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"name": StringFilterInput,
"nameLower": StringFilterInput,
"groupId": StringFilterInput,
"tag": StringFilterIgnoreDdbInput,
"documentType": StringFilterInput
}
DocumentResponseType
Fields
| Field Name | Description |
|---|---|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
documentId - String!
|
|
groupId - String
|
|
name - String!
|
|
lastVersionNumber - Int!
|
|
documentType - DocumentTypeEnum!
|
|
linkMetaData - DocumentToAssetLinkMetaDataType
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
versions - PaginatedDocumentVersionResponseType!
|
|
Arguments
|
|
linkedTags - PaginatedTagResponseType!
|
|
Arguments
|
|
Example
{
"objectVersion": 123,
"creationUserId": "xyz789",
"updateUserId": "abc123",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documentId": "abc123",
"groupId": "abc123",
"name": "abc123",
"lastVersionNumber": 123,
"documentType": "PDF",
"linkMetaData": DocumentToAssetLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"versions": PaginatedDocumentVersionResponseType,
"linkedTags": PaginatedTagResponseType
}
DocumentToAssetLinkMetaDataType
Fields
| Field Name | Description |
|---|---|
assetVersionId - String
|
Example
{"assetVersionId": "abc123"}
DocumentTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PDF"
DocumentVersionDownloadURLResponseType
DocumentVersionFileType
DocumentVersionFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
versionId - StringFilterInput
|
|
source - StringFilterInput
|
|
commitMessage - StringFilterInput
|
|
commitMessageLower - StringFilterInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"versionId": StringFilterInput,
"source": StringFilterInput,
"commitMessage": StringFilterInput,
"commitMessageLower": StringFilterInput
}
DocumentVersionResponseType
Fields
| Field Name | Description |
|---|---|
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
groupId - String
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
documentId - String!
|
|
versionId - String!
|
|
versionNumber - Int!
|
|
documentFile - DocumentVersionFileType!
|
|
commitMessage - String
|
Example
{
"creationUserId": "xyz789",
"updateUserId": "abc123",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documentId": "abc123",
"versionId": "abc123",
"versionNumber": 987,
"documentFile": DocumentVersionFileType,
"commitMessage": "xyz789"
}
DocumentVersionUploadURLResponseType
Fields
| Field Name | Description |
|---|---|
uploadUrls - [S3MultipartUploadUrlType!]!
|
|
uploadId - String!
|
|
documentId - String!
|
|
versionId - String!
|
Example
{
"uploadUrls": [S3MultipartUploadUrlType],
"uploadId": "abc123",
"documentId": "abc123",
"versionId": "xyz789"
}
EthernetCommunicationType
FilterOperatorEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"eq"
FtpConfigurationInput
Fields
| Input Field | Description |
|---|---|
ipAddress - String!
|
The IP address of the protocol server on the device. |
port - Int!
|
The port of the FTP server on the device. Default is 22 (SFTP). Default = 22 |
protocol - FtpProtocolEnum
|
The protocol used by the FTP server on the device. Default = null |
secretId - String
|
The secret ID for the protocol server credentials (username and password). Default = null |
rootDirectory - String
|
The root directory of the protocol server on the device. If not set, the root directory is assumed to be the home directory of the user. Default = null |
Example
{
"ipAddress": "xyz789",
"port": 987,
"protocol": "FTP",
"secretId": "xyz789",
"rootDirectory": "abc123"
}
FtpConfigurationType
Fields
| Field Name | Description |
|---|---|
ipAddress - String!
|
The IP address of the protocol server on the device. |
port - Int!
|
The port of the FTP server on the device. Default is 22 (SFTP). |
protocol - FtpProtocolEnum
|
The protocol used by the FTP server on the device. |
secretId - String
|
The secret ID for the protocol server credentials (username and password). |
rootDirectory - String
|
The root directory of the protocol server on the device. If not set, the root directory is assumed to be the home directory of the user. |
Example
{
"ipAddress": "xyz789",
"port": 123,
"protocol": "FTP",
"secretId": "xyz789",
"rootDirectory": "abc123"
}
FtpProtocolEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FTP"
GatewayConfigResponseType
Fields
| Field Name | Description |
|---|---|
objectVersion - Int
|
|
reportedAt - DateTime
|
|
requestedAt - DateTime
|
|
values - GlueConfigType!
|
Example
{
"objectVersion": 123,
"reportedAt": "2007-12-03T10:15:30Z",
"requestedAt": "2007-12-03T10:15:30Z",
"values": GlueConfigType
}
GatewayConfigUpdateInput
Fields
| Input Field | Description |
|---|---|
objectVersion - Int!
|
|
values - GlueConfigInput!
|
Example
{"objectVersion": 987, "values": GlueConfigInput}
GatewayFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
name - StringFilterInput
|
|
nameLower - StringFilterInput
|
|
groupId - StringFilterInput
|
|
tag - StringFilterIgnoreDdbInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"name": StringFilterInput,
"nameLower": StringFilterInput,
"groupId": StringFilterInput,
"tag": StringFilterIgnoreDdbInput
}
GatewayMetadataResponseType
Fields
| Field Name | Description |
|---|---|
reportedAt - DateTime!
|
|
version - String!
|
|
latestVersion - String
|
|
latestVersionForMajor - String
|
|
architecture - ArchEnum!
|
|
operatingSystem - OperatingSystemEnum!
|
|
operatingSystemAttrs - WindowsAttrsTypeLinuxAttrsType
|
|
numCpu - Int
|
|
isOutdated - Boolean
|
|
isOutdatedForMajor - Boolean
|
Example
{
"reportedAt": "2007-12-03T10:15:30Z",
"version": "xyz789",
"latestVersion": "xyz789",
"latestVersionForMajor": "abc123",
"architecture": "ARM",
"operatingSystem": "WINDOWS",
"operatingSystemAttrs": WindowsAttrsType,
"numCpu": 123,
"isOutdated": false,
"isOutdatedForMajor": true
}
GatewayPublicIpResponseType
Fields
| Field Name | Description |
|---|---|
reportedAt - DateTime!
|
|
publicIp - String!
|
|
publicIpLocation - LocationType
|
Example
{
"reportedAt": "2007-12-03T10:15:30Z",
"publicIp": "xyz789",
"publicIpLocation": LocationType
}
GatewayResponseType
Fields
| Field Name | Description |
|---|---|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
gatewayId - String!
|
|
groupId - String
|
|
name - String!
|
|
description - String
|
|
linkMetaData - DeviceToGatewayLinkMetaDataType
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
state - GatewayStateResponseType
|
|
metadata - GatewayMetadataResponseType
|
|
publicIp - GatewayPublicIpResponseType
|
|
setupCommands - GatewaySetupResponseType
|
|
linkedDocuments - PaginatedDocumentResponseType!
|
|
Arguments
|
|
linkedDevices - PaginatedDeviceResponseType!
|
|
Arguments
|
|
linkedTags - PaginatedTagResponseType!
|
|
Arguments
|
|
configReported - GatewayConfigResponseType
|
|
configDesired - GatewayConfigResponseType
|
|
updateRequest - GatewayUpdateRequestType
|
|
Example
{
"objectVersion": 123,
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"gatewayId": "abc123",
"groupId": "abc123",
"name": "abc123",
"description": "abc123",
"linkMetaData": DeviceToGatewayLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"state": GatewayStateResponseType,
"metadata": GatewayMetadataResponseType,
"publicIp": GatewayPublicIpResponseType,
"setupCommands": GatewaySetupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"linkedTags": PaginatedTagResponseType,
"configReported": GatewayConfigResponseType,
"configDesired": GatewayConfigResponseType,
"updateRequest": GatewayUpdateRequestType
}
GatewaySetupByMajorType
Fields
| Field Name | Description |
|---|---|
major - String!
|
|
osCommands - [GatewaySetupType!]!
|
Example
{
"major": "abc123",
"osCommands": [GatewaySetupType]
}
GatewaySetupResponseType
Fields
| Field Name | Description |
|---|---|
expiresAt - DateTime!
|
|
osCommands - [GatewaySetupType!]!
|
|
byMajor - [GatewaySetupByMajorType!]!
|
Example
{
"expiresAt": "2007-12-03T10:15:30Z",
"osCommands": [GatewaySetupType],
"byMajor": [GatewaySetupByMajorType]
}
GatewaySetupType
Fields
| Field Name | Description |
|---|---|
osType - OperatingSystemEnum!
|
|
osName - String!
|
|
installationCommand - String!
|
|
configurationCommand - String!
|
Example
{
"osType": "WINDOWS",
"osName": "abc123",
"installationCommand": "xyz789",
"configurationCommand": "abc123"
}
GatewayStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NOT_CONFIGURED"
GatewayStateResponseType
Fields
| Field Name | Description |
|---|---|
reportedAt - DateTime!
|
|
state - GatewayStateEnum!
|
Example
{
"reportedAt": "2007-12-03T10:15:30Z",
"state": "NOT_CONFIGURED"
}
GatewayUpdateRequestType
GlueConfigInput
Fields
| Input Field | Description |
|---|---|
metaVersion - Int!
|
|
updateAuto - Boolean
|
|
updatePeriod - String
|
|
updateUnstable - Boolean
|
|
proxyAll - String
|
|
proxyHttp - String
|
|
proxyHttps - String
|
|
iotTransport - String
|
|
natMode - String
|
|
sslTunnel - Boolean
|
|
sslTunnelInsecure - Boolean
|
|
webuiEnabled - Boolean
|
|
webuiBase - String
|
|
webuiPort - Int
|
Example
{
"metaVersion": 123,
"updateAuto": false,
"updatePeriod": "xyz789",
"updateUnstable": true,
"proxyAll": "abc123",
"proxyHttp": "xyz789",
"proxyHttps": "xyz789",
"iotTransport": "abc123",
"natMode": "xyz789",
"sslTunnel": true,
"sslTunnelInsecure": true,
"webuiEnabled": true,
"webuiBase": "xyz789",
"webuiPort": 123
}
GlueConfigType
Fields
| Field Name | Description |
|---|---|
metaVersion - Int!
|
|
updateAuto - Boolean
|
|
updatePeriod - String
|
|
updateUnstable - Boolean
|
|
proxyAll - String
|
|
proxyHttp - String
|
|
proxyHttps - String
|
|
iotTransport - String
|
|
natMode - String
|
|
sslTunnel - Boolean
|
|
sslTunnelInsecure - Boolean
|
|
webuiEnabled - Boolean
|
|
webuiBase - String
|
|
webuiPort - Int
|
Example
{
"metaVersion": 987,
"updateAuto": true,
"updatePeriod": "xyz789",
"updateUnstable": true,
"proxyAll": "abc123",
"proxyHttp": "xyz789",
"proxyHttps": "abc123",
"iotTransport": "abc123",
"natMode": "abc123",
"sslTunnel": false,
"sslTunnelInsecure": false,
"webuiEnabled": true,
"webuiBase": "abc123",
"webuiPort": 987
}
GroupDeviceSyncStatusType
Fields
| Field Name | Description |
|---|---|
deviceId - String!
|
|
deviceName - String!
|
|
syncStatus - DeviceSyncStatusEnum!
|
|
groupId - String
|
|
syncStatusTimestamp - DateTime
|
Example
{
"deviceId": "abc123",
"deviceName": "abc123",
"syncStatus": "UNKNOWN",
"groupId": "abc123",
"syncStatusTimestamp": "2007-12-03T10:15:30Z"
}
HealthResponseType
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
LicenseDownloadURLResponseType
LicenseFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
name - StringFilterInput
|
|
nameLower - StringFilterInput
|
|
groupId - StringFilterInput
|
|
tag - StringFilterIgnoreDdbInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"name": StringFilterInput,
"nameLower": StringFilterInput,
"groupId": StringFilterInput,
"tag": StringFilterIgnoreDdbInput
}
LicenseResponseInterface
Fields
| Field Name | Description |
|---|---|
licenseId - String!
|
Possible Types
| LicenseResponseInterface Types |
|---|
Example
{"licenseId": "abc123"}
LicenseResponseType
Fields
| Field Name | Description |
|---|---|
licenseId - String!
|
|
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
groupId - String
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
linkedDocuments - PaginatedDocumentResponseType!
|
|
Arguments
|
|
linkedTags - PaginatedTagResponseType!
|
|
Arguments
|
|
vendorId - String!
|
The vendor ID of the license |
serialId - String!
|
|
product - String!
|
|
type - LicenseTypeEnum!
|
|
status - LicenseStatusEnum!
|
|
quantity - Int!
|
|
name - String
|
|
ideConfigId - String
|
|
expirationTimestamp - DateTime
|
|
family - String
|
|
companyName - String
|
|
productKey - String
|
|
containerId - String
|
|
firmCode - String
|
|
licenseServer - String
|
|
Example
{
"licenseId": "abc123",
"creationUserId": "xyz789",
"updateUserId": "abc123",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"vendorId": "xyz789",
"serialId": "xyz789",
"product": "xyz789",
"type": "CORPORATE",
"status": "REQUESTED",
"quantity": 123,
"name": "abc123",
"ideConfigId": "xyz789",
"expirationTimestamp": "2007-12-03T10:15:30Z",
"family": "abc123",
"companyName": "abc123",
"productKey": "abc123",
"containerId": "abc123",
"firmCode": "xyz789",
"licenseServer": "xyz789"
}
LicenseStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"REQUESTED"
LicenseTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CORPORATE"
LinuxAttrsType
LocationType
Example
{
"latitudeE6": 987,
"longitudeE6": 987,
"country": "abc123",
"state": "abc123",
"city": "xyz789",
"horizontalAccuracy": 123,
"horizontalConfidenceLevelPercentage": 123
}
LockResponseInterface
Possible Types
| LockResponseInterface Types |
|---|
Example
{
"creationUserId": "abc123",
"updateUserId": "xyz789"
}
LockResponseType
Fields
| Field Name | Description |
|---|---|
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
resourceId - String!
|
|
resourceType - String!
|
|
ownerId - String!
|
|
service - String!
|
|
message - String
|
Example
{
"creationUserId": "xyz789",
"updateUserId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"objectVersion": 123,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"resourceId": "abc123",
"resourceType": "xyz789",
"ownerId": "xyz789",
"service": "xyz789",
"message": "abc123"
}
NetcatStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OK"
OperatingSystemEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"WINDOWS"
PaginatedAssetLinkResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [AssetLinkResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 123,
"items": [AssetLinkResponseType],
"itemCount": 987
}
PaginatedDeviceResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [DeviceResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 987,
"items": [DeviceResponseType],
"itemCount": 123
}
PaginatedDocumentResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [DocumentResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 123,
"items": [DocumentResponseType],
"itemCount": 987
}
PaginatedDocumentVersionResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [DocumentVersionResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 987,
"items": [DocumentVersionResponseType],
"itemCount": 123
}
PaginatedGatewayResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [GatewayResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 123,
"items": [GatewayResponseType],
"itemCount": 123
}
PaginatedLicenseResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [LicenseResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 987,
"items": [LicenseResponseType],
"itemCount": 123
}
PaginatedProjectResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [ProjectResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 987,
"items": [ProjectResponseType],
"itemCount": 123
}
PaginatedProjectVersionResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [ProjectVersionResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 123,
"items": [ProjectVersionResponseType],
"itemCount": 123
}
PaginatedResourceGroupAssetResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [ResourceGroupAssetResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 987,
"items": [DeviceResponseType],
"itemCount": 987
}
PaginatedResourceGroupResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [ResourceGroupResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 123,
"items": [ResourceGroupResponseType],
"itemCount": 123
}
PaginatedSecretResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [SecretResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 123,
"items": [SecretResponseType],
"itemCount": 123
}
PaginatedSecretVersionResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [SecretVersionResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 123,
"items": [SecretVersionResponseType],
"itemCount": 987
}
PaginatedSecretVersionUnceiledResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [SecretVersionUnceiledResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 123,
"items": [SecretVersionUnceiledResponseType],
"itemCount": 123
}
PaginatedTagResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [TagResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 987,
"items": [TagResponseType],
"itemCount": 123
}
PaginatedVaultResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [VaultResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 123,
"items": [VaultResponseType],
"itemCount": 987
}
PaginatedWorkstationDeviceConnectionStatusResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [WorkstationDeviceConnectionType]!
|
|
itemCount - Int!
|
Example
{
"pages": 987,
"items": [WorkstationDeviceConnectionType],
"itemCount": 123
}
PaginatedWorkstationResponseType
Fields
| Field Name | Description |
|---|---|
pages - Int!
|
|
items - [WorkstationResponseType]!
|
|
itemCount - Int!
|
Example
{
"pages": 987,
"items": [WorkstationResponseType],
"itemCount": 123
}
PaginationInput
PingStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OK"
ProjectFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
name - StringFilterInput
|
|
nameLower - StringFilterInput
|
|
groupId - StringFilterInput
|
|
tag - StringFilterIgnoreDdbInput
|
|
vendorId - StringFilterInput
|
|
ideConfigId - StringFilterInput
|
|
projectType - StringFilterInput
|
|
secretId - StringFilterInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"name": StringFilterInput,
"nameLower": StringFilterInput,
"groupId": StringFilterInput,
"tag": StringFilterIgnoreDdbInput,
"vendorId": StringFilterInput,
"ideConfigId": StringFilterInput,
"projectType": StringFilterInput,
"secretId": StringFilterInput
}
ProjectLinkMetaDataType
Types
| Union Types |
|---|
Example
ProjectToDeviceLinkMetaDataType
ProjectResponseType
Fields
| Field Name | Description |
|---|---|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
projectId - String!
|
|
groupId - String
|
|
name - String!
|
|
vendorId - String!
|
|
ideConfigId - String!
|
|
projectType - ProjectTypeEnum!
|
|
lastVersionNumber - Int!
|
|
description - String
|
|
secretId - String
|
|
attachedLicenses - [String!]
|
|
linkMetaData - ProjectLinkMetaDataType
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
linkedDocuments - PaginatedDocumentResponseType!
|
|
Arguments
|
|
linkedTags - PaginatedTagResponseType!
|
|
Arguments
|
|
linkedDevices - PaginatedDeviceResponseType!
|
|
Arguments
|
|
linkedSubProjects - PaginatedProjectResponseType!
|
|
Arguments
|
|
linkedParentProjects - PaginatedProjectResponseType!
|
|
Arguments
|
|
versions - PaginatedProjectVersionResponseType!
|
|
Arguments
|
|
secret - SecretResponseType
|
|
Example
{
"objectVersion": 987,
"creationUserId": "xyz789",
"updateUserId": "xyz789",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"projectId": "abc123",
"groupId": "abc123",
"name": "xyz789",
"vendorId": "abc123",
"ideConfigId": "xyz789",
"projectType": "STANDARD",
"lastVersionNumber": 987,
"description": "xyz789",
"secretId": "xyz789",
"attachedLicenses": ["abc123"],
"linkMetaData": ProjectToDeviceLinkMetaDataType,
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"linkedDocuments": PaginatedDocumentResponseType,
"linkedTags": PaginatedTagResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"linkedSubProjects": PaginatedProjectResponseType,
"linkedParentProjects": PaginatedProjectResponseType,
"versions": PaginatedProjectVersionResponseType,
"secret": SecretResponseType
}
ProjectToDeviceLinkMetaDataType
Fields
| Field Name | Description |
|---|---|
deviceName - String
|
The name of the device within the project. |
deviceType - String
|
The type of the device within the project. |
deviceIpAddress - String
|
The IP address of the device within the project. |
deviceSubnet - String
|
The subnet mask of the device within the project. |
targetProjectVersionId - String
|
Version ID of the target project for the linked device. |
targetProjectSyncStatus - ProjectToDeviceSyncStatusEnum
|
Sync status of the target project for the linked device. |
targetProjectSyncStatusTimestamp - DateTime
|
Sync timestamp of the target project for the linked device. |
previousProjectSyncStatus - ProjectToDeviceSyncStatusEnum
|
Sync status of the previous sync check (backup) for the linked device. |
projectSyncType - ProjectToDeviceSyncTypeEnum
|
Sync type used for the status check (IDE, FTP, NETWORK). |
projectSyncErrorMessage - String
|
Error message if any during sync check. |
projectSyncJobId - String
|
The related job ID for the sync operation, if applicable. |
Example
{
"deviceName": "xyz789",
"deviceType": "xyz789",
"deviceIpAddress": "abc123",
"deviceSubnet": "abc123",
"targetProjectVersionId": "xyz789",
"targetProjectSyncStatus": "UNKNOWN",
"targetProjectSyncStatusTimestamp": "2007-12-03T10:15:30Z",
"previousProjectSyncStatus": "UNKNOWN",
"projectSyncType": "IDE",
"projectSyncErrorMessage": "xyz789",
"projectSyncJobId": "xyz789"
}
ProjectToDeviceSyncStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
ProjectToDeviceSyncTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"IDE"
ProjectToProjectLinkMetaDataType
ProjectTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"STANDARD"
ProjectVersionDownloadURLResponseType
ProjectVersionFileType
ProjectVersionFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
versionId - StringFilterInput
|
|
source - StringFilterInput
|
|
commitMessage - StringFilterInput
|
|
commitMessageLower - StringFilterInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"versionId": StringFilterInput,
"source": StringFilterInput,
"commitMessage": StringFilterInput,
"commitMessageLower": StringFilterInput
}
ProjectVersionResponseInterface
Possible Types
| ProjectVersionResponseInterface Types |
|---|
Example
{
"projectId": "xyz789",
"versionId": "abc123"
}
ProjectVersionResponseType
Fields
| Field Name | Description |
|---|---|
projectId - String!
|
|
versionId - String!
|
|
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
groupId - String
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
deviceInformation - [DeviceInformationType!]
|
|
downloadUrl - String!
|
|
vendorId - String
|
|
ideConfigId - String
|
|
versionNumber - Int!
|
|
projectFile - ProjectVersionFileType!
|
|
source - ProjectVersionSourceEnum!
|
|
commitMessage - String
|
|
commitId - String
|
Example
{
"projectId": "xyz789",
"versionId": "xyz789",
"creationUserId": "abc123",
"updateUserId": "abc123",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"deviceInformation": [DeviceInformationType],
"downloadUrl": "xyz789",
"vendorId": "xyz789",
"ideConfigId": "xyz789",
"versionNumber": 123,
"projectFile": ProjectVersionFileType,
"source": "UPLOAD",
"commitMessage": "xyz789",
"commitId": "abc123"
}
ProjectVersionSourceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UPLOAD"
ProjectVersionUploadURLResponseType
Fields
| Field Name | Description |
|---|---|
uploadUrls - [S3MultipartUploadUrlType!]!
|
|
uploadId - String!
|
|
projectId - String!
|
|
versionId - String!
|
Example
{
"uploadUrls": [S3MultipartUploadUrlType],
"uploadId": "abc123",
"projectId": "xyz789",
"versionId": "xyz789"
}
ResourceGroupAssetResponseType
Types
| Union Types |
|---|
Example
DeviceResponseType
ResourceGroupAssetTypeFilterInput
Fields
| Input Field | Description |
|---|---|
assetType - StringFilterIgnoreDdbInput
|
|
tag - StringFilterIgnoreDdbInput
|
Example
{
"assetType": StringFilterIgnoreDdbInput,
"tag": StringFilterIgnoreDdbInput
}
ResourceGroupDevicesSyncStatusFilterInput
Fields
| Input Field | Description |
|---|---|
deviceSyncStatus - StringFilterIgnoreDdbInput
|
Example
{"deviceSyncStatus": StringFilterIgnoreDdbInput}
ResourceGroupDevicesSyncStatusType
Fields
| Field Name | Description |
|---|---|
groupSyncStatus - DeviceSyncStatusEnum!
|
|
devicesSyncStatus - [GroupDeviceSyncStatusType!]!
|
Example
{
"groupSyncStatus": "UNKNOWN",
"devicesSyncStatus": [GroupDeviceSyncStatusType]
}
ResourceGroupFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
name - StringFilterInput
|
|
nameLower - StringFilterInput
|
|
groupId - StringFilterInput
|
|
tag - StringFilterIgnoreDdbInput
|
|
parentGroupId - StringFilterInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"name": StringFilterInput,
"nameLower": StringFilterInput,
"groupId": StringFilterInput,
"tag": StringFilterIgnoreDdbInput,
"parentGroupId": StringFilterInput
}
ResourceGroupResponseInterface
Possible Types
| ResourceGroupResponseInterface Types |
|---|
Example
{
"groupId": "abc123",
"parentGroupId": "abc123"
}
ResourceGroupResponseType
Fields
| Field Name | Description |
|---|---|
groupId - String!
|
|
parentGroupId - String
|
|
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
devices - PaginatedDeviceResponseType!
|
|
Arguments
|
|
documents - PaginatedDocumentResponseType!
|
|
Arguments
|
|
gateways - PaginatedGatewayResponseType!
|
|
Arguments
|
|
licenses - PaginatedLicenseResponseType!
|
|
Arguments
|
|
projects - PaginatedProjectResponseType!
|
|
Arguments
|
|
tags - PaginatedTagResponseType!
|
|
Arguments
|
|
subGroups - PaginatedResourceGroupResponseType!
|
|
Arguments
|
|
parentGroup - ResourceGroupResponseType
|
|
fullPath - String!
|
|
groupDevicesSyncStatus - ResourceGroupDevicesSyncStatusType!
|
|
Arguments |
|
name - String!
|
|
groupType - ResourceGroupTypeEnum!
|
|
isSystemGroup - Boolean!
|
|
Example
{
"groupId": "xyz789",
"parentGroupId": "abc123",
"creationUserId": "abc123",
"updateUserId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"devices": PaginatedDeviceResponseType,
"documents": PaginatedDocumentResponseType,
"gateways": PaginatedGatewayResponseType,
"licenses": PaginatedLicenseResponseType,
"projects": PaginatedProjectResponseType,
"tags": PaginatedTagResponseType,
"subGroups": PaginatedResourceGroupResponseType,
"parentGroup": ResourceGroupResponseType,
"fullPath": "xyz789",
"groupDevicesSyncStatus": ResourceGroupDevicesSyncStatusType,
"name": "xyz789",
"groupType": "USER",
"isSystemGroup": false
}
ResourceGroupTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"USER"
S3MultipartCompleteInfoInput
S3MultipartUploadUrlType
SecretFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
name - StringFilterInput
|
|
nameLower - StringFilterInput
|
|
groupId - StringFilterInput
|
|
tag - StringFilterIgnoreDdbInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"name": StringFilterInput,
"nameLower": StringFilterInput,
"groupId": StringFilterInput,
"tag": StringFilterIgnoreDdbInput
}
SecretResponseInterface
Possible Types
| SecretResponseInterface Types |
|---|
Example
{
"secretId": "abc123",
"vaultId": "abc123"
}
SecretResponseType
Fields
| Field Name | Description |
|---|---|
secretId - String!
|
|
vaultId - String!
|
|
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
groupId - String
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
vault - VaultResponseType!
|
|
versions - PaginatedSecretVersionResponseType!
|
|
linkedProjects - PaginatedProjectResponseType!
|
|
linkedDevices - PaginatedDeviceResponseType!
|
|
name - String!
|
|
secretType - SecretTypeEnum!
|
|
lastVersionNumber - Int!
|
|
username - String
|
|
secretValue - String!
|
Example
{
"secretId": "xyz789",
"vaultId": "abc123",
"creationUserId": "abc123",
"updateUserId": "abc123",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"vault": VaultResponseType,
"versions": PaginatedSecretVersionResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"name": "abc123",
"secretType": "CREDENTIAL",
"lastVersionNumber": 987,
"username": "abc123",
"secretValue": "abc123"
}
SecretTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CREDENTIAL"
SecretUnceiledResponseType
Fields
| Field Name | Description |
|---|---|
secretId - String!
|
|
vaultId - String!
|
|
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
groupId - String
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
vault - VaultResponseType!
|
|
versions - PaginatedSecretVersionUnceiledResponseType!
|
|
linkedProjects - PaginatedProjectResponseType!
|
|
linkedDevices - PaginatedDeviceResponseType!
|
|
name - String!
|
|
secretType - SecretTypeEnum!
|
|
lastVersionNumber - Int!
|
|
username - String
|
|
secretValue - String!
|
Example
{
"secretId": "xyz789",
"vaultId": "xyz789",
"creationUserId": "abc123",
"updateUserId": "xyz789",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"vault": VaultResponseType,
"versions": PaginatedSecretVersionUnceiledResponseType,
"linkedProjects": PaginatedProjectResponseType,
"linkedDevices": PaginatedDeviceResponseType,
"name": "abc123",
"secretType": "CREDENTIAL",
"lastVersionNumber": 987,
"username": "xyz789",
"secretValue": "abc123"
}
SecretVersionResponseType
SecretVersionUnceiledResponseType
SmbConfigurationInput
Fields
| Input Field | Description |
|---|---|
ipAddress - String!
|
The IP address of the protocol server on the device. |
port - Int!
|
The port of the SMB server on the device. Default is 445 (SMB). Default = 445 |
protocol - SmbProtocolEnum
|
The protocol used by the SMB server on the device. Default = null |
secretId - String
|
The secret ID for the protocol server credentials (username and password). Default = null |
rootDirectory - String
|
The root directory of the protocol server on the device. If not set, the root directory is assumed to be the home directory of the user. Default = null |
Example
{
"ipAddress": "abc123",
"port": 987,
"protocol": "SMB",
"secretId": "abc123",
"rootDirectory": "xyz789"
}
SmbConfigurationType
Fields
| Field Name | Description |
|---|---|
ipAddress - String!
|
The IP address of the protocol server on the device. |
port - Int!
|
The port of the SMB server on the device. Default is 445 (SMB). |
protocol - SmbProtocolEnum
|
The protocol used by the SMB server on the device. |
secretId - String
|
The secret ID for the protocol server credentials (username and password). |
rootDirectory - String
|
The root directory of the protocol server on the device. If not set, the root directory is assumed to be the home directory of the user. |
Example
{
"ipAddress": "xyz789",
"port": 987,
"protocol": "SMB",
"secretId": "abc123",
"rootDirectory": "xyz789"
}
SmbProtocolEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"SMB"
String
Description
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.
Example
"xyz789"
StringFilterIgnoreDdbInput
Example
{
"eq": "abc123",
"ne": "abc123",
"gt": "abc123",
"lt": "xyz789",
"gte": "xyz789",
"lte": "abc123",
"contains": "abc123",
"containsAny": ["xyz789"],
"notContains": "xyz789",
"beginsWith": "abc123",
"in_": ["abc123"],
"between": ["xyz789"],
"doNotIgnoreNullable": ["eq"],
"ignoreForDdbQuery": true
}
StringFilterInput
Example
{
"eq": "xyz789",
"ne": "abc123",
"gt": "xyz789",
"lt": "abc123",
"gte": "xyz789",
"lte": "abc123",
"contains": "xyz789",
"containsAny": ["xyz789"],
"notContains": "xyz789",
"beginsWith": "abc123",
"in_": ["abc123"],
"between": ["abc123"],
"doNotIgnoreNullable": ["eq"]
}
TagFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
name - StringFilterInput
|
|
nameLower - StringFilterInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"name": StringFilterInput,
"nameLower": StringFilterInput
}
TagResponseInterface
Fields
| Field Name | Description |
|---|---|
name - String!
|
Possible Types
| TagResponseInterface Types |
|---|
Example
{"name": "xyz789"}
TagResponseType
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
groupId - String
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
documents - PaginatedDocumentResponseType!
|
|
Arguments
|
|
devices - PaginatedDeviceResponseType!
|
|
Arguments
|
|
gateways - PaginatedGatewayResponseType!
|
|
Arguments
|
|
projects - PaginatedProjectResponseType!
|
|
Arguments
|
|
color - String
|
|
icon - String
|
|
Example
{
"name": "abc123",
"creationUserId": "abc123",
"updateUserId": "abc123",
"groupId": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 123,
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"documents": PaginatedDocumentResponseType,
"devices": PaginatedDeviceResponseType,
"gateways": PaginatedGatewayResponseType,
"projects": PaginatedProjectResponseType,
"color": "xyz789",
"icon": "abc123"
}
TagToAssetLinkMetaDataType
Fields
| Field Name | Description |
|---|---|
assetVersionId - String
|
Example
{"assetVersionId": "abc123"}
UpdateAssetLinkInput
Fields
| Input Field | Description |
|---|---|
metaData - AssetMetaDataCombinedInput
|
The provided meta data will be merged with the existing meta data of the asset link. Default = null |
objectVersion - Int
|
The object version of the asset link to be updated. This is used for optimistic concurrency control. Default = null |
Example
{
"metaData": AssetMetaDataCombinedInput,
"objectVersion": 987
}
UpdateDeviceInput
Fields
| Input Field | Description |
|---|---|
groupId - String
|
|
name - String
|
|
connectionConfiguration - ConnectionConfigurationUpdateInput
|
|
metaData - JSON
|
|
description - String
|
|
secretId - String
|
|
ftpConfiguration - FtpConfigurationInput
|
|
smbConfiguration - SmbConfigurationInput
|
|
objectVersion - Int
|
Example
{
"groupId": "xyz789",
"name": "abc123",
"connectionConfiguration": ConnectionConfigurationUpdateInput,
"metaData": {},
"description": "xyz789",
"secretId": "abc123",
"ftpConfiguration": FtpConfigurationInput,
"smbConfiguration": SmbConfigurationInput,
"objectVersion": 123
}
UpdateDocumentInput
UpdateDocumentVersionInput
UpdateGatewayInput
UpdateLicenseInput
UpdateProjectInput
Example
{
"groupId": "abc123",
"name": "xyz789",
"description": "xyz789",
"secretId": "abc123",
"attachedLicenses": ["xyz789"],
"objectVersion": 123
}
UpdateProjectVersionInput
UpdateResourceGroupInput
UpdateSecretInput
UpdateTagInput
UpdateVaultInput
UpdateWorkstationInput
UserResponseType
Fields
| Field Name | Description |
|---|---|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
userId - String!
|
|
groupId - String
|
|
firstName - String!
|
|
lastName - String!
|
|
email - String!
|
Example
{
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "xyz789",
"deleteUserId": "abc123",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"userId": "xyz789",
"groupId": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"email": "xyz789"
}
VaultFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
name - StringFilterInput
|
|
nameLower - StringFilterInput
|
|
groupId - StringFilterInput
|
|
tag - StringFilterIgnoreDdbInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"name": StringFilterInput,
"nameLower": StringFilterInput,
"groupId": StringFilterInput,
"tag": StringFilterIgnoreDdbInput
}
VaultResponseInterface
Fields
| Field Name | Description |
|---|---|
vaultId - String!
|
Possible Types
| VaultResponseInterface Types |
|---|
Example
{"vaultId": "abc123"}
VaultResponseType
Fields
| Field Name | Description |
|---|---|
vaultId - String!
|
|
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
groupId - String
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
secrets - PaginatedSecretResponseType!
|
|
Arguments
|
|
linkedTags - PaginatedTagResponseType!
|
|
Arguments
|
|
name - String!
|
|
description - String
|
|
Example
{
"vaultId": "abc123",
"creationUserId": "xyz789",
"updateUserId": "abc123",
"groupId": "abc123",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"objectVersion": 987,
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"secrets": PaginatedSecretResponseType,
"linkedTags": PaginatedTagResponseType,
"name": "abc123",
"description": "abc123"
}
Void
Description
Represents NULL values
WindowsAttrsType
Example
{
"productId": "abc123",
"productName": "abc123",
"compositionEditionId": "abc123",
"currentBuild": "abc123",
"currentVersion": "abc123",
"displayVersion": "xyz789",
"editionId": "abc123",
"installationType": "xyz789",
"registeredOrganization": "xyz789",
"registeredOwner": "abc123",
"winreVersion": "xyz789"
}
WindowsAttrsTypeLinuxAttrsType
Types
| Union Types |
|---|
Example
WindowsAttrsType
WorkstationDeviceConnectionType
Fields
| Field Name | Description |
|---|---|
connectionType - String!
|
|
connectionId - String!
|
|
connectionState - ConnectionState!
|
|
connectionReason - String
|
|
deviceId - String!
|
|
deviceStatus - ConnectionNodeStatus
|
|
workstationId - String!
|
|
workstationStatus - ConnectionNodeStatus
|
|
gatewayId - String
|
|
gatewayStatus - ConnectionNodeStatus
|
|
serverId - String
|
|
serverStatus - ConnectionNodeStatus
|
Example
{
"connectionType": "xyz789",
"connectionId": "xyz789",
"connectionState": "CONNECT_REQUESTED",
"connectionReason": "abc123",
"deviceId": "xyz789",
"deviceStatus": "NOT_CONFIGURED",
"workstationId": "abc123",
"workstationStatus": "NOT_CONFIGURED",
"gatewayId": "xyz789",
"gatewayStatus": "NOT_CONFIGURED",
"serverId": "abc123",
"serverStatus": "NOT_CONFIGURED"
}
WorkstationFilterInput
Fields
| Input Field | Description |
|---|---|
creationTimestamp - StringFilterInput
|
|
updateTimestamp - StringFilterInput
|
|
name - StringFilterInput
|
|
nameLower - StringFilterInput
|
|
groupId - StringFilterInput
|
|
tag - StringFilterIgnoreDdbInput
|
Example
{
"creationTimestamp": StringFilterInput,
"updateTimestamp": StringFilterInput,
"name": StringFilterInput,
"nameLower": StringFilterInput,
"groupId": StringFilterInput,
"tag": StringFilterIgnoreDdbInput
}
WorkstationMetadataResponseType
Fields
| Field Name | Description |
|---|---|
reportedAt - DateTime!
|
|
version - String!
|
|
latestVersion - String
|
|
latestVersionForMajor - String
|
|
architecture - ArchEnum!
|
|
operatingSystem - OperatingSystemEnum!
|
|
operatingSystemAttrs - WindowsAttrsTypeLinuxAttrsType
|
|
numCpu - Int
|
|
isOutdated - Boolean
|
|
isOutdatedForMajor - Boolean
|
Example
{
"reportedAt": "2007-12-03T10:15:30Z",
"version": "abc123",
"latestVersion": "abc123",
"latestVersionForMajor": "abc123",
"architecture": "ARM",
"operatingSystem": "WINDOWS",
"operatingSystemAttrs": WindowsAttrsType,
"numCpu": 123,
"isOutdated": true,
"isOutdatedForMajor": true
}
WorkstationPublicIpResponseType
Fields
| Field Name | Description |
|---|---|
reportedAt - DateTime!
|
|
publicIp - String!
|
|
publicIpLocation - LocationType
|
Example
{
"reportedAt": "2007-12-03T10:15:30Z",
"publicIp": "xyz789",
"publicIpLocation": LocationType
}
WorkstationResponseType
Fields
| Field Name | Description |
|---|---|
objectVersion - Int
|
Version number of the object, used for optimistic locking and change tracking |
creationUserId - String
|
Unique identifier of the user who created this object |
updateUserId - String
|
Unique identifier of the user who last updated this object |
deleteUserId - String
|
Unique identifier of the user who deleted this object |
creationTimestamp - DateTime
|
Date and time when this object was first created (ISO 8601 format) |
updateTimestamp - DateTime
|
Date and time when this object was last modified (ISO 8601 format) |
lock - LockResponseType
|
|
workstationId - String!
|
|
groupId - String
|
|
name - String!
|
|
description - String
|
|
creationUser - UserResponseType
|
|
updateUser - UserResponseType
|
|
group - ResourceGroupResponseType
|
|
state - WorkstationStateResponseType
|
|
metadata - WorkstationMetadataResponseType
|
|
publicIp - WorkstationPublicIpResponseType
|
|
setupCommands - WorkstationSetupResponseType
|
|
deviceConnections - PaginatedWorkstationDeviceConnectionStatusResponseType!
|
|
linkedTags - PaginatedTagResponseType!
|
|
Arguments
|
|
Example
{
"objectVersion": 123,
"creationUserId": "abc123",
"updateUserId": "xyz789",
"deleteUserId": "xyz789",
"creationTimestamp": "2007-12-03T10:15:30Z",
"updateTimestamp": "2007-12-03T10:15:30Z",
"lock": LockResponseType,
"workstationId": "abc123",
"groupId": "xyz789",
"name": "abc123",
"description": "xyz789",
"creationUser": UserResponseType,
"updateUser": UserResponseType,
"group": ResourceGroupResponseType,
"state": WorkstationStateResponseType,
"metadata": WorkstationMetadataResponseType,
"publicIp": WorkstationPublicIpResponseType,
"setupCommands": WorkstationSetupResponseType,
"deviceConnections": PaginatedWorkstationDeviceConnectionStatusResponseType,
"linkedTags": PaginatedTagResponseType
}
WorkstationSetupResponseType
Fields
| Field Name | Description |
|---|---|
expiresAt - DateTime!
|
|
osCommands - [WorkstationSetupType!]!
|
Example
{
"expiresAt": "2007-12-03T10:15:30Z",
"osCommands": [WorkstationSetupType]
}
WorkstationSetupType
Fields
| Field Name | Description |
|---|---|
osType - OperatingSystemEnum!
|
|
osName - String!
|
|
installationCommand - String!
|
|
configurationCommand - String!
|
Example
{
"osType": "WINDOWS",
"osName": "abc123",
"installationCommand": "abc123",
"configurationCommand": "xyz789"
}
WorkstationStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NOT_CONFIGURED"
WorkstationStateResponseType
Fields
| Field Name | Description |
|---|---|
reportedAt - DateTime!
|
|
state - WorkstationStateEnum!
|
Example
{
"reportedAt": "2007-12-03T10:15:30Z",
"state": "NOT_CONFIGURED"
}