Vault
Crear intención de carga
cURL
curl --request POST \
--url https://app.edtools.co/api/client/v1/vault/documents/upload-intents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"originalFileName": "<string>",
"mimeType": "<string>",
"sizeBytes": 26214400,
"title": "<string>",
"documentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiresAt": "2023-11-07T05:31:56Z",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityExternalId": "<string>"
}
'import requests
url = "https://app.edtools.co/api/client/v1/vault/documents/upload-intents"
payload = {
"originalFileName": "<string>",
"mimeType": "<string>",
"sizeBytes": 26214400,
"title": "<string>",
"documentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiresAt": "2023-11-07T05:31:56Z",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityExternalId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
originalFileName: '<string>',
mimeType: '<string>',
sizeBytes: 26214400,
title: '<string>',
documentTypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
expiresAt: '2023-11-07T05:31:56Z',
entityId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
entityExternalId: '<string>'
})
};
fetch('https://app.edtools.co/api/client/v1/vault/documents/upload-intents', 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.edtools.co/api/client/v1/vault/documents/upload-intents",
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([
'originalFileName' => '<string>',
'mimeType' => '<string>',
'sizeBytes' => 26214400,
'title' => '<string>',
'documentTypeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'expiresAt' => '2023-11-07T05:31:56Z',
'entityId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'entityExternalId' => '<string>'
]),
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.edtools.co/api/client/v1/vault/documents/upload-intents"
payload := strings.NewReader("{\n \"originalFileName\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 26214400,\n \"title\": \"<string>\",\n \"documentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.edtools.co/api/client/v1/vault/documents/upload-intents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"originalFileName\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 26214400,\n \"title\": \"<string>\",\n \"documentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.edtools.co/api/client/v1/vault/documents/upload-intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"originalFileName\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 26214400,\n \"title\": \"<string>\",\n \"documentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"document": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "<string>",
"source": "<string>",
"documentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentTypeName": "<string>",
"expiresAt": "<string>",
"rejectionReason": "<string>",
"deletedAt": "<string>",
"deletedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedByUserName": "<string>",
"deletedReason": "<string>",
"currentVersion": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"originalFileName": "<string>",
"mimeType": "<string>",
"sizeBytes": 123,
"uploadStatus": "<string>",
"textExtractionStatus": "<string>",
"searchIndexStatus": "<string>",
"createdAt": "<string>"
},
"links": [
{
"id": "<string>",
"entityKind": "<string>",
"entityId": "<string>",
"label": "<string>",
"path": "<string>",
"createdAt": "<string>"
}
],
"primaryLink": {
"id": "<string>",
"entityKind": "<string>",
"entityId": "<string>",
"label": "<string>",
"path": "<string>",
"createdAt": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
},
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"storageProvider": "<string>",
"upload": {
"url": "<string>",
"method": "PUT",
"headers": {},
"expiresAt": "<string>"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Required string length:
1 - 255Required string length:
1 - 127Required range:
0 < x <= 52428800Maximum string length:
255Available options:
student, admission_application Required string length:
1 - 160Response
201 - application/json
Created Vault upload intent
Show child attributes
Show child attributes
Was this page helpful?
cURL
curl --request POST \
--url https://app.edtools.co/api/client/v1/vault/documents/upload-intents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"originalFileName": "<string>",
"mimeType": "<string>",
"sizeBytes": 26214400,
"title": "<string>",
"documentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiresAt": "2023-11-07T05:31:56Z",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityExternalId": "<string>"
}
'import requests
url = "https://app.edtools.co/api/client/v1/vault/documents/upload-intents"
payload = {
"originalFileName": "<string>",
"mimeType": "<string>",
"sizeBytes": 26214400,
"title": "<string>",
"documentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiresAt": "2023-11-07T05:31:56Z",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityExternalId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
originalFileName: '<string>',
mimeType: '<string>',
sizeBytes: 26214400,
title: '<string>',
documentTypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
expiresAt: '2023-11-07T05:31:56Z',
entityId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
entityExternalId: '<string>'
})
};
fetch('https://app.edtools.co/api/client/v1/vault/documents/upload-intents', 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.edtools.co/api/client/v1/vault/documents/upload-intents",
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([
'originalFileName' => '<string>',
'mimeType' => '<string>',
'sizeBytes' => 26214400,
'title' => '<string>',
'documentTypeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'expiresAt' => '2023-11-07T05:31:56Z',
'entityId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'entityExternalId' => '<string>'
]),
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.edtools.co/api/client/v1/vault/documents/upload-intents"
payload := strings.NewReader("{\n \"originalFileName\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 26214400,\n \"title\": \"<string>\",\n \"documentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.edtools.co/api/client/v1/vault/documents/upload-intents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"originalFileName\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 26214400,\n \"title\": \"<string>\",\n \"documentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.edtools.co/api/client/v1/vault/documents/upload-intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"originalFileName\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 26214400,\n \"title\": \"<string>\",\n \"documentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"document": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "<string>",
"source": "<string>",
"documentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentTypeName": "<string>",
"expiresAt": "<string>",
"rejectionReason": "<string>",
"deletedAt": "<string>",
"deletedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedByUserName": "<string>",
"deletedReason": "<string>",
"currentVersion": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"originalFileName": "<string>",
"mimeType": "<string>",
"sizeBytes": 123,
"uploadStatus": "<string>",
"textExtractionStatus": "<string>",
"searchIndexStatus": "<string>",
"createdAt": "<string>"
},
"links": [
{
"id": "<string>",
"entityKind": "<string>",
"entityId": "<string>",
"label": "<string>",
"path": "<string>",
"createdAt": "<string>"
}
],
"primaryLink": {
"id": "<string>",
"entityKind": "<string>",
"entityId": "<string>",
"label": "<string>",
"path": "<string>",
"createdAt": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
},
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"storageProvider": "<string>",
"upload": {
"url": "<string>",
"method": "PUT",
"headers": {},
"expiresAt": "<string>"
}
}
}