Update Linked Instruction Visibility
curl --request PATCH \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility \
--header 'Content-Type: application/json' \
--data '
{
"instructionKey": "<string>",
"enabled": true,
"entryVersion": 123,
"collectionVersion": 123
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility"
payload = {
"instructionKey": "<string>",
"enabled": True,
"entryVersion": 123,
"collectionVersion": 123
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
instructionKey: '<string>',
enabled: true,
entryVersion: 123,
collectionVersion: 123
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility', 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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility",
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([
'instructionKey' => '<string>',
'enabled' => true,
'entryVersion' => 123,
'collectionVersion' => 123
]),
CURLOPT_HTTPHEADER => [
"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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility"
payload := strings.NewReader("{\n \"instructionKey\": \"<string>\",\n \"enabled\": true,\n \"entryVersion\": 123,\n \"collectionVersion\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility")
.header("Content-Type", "application/json")
.body("{\n \"instructionKey\": \"<string>\",\n \"enabled\": true,\n \"entryVersion\": 123,\n \"collectionVersion\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"instructionKey\": \"<string>\",\n \"enabled\": true,\n \"entryVersion\": 123,\n \"collectionVersion\": 123\n}"
response = http.request(request)
puts response.read_body{
"guidance": {
"revision": 123,
"classification": {
"categoryId": "<string>",
"productTypeId": "<string>"
},
"instructions": [
{
"groupId": "<string>",
"groupLineageId": "<string>",
"groupLabel": "<string>",
"items": [
{
"key": "<string>",
"id": "<string>",
"lineageId": "<string>",
"text": "<string>",
"assigneeRoleGroupIds": [
"warehouse"
],
"position": 123,
"origin": "entry",
"source": {
"kind": "collection",
"id": "<string>",
"name": "<string>",
"version": 123,
"collectionId": "<string>",
"collectionVersion": 123
}
}
]
}
],
"requirements": [
{
"groupId": "<string>",
"groupLineageId": "<string>",
"groupLabel": "<string>",
"items": [
{
"id": "<string>",
"lineageId": "<string>",
"text": "<string>",
"assigneeRoleGroupIds": [
"warehouse"
],
"position": 123,
"origin": "category"
}
]
}
],
"linkedInstructions": [
{
"id": "<string>",
"text": "<string>",
"assigneeRoleGroupIds": [
"warehouse"
],
"key": "<string>",
"source": {
"kind": "collection",
"id": "<string>",
"name": "<string>",
"version": 123,
"collectionId": "<string>",
"collectionVersion": 123
},
"disabled": true
}
]
},
"entryVersion": 123,
"collectionVersion": 123
}Collection Entry Category Guidance
Update Linked Instruction Visibility
PATCH
/
v1
/
workspaces
/
{workspaceId}
/
collections
/
{id}
/
entries
/
{entryId}
/
category-guidance
/
linked-instructions
/
visibility
Update Linked Instruction Visibility
curl --request PATCH \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility \
--header 'Content-Type: application/json' \
--data '
{
"instructionKey": "<string>",
"enabled": true,
"entryVersion": 123,
"collectionVersion": 123
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility"
payload = {
"instructionKey": "<string>",
"enabled": True,
"entryVersion": 123,
"collectionVersion": 123
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
instructionKey: '<string>',
enabled: true,
entryVersion: 123,
collectionVersion: 123
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility', 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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility",
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([
'instructionKey' => '<string>',
'enabled' => true,
'entryVersion' => 123,
'collectionVersion' => 123
]),
CURLOPT_HTTPHEADER => [
"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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility"
payload := strings.NewReader("{\n \"instructionKey\": \"<string>\",\n \"enabled\": true,\n \"entryVersion\": 123,\n \"collectionVersion\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility")
.header("Content-Type", "application/json")
.body("{\n \"instructionKey\": \"<string>\",\n \"enabled\": true,\n \"entryVersion\": 123,\n \"collectionVersion\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/category-guidance/linked-instructions/visibility")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"instructionKey\": \"<string>\",\n \"enabled\": true,\n \"entryVersion\": 123,\n \"collectionVersion\": 123\n}"
response = http.request(request)
puts response.read_body{
"guidance": {
"revision": 123,
"classification": {
"categoryId": "<string>",
"productTypeId": "<string>"
},
"instructions": [
{
"groupId": "<string>",
"groupLineageId": "<string>",
"groupLabel": "<string>",
"items": [
{
"key": "<string>",
"id": "<string>",
"lineageId": "<string>",
"text": "<string>",
"assigneeRoleGroupIds": [
"warehouse"
],
"position": 123,
"origin": "entry",
"source": {
"kind": "collection",
"id": "<string>",
"name": "<string>",
"version": 123,
"collectionId": "<string>",
"collectionVersion": 123
}
}
]
}
],
"requirements": [
{
"groupId": "<string>",
"groupLineageId": "<string>",
"groupLabel": "<string>",
"items": [
{
"id": "<string>",
"lineageId": "<string>",
"text": "<string>",
"assigneeRoleGroupIds": [
"warehouse"
],
"position": 123,
"origin": "category"
}
]
}
],
"linkedInstructions": [
{
"id": "<string>",
"text": "<string>",
"assigneeRoleGroupIds": [
"warehouse"
],
"key": "<string>",
"source": {
"kind": "collection",
"id": "<string>",
"name": "<string>",
"version": 123,
"collectionId": "<string>",
"collectionVersion": 123
},
"disabled": true
}
]
},
"entryVersion": 123,
"collectionVersion": 123
}Body
application/json
Pattern:
^(?:(?:catalog|template):[1-9]\d*:(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)|collection:[1-9]\d*:[1-9]\d*)$Required range:
x <= 9007199254740991Required range:
x <= 9007199254740991⌘I