API Reference
/
ScenarioService
/
List scenarios

(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

RFIService

Operations

ScenarioService

Operations

List scenarios

Request

List scenarios.

Query
page_sizeinteger(int32)

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

page_tokenstring

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

show_deletedboolean

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

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

Responses

OK

Bodyapplication/json
scenariosArray of objects(Scenario)

The list of scenarios.

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
{
  "scenarios": [
    { … }
  ],
  "next_page_token": "string"
}

Get a scenario

Request

Get a scenario.

Path
scenariostringrequired

The scenario id.

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

Responses

OK

Bodyapplication/json
namestring

The resource name of the scenario.

Format: scenarios/{scenario}

uidstringread-only

A system-assigned unique identifier for the scenario.

display_namestring

A human-readable name for the scenario, for use in user interfaces.

rfi_ttlstring^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$

The TTL for an RFI based on this scenario, relative to when the RFI is created.

If not set, the RFI will not expire.

rfi_input_json_schemaobject

The JSON schema that the input for an RFI based on this scenario must adhere to.

annotationsobject

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

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

create_timestring(date-time)read-only

Timestamp of when the scenario was created.

update_timestring(date-time)read-only

Timestamp of when the scenario was last updated.

delete_timestring(date-time)read-only

Timestamp of when the scenario was deleted.

etagstringread-only

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

Response
application/json
{
  "name": "string",
  "uid": "string",
  "display_name": "string",
  "rfi_ttl": "string",
  "rfi_input_json_schema": {},
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "delete_time": "2019-08-24T14:15:22Z",
  "etag": "string"
}

Delete a scenario

Request

Delete a scenario

Path
scenariostringrequired

The scenario id.

Query
etagstring

Optional. The current ETag of the scenario.

If provided, and this value does not match the current ETag of the scenario, 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}?etag=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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

Undelete a scenario

Request

Undelete a scenario

Path
scenariostringrequired

The scenario id.

Bodyapplication/jsonrequired
namestringrequired

Required. The resource name of the deleted team.

Format: scenarios/{scenario}

etagstring

Optional. The current ETag of the scenario.

If provided, and this value does not match the current ETag of the scenario, 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}: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 scenario.

Format: scenarios/{scenario}

uidstringread-only

A system-assigned unique identifier for the scenario.

display_namestring

A human-readable name for the scenario, for use in user interfaces.

rfi_ttlstring^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$

The TTL for an RFI based on this scenario, relative to when the RFI is created.

If not set, the RFI will not expire.

rfi_input_json_schemaobject

The JSON schema that the input for an RFI based on this scenario must adhere to.

annotationsobject

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

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

create_timestring(date-time)read-only

Timestamp of when the scenario was created.

update_timestring(date-time)read-only

Timestamp of when the scenario was last updated.

delete_timestring(date-time)read-only

Timestamp of when the scenario was deleted.

etagstringread-only

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

Response
application/json
{
  "name": "string",
  "uid": "string",
  "display_name": "string",
  "rfi_ttl": "string",
  "rfi_input_json_schema": {},
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "delete_time": "2019-08-24T14:15:22Z",
  "etag": "string"
}

TeamService

Operations