mago3D GraphQL API Layerset 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/layerset/graphql
Headers
# Your foo from bar
Authorization: Bearer <YOUR_TOKEN_HERE>

Introduction

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

Queries

asset

Response

Returns a LayerAsset!

Arguments
Name Description
id - ID!

Example

Query
query asset($id: ID!) {
  asset(id: $id) {
    id
    name
    description
    type
    enabled
    visible
    access
    status
    order
    groups {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    styles {
      id
      name
      format
      description
      enabled
      defaultStatus
      access
      context
    }
    logs {
      id
      assetId
      type
      content
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
    properties
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "asset": {
      "id": "4",
      "name": "abc123",
      "description": "abc123",
      "type": "LAYERGROUP",
      "enabled": false,
      "visible": false,
      "access": "Default",
      "status": "INIT",
      "order": 123,
      "groups": [LayerGroup],
      "styles": [LayerStyle],
      "logs": [LayerAssetLog],
      "createdBy": "4",
      "createdAt": "xyz789",
      "updatedBy": "4",
      "updatedAt": "xyz789",
      "properties": {}
    }
  }
}
Queries

assets

Response

Returns [LayerAsset]!

Arguments
Name Description
filter - AssetFilterInput

Example

Query
query assets($filter: AssetFilterInput) {
  assets(filter: $filter) {
    id
    name
    description
    type
    enabled
    visible
    access
    status
    order
    groups {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    styles {
      id
      name
      format
      description
      enabled
      defaultStatus
      access
      context
    }
    logs {
      id
      assetId
      type
      content
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
    properties
  }
}
Variables
{"filter": AssetFilterInput}
Response
{
  "data": {
    "assets": [
      {
        "id": "4",
        "name": "abc123",
        "description": "xyz789",
        "type": "LAYERGROUP",
        "enabled": true,
        "visible": true,
        "access": "Default",
        "status": "INIT",
        "order": 123,
        "groups": [LayerGroup],
        "styles": [LayerStyle],
        "logs": [LayerAssetLog],
        "createdBy": "4",
        "createdAt": "abc123",
        "updatedBy": "4",
        "updatedAt": "xyz789",
        "properties": {}
      }
    ]
  }
}
Queries

classifyAttribute

Response

Returns a ClassifiedAttribute!

Arguments
Name Description
nativeName - String!
attribute - String!

Example

Query
query classifyAttribute(
  $nativeName: String!,
  $attribute: String!
) {
  classifyAttribute(
    nativeName: $nativeName,
    attribute: $attribute
  ) {
    type
    rules {
      min
      max
      eq
      color
    }
  }
}
Variables
{
  "nativeName": "abc123",
  "attribute": "xyz789"
}
Response
{
  "data": {
    "classifyAttribute": {
      "type": "STRING",
      "rules": [Rule]
    }
  }
}
Queries

group

Response

Returns a LayerGroup!

Arguments
Name Description
id - ID!

Example

Query
query group($id: ID!) {
  group(id: $id) {
    id
    parent {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    children {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    name
    description
    order
    enabled
    published
    collapsed
    access
    assets {
      id
      name
      description
      type
      enabled
      visible
      access
      status
      order
      groups {
        ...LayerGroupFragment
      }
      styles {
        ...LayerStyleFragment
      }
      logs {
        ...LayerAssetLogFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
      properties
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "group": {
      "id": 4,
      "parent": LayerGroup,
      "children": [LayerGroup],
      "name": "abc123",
      "description": "abc123",
      "order": 123,
      "enabled": false,
      "published": true,
      "collapsed": false,
      "access": "Default",
      "assets": [LayerAsset],
      "createdBy": "4",
      "createdAt": "abc123",
      "updatedBy": 4,
      "updatedAt": "xyz789"
    }
  }
}
Queries

groups

Response

Returns [LayerGroup]!

Arguments
Name Description
filter - GroupFilterInput

Example

Query
query groups($filter: GroupFilterInput) {
  groups(filter: $filter) {
    id
    parent {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    children {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    name
    description
    order
    enabled
    published
    collapsed
    access
    assets {
      id
      name
      description
      type
      enabled
      visible
      access
      status
      order
      groups {
        ...LayerGroupFragment
      }
      styles {
        ...LayerStyleFragment
      }
      logs {
        ...LayerAssetLogFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
      properties
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"filter": GroupFilterInput}
Response
{
  "data": {
    "groups": [
      {
        "id": 4,
        "parent": LayerGroup,
        "children": [LayerGroup],
        "name": "abc123",
        "description": "xyz789",
        "order": 123,
        "enabled": false,
        "published": false,
        "collapsed": true,
        "access": "Default",
        "assets": [LayerAsset],
        "createdBy": 4,
        "createdAt": "abc123",
        "updatedBy": 4,
        "updatedAt": "abc123"
      }
    ]
  }
}
Queries

label

Response

Returns a LayerLabel!

Arguments
Name Description
id - ID!

Example

Query
query label($id: ID!) {
  label(id: $id) {
    id
    name
    description
    value
    enabled
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "label": {
      "id": 4,
      "name": "abc123",
      "description": "xyz789",
      "value": "xyz789",
      "enabled": false
    }
  }
}
Queries

remote

Response

Returns a JSON

Arguments
Name Description
href - String!

Example

Query
query remote($href: String!) {
  remote(href: $href)
}
Variables
{"href": "abc123"}
Response
{"data": {"remote": {}}}
Queries

remoteAssets

Response

Returns [RemoteLayerAsset]!

Example

Query
query remoteAssets {
  remoteAssets {
    name
    href
  }
}
Response
{
  "data": {
    "remoteAssets": [
      {
        "name": "abc123",
        "href": "xyz789"
      }
    ]
  }
}
Queries

remoteStyles

Response

Returns [RemoteLayerStyle]!

Arguments
Name Description
filter - RemoteStyleFilterInput

Example

Query
query remoteStyles($filter: RemoteStyleFilterInput) {
  remoteStyles(filter: $filter) {
    name
    href
    type
  }
}
Variables
{"filter": RemoteStyleFilterInput}
Response
{
  "data": {
    "remoteStyles": [
      {
        "name": "abc123",
        "href": "abc123",
        "type": "POINT"
      }
    ]
  }
}
Queries

style

Response

Returns a LayerStyle!

Arguments
Name Description
id - ID!

Example

Query
query style($id: ID!) {
  style(id: $id) {
    id
    name
    format
    description
    enabled
    defaultStatus
    access
    context
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "style": {
      "id": "4",
      "name": "xyz789",
      "format": "JSON",
      "description": "xyz789",
      "enabled": false,
      "defaultStatus": false,
      "access": "Default",
      "context": {}
    }
  }
}
Queries

terrains

Response

Returns [TerrainAsset]!

Example

Query
query terrains {
  terrains {
    id
    name
    selected
    properties
  }
}
Response
{
  "data": {
    "terrains": [
      {
        "id": "4",
        "name": "abc123",
        "selected": true,
        "properties": {}
      }
    ]
  }
}
Queries

userAsset

Response

Returns a UserLayerAsset!

Arguments
Name Description
id - ID!

Example

Query
query userAsset($id: ID!) {
  userAsset(id: $id) {
    id
    assetId
    name
    description
    type
    enabled
    visible
    access
    order
    logs {
      id
      assetId
      type
      content
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
    properties
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "userAsset": {
      "id": 4,
      "assetId": 4,
      "name": "abc123",
      "description": "xyz789",
      "type": "LAYERGROUP",
      "enabled": false,
      "visible": false,
      "access": "Default",
      "order": 123,
      "logs": [LayerAssetLog],
      "createdBy": "4",
      "createdAt": "abc123",
      "updatedBy": "4",
      "updatedAt": "abc123",
      "properties": {}
    }
  }
}
Queries

userAssets

Response

Returns [UserLayerAsset]!

Arguments
Name Description
filter - UserAssetFilterInput

Example

Query
query userAssets($filter: UserAssetFilterInput) {
  userAssets(filter: $filter) {
    id
    assetId
    name
    description
    type
    enabled
    visible
    access
    order
    logs {
      id
      assetId
      type
      content
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
    properties
  }
}
Variables
{"filter": UserAssetFilterInput}
Response
{
  "data": {
    "userAssets": [
      {
        "id": 4,
        "assetId": 4,
        "name": "abc123",
        "description": "abc123",
        "type": "LAYERGROUP",
        "enabled": false,
        "visible": false,
        "access": "Default",
        "order": 123,
        "logs": [LayerAssetLog],
        "createdBy": "4",
        "createdAt": "xyz789",
        "updatedBy": "4",
        "updatedAt": "abc123",
        "properties": {}
      }
    ]
  }
}
Queries

userGroup

Response

Returns a UserLayerGroup!

Arguments
Name Description
id - ID!

Example

Query
query userGroup($id: ID!) {
  userGroup(id: $id) {
    id
    groupId
    parent {
      id
      groupId
      parent {
        ...UserLayerGroupFragment
      }
      children {
        ...UserLayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...UserLayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    children {
      id
      groupId
      parent {
        ...UserLayerGroupFragment
      }
      children {
        ...UserLayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...UserLayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    name
    description
    order
    enabled
    published
    collapsed
    access
    assets {
      id
      assetId
      name
      description
      type
      enabled
      visible
      access
      order
      logs {
        ...LayerAssetLogFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
      properties
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "userGroup": {
      "id": 4,
      "groupId": 4,
      "parent": UserLayerGroup,
      "children": [UserLayerGroup],
      "name": "xyz789",
      "description": "abc123",
      "order": 987,
      "enabled": false,
      "published": true,
      "collapsed": false,
      "access": "Default",
      "assets": [UserLayerAsset],
      "createdBy": 4,
      "createdAt": "abc123",
      "updatedBy": "4",
      "updatedAt": "abc123"
    }
  }
}
Queries

userGroups

Response

Returns [UserLayerGroup]!

Arguments
Name Description
filter - UserGroupFilterInput

Example

Query
query userGroups($filter: UserGroupFilterInput) {
  userGroups(filter: $filter) {
    id
    groupId
    parent {
      id
      groupId
      parent {
        ...UserLayerGroupFragment
      }
      children {
        ...UserLayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...UserLayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    children {
      id
      groupId
      parent {
        ...UserLayerGroupFragment
      }
      children {
        ...UserLayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...UserLayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    name
    description
    order
    enabled
    published
    collapsed
    access
    assets {
      id
      assetId
      name
      description
      type
      enabled
      visible
      access
      order
      logs {
        ...LayerAssetLogFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
      properties
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"filter": UserGroupFilterInput}
Response
{
  "data": {
    "userGroups": [
      {
        "id": "4",
        "groupId": "4",
        "parent": UserLayerGroup,
        "children": [UserLayerGroup],
        "name": "abc123",
        "description": "abc123",
        "order": 123,
        "enabled": false,
        "published": true,
        "collapsed": false,
        "access": "Default",
        "assets": [UserLayerAsset],
        "createdBy": "4",
        "createdAt": "xyz789",
        "updatedBy": 4,
        "updatedAt": "abc123"
      }
    ]
  }
}

Mutations

applyAssetRemoteStyle

Response

Returns a Boolean!

Arguments
Name Description
id - ID!
styleName - String!

Example

Query
mutation applyAssetRemoteStyle(
  $id: ID!,
  $styleName: String!
) {
  applyAssetRemoteStyle(
    id: $id,
    styleName: $styleName
  )
}
Variables
{"id": 4, "styleName": "xyz789"}
Response
{"data": {"applyAssetRemoteStyle": false}}
Mutations

applyAssetStyle

Response

Returns a LayerAsset!

Arguments
Name Description
id - ID!
styleId - ID!

Example

Query
mutation applyAssetStyle(
  $id: ID!,
  $styleId: ID!
) {
  applyAssetStyle(
    id: $id,
    styleId: $styleId
  ) {
    id
    name
    description
    type
    enabled
    visible
    access
    status
    order
    groups {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    styles {
      id
      name
      format
      description
      enabled
      defaultStatus
      access
      context
    }
    logs {
      id
      assetId
      type
      content
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
    properties
  }
}
Variables
{"id": "4", "styleId": 4}
Response
{
  "data": {
    "applyAssetStyle": {
      "id": 4,
      "name": "abc123",
      "description": "abc123",
      "type": "LAYERGROUP",
      "enabled": false,
      "visible": true,
      "access": "Default",
      "status": "INIT",
      "order": 123,
      "groups": [LayerGroup],
      "styles": [LayerStyle],
      "logs": [LayerAssetLog],
      "createdBy": 4,
      "createdAt": "xyz789",
      "updatedBy": 4,
      "updatedAt": "xyz789",
      "properties": {}
    }
  }
}
Mutations

createAsset

Response

Returns a CreateAssetResponse!

Arguments
Name Description
input - CreateAssetInput!

Example

Query
mutation createAsset($input: CreateAssetInput!) {
  createAsset(input: $input) {
    id
    name
    description
    type
    enabled
    visible
    access
    status
    createdBy
    createdAt
    updatedBy
    updatedAt
    properties
  }
}
Variables
{"input": CreateAssetInput}
Response
{
  "data": {
    "createAsset": {
      "id": "4",
      "name": "xyz789",
      "description": "xyz789",
      "type": "LAYERGROUP",
      "enabled": true,
      "visible": false,
      "access": "Default",
      "status": "INIT",
      "createdBy": "4",
      "createdAt": "xyz789",
      "updatedBy": "4",
      "updatedAt": "xyz789",
      "properties": {}
    }
  }
}
Mutations

createGroup

Response

Returns a CreateGroupResponse!

Arguments
Name Description
input - CreateGroupInput!

Example

Query
mutation createGroup($input: CreateGroupInput!) {
  createGroup(input: $input) {
    id
    parent {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    children {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    name
    description
    enabled
    published
    collapsed
    access
    order
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"input": CreateGroupInput}
Response
{
  "data": {
    "createGroup": {
      "id": "4",
      "parent": LayerGroup,
      "children": [LayerGroup],
      "name": "abc123",
      "description": "abc123",
      "enabled": true,
      "published": false,
      "collapsed": false,
      "access": "Default",
      "order": 123,
      "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
    value
    enabled
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"input": CreateLabelInput}
Response
{
  "data": {
    "createLabel": {
      "id": "4",
      "name": "abc123",
      "description": "xyz789",
      "value": "xyz789",
      "enabled": false,
      "createdBy": 4,
      "createdAt": "xyz789",
      "updatedBy": 4,
      "updatedAt": "abc123"
    }
  }
}
Mutations

createStyle

Response

Returns a CreateStyleResponse!

Arguments
Name Description
input - CreateStyleInput!

Example

Query
mutation createStyle($input: CreateStyleInput!) {
  createStyle(input: $input) {
    id
    name
    format
    description
    enabled
    defaultStatus
    access
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"input": CreateStyleInput}
Response
{
  "data": {
    "createStyle": {
      "id": 4,
      "name": "xyz789",
      "format": "JSON",
      "description": "xyz789",
      "enabled": true,
      "defaultStatus": false,
      "access": "Default",
      "createdBy": 4,
      "createdAt": "xyz789",
      "updatedBy": 4,
      "updatedAt": "abc123"
    }
  }
}
Mutations

deleteAsset

Response

Returns a Boolean!

Arguments
Name Description
ids - [ID!]!

Example

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

deleteGroup

Response

Returns a Boolean!

Arguments
Name Description
ids - [ID!]!

Example

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

deleteLabel

Response

Returns a Boolean!

Arguments
Name Description
ids - [ID!]!

Example

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

deleteStyle

Response

Returns a Boolean!

Arguments
Name Description
ids - [ID!]!

Example

Query
mutation deleteStyle($ids: [ID!]!) {
  deleteStyle(ids: $ids)
}
Variables
{"ids": [4]}
Response
{"data": {"deleteStyle": false}}
Mutations

locateAsset

Response

Returns a LayerAsset!

Arguments
Name Description
input - LocateAssetInput!

Example

Query
mutation locateAsset($input: LocateAssetInput!) {
  locateAsset(input: $input) {
    id
    name
    description
    type
    enabled
    visible
    access
    status
    order
    groups {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    styles {
      id
      name
      format
      description
      enabled
      defaultStatus
      access
      context
    }
    logs {
      id
      assetId
      type
      content
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
    properties
  }
}
Variables
{"input": LocateAssetInput}
Response
{
  "data": {
    "locateAsset": {
      "id": 4,
      "name": "abc123",
      "description": "xyz789",
      "type": "LAYERGROUP",
      "enabled": true,
      "visible": false,
      "access": "Default",
      "status": "INIT",
      "order": 123,
      "groups": [LayerGroup],
      "styles": [LayerStyle],
      "logs": [LayerAssetLog],
      "createdBy": 4,
      "createdAt": "abc123",
      "updatedBy": "4",
      "updatedAt": "xyz789",
      "properties": {}
    }
  }
}
Mutations

locateGroup

Response

Returns a LayerGroup!

Arguments
Name Description
id - ID!
input - LocateGroupInput!

Example

Query
mutation locateGroup(
  $id: ID!,
  $input: LocateGroupInput!
) {
  locateGroup(
    id: $id,
    input: $input
  ) {
    id
    parent {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    children {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    name
    description
    order
    enabled
    published
    collapsed
    access
    assets {
      id
      name
      description
      type
      enabled
      visible
      access
      status
      order
      groups {
        ...LayerGroupFragment
      }
      styles {
        ...LayerStyleFragment
      }
      logs {
        ...LayerAssetLogFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
      properties
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{
  "id": "4",
  "input": LocateGroupInput
}
Response
{
  "data": {
    "locateGroup": {
      "id": 4,
      "parent": LayerGroup,
      "children": [LayerGroup],
      "name": "xyz789",
      "description": "abc123",
      "order": 123,
      "enabled": true,
      "published": true,
      "collapsed": true,
      "access": "Default",
      "assets": [LayerAsset],
      "createdBy": 4,
      "createdAt": "abc123",
      "updatedBy": 4,
      "updatedAt": "abc123"
    }
  }
}
Mutations

reloadRemoteAsset

Response

Returns a Boolean!

Arguments
Name Description
layerKey - String!

Example

Query
mutation reloadRemoteAsset($layerKey: String!) {
  reloadRemoteAsset(layerKey: $layerKey)
}
Variables
{"layerKey": "abc123"}
Response
{"data": {"reloadRemoteAsset": false}}
Mutations

saveUserLayer

Response

Returns [UserLayerGroup]!

Arguments
Name Description
input - [CreateUserGroupInput]

Example

Query
mutation saveUserLayer($input: [CreateUserGroupInput]) {
  saveUserLayer(input: $input) {
    id
    groupId
    parent {
      id
      groupId
      parent {
        ...UserLayerGroupFragment
      }
      children {
        ...UserLayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...UserLayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    children {
      id
      groupId
      parent {
        ...UserLayerGroupFragment
      }
      children {
        ...UserLayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...UserLayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    name
    description
    order
    enabled
    published
    collapsed
    access
    assets {
      id
      assetId
      name
      description
      type
      enabled
      visible
      access
      order
      logs {
        ...LayerAssetLogFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
      properties
    }
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"input": [CreateUserGroupInput]}
Response
{
  "data": {
    "saveUserLayer": [
      {
        "id": 4,
        "groupId": "4",
        "parent": UserLayerGroup,
        "children": [UserLayerGroup],
        "name": "xyz789",
        "description": "xyz789",
        "order": 987,
        "enabled": false,
        "published": false,
        "collapsed": true,
        "access": "Default",
        "assets": [UserLayerAsset],
        "createdBy": 4,
        "createdAt": "xyz789",
        "updatedBy": "4",
        "updatedAt": "abc123"
      }
    ]
  }
}
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
    order
    type
    enabled
    visible
    access
    status
    createdBy
    createdAt
    updatedBy
    updatedAt
    properties
  }
}
Variables
{
  "id": "4",
  "input": UpdateAssetInput
}
Response
{
  "data": {
    "updateAsset": {
      "id": 4,
      "name": "abc123",
      "description": "xyz789",
      "order": 123,
      "type": "LAYERGROUP",
      "enabled": false,
      "visible": false,
      "access": "Default",
      "status": "INIT",
      "createdBy": 4,
      "createdAt": "abc123",
      "updatedBy": 4,
      "updatedAt": "abc123",
      "properties": {}
    }
  }
}
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
    parent {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    children {
      id
      parent {
        ...LayerGroupFragment
      }
      children {
        ...LayerGroupFragment
      }
      name
      description
      order
      enabled
      published
      collapsed
      access
      assets {
        ...LayerAssetFragment
      }
      createdBy
      createdAt
      updatedBy
      updatedAt
    }
    name
    description
    enabled
    published
    collapsed
    access
    order
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{"id": 4, "input": UpdateGroupInput}
Response
{
  "data": {
    "updateGroup": {
      "id": 4,
      "parent": LayerGroup,
      "children": [LayerGroup],
      "name": "xyz789",
      "description": "abc123",
      "enabled": false,
      "published": true,
      "collapsed": false,
      "access": "Default",
      "order": 987,
      "createdBy": "4",
      "createdAt": "xyz789",
      "updatedBy": 4,
      "updatedAt": "xyz789"
    }
  }
}
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
    value
    enabled
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{
  "id": "4",
  "input": UpdateLabelInput
}
Response
{
  "data": {
    "updateLabel": {
      "id": 4,
      "name": "xyz789",
      "description": "xyz789",
      "value": "xyz789",
      "enabled": true,
      "createdBy": "4",
      "createdAt": "xyz789",
      "updatedBy": "4",
      "updatedAt": "abc123"
    }
  }
}
Mutations

updateStyle

Response

Returns an UpdateStyleResponse!

Arguments
Name Description
id - ID!
input - UpdateStyleInput!

Example

Query
mutation updateStyle(
  $id: ID!,
  $input: UpdateStyleInput!
) {
  updateStyle(
    id: $id,
    input: $input
  ) {
    id
    name
    format
    description
    enabled
    defaultStatus
    access
    createdBy
    createdAt
    updatedBy
    updatedAt
  }
}
Variables
{
  "id": "4",
  "input": UpdateStyleInput
}
Response
{
  "data": {
    "updateStyle": {
      "id": 4,
      "name": "xyz789",
      "format": "JSON",
      "description": "abc123",
      "enabled": true,
      "defaultStatus": false,
      "access": "Default",
      "createdBy": 4,
      "createdAt": "xyz789",
      "updatedBy": "4",
      "updatedAt": "abc123"
    }
  }
}

Types

AssetFilterInput

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

AttributeStyleInput

Fields
Input Field Description
name - String
attribute - String
rules - [RuleStyleInput]
Example
{
  "name": "xyz789",
  "attribute": "abc123",
  "rules": [RuleStyleInput]
}
Types

AttributeType

Values
Enum Value Description

STRING

NUMBER

BOOLEAN

DATE

GEOMETRY

OBJECT

ARRAY

OTHER
Example
"STRING"
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": false,
  "le": true,
  "eq": true,
  "ne": true,
  "ge": true,
  "gt": true,
  "isNull": false,
  "in": [false],
  "notIn": [false],
  "between": [true],
  "notBetween": [false],
  "min": BooleanCriteria,
  "max": BooleanCriteria
}
Types

ChannelOptions

Fields
Input Field Description
name - String
mode - ContrastMethod
gamma - Float
Example
{
  "name": "abc123",
  "mode": "NORMALIZE",
  "gamma": 987.65
}
Types

Channels

Fields
Input Field Description
gray - ChannelOptions
red - ChannelOptions
green - ChannelOptions
blue - ChannelOptions
Example
{
  "gray": ChannelOptions,
  "red": ChannelOptions,
  "green": ChannelOptions,
  "blue": ChannelOptions
}
Types

ClassifiedAttribute

Fields
Field Name Description
type - AttributeType
rules - [Rule]
Example
{"type": "STRING", "rules": [Rule]}
Types

CogInput

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

ColorMapEntry

Fields
Input Field Description
color - String
entryOpacity - Float
bandValue - Float
textLabel - String
Example
{
  "color": "abc123",
  "entryOpacity": 123.45,
  "bandValue": 123.45,
  "textLabel": "xyz789"
}
Types

ColorMapType

Values
Enum Value Description

RAMP

INTERVALS

VALUES
Example
"RAMP"
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

ContrastMethod

Values
Enum Value Description

NORMALIZE

HISTOGRAM
Example
"NORMALIZE"
Types

CoverageInput

Fields
Input Field Description
dataAssetId - ID
workspace - String!
Example
{"dataAssetId": 4, "workspace": "abc123"}
Types

CreateAssetInput

Fields
Input Field Description
groupIds - [ID!]!
name - String!
description - String
order - Int
type - LayerAssetType!
enabled - Boolean!
visible - Boolean!
access - LayerAccess!
context - PublishContextValue!
properties - JSON
Example
{
  "groupIds": [4],
  "name": "abc123",
  "description": "xyz789",
  "order": 987,
  "type": "LAYERGROUP",
  "enabled": false,
  "visible": false,
  "access": "Default",
  "context": PublishContextValue,
  "properties": {}
}
Types

CreateAssetResponse

Fields
Field Name Description
id - ID!
name - String!
description - String
type - LayerAssetType
enabled - Boolean!
visible - Boolean!
access - LayerAccess
status - LayerAssetStatus
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
properties - JSON
Example
{
  "id": "4",
  "name": "xyz789",
  "description": "xyz789",
  "type": "LAYERGROUP",
  "enabled": false,
  "visible": true,
  "access": "Default",
  "status": "INIT",
  "createdBy": 4,
  "createdAt": "abc123",
  "updatedBy": "4",
  "updatedAt": "abc123",
  "properties": {}
}
Types

CreateGroupInput

Fields
Input Field Description
parentId - ID
name - String!
description - String
enabled - Boolean!
published - Boolean!
collapsed - Boolean!
access - LayerAccess!
order - Int
properties - JSON
Example
{
  "parentId": "4",
  "name": "xyz789",
  "description": "abc123",
  "enabled": true,
  "published": true,
  "collapsed": true,
  "access": "Default",
  "order": 987,
  "properties": {}
}
Types

CreateGroupResponse

Fields
Field Name Description
id - ID!
parent - LayerGroup
children - [LayerGroup]
name - String!
description - String
enabled - Boolean!
published - Boolean!
collapsed - Boolean!
access - LayerAccess!
order - Int
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": 4,
  "parent": LayerGroup,
  "children": [LayerGroup],
  "name": "xyz789",
  "description": "abc123",
  "enabled": true,
  "published": true,
  "collapsed": true,
  "access": "Default",
  "order": 987,
  "createdBy": "4",
  "createdAt": "abc123",
  "updatedBy": 4,
  "updatedAt": "xyz789"
}
Types

CreateLabelInput

Fields
Input Field Description
name - String!
description - String
value - String
enabled - Boolean!
Example
{
  "name": "abc123",
  "description": "abc123",
  "value": "xyz789",
  "enabled": false
}
Types

CreateLabelResponse

Fields
Field Name Description
id - ID!
name - String!
description - String
value - String
enabled - Boolean
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": 4,
  "name": "abc123",
  "description": "xyz789",
  "value": "abc123",
  "enabled": true,
  "createdBy": 4,
  "createdAt": "xyz789",
  "updatedBy": "4",
  "updatedAt": "xyz789"
}
Types

CreateStyleInput

Fields
Input Field Description
name - String!
format - LayerStyleFormat!
description - String
enabled - Boolean!
defaultStatus - Boolean!
access - LayerAccess!
context - StyleContextValue!
properties - JSON
Example
{
  "name": "abc123",
  "format": "JSON",
  "description": "abc123",
  "enabled": false,
  "defaultStatus": false,
  "access": "Default",
  "context": StyleContextValue,
  "properties": {}
}
Types

CreateStyleResponse

Fields
Field Name Description
id - ID!
name - String!
format - LayerStyleFormat
description - String
enabled - Boolean
defaultStatus - Boolean
access - LayerAccess
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": 4,
  "name": "xyz789",
  "format": "JSON",
  "description": "xyz789",
  "enabled": false,
  "defaultStatus": true,
  "access": "Default",
  "createdBy": "4",
  "createdAt": "xyz789",
  "updatedBy": 4,
  "updatedAt": "abc123"
}
Types

CreateUserAssetInput

Fields
Input Field Description
assetId - ID!
order - Int
visible - Boolean
Example
{"assetId": 4, "order": 123, "visible": false}
Types

CreateUserGroupInput

Fields
Input Field Description
groupId - ID!
parent - CreateUserGroupInput
children - [CreateUserGroupInput!]
order - Int
collapsed - Boolean
assets - [CreateUserAssetInput!]
Example
{
  "groupId": "4",
  "parent": CreateUserGroupInput,
  "children": [CreateUserGroupInput],
  "order": 987,
  "collapsed": true,
  "assets": [CreateUserAssetInput]
}
Types

Date

Example
"2007-12-03"
Types

DateCriteria

Fields
Input Field Description
lt - Date
le - Date
eq - Date
ne - Date
ge - Date
gt - Date
isNull - Boolean
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",
  "isNull": true,
  "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": false,
  "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

F4DInput

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

FeatureInput

Fields
Input Field Description
dataAssetId - ID
workspace - String!
store - String!
Example
{
  "dataAssetId": 4,
  "workspace": "xyz789",
  "store": "abc123"
}
Types

Float

Description

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

Example
123.45
Types

FloatCriteria

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

GroupFilterInput

Fields
Input Field Description
id - SimpleCriteria
userId - SimpleCriteria
parentId - SimpleCriteria
name - StringCriteria
access - CommonCriteria
enabled - BooleanCriteria
and - [GroupFilterInput!]
or - [GroupFilterInput!]
not - GroupFilterInput
Example
{
  "id": SimpleCriteria,
  "userId": SimpleCriteria,
  "parentId": SimpleCriteria,
  "name": StringCriteria,
  "access": CommonCriteria,
  "enabled": BooleanCriteria,
  "and": [GroupFilterInput],
  "or": [GroupFilterInput],
  "not": GroupFilterInput
}
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
123
Types

IntCriteria

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

JSON

Example
{}
Types

JsonPropertyInput

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

JsonPropertyPatchInput

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

JsonPropertyPatchOperation

Values
Enum Value Description

add

remove

replace

move

copy

test
Example
"add"
Types

LabelFilter

Fields
Input Field Description
id - ID
name - StringCriteria
description - StringCriteria
value - StringCriteria
enabled - BooleanCriteria
and - [LabelFilter!]
or - [LabelFilter!]
not - LabelFilter
Example
{
  "id": "4",
  "name": StringCriteria,
  "description": StringCriteria,
  "value": StringCriteria,
  "enabled": BooleanCriteria,
  "and": [LabelFilter],
  "or": [LabelFilter],
  "not": LabelFilter
}
Types

LayerAccess

Values
Enum Value Description

Default

Inherit

Private

Protected

Public
Example
"Default"
Types

LayerAsset

Fields
Field Name Description
id - ID!
name - String
description - String
type - LayerAssetType
enabled - Boolean
visible - Boolean
access - LayerAccess
status - LayerAssetStatus
order - Int
groups - [LayerGroup]
styles - [LayerStyle]
logs - [LayerAssetLog]
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
properties - JSON
Example
{
  "id": 4,
  "name": "xyz789",
  "description": "xyz789",
  "type": "LAYERGROUP",
  "enabled": false,
  "visible": true,
  "access": "Default",
  "status": "INIT",
  "order": 123,
  "groups": [LayerGroup],
  "styles": [LayerStyle],
  "logs": [LayerAssetLog],
  "createdBy": 4,
  "createdAt": "abc123",
  "updatedBy": 4,
  "updatedAt": "abc123",
  "properties": {}
}
Types

LayerAssetInfo

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

LayerAssetLog

Fields
Field Name Description
id - ID!
assetId - ID!
type - String!
content - String!
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": "4",
  "assetId": "4",
  "type": "xyz789",
  "content": "abc123",
  "createdBy": "4",
  "createdAt": "xyz789",
  "updatedBy": "4",
  "updatedAt": "abc123"
}
Types

LayerAssetStatus

Values
Enum Value Description

INIT

READY

RUNNING

DONE

ERROR
Example
"INIT"
Types

LayerAssetType

Values
Enum Value Description

LAYERGROUP

RASTER

VECTOR

COG

TILES3D

F4D

SMARTTILE
Example
"LAYERGROUP"
Types

LayerGroup

Fields
Field Name Description
id - ID!
parent - LayerGroup
children - [LayerGroup!]!
name - String
description - String
order - Int
enabled - Boolean!
published - Boolean!
collapsed - Boolean!
access - LayerAccess!
assets - [LayerAsset!]!
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": 4,
  "parent": LayerGroup,
  "children": [LayerGroup],
  "name": "xyz789",
  "description": "xyz789",
  "order": 123,
  "enabled": false,
  "published": true,
  "collapsed": true,
  "access": "Default",
  "assets": [LayerAsset],
  "createdBy": "4",
  "createdAt": "xyz789",
  "updatedBy": "4",
  "updatedAt": "xyz789"
}
Types

LayerLabel

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

LayerStyle

Fields
Field Name Description
id - ID
name - String
format - LayerStyleFormat
description - String
enabled - Boolean
defaultStatus - Boolean
access - LayerAccess
context - JSON
Example
{
  "id": 4,
  "name": "xyz789",
  "format": "JSON",
  "description": "xyz789",
  "enabled": false,
  "defaultStatus": false,
  "access": "Default",
  "context": {}
}
Types

LayerStyleFormat

Values
Enum Value Description

JSON

SLD

QML

Mapbox

Mapfile

Geostyler

Openlayers
Example
"JSON"
Types

LineStyleInput

Fields
Input Field Description
strokeColor - String
strokeOpacity - Float
strokeWidth - Float
strokeLinejoin - Linejoin
strokeLinecap - Linecap
strokeDasharray - [Float]
strokeDashoffset - Float
graphicFillStyle - PointStyleInput
graphicStrokeStyle - PointStyleInput
Example
{
  "strokeColor": "xyz789",
  "strokeOpacity": 123.45,
  "strokeWidth": 123.45,
  "strokeLinejoin": "MITRE",
  "strokeLinecap": "BUTT",
  "strokeDasharray": [123.45],
  "strokeDashoffset": 123.45,
  "graphicFillStyle": PointStyleInput,
  "graphicStrokeStyle": PointStyleInput
}
Types

Linecap

Values
Enum Value Description

BUTT

ROUND

SQUARE
Example
"BUTT"
Types

Linejoin

Values
Enum Value Description

MITRE

ROUND

BEVEL
Example
"MITRE"
Types

LocateAssetInput

Fields
Input Field Description
source - LayerAssetInfo!
target - LayerAssetInfo!
option - LocateOption!
Example
{
  "source": LayerAssetInfo,
  "target": LayerAssetInfo,
  "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

Long

Example
{}
Types

LongCriteria

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

PointStyleInput

Fields
Input Field Description
shape - String
fillColor - String
fillOpacity - Float
strokeColor - String
strokeOpacity - Float
strokeWidth - Float
strokeLinejoin - Linejoin
strokeLinecap - Linecap
strokeDasharray - [Float]
strokeDashoffset - Float
size - Float
rotation - Float
Example
{
  "shape": "abc123",
  "fillColor": "abc123",
  "fillOpacity": 987.65,
  "strokeColor": "abc123",
  "strokeOpacity": 123.45,
  "strokeWidth": 987.65,
  "strokeLinejoin": "MITRE",
  "strokeLinecap": "BUTT",
  "strokeDasharray": [123.45],
  "strokeDashoffset": 123.45,
  "size": 987.65,
  "rotation": 987.65
}
Types

PolygonStyleInput

Fields
Input Field Description
fillColor - String
fillOpacity - Float
fillGraphic - PointStyleInput
strokeColor - String
strokeOpacity - Float
strokeWidth - Float
strokeLinejoin - Linejoin
strokeLinecap - Linecap
strokeDasharray - [Float]
strokeDashoffset - Float
graphicFillStyle - PointStyleInput
graphicStrokeStyle - PointStyleInput
Example
{
  "fillColor": "xyz789",
  "fillOpacity": 987.65,
  "fillGraphic": PointStyleInput,
  "strokeColor": "xyz789",
  "strokeOpacity": 123.45,
  "strokeWidth": 123.45,
  "strokeLinejoin": "MITRE",
  "strokeLinecap": "BUTT",
  "strokeDasharray": [987.65],
  "strokeDashoffset": 123.45,
  "graphicFillStyle": PointStyleInput,
  "graphicStrokeStyle": PointStyleInput
}
Types

PublishContextValue

Fields
Input Field Description
remote - RemoteInput
remoteT3d - RemoteT3DInput
feature - FeatureInput
coverage - CoverageInput
cog - CogInput
t3d - T3DInput
f4d - F4DInput
smartTile - SmartTileInput
Example
{
  "remote": RemoteInput,
  "remoteT3d": RemoteT3DInput,
  "feature": FeatureInput,
  "coverage": CoverageInput,
  "cog": CogInput,
  "t3d": T3DInput,
  "f4d": F4DInput,
  "smartTile": SmartTileInput
}
Types

RasterStyleInput

Fields
Input Field Description
opacity - Float
channels - Channels
type - ColorMapType
entries - [ColorMapEntry]
mode - ContrastMethod
gamma - Float
Example
{
  "opacity": 987.65,
  "channels": Channels,
  "type": "RAMP",
  "entries": [ColorMapEntry],
  "mode": "NORMALIZE",
  "gamma": 987.65
}
Types

RemoteInput

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

RemoteLayerAsset

Fields
Field Name Description
name - String
href - String
Example
{
  "name": "xyz789",
  "href": "xyz789"
}
Types

RemoteLayerStyle

Fields
Field Name Description
name - String!
href - String!
type - StyleType!
Example
{
  "name": "abc123",
  "href": "xyz789",
  "type": "POINT"
}
Types

RemoteStyleFilterInput

Fields
Input Field Description
type - StyleType
Example
{"type": "POINT"}
Types

RemoteT3DInput

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

Rule

Fields
Field Name Description
min - String
max - String
eq - String
color - String
Example
{
  "min": "xyz789",
  "max": "xyz789",
  "eq": "xyz789",
  "color": "abc123"
}
Types

RuleInput

Fields
Input Field Description
min - String
max - String
eq - String
Example
{
  "min": "abc123",
  "max": "abc123",
  "eq": "xyz789"
}
Types

RuleStyleInput

Fields
Input Field Description
rule - RuleInput
style - PolygonStyleInput
Example
{
  "rule": RuleInput,
  "style": PolygonStyleInput
}
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

SmartTileInput

Fields
Input Field Description
dataAssetId - ID
Example
{"dataAssetId": "4"}
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
"xyz789"
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": "xyz789",
  "eq": "abc123",
  "ne": "abc123",
  "ge": "abc123",
  "gt": "abc123",
  "isNull": false,
  "in": ["xyz789"],
  "notIn": ["xyz789"],
  "between": ["xyz789"],
  "notBetween": ["xyz789"],
  "min": StringCriteria,
  "max": StringCriteria,
  "eqIgnoreCase": "xyz789",
  "contains": "xyz789",
  "containsIgnoreCase": "xyz789",
  "startsWith": "abc123",
  "startsWithIgnoreCase": "xyz789",
  "endsWith": "xyz789",
  "endsWithIgnoreCase": "xyz789",
  "isEmpty": true,
  "matches": "abc123"
}
Types

StyleContextValue

Fields
Input Field Description
point - PointStyleInput
line - LineStyleInput
polygon - PolygonStyleInput
raster - RasterStyleInput
attribute - AttributeStyleInput
Example
{
  "point": PointStyleInput,
  "line": LineStyleInput,
  "polygon": PolygonStyleInput,
  "raster": RasterStyleInput,
  "attribute": AttributeStyleInput
}
Types

StyleFilter

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

StyleType

Values
Enum Value Description

POINT

LINE

POLYGON

RASTER

UNKNOWN
Example
"POINT"
Types

T3DInput

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

TerrainAsset

Fields
Field Name Description
id - ID!
name - String
selected - Boolean
properties - JSON
Example
{
  "id": "4",
  "name": "abc123",
  "selected": false,
  "properties": {}
}
Types

Time

Example
"10:15:30Z"
Types

TimeCriteria

Fields
Input Field Description
lt - Time
le - Time
eq - Time
ne - Time
ge - Time
gt - Time
isNull - Boolean
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",
  "isNull": false,
  "in": ["10:15:30Z"],
  "notIn": ["10:15:30Z"],
  "between": ["10:15:30Z"],
  "notBetween": ["10:15:30Z"],
  "min": TimeCriteria,
  "max": TimeCriteria
}
Types

UpdateAssetInput

Fields
Input Field Description
groupIds - [ID!]
name - String
description - String
order - Int
type - LayerAssetType
enabled - Boolean
visible - Boolean
access - LayerAccess
context - PublishContextValue
properties - JsonPropertyInput
Example
{
  "groupIds": [4],
  "name": "xyz789",
  "description": "abc123",
  "order": 123,
  "type": "LAYERGROUP",
  "enabled": true,
  "visible": false,
  "access": "Default",
  "context": PublishContextValue,
  "properties": JsonPropertyInput
}
Types

UpdateAssetResponse

Fields
Field Name Description
id - ID!
name - String
description - String
order - Int
type - LayerAssetType
enabled - Boolean
visible - Boolean
access - LayerAccess
status - LayerAssetStatus
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
properties - JSON
Example
{
  "id": 4,
  "name": "abc123",
  "description": "xyz789",
  "order": 123,
  "type": "LAYERGROUP",
  "enabled": false,
  "visible": false,
  "access": "Default",
  "status": "INIT",
  "createdBy": "4",
  "createdAt": "xyz789",
  "updatedBy": 4,
  "updatedAt": "xyz789",
  "properties": {}
}
Types

UpdateGroupInput

Fields
Input Field Description
parentId - ID
name - String
description - String
enabled - Boolean
published - Boolean
collapsed - Boolean
access - LayerAccess
order - Int
properties - JsonPropertyInput
Example
{
  "parentId": 4,
  "name": "abc123",
  "description": "abc123",
  "enabled": true,
  "published": true,
  "collapsed": false,
  "access": "Default",
  "order": 123,
  "properties": JsonPropertyInput
}
Types

UpdateGroupResponse

Fields
Field Name Description
id - ID!
parent - LayerGroup
children - [LayerGroup]
name - String!
description - String
enabled - Boolean!
published - Boolean!
collapsed - Boolean!
access - LayerAccess!
order - Int
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": "4",
  "parent": LayerGroup,
  "children": [LayerGroup],
  "name": "xyz789",
  "description": "xyz789",
  "enabled": true,
  "published": false,
  "collapsed": true,
  "access": "Default",
  "order": 123,
  "createdBy": 4,
  "createdAt": "abc123",
  "updatedBy": 4,
  "updatedAt": "xyz789"
}
Types

UpdateLabelInput

Fields
Input Field Description
name - String
description - String
value - String
enabled - Boolean
Example
{
  "name": "abc123",
  "description": "abc123",
  "value": "abc123",
  "enabled": true
}
Types

UpdateLabelResponse

Fields
Field Name Description
id - ID!
name - String!
description - String
value - String
enabled - Boolean
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": "4",
  "name": "xyz789",
  "description": "abc123",
  "value": "abc123",
  "enabled": false,
  "createdBy": 4,
  "createdAt": "abc123",
  "updatedBy": 4,
  "updatedAt": "xyz789"
}
Types

UpdateStyleInput

Fields
Input Field Description
name - String
format - LayerStyleFormat
description - String
enabled - Boolean
defaultStatus - Boolean
access - LayerAccess
context - StyleContextValue
properties - JsonPropertyInput
Example
{
  "name": "xyz789",
  "format": "JSON",
  "description": "xyz789",
  "enabled": false,
  "defaultStatus": false,
  "access": "Default",
  "context": StyleContextValue,
  "properties": JsonPropertyInput
}
Types

UpdateStyleResponse

Fields
Field Name Description
id - ID!
name - String!
format - LayerStyleFormat
description - String
enabled - Boolean
defaultStatus - Boolean
access - LayerAccess
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": "4",
  "name": "xyz789",
  "format": "JSON",
  "description": "xyz789",
  "enabled": false,
  "defaultStatus": true,
  "access": "Default",
  "createdBy": "4",
  "createdAt": "abc123",
  "updatedBy": 4,
  "updatedAt": "abc123"
}
Types

UserAssetFilterInput

Fields
Input Field Description
id - SimpleCriteria
groupId - SimpleCriteria
name - StringCriteria
access - CommonCriteria
enabled - BooleanCriteria
and - [UserAssetFilterInput!]
or - [UserAssetFilterInput!]
not - UserAssetFilterInput
Example
{
  "id": SimpleCriteria,
  "groupId": SimpleCriteria,
  "name": StringCriteria,
  "access": CommonCriteria,
  "enabled": BooleanCriteria,
  "and": [UserAssetFilterInput],
  "or": [UserAssetFilterInput],
  "not": UserAssetFilterInput
}
Types

UserGroupFilterInput

Fields
Input Field Description
id - SimpleCriteria
parentId - SimpleCriteria
name - StringCriteria
access - CommonCriteria
enabled - BooleanCriteria
and - [UserGroupFilterInput!]
or - [UserGroupFilterInput!]
not - UserGroupFilterInput
Example
{
  "id": SimpleCriteria,
  "parentId": SimpleCriteria,
  "name": StringCriteria,
  "access": CommonCriteria,
  "enabled": BooleanCriteria,
  "and": [UserGroupFilterInput],
  "or": [UserGroupFilterInput],
  "not": UserGroupFilterInput
}
Types

UserLayerAsset

Fields
Field Name Description
id - ID!
assetId - ID!
name - String
description - String
type - LayerAssetType
enabled - Boolean
visible - Boolean
access - LayerAccess
order - Int
logs - [LayerAssetLog]
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
properties - JSON
Example
{
  "id": 4,
  "assetId": "4",
  "name": "abc123",
  "description": "abc123",
  "type": "LAYERGROUP",
  "enabled": true,
  "visible": false,
  "access": "Default",
  "order": 123,
  "logs": [LayerAssetLog],
  "createdBy": "4",
  "createdAt": "abc123",
  "updatedBy": "4",
  "updatedAt": "xyz789",
  "properties": {}
}
Types

UserLayerGroup

Fields
Field Name Description
id - ID!
groupId - ID!
parent - UserLayerGroup
children - [UserLayerGroup!]!
name - String
description - String
order - Int
enabled - Boolean!
published - Boolean!
collapsed - Boolean!
access - LayerAccess!
assets - [UserLayerAsset!]!
createdBy - ID
createdAt - String
updatedBy - ID
updatedAt - String
Example
{
  "id": "4",
  "groupId": "4",
  "parent": UserLayerGroup,
  "children": [UserLayerGroup],
  "name": "abc123",
  "description": "xyz789",
  "order": 987,
  "enabled": false,
  "published": true,
  "collapsed": true,
  "access": "Default",
  "assets": [UserLayerAsset],
  "createdBy": 4,
  "createdAt": "xyz789",
  "updatedBy": 4,
  "updatedAt": "abc123"
}
Documentation by Anvil SpectaQL