Pointscene GraphQL API Reference

Pointscene GraphQL API is used to analyze, manage and stream reality capture data.

Contact

License

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

API Endpoints

Production:
https://api.pointscene.com/graphql

Queries

`client`

Query Client by ID

Returns a Client

Name	Description
`id` - `ID!`

Example

Query

query client($id: ID!) {
  client(id: $id) {
    id
    instanceId
    title
    description
    managed
    clientKey
    clientSecret
  }
}

Variables

{"id": ID}

Response

{
  "data": {
    "client": {
      "id": ID,
      "instanceId": [123],
      "title": "abc123",
      "description": "xyz789",
      "managed": false,
      "clientKey": "abc123",
      "clientSecret": "xyz789"
    }
  }
}

Queries

`incompleteStorageObjects`

Query Incomplete Storage Objects. Requires client or user token in request header Authorization: Bearer <token>.

Returns a StorageObjectsResult!

Name	Description
`id` - `ID!`	Storage Object ID
`page` - `Page`

Example

Query

query incompleteStorageObjects($id: ID!, $page: Page) {
  incompleteStorageObjects(id: $id, page: $page) {
    items {
      ...StorageObjectFragment
    }
    count
    cursor
  }
}

Variables

{"id": ID, "page": Page}

Response

{
  "data": {
    "incompleteStorageObjects": {
      "items": [StorageObject],
      "count": 987,
      "cursor": Cursor
    }
  }
}

Queries

`instance`

Query instance by ID. Requires client or user token in request header Authorization: Bearer <token>.

Returns an Instance!

Name	Description
`id` - `ID!`	Instance ID

Example

Query

query instance($id: ID!) {
  instance(id: $id) {
    id
    title
    description
    timestamps {
      ...TimestampsFragment
    }
  }
}

Variables

{"id": ID}

Response

{
  "data": {
    "instance": {
      "id": ID,
      "title": "xyz789",
      "description": "abc123",
      "timestamps": Timestamps
    }
  }
}

Queries

`instances`

Query instances by User ID or Client Key. Requires client or user token in request header Authorization: Bearer <token>.

Returns an InstancesResult!

Name	Description
`userId` - `ID`	User ID for linked instances
`clientKey` - `String`	Client Key for linked instances

Example

Query

query instances($userId: ID, $clientKey: String) {
  instances(userId: $userId, clientKey: $clientKey) {
    items {
      ...InstanceFragment
    }
    count
  }
}

Variables

{"userId": ID, "clientKey": "abc123"}

Response

{
  "data": {
    "instances": {"items": [Instance], "count": 987}
  }
}

Queries

`resource`

Query resource by ID

Returns a Resource!

Name	Description
`id` - `ID!`	Resource ID

Example

Query

query resource($id: ID!) {
  resource(id: $id) {
    id
    type
    description
    metadata
    timestamps {
      ...TimestampsFragment
    }
    distance(target: $target)
  }
}

Variables

{"id": ID}

Response

{
  "data": {
    "resource": {
      "id": ID,
      "type": ResourceType,
      "description": "abc123",
      "metadata": {},
      "timestamps": Timestamps,
      "distance": 123.45
    }
  }
}

Queries

`resources`

Query instance resources. Requires client or user token in request header Authorization: Bearer <token>. User or client must be linked to the instance.

Returns a ResourceResult!

Name	Description
`instanceId` - `Int!`	Instance ID of resources
`spatial` - `SpatialQuery`	Spatial query
`types` - `[ResourceType]`	Array of resource types to return
`status` - `[ResourceStatus]`	Resource status
`labels` - `[String]`

Example

Query

query resources($instanceId: Int!, $spatial: SpatialQuery, $types: [ResourceType], $status: [ResourceStatus], $labels: [String]) {
  resources(instanceId: $instanceId, spatial: $spatial, types: $types, status: $status, labels: $labels) {
    items {
      ...ResourceFragment
    }
    count
    cursor
  }
}

Variables

{
  "instanceId": 987,
  "spatial": SpatialQuery,
  "types": [ResourceType],
  "status": [ResourceStatus],
  "labels": ["xyz789"]
}

Response

{
  "data": {
    "resources": {
      "items": [Resource],
      "count": 987,
      "cursor": Cursor
    }
  }
}

Queries

`storageBucket`

Query storage bucket by Storage bucket ID or Instance ID Requires client or user token in request header Authorization: Bearer <token>.

Returns a StorageBucket!

Name	Description
`id` - `ID`
`instanceId` - `ID`

Example

Query

query storageBucket($id: ID, $instanceId: ID) {
  storageBucket(id: $id, instanceId: $instanceId) {
    id
    bucketName
    description
  }
}

Variables

{"id": ID, "instanceId": ID}

Response

{
  "data": {
    "storageBucket": {
      "id": ID,
      "bucketName": "xyz789",
      "description": "xyz789"
    }
  }
}

Queries

`storageBuckets`

Returns a StorageBucketsResult!

Name	Description
`instanceId` - `ID!`
`page` - `Page`

Example

Query

query storageBuckets($instanceId: ID!, $page: Page) {
  storageBuckets(instanceId: $instanceId, page: $page) {
    items {
      ...StorageBucketFragment
    }
    count
    cursor
  }
}

Variables

{"instanceId": ID, "page": Page}

Response

{
  "data": {
    "storageBuckets": {
      "items": [StorageBucket],
      "count": 987,
      "cursor": Cursor
    }
  }
}

Queries

`storageObjects`

Query storage objects by ID. Requires client or user token in request header Authorization: Bearer <token>.

Returns a StorageObjectsResult!

Name	Description
`id` - `ID!`	Storage Object ID
`page` - `Page`

Example

Query

query storageObjects($id: ID!, $page: Page) {
  storageObjects(id: $id, page: $page) {
    items {
      ...StorageObjectFragment
    }
    count
    cursor
  }
}

Variables

{"id": ID, "page": Page}

Response

{
  "data": {
    "storageObjects": {
      "items": [StorageObject],
      "count": 987,
      "cursor": Cursor
    }
  }
}

Queries

`user`

Query User by ID or email

Returns a User

Name	Description
`id` - `ID`	User ID
`email` - `String`	User email

Example

Query

query user($id: ID, $email: String) {
  user(id: $id, email: $email) {
    id
    firstName
    lastName
    email
    admin
    status
  }
}

Variables

{"id": ID, "email": "xyz789"}

Response

{
  "data": {
    "user": {
      "id": ID,
      "firstName": "abc123",
      "lastName": "xyz789",
      "email": "abc123",
      "admin": false,
      "status": UserStatus
    }
  }
}

Queries

`workflow`

Query workflow by ID Requires client or user token in request header Authorization: Bearer <token>.

Returns a Workflow

Name	Description
`id` - `ID!`

Example

Query

query workflow($id: ID!) {
  workflow(id: $id) {
    id
    title
    reports
    debugging
  }
}

Variables

{"id": ID}

Response

{
  "data": {
    "workflow": {
      "id": ID,
      "title": "abc123",
      "reports": [{}],
      "debugging": {}
    }
  }
}

Queries

`workflows`

Query workflows by Instance ID Requires client or user token in request header Authorization: Bearer <token>.

Returns a WorkflowsResult!

Name	Description
`instanceId` - `ID!`
`first` - `Int`
`after` - `Cursor`

Example

Query

query workflows($instanceId: ID!, $first: Int, $after: Cursor) {
  workflows(instanceId: $instanceId, first: $first, after: $after) {
    items {
      ...WorkflowFragment
    }
    count
    cursor
  }
}

Variables

{
  "instanceId": ID,
  "first": 123,
  "after": Cursor
}

Response

{
  "data": {
    "workflows": {
      "items": [Workflow],
      "count": 987,
      "cursor": Cursor
    }
  }
}

Mutations

`activateUser`

Mutation for activating a user

Returns a User

Name	Description
`email` - `String!`	Email
`code` - `String!`	Activation code

