Apply
curl --request PATCH \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/catalog-families/bulk-edit/components \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parents": [
{
"familyId": "<string>",
"familyVersion": 123,
"primaryItemId": "<string>",
"primaryItemVersion": 4503599627370495,
"primaryFamilySourceId": "<string>",
"primaryFamilySourceVersion": 4503599627370495,
"primaryItemSourceId": "<string>",
"primaryItemSourceVersion": 4503599627370495
}
],
"targets": [
{
"componentId": "<string>",
"componentVersion": 123,
"familyId": "<string>",
"familyVersion": 123,
"familySourceId": "<string>",
"familySourceVersion": 4503599627370495,
"itemSourceId": "<string>",
"itemSourceVersion": 4503599627370495,
"links": [
{
"parentId": "<string>",
"parentItemId": "<string>",
"linkId": "<string>"
}
]
}
],
"fieldKey": "<string>",
"value": "<string>",
"selectionMode": "components"
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/catalog-families/bulk-edit/components"
payload = {
"parents": [
{
"familyId": "<string>",
"familyVersion": 123,
"primaryItemId": "<string>",
"primaryItemVersion": 4503599627370495,
"primaryFamilySourceId": "<string>",
"primaryFamilySourceVersion": 4503599627370495,
"primaryItemSourceId": "<string>",
"primaryItemSourceVersion": 4503599627370495
}
],
"targets": [
{
"componentId": "<string>",
"componentVersion": 123,
"familyId": "<string>",
"familyVersion": 123,
"familySourceId": "<string>",
"familySourceVersion": 4503599627370495,
"itemSourceId": "<string>",
"itemSourceVersion": 4503599627370495,
"links": [
{
"parentId": "<string>",
"parentItemId": "<string>",
"linkId": "<string>"
}
]
}
],
"fieldKey": "<string>",
"value": "<string>",
"selectionMode": "components"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parents: [
{
familyId: '<string>',
familyVersion: 123,
primaryItemId: '<string>',
primaryItemVersion: 4503599627370495,
primaryFamilySourceId: '<string>',
primaryFamilySourceVersion: 4503599627370495,
primaryItemSourceId: '<string>',
primaryItemSourceVersion: 4503599627370495
}
],
targets: [
{
componentId: '<string>',
componentVersion: 123,
familyId: '<string>',
familyVersion: 123,
familySourceId: '<string>',
familySourceVersion: 4503599627370495,
itemSourceId: '<string>',
itemSourceVersion: 4503599627370495,
links: [{parentId: '<string>', parentItemId: '<string>', linkId: '<string>'}]
}
],
fieldKey: '<string>',
value: '<string>',
selectionMode: 'components'
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/catalog-families/bulk-edit/components', 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}/catalog-families/bulk-edit/components",
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([
'parents' => [
[
'familyId' => '<string>',
'familyVersion' => 123,
'primaryItemId' => '<string>',
'primaryItemVersion' => 4503599627370495,
'primaryFamilySourceId' => '<string>',
'primaryFamilySourceVersion' => 4503599627370495,
'primaryItemSourceId' => '<string>',
'primaryItemSourceVersion' => 4503599627370495
]
],
'targets' => [
[
'componentId' => '<string>',
'componentVersion' => 123,
'familyId' => '<string>',
'familyVersion' => 123,
'familySourceId' => '<string>',
'familySourceVersion' => 4503599627370495,
'itemSourceId' => '<string>',
'itemSourceVersion' => 4503599627370495,
'links' => [
[
'parentId' => '<string>',
'parentItemId' => '<string>',
'linkId' => '<string>'
]
]
]
],
'fieldKey' => '<string>',
'value' => '<string>',
'selectionMode' => 'components'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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}/catalog-families/bulk-edit/components"
payload := strings.NewReader("{\n \"parents\": [\n {\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"primaryItemId\": \"<string>\",\n \"primaryItemVersion\": 4503599627370495,\n \"primaryFamilySourceId\": \"<string>\",\n \"primaryFamilySourceVersion\": 4503599627370495,\n \"primaryItemSourceId\": \"<string>\",\n \"primaryItemSourceVersion\": 4503599627370495\n }\n ],\n \"targets\": [\n {\n \"componentId\": \"<string>\",\n \"componentVersion\": 123,\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"familySourceId\": \"<string>\",\n \"familySourceVersion\": 4503599627370495,\n \"itemSourceId\": \"<string>\",\n \"itemSourceVersion\": 4503599627370495,\n \"links\": [\n {\n \"parentId\": \"<string>\",\n \"parentItemId\": \"<string>\",\n \"linkId\": \"<string>\"\n }\n ]\n }\n ],\n \"fieldKey\": \"<string>\",\n \"value\": \"<string>\",\n \"selectionMode\": \"components\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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}/catalog-families/bulk-edit/components")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parents\": [\n {\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"primaryItemId\": \"<string>\",\n \"primaryItemVersion\": 4503599627370495,\n \"primaryFamilySourceId\": \"<string>\",\n \"primaryFamilySourceVersion\": 4503599627370495,\n \"primaryItemSourceId\": \"<string>\",\n \"primaryItemSourceVersion\": 4503599627370495\n }\n ],\n \"targets\": [\n {\n \"componentId\": \"<string>\",\n \"componentVersion\": 123,\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"familySourceId\": \"<string>\",\n \"familySourceVersion\": 4503599627370495,\n \"itemSourceId\": \"<string>\",\n \"itemSourceVersion\": 4503599627370495,\n \"links\": [\n {\n \"parentId\": \"<string>\",\n \"parentItemId\": \"<string>\",\n \"linkId\": \"<string>\"\n }\n ]\n }\n ],\n \"fieldKey\": \"<string>\",\n \"value\": \"<string>\",\n \"selectionMode\": \"components\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/catalog-families/bulk-edit/components")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parents\": [\n {\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"primaryItemId\": \"<string>\",\n \"primaryItemVersion\": 4503599627370495,\n \"primaryFamilySourceId\": \"<string>\",\n \"primaryFamilySourceVersion\": 4503599627370495,\n \"primaryItemSourceId\": \"<string>\",\n \"primaryItemSourceVersion\": 4503599627370495\n }\n ],\n \"targets\": [\n {\n \"componentId\": \"<string>\",\n \"componentVersion\": 123,\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"familySourceId\": \"<string>\",\n \"familySourceVersion\": 4503599627370495,\n \"itemSourceId\": \"<string>\",\n \"itemSourceVersion\": 4503599627370495,\n \"links\": [\n {\n \"parentId\": \"<string>\",\n \"parentItemId\": \"<string>\",\n \"linkId\": \"<string>\"\n }\n ]\n }\n ],\n \"fieldKey\": \"<string>\",\n \"value\": \"<string>\",\n \"selectionMode\": \"components\"\n}"
response = http.request(request)
puts response.read_body{
"updatedCount": 123,
"familyIds": [
"<string>"
],
"affectedParentFamilyIds": [
"<string>"
],
"affectedProjectIds": [
"<string>"
]
}Catalog Component Bulk Edit
Apply
PATCH
/
v1
/
workspaces
/
{workspaceId}
/
catalog-families
/
bulk-edit
/
components
Apply
curl --request PATCH \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/catalog-families/bulk-edit/components \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parents": [
{
"familyId": "<string>",
"familyVersion": 123,
"primaryItemId": "<string>",
"primaryItemVersion": 4503599627370495,
"primaryFamilySourceId": "<string>",
"primaryFamilySourceVersion": 4503599627370495,
"primaryItemSourceId": "<string>",
"primaryItemSourceVersion": 4503599627370495
}
],
"targets": [
{
"componentId": "<string>",
"componentVersion": 123,
"familyId": "<string>",
"familyVersion": 123,
"familySourceId": "<string>",
"familySourceVersion": 4503599627370495,
"itemSourceId": "<string>",
"itemSourceVersion": 4503599627370495,
"links": [
{
"parentId": "<string>",
"parentItemId": "<string>",
"linkId": "<string>"
}
]
}
],
"fieldKey": "<string>",
"value": "<string>",
"selectionMode": "components"
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/catalog-families/bulk-edit/components"
payload = {
"parents": [
{
"familyId": "<string>",
"familyVersion": 123,
"primaryItemId": "<string>",
"primaryItemVersion": 4503599627370495,
"primaryFamilySourceId": "<string>",
"primaryFamilySourceVersion": 4503599627370495,
"primaryItemSourceId": "<string>",
"primaryItemSourceVersion": 4503599627370495
}
],
"targets": [
{
"componentId": "<string>",
"componentVersion": 123,
"familyId": "<string>",
"familyVersion": 123,
"familySourceId": "<string>",
"familySourceVersion": 4503599627370495,
"itemSourceId": "<string>",
"itemSourceVersion": 4503599627370495,
"links": [
{
"parentId": "<string>",
"parentItemId": "<string>",
"linkId": "<string>"
}
]
}
],
"fieldKey": "<string>",
"value": "<string>",
"selectionMode": "components"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parents: [
{
familyId: '<string>',
familyVersion: 123,
primaryItemId: '<string>',
primaryItemVersion: 4503599627370495,
primaryFamilySourceId: '<string>',
primaryFamilySourceVersion: 4503599627370495,
primaryItemSourceId: '<string>',
primaryItemSourceVersion: 4503599627370495
}
],
targets: [
{
componentId: '<string>',
componentVersion: 123,
familyId: '<string>',
familyVersion: 123,
familySourceId: '<string>',
familySourceVersion: 4503599627370495,
itemSourceId: '<string>',
itemSourceVersion: 4503599627370495,
links: [{parentId: '<string>', parentItemId: '<string>', linkId: '<string>'}]
}
],
fieldKey: '<string>',
value: '<string>',
selectionMode: 'components'
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/catalog-families/bulk-edit/components', 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}/catalog-families/bulk-edit/components",
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([
'parents' => [
[
'familyId' => '<string>',
'familyVersion' => 123,
'primaryItemId' => '<string>',
'primaryItemVersion' => 4503599627370495,
'primaryFamilySourceId' => '<string>',
'primaryFamilySourceVersion' => 4503599627370495,
'primaryItemSourceId' => '<string>',
'primaryItemSourceVersion' => 4503599627370495
]
],
'targets' => [
[
'componentId' => '<string>',
'componentVersion' => 123,
'familyId' => '<string>',
'familyVersion' => 123,
'familySourceId' => '<string>',
'familySourceVersion' => 4503599627370495,
'itemSourceId' => '<string>',
'itemSourceVersion' => 4503599627370495,
'links' => [
[
'parentId' => '<string>',
'parentItemId' => '<string>',
'linkId' => '<string>'
]
]
]
],
'fieldKey' => '<string>',
'value' => '<string>',
'selectionMode' => 'components'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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}/catalog-families/bulk-edit/components"
payload := strings.NewReader("{\n \"parents\": [\n {\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"primaryItemId\": \"<string>\",\n \"primaryItemVersion\": 4503599627370495,\n \"primaryFamilySourceId\": \"<string>\",\n \"primaryFamilySourceVersion\": 4503599627370495,\n \"primaryItemSourceId\": \"<string>\",\n \"primaryItemSourceVersion\": 4503599627370495\n }\n ],\n \"targets\": [\n {\n \"componentId\": \"<string>\",\n \"componentVersion\": 123,\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"familySourceId\": \"<string>\",\n \"familySourceVersion\": 4503599627370495,\n \"itemSourceId\": \"<string>\",\n \"itemSourceVersion\": 4503599627370495,\n \"links\": [\n {\n \"parentId\": \"<string>\",\n \"parentItemId\": \"<string>\",\n \"linkId\": \"<string>\"\n }\n ]\n }\n ],\n \"fieldKey\": \"<string>\",\n \"value\": \"<string>\",\n \"selectionMode\": \"components\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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}/catalog-families/bulk-edit/components")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parents\": [\n {\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"primaryItemId\": \"<string>\",\n \"primaryItemVersion\": 4503599627370495,\n \"primaryFamilySourceId\": \"<string>\",\n \"primaryFamilySourceVersion\": 4503599627370495,\n \"primaryItemSourceId\": \"<string>\",\n \"primaryItemSourceVersion\": 4503599627370495\n }\n ],\n \"targets\": [\n {\n \"componentId\": \"<string>\",\n \"componentVersion\": 123,\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"familySourceId\": \"<string>\",\n \"familySourceVersion\": 4503599627370495,\n \"itemSourceId\": \"<string>\",\n \"itemSourceVersion\": 4503599627370495,\n \"links\": [\n {\n \"parentId\": \"<string>\",\n \"parentItemId\": \"<string>\",\n \"linkId\": \"<string>\"\n }\n ]\n }\n ],\n \"fieldKey\": \"<string>\",\n \"value\": \"<string>\",\n \"selectionMode\": \"components\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/catalog-families/bulk-edit/components")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parents\": [\n {\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"primaryItemId\": \"<string>\",\n \"primaryItemVersion\": 4503599627370495,\n \"primaryFamilySourceId\": \"<string>\",\n \"primaryFamilySourceVersion\": 4503599627370495,\n \"primaryItemSourceId\": \"<string>\",\n \"primaryItemSourceVersion\": 4503599627370495\n }\n ],\n \"targets\": [\n {\n \"componentId\": \"<string>\",\n \"componentVersion\": 123,\n \"familyId\": \"<string>\",\n \"familyVersion\": 123,\n \"familySourceId\": \"<string>\",\n \"familySourceVersion\": 4503599627370495,\n \"itemSourceId\": \"<string>\",\n \"itemSourceVersion\": 4503599627370495,\n \"links\": [\n {\n \"parentId\": \"<string>\",\n \"parentItemId\": \"<string>\",\n \"linkId\": \"<string>\"\n }\n ]\n }\n ],\n \"fieldKey\": \"<string>\",\n \"value\": \"<string>\",\n \"selectionMode\": \"components\"\n}"
response = http.request(request)
puts response.read_body{
"updatedCount": 123,
"familyIds": [
"<string>"
],
"affectedParentFamilyIds": [
"<string>"
],
"affectedProjectIds": [
"<string>"
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Maximum array length:
100Show child attributes
Show child attributes
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Required string length:
1 - 255Allowed value:
"components"⌘I