Skip to main content
Workspace API fields use scalars, not bare string or number. Each scalar name has a namespace: Identity.UUID, Contact.Email, Temporal.DateTime. If you send a value in the wrong shape, the request fails with a 400 and changes nothing. The API reference shows the pattern, the length limits, and the description that each field gets from its scalar. The SDKs check the same rules before they send a request. Catalog responses use the same names: scalarRef in the data catalog and parableScalar in table shape statistics. The examples below show the canonical form. Many scalars accept other spellings and change them to the canonical form.

Artifact and Asset

Auth

Connector and Tap

Contact

Contact.PhoneNumber accepts the number alone, with its country code after a +. On the way in, it also accepts spaces, (, ), . and - between the digits, an extension such as ext. 3, and a tel: URI such as tel:+1-415-555-2671. It refuses letters, as in +1 800 FLOWERS, and text before the number, as in Phone: +1 415 555 2671. A tel: URI has no spaces. Before the check, it removes the byte order mark and the invisible zero-width and direction marks. The E.164 form drops the extension.

Crypto

Design

Embedding

File

Finance

Generic

Geo

Identity

All IDs use the same UUID family. When you send an ID back, send the base62 value that the API gave you.

Localization

Network

Parable

A Parable.Subject names a Parable and one target in it. Write each id in base62 with no leading zero, as the API writes ids. The revision of a Patch stays the same when another Patch publishes and moves this Patch onto the new Release. It changes each time the Patch is proposed again, for example after the person who started the Patch edits it. The revision is a positive integer with no leading zero, so each subject has one spelling. Parable.Permission values keep the tenant. prefix. In a permission name, tenant means the Workspace.

Temporal

A count scalar, such as Temporal.Minutes, is an amount of elapsed time, never a point in time. A point in time is always a Temporal.DateTime.

Text

Validation errors

An invalid value fails the whole request with a 400. The response lists each field that failed and the rule it broke. The request changes nothing.