Example

Query

mutation activateUser($email: String!, $code: String!) {
  activateUser(email: $email, code: $code) {
    id
    firstName
    lastName
    email
    admin
    status
  }
}

Variables

{"email": "abc123", "code": "abc123"}

Response

{
  "data": {
    "activateUser": {
      "id": ID,
      "firstName": "abc123",
      "lastName": "xyz789",
      "email": "abc123",
      "admin": false,
      "status": UserStatus
    }
  }
}

Mutations

`createClient`

Mutation for creating a new client. Contact support@pointscene.com for client access.

Returns a Client

Name	Description
`title` - `String`
`description` - `String`

Example

Query

mutation createClient($title: String, $description: String) {
  createClient(title: $title, description: $description) {
    id
    instanceId
    title
    description
    managed
    clientKey
    clientSecret
  }
}

Variables

{"title": "abc123", "description": "xyz789"}

Response

{
  "data": {
    "createClient": {
      "id": ID,
      "instanceId": [123],
      "title": "abc123",
      "description": "abc123",
      "managed": true,
      "clientKey": "abc123",
      "clientSecret": "abc123"
    }
  }
}

Mutations

`createInstance`

Mutation for creating an instance. Requires client or user token in request header Authorization: Bearer <token>

Returns an Instance!

Name	Description
`title` - `String!`	Title of instance
`description` - `String!`	Instance description

Example

Query

mutation createInstance($title: String!, $description: String!) {
  createInstance(title: $title, description: $description) {
    id
    title
    description
    timestamps {
      ...TimestampsFragment
    }
  }
}

Variables

{"title": "abc123", "description": "xyz789"}

Response

{
  "data": {
    "createInstance": {
      "id": ID,
      "title": "xyz789",
      "description": "xyz789",
      "timestamps": Timestamps
    }
  }
}

Mutations

`createResource`

Mutation for creating an empty resource that can be used as output for workflows

Returns a Resource!

Name	Description
`instanceId` - `Int!`	Instance Id for empty resource
`description` - `String`	Description
`type` - `ResourceType!`	Resource type to create
`labels` - `[String]`	Resource labels

Example

Query

mutation createResource($instanceId: Int!, $description: String, $type: ResourceType!, $labels: [String]) {
  createResource(instanceId: $instanceId, description: $description, type: $type, labels: $labels) {
    id
    type
    description
    metadata
    timestamps {
      ...TimestampsFragment
    }
    distance(target: $target)
  }
}

Variables

{
  "instanceId": 123,
  "description": "xyz789",
  "type": ResourceType,
  "labels": ["abc123"]
}

Response

{
  "data": {
    "createResource": {
      "id": ID,
      "type": ResourceType,
      "description": "abc123",
      "metadata": {},
      "timestamps": Timestamps,
      "distance": 123.45
    }
  }
}

Mutations

`createStorageBucket`

Mutation for creating storage bucket. Requires client or user token in request header Authorization: Bearer <token>

Returns a StorageBucket!

Name	Description
`instanceId` - `ID!`
`description` - `String`
`accessKey` - `String`
`secretKey` - `String`
`endpoint` - `String`

Example

Query

mutation createStorageBucket($instanceId: ID!, $description: String, $accessKey: String, $secretKey: String, $endpoint: String) {
  createStorageBucket(instanceId: $instanceId, description: $description, accessKey: $accessKey, secretKey: $secretKey, endpoint: $endpoint) {
    id
    bucketName
    description
  }
}

Variables

{
  "instanceId": ID,
  "description": "abc123",
  "accessKey": "abc123",
  "secretKey": "xyz789",
  "endpoint": "abc123"
}

Response

{
  "data": {
    "createStorageBucket": {
      "id": ID,
      "bucketName": "xyz789",
      "description": "xyz789"
    }
  }
}

Mutations

`createStorageObject`

Mutation for Create Storage Object. Requires client or user token in request header Authorization: Bearer <token>.

Returns a CreateStorageObjectResponse!

Name	Description
`instanceId` - `ID!`
`bucket` - `String!`
`name` - `String`
`metadata` - `JSONObject`

Example

Query

mutation createStorageObject($instanceId: ID!, $bucket: String!, $name: String, $metadata: JSONObject) {
  createStorageObject(instanceId: $instanceId, bucket: $bucket, name: $name, metadata: $metadata) {
    uploadID
    name
  }
}

Variables

{
  "instanceId": ID,
  "bucket": "xyz789",
  "name": "xyz789",
  "metadata": JSONObject
}

Response

{"data": {"createStorageObject": {"uploadID": "xyz789", "name": "abc123"}}}

Mutations

`createUser`

Mutation for creating a new User.

Returns a User

Name	Description
`firstName` - `String`	First name
`lastName` - `String`	Last name
`email` - `String!`	Email
`password` - `String!`	Password
`status` - `UserStatus`	User status

Example

Query

mutation createUser($firstName: String, $lastName: String, $email: String!, $password: String!, $status: UserStatus) {
  createUser(firstName: $firstName, lastName: $lastName, email: $email, password: $password, status: $status) {
    id
    firstName
    lastName
    email
    admin
    status
  }
}

Variables

{
  "firstName": "xyz789",
  "lastName": "abc123",
  "email": "xyz789",
  "password": "xyz789",
  "status": UserStatus
}

Response

{
  "data": {
    "createUser": {
      "id": ID,
      "firstName": "abc123",
      "lastName": "xyz789",
      "email": "abc123",
      "admin": true,
      "status": UserStatus
    }
  }
}

Mutations

`createWorkflow`

Mutation for creating a new workflow. Requires client or user token in request header Authorization: Bearer <token>.

Returns a Workflow

Name	Description
`instanceId` - `ID!`	Instance for which to create the Workflow
`dryrun` - `Boolean`	Dry run the workflow without actually processing data
`title` - `String!`	Workflow title
`inputs` - `JSON`	Input resources
`outputs` - `JSON`	Output resources or assets
`tasks` - `[WorkflowTask!]`	Workflow tasks
`advanced` - `AdvancedWorkflowOptions`	Advanced Workflow Options

Example

Query

mutation createWorkflow($instanceId: ID!, $dryrun: Boolean, $title: String!, $inputs: JSON, $outputs: JSON, $tasks: [WorkflowTask!], $advanced: AdvancedWorkflowOptions) {
  createWorkflow(instanceId: $instanceId, dryrun: $dryrun, title: $title, inputs: $inputs, outputs: $outputs, tasks: $tasks, advanced: $advanced) {
    id
    title
    reports
    debugging
  }
}

Variables

{
  "instanceId": ID,
  "dryrun": false,
  "title": "xyz789",
  "inputs": {},
  "outputs": {},
  "tasks": [WorkflowTask],
  "advanced": AdvancedWorkflowOptions
}

Response

{
  "data": {
    "createWorkflow": {
      "id": ID,
      "title": "xyz789",
      "reports": [{}],
      "debugging": {}
    }
  }
}

Mutations

`deleteClient`

Mutation for deleting an existing client. Contact support@pointscene.com for deletion requests.

Returns a DeleteClientResult

Name	Description
`clientKey` - `String!`

Example

Query

mutation deleteClient($clientKey: String!) {
  deleteClient(clientKey: $clientKey) {
    success
  }
}

Variables

{"clientKey": "xyz789"}

Response

{"data": {"deleteClient": {"success": true}}}

Mutations

`deleteInstance`

Mutation for deleting an existing instance. Contact support@pointscene.com for deletion requests.

Returns a DeleteInstanceResult

Name	Description
`instanceId` - `ID!`

Example

Query

mutation deleteInstance($instanceId: ID!) {
  deleteInstance(instanceId: $instanceId) {
    success
  }
}

Variables

{"instanceId": ID}

Response

{"data": {"deleteInstance": {"success": false}}}

Mutations

`deleteResource`

Mutation for deleting a resource

Returns a DeleteResourceResult

