APIs.io Engineering Platform Request for Information (RFI) API

The Request for Information (RFI) API from APIs.io Engineering Platform — 12 operation(s) for request for information (rfi).

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 17 operations across 12 paths, and defines 28 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

17 operations 12 paths 28 schemas 3 DELETE5 GET6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Request for Information (RFI) API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

Paths & Operations 17

Across 12 paths, the API surfaces 17 operations — 3 DELETE, 5 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Request for Information (RFI) 17

POST

/accounts/{account_identifier}/cloudforce-one/requests

APIs.io Engineering Platform List Requests

cloudforce-one-request-list 1 param body → 4XX200

DELETE

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}

APIs.io Engineering Platform Delete a Request

cloudforce-one-request-delete 2 params → 4XX200

GET

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}

APIs.io Engineering Platform Get a Request

cloudforce-one-request-get 2 params → 4XX200

PUT

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}

APIs.io Engineering Platform Update a Request

cloudforce-one-request-update 2 params body → 4XX200

POST

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset

APIs.io Engineering Platform List Request Assets

cloudforce-one-request-asset-list 2 params body → 4XX200

DELETE

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset/{asset_identifer}

APIs.io Engineering Platform Delete a Request Asset

cloudforce-one-request-asset-delete 3 params → 4XX200

GET

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset/{asset_identifer}

APIs.io Engineering Platform Get a Request Asset

cloudforce-one-request-asset-get 3 params → 4XX200

PUT

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset/{asset_identifer}

APIs.io Engineering Platform Update a Request Asset

cloudforce-one-request-asset-update 3 params body → 4XX200

POST

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset/new

APIs.io Engineering Platform Create a New Request Asset

cloudforce-one-request-asset-new 2 params body → 4XX200

POST

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message

APIs.io Engineering Platform List Request Messages

cloudforce-one-request-message-list 2 params body → 4XX200

DELETE

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/{message_identifer}

APIs.io Engineering Platform Delete a Request Message

cloudforce-one-request-message-delete 3 params → 4XX200

PUT

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/{message_identifer}

APIs.io Engineering Platform Update a Request Message

cloudforce-one-request-message-update 3 params body → 4XX200

POST

/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/new

APIs.io Engineering Platform Create a New Request Message

cloudforce-one-request-message-new 2 params body → 4XX200

GET

/accounts/{account_identifier}/cloudforce-one/requests/constants

APIs.io Engineering Platform Get Request Priority, Status, and TLP constants

cloudforce-one-request-constants 1 param → 4XX200

POST

/accounts/{account_identifier}/cloudforce-one/requests/new

APIs.io Engineering Platform Create a New Request

cloudforce-one-request-new 1 param body → 4XX200

GET

/accounts/{account_identifier}/cloudforce-one/requests/quota

APIs.io Engineering Platform Get Request Quota

cloudforce-one-request-quota 1 param → 4XX200

GET

/accounts/{account_identifier}/cloudforce-one/requests/types

APIs.io Engineering Platform Get Request Types

cloudforce-one-request-types 1 param → 4XX200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are cloudforce-one_request-item (13 properties), cloudforce-one_request-list-item (12 properties), cloudforce-one_request-list (10 properties), cloudforce-one_request-message-list (6 properties). Each schema is shown below with its type and property counts.

cloudforce-one_uuid

string

UUID

cloudforce-one_identifier

string

Identifier

cloudforce-one_tlp

string

The CISA defined Traffic Light Protocol (TLP)

cloudforce-one_request-constants

object

3 properties

cloudforce-one_request-status

string

Request Status

cloudforce-one_time

string

cloudforce-one_api-response-common

object

3 properties 3 required

cloudforce-one_messages

array

cloudforce-one_request-edit

object

5 properties

cloudforce-one_request-asset-list

object

2 properties 2 required

cloudforce-one_quota

object

4 properties

cloudforce-one_request-asset-edit

object

1 property

cloudforce-one_request-content

string

Request content

cloudforce-one_request-message-item

object

6 properties 5 required

cloudforce-one_request-type

string

Requested information from request

cloudforce-one_request-list-item

object

12 properties 7 required

cloudforce-one_message-content

string

Content of message

cloudforce-one_request-message-edit

object

1 property

cloudforce-one_request-list

object

10 properties 2 required

cloudforce-one_request-asset-item

object

5 properties 2 required

cloudforce-one_request-summary

string

Brief description of the request

cloudforce-one_asset-content

string

Asset file to upload

cloudforce-one_request-readable-id

string

Readable Request ID

cloudforce-one_request-message-list

object

6 properties 2 required

cloudforce-one_request-types

array

cloudforce-one_api-response-common-failure

object

4 properties 4 required

cloudforce-one_request-item

object

13 properties 8 required

cloudforce-one_priority

string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Request for Information (RFI)

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Request for Information (RFI) API

Metadata

Authentication & Security 1

Paths & Operations 17

Schemas 28

Specification

Source

API Details

Provider

Explore more