Get all BRM assessments

cURL

curl --request POST \
  --url https://api-v2.production.higg.org/api/v1/modulecsv/brm \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "from": 123,
  "size": 123,
  "oarIds": [
    "<string>"
  ],
  "assessmentIds": [
    "<string>"
  ],
  "accountIds": [
    "<string>"
  ],
  "accountSacIds": [
    "<string>"
  ],
  "status": [],
  "verified": true,
  "include": [
    "<string>"
  ],
  "lastUpdated": 123,
  "lastActivityDate": 123,
  "lastStatusChange": 123,
  "lastASCStatusDate": 123,
  "greaterThanYear": 123,
  "dctVersion": "<string>",
  "filters": [
    {
      "field": "<string>",
      "operator": "<string>",
      "value": {}
    }
  ],
  "nextPage": "<string>",
  "facilityPosted": true,
  "sipfacilitytype": [
    "<string>"
  ],
  "sort": [
    {
      "field": "<string>"
    }
  ],
  "verificationPosted": 123,
  "wildcardSearch": {
    "sacId": "<string>",
    "accountName": "<string>",
    "oarId": "<string>",
    "tags": "<string>",
    "accountId": "<string>",
    "customId": "<string>",
    "ffcId": "<string>"
  },
  "reportingPeriodStart": 123,
  "reportingPeriodEnd": 123,
  "isBaseMaterialFilter": true
}
'

import requests

url = "https://api-v2.production.higg.org/api/v1/modulecsv/brm"

payload = {
    "from": 123,
    "size": 123,
    "oarIds": ["<string>"],
    "assessmentIds": ["<string>"],
    "accountIds": ["<string>"],
    "accountSacIds": ["<string>"],
    "status": [],
    "verified": True,
    "include": ["<string>"],
    "lastUpdated": 123,
    "lastActivityDate": 123,
    "lastStatusChange": 123,
    "lastASCStatusDate": 123,
    "greaterThanYear": 123,
    "dctVersion": "<string>",
    "filters": [
        {
            "field": "<string>",
            "operator": "<string>",
            "value": {}
        }
    ],
    "nextPage": "<string>",
    "facilityPosted": True,
    "sipfacilitytype": ["<string>"],
    "sort": [{ "field": "<string>" }],
    "verificationPosted": 123,
    "wildcardSearch": {
        "sacId": "<string>",
        "accountName": "<string>",
        "oarId": "<string>",
        "tags": "<string>",
        "accountId": "<string>",
        "customId": "<string>",
        "ffcId": "<string>"
    },
    "reportingPeriodStart": 123,
    "reportingPeriodEnd": 123,
    "isBaseMaterialFilter": True
}
headers = {
    "x-api-key": "<api-key>",
    "x-developer-request-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-developer-request-token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    from: 123,
    size: 123,
    oarIds: ['<string>'],
    assessmentIds: ['<string>'],
    accountIds: ['<string>'],
    accountSacIds: ['<string>'],
    status: [],
    verified: true,
    include: ['<string>'],
    lastUpdated: 123,
    lastActivityDate: 123,
    lastStatusChange: 123,
    lastASCStatusDate: 123,
    greaterThanYear: 123,
    dctVersion: '<string>',
    filters: [{field: '<string>', operator: '<string>', value: {}}],
    nextPage: '<string>',
    facilityPosted: true,
    sipfacilitytype: ['<string>'],
    sort: [{field: '<string>'}],
    verificationPosted: 123,
    wildcardSearch: {
      sacId: '<string>',
      accountName: '<string>',
      oarId: '<string>',
      tags: '<string>',
      accountId: '<string>',
      customId: '<string>',
      ffcId: '<string>'
    },
    reportingPeriodStart: 123,
    reportingPeriodEnd: 123,
    isBaseMaterialFilter: true
  })
};