Name	Description
`id` - `ID!`	Resource Id

Example

Query

mutation deleteResource($id: ID!) {
  deleteResource(id: $id) {
    success
  }
}

Variables

{"id": ID}

Response

{"data": {"deleteResource": {"success": false}}}

Mutations

`deleteStorageBucket`

Mutation for deleting an existing storage bucket. Contact support@pointscene.com for deletion requests.

Returns a deleteStorageBucketResponse!

Name	Description
`id` - `ID!`

Example

Query

mutation deleteStorageBucket($id: ID!) {
  deleteStorageBucket(id: $id) {
    success
  }
}

Variables

{"id": ID}

Response

{"data": {"deleteStorageBucket": {"success": false}}}

Mutations

`deleteStorageOject`

Returns a Boolean!

Name	Description
`bucket` - `String!`
`name` - `String!`

Example

Query

mutation deleteStorageOject($bucket: String!, $name: String!) {
  deleteStorageOject(bucket: $bucket, name: $name)
}

Variables

{"bucket": "abc123", "name": "abc123"}

Response

{"data": {"deleteStorageOject": false}}

Mutations

`deleteUser`

Mutation for deleting an existing user. Requires client or user token in request header Authorization: Bearer <token>.

Returns a SuccessResponse

Name	Description
`email` - `String!`	User email

Example

Query

mutation deleteUser($email: String!) {
  deleteUser(email: $email) {
    success
  }
}

Variables

{"email": "abc123"}

Response

{"data": {"deleteUser": {"success": true}}}

Mutations

`linkInstanceClient`

Mutation for linking a client to an instance. The Client can be linked either with Client ID or Client Key. Requires client or user token in request header Authorization: Bearer <token>. Client or user from the Bearer token need to be linked to the instance. User level for the instance needs to be owner.

Returns an InstanceLinkResult!

Name	Description
`instanceId` - `ID!`	Instance ID to link the user
`clientId` - `ID`	Client ID to link to the instance
`clientKey` - `String`	Client Key to link to the instance

Example

Query

mutation linkInstanceClient($instanceId: ID!, $clientId: ID, $clientKey: String) {
  linkInstanceClient(instanceId: $instanceId, clientId: $clientId, clientKey: $clientKey) {
    success
  }
}

Variables

{
  "instanceId": ID,
  "clientId": ID,
  "clientKey": "xyz789"
}

Response

{"data": {"linkInstanceClient": {"success": true}}}

Mutations

`linkInstanceUser`

Mutation for linking a user to an instance. The User can be linked either with User ID or User email. Requires client or user token in request header Authorization: Bearer <token>. Client or user from the Bearer token need to be linked to the instance. User level for the instance needs to be owner.

Returns an InstanceLinkResult!

Name	Description
`instanceId` - `ID!`	Instance ID to link the user
`userId` - `ID`	User ID to link to the instance
`email` - `String`	User email to link to the instance
`level` - `UserLevel!`	User level

Example

Query

mutation linkInstanceUser($instanceId: ID!, $userId: ID, $email: String, $level: UserLevel!) {
  linkInstanceUser(instanceId: $instanceId, userId: $userId, email: $email, level: $level) {
    success
  }
}

Variables

{
  "instanceId": ID,
  "userId": ID,
  "email": "abc123",
  "level": UserLevel
}

Response

{"data": {"linkInstanceUser": {"success": true}}}

Mutations

`requestResetPassword`

Mutation for requesting password reset

Returns a SuccessResponse

Name	Description
`email` - `String!`	User email

Example

Query

mutation requestResetPassword($email: String!) {
  requestResetPassword(email: $email) {
    success
  }
}

Variables

{"email": "xyz789"}

Response

{"data": {"requestResetPassword": {"success": false}}}

Mutations

`resetClientSecret`

Mutation for resetting Client Secret. Contact support@pointscene.com for resetting client secrets.

Returns a Client

Name	Description
`clientKey` - `String!`

Example

Query

mutation resetClientSecret($clientKey: String!) {
  resetClientSecret(clientKey: $clientKey) {
    id
    instanceId
    title
    description
    managed
    clientKey
    clientSecret
  }
}

Variables

{"clientKey": "abc123"}

Response

{
  "data": {
    "resetClientSecret": {
      "id": ID,
      "instanceId": [123],
      "title": "abc123",
      "description": "xyz789",
      "managed": true,
      "clientKey": "abc123",
      "clientSecret": "abc123"
    }
  }
}

Mutations

`resetPassword`

Mutation for resetting User password

Returns a User

Name	Description
`email` - `String!`	User email
`code` - `String!`	Reset code
`password` - `String!`	New password

Example

Query

mutation resetPassword($email: String!, $code: String!, $password: String!) {
  resetPassword(email: $email, code: $code, password: $password) {
    id
    firstName
    lastName
    email
    admin
    status
  }
}

Variables

{"email": "abc123", "code": "xyz789", "password": "abc123"}

Response

{
  "data": {
    "resetPassword": {
      "id": ID,
      "firstName": "xyz789",
      "lastName": "xyz789",
      "email": "xyz789",
      "admin": false,
      "status": UserStatus
    }
  }
}

Mutations

`updateResource`

Mutation for updating a resource

Returns a Resource!

Name	Description
`id` - `ID!`	Resource Id
`description` - `String`	Description
`type` - `ResourceType`	Resource type
`labels` - `[String]`	Resource labels

Example

Query

mutation updateResource($id: ID!, $description: String, $type: ResourceType, $labels: [String]) {
  updateResource(id: $id, description: $description, type: $type, labels: $labels) {
    id
    type
    description
    metadata
    timestamps {
      ...TimestampsFragment
    }
    distance(target: $target)
  }
}

Variables

{
  "id": ID,
  "description": "xyz789",
  "type": ResourceType,
  "labels": ["abc123"]
}

Response

{
  "data": {
    "updateResource": {
      "id": ID,
      "type": ResourceType,
      "description": "abc123",
      "metadata": {},
      "timestamps": Timestamps,
      "distance": 987.65
    }
  }
}

Mutations

`updateStorageBucket`

Returns a StorageBucket!

Name	Description
`id` - `ID!`
`description` - `String`

Example

Query

mutation updateStorageBucket($id: ID!, $description: String) {
  updateStorageBucket(id: $id, description: $description) {
    id
    bucketName
    description
  }
}

Variables

{"id": ID, "description": "xyz789"}

Response

{
  "data": {
    "updateStorageBucket": {
      "id": ID,
      "bucketName": "xyz789",
      "description": "abc123"
    }
  }
}

Mutations

`uploadStorageObject`

Mutation for Upload Storage Object. Requires client or user token in request header Authorization: Bearer <token>.

Returns a String

Name	Description
`bucket` - `String!`
`name` - `String`
`metadata` - `JSONObject`
`file` - `Upload!`

Example

Query

mutation uploadStorageObject($bucket: String!, $name: String, $metadata: JSONObject, $file: Upload!) {
  uploadStorageObject(bucket: $bucket, name: $name, metadata: $metadata, file: $file)
}

Variables

{
  "bucket": "abc123",
  "name": "abc123",
  "metadata": JSONObject,
  "file": Upload
}

Response

{"data": {"uploadStorageObject": "abc123"}}

Types

`AdvancedWorkflowOptions`

Input for Advanced Workflow Options

Input Field	Description
`noDeleteOn` - `String`

Example

{"noDeleteOn": "xyz789"}

Types

`Boolean`

The Boolean scalar type represents true or false.

Example

true

Types

`Client`

Client type

Field Name	Description
`id` - `ID!`
`instanceId` - `[Int]`
`title` - `String`
`description` - `String`
`managed` - `Boolean`
`clientKey` - `String!`
`clientSecret` - `String!`

Example

{
  "id": ID,
  "instanceId": [987],
  "title": "xyz789",
  "description": "xyz789",
  "managed": true,
  "clientKey": "xyz789",
  "clientSecret": "abc123"
}

