Update Submission Document Details
curl --request PATCH \
--url https://vision.pingintel.com/api/v1/submission/{id}/document/{filename} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"filename": "<string>",
"is_archived": true
}
'import requests
url = "https://vision.pingintel.com/api/v1/submission/{id}/document/{filename}"
payload = {
"filename": "<string>",
"is_archived": True
}
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({filename: '<string>', is_archived: true})
};
fetch('https://vision.pingintel.com/api/v1/submission/{id}/document/{filename}', 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://vision.pingintel.com/api/v1/submission/{id}/document/{filename}",
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([
'filename' => '<string>',
'is_archived' => true
]),
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://vision.pingintel.com/api/v1/submission/{id}/document/{filename}"
payload := strings.NewReader("{\n \"filename\": \"<string>\",\n \"is_archived\": true\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://vision.pingintel.com/api/v1/submission/{id}/document/{filename}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filename\": \"<string>\",\n \"is_archived\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vision.pingintel.com/api/v1/submission/{id}/document/{filename}")
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 \"filename\": \"<string>\",\n \"is_archived\": true\n}"
response = http.request(request)
puts response.read_body{
"filename": "<string>",
"document_type": "SOV",
"is_archived": true
}{
"error": "<string>",
"errors": {}
}{
"detail": "<string>",
"error": "<string>"
}Update Submission
Update Submission Document Details
Update details of a submission document, such as renaming, changing type, or archiving.
PATCH
/
api
/
v1
/
submission
/
{id}
/
document
/
{filename}
Update Submission Document Details
curl --request PATCH \
--url https://vision.pingintel.com/api/v1/submission/{id}/document/{filename} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"filename": "<string>",
"is_archived": true
}
'import requests
url = "https://vision.pingintel.com/api/v1/submission/{id}/document/{filename}"
payload = {
"filename": "<string>",
"is_archived": True
}
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({filename: '<string>', is_archived: true})
};
fetch('https://vision.pingintel.com/api/v1/submission/{id}/document/{filename}', 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://vision.pingintel.com/api/v1/submission/{id}/document/{filename}",
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([
'filename' => '<string>',
'is_archived' => true
]),
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://vision.pingintel.com/api/v1/submission/{id}/document/{filename}"
payload := strings.NewReader("{\n \"filename\": \"<string>\",\n \"is_archived\": true\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://vision.pingintel.com/api/v1/submission/{id}/document/{filename}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filename\": \"<string>\",\n \"is_archived\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vision.pingintel.com/api/v1/submission/{id}/document/{filename}")
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 \"filename\": \"<string>\",\n \"is_archived\": true\n}"
response = http.request(request)
puts response.read_body{
"filename": "<string>",
"document_type": "SOV",
"is_archived": true
}{
"error": "<string>",
"errors": {}
}{
"detail": "<string>",
"error": "<string>"
}Authorizations
Supports Token-prefixed API keys and Bearer-prefixed JWT-based authentication.
Path Parameters
The filename of the document to update.
The pingid of the submission.
Body
application/json
SOV- SOVSOV_WORKING_FILE- SOV Working FileLOSS_RUN- Loss RunACORD- ACORDPDF- PDFUNKNOWN- UnknownSOVFIXER_OUTPUT- SOVFixer OutputEML- EMLMSG- MSGEMAIL_HTML- Email HTMLEMAIL_BODY_HTML- Email Body HTMLEMAIL_BODY_TXT- Email Body TextOTHER- OtherAIR_P_CSV- AIR Policy CSVAIR_L_CSV- AIR Location CSVRMS_P_CSV- RMS Policy CSVRMS_L_CSV- RMS Location CSVCAT_MODEL_OUTPUT- CAT Model OutputCAT_RESULT_JSON- CAT Result JsonUFS_CSV- UFS CSVSOVFIXER_JSON- SOVFixer JSONSOVFIXER_SCRUBBER- SOVFixer ScrubberSOVFIXER_AIR_P_CSV- AIR Policy CSVSOVFIXER_AIR_L_CSV- AIR Location CSVSOVFIXER_RMS_P_CSV- RMS Policy CSVSOVFIXER_RMS_L_CSV- RMS Location CSV
Available options:
SOV, SOV_WORKING_FILE, LOSS_RUN, ACORD, PDF, UNKNOWN, SOVFIXER_OUTPUT, EML, MSG, EMAIL_HTML, EMAIL_BODY_HTML, EMAIL_BODY_TXT, OTHER, AIR_P_CSV, AIR_L_CSV, RMS_P_CSV, RMS_L_CSV, CAT_MODEL_OUTPUT, CAT_RESULT_JSON, UFS_CSV, SOVFIXER_JSON, SOVFIXER_SCRUBBER, SOVFIXER_AIR_P_CSV, SOVFIXER_AIR_L_CSV, SOVFIXER_RMS_P_CSV, SOVFIXER_RMS_L_CSV, , null Maximum string length:
2000Set to true to archive the document. This is a soft delete, the document is not removed from the database.
Response
Maximum string length:
2000SOV- SOVSOV_WORKING_FILE- SOV Working FileLOSS_RUN- Loss RunACORD- ACORDPDF- PDFUNKNOWN- UnknownSOVFIXER_OUTPUT- SOVFixer OutputEML- EMLMSG- MSGEMAIL_HTML- Email HTMLEMAIL_BODY_HTML- Email Body HTMLEMAIL_BODY_TXT- Email Body TextOTHER- OtherAIR_P_CSV- AIR Policy CSVAIR_L_CSV- AIR Location CSVRMS_P_CSV- RMS Policy CSVRMS_L_CSV- RMS Location CSVCAT_MODEL_OUTPUT- CAT Model OutputCAT_RESULT_JSON- CAT Result JsonUFS_CSV- UFS CSVSOVFIXER_JSON- SOVFixer JSONSOVFIXER_SCRUBBER- SOVFixer ScrubberSOVFIXER_AIR_P_CSV- AIR Policy CSVSOVFIXER_AIR_L_CSV- AIR Location CSVSOVFIXER_RMS_P_CSV- RMS Policy CSVSOVFIXER_RMS_L_CSV- RMS Location CSV
Available options:
SOV, SOV_WORKING_FILE, LOSS_RUN, ACORD, PDF, UNKNOWN, SOVFIXER_OUTPUT, EML, MSG, EMAIL_HTML, EMAIL_BODY_HTML, EMAIL_BODY_TXT, OTHER, AIR_P_CSV, AIR_L_CSV, RMS_P_CSV, RMS_L_CSV, CAT_MODEL_OUTPUT, CAT_RESULT_JSON, UFS_CSV, SOVFIXER_JSON, SOVFIXER_SCRUBBER, SOVFIXER_AIR_P_CSV, SOVFIXER_AIR_L_CSV, SOVFIXER_RMS_P_CSV, SOVFIXER_RMS_L_CSV, , null Set to true to archive the document. This is a soft delete, the document is not removed from the database.
⌘I