curl --request POST \
--url https://api-staging.pixwel.com/api/assets/{id}/workflow/note \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"phase": "<string>",
"note": "<string>"
}
'import requests
url = "https://api-staging.pixwel.com/api/assets/{id}/workflow/note"
payload = {
"phase": "<string>",
"note": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({phase: '<string>', note: '<string>'})
};
fetch('https://api-staging.pixwel.com/api/assets/{id}/workflow/note', 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-staging.pixwel.com/api/assets/{id}/workflow/note",
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([
'phase' => '<string>',
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://api-staging.pixwel.com/api/assets/{id}/workflow/note"
payload := strings.NewReader("{\n \"phase\": \"<string>\",\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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-staging.pixwel.com/api/assets/{id}/workflow/note")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"phase\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.pixwel.com/api/assets/{id}/workflow/note")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phase\": \"<string>\",\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "507f1f77bcf86cd799439011",
"studio": "507f1f77bcf86cd799439011",
"project": "507f1f77bcf86cd799439011",
"name": "<string>",
"usage": {
"broadcast": true,
"online": true,
"dcp": true,
"film35": true,
"film70": true,
"dcp4k": true,
"imax": true,
"atmos": true
},
"importName": "<string>",
"slug": "<string>",
"type": "<string>",
"thumbnail": "507f1f77bcf86cd799439011",
"verified": true,
"previews": [
{
"_id": "507f1f77bcf86cd799439011",
"asset": "507f1f77bcf86cd799439011",
"created": 123,
"label": "<string>",
"language": "<string>",
"project": "507f1f77bcf86cd799439011",
"revision": "<string>",
"studio": "507f1f77bcf86cd799439011",
"type": "<string>",
"cdn": {
"domain": "<string>",
"path": "<string>",
"key": "<string>"
}
}
],
"created": 123,
"mediaType": "<string>",
"creative": true,
"$links": {
"self": "//example.com/path/to/object",
"thumbnail": "//example.com/path/to/object",
"project": "//example.com/path/to/object",
"studio": "//example.com/path/to/object",
"type": "//example.com/path/to/object",
"transcription": "//example.com/path/to/object"
},
"$flags": "<unknown>",
"$permissions": {
"canAutosub": true,
"sources": {
"requests": {
"languages": "<unknown>",
"countries": "<unknown>"
},
"autosubs": {
"languages": "<unknown>",
"countries": "<unknown>"
}
},
"access": [
"<string>"
],
"tags": {
"online": true,
"broadcast": true,
"dcp": true,
"cmyk": true,
"rgb": true
},
"ingest": [
"<string>"
]
},
"$embargo": true,
"$feedback": {
"share": "<unknown>",
"vote": "<unknown>",
"summary": "<unknown>"
},
"transcription": {
"script": "507f1f77bcf86cd799439011",
"_id": "507f1f77bcf86cd799439011",
"graphics": "507f1f77bcf86cd799439011"
},
"creator": "507f1f77bcf86cd799439011",
"private": true,
"unorderable": true,
"aspectRatio": "<string>",
"autosubIngest": "507f1f77bcf86cd799439011",
"notifyUrl": "https://example.com/path/to/object",
"embargo": 123
}Save a workflow phase note
Replaces the note on the asset’s current workflow phase. Mutates a single asset; it is not a collection endpoint.
curl --request POST \
--url https://api-staging.pixwel.com/api/assets/{id}/workflow/note \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"phase": "<string>",
"note": "<string>"
}
'import requests
url = "https://api-staging.pixwel.com/api/assets/{id}/workflow/note"
payload = {
"phase": "<string>",
"note": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({phase: '<string>', note: '<string>'})
};
fetch('https://api-staging.pixwel.com/api/assets/{id}/workflow/note', 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-staging.pixwel.com/api/assets/{id}/workflow/note",
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([
'phase' => '<string>',
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://api-staging.pixwel.com/api/assets/{id}/workflow/note"
payload := strings.NewReader("{\n \"phase\": \"<string>\",\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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-staging.pixwel.com/api/assets/{id}/workflow/note")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"phase\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.pixwel.com/api/assets/{id}/workflow/note")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phase\": \"<string>\",\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "507f1f77bcf86cd799439011",
"studio": "507f1f77bcf86cd799439011",
"project": "507f1f77bcf86cd799439011",
"name": "<string>",
"usage": {
"broadcast": true,
"online": true,
"dcp": true,
"film35": true,
"film70": true,
"dcp4k": true,
"imax": true,
"atmos": true
},
"importName": "<string>",
"slug": "<string>",
"type": "<string>",
"thumbnail": "507f1f77bcf86cd799439011",
"verified": true,
"previews": [
{
"_id": "507f1f77bcf86cd799439011",
"asset": "507f1f77bcf86cd799439011",
"created": 123,
"label": "<string>",
"language": "<string>",
"project": "507f1f77bcf86cd799439011",
"revision": "<string>",
"studio": "507f1f77bcf86cd799439011",
"type": "<string>",
"cdn": {
"domain": "<string>",
"path": "<string>",
"key": "<string>"
}
}
],
"created": 123,
"mediaType": "<string>",
"creative": true,
"$links": {
"self": "//example.com/path/to/object",
"thumbnail": "//example.com/path/to/object",
"project": "//example.com/path/to/object",
"studio": "//example.com/path/to/object",
"type": "//example.com/path/to/object",
"transcription": "//example.com/path/to/object"
},
"$flags": "<unknown>",
"$permissions": {
"canAutosub": true,
"sources": {
"requests": {
"languages": "<unknown>",
"countries": "<unknown>"
},
"autosubs": {
"languages": "<unknown>",
"countries": "<unknown>"
}
},
"access": [
"<string>"
],
"tags": {
"online": true,
"broadcast": true,
"dcp": true,
"cmyk": true,
"rgb": true
},
"ingest": [
"<string>"
]
},
"$embargo": true,
"$feedback": {
"share": "<unknown>",
"vote": "<unknown>",
"summary": "<unknown>"
},
"transcription": {
"script": "507f1f77bcf86cd799439011",
"_id": "507f1f77bcf86cd799439011",
"graphics": "507f1f77bcf86cd799439011"
},
"creator": "507f1f77bcf86cd799439011",
"private": true,
"unorderable": true,
"aspectRatio": "<string>",
"autosubIngest": "507f1f77bcf86cd799439011",
"notifyUrl": "https://example.com/path/to/object",
"embargo": 123
}Authorizations
Email address and password. A personal access token (pat_…) or session token (token-…) may also be sent in the password field, with any non-empty value as the username — a blank username short-circuits to a 401 before the token is read.
Path Parameters
Body
Response
Note saved; returns the updated asset
"507f1f77bcf86cd799439011"
"507f1f77bcf86cd799439011"
"507f1f77bcf86cd799439011"
Show child attributes
Show child attributes
"507f1f77bcf86cd799439011"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Shape not inferred — the sampled response had no entries
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"507f1f77bcf86cd799439011"
"507f1f77bcf86cd799439011"
"https://example.com/path/to/object"