Types

`Comparator`

Enum Value	Description
`TITLE`
`DESCRIPTION`
`DISTANCE`
`CREATED_AT`
`UPDATED_AT`
`DELETED_AT`

Types

`CreateStorageObjectResponse`

Create Storage Object Response type

Field Name	Description
`uploadID` - `String!`
`name` - `String!`

Example

{"uploadID": "abc123", "name": "xyz789"}

Types

`Cursor`

Cursor scalar type for pagination

Example

object

Types

`Date`

Date custom scalar type

Example

2021-06-30T09:27:53.870Z

Types

`DeleteClientResult`

Result type for deleting a client

Field Name	Description
`success` - `Boolean!`	Indicates success of the mutation

Example

{"success": true}

Types

`DeleteInstanceResult`

Result type for deleting an instance

Field Name	Description
`success` - `Boolean!`	Indicates success of the mutation

Example

{"success": true}

Types

`DeleteResourceResult`

Result type for deleting a resource

Field Name	Description
`success` - `Boolean!`	Indicates success of the mutation

Example

{"success": false}

Types

`EntwineBuildTaskArgs`

Arguments for task entwine.build.
See reference for more information: link

Field Name	Description
`srs` - `String`
`reprojection` - `String`
`hammer` - `Boolean`
`threads` - `Int`
`force` - `Boolean`
`dataType` - `String`
`span` - `Int`
`noOriginId` - `Boolean`
`bounds` - `String`
`deep` - `Boolean`
`absolute` - `Boolean`
`scale` - `Float`
`limit` - `Int`
`subset` - `String`
`maxNodeSize` - `Int`
`minNodeSize` - `Int`
`cacheSize` - `Int`
`hierarchyStep` - `Int`
`sleepCount` - `Int`
`progress` - `Int`
`sse` - `Boolean`
`requesterPays` - `Boolean`
`allowInstanceProfile` - `Boolean`
`verbose` - `Boolean`

Example

{
  "srs": "abc123",
  "reprojection": "xyz789",
  "hammer": true,
  "threads": 123,
  "force": true,
  "dataType": "abc123",
  "span": 123,
  "noOriginId": true,
  "bounds": "xyz789",
  "deep": false,
  "absolute": true,
  "scale": 987.65,
  "limit": 123,
  "subset": "xyz789",
  "maxNodeSize": 987,
  "minNodeSize": 123,
  "cacheSize": 987,
  "hierarchyStep": 987,
  "sleepCount": 987,
  "progress": 123,
  "sse": true,
  "requesterPays": true,
  "allowInstanceProfile": false,
  "verbose": false
}

Types

`EntwineInfoTaskArgs`

Arguments for task entwine.info.

Field Name	Description
`deep` - `Boolean`
`srs` - `String`
`reprojection` - `String`
`hammer` - `Boolean`
`threads` - `Int`
`config` - `String`
`profile` - `String`
`sse` - `Boolean`
`requesterPays` - `Boolean`
`allowInstanceProfile` - `Boolean`
`verbose` - `Boolean`

Example

{
  "deep": true,
  "srs": "abc123",
  "reprojection": "xyz789",
  "hammer": false,
  "threads": 987,
  "config": "xyz789",
  "profile": "xyz789",
  "sse": false,
  "requesterPays": true,
  "allowInstanceProfile": true,
  "verbose": false
}

Types

`EntwineMergeTaskArgs`

Arguments for task entwine.merge.
See reference for more information: link

Field Name	Description
`config` - `String`
`threads` - `Int`
`profile` - `String`
`sse` - `Boolean`
`requesterPays` - `Boolean`
`allowInstanceProfile` - `Boolean`
`verbose` - `Boolean`
`force` - `Boolean`

Example

{
  "config": "xyz789",
  "threads": 987,
  "profile": "abc123",
  "sse": false,
  "requesterPays": true,
  "allowInstanceProfile": true,
  "verbose": true,
  "force": true
}

Types

`Float`

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

Example

987.65

Types

`ForceReference`

Field Name	Description
`id` - `ReferenceId`

Example

{"id": ReferenceId}

Types

`GdalInfoTaskArgs`

Arguments for task gdal.info.
See reference url for more information.

Field Name	Description
`mm` - `Boolean`
`stats` - `Boolean`
`approxStats` - `Boolean`
`hist` - `Boolean`
`nogcp` - `Boolean`
`nomd` - `Boolean`
`norat` - `Boolean`
`noct` - `Boolean`
`checksum` - `Boolean`
`listmdd` - `Boolean`
`mdd` - `String`
`nofl` - `Boolean`
`wktFormat` - `String`
`sd` - `Float`
`proj4` - `String`
`oo` - `[String]`
`if` - `String`

Example

{
  "mm": false,
  "stats": false,
  "approxStats": false,
  "hist": true,
  "nogcp": false,
  "nomd": false,
  "norat": false,
  "noct": false,
  "checksum": true,
  "listmdd": true,
  "mdd": "xyz789",
  "nofl": false,
  "wktFormat": "abc123",
  "sd": 123.45,
  "proj4": "xyz789",
  "oo": ["xyz789"],
  "if": "xyz789"
}

Types

`GdalMergeTaskArgs`

Arguments for task gdal.merge.
See reference url for more information.

Field Name	Description
`of` - `String`
`co` - `[String]`
`ot` - `String`
`ps` - `String`
`ulLr` - `String`
`separate` - `Boolean`
`pct` - `Boolean`
`n` - `Int`
`aNodata` - `Int`
`init` - `StringOrFloat`

Example

{
  "of": "abc123",
  "co": ["xyz789"],
  "ot": "abc123",
  "ps": "abc123",
  "ulLr": "xyz789",
  "separate": true,
  "pct": false,
  "n": 123,
  "aNodata": 987,
  "init": StringOrFloat
}

Types

`GdalTranslateTaskArgs`

Arguments for task gdal.translate.
See reference url for more information.

Field Name	Description
`ot` - `String`
`strict` - `Boolean`
`if` - `String`
`of` - `String`
`b` - `[String]`
`mask` - `Int`
`expand` - `String`
`outsize` - `String`
`tr` - `String`
`r` - `String`
`scale` - `String`
`exponent` - `Int`
`unscale` - `Boolean`
`srcwin` - `String`
`projwin` - `String`
`projwinSrs` - `String`
`epo` - `Boolean`
`eco` - `Boolean`
`aSrs` - `String`
`aScale` - `Float`
`aOffset` - `Float`
`aUllr` - `String`
`aNodata` - `Int`
`colorinterp1` - `String`
`colorinterp2` - `String`
`colorinterp3` - `String`
`colorinterp4` - `String`
`colorinterp` - `String`
`mo` - `[String]`
`co` - `[String]`
`nogcp` - `Boolean`
`gcp` - `String`
`sds` - `Boolean`
`stats` - `Boolean`
`norat` - `Boolean`
`noxmp` - `Boolean`
`oo` - `[String]`

Example

{
  "ot": "abc123",
  "strict": false,
  "if": "abc123",
  "of": "abc123",
  "b": ["abc123"],
  "mask": 987,
  "expand": "abc123",
  "outsize": "xyz789",
  "tr": "abc123",
  "r": "abc123",
  "scale": "xyz789",
  "exponent": 987,
  "unscale": true,
  "srcwin": "xyz789",
  "projwin": "xyz789",
  "projwinSrs": "xyz789",
  "epo": true,
  "eco": true,
  "aSrs": "abc123",
  "aScale": 987.65,
  "aOffset": 987.65,
  "aUllr": "xyz789",
  "aNodata": 123,
  "colorinterp1": "xyz789",
  "colorinterp2": "xyz789",
  "colorinterp3": "xyz789",
  "colorinterp4": "abc123",
  "colorinterp": "xyz789",
  "mo": ["xyz789"],
  "co": ["abc123"],
  "nogcp": false,
  "gcp": "xyz789",
  "sds": false,
  "stats": false,
  "norat": false,
  "noxmp": false,
  "oo": ["abc123"]
}

