Respond to an RFI

(0.0.1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

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

https://api.{customer}.app.identitii.com/

AuthenticationService

Operations

DraftService

Operations

RFIService

Operations

List all RFIs

Request

List RFIs.

Path

scenariostringrequired

The scenario id.

Query

page_sizeinteger(int32)

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

page_tokenstring

Optional. A page token received from a previous ListRFIs 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}/rfis?page_size=0&page_token=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

rfisArray of objects(RFI)

The list of RFIs.

next_page_tokenstring

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

Response

application/json

{
  "rfis": [
    { … }
  ],
  "next_page_token": "string"
}

Create an RFI

Request

Create an RFI.

Path

scenariostringrequired

The scenario id.

Query

rfi_idstring

Optional. The ID to use for the RFI, which will become the final component of the RFI'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 RFI.

Format: scenarios/{scenario}/rfis/{rfi}

creator_teamstring

The resource name of the team that created or initiated the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that facilitates and coordinates the RFI process.

Format: teams/{team}

current_assignee_teamstring

The resource name of the team currently assigned to the RFI. Note: RFIs are reassigned as a side effect of state transitions and cannot be explicitly reassigned.

Format: teams/{team}

inputobject

Input data used to create the RFI, immutable after creation.

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 RFI.

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}/rfis?rfi_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "creator_team": "string",
    "broker_team": "string",
    "current_assignee_team": "string",
    "input": {},
    "annotations": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Bodyapplication/json

namestring

The resource name of the RFI.

Format: scenarios/{scenario}/rfis/{rfi}

uidstringread-only

A unique identifier for the RFI, in UUID4 format.

creator_teamstring

The resource name of the team that created or initiated the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that facilitates and coordinates the RFI process.

Format: teams/{team}

current_assignee_teamstring

The resource name of the team currently assigned to the RFI. Note: RFIs are reassigned as a side effect of state transitions and cannot be explicitly reassigned.

Format: teams/{team}

initial_assignee_teamstringread-only

The resource name of the team that was initially assigned to the RFI.

Format: teams/{team}

inputobject

Input data used to create the RFI, immutable after creation.

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

create_timestring(date-time)read-only

Timestamp when the RFI was created.

update_timestring(date-time)read-only

Timestamp when the RFI was last updated.

expire_timestring(date-time)read-only

Timestamp of when the RFI will expire.

The expiry time, and whether or not an RFI can expire, is determined by the scenario.

This field is only set when the RFI is in OPEN state and the scenario specifies an expiry time.

statestring(enum)read-only

The current state of the RFI.

Enum"STATE_UNSPECIFIED""OPEN""IN_PROGRESS""IN_REVIEW""COMPLETE""REVOKED""EXPIRED""REJECTED"

questionsobjectread-only

A map of questions being asked in the RFI, keyed by question identifiers. Each question contains the expected kind of answer and the current answer if provided.

display_metadataobjectread-only

Metadata for display purposes, such as UI rendering instructions.

annotationsobject

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

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

etagstringread-only

The etag of the RFI, used for optimistic concurrency control.

Response

application/json

{
  "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": {
    "property1": { … },
    "property2": { … }
  },
  "display_metadata": {
    "instructions": { … },
    "groups": [ … ]
  },
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "etag": "string"
}

Get an RFI

Request

Get an RFI.

Path

scenariostringrequired

The scenario id.

rfistringrequired

The rfi id.

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

Responses

Bodyapplication/json

namestring

The resource name of the RFI.

Format: scenarios/{scenario}/rfis/{rfi}

uidstringread-only

A unique identifier for the RFI, in UUID4 format.

creator_teamstring

The resource name of the team that created or initiated the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that facilitates and coordinates the RFI process.

Format: teams/{team}

current_assignee_teamstring

The resource name of the team currently assigned to the RFI. Note: RFIs are reassigned as a side effect of state transitions and cannot be explicitly reassigned.

Format: teams/{team}

initial_assignee_teamstringread-only

The resource name of the team that was initially assigned to the RFI.

Format: teams/{team}

inputobject

Input data used to create the RFI, immutable after creation.

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

create_timestring(date-time)read-only

Timestamp when the RFI was created.

update_timestring(date-time)read-only

Timestamp when the RFI was last updated.

