DataAmp API

Query

Root query field

Retrieve a an item by its ID

Retrieve a unique item by its parent and unique-key

Get all items on a parent-object URN matching an optional filter

Mutation

Root mutation field

Create a new item

Update an existing item

Set an item's value

Delete an item

Objects

AddressValue

An item's value representing an address

The region in which the address is located. For example: Canton Zürich

The city in which the address is located. For example: Zürich

The street on which the address is located. For example: Schaffhauserstrasse

Address lines.

For example: ["434 Main Street"].

Address lines may hold components such as:

  • Building
  • Sub-Building
  • Premise number (house number)
  • Premise Range
  • Thoroughfare
  • Sub-Thoroughfare
  • Double-Dependent Locality
  • Sub-Locality

The name of the addressee. For example: Allthings Technologies AG

The postal code corresponding to the address. For example: 8001

Item

Datetime when the item was created

URN of the actor who created this item. E.g. urn:allthings:account:1234 or urn:allthings:oauth-client:1234

The parent object this item is associated with

The key-name of the item.

The value or data of the item.

ItemConfiguration

Can a user edit this item's value?

Should the key be unique? cannot be changed to true if duplicates already exist. if true new items with same key cannot be created.

If set - a future date when this Item should be automatically purged. This will trigger an 'item.expired' event when the expiration occurs.

Control the type of value when the item value is provided

ItemEdge

An Item edge

A cursor for use in pagination.

The item at the end of edge.

ItemMutationResult

ItemsConnection

An Item connection

A list of node edges

A list of nodes

Information for pagination

The total count of items in the connection.

JsonValue

An item's value representing any sort of JSON data.

OAuthClient

The OAuthClient's URN

PageInfo

Pagination information

An end cursor for use in pagination.

Indicates if there are more pages to fetch.

Indicates if there are any pages prior to the current page.

An start cursor for use in pagination.

Parent

The ID of the parent object (e.g. parent's foreign key)

User

The user's URN

Inputs

ItemConfigurationInput

Can a user edit this item's value?

should the key be unique? cannot be changed to true if duplicates already exist. if true new items with same key cannot be created.

If set - a future date when this Item should be automatically purged. This will trigger an 'item.expired' event when the expiration occurs.

Control the type of value when the item value is provided

ItemInput

ItemsFilter

Only return items with these keys

Maximum keys: 100

Enums

ItemValueType

ParentType

Scalars

Boolean

The Boolean scalar type represents true or false.

DateTime

Datetime scalar type

Float

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

ID

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

Int

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

JSON

JSON scalar type

KeyString

A string which matches /^([A-Za-z0-9-/])+$/gi. For example: "myItemKey"

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.

URN

A string which defines a URN. For example: "urn:allthings:app:82662ee4-0080-4960-8b8f-d7693e6ff3e4"

UrnPattern

Interfaces

MutationResult

Node

An object with an ID to support global identification.

The object's id

Datetime when the object was created

Value

An object that describes a item's value