getAllCompanyResources
Use this method to retrieve all detected resources for a company.
Parameters
Name | Description | Included in request | Type | Values |
|---|---|---|---|---|
| A text value used to search and return only the resources whose names match the specified string. | Optional | String | No additional requirements. If not included, the response will include all resources. |
These are common parameters, available across all public API methods.
Parameter | Description | Included in request | Type | Value requirements |
|---|---|---|---|---|
| This parameter adds an identifier to the request, linking it to its corresponding response. The target replies with the same value in the response, allowing easy call tracking. | Mandatory | String | No additional requirements. |
| The name of the method you are using to send the request. | Mandatory | String | Must be a valid method name. |
| The version of JSON-RPC used by the request and the response. | Mandatory | Integer | The only possible value is
|
| An object containing the configuration of the request. | Mandatory | Object | No additional requirements. |
Under the | ||||
| The results page number. | Optional | Integer | Default value: |
| The number of results displayed per page. | Optional | Integer | The upper limit is 100 items per page. Default value: |
Return value
Attribute | Type | Description |
|---|---|---|
| Array of objects | Each object contains information on a resource. |
Objects
items
Attribute | Type | Description |
|---|---|---|
| String | The ID of the resource. |
| String | The name of the resource. |
Example
Request:
{
"params": {
"companyId": "67fe8595d4db0d536908ec92", - NOT required
"page": 1, - NOT required
"perPage": 10, - NOT required
"searchString": "AutoTest", - NOT required
},
"jsonrpc": "2.0",
"method": "getAllCompanyResources", - required
"id": "b7e2c1d4-9f8a-4c2e-8b1a-ef1234567890"
}Response:
{
"id": "b7e2c1d4-9f8a-4c2e-8b1a-ef1234567890",
"jsonrpc": "2.0",
"result": [
{
"behavioralProfileResource": "d5cff268-b67c-4cad-90c8-ff2742f3bf43-47146daa1909",
"behavioralProfileResourceName": "AutoTestWinSpecialV1-bsd6i"
},
{
"behavioralProfileResource": "d5cff268-b67c-4cad-90c8-ff2742f3bf43-47146daa1909",
"behavioralProfileResourceName": "AutoTestWinSpecialV1-bsd6i"
},
]
}