API Reference
/
Workspaces

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.bndry.net/_mock/apis/openapi/

Form Definitions

Operations

Workspaces

Operations

GetWorkspace

Request

Gets a workspace.

Path
namestring(name)required

The resource name of the workspace to retrieve.

Format: workspaces/{workspace}

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/api/v1alpha/{name=workspaces/*}'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the workspace.

Format: workspaces/{workspace}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

A human-readable name for display purposes.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the workspace was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the workspace was last updated.

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities that are associated with this workspace.

Format: entities/{entity}

statestring(bndry.api.forms.v1alpha.Workspace.State)read-only

The state of the workspace.

Enum"STATE_UNSPECIFIED""OPEN""CLOSED"
Response
application/json
{
  "name": "string",
  "displayName": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "entities": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

ListWorkspaces

Request

Lists all workspaces available to the user.

Query
pageSizeinteger(int32)(page_size)

The maximum number of workspaces to return. The service may return fewer than this value.

pageTokenstring(page_token)

A page token, received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page.

skipinteger(int32)(skip)

The number of individual resources to skip in the paginated results. This value allows the user to skip a specific number of results.

For example:

  • A request with no page token and a skip value of 30 returns a single page of results starting with the 31st result.
  • A request with a page token corresponding to the 51st result (because the first 50 results were returned on the first page) and a skip value of 30 returns a single page of results starting with the 81st result.

If the skip value causes the cursor to move past the end of the collection of results, the response will be 200 OK with an empty result set and no next_page_token.

filterstring(filter)

An optional filter to restrict the workspaces returned (see https://google.aip.dev/160). The following fields are supported for filtering:

  • entities: The entities associated with the workspace.
curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/api/v1alpha/workspaces?filter=string&pageSize=0&pageToken=string&skip=0'

Responses

Success

Bodyapplication/json
workspacesArray of objects(workspaces)

The list of workspaces.

nextPageTokenstring(next_page_token)

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to ListWorkspaces method to retrieve the next page of results.

totalSizeinteger(int32)(total_size)

The total number of workspaces.

Response
application/json
{
  "workspaces": [
    { … }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

CreateWorkspace

Request

Creates a new workspace.

Bodyapplication/json

The workspace to create.

namestring(name)

(IDENTIFIER) The resource name of the workspace.

Format: workspaces/{workspace}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

A human-readable name for display purposes.

formDefinitionsArray of strings(form_definitions)write-only

(IMMUTABLE) The resource names of the form definitions that will be used to create the initial set of workspace forms.

buf:lint:ignore AIP_CORE_0203_FIELD_BEHAVIOR_REQUIRED

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities that are associated with this workspace.

Format: entities/{entity}

curl -i -X POST \
  https://docs.bndry.net/_mock/apis/openapi/api/v1alpha/workspaces \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "string",
    "formDefinitions": [
      "string"
    ],
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "entities": [
      "string"
    ],
    "state": "STATE_UNSPECIFIED"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the workspace.

Format: workspaces/{workspace}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

A human-readable name for display purposes.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the workspace was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the workspace was last updated.

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities that are associated with this workspace.

Format: entities/{entity}

statestring(bndry.api.forms.v1alpha.Workspace.State)read-only

The state of the workspace.

Enum"STATE_UNSPECIFIED""OPEN""CLOSED"
Response
application/json
{
  "name": "string",
  "displayName": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "entities": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

UpdateWorkspace

Request

Updates a workspace.

Path
workspace.namestring(name)required

(IDENTIFIER) The resource name of the workspace.

Format: workspaces/{workspace}

Bodyapplication/json

The workspace to update.

namestring(name)

(IDENTIFIER) The resource name of the workspace.

Format: workspaces/{workspace}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

A human-readable name for display purposes.

formDefinitionsArray of strings(form_definitions)write-only

(IMMUTABLE) The resource names of the form definitions that will be used to create the initial set of workspace forms.

buf:lint:ignore AIP_CORE_0203_FIELD_BEHAVIOR_REQUIRED

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities that are associated with this workspace.

Format: entities/{entity}

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/api/v1alpha/{workspace.name=workspaces/*}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "string",
    "formDefinitions": [
      "string"
    ],
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "entities": [
      "string"
    ],
    "state": "STATE_UNSPECIFIED"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the workspace.

Format: workspaces/{workspace}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

A human-readable name for display purposes.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the workspace was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the workspace was last updated.

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities that are associated with this workspace.

Format: entities/{entity}

statestring(bndry.api.forms.v1alpha.Workspace.State)read-only

The state of the workspace.

Enum"STATE_UNSPECIFIED""OPEN""CLOSED"
Response
application/json
{
  "name": "string",
  "displayName": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "entities": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

CloseWorkspace

Request

Closes a workspace. The state of the workspace after closing is CLOSED. CloseWorkspace can be called on Workspaces in the state OPEN; Workspaces in a different state (including CLOSED) return an error.

Path
namestring(name)required

The resource name of the workspace to close.

Format: workspaces/{workspace}

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/api/v1alpha/{name=workspaces/*}:close'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the workspace.

Format: workspaces/{workspace}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

A human-readable name for display purposes.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the workspace was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the workspace was last updated.

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities that are associated with this workspace.

Format: entities/{entity}

statestring(bndry.api.forms.v1alpha.Workspace.State)read-only

The state of the workspace.

Enum"STATE_UNSPECIFIED""OPEN""CLOSED"
Response
application/json
{
  "name": "string",
  "displayName": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "entities": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

CreateWorkspaceMagicLink

Request

CreateWorkspaceMagicLink will create a magic link for the given workspace.

Path
namestring(name)required

The resource name of the workspace to close.

Format: workspaces/{workspace}

Bodyapplication/jsonrequired
emailstring(email)(email)required

The email address to create a magic link for.

expirationInSecondsinteger(int32)(expiration_in_seconds)

(OPTIONAL) The number of seconds the magic link should be valid for. It will default to 1 week.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/api/v1alpha/{name=workspaces/*}:createWorkspaceMagicLink' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com",
    "expirationInSeconds": 0
  }'

Responses

Success

Bodyapplication/json
magicLinkstring(magic_link)

The magic link to send to the user.

Response
application/json
{
  "magicLink": "string"
}

GetWorkspaceForm

Request

Gets a form in the specified workspace.

Path
namestring(name)required

The resource name of the workspace form to retrieve.

Format: workspaces/{workspace}/forms/{form}

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/api/v1alpha/{name=workspaces/*/forms/*}'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the workspace form.

formDefinitionstring(form_definition)

(IMMUTABLE) The resource name of the form definition that this form was created from.

formkitSchemaobject(bndry.api.forms.v1alpha.FormKitSchema)read-only

The FormKit schema that describes this form.

responseobject(google.protobuf.Struct)required

The response to the form.

response.​property name*null or number or string or boolean or Array of arrays or object(google.protobuf.Value)additional property

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

One of:

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

null

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the form was added to the workspace.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the form was last updated through this workspace.

etagstring(etag)

A checksum computed by the server based on the value of other fields. The etag may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Response
application/json
{
  "name": "string",
  "formDefinition": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "response": {
    "property1": {},
    "property2": {}
  },
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "etag": "string"
}

UpdateWorkspaceForm

Request

Updates a form in the specified workspace.

Path
workspace_form.namestring(name)required

(IDENTIFIER) The resource name of the workspace form.

Bodyapplication/json

The workspace form to update.

namestring(name)

(IDENTIFIER) The resource name of the workspace form.

formDefinitionstring(form_definition)

(IMMUTABLE) The resource name of the form definition that this form was created from.

responseobject(google.protobuf.Struct)required

The response to the form.

response.​property name*null or number or string or boolean or Array of arrays or object(google.protobuf.Value)additional property

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

One of:

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

null

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

etagstring(etag)

A checksum computed by the server based on the value of other fields. The etag may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/api/v1alpha/{workspace_form.name=workspaces/*/forms/*}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "formDefinition": "string",
    "formkitSchema": {
      "nodes": {
        "values": [
          {}
        ]
      }
    },
    "response": {
      "property1": {},
      "property2": {}
    },
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "etag": "string"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the workspace form.

formDefinitionstring(form_definition)

(IMMUTABLE) The resource name of the form definition that this form was created from.

formkitSchemaobject(bndry.api.forms.v1alpha.FormKitSchema)read-only

The FormKit schema that describes this form.

responseobject(google.protobuf.Struct)required

The response to the form.

response.​property name*null or number or string or boolean or Array of arrays or object(google.protobuf.Value)additional property

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

One of:

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

null

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the form was added to the workspace.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

The timestamp when the form was last updated through this workspace.

etagstring(etag)

A checksum computed by the server based on the value of other fields. The etag may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Response
application/json
{
  "name": "string",
  "formDefinition": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "response": {
    "property1": {},
    "property2": {}
  },
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "etag": "string"
}

ListWorkspaceForms

Request

Lists all forms in the specified workspace.

Path
parentstring(parent)required

The resource name of the workspace to list forms for.

Format: workspaces/{workspace}

Query
pageSizeinteger(int32)(page_size)

The maximum number of forms to return. The service may return fewer than this value.

pageTokenstring(page_token)

A page token, received from a previous ListWorkspaceForms call. Provide this to retrieve the subsequent page.

skipinteger(int32)(skip)

The number of individual resources to skip in the paginated results. This value allows the user to skip a specific number of results.

For example:

  • A request with no page token and a skip value of 30 returns a single page of results starting with the 31st result.
  • A request with a page token corresponding to the 51st result (because the first 50 results were returned on the first page) and a skip value of 30 returns a single page of results starting with the 81st result.

If the skip value causes the cursor to move past the end of the collection of results, the response will be 200 OK with an empty result set and no next_page_token.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/api/v1alpha/{parent=workspaces/*}/forms?pageSize=0&pageToken=string&skip=0'

Responses

Success

Bodyapplication/json
workspaceFormsArray of objects(workspace_forms)

The list of forms in the workspace.

nextPageTokenstring(next_page_token)

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to ListWorkspaceForms method to retrieve the next page of results.

totalSizeinteger(int32)(total_size)

The total number of forms in the workspace.

Response
application/json
{
  "workspaceForms": [
    { … }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

Entities

Operations