Update a CRR scorecard
curl --request PATCH \
--url https://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedVersion": 2,
"changeSummary": "<string>",
"name": "<string>",
"description": "<string>",
"factorDefinitions": [
{
"key": "<string>",
"label": "<string>",
"code": 2,
"description": "<string>",
"category": "<string>",
"section": "<string>",
"active": true,
"archived": true,
"minScore": 123,
"maxScore": 123,
"defaultWeight": 0.5
}
],
"thresholds": [
{
"label": "<string>",
"min": 123,
"max": 123,
"color": "<string>"
}
]
}
'import requests
url = "https://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}"
payload = {
"expectedVersion": 2,
"changeSummary": "<string>",
"name": "<string>",
"description": "<string>",
"factorDefinitions": [
{
"key": "<string>",
"label": "<string>",
"code": 2,
"description": "<string>",
"category": "<string>",
"section": "<string>",
"active": True,
"archived": True,
"minScore": 123,
"maxScore": 123,
"defaultWeight": 0.5
}
],
"thresholds": [
{
"label": "<string>",
"min": 123,
"max": 123,
"color": "<string>"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedVersion: 2,
changeSummary: '<string>',
name: '<string>',
description: '<string>',
factorDefinitions: [
{
key: '<string>',
label: '<string>',
code: 2,
description: '<string>',
category: '<string>',
section: '<string>',
active: true,
archived: true,
minScore: 123,
maxScore: 123,
defaultWeight: 0.5
}
],
thresholds: [{label: '<string>', min: 123, max: 123, color: '<string>'}]
})
};
fetch('https://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}', 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://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expectedVersion' => 2,
'changeSummary' => '<string>',
'name' => '<string>',
'description' => '<string>',
'factorDefinitions' => [
[
'key' => '<string>',
'label' => '<string>',
'code' => 2,
'description' => '<string>',
'category' => '<string>',
'section' => '<string>',
'active' => true,
'archived' => true,
'minScore' => 123,
'maxScore' => 123,
'defaultWeight' => 0.5
]
],
'thresholds' => [
[
'label' => '<string>',
'min' => 123,
'max' => 123,
'color' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}"
payload := strings.NewReader("{\n \"expectedVersion\": 2,\n \"changeSummary\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"factorDefinitions\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"code\": 2,\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"section\": \"<string>\",\n \"active\": true,\n \"archived\": true,\n \"minScore\": 123,\n \"maxScore\": 123,\n \"defaultWeight\": 0.5\n }\n ],\n \"thresholds\": [\n {\n \"label\": \"<string>\",\n \"min\": 123,\n \"max\": 123,\n \"color\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<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.patch("https://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expectedVersion\": 2,\n \"changeSummary\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"factorDefinitions\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"code\": 2,\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"section\": \"<string>\",\n \"active\": true,\n \"archived\": true,\n \"minScore\": 123,\n \"maxScore\": 123,\n \"defaultWeight\": 0.5\n }\n ],\n \"thresholds\": [\n {\n \"label\": \"<string>\",\n \"min\": 123,\n \"max\": 123,\n \"color\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedVersion\": 2,\n \"changeSummary\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"factorDefinitions\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"code\": 2,\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"section\": \"<string>\",\n \"active\": true,\n \"archived\": true,\n \"minScore\": 123,\n \"maxScore\": 123,\n \"defaultWeight\": 0.5\n }\n ],\n \"thresholds\": [\n {\n \"label\": \"<string>\",\n \"min\": 123,\n \"max\": 123,\n \"color\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"status": 400,
"message": "Bad request",
"code": "VALIDATION_ERROR"
}<string><string><string>CRR Scorecards
Update a CRR scorecard
Updates a scorecard. Requires an admin application key (tenant-scoped, created by an owner or admin) or a dashboard user token. Writes by a user token require an owner or admin.
PATCH
/
v2
/
organizations
/
{orgId}
/
workspaces
/
{workspaceId}
/
crr-scorecards
/
{scorecardId}
Update a CRR scorecard
curl --request PATCH \
--url https://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedVersion": 2,
"changeSummary": "<string>",
"name": "<string>",
"description": "<string>",
"factorDefinitions": [
{
"key": "<string>",
"label": "<string>",
"code": 2,
"description": "<string>",
"category": "<string>",
"section": "<string>",
"active": true,
"archived": true,
"minScore": 123,
"maxScore": 123,
"defaultWeight": 0.5
}
],
"thresholds": [
{
"label": "<string>",
"min": 123,
"max": 123,
"color": "<string>"
}
]
}
'import requests
url = "https://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}"
payload = {
"expectedVersion": 2,
"changeSummary": "<string>",
"name": "<string>",
"description": "<string>",
"factorDefinitions": [
{
"key": "<string>",
"label": "<string>",
"code": 2,
"description": "<string>",
"category": "<string>",
"section": "<string>",
"active": True,
"archived": True,
"minScore": 123,
"maxScore": 123,
"defaultWeight": 0.5
}
],
"thresholds": [
{
"label": "<string>",
"min": 123,
"max": 123,
"color": "<string>"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedVersion: 2,
changeSummary: '<string>',
name: '<string>',
description: '<string>',
factorDefinitions: [
{
key: '<string>',
label: '<string>',
code: 2,
description: '<string>',
category: '<string>',
section: '<string>',
active: true,
archived: true,
minScore: 123,
maxScore: 123,
defaultWeight: 0.5
}
],
thresholds: [{label: '<string>', min: 123, max: 123, color: '<string>'}]
})
};
fetch('https://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}', 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://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expectedVersion' => 2,
'changeSummary' => '<string>',
'name' => '<string>',
'description' => '<string>',
'factorDefinitions' => [
[
'key' => '<string>',
'label' => '<string>',
'code' => 2,
'description' => '<string>',
'category' => '<string>',
'section' => '<string>',
'active' => true,
'archived' => true,
'minScore' => 123,
'maxScore' => 123,
'defaultWeight' => 0.5
]
],
'thresholds' => [
[
'label' => '<string>',
'min' => 123,
'max' => 123,
'color' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}"
payload := strings.NewReader("{\n \"expectedVersion\": 2,\n \"changeSummary\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"factorDefinitions\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"code\": 2,\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"section\": \"<string>\",\n \"active\": true,\n \"archived\": true,\n \"minScore\": 123,\n \"maxScore\": 123,\n \"defaultWeight\": 0.5\n }\n ],\n \"thresholds\": [\n {\n \"label\": \"<string>\",\n \"min\": 123,\n \"max\": 123,\n \"color\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<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.patch("https://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expectedVersion\": 2,\n \"changeSummary\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"factorDefinitions\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"code\": 2,\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"section\": \"<string>\",\n \"active\": true,\n \"archived\": true,\n \"minScore\": 123,\n \"maxScore\": 123,\n \"defaultWeight\": 0.5\n }\n ],\n \"thresholds\": [\n {\n \"label\": \"<string>\",\n \"min\": 123,\n \"max\": 123,\n \"color\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://admin-api.gominerva.com/v2/organizations/{orgId}/workspaces/{workspaceId}/crr-scorecards/{scorecardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedVersion\": 2,\n \"changeSummary\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"factorDefinitions\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"code\": 2,\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"section\": \"<string>\",\n \"active\": true,\n \"archived\": true,\n \"minScore\": 123,\n \"maxScore\": 123,\n \"defaultWeight\": 0.5\n }\n ],\n \"thresholds\": [\n {\n \"label\": \"<string>\",\n \"min\": 123,\n \"max\": 123,\n \"color\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"status": 400,
"message": "Bad request",
"code": "VALIDATION_ERROR"
}<string><string><string>Authorizations
AdminApiKeyAuthUserTokenAuth
An admin application key: Authorization: Api-Key <token> (or legacy x-api-key). Only tenant owners and admins can create one. Standard keys are refused with 403 on workspace management and tenant configuration routes.
Path Parameters
The organization (tenant) id. Must equal the tenant of the admin key.
A workspace id in this organization. A workspace of another organization is 404.
The scorecard id.
Body
application/json
Besides expectedVersion and changeSummary, at least one of name, description, status, factorDefinitions or thresholds is required.
Required range:
x >= 1Required string length:
1 - 500Required string length:
1 - 120Maximum string length:
1000Available options:
draft, active, archived Maximum array length:
200Show child attributes
Show child attributes
Maximum array length:
20Show child attributes
Show child attributes
Response
Success
Envelope { data: { id, ... } } carrying the requested tenant-configuration record(s).