/api/<resource>
GET#
Returns a ArchitectResource array which represents collection of your resources.
Parameters#
This method does not require any parameters.
Response#
Successful response returns a HTTP 200 OK status and the following body:
| Type | Description |
|---|---|
ArchitectResource | Resource collection |
POST#
Returns a ArchitectResource which represents your created resource.
Parameters#
This method takes 1 parameter:
| Parameter | Required | Type | Default value | Description |
|---|---|---|---|---|
resourceData | true | Record<string, any> | Data representing the resource you want to create |
Response#
Successful response returns a HTTP 200 OK status and the following body:
| Type | Description |
|---|---|
ArchitectResource | Created resource |
PUT#
Returns a ArchitectResource which represents your updated resource.
Parameters#
This method takes 2 parameters:
| Parameter | Required | Type | Default value | Description |
|---|---|---|---|---|
resourceId | true | string | Id representing id of your resource | |
resourceData | true | Record<string, any> | Data you want to update for the given resource |
Response#
Successful response returns a HTTP 200 OK status and the following body:
| Type | Description |
|---|---|
ArchitectResource | Updated resource |
DELETE#
Returns a boolean representing resource removal confirmation.
Parameters#
This method takes 1 route parameter:
| Parameter | Required | Type | Default value | Description |
|---|---|---|---|---|
resourceId | true | string | Unique ID representing your resource |
Response#
Successful response returns a HTTP 200 OK status and the following body:
| Type | Description |
|---|---|
boolean | Returns a boolean based on removal confirmation |