expire_timestring(date-time)read-only

Timestamp of when the RFI will expire.

The expiry time, and whether or not an RFI can expire, is determined by the scenario.

This field is only set when the RFI is in OPEN state and the scenario specifies an expiry time.

statestring(enum)read-only

The current state of the RFI.

Enum"STATE_UNSPECIFIED""OPEN""IN_PROGRESS""IN_REVIEW""COMPLETE""REVOKED""EXPIRED""REJECTED"

questionsobjectread-only

A map of questions being asked in the RFI, keyed by question identifiers. Each question contains the expected kind of answer and the current answer if provided.

display_metadataobjectread-only

Metadata for display purposes, such as UI rendering instructions.

annotationsobject

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

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

etagstringread-only

The etag of the RFI, used for optimistic concurrency control.

Response

application/json

{
  "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": {
    "property1": { … },
    "property2": { … }
  },
  "display_metadata": {
    "instructions": { … },
    "groups": [ … ]
  },
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "etag": "string"
}

Delete an RFI

Request

Path

scenariostringrequired

The scenario id.

rfistringrequired

The rfi id.

Query

etagstring

Optional. The current ETag of the RFI.

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

curl -i -X DELETE \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/scenarios/{scenario}/rfis/{rfi}?etag=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Body

Response

application/json

{
  "code": 0,
  "message": "string",
  "details": [
    { … }
  ]
}

Complete an RFI

Request

Complete an RFI.

The broker of an RFI can complete it to indicate that the response to the RFI is satisfactory.

An RFI can be completed in the OPEN, IN_PROGRESS and IN_REVIEW states. Completing an RFI will transition it to COMPLETE state and assign it to the creator.

Path

scenariostringrequired

The scenario id.

rfistringrequired

The rfi id.

Bodyapplication/jsonrequired

namestringrequired

Required. The resource name of the RFI to complete.

Format: scenarios/{scenario}/rfis/{rfi}

etagstring

Optional. The current ETag of the RFI.

If provided, and this value does not match the current ETag of the RFI, 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}/rfis/{rfi}:complete' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "etag": "string"
  }'

Responses

Bodyapplication/json

namestring

The resource name of the RFI.

Format: scenarios/{scenario}/rfis/{rfi}

uidstringread-only

A unique identifier for the RFI, in UUID4 format.

creator_teamstring

The resource name of the team that created or initiated the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that facilitates and coordinates the RFI process.

Format: teams/{team}

current_assignee_teamstring

The resource name of the team currently assigned to the RFI. Note: RFIs are reassigned as a side effect of state transitions and cannot be explicitly reassigned.

Format: teams/{team}

initial_assignee_teamstringread-only

The resource name of the team that was initially assigned to the RFI.

Format: teams/{team}

inputobject

Input data used to create the RFI, immutable after creation.

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

create_timestring(date-time)read-only

Timestamp when the RFI was created.

update_timestring(date-time)read-only

Timestamp when the RFI was last updated.

expire_timestring(date-time)read-only

Timestamp of when the RFI will expire.

The expiry time, and whether or not an RFI can expire, is determined by the scenario.

This field is only set when the RFI is in OPEN state and the scenario specifies an expiry time.

statestring(enum)read-only

The current state of the RFI.

Enum"STATE_UNSPECIFIED""OPEN""IN_PROGRESS""IN_REVIEW""COMPLETE""REVOKED""EXPIRED""REJECTED"

questionsobjectread-only

A map of questions being asked in the RFI, keyed by question identifiers. Each question contains the expected kind of answer and the current answer if provided.

display_metadataobjectread-only

Metadata for display purposes, such as UI rendering instructions.

annotationsobject

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

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

etagstringread-only

The etag of the RFI, used for optimistic concurrency control.

Response

application/json

{
  "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": {
    "property1": { … },
    "property2": { … }
  },
  "display_metadata": {
    "instructions": { … },
    "groups": [ … ]
  },
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "etag": "string"
}

Reject an RFI

Request

The current assignee of an RFI can reject it to indicate that they are unable to respond.

Path

scenariostringrequired

The scenario id.

rfistringrequired

The rfi id.

Bodyapplication/jsonrequired

namestringrequired

Required. The resource name of the RFI to reject.

