API Reference
del
DELETE HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | Input for DELETE operation |
Throws
RestApiError
generateClient
Generates an API client that can work with models or raw GraphQL
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
options | false |
Throws
Error- Throws error when client cannot be generated due to configuration issues.
Returns
<>get
GET HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | Input for GET operation |
Throws
RestApiError
head
HEAD HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | Input for HEAD operation |
Throws
RestApiError
isCancelError
Check if an error is caused by user calling
cancel() in REST API.Parameters
| Option | Required | Type | Description |
|---|---|---|---|
error | true | unknown | The unknown exception to be checked. |
Returns
CanceledErrorpatch
PATCH HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | Input for PATCH operation |
Throws
RestApiError
post
POST HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | Input for POST operation |
Throws
RestApiError
put
PUT HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | Input for PUT operation |
Throws
RestApiError
Link Color Legend
Interface
Reference
Other