fetch('https://api-v2.production.higg.org/api/v1/modulecsv/brm', 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-v2.production.higg.org/api/v1/modulecsv/brm",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'from' => 123,
    'size' => 123,
    'oarIds' => [
        '<string>'
    ],
    'assessmentIds' => [
        '<string>'
    ],
    'accountIds' => [
        '<string>'
    ],
    'accountSacIds' => [
        '<string>'
    ],
    'status' => [
        
    ],
    'verified' => true,
    'include' => [
        '<string>'
    ],
    'lastUpdated' => 123,
    'lastActivityDate' => 123,
    'lastStatusChange' => 123,
    'lastASCStatusDate' => 123,
    'greaterThanYear' => 123,
    'dctVersion' => '<string>',
    'filters' => [
        [
                'field' => '<string>',
                'operator' => '<string>',
                'value' => [
                                
                ]
        ]
    ],
    'nextPage' => '<string>',
    'facilityPosted' => true,
    'sipfacilitytype' => [
        '<string>'
    ],
    'sort' => [
        [
                'field' => '<string>'
        ]
    ],
    'verificationPosted' => 123,
    'wildcardSearch' => [
        'sacId' => '<string>',
        'accountName' => '<string>',
        'oarId' => '<string>',
        'tags' => '<string>',
        'accountId' => '<string>',
        'customId' => '<string>',
        'ffcId' => '<string>'
    ],
    'reportingPeriodStart' => 123,
    'reportingPeriodEnd' => 123,
    'isBaseMaterialFilter' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-developer-request-token: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-v2.production.higg.org/api/v1/modulecsv/brm"

	payload := strings.NewReader("{\n  \"from\": 123,\n  \"size\": 123,\n  \"oarIds\": [\n    \"<string>\"\n  ],\n  \"assessmentIds\": [\n    \"<string>\"\n  ],\n  \"accountIds\": [\n    \"<string>\"\n  ],\n  \"accountSacIds\": [\n    \"<string>\"\n  ],\n  \"status\": [],\n  \"verified\": true,\n  \"include\": [\n    \"<string>\"\n  ],\n  \"lastUpdated\": 123,\n  \"lastActivityDate\": 123,\n  \"lastStatusChange\": 123,\n  \"lastASCStatusDate\": 123,\n  \"greaterThanYear\": 123,\n  \"dctVersion\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"nextPage\": \"<string>\",\n  \"facilityPosted\": true,\n  \"sipfacilitytype\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"verificationPosted\": 123,\n  \"wildcardSearch\": {\n    \"sacId\": \"<string>\",\n    \"accountName\": \"<string>\",\n    \"oarId\": \"<string>\",\n    \"tags\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customId\": \"<string>\",\n    \"ffcId\": \"<string>\"\n  },\n  \"reportingPeriodStart\": 123,\n  \"reportingPeriodEnd\": 123,\n  \"isBaseMaterialFilter\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-developer-request-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-v2.production.higg.org/api/v1/modulecsv/brm")
  .header("x-api-key", "<api-key>")
  .header("x-developer-request-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": 123,\n  \"size\": 123,\n  \"oarIds\": [\n    \"<string>\"\n  ],\n  \"assessmentIds\": [\n    \"<string>\"\n  ],\n  \"accountIds\": [\n    \"<string>\"\n  ],\n  \"accountSacIds\": [\n    \"<string>\"\n  ],\n  \"status\": [],\n  \"verified\": true,\n  \"include\": [\n    \"<string>\"\n  ],\n  \"lastUpdated\": 123,\n  \"lastActivityDate\": 123,\n  \"lastStatusChange\": 123,\n  \"lastASCStatusDate\": 123,\n  \"greaterThanYear\": 123,\n  \"dctVersion\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"nextPage\": \"<string>\",\n  \"facilityPosted\": true,\n  \"sipfacilitytype\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"verificationPosted\": 123,\n  \"wildcardSearch\": {\n    \"sacId\": \"<string>\",\n    \"accountName\": \"<string>\",\n    \"oarId\": \"<string>\",\n    \"tags\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customId\": \"<string>\",\n    \"ffcId\": \"<string>\"\n  },\n  \"reportingPeriodStart\": 123,\n  \"reportingPeriodEnd\": 123,\n  \"isBaseMaterialFilter\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-v2.production.higg.org/api/v1/modulecsv/brm")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-developer-request-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": 123,\n  \"size\": 123,\n  \"oarIds\": [\n    \"<string>\"\n  ],\n  \"assessmentIds\": [\n    \"<string>\"\n  ],\n  \"accountIds\": [\n    \"<string>\"\n  ],\n  \"accountSacIds\": [\n    \"<string>\"\n  ],\n  \"status\": [],\n  \"verified\": true,\n  \"include\": [\n    \"<string>\"\n  ],\n  \"lastUpdated\": 123,\n  \"lastActivityDate\": 123,\n  \"lastStatusChange\": 123,\n  \"lastASCStatusDate\": 123,\n  \"greaterThanYear\": 123,\n  \"dctVersion\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"nextPage\": \"<string>\",\n  \"facilityPosted\": true,\n  \"sipfacilitytype\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"verificationPosted\": 123,\n  \"wildcardSearch\": {\n    \"sacId\": \"<string>\",\n    \"accountName\": \"<string>\",\n    \"oarId\": \"<string>\",\n    \"tags\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customId\": \"<string>\",\n    \"ffcId\": \"<string>\"\n  },\n  \"reportingPeriodStart\": 123,\n  \"reportingPeriodEnd\": 123,\n  \"isBaseMaterialFilter\": true\n}"

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

POST

brm

cURL

curl --request POST \
  --url https://api-v2.production.higg.org/api/v1/modulecsv/brm \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "from": 123,
  "size": 123,
  "oarIds": [
    "<string>"
  ],
  "assessmentIds": [
    "<string>"
  ],
  "accountIds": [
    "<string>"
  ],
  "accountSacIds": [
    "<string>"
  ],
  "status": [],
  "verified": true,
  "include": [
    "<string>"
  ],
  "lastUpdated": 123,
  "lastActivityDate": 123,
  "lastStatusChange": 123,
  "lastASCStatusDate": 123,
  "greaterThanYear": 123,
  "dctVersion": "<string>",
  "filters": [
    {
      "field": "<string>",
      "operator": "<string>",
      "value": {}
    }
  ],
  "nextPage": "<string>",
  "facilityPosted": true,
  "sipfacilitytype": [
    "<string>"
  ],
  "sort": [
    {
      "field": "<string>"
    }
  ],
  "verificationPosted": 123,
  "wildcardSearch": {
    "sacId": "<string>",
    "accountName": "<string>",
    "oarId": "<string>",
    "tags": "<string>",
    "accountId": "<string>",
    "customId": "<string>",
    "ffcId": "<string>"
  },
  "reportingPeriodStart": 123,
  "reportingPeriodEnd": 123,
  "isBaseMaterialFilter": true
}
'