Format: scenarios/{scenario}/rfis/{rfi}

commentstringrequired

Required. A comment explaining the reason for rejection.

etagstring

Optional. The current ETag of the RFI.

If provided, and this value does not match the current ETag of the RFI, 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}/rfis/{rfi}:reject' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "comment": "string",
    "etag": "string"
  }'

Responses

Bodyapplication/json

namestring

The resource name of the RFI.

Format: scenarios/{scenario}/rfis/{rfi}

uidstringread-only

A unique identifier for the RFI, in UUID4 format.

creator_teamstring

The resource name of the team that created or initiated the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that facilitates and coordinates the RFI process.

Format: teams/{team}

current_assignee_teamstring

The resource name of the team currently assigned to the RFI. Note: RFIs are reassigned as a side effect of state transitions and cannot be explicitly reassigned.

Format: teams/{team}

initial_assignee_teamstringread-only

The resource name of the team that was initially assigned to the RFI.

Format: teams/{team}

inputobject

Input data used to create the RFI, immutable after creation.

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

create_timestring(date-time)read-only

Timestamp when the RFI was created.

update_timestring(date-time)read-only

Timestamp when the RFI was last updated.

expire_timestring(date-time)read-only

Timestamp of when the RFI will expire.

The expiry time, and whether or not an RFI can expire, is determined by the scenario.

This field is only set when the RFI is in OPEN state and the scenario specifies an expiry time.

statestring(enum)read-only

The current state of the RFI.

Enum"STATE_UNSPECIFIED""OPEN""IN_PROGRESS""IN_REVIEW""COMPLETE""REVOKED""EXPIRED""REJECTED"

questionsobjectread-only

A map of questions being asked in the RFI, keyed by question identifiers. Each question contains the expected kind of answer and the current answer if provided.

display_metadataobjectread-only

Metadata for display purposes, such as UI rendering instructions.

annotationsobject

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

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

etagstringread-only

The etag of the RFI, used for optimistic concurrency control.

Response

application/json

{
  "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": {
    "property1": { … },
    "property2": { … }
  },
  "display_metadata": {
    "instructions": { … },
    "groups": [ … ]
  },
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "etag": "string"
}

Respond to an RFI

Request

Respond to an RFI.

An RFI can be responded to in the OPEN and IN_PROGRESS states. Responding to an RFI in the OPEN state will transition it to IN_PROGRESS.

Path

scenariostringrequired

The scenario id.

rfistringrequired

The rfi id.

Bodyapplication/jsonrequired

namestringrequired

Required. The resource name of the RFI to respond to.

Format: scenarios/{scenario}/rfis/{rfi}

etagstring

Optional. The current ETag of the RFI.

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

answersobjectrequired

Required. A map of answers keyed by question identifiers. The keys must correspond to valid question IDs within the RFI.

answers.property name*object(Answer)additional property

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/scenarios/{scenario}/rfis/{rfi}:respond' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "etag": "string",
    "answers": {
      "property1": {
        "address": {
          "revision": 0,
          "region_code": "string",
          "language_code": "string",
          "postal_code": "string",
          "sorting_code": "string",
          "administrative_area": "string",
          "locality": "string",
          "sublocality": "string",
          "address_lines": [
            "string"
          ],
          "recipients": [
            "string"
          ],
          "organization": "string"
        },
        "date": "2019-08-24",
        "multi_file": {
          "file_ids": [
            "string"
          ]
        },
        "text": "string"
      },
      "property2": {
        "address": {
          "revision": 0,
          "region_code": "string",
          "language_code": "string",
          "postal_code": "string",
          "sorting_code": "string",
          "administrative_area": "string",
          "locality": "string",
          "sublocality": "string",
          "address_lines": [
            "string"
          ],
          "recipients": [
            "string"
          ],
          "organization": "string"
        },
        "date": "2019-08-24",
        "multi_file": {
          "file_ids": [
            "string"
          ]
        },
        "text": "string"
      }
    }
  }'

Responses

Bodyapplication/json

namestring

The resource name of the RFI.

Format: scenarios/{scenario}/rfis/{rfi}

uidstringread-only

A unique identifier for the RFI, in UUID4 format.

creator_teamstring

The resource name of the team that created or initiated the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that facilitates and coordinates the RFI process.

