Update a workspace

API Reference

Workspaces

Update a workspace

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

https://docs.bndry.net/_mock/apis/openapi/

Documents

Service for managing documents.

Operations

Form Definitions

Service for managing form definitions.

Operations

FormService

Operations

Workspaces

Service for managing workspaces and their associated forms and documents.

Operations

Retrieve a workspace

Request

Retrieves a workspace.

Path

workspacestringrequired

The workspace id.

Query

namestring(name)required

Required. The resource name of the workspace to retrieve. Format: workspaces/{workspace}

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

Responses

Success

Bodyapplication/json

namestring(name)

(IDENTIFIER) The resource name of the workspace. Format: workspaces/{workspace}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

Required. A mutable, user-settable field for providing a human-readable name for the workspace, to be used in user interfaces. Must be <= 63 characters.

formDefinitionsArray of strings(form_definitions)

(IMMUTABLE) The resource names of the form definitions used to create the initial set of forms in the workspace. Format: formDefinitions/{form_definition}

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

Output only. The timestamp when the workspace was created.

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

Output only. The timestamp when the workspace was most recently updated.

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities associated with the workspace. Format: entities/{entity}

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

Output only. The current state of the workspace.

Enum"STATE_UNSPECIFIED""OPEN""CLOSED"

Response

application/json

