Update document
curl --request PATCH \
--url http://localhost:3000/v2/documents/{id} \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"fileName": "<string>",
"accessGroup": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"url": "<string>",
"name": "<string>",
"objectId": "<string>",
"userId": "<string>",
"jobId": "<string>",
"customerId": "<string>",
"absenceId": "<string>",
"complaintId": "<string>",
"uploadId": "<string>"
}
'import requests
url = "http://localhost:3000/v2/documents/{id}"
payload = {
"fileName": "<string>",
"accessGroup": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"url": "<string>",
"name": "<string>",
"objectId": "<string>",
"userId": "<string>",
"jobId": "<string>",
"customerId": "<string>",
"absenceId": "<string>",
"complaintId": "<string>",
"uploadId": "<string>"
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fileName: '<string>',
accessGroup: '<string>',
_id: '<string>',
number: 123,
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>'
},
url: '<string>',
name: '<string>',
objectId: '<string>',
userId: '<string>',
jobId: '<string>',
customerId: '<string>',
absenceId: '<string>',
complaintId: '<string>',
uploadId: '<string>'
})
};
fetch('http://localhost:3000/v2/documents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/documents/{id}",
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>',
'accessGroup' => '<string>',
'_id' => '<string>',
'number' => 123,
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>'
],
'url' => '<string>',
'name' => '<string>',
'objectId' => '<string>',
'userId' => '<string>',
'jobId' => '<string>',
'customerId' => '<string>',
'absenceId' => '<string>',
'complaintId' => '<string>',
'uploadId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-API-Key: <api-key>"
],
]);
$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 := "http://localhost:3000/v2/documents/{id}"
payload := strings.NewReader("{\n \"fileName\": \"<string>\",\n \"accessGroup\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"objectId\": \"<string>\",\n \"userId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"absenceId\": \"<string>\",\n \"complaintId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-API-Key", "<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("http://localhost:3000/v2/documents/{id}")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fileName\": \"<string>\",\n \"accessGroup\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"objectId\": \"<string>\",\n \"userId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"absenceId\": \"<string>\",\n \"complaintId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/documents/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fileName\": \"<string>\",\n \"accessGroup\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"objectId\": \"<string>\",\n \"userId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"absenceId\": \"<string>\",\n \"complaintId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyDocuments
Update Document
Update a document’s metadata or properties.
PATCH
/
documents
/
{id}
Update document
curl --request PATCH \
--url http://localhost:3000/v2/documents/{id} \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"fileName": "<string>",
"accessGroup": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"url": "<string>",
"name": "<string>",
"objectId": "<string>",
"userId": "<string>",
"jobId": "<string>",
"customerId": "<string>",
"absenceId": "<string>",
"complaintId": "<string>",
"uploadId": "<string>"
}
'import requests
url = "http://localhost:3000/v2/documents/{id}"
payload = {
"fileName": "<string>",
"accessGroup": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"url": "<string>",
"name": "<string>",
"objectId": "<string>",
"userId": "<string>",
"jobId": "<string>",
"customerId": "<string>",
"absenceId": "<string>",
"complaintId": "<string>",
"uploadId": "<string>"
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fileName: '<string>',
accessGroup: '<string>',
_id: '<string>',
number: 123,
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>'
},
url: '<string>',
name: '<string>',
objectId: '<string>',
userId: '<string>',
jobId: '<string>',
customerId: '<string>',
absenceId: '<string>',
complaintId: '<string>',
uploadId: '<string>'
})
};
fetch('http://localhost:3000/v2/documents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/documents/{id}",
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>',
'accessGroup' => '<string>',
'_id' => '<string>',
'number' => 123,
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>'
],
'url' => '<string>',
'name' => '<string>',
'objectId' => '<string>',
'userId' => '<string>',
'jobId' => '<string>',
'customerId' => '<string>',
'absenceId' => '<string>',
'complaintId' => '<string>',
'uploadId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-API-Key: <api-key>"
],
]);
$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 := "http://localhost:3000/v2/documents/{id}"
payload := strings.NewReader("{\n \"fileName\": \"<string>\",\n \"accessGroup\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"objectId\": \"<string>\",\n \"userId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"absenceId\": \"<string>\",\n \"complaintId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-API-Key", "<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("http://localhost:3000/v2/documents/{id}")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fileName\": \"<string>\",\n \"accessGroup\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"objectId\": \"<string>\",\n \"userId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"absenceId\": \"<string>\",\n \"complaintId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/documents/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fileName\": \"<string>\",\n \"accessGroup\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"objectId\": \"<string>\",\n \"userId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"absenceId\": \"<string>\",\n \"complaintId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API-KeyBearer-Auth
Path Parameters
Document ID
Body
application/json
Document data to update
A document represents a file or attachment stored in the system, with metadata and references to related entities.
Original file name
Access group for the document (e.g. service, objectmanager)
Unique identifier of the entity
Unique number of the entity, used for identification
The ID of the company this entity belongs to
Entity Status information
Show child attributes
Show child attributes
URL to access the document file
Display name of the document
Related object ID
Related user ID
Related job ID
Related customer ID
Related absence ID
Related complaint ID
Upload process ID
Response
Document updated successfully
Was this page helpful?
⌘I