Format: teams/{team}

current_assignee_teamstring

The resource name of the team currently assigned to the RFI. Note: RFIs are reassigned as a side effect of state transitions and cannot be explicitly reassigned.

Format: teams/{team}

initial_assignee_teamstringread-only

The resource name of the team that was initially assigned to the RFI.

Format: teams/{team}

inputobject

Input data used to create the RFI, immutable after creation.

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

create_timestring(date-time)read-only

Timestamp when the RFI was created.

update_timestring(date-time)read-only

Timestamp when the RFI was last updated.

expire_timestring(date-time)read-only

Timestamp of when the RFI will expire.

The expiry time, and whether or not an RFI can expire, is determined by the scenario.

This field is only set when the RFI is in OPEN state and the scenario specifies an expiry time.

statestring(enum)read-only

The current state of the RFI.

Enum"STATE_UNSPECIFIED""OPEN""IN_PROGRESS""IN_REVIEW""COMPLETE""REVOKED""EXPIRED""REJECTED"

questionsobjectread-only

A map of questions being asked in the RFI, keyed by question identifiers. Each question contains the expected kind of answer and the current answer if provided.

display_metadataobjectread-only

Metadata for display purposes, such as UI rendering instructions.

annotationsobject

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

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

etagstringread-only

The etag of the RFI, used for optimistic concurrency control.

Response

application/json

{
  "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": {
    "property1": { … },
    "property2": { … }
  },
  "display_metadata": {
    "instructions": { … },
    "groups": [ … ]
  },
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "etag": "string"
}

Review an RFI

Request

Review an RFI.

The broker of an RFI can review it to approve/reject the answers provided by the initial assignee of the RFI.

An RFI can be only be reviewed in the IN_REVIEW state.

Path

scenariostringrequired

The scenario id.

rfistringrequired

The rfi id.

Bodyapplication/jsonrequired

namestringrequired

Required. The resource name of the RFI to review.

Format: scenarios/{scenario}/rfis/{rfi}

etagstring

Optional. The current ETag of the RFI.

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

reviewsobjectrequired

Required. A map of review states for answers, keyed by question identifiers. The keys must correspond to valid question IDs within the RFI.

reviews.property name*string(enum)additional property

Enum"REVIEW_STATE_UNSPECIFIED""NOT_REQUIRED""PENDING""APPROVED""REJECTED"

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/scenarios/{scenario}/rfis/{rfi}:review' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "etag": "string",
    "reviews": {
      "property1": "REVIEW_STATE_UNSPECIFIED",
      "property2": "REVIEW_STATE_UNSPECIFIED"
    }
  }'

Responses

Bodyapplication/json

namestring

The resource name of the RFI.

Format: scenarios/{scenario}/rfis/{rfi}

uidstringread-only

A unique identifier for the RFI, in UUID4 format.

creator_teamstring

The resource name of the team that created or initiated the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that facilitates and coordinates the RFI process.

Format: teams/{team}

current_assignee_teamstring

The resource name of the team currently assigned to the RFI. Note: RFIs are reassigned as a side effect of state transitions and cannot be explicitly reassigned.

Format: teams/{team}

initial_assignee_teamstringread-only

The resource name of the team that was initially assigned to the RFI.

Format: teams/{team}

inputobject

Input data used to create the RFI, immutable after creation.

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

create_timestring(date-time)read-only

Timestamp when the RFI was created.

update_timestring(date-time)read-only

Timestamp when the RFI was last updated.

expire_timestring(date-time)read-only

Timestamp of when the RFI will expire.

The expiry time, and whether or not an RFI can expire, is determined by the scenario.

This field is only set when the RFI is in OPEN state and the scenario specifies an expiry time.

statestring(enum)read-only

The current state of the RFI.

Enum"STATE_UNSPECIFIED""OPEN""IN_PROGRESS""IN_REVIEW""COMPLETE""REVOKED""EXPIRED""REJECTED"

questionsobjectread-only

A map of questions being asked in the RFI, keyed by question identifiers. Each question contains the expected kind of answer and the current answer if provided.

display_metadataobjectread-only

Metadata for display purposes, such as UI rendering instructions.

annotationsobject

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

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

etagstringread-only

The etag of the RFI, used for optimistic concurrency control.

Response

