getRecommendationProfiles

Use this method to retrieve information for the behavioral profiles that a specific recommendation applies to.

Parameters

Name	Description	Included in request	Type	Values
`companyId`	The ID of the company the targeted recommendation belongs to.	Optional Note Mandatory when targetting recommendations from another company.	String	Must be a valid company ID for which you have management rights to. Default value: The ID of the company associated with the API key used for the request. Example "companyId": "456def456def456def456def"
`objectId`	The ID of the recommendation you want to retrieve the behavioral profiles for.	Mandatory	String	Must be a valid recommendation ID. Example "objectId": "123abc123abc123abc123abc"

Name

Description

Included in request

Type

Values

companyId

The ID of the company the targeted recommendation belongs to.

Optional

Note

Mandatory when targetting recommendations from another company.

String

Must be a valid company ID for which you have management rights to.

Default value: The ID of the company associated with the API key used for the request.

objectId

The ID of the recommendation you want to retrieve the behavioral profiles for.

Mandatory

String

Must be a valid recommendation ID.

General parameters

These are common parameters, available across all public API methods.

Parameter	Description	Included in request	Type	Values
`id`	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 Example "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
`method`	The name of the method you are using to send the request.	Mandatory	String	Must be a valid method name. Example "method": "methodName"
`jsonrpc`	The version of JSON-RPC used by the request and the response.	Mandatory	Integer	Possible values: `2.0` Example "jsonrpc": "2.0"
`params`	An object containing the configuration of the request.	Mandatory	Object	No additional requirements. Example "params": {...}
Under the `params` object
`page`	The results page number.	Optional	Integer	Default value: `1`
`perPage`	The number of results displayed per page.	Optional	Integer	The upper limit is 100 items per page. Default value: `30`

Return value

Attribute	Type	Description
`items`	Array of objects	Each object contains information regarding a behavioral profile.

Objects

`items`

Attribute	Type	Description
`recommendationId`	String	The ID of the recommendation that applies to this behavioral profile.
`behavioralProfileResource`	String	The ID of the resource that belongs to the behavioral profile.
`behavioralProfileResourceName`	String	The name of the resource that belongs to the behavioral profile.
`behavioralProfileIdentity`	String	The ID of the identity that belongs to the behavioral profile.
`behavioralProfileIdentityName`	String	The name of the identity that belongs to the behavioral profile.

Example

Request:

{
  "params": {
    "page": 1,
    "perPage": 20,
    "objectId": "123abc123abc123abc123abc",
    "companyId": "456def456def456def456def",
    "search": "Font Driver Host"
  },
  "jsonrpc": "2.0",
  "method": "getRecommendationProfiles",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Response:

{
  "total": 9,
  "page": 1,
  "perPage": 20,
  "pagesCount": 1,
  "items": [
    {
      "recommendationId": "123abc123abc123abc123abc",
      "behavioralProfileResource": "00000000-0000-0000-0000-100000000001",
      "behavioralProfileResourceName": "WIN10-TEMPL",
      "behavioralProfileIdentity": "Local_S-1-5-96-0-0_683ebe0d21ee239251adc088",
      "behavioralProfileIdentityName": "Font Driver Host\\UMFD-0"
    },
    {
      "recommendationId": "123abc123abc123abc123abc",
      "behavioralProfileResource": "00000000-0000-0000-0000-100000000001",
      "behavioralProfileResourceName": "WIN10-TEMPL",
      "behavioralProfileIdentity": "Local_S-1-5-96-0-1_683ebe0d21ee239251adc088",
      "behavioralProfileIdentityName": "Font Driver Host\\UMFD-1"
    },
    {
      "recommendationId": "123abc123abc123abc123abc",
      "behavioralProfileResource": "00000000-0000-0000-0000-100000000001",
      "behavioralProfileResourceName": "WIN10-TEMPL",
      "behavioralProfileIdentity": "Local_S-1-5-96-0-2_683ebe0d21ee239251adc088",
      "behavioralProfileIdentityName": "Font Driver Host\\UMFD-2"
    }
  ]
}

In this section: