API Reference
/
DraftService
/
Publish a draft

(0.0.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.bndry.net/_mock/apis/openapi/
https://api.{customer}.app.identitii.com/

AuthenticationService

Operations

DraftService

Operations

List all drafts

Request

List all drafts.

Path
scenariostringrequired

The scenario id.

Query
page_sizeinteger(int32)

Optional. The maximum number of drafts to return. The service may return fewer than this value. If unspecified, the server will decide the number of drafts to return.

page_tokenstring

Optional. A page token received from a previous ListDrafts call. Provide this to retrieve the subsequent page of results.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/scenarios/{scenario}/drafts?page_size=0&page_token=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
draftsArray of objects(Draft)

The list of drafts.

next_page_tokenstring

A token to retrieve the next page of results. This field is empty if there are no more results.

show_deletedboolean

Optional. Controls whether deleted drafts are included in the response. Defaults to false.

Response
application/json
{
  "drafts": [
    { … }
  ],
  "next_page_token": "string",
  "show_deleted": true
}

Create a draft

Request

Create a draft.

Path
scenariostringrequired

The scenario id.

Query
draft_idstring

Optional. The ID to use for the draft, which will become the final component of the draft's resource name. A system-generated ID will be used if this is not provided.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Bodyapplication/jsonrequired
namestring

The resource name of the draft.

Format: scenarios/{scenario}/drafts/{draft}

creator_teamstring

The resource name of the team that will create or initiate the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that will facilitate or coordinate the RFI process.

Format: teams/{team}

assignee_teamstring

The resource name of the team that will become the initial assignee of the RFI.

Format: teams/{team}

inputobjectrequired

Input data that will be used to create the RFI.

This field should contain JSON that matches the scenario's input schema.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the draft.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/scenarios/{scenario}/drafts?draft_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "creator_team": "string",
    "broker_team": "string",
    "assignee_team": "string",
    "input": {},
    "annotations": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

OK

Bodyapplication/json
namestring

The resource name of the draft.

Format: scenarios/{scenario}/drafts/{draft}

uidstringread-only

A system-assigned unique identifier for the draft, in UUID4 format.

creator_teamstring

The resource name of the team that will create or initiate the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that will facilitate or coordinate the RFI process.

Format: teams/{team}

assignee_teamstring

The resource name of the team that will become the initial assignee of the RFI.

Format: teams/{team}

inputobjectrequired

Input data that will be used to create the RFI.

This field should contain JSON that matches the scenario's input schema.

create_timestring(date-time)read-only

Timestamp of when the draft was created.

update_timestring(date-time)read-only

Timestamp of when the draft was last updated.

delete_timestring(date-time)read-only

Timestamp of when the draft was deleted.

etagstringread-only

The ETag of the draft, used for optimistic concurrency control.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the draft.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

Response
application/json
{
  "name": "string",
  "uid": "string",
  "creator_team": "string",
  "broker_team": "string",
  "assignee_team": "string",
  "input": {},
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "delete_time": "2019-08-24T14:15:22Z",
  "etag": "string",
  "annotations": {
    "property1": "string",
    "property2": "string"
  }
}

Get a draft

Request

Get a draft.

Path
scenariostringrequired

The scenario id.

draftstringrequired

The draft id.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/scenarios/{scenario}/drafts/{draft}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
namestring

The resource name of the draft.

Format: scenarios/{scenario}/drafts/{draft}

uidstringread-only

A system-assigned unique identifier for the draft, in UUID4 format.

creator_teamstring

The resource name of the team that will create or initiate the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that will facilitate or coordinate the RFI process.

Format: teams/{team}

assignee_teamstring

The resource name of the team that will become the initial assignee of the RFI.

Format: teams/{team}

inputobjectrequired

Input data that will be used to create the RFI.

This field should contain JSON that matches the scenario's input schema.

create_timestring(date-time)read-only

Timestamp of when the draft was created.

update_timestring(date-time)read-only

Timestamp of when the draft was last updated.

delete_timestring(date-time)read-only

Timestamp of when the draft was deleted.

etagstringread-only

The ETag of the draft, used for optimistic concurrency control.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the draft.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

Response
application/json
{
  "name": "string",
  "uid": "string",
  "creator_team": "string",
  "broker_team": "string",
  "assignee_team": "string",
  "input": {},
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "delete_time": "2019-08-24T14:15:22Z",
  "etag": "string",
  "annotations": {
    "property1": "string",
    "property2": "string"
  }
}

Delete a draft

Request

Delete a draft.

Path
scenariostringrequired

The scenario id.

draftstringrequired

The draft id.

curl -i -X DELETE \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/scenarios/{scenario}/drafts/{draft}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body
Response
application/json
{
  "code": 0,
  "message": "string",
  "details": [
    { … }
  ]
}

Update a draft

Request

Update a draft.

Path
scenariostringrequired

The scenario id.

draftstringrequired

The draft id.

Query
update_maskstring(field-mask)

Required. The fields to update.

allow_missingboolean

Optional. If set to true, and the draft is not found, a new draft will be created.

Bodyapplication/jsonrequired
namestring

The resource name of the draft.

Format: scenarios/{scenario}/drafts/{draft}

creator_teamstring

The resource name of the team that will create or initiate the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that will facilitate or coordinate the RFI process.

Format: teams/{team}

assignee_teamstring

The resource name of the team that will become the initial assignee of the RFI.

Format: teams/{team}

inputobjectrequired

Input data that will be used to create the RFI.

This field should contain JSON that matches the scenario's input schema.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the draft.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/scenarios/{scenario}/drafts/{draft}?allow_missing=true&update_mask=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "creator_team": "string",
    "broker_team": "string",
    "assignee_team": "string",
    "input": {},
    "annotations": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

OK

Bodyapplication/json
namestring

The resource name of the draft.

Format: scenarios/{scenario}/drafts/{draft}

uidstringread-only

A system-assigned unique identifier for the draft, in UUID4 format.

creator_teamstring

The resource name of the team that will create or initiate the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that will facilitate or coordinate the RFI process.

Format: teams/{team}

assignee_teamstring

The resource name of the team that will become the initial assignee of the RFI.

Format: teams/{team}

inputobjectrequired

Input data that will be used to create the RFI.

This field should contain JSON that matches the scenario's input schema.

create_timestring(date-time)read-only

Timestamp of when the draft was created.

update_timestring(date-time)read-only

Timestamp of when the draft was last updated.

delete_timestring(date-time)read-only

Timestamp of when the draft was deleted.

etagstringread-only

The ETag of the draft, used for optimistic concurrency control.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the draft.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

Response
application/json
{
  "name": "string",
  "uid": "string",
  "creator_team": "string",
  "broker_team": "string",
  "assignee_team": "string",
  "input": {},
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "delete_time": "2019-08-24T14:15:22Z",
  "etag": "string",
  "annotations": {
    "property1": "string",
    "property2": "string"
  }
}

Publish a draft

Request

Publish a draft.

Publishing a draft converts it into an RFI.

Path
scenariostringrequired

The scenario id.

draftstringrequired

The draft id.

Query
namestring

Required. The resource name of the draft to publish.

Format: scenarios/{scenario}/drafts/{draft}

etagstring

Optional. The current ETag of the draft.

If provided, and this value does not match the current ETag of the draft, the request will fail and an ABORTED error will be returned.

Bodyapplication/jsonrequired
curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/scenarios/{scenario}/drafts/{draft}:publish?etag=string&name=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json'

Responses

OK

Bodyapplication/json
rfiobject

The RFI that was created from the draft.

Response
application/json
{
  "rfi": {
    "name": "string",
    "uid": "string",
    "creator_team": "string",
    "broker_team": "string",
    "current_assignee_team": "string",
    "initial_assignee_team": "string",
    "input": {},
    "create_time": "2019-08-24T14:15:22Z",
    "update_time": "2019-08-24T14:15:22Z",
    "expire_time": "2019-08-24T14:15:22Z",
    "state": "STATE_UNSPECIFIED",
    "questions": { … },
    "display_metadata": { … },
    "annotations": { … },
    "etag": "string"
  }
}

Undelete a draft

Request

Undelete a draft.

Path
scenariostringrequired

The scenario id.

draftstringrequired

The draft id.

Bodyapplication/jsonrequired
namestringrequired

Required. The resource name of the deleted draft.

Format: scenarios/{scenario}/drafts/{draft}

etagstring

Optional. The current ETag of the draft.

If provided, and this value does not match the current ETag of the draft, the request will fail and an ABORTED error will be returned.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/scenarios/{scenario}/drafts/{draft}:undelete' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "etag": "string"
  }'

Responses

OK

Bodyapplication/json
namestring

The resource name of the draft.

Format: scenarios/{scenario}/drafts/{draft}

uidstringread-only

A system-assigned unique identifier for the draft, in UUID4 format.

creator_teamstring

The resource name of the team that will create or initiate the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that will facilitate or coordinate the RFI process.

Format: teams/{team}

assignee_teamstring

The resource name of the team that will become the initial assignee of the RFI.

Format: teams/{team}

inputobjectrequired

Input data that will be used to create the RFI.

This field should contain JSON that matches the scenario's input schema.

create_timestring(date-time)read-only

Timestamp of when the draft was created.

update_timestring(date-time)read-only

Timestamp of when the draft was last updated.

delete_timestring(date-time)read-only

Timestamp of when the draft was deleted.

etagstringread-only

The ETag of the draft, used for optimistic concurrency control.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the draft.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

Response
application/json
{
  "name": "string",
  "uid": "string",
  "creator_team": "string",
  "broker_team": "string",
  "assignee_team": "string",
  "input": {},
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "delete_time": "2019-08-24T14:15:22Z",
  "etag": "string",
  "annotations": {
    "property1": "string",
    "property2": "string"
  }
}

RFIService

Operations

ScenarioService

Operations

TeamService

Operations