Run an automation

API Reference

Automations

Run an automation

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

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

Automations

Service for managing and executing automations.

This description was generated by a custom Redocly generator.

Operations

List all automations

Request

Lists available automations for the tenant.

Query

pageSizeinteger(int32)(page_size)

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

filterstring(filter)

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

skipinteger(int32)(skip)

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

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/automations?filter=string&pageSize=0&pageToken=string&skip=0'

Responses

Success

Bodyapplication/json

automationsArray of objects(automations)

The list of automations.

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

Response

application/json

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

Retrieve an automation

Request

Retrieves details about a specific automation.

Path

automationstringrequired

The automation id.

Query

namestring(name)required

Required. The resource name of the automation to retrieve. Format: automations/{automation}

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

Responses

Success

Bodyapplication/json

namestring(name)

(IDENTIFIER) The resource name of the automation. Format: automations/{automation}

displayNamestring(display_name)read-only

Human-readable display name.

descriptionstring(description)read-only

Description of what the automation does.

inputSchemaobject(google.protobuf.Struct)read-only

Input schema for parameters (JSON schema).

Response

application/json

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "inputSchema": {
    "property1": {},
    "property2": {}
  }
}

Run an automation

Request

Runs an automation and returns an automation execution.

Path

automationstringrequired

The automation id.

Bodyapplication/jsonrequired

automationstring(automation)required

Required. The resource name of the automation to execute. Format: automations/{automation} automation must start with 'automations/':

this.startsWith('automations/')

parametersobject(google.protobuf.Struct)

(OPTIONAL) Optional. Input parameters for the automation execution.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/automations/{automation}:run' \
  -H 'Content-Type: application/json' \
  -d '{
    "automation": "string",
    "parameters": {
      "property1": {},
      "property2": {}
    }
  }'

Responses

Success

Bodyapplication/json

One of:

This resource represents a long-running operation that is the result of a network API call.

errorobject(google.rpc.Status)required

The error result of the operation in case of failure or cancellation.

error.codeinteger(int32)(code)

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

error.messagestring(message)

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

error.detailsArray of objects(details)

A list of messages that carry the error details. There is a common set of message types for APIs to use.

namestring(name)

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

metadataobject(google.protobuf.Any)

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

doneboolean(done)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

Response

application/json

{
  "error": {
    "code": 0,
    "message": "string",
    "details": [ … ]
  },
  "name": "string",
  "metadata": {
    "type": "string",
    "value": "string",
    "debug": {}
  },
  "done": true
}

List automation executions

Request

Lists automation executions for a specific automation.

Path

automationstringrequired

The automation id.

Query

parentstring(parent)required

Required. The parent automation resource name. Format: automations/{automation}

pageSizeinteger(int32)(page_size)

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

filterstring(filter)

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

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/automations/{automation}/executions?filter=string&pageSize=0&pageToken=string&parent=string'

Responses

Success

Bodyapplication/json

automationExecutionsArray of objects(automation_executions)

The list of automation executions.

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

Response

application/json

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

Retrieve an automation execution

Request

Retrieves details about a specific automation execution.

Path

automationstringrequired

The automation id.

executionstringrequired

The execution id.

Query

namestring(name)required

Required. The resource name of the automation execution to retrieve. Format: automations/{automation}/executions/{execution}

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

Responses

Success

Bodyapplication/json

namestring(name)

(IDENTIFIER) The resource name of the automation. Format: automations/{automation}/executions/{execution}

automationstring(automation)read-only

The automation being executed. Format: automations/{automation}

inputParametersobject(google.protobuf.Struct)read-only

Input parameters provided for the execution.

statestring(bndry.api.core.v1alpha.AutomationExecution.State)read-only

Current execution state.

Enum"STATE_UNSPECIFIED""ACTIVE""REQUIRES_INPUT""SUCCEEDED""FAILED""CANCELLED"

formsArray of strings(forms)read-only

The resource names of the forms that require a response to continue the execution.

errorobject(google.rpc.Status)read-only

Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is FAILED or CANCELLED.

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

Output only. Timestamp when execution started.

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

Output only. Marks the end of execution, successful or not.

Response

application/json

{
  "name": "string",
  "automation": "string",
  "inputParameters": {
    "property1": {},
    "property2": {}
  },
  "state": "STATE_UNSPECIFIED",
  "forms": [
    "string"
  ],
  "error": {
    "code": 0,
    "message": "string",
    "details": [ … ]
  },
  "startTime": "1s",
  "endTime": "1s"
}

Cancel an automation execution

Request

Cancels a running automation execution.

Path

automationstringrequired

The automation id.

executionstringrequired

The execution id.

Bodyapplication/jsonrequired

namestring(name)required

Required. The resource name of the automation execution to cancel. Format: automations/{automation}/executions/{execution} name must follow format 'automations//executions/':

this.matches('^automations/.+/executions/.+$')

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/automations/{automation}/executions/{execution}:cancel' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

Success

Bodyapplication/json

namestring(name)

(IDENTIFIER) The resource name of the automation. Format: automations/{automation}/executions/{execution}

automationstring(automation)read-only

The automation being executed. Format: automations/{automation}

inputParametersobject(google.protobuf.Struct)read-only

Input parameters provided for the execution.

statestring(bndry.api.core.v1alpha.AutomationExecution.State)read-only

Current execution state.

Enum"STATE_UNSPECIFIED""ACTIVE""REQUIRES_INPUT""SUCCEEDED""FAILED""CANCELLED"

formsArray of strings(forms)read-only

The resource names of the forms that require a response to continue the execution.

errorobject(google.rpc.Status)read-only

Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is FAILED or CANCELLED.

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

Output only. Timestamp when execution started.

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

Output only. Marks the end of execution, successful or not.

Response

application/json

{
  "name": "string",
  "automation": "string",
  "inputParameters": {
    "property1": {},
    "property2": {}
  },
  "state": "STATE_UNSPECIFIED",
  "forms": [
    "string"
  ],
  "error": {
    "code": 0,
    "message": "string",
    "details": [ … ]
  },
  "startTime": "1s",
  "endTime": "1s"
}

Documents

Service for managing documents.

Operations

Tenants

Service for managing tenants.

Operations

Form Definitions

Service for managing form definitions.

Operations

FormService

Operations

Workspaces

Service for managing workspaces and their associated forms and documents.

Operations

Entities

Operations

Automations

List all automations

Request

Responses

Was this helpful?

Retrieve an automation

Request

Responses

Was this helpful?

Run an automation

Request

Responses

Was this helpful?

List automation executions

Request

Responses

Was this helpful?

Retrieve an automation execution

Request

Responses

Was this helpful?

Cancel an automation execution

Request

Responses

Was this helpful?

Documents

Tenants

Form Definitions

FormService

Workspaces

Entities

Automations

List all automations

Request

Responses

Was this helpful?

Retrieve an automation

Request

Responses

Was this helpful?

Run an automation

RequestExpand all

Responses

Was this helpful?

List automation executions

Request

Responses

Was this helpful?

Retrieve an automation execution

Request

Responses

Was this helpful?

Cancel an automation execution

Request

Responses

Was this helpful?

Documents

Tenants

Form Definitions

FormService

Workspaces

Entities

Request