mago3D GraphQL API Dataset Reference

This is a sample server for a mago3D GraphQL API Dataset Reference. You can find out more about mago3D at https://www.mago3d.com.

Experience the Future with mago3D.

Objects represent the past of the city, sensor data represents the present of the city, and digital twins represent the future of the city. mago3D provides optimal solutions for customers through 3D visualization, simulation, machine learning (AI), IoT sensors, and big data analysis.
mago3D LIVE DEMO
Contact

API Support

info@gaia3d.com

License

Apache 2.0

https://www.apache.org/licenses/LICENSE-2.0.html

Terms of Service

https://mago3d.com/terms

API Endpoints
https://map.gaia3d.com/app/api/dataset/graphql
Headers
# Your foo from bar
Authorization: Bearer <YOUR_TOKEN_HERE>

Introduction

This is a sample server for a mago3D GraphQL API Dataset Reference. You can find out more about mago3D at https://www.mago3d.com.

Queries

asset

Response

Returns an Asset

Arguments
Name Description
id - ID!

Example

Query
query asset($id: ID!) {
  asset(id: $id) {
    id
    groups {
      id
      name
      assets {
        ...AssetFragment
      }
      description
      enabled
      access
      flags
      tags {
        ...SimpleTagValueFragment
      }
      properties
      parent {
        ...GroupFragment
      }
      children {
        ...GroupFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
    }
    name
    description
    assetType
    enabled
    access
    status
    createdBy
    createdByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    createdAt
    updatedBy
    updatedByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    updatedAt
    files {
      id
      filename
      contentType
      contentSize
      download
      filepath
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    process {
      id
      name
      context
      status
      tasks {
        ...ProcessTaskFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
      properties
    }
    convertedFiles {
      id
      taskId
      filename
      contentType
      contentSize
      download
      filepath
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    flags
    properties
    tags {
      id
      name
      value
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "asset": {
      "id": "4",
      "groups": [Group],
      "name": "abc123",
      "description": "xyz789",
      "assetType": "Tiles3D",
      "enabled": true,
      "access": "Private",
      "status": "None",
      "createdBy": "4",
      "createdByUser": User,
      "createdAt": "xyz789",
      "updatedBy": "4",
      "updatedByUser": User,
      "updatedAt": "abc123",
      "files": [AssetFile],
      "process": Process,
      "convertedFiles": [ConvertedFile],
      "flags": ["VECTOR"],
      "properties": {},
      "tags": [SimpleTagValue]
    }
  }
}
Queries

assets

Response

Returns an AssetPaged!

Arguments
Name Description
filter - AssetFilterInput
pageable - AssetPageableInput

Example

Query
query assets(
  $filter: AssetFilterInput,
  $pageable: AssetPageableInput
) {
  assets(
    filter: $filter,
    pageable: $pageable
  ) {
    items {
      id
      groups {
        ...GroupFragment
      }
      name
      description
      assetType
      enabled
      access
      status
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
      files {
        ...AssetFileFragment
      }
      process {
        ...ProcessFragment
      }
      convertedFiles {
        ...ConvertedFileFragment
      }
      flags
      properties
      tags {
        ...SimpleTagValueFragment
      }
    }
    pageInfo {
      totalPages
      totalItems
      page
      size
      hasNextPage
      hasPreviousPage
    }
  }
}
Variables
{
  "filter": AssetFilterInput,
  "pageable": AssetPageableInput
}
Response
{
  "data": {
    "assets": {
      "items": [Asset],
      "pageInfo": PaginationInfo
    }
  }
}
Queries

group

Response

Returns a Group

Arguments
Name Description
id - ID!

Example

Query
query group($id: ID!) {
  group(id: $id) {
    id
    name
    assets {
      id
      groups {
        ...GroupFragment
      }
      name
      description
      assetType
      enabled
      access
      status
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
      files {
        ...AssetFileFragment
      }
      process {
        ...ProcessFragment
      }
      convertedFiles {
        ...ConvertedFileFragment
      }
      flags
      properties
      tags {
        ...SimpleTagValueFragment
      }
    }
    description
    enabled
    access
    flags
    tags {
      id
      name
      value
    }
    properties
    parent {
      id
      name
      assets {
        ...AssetFragment
      }
      description
      enabled
      access
      flags
      tags {
        ...SimpleTagValueFragment
      }
      properties
      parent {
        ...GroupFragment
      }
      children {
        ...GroupFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
    }
    children {
      id
      name
      assets {
        ...AssetFragment
      }
      description
      enabled
      access
      flags
      tags {
        ...SimpleTagValueFragment
      }
      properties
      parent {
        ...GroupFragment
      }
      children {
        ...GroupFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
    }
    createdBy
    createdByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    createdAt
    updatedBy
    updatedByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "group": {
      "id": "4",
      "name": "abc123",
      "assets": [Asset],
      "description": "abc123",
      "enabled": false,
      "access": "Private",
      "flags": ["BASEMAP"],
      "tags": [SimpleTagValue],
      "properties": {},
      "parent": Group,
      "children": [Group],
      "createdBy": 4,
      "createdByUser": User,
      "createdAt": "abc123",
      "updatedBy": 4,
      "updatedByUser": User,
      "updatedAt": "xyz789"
    }
  }
}
Queries

groups

Response

Returns a GroupPaged!

Arguments
Name Description
filter - GroupFilterInput
pageable - GroupPageableInput

Example

Query
query groups(
  $filter: GroupFilterInput,
  $pageable: GroupPageableInput
) {
  groups(
    filter: $filter,
    pageable: $pageable
  ) {
    items {
      id
      name
      assets {
        ...AssetFragment
      }
      description
      enabled
      access
      flags
      tags {
        ...SimpleTagValueFragment
      }
      properties
      parent {
        ...GroupFragment
      }
      children {
        ...GroupFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
    }
    pageInfo {
      totalPages
      totalItems
      page
      size
      hasNextPage
      hasPreviousPage
    }
  }
}
Variables
{
  "filter": GroupFilterInput,
  "pageable": GroupPageableInput
}
Response
{
  "data": {
    "groups": {
      "items": [Group],
      "pageInfo": PaginationInfo
    }
  }
}
Queries

label

Response

Returns a Label

Arguments
Name Description
id - ID!

Example

Query
query label($id: ID!) {
  label(id: $id) {
    id
    name
    content
    enabled
    access
    viewCount
    createdBy
    createdAt
    updatedBy
    updatedAt
    files {
      id
      filename
      contentType
      contentSize
      download
      filepath
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "label": {
      "id": "4",
      "name": "abc123",
      "content": "xyz789",
      "enabled": false,
      "access": "Private",
      "viewCount": 123,
      "createdBy": "4",
      "createdAt": "abc123",
      "updatedBy": 4,
      "updatedAt": "xyz789",
      "files": [AssetFile]
    }
  }
}
Queries

labels

Response

Returns a LabelPaged!

Arguments
Name Description
filter - LabelFilterInput
pageable - LabelPageableInput

Example

Query
query labels(
  $filter: LabelFilterInput,
  $pageable: LabelPageableInput
) {
  labels(
    filter: $filter,
    pageable: $pageable
  ) {
    items {
      id
      name
      content
      enabled
      access
      viewCount
      createdBy
      createdAt
      updatedBy
      updatedAt
      files {
        ...AssetFileFragment
      }
    }
    pageInfo {
      totalPages
      totalItems
      page
      size
      hasNextPage
      hasPreviousPage
    }
  }
}
Variables
{
  "filter": LabelFilterInput,
  "pageable": LabelPageableInput
}
Response
{
  "data": {
    "labels": {
      "items": [Label],
      "pageInfo": PaginationInfo
    }
  }
}
Queries

process

Response

Returns a Process

Arguments
Name Description
id - ID!

Example

Query
query process($id: ID!) {
  process(id: $id) {
    id
    name
    context
    status
    tasks {
      id
      status
      error
      stacktrace
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    createdBy
    createdByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    createdAt
    updatedBy
    updatedByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    updatedAt
    properties
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "process": {
      "id": "4",
      "name": "abc123",
      "context": {},
      "status": "None",
      "tasks": [ProcessTask],
      "createdBy": "4",
      "createdByUser": User,
      "createdAt": "xyz789",
      "updatedBy": 4,
      "updatedByUser": User,
      "updatedAt": "xyz789",
      "properties": {}
    }
  }
}
Queries

processes

Response

Returns a ProcessPaged!

Arguments
Name Description
filter - ProcessFilterInput
pageable - ProcessPageableInput

Example

Query
query processes(
  $filter: ProcessFilterInput,
  $pageable: ProcessPageableInput
) {
  processes(
    filter: $filter,
    pageable: $pageable
  ) {
    items {
      id
      name
      context
      status
      tasks {
        ...ProcessTaskFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
      properties
    }
    pageInfo {
      totalPages
      totalItems
      page
      size
      hasNextPage
      hasPreviousPage
    }
  }
}
Variables
{
  "filter": ProcessFilterInput,
  "pageable": ProcessPageableInput
}
Response
{
  "data": {
    "processes": {
      "items": [Process],
      "pageInfo": PaginationInfo
    }
  }
}
Queries

uploadFile

Response

Returns an UploadFile

Arguments
Name Description
id - ID!

Example

Query
query uploadFile($id: ID!) {
  uploadFile(id: $id) {
    id
    filename
    contentSize
    contentType
    download
    createdBy
    createdByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    createdAt
    updatedBy
    updatedByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    updatedAt
    properties
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "uploadFile": {
      "id": 4,
      "filename": "abc123",
      "contentSize": 123,
      "contentType": "abc123",
      "download": "abc123",
      "createdBy": 4,
      "createdByUser": User,
      "createdAt": "abc123",
      "updatedBy": "4",
      "updatedByUser": User,
      "updatedAt": "abc123",
      "properties": {}
    }
  }
}
Queries

uploadFiles

Response

Returns an UploadFilePaged!

Arguments
Name Description
filter - UploadFileFilterInput
pageable - UploadFilePageableInput

Example

Query
query uploadFiles(
  $filter: UploadFileFilterInput,
  $pageable: UploadFilePageableInput
) {
  uploadFiles(
    filter: $filter,
    pageable: $pageable
  ) {
    items {
      id
      filename
      contentSize
      contentType
      download
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
      properties
    }
    pageInfo {
      totalPages
      totalItems
      page
      size
      hasNextPage
      hasPreviousPage
    }
  }
}
Variables
{
  "filter": UploadFileFilterInput,
  "pageable": UploadFilePageableInput
}
Response
{
  "data": {
    "uploadFiles": {
      "items": [UploadFile],
      "pageInfo": PaginationInfo
    }
  }
}

Mutations

appendAsset

Response

Returns a Boolean!

Arguments
Name Description
id - ID!
assetId - [ID]!

Example

Query
mutation appendAsset(
  $id: ID!,
  $assetId: [ID]!
) {
  appendAsset(
    id: $id,
    assetId: $assetId
  )
}
Variables
{"id": 4, "assetId": ["4"]}
Response
{"data": {"appendAsset": false}}
Mutations

appendAssetFile

Response

Returns a Boolean!

Arguments
Name Description
id - ID!
fileId - [ID]!

Example

Query
mutation appendAssetFile(
  $id: ID!,
  $fileId: [ID]!
) {
  appendAssetFile(
    id: $id,
    fileId: $fileId
  )
}
Variables
{"id": 4, "fileId": [4]}
Response
{"data": {"appendAssetFile": false}}
Mutations

createAsset

Response

Returns a CreateAssetResponse!

Arguments
Name Description
input - CreateAssetInput!

Example

Query
mutation createAsset($input: CreateAssetInput!) {
  createAsset(input: $input) {
    id
    name
    description
    assetType
    enabled
    access
    groups {
      id
      name
      assets {
        ...AssetFragment
      }
      description
      enabled
      access
      flags
      tags {
        ...SimpleTagValueFragment
      }
      properties
      parent {
        ...GroupFragment
      }
      children {
        ...GroupFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
    }
    files {
      id
      filename
      contentType
      contentSize
      download
      filepath
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    properties
    flags
    tags {
      id
      name
      value
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"input": CreateAssetInput}
Response
{
  "data": {
    "createAsset": {
      "id": "4",
      "name": "xyz789",
      "description": "xyz789",
      "assetType": "Tiles3D",
      "enabled": true,
      "access": "Private",
      "groups": [Group],
      "files": [AssetFile],
      "properties": {},
      "flags": ["VECTOR"],
      "tags": [SimpleTagValue],
      "createdBy": 4,
      "createdAt": "xyz789",
      "updatedBy": "4",
      "updatedAt": "abc123"
    }
  }
}
Mutations

createGroup

Response

Returns a CreateGroupResponse!

Arguments
Name Description
input - CreateGroupInput!

Example

Query
mutation createGroup($input: CreateGroupInput!) {
  createGroup(input: $input) {
    id
    parentId
    name
    description
    enabled
    access
    flags
    tags {
      id
      name
      value
    }
    properties
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"input": CreateGroupInput}
Response
{
  "data": {
    "createGroup": {
      "id": "4",
      "parentId": 4,
      "name": "xyz789",
      "description": "xyz789",
      "enabled": false,
      "access": "Private",
      "flags": ["BASEMAP"],
      "tags": [SimpleTagValue],
      "properties": {},
      "createdBy": "4",
      "createdAt": "xyz789",
      "updatedBy": "4",
      "updatedAt": "abc123"
    }
  }
}
Mutations

createLabel

Response

Returns a CreateLabelResponse!

Arguments
Name Description
input - CreateLabelInput!

Example

Query
mutation createLabel($input: CreateLabelInput!) {
  createLabel(input: $input) {
    id
    name
    description
    assetType
    enabled
    access
    files {
      id
      filename
      contentType
      contentSize
      download
      filepath
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
    properties
    tags {
      id
      name
      value
    }
  }
}
Variables
{"input": CreateLabelInput}
Response
{
  "data": {
    "createLabel": {
      "id": "4",
      "name": "abc123",
      "description": "abc123",
      "assetType": "Tiles3D",
      "enabled": true,
      "access": "Private",
      "files": [AssetFile],
      "createdBy": "4",
      "createdAt": "abc123",
      "updatedBy": "4",
      "updatedAt": "abc123",
      "properties": {},
      "tags": [SimpleTagValue]
    }
  }
}
Mutations

createProcess

Response

Returns a CreateProcessResponse!

Arguments
Name Description
input - CreateProcessInput!

Example

Query
mutation createProcess($input: CreateProcessInput!) {
  createProcess(input: $input) {
    id
    name
    status
    properties
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"input": CreateProcessInput}
Response
{
  "data": {
    "createProcess": {
      "id": 4,
      "name": "xyz789",
      "status": "None",
      "properties": {},
      "createdBy": 4,
      "createdAt": "abc123",
      "updatedBy": "4",
      "updatedAt": "abc123"
    }
  }
}
Mutations

deleteAsset

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation deleteAsset($id: ID!) {
  deleteAsset(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"deleteAsset": true}}
Mutations

deleteAssetFile

Response

Returns a Boolean!

Arguments
Name Description
id - ID!
fileId - [ID]!

Example

Query
mutation deleteAssetFile(
  $id: ID!,
  $fileId: [ID]!
) {
  deleteAssetFile(
    id: $id,
    fileId: $fileId
  )
}
Variables
{"id": 4, "fileId": [4]}
Response
{"data": {"deleteAssetFile": false}}
Mutations

deleteGroup

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation deleteGroup($id: ID!) {
  deleteGroup(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"deleteGroup": false}}
Mutations

deleteLabel

Response

Returns a Boolean!

Arguments
Name Description
id - [ID]!

Example

Query
mutation deleteLabel($id: [ID]!) {
  deleteLabel(id: $id)
}
Variables
{"id": ["4"]}
Response
{"data": {"deleteLabel": true}}
Mutations

deleteUploadFile

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation deleteUploadFile($id: ID!) {
  deleteUploadFile(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"deleteUploadFile": false}}
Mutations

locateAsset

Response

Returns an Asset!

Arguments
Name Description
input - LocateAssetInput!

Example

Query
mutation locateAsset($input: LocateAssetInput!) {
  locateAsset(input: $input) {
    id
    groups {
      id
      name
      assets {
        ...AssetFragment
      }
      description
      enabled
      access
      flags
      tags {
        ...SimpleTagValueFragment
      }
      properties
      parent {
        ...GroupFragment
      }
      children {
        ...GroupFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
    }
    name
    description
    assetType
    enabled
    access
    status
    createdBy
    createdByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    createdAt
    updatedBy
    updatedByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    updatedAt
    files {
      id
      filename
      contentType
      contentSize
      download
      filepath
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    process {
      id
      name
      context
      status
      tasks {
        ...ProcessTaskFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
      properties
    }
    convertedFiles {
      id
      taskId
      filename
      contentType
      contentSize
      download
      filepath
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    flags
    properties
    tags {
      id
      name
      value
    }
  }
}
Variables
{"input": LocateAssetInput}
Response
{
  "data": {
    "locateAsset": {
      "id": "4",
      "groups": [Group],
      "name": "abc123",
      "description": "xyz789",
      "assetType": "Tiles3D",
      "enabled": true,
      "access": "Private",
      "status": "None",
      "createdBy": "4",
      "createdByUser": User,
      "createdAt": "xyz789",
      "updatedBy": 4,
      "updatedByUser": User,
      "updatedAt": "abc123",
      "files": [AssetFile],
      "process": Process,
      "convertedFiles": [ConvertedFile],
      "flags": ["VECTOR"],
      "properties": {},
      "tags": [SimpleTagValue]
    }
  }
}
Mutations

locateGroup

Response

Returns a Group!

Arguments
Name Description
id - ID!
input - LocateGroupInput!

Example

Query
mutation locateGroup(
  $id: ID!,
  $input: LocateGroupInput!
) {
  locateGroup(
    id: $id,
    input: $input
  ) {
    id
    name
    assets {
      id
      groups {
        ...GroupFragment
      }
      name
      description
      assetType
      enabled
      access
      status
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
      files {
        ...AssetFileFragment
      }
      process {
        ...ProcessFragment
      }
      convertedFiles {
        ...ConvertedFileFragment
      }
      flags
      properties
      tags {
        ...SimpleTagValueFragment
      }
    }
    description
    enabled
    access
    flags
    tags {
      id
      name
      value
    }
    properties
    parent {
      id
      name
      assets {
        ...AssetFragment
      }
      description
      enabled
      access
      flags
      tags {
        ...SimpleTagValueFragment
      }
      properties
      parent {
        ...GroupFragment
      }
      children {
        ...GroupFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
    }
    children {
      id
      name
      assets {
        ...AssetFragment
      }
      description
      enabled
      access
      flags
      tags {
        ...SimpleTagValueFragment
      }
      properties
      parent {
        ...GroupFragment
      }
      children {
        ...GroupFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
    }
    createdBy
    createdByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    createdAt
    updatedBy
    updatedByUser {
      id
      username
      firstname
      lastname
      email
      emailVerified
      enabled
      attributes
      createdAt
    }
    updatedAt
  }
}
Variables
{"id": 4, "input": LocateGroupInput}
Response
{
  "data": {
    "locateGroup": {
      "id": "4",
      "name": "xyz789",
      "assets": [Asset],
      "description": "xyz789",
      "enabled": false,
      "access": "Private",
      "flags": ["BASEMAP"],
      "tags": [SimpleTagValue],
      "properties": {},
      "parent": Group,
      "children": [Group],
      "createdBy": "4",
      "createdByUser": User,
      "createdAt": "xyz789",
      "updatedBy": 4,
      "updatedByUser": User,
      "updatedAt": "abc123"
    }
  }
}
Mutations

replaceAsset

Response

Returns a Boolean!

Arguments
Name Description
id - ID!
assetId - [ID]!

Example

Query
mutation replaceAsset(
  $id: ID!,
  $assetId: [ID]!
) {
  replaceAsset(
    id: $id,
    assetId: $assetId
  )
}
Variables
{"id": "4", "assetId": [4]}
Response
{"data": {"replaceAsset": true}}
Mutations

updateAsset

Response

Returns an UpdateAssetResponse!

Arguments
Name Description
id - ID!
input - UpdateAssetInput!

Example

Query
mutation updateAsset(
  $id: ID!,
  $input: UpdateAssetInput!
) {
  updateAsset(
    id: $id,
    input: $input
  ) {
    id
    name
    description
    assetType
    enabled
    access
    groups {
      id
      name
      assets {
        ...AssetFragment
      }
      description
      enabled
      access
      flags
      tags {
        ...SimpleTagValueFragment
      }
      properties
      parent {
        ...GroupFragment
      }
      children {
        ...GroupFragment
      }
      createdBy
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedBy
      updatedByUser {
        ...UserFragment
      }
      updatedAt
    }
    files {
      id
      filename
      contentType
      contentSize
      download
      filepath
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    flags
    properties
    tags {
      id
      name
      value
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{
  "id": "4",
  "input": UpdateAssetInput
}
Response
{
  "data": {
    "updateAsset": {
      "id": "4",
      "name": "xyz789",
      "description": "abc123",
      "assetType": "Tiles3D",
      "enabled": false,
      "access": "Private",
      "groups": [Group],
      "files": [AssetFile],
      "flags": ["VECTOR"],
      "properties": {},
      "tags": [SimpleTagValue],
      "createdBy": "4",
      "createdAt": "xyz789",
      "updatedBy": 4,
      "updatedAt": "xyz789"
    }
  }
}
Mutations

updateGroup

Response

Returns an UpdateGroupResponse!

Arguments
Name Description
id - ID!
input - UpdateGroupInput!

Example

Query
mutation updateGroup(
  $id: ID!,
  $input: UpdateGroupInput!
) {
  updateGroup(
    id: $id,
    input: $input
  ) {
    id
    parentId
    name
    description
    enabled
    access
    viewCount
    createdBy
    createdAt
    updatedBy
    updatedAt
    flags
    tags {
      id
      name
      value
    }
    properties
  }
}
Variables
{
  "id": "4",
  "input": UpdateGroupInput
}
Response
{
  "data": {
    "updateGroup": {
      "id": "4",
      "parentId": "4",
      "name": "abc123",
      "description": "xyz789",
      "enabled": false,
      "access": "Private",
      "viewCount": 123,
      "createdBy": 4,
      "createdAt": "xyz789",
      "updatedBy": "4",
      "updatedAt": "xyz789",
      "flags": ["BASEMAP"],
      "tags": [SimpleTagValue],
      "properties": {}
    }
  }
}
Mutations

updateLabel

Response

Returns an UpdateLabelResponse!

Arguments
Name Description
id - ID!
input - UpdateLabelInput!

Example

Query
mutation updateLabel(
  $id: ID!,
  $input: UpdateLabelInput!
) {
  updateLabel(
    id: $id,
    input: $input
  ) {
    id
    name
    description
    assetType
    enabled
    access
    files {
      id
      filename
      contentType
      contentSize
      download
      filepath
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
    properties
    tags {
      id
      name
      value
    }
  }
}
Variables
{
  "id": "4",
  "input": UpdateLabelInput
}
Response
{
  "data": {
    "updateLabel": {
      "id": "4",
      "name": "xyz789",
      "description": "xyz789",
      "assetType": "Tiles3D",
      "enabled": false,
      "access": "Private",
      "files": [AssetFile],
      "createdBy": "4",
      "createdAt": "xyz789",
      "updatedBy": 4,
      "updatedAt": "xyz789",
      "properties": {},
      "tags": [SimpleTagValue]
    }
  }
}
Mutations

updateProcess

Response

Returns an UpdateProcessResponse!

Arguments
Name Description
id - ID!
input - UpdateProcessInput!

Example

Query
mutation updateProcess(
  $id: ID!,
  $input: UpdateProcessInput!
) {
  updateProcess(
    id: $id,
    input: $input
  ) {
    id
    name
    status
    properties
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"id": 4, "input": UpdateProcessInput}
Response
{
  "data": {
    "updateProcess": {
      "id": "4",
      "name": "xyz789",
      "status": "None",
      "properties": {},
      "createdBy": "4",
      "createdAt": "abc123",
      "updatedBy": 4,
      "updatedAt": "xyz789"
    }
  }
}

Types

Access

Values
Enum Value Description

Private

Protected

Public
Example
"Private"
Types

AccessCriteria

Fields
Input Field Description
eq - Access
ne - Access
in - [Access]
notIn - [Access]
isNull - Boolean
Example
{
  "eq": "Private",
  "ne": "Private",
  "in": ["Private"],
  "notIn": ["Private"],
  "isNull": true
}
Types

Asset

Fields
Field Name Description
id - ID!
groups - [Group]
name - String!
description - String
assetType - AssetType!
enabled - Boolean!
access - Access!
status - ProcessTaskStatus
createdBy - ID!
createdByUser - User!
createdAt - String
updatedBy - ID!
updatedByUser - User!
updatedAt - String
files - [AssetFile]!
process - Process
convertedFiles - [ConvertedFile]
flags - [DataAssetFlag]
properties - JSON
tags - [SimpleTagValue]!
Example
{
  "id": 4,
  "groups": [Group],
  "name": "abc123",
  "description": "abc123",
  "assetType": "Tiles3D",
  "enabled": false,
  "access": "Private",
  "status": "None",
  "createdBy": "4",
  "createdByUser": User,
  "createdAt": "xyz789",
  "updatedBy": "4",
  "updatedByUser": User,
  "updatedAt": "abc123",
  "files": [AssetFile],
  "process": Process,
  "convertedFiles": [ConvertedFile],
  "flags": ["VECTOR"],
  "properties": {},
  "tags": [SimpleTagValue]
}
Types

AssetFile

Fields
Field Name Description
id - ID!
filename - String!
contentType - String!
contentSize - Int!
download - String
filepath - String
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": 4,
  "filename": "xyz789",
  "contentType": "xyz789",
  "contentSize": 987,
  "download": "xyz789",
  "filepath": "abc123",
  "createdBy": 4,
  "createdAt": "xyz789",
  "updatedBy": 4,
  "updatedAt": "abc123"
}
Types

AssetFilterInput

Fields
Input Field Description
id - SimpleCriteria
groupId - SimpleCriteria
groupName - StringCriteria
name - StringCriteria
description - StringCriteria
enabled - BooleanCriteria
access - AccessCriteria
assetType - AssetTypeCriteria
status - ProcessTaskStatusCriteria
createdAt - DateTimeCriteria
createdBy - SimpleCriteria
and - [AssetFilterInput]
or - [AssetFilterInput]
not - AssetFilterInput
Example
{
  "id": SimpleCriteria,
  "groupId": SimpleCriteria,
  "groupName": StringCriteria,
  "name": StringCriteria,
  "description": StringCriteria,
  "enabled": BooleanCriteria,
  "access": AccessCriteria,
  "assetType": AssetTypeCriteria,
  "status": ProcessTaskStatusCriteria,
  "createdAt": DateTimeCriteria,
  "createdBy": SimpleCriteria,
  "and": [AssetFilterInput],
  "or": [AssetFilterInput],
  "not": AssetFilterInput
}
Types

AssetPageableInput

Fields
Input Field Description
page - Int!
size - Int!
sort - [AssetSort]
Example
{"page": 123, "size": 987, "sort": ["ORDER_ASC"]}
Types

AssetPaged

Fields
Field Name Description
items - [Asset]!
pageInfo - PaginationInfo!
Example
{
  "items": [Asset],
  "pageInfo": PaginationInfo
}
Types

AssetSort

Values
Enum Value Description

ORDER_ASC

ORDER_DESC

NAME_ASC

NAME_DESC

CREATED_AT_ASC

CREATED_AT_DESC

UPDATED_AT_ASC

UPDATED_AT_DESC
Example
"ORDER_ASC"
Types

AssetType

Values
Enum Value Description

Tiles3D

Imagery

Terrain

GeoJSON

CZML

KML

SHP

COG
Example
"Tiles3D"
Types

AssetTypeCriteria

Fields
Input Field Description
eq - AssetType
ne - AssetType
in - [AssetType]
notIn - [AssetType]
isNull - Boolean
Example
{
  "eq": "Tiles3D",
  "ne": "Tiles3D",
  "in": ["Tiles3D"],
  "notIn": ["Tiles3D"],
  "isNull": false
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

BooleanCriteria

Fields
Input Field Description
lt - Boolean
le - Boolean
eq - Boolean
ne - Boolean
ge - Boolean
gt - Boolean
isNull - Boolean
in - [Boolean]
notIn - [Boolean]
between - [Boolean]
notBetween - [Boolean]
min - BooleanCriteria
max - BooleanCriteria
Example
{
  "lt": true,
  "le": true,
  "eq": true,
  "ne": true,
  "ge": true,
  "gt": true,
  "isNull": true,
  "in": [true],
  "notIn": [false],
  "between": [true],
  "notBetween": [false],
  "min": BooleanCriteria,
  "max": BooleanCriteria
}
Types

CogConvertInput

Fields
Input Field Description
tiled - Boolean!
overviews - Boolean!
compress - String!
Example
{
  "tiled": true,
  "overviews": false,
  "compress": "xyz789"
}
Types

CommonCriteria

Fields
Input Field Description
lt - ID
le - ID
eq - ID
ne - ID
ge - ID
gt - ID
isNull - Boolean
in - [ID]
notIn - [ID]
between - [ID]
notBetween - [ID]
min - CommonCriteria
max - CommonCriteria
Example
{
  "lt": "4",
  "le": "4",
  "eq": "4",
  "ne": "4",
  "ge": "4",
  "gt": 4,
  "isNull": false,
  "in": [4],
  "notIn": ["4"],
  "between": ["4"],
  "notBetween": [4],
  "min": CommonCriteria,
  "max": CommonCriteria
}
Types

ConvertedFile

Fields
Field Name Description
id - ID!
taskId - ID!
filename - String!
contentType - String!
contentSize - Int!
download - String
filepath - String
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": 4,
  "taskId": 4,
  "filename": "xyz789",
  "contentType": "abc123",
  "contentSize": 987,
  "download": "abc123",
  "filepath": "xyz789",
  "createdBy": 4,
  "createdAt": "xyz789",
  "updatedBy": 4,
  "updatedAt": "xyz789"
}
Types

CreateAssetInput

Fields
Input Field Description
name - String!
description - String
assetType - AssetType!
enabled - Boolean!
access - Access!
groupId - [ID]
uploadId - [ID!]
flags - [DataAssetFlag]
tags - [SimpleTagCreateInput]
properties - JSON
Example
{
  "name": "abc123",
  "description": "xyz789",
  "assetType": "Tiles3D",
  "enabled": true,
  "access": "Private",
  "groupId": ["4"],
  "uploadId": ["4"],
  "flags": ["VECTOR"],
  "tags": [SimpleTagCreateInput],
  "properties": {}
}
Types

CreateAssetResponse

Fields
Field Name Description
id - ID!
name - String!
description - String
assetType - AssetType!
enabled - Boolean!
access - Access!
groups - [Group]
files - [AssetFile]!
properties - JSON
flags - [DataAssetFlag]
tags - [SimpleTagValue]
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": 4,
  "name": "xyz789",
  "description": "xyz789",
  "assetType": "Tiles3D",
  "enabled": true,
  "access": "Private",
  "groups": [Group],
  "files": [AssetFile],
  "properties": {},
  "flags": ["VECTOR"],
  "tags": [SimpleTagValue],
  "createdBy": 4,
  "createdAt": "xyz789",
  "updatedBy": "4",
  "updatedAt": "xyz789"
}
Types

CreateGroupInput

Fields
Input Field Description
parentId - ID
name - String!
description - String
enabled - Boolean!
access - Access!
flags - [DataGroupFlag]
tags - [SimpleTagCreateInput]
properties - JSON
Example
{
  "parentId": 4,
  "name": "abc123",
  "description": "abc123",
  "enabled": true,
  "access": "Private",
  "flags": ["BASEMAP"],
  "tags": [SimpleTagCreateInput],
  "properties": {}
}
Types

CreateGroupResponse

Fields
Field Name Description
id - ID!
parentId - ID
name - String!
description - String
enabled - Boolean!
access - Access!
flags - [DataGroupFlag]
tags - [SimpleTagValue]
properties - JSON
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": 4,
  "parentId": "4",
  "name": "xyz789",
  "description": "abc123",
  "enabled": true,
  "access": "Private",
  "flags": ["BASEMAP"],
  "tags": [SimpleTagValue],
  "properties": {},
  "createdBy": 4,
  "createdAt": "xyz789",
  "updatedBy": "4",
  "updatedAt": "xyz789"
}
Types

CreateLabelInput

Fields
Input Field Description
name - String!
description - String
content - String
enabled - Boolean!
access - Access!
files - [ID!]
tags - [SimpleTagCreateInput]
properties - JSON
Example
{
  "name": "abc123",
  "description": "abc123",
  "content": "xyz789",
  "enabled": false,
  "access": "Private",
  "files": ["4"],
  "tags": [SimpleTagCreateInput],
  "properties": {}
}
Types

CreateLabelResponse

Fields
Field Name Description
id - ID!
name - String!
description - String
assetType - AssetType!
enabled - Boolean!
access - Access!
files - [AssetFile]!
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
properties - JSON
tags - [SimpleTagValue]!
Example
{
  "id": 4,
  "name": "xyz789",
  "description": "abc123",
  "assetType": "Tiles3D",
  "enabled": true,
  "access": "Private",
  "files": [AssetFile],
  "createdBy": 4,
  "createdAt": "abc123",
  "updatedBy": 4,
  "updatedAt": "xyz789",
  "properties": {},
  "tags": [SimpleTagValue]
}
Types

CreateProcessInput

Fields
Input Field Description
name - String!
context - ProcessContextInput!
source - ProcessSourceInput!
properties - JSON
Example
{
  "name": "xyz789",
  "context": ProcessContextInput,
  "source": ProcessSourceInput,
  "properties": {}
}
Types

CreateProcessResponse

Fields
Field Name Description
id - ID!
name - String!
status - ProcessTaskStatus
properties - JSON
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": 4,
  "name": "abc123",
  "status": "None",
  "properties": {},
  "createdBy": "4",
  "createdAt": "xyz789",
  "updatedBy": "4",
  "updatedAt": "abc123"
}
Types

DataAssetFlag

Values
Enum Value Description

VECTOR

RASTER

MODEL

IMAGE

VIDEO

DOCUMENT

OTHER
Example
"VECTOR"
Types

DataGroupFlag

Values
Enum Value Description

BASEMAP

SATELLITE

AERIAL

DEM

TERRAIN

ARMY

NAVY

AIRFORCE

MARINES
Example
"BASEMAP"
Types

Date

Example
"2007-12-03"
Types

DateCriteria

Fields
Input Field Description
lt - Date
le - Date
eq - Date
ne - Date
ge - Date
gt - Date
in - [Date]
notIn - [Date]
between - [Date]
notBetween - [Date]
min - DateCriteria
max - DateCriteria
Example
{
  "lt": "2007-12-03",
  "le": "2007-12-03",
  "eq": "2007-12-03",
  "ne": "2007-12-03",
  "ge": "2007-12-03",
  "gt": "2007-12-03",
  "in": ["2007-12-03"],
  "notIn": ["2007-12-03"],
  "between": ["2007-12-03"],
  "notBetween": ["2007-12-03"],
  "min": DateCriteria,
  "max": DateCriteria
}
Types

DateTime

Example
"2007-12-03T10:15:30Z"
Types

DateTimeCriteria

Fields
Input Field Description
lt - DateTime
le - DateTime
eq - DateTime
ne - DateTime
ge - DateTime
gt - DateTime
isNull - Boolean
in - [DateTime]
notIn - [DateTime]
between - [DateTime]
notBetween - [DateTime]
min - DateTimeCriteria
max - DateTimeCriteria
Example
{
  "lt": "2007-12-03T10:15:30Z",
  "le": "2007-12-03T10:15:30Z",
  "eq": "2007-12-03T10:15:30Z",
  "ne": "2007-12-03T10:15:30Z",
  "ge": "2007-12-03T10:15:30Z",
  "gt": "2007-12-03T10:15:30Z",
  "isNull": true,
  "in": ["2007-12-03T10:15:30Z"],
  "notIn": ["2007-12-03T10:15:30Z"],
  "between": ["2007-12-03T10:15:30Z"],
  "notBetween": ["2007-12-03T10:15:30Z"],
  "min": DateTimeCriteria,
  "max": DateTimeCriteria
}
Types

F4DConvertInput

Fields
Input Field Description
sourceCharset - String!
targetCharset - String!
meshType - String
skinLevel - Int
usf - Float
indexing - Boolean
upAxis - ProcessTaskF4DUpAxis
Example
{
  "sourceCharset": "abc123",
  "targetCharset": "abc123",
  "meshType": "abc123",
  "skinLevel": 123,
  "usf": 987.65,
  "indexing": false,
  "upAxis": "Y"
}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

FloatCriteria

Fields
Input Field Description
lt - Float
le - Float
eq - Float
ne - Float
ge - Float
gt - Float
in - [Float]
notIn - [Float]
between - [Float]
notBetween - [Float]
min - FloatCriteria
max - FloatCriteria
Example
{
  "lt": 987.65,
  "le": 123.45,
  "eq": 987.65,
  "ne": 123.45,
  "ge": 987.65,
  "gt": 123.45,
  "in": [123.45],
  "notIn": [123.45],
  "between": [987.65],
  "notBetween": [123.45],
  "min": FloatCriteria,
  "max": FloatCriteria
}
Types

Group

Fields
Field Name Description
id - ID!
name - String!
assets - [Asset]
description - String
enabled - Boolean!
access - Access!
flags - [DataGroupFlag]
tags - [SimpleTagValue]
properties - JSON
parent - Group
children - [Group]!
createdBy - ID!
createdByUser - User!
createdAt - String
updatedBy - ID!
updatedByUser - User!
updatedAt - String
Example
{
  "id": 4,
  "name": "abc123",
  "assets": [Asset],
  "description": "abc123",
  "enabled": true,
  "access": "Private",
  "flags": ["BASEMAP"],
  "tags": [SimpleTagValue],
  "properties": {},
  "parent": Group,
  "children": [Group],
  "createdBy": 4,
  "createdByUser": User,
  "createdAt": "xyz789",
  "updatedBy": 4,
  "updatedByUser": User,
  "updatedAt": "xyz789"
}
Types

GroupFilterInput

Fields
Input Field Description
onlyRoot - Boolean
id - SimpleCriteria
parentId - SimpleCriteria
name - StringCriteria
description - StringCriteria
enabled - BooleanCriteria
access - AccessCriteria
createdBy - SimpleCriteria
createdAt - DateTimeCriteria
and - [GroupFilterInput!]
or - [GroupFilterInput!]
not - GroupFilterInput
Example
{
  "onlyRoot": false,
  "id": SimpleCriteria,
  "parentId": SimpleCriteria,
  "name": StringCriteria,
  "description": StringCriteria,
  "enabled": BooleanCriteria,
  "access": AccessCriteria,
  "createdBy": SimpleCriteria,
  "createdAt": DateTimeCriteria,
  "and": [GroupFilterInput],
  "or": [GroupFilterInput],
  "not": GroupFilterInput
}
Types

GroupPageableInput

Fields
Input Field Description
page - Int!
size - Int!
sort - [GroupSort]
Example
{"page": 987, "size": 123, "sort": ["NAME_ASC"]}
Types

GroupPaged

Fields
Field Name Description
items - [Group]!
pageInfo - PaginationInfo!
Example
{
  "items": [Group],
  "pageInfo": PaginationInfo
}
Types

GroupSort

Values
Enum Value Description

NAME_ASC

NAME_DESC

CREATED_AT_ASC

CREATED_AT_DESC

UPDATED_AT_ASC

UPDATED_AT_DESC
Example
"NAME_ASC"
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"4"
Types

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
Types

IntCriteria

Fields
Input Field Description
lt - Int
le - Int
eq - Int
ne - Int
ge - Int
gt - Int
in - [Int]
notIn - [Int]
between - [Int]
notBetween - [Int]
min - IntCriteria
max - IntCriteria
Example
{
  "lt": 123,
  "le": 123,
  "eq": 123,
  "ne": 123,
  "ge": 987,
  "gt": 987,
  "in": [987],
  "notIn": [987],
  "between": [987],
  "notBetween": [123],
  "min": IntCriteria,
  "max": IntCriteria
}
Types

InterpolationType

Values
Enum Value Description

NEAREST

BILINEAR
Example
"NEAREST"
Types

JSON

Example
{}
Types

JsonPropertyInput

Fields
Input Field Description
patch - [JsonPropertyPatchInput!]
merge - JSON
Example
{"patch": [JsonPropertyPatchInput], "merge": {}}
Types

JsonPropertyPatchInput

Fields
Input Field Description
op - JsonPropertyPatchOp!
path - String!
from - String
value - JSON
Example
{
  "op": "add",
  "path": "xyz789",
  "from": "xyz789",
  "value": {}
}
Types

JsonPropertyPatchOp

Values
Enum Value Description

add

remove

replace

move

copy
Example
"add"
Types

Label

Fields
Field Name Description
id - ID!
name - String!
content - String
enabled - Boolean!
access - Access!
viewCount - Int!
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
files - [AssetFile]!
Example
{
  "id": 4,
  "name": "abc123",
  "content": "xyz789",
  "enabled": true,
  "access": "Private",
  "viewCount": 123,
  "createdBy": 4,
  "createdAt": "abc123",
  "updatedBy": "4",
  "updatedAt": "xyz789",
  "files": [AssetFile]
}
Types

LabelFilterInput

Fields
Input Field Description
id - SimpleCriteria
name - StringCriteria
enabled - BooleanCriteria
Example
{
  "id": SimpleCriteria,
  "name": StringCriteria,
  "enabled": BooleanCriteria
}
Types

LabelPageableInput

Fields
Input Field Description
page - Int!
size - Int!
sort - [LabelSort]
Example
{"page": 123, "size": 987, "sort": ["NAME_ASC"]}
Types

LabelPaged

Fields
Field Name Description
items - [Label]!
pageInfo - PaginationInfo!
Example
{
  "items": [Label],
  "pageInfo": PaginationInfo
}
Types

LabelSort

Values
Enum Value Description

NAME_ASC

NAME_DESC
Example
"NAME_ASC"
Types

LayerAssetInfoSource

Fields
Input Field Description
id - ID!
groupId - ID!
Example
{"id": "4", "groupId": 4}
Types

LayerAssetInfoTarget

Fields
Input Field Description
id - ID
groupId - ID!
Example
{"id": 4, "groupId": 4}
Types

LocateAssetInput

Fields
Input Field Description
source - LayerAssetInfoSource!
target - LayerAssetInfoTarget!
option - LocateOption
Example
{
  "source": LayerAssetInfoSource,
  "target": LayerAssetInfoTarget,
  "option": "BEFORE"
}
Types

LocateGroupInput

Fields
Input Field Description
target - ID!
option - LocateOption!
Example
{"target": "4", "option": "BEFORE"}
Types

LocateOption

Values
Enum Value Description

BEFORE

AFTER

FIRST_CHILD

LAST_CHILD
Example
"BEFORE"
Types

PaginationInfo

Fields
Field Name Description
totalPages - Int!
totalItems - Int!
page - Int!
size - Int!
hasNextPage - Boolean!
hasPreviousPage - Boolean!
Example
{
  "totalPages": 987,
  "totalItems": 987,
  "page": 123,
  "size": 987,
  "hasNextPage": false,
  "hasPreviousPage": true
}
Types

Process

Fields
Field Name Description
id - ID!
name - String
context - JSON
status - ProcessTaskStatus
tasks - [ProcessTask]
createdBy - ID!
createdByUser - User!
createdAt - String
updatedBy - ID!
updatedByUser - User!
updatedAt - String
properties - JSON
Example
{
  "id": "4",
  "name": "xyz789",
  "context": {},
  "status": "None",
  "tasks": [ProcessTask],
  "createdBy": 4,
  "createdByUser": User,
  "createdAt": "abc123",
  "updatedBy": 4,
  "updatedByUser": User,
  "updatedAt": "abc123",
  "properties": {}
}
Types

ProcessContextInput

Fields
Input Field Description
t3d - T3DConvertInput
f4d - F4DConvertInput
smartTile - SmartTileConvertInput
cog - CogConvertInput
ogr2ogr - ShpConvertInput
warp - TiffConvertInput
terrain - TerrainConvertInput
Example
{
  "t3d": T3DConvertInput,
  "f4d": F4DConvertInput,
  "smartTile": SmartTileConvertInput,
  "cog": CogConvertInput,
  "ogr2ogr": ShpConvertInput,
  "warp": TiffConvertInput,
  "terrain": TerrainConvertInput
}
Types

ProcessFilterInput

Fields
Input Field Description
id - SimpleCriteria
assetId - SimpleCriteria
name - StringCriteria
description - StringCriteria
enabled - BooleanCriteria
and - [ProcessFilterInput!]
or - [ProcessFilterInput!]
not - ProcessFilterInput
Example
{
  "id": SimpleCriteria,
  "assetId": SimpleCriteria,
  "name": StringCriteria,
  "description": StringCriteria,
  "enabled": BooleanCriteria,
  "and": [ProcessFilterInput],
  "or": [ProcessFilterInput],
  "not": ProcessFilterInput
}
Types

ProcessPageableInput

Fields
Input Field Description
page - Int!
size - Int!
sort - [ProcessSort]
Example
{"page": 987, "size": 987, "sort": ["CREATED_AT_ASC"]}
Types

ProcessPaged

Fields
Field Name Description
items - [Process]!
pageInfo - PaginationInfo!
Example
{
  "items": [Process],
  "pageInfo": PaginationInfo
}
Types

ProcessSort

Values
Enum Value Description

CREATED_AT_ASC

CREATED_AT_DESC
Example
"CREATED_AT_ASC"
Types

ProcessSourceInput

Fields
Input Field Description
assetId - [ID]!
Example
{"assetId": ["4"]}
Types

ProcessTask

Fields
Field Name Description
id - ID!
status - ProcessTaskStatus
error - String
stacktrace - String
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": "4",
  "status": "None",
  "error": "xyz789",
  "stacktrace": "xyz789",
  "createdBy": 4,
  "createdAt": "abc123",
  "updatedBy": "4",
  "updatedAt": "xyz789"
}
Types

ProcessTaskF4DUpAxis

Values
Enum Value Description

Y

Z
Example
"Y"
Types

ProcessTaskStatus

Values
Enum Value Description

None

Ready

Running

Terminating

Terminated

Done

Error
Example
"None"
Types

ProcessTaskStatusCriteria

Fields
Input Field Description
eq - ProcessTaskStatus
ne - ProcessTaskStatus
in - [ProcessTaskStatus]
notIn - [ProcessTaskStatus]
isNull - Boolean
Example
{"eq": "None", "ne": "None", "in": ["None"], "notIn": ["None"], "isNull": false}
Types

ShpConvertInput

Fields
Input Field Description
sourceCharset - String!
targetCharset - String!
sourceSrs - String!
targetSrs - String!
layerType - String!
output - ShpConvertOutputInput
Example
{
  "sourceCharset": "abc123",
  "targetCharset": "abc123",
  "sourceSrs": "abc123",
  "targetSrs": "xyz789",
  "layerType": "abc123",
  "output": ShpConvertOutputInput
}
Types

ShpConvertOutputInput

Fields
Input Field Description
pgsql - ShpOutputPgsql
test - ShpOutputPgsqlTest
Example
{
  "pgsql": ShpOutputPgsql,
  "test": ShpOutputPgsqlTest
}
Types

ShpOutputPgsql

Fields
Input Field Description
host - String!
port - Int
schema - String
database - String!
username - String!
password - String!
Example
{
  "host": "xyz789",
  "port": 987,
  "schema": "abc123",
  "database": "xyz789",
  "username": "xyz789",
  "password": "xyz789"
}
Types

ShpOutputPgsqlTest

Fields
Input Field Description
host - String
port - Int
schema - String
database - String
username - String
password - String
Example
{
  "host": "xyz789",
  "port": 123,
  "schema": "abc123",
  "database": "xyz789",
  "username": "abc123",
  "password": "xyz789"
}
Types

SimpleCriteria

Fields
Input Field Description
eq - ID
ne - ID
in - [ID]
notIn - [ID]
isNull - Boolean
Example
{
  "eq": "4",
  "ne": 4,
  "in": [4],
  "notIn": ["4"],
  "isNull": false
}
Types

SimpleTagCommandInput

Fields
Input Field Description
create - [SimpleTagCreateInput]
update - [SimpleTagUpdateInput]
delete - [SimpleTagDeleteInput]
Example
{
  "create": [SimpleTagCreateInput],
  "update": [SimpleTagUpdateInput],
  "delete": [SimpleTagDeleteInput]
}
Types

SimpleTagCreateInput

Fields
Input Field Description
name - String!
value - String!
Example
{
  "name": "abc123",
  "value": "abc123"
}
Types

SimpleTagDeleteInput

Fields
Input Field Description
id - ID!
Example
{"id": "4"}
Types

SimpleTagUpdateInput

Fields
Input Field Description
id - ID!
name - String
value - String
Example
{
  "id": 4,
  "name": "xyz789",
  "value": "xyz789"
}
Types

SimpleTagValue

Fields
Field Name Description
id - ID!
name - String
value - String
Example
{
  "id": "4",
  "name": "abc123",
  "value": "xyz789"
}
Types

SmartTileConvertInput

Fields
Input Field Description
name - String
charset - String!
Example
{
  "name": "xyz789",
  "charset": "abc123"
}
Types

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
"abc123"
Types

StringCriteria

Fields
Input Field Description
lt - String
le - String
eq - String
ne - String
ge - String
gt - String
isNull - Boolean
in - [String]
notIn - [String]
between - [String]
notBetween - [String]
min - StringCriteria
max - StringCriteria
eqIgnoreCase - String
contains - String
containsIgnoreCase - String
startsWith - String
startsWithIgnoreCase - String
endsWith - String
endsWithIgnoreCase - String
isEmpty - Boolean
matches - String
Example
{
  "lt": "abc123",
  "le": "abc123",
  "eq": "abc123",
  "ne": "abc123",
  "ge": "xyz789",
  "gt": "xyz789",
  "isNull": true,
  "in": ["xyz789"],
  "notIn": ["xyz789"],
  "between": ["abc123"],
  "notBetween": ["abc123"],
  "min": StringCriteria,
  "max": StringCriteria,
  "eqIgnoreCase": "abc123",
  "contains": "abc123",
  "containsIgnoreCase": "xyz789",
  "startsWith": "xyz789",
  "startsWithIgnoreCase": "abc123",
  "endsWith": "xyz789",
  "endsWithIgnoreCase": "abc123",
  "isEmpty": false,
  "matches": "abc123"
}
Types

T3DConvertInput

Fields
Input Field Description
inputType - T3DFormatType!
crs - String
proj - String
quiet - Boolean!
recursive - Boolean!
reverseTexCoord - Boolean
pngTexture - Boolean
yUpAxis - Boolean
refineAdd - Boolean
maxCount - Int
maxLod - Int
minLod - Int
maxPoints - Int
flipCoordinate - Boolean
nameColumn - String
heightColumn - String
altitudeColumn - String
minimumHeight - Float
absoluteAltitude - Boolean
zeroOrigin - Boolean
autoUpAxis - Boolean
Example
{
  "inputType": "FBX",
  "crs": "abc123",
  "proj": "xyz789",
  "quiet": false,
  "recursive": true,
  "reverseTexCoord": false,
  "pngTexture": true,
  "yUpAxis": false,
  "refineAdd": true,
  "maxCount": 123,
  "maxLod": 123,
  "minLod": 987,
  "maxPoints": 987,
  "flipCoordinate": false,
  "nameColumn": "abc123",
  "heightColumn": "abc123",
  "altitudeColumn": "xyz789",
  "minimumHeight": 987.65,
  "absoluteAltitude": false,
  "zeroOrigin": true,
  "autoUpAxis": true
}
Types

T3DFormatType

Values
Enum Value Description

FBX

GLTF

GLB

KML

COLLADA

MAX_3DS

MAX_ASE

OBJ

IFC

CITY_GML

INDOOR_GML

MODO

LWO

LWS

DirectX

SHP

GEOJSON

JSON

LAS

LAZ

B3DM

I3DM

PNTS

TEMP
Example
"FBX"
Types

TerrainConvertInput

Fields
Input Field Description
calculateNormals - Boolean
debug - Boolean
help - Boolean
interpolationType - InterpolationType
minDepth - Int!
maxDepth - Int!
strength - Int
Example
{
  "calculateNormals": false,
  "debug": false,
  "help": false,
  "interpolationType": "NEAREST",
  "minDepth": 987,
  "maxDepth": 987,
  "strength": 123
}
Types

TiffConvertInput

Fields
Input Field Description
sourceSrs - String!
targetSrs - String!
ot - Type
Example
{
  "sourceSrs": "abc123",
  "targetSrs": "xyz789",
  "ot": "Byte"
}
Types

Time

Example
"10:15:30Z"
Types

TimeCriteria

Fields
Input Field Description
lt - Time
le - Time
eq - Time
ne - Time
ge - Time
gt - Time
in - [Time]
notIn - [Time]
between - [Time]
notBetween - [Time]
min - TimeCriteria
max - TimeCriteria
Example
{
  "lt": "10:15:30Z",
  "le": "10:15:30Z",
  "eq": "10:15:30Z",
  "ne": "10:15:30Z",
  "ge": "10:15:30Z",
  "gt": "10:15:30Z",
  "in": ["10:15:30Z"],
  "notIn": ["10:15:30Z"],
  "between": ["10:15:30Z"],
  "notBetween": ["10:15:30Z"],
  "min": TimeCriteria,
  "max": TimeCriteria
}
Types

Type

Values
Enum Value Description

Byte

Int8

UInt16

Int16

UInt32

Int32

UInt64

Int64

Float32

Float64

CInt16

CInt32

CFloat32

CFloat64
Example
"Byte"
Types

UpdateAssetInput

Fields
Input Field Description
name - String
description - String
assetType - AssetType
enabled - Boolean
access - Access
status - ProcessTaskStatus
groupId - [ID]
uploadId - [ID!]
flags - [DataAssetFlag]
tags - SimpleTagCommandInput
properties - JsonPropertyInput
Example
{
  "name": "abc123",
  "description": "abc123",
  "assetType": "Tiles3D",
  "enabled": true,
  "access": "Private",
  "status": "None",
  "groupId": ["4"],
  "uploadId": ["4"],
  "flags": ["VECTOR"],
  "tags": SimpleTagCommandInput,
  "properties": JsonPropertyInput
}
Types

UpdateAssetResponse

Fields
Field Name Description
id - ID!
name - String!
description - String
assetType - AssetType!
enabled - Boolean!
access - Access!
groups - [Group]
files - [AssetFile]!
flags - [DataAssetFlag]
properties - JSON
tags - [SimpleTagValue]!
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": 4,
  "name": "abc123",
  "description": "abc123",
  "assetType": "Tiles3D",
  "enabled": false,
  "access": "Private",
  "groups": [Group],
  "files": [AssetFile],
  "flags": ["VECTOR"],
  "properties": {},
  "tags": [SimpleTagValue],
  "createdBy": "4",
  "createdAt": "abc123",
  "updatedBy": 4,
  "updatedAt": "xyz789"
}
Types

UpdateGroupInput

Fields
Input Field Description
parentId - ID
name - String
description - String
enabled - Boolean
access - Access
flags - [DataGroupFlag]
tags - SimpleTagCommandInput
properties - JsonPropertyInput
Example
{
  "parentId": 4,
  "name": "abc123",
  "description": "xyz789",
  "enabled": false,
  "access": "Private",
  "flags": ["BASEMAP"],
  "tags": SimpleTagCommandInput,
  "properties": JsonPropertyInput
}
Types

UpdateGroupResponse

Fields
Field Name Description
id - ID!
parentId - ID
name - String!
description - String
enabled - Boolean!
access - Access!
viewCount - Int!
createdBy - ID!
createdAt - String
updatedBy - ID!
updatedAt - String
flags - [DataGroupFlag]
tags - [SimpleTagValue]
properties - JSON
Example
{
  "id": 4,
  "parentId": 4,
  "name": "xyz789",
  "description": "xyz789",
  "enabled": false,
  "access": "Private",
  "viewCount": 987,
  "createdBy": "4",
  "createdAt": "abc123",
  "updatedBy": "4",
  "updatedAt": "abc123",
  "flags": ["BASEMAP"],
  "tags": [SimpleTagValue],
  "properties": {}
}
Types

UpdateLabelInput

Fields
Input Field Description
id - ID!
name - String
description - String
assetType - AssetType
enabled - Boolean
access - Access
tags - SimpleTagCommandInput
properties - JsonPropertyInput
Example
{
  "id": 4,
  "name": "xyz789",
  "description": "abc123",
  "assetType": "Tiles3D",
  "enabled": false,
  "access": "Private",
  "tags": SimpleTagCommandInput,
  "properties": JsonPropertyInput
}
Types

UpdateLabelResponse

Fields
Field Name Description
id - ID!
name - String!
description - String
assetType - AssetType!
enabled - Boolean!
access - Access!
files - [AssetFile]!
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
properties - JSON
tags - [SimpleTagValue]!
Example
{
  "id": 4,
  "name": "xyz789",
  "description": "xyz789",
  "assetType": "Tiles3D",
  "enabled": false,
  "access": "Private",
  "files": [AssetFile],
  "createdBy": "4",
  "createdAt": "xyz789",
  "updatedBy": 4,
  "updatedAt": "xyz789",
  "properties": {},
  "tags": [SimpleTagValue]
}
Types

UpdateProcessInput

Fields
Input Field Description
id - ID
name - String
context - ProcessContextInput
source - ProcessSourceInput
properties - JsonPropertyInput
Example
{
  "id": "4",
  "name": "abc123",
  "context": ProcessContextInput,
  "source": ProcessSourceInput,
  "properties": JsonPropertyInput
}
Types

UpdateProcessResponse

Fields
Field Name Description
id - ID!
name - String
status - ProcessTaskStatus
properties - JSON
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": "4",
  "name": "abc123",
  "status": "None",
  "properties": {},
  "createdBy": "4",
  "createdAt": "xyz789",
  "updatedBy": "4",
  "updatedAt": "xyz789"
}
Types

UploadFile

Fields
Field Name Description
id - ID!
filename - String!
contentSize - Int!
contentType - String!
download - String!
createdBy - ID!
createdByUser - User!
createdAt - String
updatedBy - ID!
updatedByUser - User!
updatedAt - String
properties - JSON
Example
{
  "id": 4,
  "filename": "xyz789",
  "contentSize": 123,
  "contentType": "xyz789",
  "download": "abc123",
  "createdBy": "4",
  "createdByUser": User,
  "createdAt": "xyz789",
  "updatedBy": 4,
  "updatedByUser": User,
  "updatedAt": "abc123",
  "properties": {}
}
Types

UploadFileFilterInput

Fields
Input Field Description
id - SimpleCriteria
filename - StringCriteria
createdAt - DateTimeCriteria
createdBy - SimpleCriteria
and - [UploadFileFilterInput]
or - [UploadFileFilterInput]
not - UploadFileFilterInput
Example
{
  "id": SimpleCriteria,
  "filename": StringCriteria,
  "createdAt": DateTimeCriteria,
  "createdBy": SimpleCriteria,
  "and": [UploadFileFilterInput],
  "or": [UploadFileFilterInput],
  "not": UploadFileFilterInput
}
Types

UploadFilePageableInput

Fields
Input Field Description
page - Int!
size - Int!
sort - [UploadFileSort]
Example
{"page": 987, "size": 987, "sort": ["NAME_ASC"]}
Types

UploadFilePaged

Fields
Field Name Description
items - [UploadFile]!
pageInfo - PaginationInfo!
Example
{
  "items": [UploadFile],
  "pageInfo": PaginationInfo
}
Types

UploadFileSort

Values
Enum Value Description

NAME_ASC

NAME_DESC

CREATED_AT_ASC

CREATED_AT_DESC
Example
"NAME_ASC"
Types

User

Fields
Field Name Description
id - ID!
username - String
firstname - String
lastname - String
email - String
emailVerified - Boolean
enabled - Boolean!
attributes - JSON
createdAt - String
Example
{
  "id": 4,
  "username": "xyz789",
  "firstname": "abc123",
  "lastname": "xyz789",
  "email": "abc123",
  "emailVerified": true,
  "enabled": false,
  "attributes": {},
  "createdAt": "xyz789"
}
Documentation by Anvil SpectaQL