Create a workspace variable

Updated on Nov 5, 2024
Published on Aug 22, 2023

4 minute(s) read

Post

/v1alpha/workspace_variables

Creates a new workspace variable. Workspace variables are key-value pairs or tables accessible from all the workspace workflows and retained until manually deleted. For an example of creating a table using this API, refer to our Knowledge Base.

Security

HTTP

Type bearer

Body parameters

Collapse all

object

pretty_name

string Required

The pretty name of the workspace variable. This is the name as it will appear in the UI. The pretty name can include alphanumerics, underscores, hyphens, and spaces. The workspace variable name will have the hyphens and spaces converted to underscores and all lowercase letters.

ExampleMy Variable

value

object

The value of the workspace variable to create. For a string variable, enclose the value in quotation marks; use true/false for booleans; numbers and JSON objects can also be provided.

Example

table

object (v1alphaTable)

json

object

boolean

number

number (double)

text

string

Responses

200

401

403

default

A successful response.

Collapse all

object

variable

object (v1alphaWorkspaceVariable)

account_id

string

The ID of the workspace where the variable lives.

name

string

The name of the workspace variable.

pretty_name

string

The pretty name of the workspace variable. This is the name as it will appear in the UI.

value

object

The value of the workspace variable.

updated_by

object (v1alphaActor)

updated_at

string (date-time)

The timestamp when the workspace variable was last updated.

created_by

object (v1alphaActor)

created_at

string (date-time)

The timestamp when the workspace variable was created.

string

The unique identifier of the workspace variable.

sharing_data

object (v1alphaSharingData)

table

object (v1alphaTable)

json

object

boolean

number

number (double)

text

string

preview

string

An unexpected error response.

Collapse all

object

code

integer (int32)

message

string

details

Array of object (protobufAny)

object

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo))

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) // or ... if (any.isSameTypeAs(Foo.getDefaultInstance()))

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo any, err := anypb.New(foo) if err != nil ... foo := &pb.Foo if err := any.UnmarshalTo(foo); err != nil

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile; message Person

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

@type

string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

If no scheme is provided, https is assumed.
An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

property*

object additionalProperties

Was this article helpful?