Resources
All PUT endpoints update only the fields present in the body; see Updating Resources.
GET/v1/resourcesGET /v1/resources
Code samples
cURL
# You can also use wget
curl -X GET /v1/resources \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
GET /v1/resources
Gets a list of resources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| select | query | string | false | none |
| filter | query | string | false | none |
| sort | query | string | false | none |
| take | query | integer(int32) | false | none |
| skip | query | integer(int32) | false | none |
Example responses
200 Response
{"success":true,"code":0,"message":"string","resources":[{"id":0,"name":"string","type":"string","code":"string","description":"string","source":"string","password":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","data":"string","dataFormat":"string","meta":"string"}],"totalResourcesCount":0}{
"success": true,
"code": 0,
"message": "string",
"resources": [
{
"id": 0,
"name": "string",
"type": "string",
"code": "string",
"description": "string",
"source": "string",
"password": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"data": "string",
"dataFormat": "string",
"meta": "string"
}
],
"totalResourcesCount": 0
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.GetResourcesResponse |
Authentication: API key (x-api-key).
POST/v1/resourcesPOST /v1/resources
Code samples
cURL
# You can also use wget
curl -X POST /v1/resources \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
POST /v1/resources
Inserts a new resource.
Body parameter
{
"resource": {
"id": 0,
"name": "string",
"type": "string",
"code": "string",
"description": "string",
"source": "string",
"password": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"data": "string",
"dataFormat": "string",
"meta": "string"
}
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Management.InsertResourceRequest | false | The request containing the details of the resource to insert. |
Example responses
200 Response
{"resourceId":0,"success":true,"code":0,"message":"string"}{
"resourceId": 0,
"success": true,
"code": 0,
"message": "string"
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.InsertResourceResponse |
Authentication: API key (x-api-key).
PUT/v1/resourcesPUT /v1/resources
Code samples
cURL
# You can also use wget
curl -X PUT /v1/resources \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
PUT /v1/resources
Updates an existing resource.
Body parameter
{
"resource": {
"id": 0,
"name": "string",
"type": "string",
"code": "string",
"description": "string",
"source": "string",
"password": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"data": "string",
"dataFormat": "string",
"meta": "string"
}
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Management.UpdateResourceRequest | false | The request containing the details of the resource to update. |
Example responses
200 Response
{"success":true,"code":0,"message":"string"}{
"success": true,
"code": 0,
"message": "string"
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.UpdateResourceResponse |
Authentication: API key (x-api-key).
DELETE/v1/resources/{resourceId}DELETE /v1/resources/{resourceId}
Code samples
cURL
# You can also use wget
curl -X DELETE /v1/resources/{resourceId} \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
DELETE /v1/resources/\{resourceId\}
Deletes a resource.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| resourceId | path | integer(int32) | true | The resource ID. |
Example responses
200 Response
{"success":true,"code":0,"message":"string"}{
"success": true,
"code": 0,
"message": "string"
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.DeleteResourceResponse |
Authentication: API key (x-api-key).
Last updated on