application/json

{
  "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": {
    "property1": { … },
    "property2": { … }
  },
  "display_metadata": {
    "instructions": { … },
    "groups": [ … ]
  },
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "etag": "string"
}

Revoke an RFI

Request

The broker of an RFI can revoke it to indicate that a response is no longer required.

Path

scenariostringrequired

The scenario id.

rfistringrequired

The rfi id.

Bodyapplication/jsonrequired

namestringrequired

Required. The resource name of the RFI to revoke.

Format: scenarios/{scenario}/rfis/{rfi}

commentstringrequired

Required. A comment explaining the reason for revocation.

etagstring

Optional. The current ETag of the RFI.

If provided, and this value does not match the current ETag of the RFI, 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}/rfis/{rfi}:revoke' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "comment": "string",
    "etag": "string"
  }'

Responses

Bodyapplication/json

namestring

The resource name of the RFI.

Format: scenarios/{scenario}/rfis/{rfi}

uidstringread-only

A unique identifier for the RFI, in UUID4 format.

creator_teamstring

The resource name of the team that created or initiated the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that facilitates and coordinates the RFI process.

Format: teams/{team}

current_assignee_teamstring

The resource name of the team currently assigned to the RFI. Note: RFIs are reassigned as a side effect of state transitions and cannot be explicitly reassigned.

Format: teams/{team}

initial_assignee_teamstringread-only

The resource name of the team that was initially assigned to the RFI.

Format: teams/{team}

inputobject

Input data used to create the RFI, immutable after creation.

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

create_timestring(date-time)read-only

Timestamp when the RFI was created.

update_timestring(date-time)read-only

Timestamp when the RFI was last updated.

expire_timestring(date-time)read-only

Timestamp of when the RFI will expire.

The expiry time, and whether or not an RFI can expire, is determined by the scenario.

This field is only set when the RFI is in OPEN state and the scenario specifies an expiry time.

statestring(enum)read-only

The current state of the RFI.

Enum"STATE_UNSPECIFIED""OPEN""IN_PROGRESS""IN_REVIEW""COMPLETE""REVOKED""EXPIRED""REJECTED"

questionsobjectread-only

A map of questions being asked in the RFI, keyed by question identifiers. Each question contains the expected kind of answer and the current answer if provided.

display_metadataobjectread-only

Metadata for display purposes, such as UI rendering instructions.

annotationsobject

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

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

etagstringread-only

The etag of the RFI, used for optimistic concurrency control.

Response

application/json

{
  "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": {
    "property1": { … },
    "property2": { … }
  },
  "display_metadata": {
    "instructions": { … },
    "groups": [ … ]
  },
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "etag": "string"
}

Submit an RFI for review

Request

Submit an RFI for review.

The current assignee of an RFI can submit their answers for review by the broker.

An RFI can only be submitted for review in the IN_PROGRESS state. If any answers require review, the RFI will transition to IN_REVIEW state and be assigned to the broker. Otherwise, the RFI will transition directly to COMPLETE state and be assigned to the creator.

Path

scenariostringrequired

The scenario id.

rfistringrequired

The rfi id.

Bodyapplication/jsonrequired

namestringrequired

Required. The resource name of the RFI to submit.

Format: scenarios/{scenario}/rfis/{rfi}

etagstring

Optional. The current ETag of the RFI.

If provided, and this value does not match the current ETag of the RFI, 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}/rfis/{rfi}:submit' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "etag": "string"
  }'

Responses

Bodyapplication/json

namestring

The resource name of the RFI.

Format: scenarios/{scenario}/rfis/{rfi}

uidstringread-only

A unique identifier for the RFI, in UUID4 format.

creator_teamstring

The resource name of the team that created or initiated the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that facilitates and coordinates the RFI process.

Format: teams/{team}

current_assignee_teamstring

The resource name of the team currently assigned to the RFI. Note: RFIs are reassigned as a side effect of state transitions and cannot be explicitly reassigned.

Format: teams/{team}

initial_assignee_teamstringread-only

The resource name of the team that was initially assigned to the RFI.

Format: teams/{team}

inputobject

Input data used to create the RFI, immutable after creation.

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

create_timestring(date-time)read-only

Timestamp when the RFI was created.

update_timestring(date-time)read-only