{
  "name": "string",
  "displayName": "string",
  "formDefinitions": [
    "string"
  ],
  "createTime": "1s",
  "updateTime": "1s",
  "entities": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

Update a workspace

Request

Updates a workspace.

Path

workspacestringrequired

The workspace id.

Bodyapplication/json

Required. The workspace to update.

The workspace's name field is used to identify the workspace to update. Format: workspaces/{workspace}

namestring(name)

(IDENTIFIER) The resource name of the workspace. Format: workspaces/{workspace}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

Required. A mutable, user-settable field for providing a human-readable name for the workspace, to be used in user interfaces. Must be <= 63 characters.

formDefinitionsArray of strings(form_definitions)

(IMMUTABLE) The resource names of the form definitions used to create the initial set of forms in the workspace. Format: formDefinitions/{form_definition}

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities associated with the workspace. Format: entities/{entity}

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/workspaces/{workspace}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "string",
    "formDefinitions": [
      "string"
    ],
    "createTime": "1s",
    "updateTime": "1s",
    "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

Required. A mutable, user-settable field for providing a human-readable name for the workspace, to be used in user interfaces. Must be <= 63 characters.

formDefinitionsArray of strings(form_definitions)

(IMMUTABLE) The resource names of the form definitions used to create the initial set of forms in the workspace. Format: formDefinitions/{form_definition}

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

Output only. The timestamp when the workspace was created.

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

Output only. The timestamp when the workspace was most recently updated.

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities associated with the workspace. Format: entities/{entity}

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

Output only. The current state of the workspace.

Enum"STATE_UNSPECIFIED""OPEN""CLOSED"

Response

application/json

{
  "name": "string",
  "displayName": "string",
  "formDefinitions": [
    "string"
  ],
  "createTime": "1s",
  "updateTime": "1s",
  "entities": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

List all workspaces

Request

Lists workspaces.

Query

pageSizeinteger(int32)(page_size)

Optional. The maximum number of workspaces to return. The service may return fewer than this value. If unspecified, at most 50 workspaces will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring(page_token)

Optional. A page token, received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

skipinteger(int32)(skip)

Optional. The number of workspaces to skip before starting to collect the result set.

filterstring(filter)

Optional. A filter expression that filters the results listed in the response. See AIP-160 for more details.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/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, or empty if there are no more results in the list.

totalSizeinteger(int32)(total_size)

The total number of workspaces matching the request.

Response

application/json

{
  "workspaces": [
    { … }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

Create a workspace

Request

Creates a new workspace.

Bodyapplication/json

Required. The workspace to create.

namestring(name)

(IDENTIFIER) The resource name of the workspace. Format: workspaces/{workspace}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

Required. A mutable, user-settable field for providing a human-readable name for the workspace, to be used in user interfaces. Must be <= 63 characters.

formDefinitionsArray of strings(form_definitions)

(IMMUTABLE) The resource names of the form definitions used to create the initial set of forms in the workspace. Format: formDefinitions/{form_definition}

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities associated with the workspace. Format: entities/{entity}

curl -i -X POST \
  https://docs.bndry.net/_mock/apis/openapi/v1alpha/workspaces \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "string",
    "formDefinitions": [
      "string"
    ],
    "createTime": "1s",
    "updateTime": "1s",
    "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

Required. A mutable, user-settable field for providing a human-readable name for the workspace, to be used in user interfaces. Must be <= 63 characters.

formDefinitionsArray of strings(form_definitions)

(IMMUTABLE) The resource names of the form definitions used to create the initial set of forms in the workspace. Format: formDefinitions/{form_definition}

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

Output only. The timestamp when the workspace was created.

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

Output only. The timestamp when the workspace was most recently updated.

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities associated with the workspace. Format: entities/{entity}

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

Output only. The current state of the workspace.

Enum"STATE_UNSPECIFIED""OPEN""CLOSED"

Response

application/json

{
  "name": "string",
  "displayName": "string",
  "formDefinitions": [
    "string"
  ],
  "createTime": "1s",
  "updateTime": "1s",
  "entities": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

Close a workspace

Request

Closes a workspace.

Path

workspacestringrequired

The workspace id.

Bodyapplication/jsonrequired

namestring(name)required

Required. The resource name of the workspace to close. Format: workspaces/{workspace}

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/workspaces/{workspace}:close' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

Success

Bodyapplication/json

namestring(name)

(IDENTIFIER) The resource name of the workspace. Format: workspaces/{workspace}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

Required. A mutable, user-settable field for providing a human-readable name for the workspace, to be used in user interfaces. Must be <= 63 characters.

formDefinitionsArray of strings(form_definitions)

(IMMUTABLE) The resource names of the form definitions used to create the initial set of forms in the workspace. Format: formDefinitions/{form_definition}

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

Output only. The timestamp when the workspace was created.

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

Output only. The timestamp when the workspace was most recently updated.

entitiesArray of strings(entities)

(UNORDERED_LIST) (OPTIONAL) The resource names of the entities associated with the workspace. Format: entities/{entity}

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

Output only. The current state of the workspace.

Enum"STATE_UNSPECIFIED""OPEN""CLOSED"

Response

application/json

{
  "name": "string",
  "displayName": "string",
  "formDefinitions": [
    "string"
  ],
  "createTime": "1s",
  "updateTime": "1s",
  "entities": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

Create a workspace magic link

Request

Creates a magic link for a user to access a workspace.

Path

workspacestringrequired

The workspace id.

Bodyapplication/jsonrequired

namestring(name)required

Required. The resource name of the workspace for which to create a magic link. Format: workspaces/{workspace}

emailstring(email)(email)required

Required. Email address associated with the User to generate the magic link for. If a user does not exist with this email, they will be created.

expirationSecondsTimestring(date-time)(google.protobuf.Timestamp)

(OPTIONAL) Optional. The expiration time of the magic link. If not provided, defaults to 1 day.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/workspaces/{workspace}:createWorkspaceMagicLink' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "email": "user@example.com",
    "expirationSecondsTime": "1s"
  }'

Responses

Success

Bodyapplication/json

magicLinkstring(magic_link)

The generated magic link URL.

Response

application/json

{
  "magicLink": "string"
}

Retrieve a workspace form

Request

Retrieves a form for a given workspace.

Path

workspacestringrequired

The workspace id.

formstringrequired

The form id.

Query

namestring(name)required

Required. The resource name of the workspace form to retrieve. Format: forms/{form} Format: workspaces/{workspace}/forms/{form}

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

Responses

Success

Bodyapplication/json

namestring(name)

(IDENTIFIER) The resource name of the form. Format: forms/{form} Format: workspaces/{workspace}/forms/{form}

formDefinitionstring(form_definition)

(IMMUTABLE) Immutable. The resource name of the form definition used to create this form. Format: formDefinitions/{form_definition}

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

Output only. The schema of the form, derived from the form definition.

responseobject(google.protobuf.Struct)required

Required. The responses to the form questions, stored as a JSON object.

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:

The JSON representation for Value is JSON value.

null

The JSON representation for Value is JSON value.

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

Output only. The timestamp when the form was created.

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

Output only. The timestamp when the form was most recently updated.

etagstring(etag)

(OPTIONAL) Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154.

displayNamestring(display_name)

(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable name for the form, to be used in user interfaces. Must be <= 63 characters.

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

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

Output only. The current state of the form. State can be changed using custom methods like CloseForm or SubmitForm.

Enum"STATE_UNSPECIFIED""OPEN""EXPIRED""SUBMITTED"

Response

application/json

{
  "name": "string",
  "formDefinition": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "response": {
    "property1": {},
    "property2": {}
  },
  "createTime": "1s",
  "updateTime": "1s",
  "etag": "string",
  "displayName": "string",
  "workspaces": [
    "string"
  ],
  "automations": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

Update a workspace form

Request

Updates a workspace form.

Path

workspacestringrequired

The workspace id.

formstringrequired

The form id.

Bodyapplication/json

namestring(name)

(IDENTIFIER) The resource name of the form. Format: forms/{form} Format: workspaces/{workspace}/forms/{form}

formDefinitionstring(form_definition)

(IMMUTABLE) Immutable. The resource name of the form definition used to create this form. Format: formDefinitions/{form_definition}

responseobject(google.protobuf.Struct)required

Required. The responses to the form questions, stored as a JSON object.

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

The JSON representation for Value is JSON value.

One of:

The JSON representation for Value is JSON value.

null

The JSON representation for Value is JSON value.

etagstring(etag)

(OPTIONAL) Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154.

displayNamestring(display_name)

(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable name for the form, to be used in user interfaces. Must be <= 63 characters.

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/workspaces/{workspace}/forms/{form}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "formDefinition": "string",
    "formkitSchema": {
      "nodes": {
        "values": [
          {}
        ]
      }
    },
    "response": {
      "property1": {},
      "property2": {}
    },
    "createTime": "1s",
    "updateTime": "1s",
    "etag": "string",
    "displayName": "string",
    "workspaces": [
      "string"
    ],
    "automations": [
      "string"
    ],
    "state": "STATE_UNSPECIFIED"
  }'

Responses

Success

Bodyapplication/json

namestring(name)

(IDENTIFIER) The resource name of the form. Format: forms/{form} Format: workspaces/{workspace}/forms/{form}

formDefinitionstring(form_definition)

(IMMUTABLE) Immutable. The resource name of the form definition used to create this form. Format: formDefinitions/{form_definition}

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

Output only. The schema of the form, derived from the form definition.

responseobject(google.protobuf.Struct)required

Required. The responses to the form questions, stored as a JSON object.

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

The JSON representation for Value is JSON value.

One of:

The JSON representation for Value is JSON value.

null

The JSON representation for Value is JSON value.

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

Output only. The timestamp when the form was created.

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

Output only. The timestamp when the form was most recently updated.

etagstring(etag)

(OPTIONAL) Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154.

displayNamestring(display_name)

(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable name for the form, to be used in user interfaces. Must be <= 63 characters.

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

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

Output only. The current state of the form. State can be changed using custom methods like CloseForm or SubmitForm.

Enum"STATE_UNSPECIFIED""OPEN""EXPIRED""SUBMITTED"

Response

application/json

{
  "name": "string",
  "formDefinition": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "response": {
    "property1": {},
    "property2": {}
  },
  "createTime": "1s",
  "updateTime": "1s",
  "etag": "string",
  "displayName": "string",
  "workspaces": [
    "string"
  ],
  "automations": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

List all workspace forms

Request

Lists forms for a given workspace.

Path

workspacestringrequired

The workspace id.

Query

parentstring(parent)required

Required. The parent workspace for which to list forms. Format: forms/ Format: workspaces/{workspace}

pageSizeinteger(int32)(page_size)

Optional. The maximum number of forms to return. The service may return fewer than this value. If unspecified, at most 50 forms will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring(page_token)

Optional. A page token, received from a previous ListWorkspaceForms call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaceForms must match the call that provided the page token.

skipinteger(int32)(skip)

Optional. The number of forms to skip before starting to collect the result set.

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

Responses

Success

Bodyapplication/json

formsArray of objects(forms)

The list of workspace forms.

nextPageTokenstring(next_page_token)

A token to retrieve the next page of results, or empty if there are no more results in the list.

totalSizeinteger(int32)(total_size)

The total number of forms matching the request.

Response

application/json

{
  "forms": [
    { … }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

List all workspace documents

Request

Lists documents for a given workspace.

Path

workspacestringrequired

The workspace id.

Query

parentstring(parent)required

Required. The parent workspace for which to list documents. Format: workspaces/{workspace}

pageSizeinteger(int32)(page_size)

Optional. The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 50 documents will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring(page_token)

Optional. A page token, received from a previous ListWorkspaceDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaceDocuments must match the call that provided the page token.

skipinteger(int32)(skip)

Optional. The number of documents to skip before starting to collect the result set.

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

Responses

Success

Bodyapplication/json

documentsArray of objects(documents)

The list of documents.

nextPageTokenstring(next_page_token)

A token to retrieve the next page of results, or empty if there are no more results in the list.

totalSizeinteger(int32)(total_size)

The total number of documents matching the request.

Response

application/json

{
  "documents": [
    { … }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

Automations

Service for managing and executing automations.

Operations

NotesService

Operations

Tenants

Service for managing tenants.

Operations

Entities

Operations

TruuthService

TruuthService provides an API for the BNDRY SPA to initiate a new verification session with Truuth

Operations

Documents

Form Definitions

FormService

Workspaces

Retrieve a workspace

Request

Responses

Was this helpful?

Update a workspace

Request

Responses

Was this helpful?

List all workspaces

Request

Responses

Was this helpful?

Create a workspace

Request

Responses

Was this helpful?

Close a workspace

Request

Responses

Was this helpful?

Create a workspace magic link

Request

Responses

Was this helpful?

Retrieve a workspace form

Request

Responses

Was this helpful?

Update a workspace form

RequestExpand all

Responses

Was this helpful?

List all workspace forms

Request

Responses

Was this helpful?

List all workspace documents

Request

Responses

Was this helpful?

Automations

NotesService

Tenants

Entities

TruuthService

Request