Types

`GdalWarpTaskArgs`

Arguments for task gdal.warp.
See reference url for more information.

Field Name	Description
`sSrs` - `String`
`tSrs` - `String`
`ct` - `String`
`to` - `[String]`
`noshiftgrid` - `Boolean`
`order` - `Int`
`tps` - `Boolean`
`rpc` - `Boolean`
`geoloc` - `Boolean`
`et` - `Float`
`refineGcps` - `Float`
`te` - `String`
`teSrs` - `String`
`tr` - `String`
`tap` - `Boolean`
`ts` - `String`
`ovr` - `String`
`wo` - `[String]`
`ot` - `String`
`wt` - `String`
`r` - `String`
`srcnodata` - `String`
`dstnodata` - `String`
`srcalpha` - `String`
`nosrcalpha` - `String`
`dstalpha` - `String`
`wm` - `Float`
`multi` - `Boolean`
`if` - `String`
`of` - `String`
`co` - `[String]`
`cutline` - `String`
`cl` - `String`
`cwhere` - `String`
`csql` - `String`
`cblend` - `String`
`cropToCutline` - `Boolean`
`overwrite` - `Boolean`
`nomd` - `Boolean`
`cvmd` - `String`
`setci` - `Boolean`
`oo` - `[String]`
`doo` - `[String]`

Example

{
  "sSrs": "abc123",
  "tSrs": "xyz789",
  "ct": "xyz789",
  "to": ["xyz789"],
  "noshiftgrid": false,
  "order": 987,
  "tps": true,
  "rpc": true,
  "geoloc": false,
  "et": 987.65,
  "refineGcps": 123.45,
  "te": "abc123",
  "teSrs": "xyz789",
  "tr": "xyz789",
  "tap": false,
  "ts": "xyz789",
  "ovr": "xyz789",
  "wo": ["abc123"],
  "ot": "xyz789",
  "wt": "xyz789",
  "r": "abc123",
  "srcnodata": "xyz789",
  "dstnodata": "xyz789",
  "srcalpha": "xyz789",
  "nosrcalpha": "abc123",
  "dstalpha": "xyz789",
  "wm": 123.45,
  "multi": true,
  "if": "abc123",
  "of": "xyz789",
  "co": ["xyz789"],
  "cutline": "abc123",
  "cl": "abc123",
  "cwhere": "xyz789",
  "csql": "xyz789",
  "cblend": "abc123",
  "cropToCutline": true,
  "overwrite": false,
  "nomd": false,
  "cvmd": "abc123",
  "setci": true,
  "oo": ["abc123"],
  "doo": ["abc123"]
}

Types

`GeoJSON`

GeoJSON custom scalar type

Example

object

Types

`GeoJSONBboxScalar`

Example

object

Types

`GeoJSONCRSType`

Enum Value	Description
`name`
`link`

Types

`GeoJSONCoordinateReferenceSystem`

Field Name	Description
`type` - `String!`

Example

{"type": "abc123"}

Types

`GeoJSONCoordinates`

Example

object

Types

`GeoJSONFeature`

Field Name	Description
`type` - `GeoJSONType!`
`crs` - `GeoJSONCoordinateReferenceSystem`
`bbox` - `[Float]`
`properties` - `JSONObject`
`id` - `String`

Example

{
  "type": GeoJSONType,
  "crs": GeoJSONCoordinateReferenceSystem,
  "bbox": [987.65],
  "properties": JSONObject,
  "id": "xyz789"
}

Types

`GeoJSONFeatureCollection`

Field Name	Description
`type` - `GeoJSONType!`
`crs` - `GeoJSONCoordinateReferenceSystem`
`bbox` - `[Float]`
`features` - `[GeoJSONFeature!]!`

Example

{
  "type": GeoJSONType,
  "crs": GeoJSONCoordinateReferenceSystem,
  "bbox": [123.45],
  "features": [GeoJSONFeature]
}

Types

`GeoJSONFeatureCollectionScalar`

Example

object

Types

`GeoJSONFeatureScalar`

Example

object

Types

`GeoJSONGeometryCollection`

Field Name	Description
`type` - `GeoJSONType!`
`crs` - `GeoJSONCoordinateReferenceSystem`
`bbox` - `[Float]`

Example

{
  "type": GeoJSONType,
  "crs": GeoJSONCoordinateReferenceSystem,
  "bbox": [987.65]
}

Types

`GeoJSONGeometryCollectionScalar`

Example

object

Types

`GeoJSONGeometryScalar`

Example

object

Types

`GeoJSONLineString`

Field Name	Description
`type` - `GeoJSONType!`
`crs` - `GeoJSONCoordinateReferenceSystem`
`bbox` - `[Float]`
`coordinates` - `GeoJSONCoordinates`

Example

{
  "type": GeoJSONType,
  "crs": GeoJSONCoordinateReferenceSystem,
  "bbox": [987.65],
  "coordinates": GeoJSONCoordinates
}

Types

`GeoJSONLineStringScalar`

Example

object

Types

`GeoJSONLinkedCRSProperties`

Field Name	Description
`href` - `String!`
`type` - `String`

Example

{"href": "abc123", "type": "xyz789"}

Types

`GeoJSONMultiLineString`

Field Name	Description
`type` - `GeoJSONType!`
`crs` - `GeoJSONCoordinateReferenceSystem`
`bbox` - `[Float]`
`coordinates` - `GeoJSONCoordinates`

Example

{
  "type": GeoJSONType,
  "crs": GeoJSONCoordinateReferenceSystem,
  "bbox": [987.65],
  "coordinates": GeoJSONCoordinates
}

Types

`GeoJSONMultiLineStringScalar`

Example

object

Types

`GeoJSONMultiPoint`

Field Name	Description
`type` - `GeoJSONType!`
`crs` - `GeoJSONCoordinateReferenceSystem`
`bbox` - `[Float]`
`coordinates` - `GeoJSONCoordinates`

Example

{
  "type": GeoJSONType,
  "crs": GeoJSONCoordinateReferenceSystem,
  "bbox": [987.65],
  "coordinates": GeoJSONCoordinates
}

Types

`GeoJSONMultiPointScalar`

Example

object

Types

`GeoJSONMultiPolygon`

Field Name	Description
`type` - `GeoJSONType!`
`crs` - `GeoJSONCoordinateReferenceSystem`
`bbox` - `[Float]`
`coordinates` - `GeoJSONCoordinates`

Example

{
  "type": GeoJSONType,
  "crs": GeoJSONCoordinateReferenceSystem,
  "bbox": [123.45],
  "coordinates": GeoJSONCoordinates
}

Types

`GeoJSONMultiPolygonScalar`

Example

object

Types

`GeoJSONNamedCRSProperties`

Field Name	Description
`name` - `String!`

Example

{"name": "abc123"}

Types

`GeoJSONPoint`

Field Name	Description
`type` - `GeoJSONType!`
`crs` - `GeoJSONCoordinateReferenceSystem`
`bbox` - `[Float]`
`coordinates` - `GeoJSONCoordinates`

Example

{
  "type": GeoJSONType,
  "crs": GeoJSONCoordinateReferenceSystem,
  "bbox": [123.45],
  "coordinates": GeoJSONCoordinates
}

Types

`GeoJSONPointScalar`

Example

object

Types

`GeoJSONPolygon`

Field Name	Description
`type` - `GeoJSONType!`
`crs` - `GeoJSONCoordinateReferenceSystem`
`bbox` - `[Float]`
`coordinates` - `GeoJSONCoordinates`

Example

{
  "type": GeoJSONType,
  "crs": GeoJSONCoordinateReferenceSystem,
  "bbox": [123.45],
  "coordinates": GeoJSONCoordinates
}

Types

`GeoJSONPolygonScalar`

Example

object

Types