import requests

url = "https://api-v2.production.higg.org/api/v1/modulecsv/brm"

payload = {
    "from": 123,
    "size": 123,
    "oarIds": ["<string>"],
    "assessmentIds": ["<string>"],
    "accountIds": ["<string>"],
    "accountSacIds": ["<string>"],
    "status": [],
    "verified": True,
    "include": ["<string>"],
    "lastUpdated": 123,
    "lastActivityDate": 123,
    "lastStatusChange": 123,
    "lastASCStatusDate": 123,
    "greaterThanYear": 123,
    "dctVersion": "<string>",
    "filters": [
        {
            "field": "<string>",
            "operator": "<string>",
            "value": {}
        }
    ],
    "nextPage": "<string>",
    "facilityPosted": True,
    "sipfacilitytype": ["<string>"],
    "sort": [{ "field": "<string>" }],
    "verificationPosted": 123,
    "wildcardSearch": {
        "sacId": "<string>",
        "accountName": "<string>",
        "oarId": "<string>",
        "tags": "<string>",
        "accountId": "<string>",
        "customId": "<string>",
        "ffcId": "<string>"
    },
    "reportingPeriodStart": 123,
    "reportingPeriodEnd": 123,
    "isBaseMaterialFilter": True
}
headers = {
    "x-api-key": "<api-key>",
    "x-developer-request-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-developer-request-token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    from: 123,
    size: 123,
    oarIds: ['<string>'],
    assessmentIds: ['<string>'],
    accountIds: ['<string>'],
    accountSacIds: ['<string>'],
    status: [],
    verified: true,
    include: ['<string>'],
    lastUpdated: 123,
    lastActivityDate: 123,
    lastStatusChange: 123,
    lastASCStatusDate: 123,
    greaterThanYear: 123,
    dctVersion: '<string>',
    filters: [{field: '<string>', operator: '<string>', value: {}}],
    nextPage: '<string>',
    facilityPosted: true,
    sipfacilitytype: ['<string>'],
    sort: [{field: '<string>'}],
    verificationPosted: 123,
    wildcardSearch: {
      sacId: '<string>',
      accountName: '<string>',
      oarId: '<string>',
      tags: '<string>',
      accountId: '<string>',
      customId: '<string>',
      ffcId: '<string>'
    },
    reportingPeriodStart: 123,
    reportingPeriodEnd: 123,
    isBaseMaterialFilter: true
  })
};

