Update Reference Item Component
curl --request PATCH \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/components/{componentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"quantity": "<string>",
"componentVersion": 123,
"referenceItemVersion": 123,
"entryVersion": 123,
"collectionVersion": 123
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/components/{componentId}"
payload = {
"quantity": "<string>",
"componentVersion": 123,
"referenceItemVersion": 123,
"entryVersion": 123,
"collectionVersion": 123
}
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({
quantity: '<string>',
componentVersion: 123,
referenceItemVersion: 123,
entryVersion: 123,
collectionVersion: 123
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/components/{componentId}', 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}/reference-items/{referenceItemId}/components/{componentId}",
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([
'quantity' => '<string>',
'componentVersion' => 123,
'referenceItemVersion' => 123,
'entryVersion' => 123,
'collectionVersion' => 123
]),
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}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/components/{componentId}"
payload := strings.NewReader("{\n \"quantity\": \"<string>\",\n \"componentVersion\": 123,\n \"referenceItemVersion\": 123,\n \"entryVersion\": 123,\n \"collectionVersion\": 123\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}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/components/{componentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"quantity\": \"<string>\",\n \"componentVersion\": 123,\n \"referenceItemVersion\": 123,\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}/reference-items/{referenceItemId}/components/{componentId}")
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 \"quantity\": \"<string>\",\n \"componentVersion\": 123,\n \"referenceItemVersion\": 123,\n \"entryVersion\": 123,\n \"collectionVersion\": 123\n}"
response = http.request(request)
puts response.read_body{
"item": {
"id": "<string>",
"referenceItemId": "<string>",
"catalogItemId": "<string>",
"catalogItemType": {},
"kind": "material",
"catalogFamilySourceId": "<string>",
"brandStandardId": "<string>",
"name": "<string>",
"imageUrl": "<string>",
"referenceLabel": "<string>",
"manufacturerName": "<string>",
"sourceLabel": "<string>",
"quantity": "<string>",
"source": "direct",
"position": 123,
"version": 123
},
"referenceItemVersion": 123,
"entryVersion": 123,
"collectionVersion": 123
}Collections
Update Reference Item Component
PATCH
/
v1
/
workspaces
/
{workspaceId}
/
collections
/
{id}
/
entries
/
{entryId}
/
reference-items
/
{referenceItemId}
/
components
/
{componentId}
Update Reference Item Component
curl --request PATCH \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/components/{componentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"quantity": "<string>",
"componentVersion": 123,
"referenceItemVersion": 123,
"entryVersion": 123,
"collectionVersion": 123
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/components/{componentId}"
payload = {
"quantity": "<string>",
"componentVersion": 123,
"referenceItemVersion": 123,
"entryVersion": 123,
"collectionVersion": 123
}
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({
quantity: '<string>',
componentVersion: 123,
referenceItemVersion: 123,
entryVersion: 123,
collectionVersion: 123
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/components/{componentId}', 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}/reference-items/{referenceItemId}/components/{componentId}",
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([
'quantity' => '<string>',
'componentVersion' => 123,
'referenceItemVersion' => 123,
'entryVersion' => 123,
'collectionVersion' => 123
]),
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}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/components/{componentId}"
payload := strings.NewReader("{\n \"quantity\": \"<string>\",\n \"componentVersion\": 123,\n \"referenceItemVersion\": 123,\n \"entryVersion\": 123,\n \"collectionVersion\": 123\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}/collections/{id}/entries/{entryId}/reference-items/{referenceItemId}/components/{componentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"quantity\": \"<string>\",\n \"componentVersion\": 123,\n \"referenceItemVersion\": 123,\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}/reference-items/{referenceItemId}/components/{componentId}")
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 \"quantity\": \"<string>\",\n \"componentVersion\": 123,\n \"referenceItemVersion\": 123,\n \"entryVersion\": 123,\n \"collectionVersion\": 123\n}"
response = http.request(request)
puts response.read_body{
"item": {
"id": "<string>",
"referenceItemId": "<string>",
"catalogItemId": "<string>",
"catalogItemType": {},
"kind": "material",
"catalogFamilySourceId": "<string>",
"brandStandardId": "<string>",
"name": "<string>",
"imageUrl": "<string>",
"referenceLabel": "<string>",
"manufacturerName": "<string>",
"sourceLabel": "<string>",
"quantity": "<string>",
"source": "direct",
"position": 123,
"version": 123
},
"referenceItemVersion": 123,
"entryVersion": 123,
"collectionVersion": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pattern:
^[1-9]\d*$Pattern:
^[1-9]\d*$Pattern:
^[1-9]\d*$Pattern:
^[1-9]\d*$Pattern:
^[1-9]\d*$Body
application/json
Pattern:
^(?!0+(?:\.0{1,2})?$)\d{1,16}(?:\.\d{1,2})?$Required range:
x <= 9007199254740991Required range:
x <= 9007199254740991Required range:
x <= 9007199254740991Required range:
x <= 9007199254740991⌘I