`GeoJSONPositionScalar`

Example

object

Types

`GeoJSONType`

Enum Value	Description
`Point`
`MultiPoint`
`LineString`
`MultiLineString`
`Polygon`
`MultiPolygon`
`GeometryCollection`
`Feature`
`FeatureCollection`

Types

`ID`

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

Example

object

Types

`Instance`

Instance type

Field Name	Description
`id` - `ID!`	Instace ID
`title` - `String`	Instance Title
`description` - `String`	Instance description
`timestamps` - `Timestamps!`	Instance timestamps

Example

{
  "id": ID,
  "title": "abc123",
  "description": "xyz789",
  "timestamps": Timestamps
}

Types

`InstanceLinkResult`

Result for instance link

Field Name	Description
`success` - `Boolean!`

Example

{"success": false}

Types

`InstancesResult`

Result type for Instance

Field Name	Description
`items` - `[Instance!]!`	Collection of instances
`count` - `Int!`	Instance count

Example

{"items": [Instance], "count": 987}

Types

`Int`

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

`JSON`

The JSON scalar type represents JSON values as specified by ECMA-404.

Example

{}

Types

`JSONObject`

The JSONObject scalar type represents JSON objects as specified by ECMA-404.

Example

object

Types

`LinkLevel`

User Link Level enums

Enum Value	Description
`VIEWER`
`EDITOR`
`OWNER`

Types

`Location`

Field Name	Description
`test` - `String`
`path` - `String`
`URL` - `String`

Example

{"test": "abc123", "path": "abc123", "URL": "abc123"}

Types

`OdmRunTaskArgs`

Arguments for OpenDroneMap task odm.run.
See reference url for more information.

Field Name	Description
`buildOverviews` - `Boolean`
`cameraLens` - `String`
`cameras` - `String`
`crop` - `Float`
`debug` - `Boolean`
`demDecimation` - `Float`
`demEuclideanMap` - `Float`
`demGapfillSteps` - `Float`
`demResolution` - `Float`
`depthmapResolution` - `Float`
`dsm` - `Boolean`
`dtm` - `Boolean`
`edWith` - `String`
`fastOrthophoto` - `Boolean`
`featureQuality` - `String`
`featureType` - `String`
`forceGps` - `Boolean`
`gcp` - `String`
`geo` - `String`
`gpsAccuracy` - `Float`
`ignoreGsd` - `Boolean`
`matcherDistance` - `Float`
`matcherNeighbors` - `Int`
`matcherType` - `String`
`maxConcurrency` - `Int`
`merge` - `String`
`meshOctreeDepth` - `Int`
`meshSize` - `Int`
`minNumFeatures` - `Int`
`name` - `String`
`optimizeDiskSpace` - `Boolean`
`orthophotoCompression` - `String`
`orthophotoCutline` - `Boolean`
`orthophotoNoTiled` - `Boolean`
`orthophotoPng` - `Boolean`
`orthophotoResolution` - `Float`
`pcClassify` - `Boolean`
`pcCsv` - `Boolean`
`pcEpt` - `Boolean`
`pcFilter` - `Float`
`pcLas` - `Boolean`
`pcQuality` - `String`
`pcRectify` - `Boolean`
`pcSample` - `Int`
`pcTile` - `Boolean`
`primaryBand` - `String`
`projectPath` - `String`
`radiometricCalibration` - `String`
`rerun` - `String`
`rerunAll` - `Boolean`
`rerunFrom` - `String`
`resizeTo` - `Float`
`skip3dmodel` - `Boolean`
`skipBandAlignment` - `Boolean`
`skipReport` - `Boolean`
`smCluster` - `String`
`smrfScalar` - `Float`
`smrfSlope` - `Float`
`smrfThreshold` - `Float`
`smrfWindow` - `Float`
`split` - `Int`
`splitImageGroups` - `String`
`splitOverlap` - `Float`
`texturingDataTerm` - `String`
`texturingOutlierRemovalType` - `String`
`texturingSkipGlobalSeamLeveling` - `Boolean`
`texturingSkipLocalSeamLeveling` - `Boolean`
`texturingToneMapping` - `String`
`tiles` - `Boolean`
`time` - `Boolean`
`use3dmesh` - `Boolean`
`useExif` - `Boolean`
`useFixedCameraParams` - `Boolean`
`useHybridBundleAdjustment` - `Boolean`
`verbose` - `Boolean`

Example

{
  "buildOverviews": true,
  "cameraLens": "abc123",
  "cameras": "xyz789",
  "crop": 987.65,
  "debug": false,
  "demDecimation": 987.65,
  "demEuclideanMap": 987.65,
  "demGapfillSteps": 123.45,
  "demResolution": 123.45,
  "depthmapResolution": 987.65,
  "dsm": false,
  "dtm": false,
  "edWith": "abc123",
  "fastOrthophoto": false,
  "featureQuality": "xyz789",
  "featureType": "abc123",
  "forceGps": false,
  "gcp": "xyz789",
  "geo": "xyz789",
  "gpsAccuracy": 987.65,
  "ignoreGsd": true,
  "matcherDistance": 987.65,
  "matcherNeighbors": 123,
  "matcherType": "abc123",
  "maxConcurrency": 123,
  "merge": "xyz789",
  "meshOctreeDepth": 123,
  "meshSize": 987,
  "minNumFeatures": 987,
  "name": "abc123",
  "optimizeDiskSpace": false,
  "orthophotoCompression": "abc123",
  "orthophotoCutline": true,
  "orthophotoNoTiled": true,
  "orthophotoPng": false,
  "orthophotoResolution": 987.65,
  "pcClassify": false,
  "pcCsv": true,
  "pcEpt": false,
  "pcFilter": 987.65,
  "pcLas": false,
  "pcQuality": "xyz789",
  "pcRectify": false,
  "pcSample": 123,
  "pcTile": true,
  "primaryBand": "xyz789",
  "projectPath": "abc123",
  "radiometricCalibration": "abc123",
  "rerun": "xyz789",
  "rerunAll": true,
  "rerunFrom": "xyz789",
  "resizeTo": 123.45,
  "skip3dmodel": true,
  "skipBandAlignment": false,
  "skipReport": false,
  "smCluster": "xyz789",
  "smrfScalar": 987.65,
  "smrfSlope": 987.65,
  "smrfThreshold": 123.45,
  "smrfWindow": 123.45,
  "split": 123,
  "splitImageGroups": "xyz789",
  "splitOverlap": 123.45,
  "texturingDataTerm": "xyz789",
  "texturingOutlierRemovalType": "abc123",
  "texturingSkipGlobalSeamLeveling": false,
  "texturingSkipLocalSeamLeveling": true,
  "texturingToneMapping": "abc123",
  "tiles": false,
  "time": true,
  "use3dmesh": true,
  "useExif": false,
  "useFixedCameraParams": true,
  "useHybridBundleAdjustment": true,
  "verbose": false
}

Types

`Order`

Enum Value	Description
`ASC`
`DESC`

Types

`Page`

Input Field	Description
`first` - `Int` default = `100`
`after` - `Cursor`

Example

{"first": 100, "after": Cursor}

Types

`PdalFiltersCropOptions`

Options for pdal crop filter. See reference url for more information.

Field Name	Description
`polygon` - `String`
`outside` - `Boolean`
`point` - `String`
`distance` - `Float`
`aSrs` - `String`
`where` - `String`
`whereMerge` - `StringOrFloat`

Example

{
  "polygon": "abc123",
  "outside": true,
  "point": "abc123",
  "distance": 987.65,
  "aSrs": "abc123",
  "where": "xyz789",
  "whereMerge": StringOrFloat
}

Types

`PdalFiltersOptions`

Options for pdal filters

Field Name	Description
`crop` - `PdalFiltersCropOptions`
`sample` - `PdalFiltersSampleOptions`
`reprojection` - `PdalFiltersReprojectionOptions`

Example