fetch('https://api-v2.production.higg.org/api/v1/modulecsv/brm', 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-v2.production.higg.org/api/v1/modulecsv/brm",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'from' => 123,
    'size' => 123,
    'oarIds' => [
        '<string>'
    ],
    'assessmentIds' => [
        '<string>'
    ],
    'accountIds' => [
        '<string>'
    ],
    'accountSacIds' => [
        '<string>'
    ],
    'status' => [
        
    ],
    'verified' => true,
    'include' => [
        '<string>'
    ],
    'lastUpdated' => 123,
    'lastActivityDate' => 123,
    'lastStatusChange' => 123,
    'lastASCStatusDate' => 123,
    'greaterThanYear' => 123,
    'dctVersion' => '<string>',
    'filters' => [
        [
                'field' => '<string>',
                'operator' => '<string>',
                'value' => [
                                
                ]
        ]
    ],
    'nextPage' => '<string>',
    'facilityPosted' => true,
    'sipfacilitytype' => [
        '<string>'
    ],
    'sort' => [
        [
                'field' => '<string>'
        ]
    ],
    'verificationPosted' => 123,
    'wildcardSearch' => [
        'sacId' => '<string>',
        'accountName' => '<string>',
        'oarId' => '<string>',
        'tags' => '<string>',
        'accountId' => '<string>',
        'customId' => '<string>',
        'ffcId' => '<string>'
    ],
    'reportingPeriodStart' => 123,
    'reportingPeriodEnd' => 123,
    'isBaseMaterialFilter' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-developer-request-token: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-v2.production.higg.org/api/v1/modulecsv/brm"

	payload := strings.NewReader("{\n  \"from\": 123,\n  \"size\": 123,\n  \"oarIds\": [\n    \"<string>\"\n  ],\n  \"assessmentIds\": [\n    \"<string>\"\n  ],\n  \"accountIds\": [\n    \"<string>\"\n  ],\n  \"accountSacIds\": [\n    \"<string>\"\n  ],\n  \"status\": [],\n  \"verified\": true,\n  \"include\": [\n    \"<string>\"\n  ],\n  \"lastUpdated\": 123,\n  \"lastActivityDate\": 123,\n  \"lastStatusChange\": 123,\n  \"lastASCStatusDate\": 123,\n  \"greaterThanYear\": 123,\n  \"dctVersion\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"nextPage\": \"<string>\",\n  \"facilityPosted\": true,\n  \"sipfacilitytype\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"verificationPosted\": 123,\n  \"wildcardSearch\": {\n    \"sacId\": \"<string>\",\n    \"accountName\": \"<string>\",\n    \"oarId\": \"<string>\",\n    \"tags\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customId\": \"<string>\",\n    \"ffcId\": \"<string>\"\n  },\n  \"reportingPeriodStart\": 123,\n  \"reportingPeriodEnd\": 123,\n  \"isBaseMaterialFilter\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-developer-request-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-v2.production.higg.org/api/v1/modulecsv/brm")
  .header("x-api-key", "<api-key>")
  .header("x-developer-request-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": 123,\n  \"size\": 123,\n  \"oarIds\": [\n    \"<string>\"\n  ],\n  \"assessmentIds\": [\n    \"<string>\"\n  ],\n  \"accountIds\": [\n    \"<string>\"\n  ],\n  \"accountSacIds\": [\n    \"<string>\"\n  ],\n  \"status\": [],\n  \"verified\": true,\n  \"include\": [\n    \"<string>\"\n  ],\n  \"lastUpdated\": 123,\n  \"lastActivityDate\": 123,\n  \"lastStatusChange\": 123,\n  \"lastASCStatusDate\": 123,\n  \"greaterThanYear\": 123,\n  \"dctVersion\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"nextPage\": \"<string>\",\n  \"facilityPosted\": true,\n  \"sipfacilitytype\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"verificationPosted\": 123,\n  \"wildcardSearch\": {\n    \"sacId\": \"<string>\",\n    \"accountName\": \"<string>\",\n    \"oarId\": \"<string>\",\n    \"tags\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customId\": \"<string>\",\n    \"ffcId\": \"<string>\"\n  },\n  \"reportingPeriodStart\": 123,\n  \"reportingPeriodEnd\": 123,\n  \"isBaseMaterialFilter\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-v2.production.higg.org/api/v1/modulecsv/brm")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-developer-request-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": 123,\n  \"size\": 123,\n  \"oarIds\": [\n    \"<string>\"\n  ],\n  \"assessmentIds\": [\n    \"<string>\"\n  ],\n  \"accountIds\": [\n    \"<string>\"\n  ],\n  \"accountSacIds\": [\n    \"<string>\"\n  ],\n  \"status\": [],\n  \"verified\": true,\n  \"include\": [\n    \"<string>\"\n  ],\n  \"lastUpdated\": 123,\n  \"lastActivityDate\": 123,\n  \"lastStatusChange\": 123,\n  \"lastASCStatusDate\": 123,\n  \"greaterThanYear\": 123,\n  \"dctVersion\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": {}\n    }\n  ],\n  \"nextPage\": \"<string>\",\n  \"facilityPosted\": true,\n  \"sipfacilitytype\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"verificationPosted\": 123,\n  \"wildcardSearch\": {\n    \"sacId\": \"<string>\",\n    \"accountName\": \"<string>\",\n    \"oarId\": \"<string>\",\n    \"tags\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customId\": \"<string>\",\n    \"ffcId\": \"<string>\"\n  },\n  \"reportingPeriodStart\": 123,\n  \"reportingPeriodEnd\": 123,\n  \"isBaseMaterialFilter\": true\n}"

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