Timestamp when the RFI was last updated.

expire_timestring(date-time)read-only

Timestamp of when the RFI will expire.

The expiry time, and whether or not an RFI can expire, is determined by the scenario.

This field is only set when the RFI is in OPEN state and the scenario specifies an expiry time.

statestring(enum)read-only

The current state of the RFI.

Enum"STATE_UNSPECIFIED""OPEN""IN_PROGRESS""IN_REVIEW""COMPLETE""REVOKED""EXPIRED""REJECTED"

questionsobjectread-only

A map of questions being asked in the RFI, keyed by question identifiers. Each question contains the expected kind of answer and the current answer if provided.

display_metadataobjectread-only

Metadata for display purposes, such as UI rendering instructions.

annotationsobject

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

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

etagstringread-only

The etag of the RFI, used for optimistic concurrency control.

Response

application/json

{
  "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": {
    "property1": { … },
    "property2": { … }
  },
  "display_metadata": {
    "instructions": { … },
    "groups": [ … ]
  },
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "etag": "string"
}

Undelete an RFI

Request

Path

scenariostringrequired

The scenario id.

rfistringrequired

The rfi id.

Bodyapplication/jsonrequired

namestringrequired

Required. The resource name of the deleted RFI.

Format: scenarios/{scenario}/rfis/{rfi}

etagstring

Optional. The current ETag of the RFI.

If provided, and this value does not match the current ETag of the RFI, 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}/rfis/{rfi}:undelete' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "etag": "string"
  }'

Responses

Bodyapplication/json

namestring

The resource name of the RFI.

Format: scenarios/{scenario}/rfis/{rfi}

uidstringread-only

A unique identifier for the RFI, in UUID4 format.

creator_teamstring

The resource name of the team that created or initiated the RFI.

Format: teams/{team}

broker_teamstring

The resource name of the team that facilitates and coordinates the RFI process.

Format: teams/{team}

current_assignee_teamstring

The resource name of the team currently assigned to the RFI. Note: RFIs are reassigned as a side effect of state transitions and cannot be explicitly reassigned.

Format: teams/{team}

initial_assignee_teamstringread-only

The resource name of the team that was initially assigned to the RFI.

Format: teams/{team}

inputobject

Input data used to create the RFI, immutable after creation.

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

create_timestring(date-time)read-only

Timestamp when the RFI was created.

update_timestring(date-time)read-only

Timestamp when the RFI was last updated.

expire_timestring(date-time)read-only

Timestamp of when the RFI will expire.

The expiry time, and whether or not an RFI can expire, is determined by the scenario.

This field is only set when the RFI is in OPEN state and the scenario specifies an expiry time.

statestring(enum)read-only

The current state of the RFI.

Enum"STATE_UNSPECIFIED""OPEN""IN_PROGRESS""IN_REVIEW""COMPLETE""REVOKED""EXPIRED""REJECTED"

questionsobjectread-only

A map of questions being asked in the RFI, keyed by question identifiers. Each question contains the expected kind of answer and the current answer if provided.

display_metadataobjectread-only

Metadata for display purposes, such as UI rendering instructions.

annotationsobject

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

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

etagstringread-only

The etag of the RFI, used for optimistic concurrency control.

Response

application/json

{
  "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": {
    "property1": { … },
    "property2": { … }
  },
  "display_metadata": {
    "instructions": { … },
    "groups": [ … ]
  },
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "etag": "string"
}

ScenarioService

Operations

TeamService

Operations

(0.0.1)

AuthenticationService

DraftService

RFIService

List all RFIs

Request

Responses

Was this helpful?

Create an RFI

RequestExpand all

Responses

Was this helpful?

Get an RFI

Request

Responses

Was this helpful?

Delete an RFI

Request

Responses

Was this helpful?

Complete an RFI

Request

Responses

Was this helpful?

Reject an RFI

Request

Responses

Was this helpful?

Respond to an RFI

RequestExpand all

Responses

Was this helpful?

Review an RFI

RequestExpand all

Responses

Was this helpful?

Revoke an RFI

Request

Responses

Was this helpful?

Submit an RFI for review

Request

Responses

Was this helpful?

Undelete an RFI

Request

Responses

Was this helpful?

ScenarioService

TeamService

Request

Request

Request