{
  "crop": PdalFiltersCropOptions,
  "sample": PdalFiltersSampleOptions,
  "reprojection": PdalFiltersReprojectionOptions
}

Types

`PdalFiltersReprojectionOptions`

Options for pdal reprojection filter. See reference url for more information.

Field Name	Description
`inSrs` - `String`
`outSrs` - `String`
`inAxisOrdering` - `String`
`outAxisOrdering` - `String`

Example

{
  "inSrs": "xyz789",
  "outSrs": "xyz789",
  "inAxisOrdering": "xyz789",
  "outAxisOrdering": "abc123"
}

Types

`PdalFiltersSampleOptions`

Options for pdal sample filter. See reference url for more information.

Field Name	Description
`radius` - `Float`
`where` - `String`
`whereMerge` - `StringOrFloat`

Example

{
  "radius": 123.45,
  "where": "abc123",
  "whereMerge": StringOrFloat
}

Types

`PdalInfoTaskArgs`

Arguments for task pdal.info.
See reference url for more information.

Field Name	Description
`all` - `Boolean`
`point` - `Boolean`
`query` - `String`
`stats` - `Boolean`
`boundary` - `Boolean`
`dimensions` - `String`
`enumerate` - `String`
`schema` - `Boolean`
`summary` - `Boolean`
`metadata` - `Boolean`

Example

{
  "all": false,
  "point": false,
  "query": "abc123",
  "stats": true,
  "boundary": true,
  "dimensions": "xyz789",
  "enumerate": "abc123",
  "schema": false,
  "summary": true,
  "metadata": false
}

Types

`PdalMergeTaskArgs`

Arguments for task pdal.merge.
See reference url for more information.

Field Name	Description
`_` - `Boolean`	No args

Example

{"_": false}

Types

`PdalTranslateTaskArgs`

Arguments for task pdal.translate.
See reference url for more information.

Field Name	Description
`filters` - `PdalFiltersOptions`

Example

{"filters": PdalFiltersOptions}

Types

`PdalWritersE57Options`

Options for pdal e57 writer

Field Name	Description
`e57` - `PdalWritersE57OptionsArgs!`

Example

{"e57": PdalWritersE57OptionsArgs}

Types

`PdalWritersE57OptionsArgs`

Options for pdal e57 writer. See reference url for more information.

Field Name	Description
`doublePrecision` - `Boolean`

Example

{"doublePrecision": false}

Types

`PdalWritersGdalOptions`

Options for pdal gdal writer

Field Name	Description
`gdal` - `PdalWritersGdalOptionsArgs!`

Example

{"gdal": PdalWritersGdalOptionsArgs}

Types

`PdalWritersGdalOptionsArgs`

Options for pdal las writer. See reference url for more information.

Field Name	Description
`resolution` - `Float!`
`radius` - `Float`
`power` - `Float`
`gdaldriver` - `String`
`gdalopts` - `String`
`dataType` - `String`
`nodata` - `Float`
`outputType` - `String`
`windowSize` - `Float`
`dimension` - `String`
`bounds` - `String`
`originX` - `Float`
`originY` - `Float`
`width` - `Float`
`height` - `Float`

Example

{
  "resolution": 987.65,
  "radius": 987.65,
  "power": 987.65,
  "gdaldriver": "abc123",
  "gdalopts": "xyz789",
  "dataType": "abc123",
  "nodata": 123.45,
  "outputType": "abc123",
  "windowSize": 123.45,
  "dimension": "xyz789",
  "bounds": "abc123",
  "originX": 987.65,
  "originY": 123.45,
  "width": 123.45,
  "height": 123.45
}

Types

`PdalWritersLasOptions`

Options for pdal las writer

Field Name	Description
`las` - `PdalWritersLasOptionsArgs!`

Example

{"las": PdalWritersLasOptionsArgs}

Types

`PdalWritersLasOptionsArgs`

Options for pdal las writer. See reference url for more information.

Field Name	Description
`forward` - `String`
`minorVersion` - `String`
`softwareId` - `String`
`creationDoy` - `String`
`creationYear` - `String`
`dataformatId` - `String`
`systemId` - `String`
`aSrs` - `String`
`globalEncoding` - `String`
`projectId` - `String`
`compression` - `String`
`scaleX` - `StringOrFloat`
`scaleY` - `StringOrFloat`
`scaleZ` - `StringOrFloat`
`offsetX` - `StringOrFloat`
`offsetY` - `StringOrFloat`
`offsetZ` - `StringOrFloat`
`filesourceId` - `Float`
`discardHighReturnNumbers` - `Boolean`
`extraDims` - `String`
`pdalMetadata` - `Boolean`

Example

{
  "forward": "xyz789",
  "minorVersion": "abc123",
  "softwareId": "xyz789",
  "creationDoy": "abc123",
  "creationYear": "abc123",
  "dataformatId": "abc123",
  "systemId": "xyz789",
  "aSrs": "xyz789",
  "globalEncoding": "abc123",
  "projectId": "xyz789",
  "compression": "abc123",
  "scaleX": StringOrFloat,
  "scaleY": StringOrFloat,
  "scaleZ": StringOrFloat,
  "offsetX": StringOrFloat,
  "offsetY": StringOrFloat,
  "offsetZ": StringOrFloat,
  "filesourceId": 123.45,
  "discardHighReturnNumbers": true,
  "extraDims": "abc123",
  "pdalMetadata": false
}

Types

`PotreeConverterTaskArgs`

Arguments for task potreeconverter.convert. potreeconverter.convert is used to generate a streaming point cloud structure.
The output is in Potree 1.7 format.

Field Name	Description
`generatePage` - `String`
`spacing` - `Float`
`spacingByDiagonalFraction` - `Float`
`levels` - `Float`
`inputformat` - `String`
`colorRange` - `String`
`intensityRange` - `String`
`outputFormat` - `String`
`outputAttributes` - `String`
`scale` - `Float`
`aabb` - `String`
`incremental` - `Boolean`
`overwrite` - `Boolean`
`sourceListingOnly` - `Boolean`
`projection` - `String`
`listOfSourceFiles` - `String`
`sourceFile` - `String`
`title` - `String`
`description` - `String`
`edlEnabled` - `Boolean`
`showSkyBox` - `Boolean`
`material` - `String`

Example

{
  "generatePage": "abc123",
  "spacing": 123.45,
  "spacingByDiagonalFraction": 987.65,
  "levels": 123.45,
  "inputformat": "abc123",
  "colorRange": "xyz789",
  "intensityRange": "xyz789",
  "outputFormat": "abc123",
  "outputAttributes": "abc123",
  "scale": 123.45,
  "aabb": "abc123",
  "incremental": false,
  "overwrite": true,
  "sourceListingOnly": false,
  "projection": "abc123",
  "listOfSourceFiles": "xyz789",
  "sourceFile": "xyz789",
  "title": "abc123",
  "description": "xyz789",
  "edlEnabled": false,
  "showSkyBox": true,
  "material": "abc123"
}

Types

`ReferenceId`

Example

object

Types

`ReferenceType`

Enum Value	Description
`IMAGE_PLANAR`
`IMAGE_EQUIRECTANGULAR`
`FILE`
`USER`
`OAUTH2_CLIENT`
`WORKFLOW`
`RESOURCE`
`PIPELINE`
`INSTANCE`
`CLIENT`

Types

`Resource`

Resource type

Field Name	Description
`id` - `ID!`
`type` - `ResourceType`
`description` - `String`
`metadata` - `JSON`
`timestamps` - `Timestamps!`
`distance` - `Float`
Arguments `target` - `GeoJSON!`

Example

{
  "id": ID,
  "type": ResourceType,
  "description": "xyz789",
  "metadata": {},
  "timestamps": Timestamps,
  "distance": 123.45
}

Types

`ResourceDownloadTaskArgs`

Arguments for task resource.download. resource.download is used to transfer existing resources to a workflow.