Retrieves BRM (Brand & Retail Module) assessment data as a CSV stream based on the filters you provide.

Request body properties

Use the following properties in the request body to filter and paginate your results.

Specify the BRM version to retrieve (e.g., brm2019, brm2020, brm2021, brm2022, brm2023, brm2024, brm2025).

An array of assessment statuses to query for. Possible values include ASI (Assessment In Progress), ASC (Assessment Completed), VRF (Verified).Example: "status": ["ASI", "ASC"]

Filter for records that have changed status since the provided timestamp. The timestamp must be in Unix time in milliseconds.

Filter for records that have been updated since the provided timestamp. The timestamp must be in Unix time in milliseconds.

Boolean filter for verified (true) or unverified (false) assessments.

JSON request example

{
  "status": ["ASI", "ASC"],
  "lastStatusChange": 1672531200000,
  "lastUpdated": 1672531200000,
  "verified": true,
  "version": "brm2023"
}

Additional filters

Name	Type	Description
`accountIds`	`Array<string>`	List of account IDs to filter by.
`accountSacIds`	`Array<string>`	List of SAC IDs to filter by.
`assessmentIds`	`Array<string>`	List of specific assessment IDs to retrieve.
`cafVersion`	`string`	Filter by CAF version.
`dctVersion`	`string`	Filter by DCT version.
`facilityPosted`	`boolean`	Filter for facilities that have been posted.
`filters`	`Array<object>`	Advanced field filters. Each object must include `field`, `operator`, and `value`.
`from`	`number`	Starting index for pagination.
`greaterThanYear`	`number`	Filter assessments greater than a given year.
`include`	`Array<string>`	List of fields to include in the response.
`isBaseMaterialFilter`	`boolean`	Filter by base material status.
`lastASCStatusDate`	`number`	Filter for records with an ASC status date since the provided timestamp.
`lastActivityDate`	`number`	Filter for records that have been shared with your account, or updated, since the provided timestamp.
`lastStatusChange`	`number`	Filter for records that have changed status since the provided timestamp.
`lastUpdated`	`number`	Filter for records that have been updated since the provided timestamp.
`nextPage`	`string`	Pagination token for the next page of results.
`oarIds`	`Array<string>`	List of OAR IDs to filter by.
`reportingPeriodEnd`	`number`	Filter assessments by reporting period end.
`reportingPeriodStart`	`number`	Filter assessments by reporting period start.
`rfi_pid`	`object`	Assessment module version filters.
`sipfacilitytype`	`Array<string>`	List of SIP facility types to filter by.
`size`	`number`	Number of records to return per request.
`sort`	`Array<object>`	Sort order for the results. Each object in the array should contain `field` and `value` (`asc` or `desc`).
`status`	`Array<string>`	Array of assessment statuses to query for.
`verificationPosted`	`number`	Filter by verification posted timestamp.
`verified`	`boolean`	Boolean filter for verified (`true`) or unverified (`false`) assessments.
`wildcardSearch`	`object`	Free-text search fields such as `sacId`, `accountName`, `oarId`, `tags`, `accountId`, `customId`, and `ffcId`.

