Compliance

Get the compliance alert filter catalog

Return every criterion a compliance alert filter accepts — each with its key, valueType, allowed operations and live company values (the devices, platforms and owners that currently have an alert). This is the vocabulary for searchComplianceAlerts: use a criterion key as the filter key and one of its values inside the clause ({"<key>":{"operationType":"INCLUDE","values":["<value>"]}}). Call this first whenever you are unsure a criterion or a value exists — searchComplianceAlerts rejects an unknown key with 400. ownerId values are employee ids; resolve their names with getEmployees.

GET

compliance

alerts

filters-options

Get the compliance alert filter catalog

curl --request GET \
  --url https://api.getprimo.com/compliance/alerts/filters-options \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getprimo.com/compliance/alerts/filters-options', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getprimo.com/compliance/alerts/filters-options",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getprimo.com/compliance/alerts/filters-options"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/compliance/alerts/filters-options")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "filterOptions": [
    {
      "key": "<string>",
      "kind": "native",
      "valueType": "multi_select",
      "operationTypes": [
        "INCLUDE"
      ],
      "supportsEmpty": true,
      "description": "<string>",
      "values": [
        {
          "value": "<string>",
          "label": "<string>"
        }
      ]
    }
  ],
  "supportsMatchAny": true
}

Key: Read Scope: Company

Authorizations

Authorization

string

header

required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Response

default - application/json

Every criterion the compliance alert list accepts. Build the filter of getComplianceAlerts by placing, under each option's key, a clause { operationType, values }.

Show child attributes

supportsMatchAny

boolean

required

Whether the filter supports OR across clauses. Criteria are ANDed when false.

Get the compliance alert filter catalog

curl --request GET \
  --url https://api.getprimo.com/compliance/alerts/filters-options \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getprimo.com/compliance/alerts/filters-options', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getprimo.com/compliance/alerts/filters-options",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getprimo.com/compliance/alerts/filters-options"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/compliance/alerts/filters-options")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "filterOptions": [
    {
      "key": "<string>",
      "kind": "native",
      "valueType": "multi_select",
      "operationTypes": [
        "INCLUDE"
      ],
      "supportsEmpty": true,
      "description": "<string>",
      "values": [
        {
          "value": "<string>",
          "label": "<string>"
        }
      ]
    }
  ],
  "supportsMatchAny": true
}

Get started

API Reference

Get the compliance alert filter catalog

Authorizations

Response