Create a form definition

API Reference

Form Definitions

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

List all form definitions

Request

Lists form definitions.

Query

pageSizeinteger(int32)(page_size)

Optional. The maximum number of form definitions to return. The service may return fewer than this value. If unspecified, at most 50 form definitions 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 ListFormDefinitions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListFormDefinitions must match the call that provided the page token.

showDeletedboolean(show_deleted)

Optional. If true, soft-deleted form definitions will be included in the response. See AIP-164.

skipinteger(int32)(skip)

Optional. The number of form definitions 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/formDefinitions?filter=string&pageSize=0&pageToken=string&showDeleted=true&skip=0'

Responses

Success

Bodyapplication/json

formDefinitionsArray of objects(form_definitions)

The list of form definitions.

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 form definitions matching the request.

Response

application/json

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

Create a form definition

Request

Creates a new form definition.

Bodyapplication/json

Required. The form definition to create.

displayNamestring(display_name)

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

descriptionstring(description)

(OPTIONAL) Optional. A description of the form definition.

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)required

Required. The schema of the form, defined using FormKit.

formkitSchema.nodesobject(google.protobuf.ListValue)required

ListValue is a wrapper around a repeated field of values.

The JSON representation for ListValue is JSON array.

formkitSchema.nodes.valuesArray of null or numbers or strings or booleans or Array of arrays or objects(values)

Repeated field of dynamically typed values.

etagstring(etag)

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

curl -i -X POST \
  https://docs.bndry.net/_mock/apis/openapi/v1alpha/formDefinitions \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "string",
    "description": "string",
    "formkitSchema": {
      "nodes": {
        "values": [
          {}
        ]
      }
    },
    "createTime": "1s",
    "updateTime": "1s",
    "purgeTime": "1s",
    "etag": "string"
  }'

Responses

Success

Bodyapplication/json

namestring(name)read-only

(IDENTIFIER) Output only. The resource name of the form definition. Format: formDefinitions/{form_definition} name must start with 'formDefinitions/':

this.startsWith('formDefinitions/')

displayNamestring(display_name)

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

descriptionstring(description)

(OPTIONAL) Optional. A description of the form definition.

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)required

Required. The schema of the form, defined using FormKit.

formkitSchema.nodesobject(google.protobuf.ListValue)required

ListValue is a wrapper around a repeated field of values.

The JSON representation for ListValue is JSON array.

formkitSchema.nodes.valuesArray of null or numbers or strings or booleans or Array of arrays or objects(values)

Repeated field of dynamically typed values.

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

Output only. The timestamp when the form definition was created.

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

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

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

Output only. The timestamp when the form definition will be purged if soft-deleted. See AIP-164.

etagstring(etag)

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

Response

application/json

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "createTime": "1s",
  "updateTime": "1s",
  "purgeTime": "1s",
  "etag": "string"
}

Retrieve a form definition

Request

Retrieves a form definition.

Path

formDefinitionstringrequired

The formDefinition id.

Query

namestring(name)required

Required. The resource name of the form definition to retrieve. Format: formDefinitions/{form_definition}

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

Responses

Success

Bodyapplication/json

namestring(name)read-only

(IDENTIFIER) Output only. The resource name of the form definition. Format: formDefinitions/{form_definition} name must start with 'formDefinitions/':

this.startsWith('formDefinitions/')

displayNamestring(display_name)

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

descriptionstring(description)

(OPTIONAL) Optional. A description of the form definition.

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)required

Required. The schema of the form, defined using FormKit.

formkitSchema.nodesobject(google.protobuf.ListValue)required

ListValue is a wrapper around a repeated field of values.

The JSON representation for ListValue is JSON array.

formkitSchema.nodes.valuesArray of null or numbers or strings or booleans or Array of arrays or objects(values)

Repeated field of dynamically typed values.

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

Output only. The timestamp when the form definition was created.

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

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

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

Output only. The timestamp when the form definition will be purged if soft-deleted. See AIP-164.

etagstring(etag)

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

Response

application/json

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "createTime": "1s",
  "updateTime": "1s",
  "purgeTime": "1s",
  "etag": "string"
}

Delete a form definition

Request

Soft-deletes a form definition.

Path

formDefinitionstringrequired

The formDefinition id.

Query

namestring(name)required

Required. The resource name of the form definition to delete. Format: formDefinitions/{form_definition}

curl -i -X DELETE \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/formDefinitions/{formDefinition}?name=string'

Responses

Success

Bodyapplication/json

namestring(name)read-only

(IDENTIFIER) Output only. The resource name of the form definition. Format: formDefinitions/{form_definition} name must start with 'formDefinitions/':

this.startsWith('formDefinitions/')

displayNamestring(display_name)

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

descriptionstring(description)

(OPTIONAL) Optional. A description of the form definition.

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)required

Required. The schema of the form, defined using FormKit.

formkitSchema.nodesobject(google.protobuf.ListValue)required

ListValue is a wrapper around a repeated field of values.

The JSON representation for ListValue is JSON array.

formkitSchema.nodes.valuesArray of null or numbers or strings or booleans or Array of arrays or objects(values)

Repeated field of dynamically typed values.

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

Output only. The timestamp when the form definition was created.

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

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

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

Output only. The timestamp when the form definition will be purged if soft-deleted. See AIP-164.

etagstring(etag)

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

Response

application/json

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "createTime": "1s",
  "updateTime": "1s",
  "purgeTime": "1s",
  "etag": "string"
}

Update a form definition

Request

Updates a form definition.

Path

formDefinitionstringrequired

The formDefinition id.

Bodyapplication/json

Required. The form definition to update.

The form definition's name field is used to identify the form definition to update. Format: formDefinitions/{form_definition}

displayNamestring(display_name)

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

descriptionstring(description)

(OPTIONAL) Optional. A description of the form definition.

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)required

Required. The schema of the form, defined using FormKit.

formkitSchema.nodesobject(google.protobuf.ListValue)required

ListValue is a wrapper around a repeated field of values.

The JSON representation for ListValue is JSON array.

formkitSchema.nodes.valuesArray of null or numbers or strings or booleans or Array of arrays or objects(values)

Repeated field of dynamically typed values.

etagstring(etag)

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

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/formDefinitions/{formDefinition}' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "string",
    "description": "string",
    "formkitSchema": {
      "nodes": {
        "values": [
          {}
        ]
      }
    },
    "createTime": "1s",
    "updateTime": "1s",
    "purgeTime": "1s",
    "etag": "string"
  }'

Responses

Success

Bodyapplication/json

namestring(name)read-only

(IDENTIFIER) Output only. The resource name of the form definition. Format: formDefinitions/{form_definition} name must start with 'formDefinitions/':

this.startsWith('formDefinitions/')

displayNamestring(display_name)

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

descriptionstring(description)

(OPTIONAL) Optional. A description of the form definition.

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)required

Required. The schema of the form, defined using FormKit.

formkitSchema.nodesobject(google.protobuf.ListValue)required

ListValue is a wrapper around a repeated field of values.

The JSON representation for ListValue is JSON array.

formkitSchema.nodes.valuesArray of null or numbers or strings or booleans or Array of arrays or objects(values)

Repeated field of dynamically typed values.

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

Output only. The timestamp when the form definition was created.

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

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

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

Output only. The timestamp when the form definition will be purged if soft-deleted. See AIP-164.

etagstring(etag)

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

Response

application/json

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "createTime": "1s",
  "updateTime": "1s",
  "purgeTime": "1s",
  "etag": "string"
}

Clone a form definition

Request

Clones a form definition.

Path

formDefinitionstringrequired

The formDefinition id.

Bodyapplication/jsonrequired

namestring(name)required

Required. The resource name of the form definition to clone. Format: formDefinitions/{form_definition}

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

Responses

Success

Bodyapplication/json

namestring(name)read-only

(IDENTIFIER) Output only. The resource name of the form definition. Format: formDefinitions/{form_definition} name must start with 'formDefinitions/':

this.startsWith('formDefinitions/')

displayNamestring(display_name)

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

descriptionstring(description)

(OPTIONAL) Optional. A description of the form definition.

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)required

Required. The schema of the form, defined using FormKit.

formkitSchema.nodesobject(google.protobuf.ListValue)required

ListValue is a wrapper around a repeated field of values.

The JSON representation for ListValue is JSON array.

formkitSchema.nodes.valuesArray of null or numbers or strings or booleans or Array of arrays or objects(values)

Repeated field of dynamically typed values.

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

Output only. The timestamp when the form definition was created.

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

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

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

Output only. The timestamp when the form definition will be purged if soft-deleted. See AIP-164.

etagstring(etag)

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

Response

application/json

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "createTime": "1s",
  "updateTime": "1s",
  "purgeTime": "1s",
  "etag": "string"
}

FormService

Operations

Workspaces

Service for managing workspaces and their associated forms and documents.

Operations

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

List all form definitions

Request

Responses

Was this helpful?

Create a form definition

Request

Responses

Was this helpful?

Retrieve a form definition

Request

Responses

Was this helpful?

Delete a form definition

Request

Responses

Was this helpful?

Update a form definition

Request

Responses

Was this helpful?

Clone a form definition

Request

Responses

Was this helpful?

FormService

Workspaces

Automations

NotesService

Tenants

Entities

TruuthService

Documents

Form Definitions

List all form definitions

Request

Responses

Was this helpful?

Create a form definition

RequestExpand all

Responses

Was this helpful?

Retrieve a form definition

Request

Responses

Was this helpful?

Delete a form definition

Request

Responses

Was this helpful?

Update a form definition

RequestExpand all

Responses

Was this helpful?

Clone a form definition

Request

Responses

Was this helpful?

FormService

Workspaces

Automations

NotesService

Tenants

Entities

TruuthService

Request

Request