Scalar Types

Boolean

The Boolean scalar type represents true or false.

CurrencyCode

ISO 4217 standard three-character code indicating the currency.

Examples:

• 'USD'
• 'CHF'

Date

Date in YYYY-MM-DD format.

Example: '2022-08-18'

Decimal

Decimal is a fixed-precision data type supporting exact representation of numeric values.

Example: 105.92851

EntryType

String value for an entry type.

Example: 'ACH_CR'

Expression

A literal CEL expression to be evaluated.

ExpressionMap

A map of literal CEL expressions to be evaluated in a shared context Ex: { "two": "this.one + 1", "one": "2 - 1", "sqrt2": "math.Sqrt(double(2))", "now": "time.Now()" }

ExpressionNestedMap

A nested map of literal CEL expressions to be evaluated in a shared context Ex: { "two": "this.one + 1", "one": "2 - 1", "sqrt2": "math.Sqrt(double(2))", "now": "time.Now()", "obj": { "foo": "'bar'" } }

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.

InterpolatedExpression

Interpolated string expression. Values within {{}} are evaluated as a CEL expression.

Examples:

• Current time: {{time.Now()}} => "Current time: 2022-04-27T10:50:00.000Z"
• Raw String => "Raw String"
• {{uuid.New()}} => "9dd984db-78d8-420f-9380-80e3cf36fe75"

JSON

JSON object.

Example: { "counts": 12, "name": "Metric A" }

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.

Timestamp

RFC3339-compliant UTC timestamp.

Example: '2022-04-27T10:50:00.000Z'

UUID

128-bit universally unique identifier (UUID). Used for most ID fields on records.

Example: '3ea12e45-7df2-4293-9434-feb792affc91'

Uint8Array

Uint8Array is a []uint8 of big-endian encoded binary data

Value

Value object. Similar to the JSON object with support for type coersion

Example: { "int": 12, "float": 1.732, "uuid": "D3DC5ED3-23D0-4924-BAE1-9AA026BACE09"}