Field Name	Description
`id` - `Int!`	Resource ID to download

Example

{"id": 987}

Types

`ResourceEnableTaskArgs`

Arguments for task resource.enable.
resource.enable is used to activate a resource after syncing. See resource.sync for syncing.

Field Name	Description
`_` - `Boolean`	No args

Example

{"_": false}

Types

`ResourceResult`

Type for resource result

Field Name	Description
`items` - `[Resource!]!`
`count` - `Int!`
`cursor` - `Cursor`

Example

{
  "items": [Resource],
  "count": 987,
  "cursor": Cursor
}

Types

`ResourceStatus`

Resource status

Enum Value	Description
`INACTIVE`
`PROCESSING`
`ACTIVE`

Types

`ResourceSyncTaskArgs`

Arguments for task resource.sync. Resource sync is used to create a new resource or update an existing one. A new resource will be created if no arguments are given.

Field Name	Description
`id` - `Int`	Optional resource Id for updating an existing resource

Example

{"id": 987}

Types

`ResourceType`

Types of resources available for query or mutations

Enum Value	Description
`POINTCLOUD`
`RASTER`
`VECTOR`
`MESH`
`IMAGE_PLANAR`
`IMAGE_EQUIRECTANGULAR`

Types

`ResourceUploadTaskArgs`

Arguments for task resource.upload.
resource.upload is used to upload synced data from tasks back to storage. See resource.sync for syncing.

Field Name	Description
`_` - `Boolean`	No args

Example

{"_": true}

Types

`Sort`

Input Field	Description
`by` - `Comparator`
`order` - `Order` default = `"DESC"`
`target` - `JSON`

Example

{
  "by": Comparator,
  "order": "DESC",
  "target": {}
}

Types

`SpatialQuery`

Input Field	Description
`type` - `SpatialQueryType!`
`target` - `GeoJSON!`
`inverse` - `Boolean`

Example

{
  "type": SpatialQueryType,
  "target": GeoJSON,
  "inverse": true
}

Types

`SpatialQueryType`

Enum Value	Description
`WITHIN`
`OVERLAPS`
`INTERSECTS`
`EQUALS`

Types

`StorageBucket`

Storage bucket type

Field Name	Description
`id` - `ID!`	Storage bucket ID
`bucketName` - `String!`	Storage Bucket name
`description` - `String`	Storage Bucket description

Example

{
  "id": ID,
  "bucketName": "xyz789",
  "description": "xyz789"
}

Types

`StorageBucketsResult`

Field Name	Description
`items` - `[StorageBucket!]!`
`count` - `Int!`
`cursor` - `Cursor`

Example

{
  "items": [StorageBucket],
  "count": 987,
  "cursor": Cursor
}

Types

`StorageObject`

Storage object type

Field Name	Description
`id` - `ID!`	Storage Object ID
`name` - `String!`	Storage Object name
`size` - `Int!`	Storage Object size
`metadata` - `JSONObject`	Storage Object meta data

Example

{
  "id": ID,
  "name": "xyz789",
  "size": 123,
  "metadata": JSONObject
}

Types

`StorageObjectsResult`

Field Name	Description
`items` - `[StorageObject!]!`
`count` - `Int!`
`cursor` - `Cursor`

Example

{
  "items": [StorageObject],
  "count": 987,
  "cursor": Cursor
}

Types

`String`

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Types

`StringOrFloat`

Scalar representing String or Float

Example

object

Types

`Subscription`

Type for Subscription

Field Name	Description
`workflowStatus` - `WorkflowStatus`	Workflow status subscription
Arguments `id` - `ID!`

Example

{"workflowStatus": WorkflowStatus}

Types

`SuccessResponse`

Type for Success Response

Field Name	Description
`success` - `Boolean`

Example

{"success": true}

Types

`Timestamps`

Field Name	Description
`updatedAt` - `Date!`
`createdAt` - `Date!`
`deletedAt` - `Date`

Example

{
  "updatedAt": "2021-06-30T09:27:53.870Z",
  "createdAt": "2020-12-30T10:27:53.870Z",
  "deletedAt": "2020-12-30T10:27:53.870Z"
}

Types

`Upload`

The Upload scalar type represents a file upload.

Example

object

Types

`User`

User type

Field Name	Description
`id` - `ID!`	User ID
`firstName` - `String`	First name
`lastName` - `String`	Last name
`email` - `String`	Email
`admin` - `Boolean`	Admin status
`status` - `UserStatus`	Status

Example

{
  "id": ID,
  "firstName": "abc123",
  "lastName": "xyz789",
  "email": "abc123",
  "admin": false,
  "status": UserStatus
}

Types

`UserLevel`

User Level enum

Enum Value	Description
`Viewer`
`Editor`
`Owner`

Types

`UserStatus`

User status enums

Enum Value	Description
`INACTIVE`
`ACTIVE`
`DISABLED`

Types

`UtilCombineTaskArgs`

Arguments for task util.combine. util.combine is used to combine separate resources as one.

Field Name	Description
`withPrefix` - `Boolean`	Use input folder path as filename prefix
`maintainStructure` - `Boolean`	Keep input folder structure
`allowOverwrite` - `Boolean`	Allow overwrite of files in case of duplicates

Example

{"withPrefix": false, "maintainStructure": false, "allowOverwrite": true}

Types

`UtilFlattenTaskArgs`

Arguments for task util.flatten.
util.flatten is used to flatten input folder structure.

Field Name	Description
`_` - `Boolean`	No arguments

Example

{"_": false}

Types

`UtilMoveTaskArgs`

Arguments for task util.move. util.move is used to move folders or files from input resource.

Field Name	Description
`pathIn` - `String`	Path for input files or folders
`pathOut` - `String`	Where contents of selected input will be moved to
`selector` - `String`	Wildcard for selecting files e.g. `*.tif`

Example

{"pathIn": "xyz789", "pathOut": "abc123", "selector": "abc123"}

Types

`UtilUnzipTaskArgs`

Arguments for task util.unzip.
Unzip is used to extract zip files.

Field Name	Description
`_` - `Boolean`	No args

Example

{"_": false}

Types

`WebDownloadTaskArgs`

Arguments for task web.download.
web.download is used to download files from URL's.

Field Name	Description
`url` - `String!`	Download url

Example

{"url": "abc123"}

Types

`Workflow`

Type for Workflow

Field Name	Description
`id` - `ID!`	Workflow ID
`title` - `String!`	Workflow title
`reports` - `[JSON!]`	Workflow reports
`debugging` - `JSON`	Workflow debugging info

Example

{
  "id": ID,
  "title": "abc123",
  "reports": [{}],
  "debugging": {}
}

Types

`WorkflowStatus`

Type for Workflow Status

Field Name	Description
`status` - `String!`

Example

{"status": "xyz789"}

Types

`WorkflowTask`

Type for WorkflowTask. Workflow tasks are used to defined the workflow graph. It is possible to build custom workflows by chaining different tasks. See workflow tasks for more documentation and examples.

Field Name	Description
`name` - object	Define the task name. The task name needs to be unique in the workflow context. The name is used as input for consecutive tasks in the workflow graph.
`type` - object	Define task type e.g. `pdal.info`. See tasks for available task types.
`args` - object	Task args. See tasks for available task args.
`inputs` - object	Define task inputs. Use task names as input values e.g. `["download"]`.

Example

{
  "name": "abc123",
  "type": "xyz789",
  "args": {},
  "inputs": ["xyz789"]
}

Types

`WorkflowsResult`

Type for Workflow Result

Field Name	Description
`items` - `[Workflow!]!`	Workflow items
`count` - `Int!`	Workflow item count
`cursor` - `Cursor`

Example

{
  "items": [Workflow],
  "count": 987,
  "cursor": Cursor
}

Types

`deleteStorageBucketResponse`

Result type for deleting a storage bucket

Field Name	Description
`success` - `Boolean`

Example

{"success": true}

Documentation by Anvil SpectaQL