Implementation details

This endpoint uses a POST request to allow for complex filtering that might exceed URL length limits for query parameters.
The response is a CSV stream containing the requested assessment data.
All timestamps must be in Unix time in milliseconds (e.g., 1672531200000).

Limit bulk CSV data by assessment status and timestamp of last status change

Authorizations

x-api-key

string

header

required

x-developer-request-token

string

header

required

Body

application/json

from

number<double> | null

size

number<double> | null

oarIds

string[] | null

assessmentIds

string[] | null

accountIds

string[] | null

accountSacIds

string[] | null

version

enum<string>

This interface was referenced by Exports's JSON-Schema via the definition "assessmentRfiPid".

Available options:

fem2017,

fem2018,

fem2019,

fem2020,

fem2021,

fem2022,

fem2023,

fem2024,

fem2025,

fem2026,

fslm,

brm2019,

brm2020,

brm2021,

brm2022,

brm2023,

brm2024,

brm2025,

dct,

one2022,

ffc

status

enum<string>[] | null

This interface was referenced by Exports's JSON-Schema via the definition "assessmentStatus".

Available options:

NS,

ASI,

ASC,

VRP,

VRQ,

VRE,

VRC,

VRD,

VRF,

VRI,

ASD

verified

boolean | null

include

string[] | null

lastUpdated

number<double> | null

lastActivityDate

number<double> | null

lastStatusChange

number<double> | null

lastASCStatusDate

number<double> | null

greaterThanYear

number<double> | null

cafVersion

enum<string>

Available options:

2.0,

1.7,

1.6,

1.5,

1.4,

1.3

dctVersion

string | null

filters

object[] | null

Show child attributes

string | null

facilityPosted

boolean | null

sipfacilitytype

string[] | null

sort

object[] | null

Show child attributes

verificationPosted

number<double> | null

rfi_pid

enum<string>

This interface was referenced by Exports's JSON-Schema via the definition "assessmentRfiPid".

Available options:

fem2017,

fem2018,

fem2019,

fem2020,

fem2021,

fem2022,

fem2023,

fem2024,

fem2025,

fem2026,

fslm,

brm2019,

brm2020,

brm2021,

brm2022,

brm2023,

brm2024,

brm2025,

dct,

one2022,

ffc

wildcardSearch

object | null

Show child attributes

reportingPeriodStart

number<double> | null

reportingPeriodEnd

number<double> | null

isBaseMaterialFilter

boolean | null

Response

204

No content

Assessments

PIC API

Product Tools

Request body properties

JSON request example

Additional filters

Implementation details

Limit bulk CSV data by assessment status and timestamp of last status change

Authorizations

Body

Response

​Request body properties

​JSON request example

​Additional filters

​Implementation details

Limit bulk CSV data by assessment status and timestamp of last status change

Authorizations

Body

Response

Request body properties

JSON request example

Additional filters

Implementation details