Read or continue an expand of one asset
curl --request POST \
--url https://api.docusnap365.com/api/v1/assets/expand \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"parentId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
"expandName": "children",
"limit": 100
}
'import requests
url = "https://api.docusnap365.com/api/v1/assets/expand"
payload = {
"parentId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
"expandName": "children",
"limit": 100
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parentId: '3f2504e0-4f89-11d3-9a0c-0305e82c3301',
expandName: 'children',
limit: 100
})
};
fetch('https://api.docusnap365.com/api/v1/assets/expand', 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.docusnap365.com/api/v1/assets/expand",
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([
'parentId' => '3f2504e0-4f89-11d3-9a0c-0305e82c3301',
'expandName' => 'children',
'limit' => 100
]),
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 := "https://api.docusnap365.com/api/v1/assets/expand"
payload := strings.NewReader("{\n \"parentId\": \"3f2504e0-4f89-11d3-9a0c-0305e82c3301\",\n \"expandName\": \"children\",\n \"limit\": 100\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.docusnap365.com/api/v1/assets/expand")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"parentId\": \"3f2504e0-4f89-11d3-9a0c-0305e82c3301\",\n \"expandName\": \"children\",\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.docusnap365.com/api/v1/assets/expand")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parentId\": \"3f2504e0-4f89-11d3-9a0c-0305e82c3301\",\n \"expandName\": \"children\",\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"objectType": "<string>",
"type": "<string>",
"iconId": "<string>",
"sourceType": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"status": "<string>",
"isManually": true,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdByDisplayName": "<string>",
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"modifiedByDisplayName": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedByDisplayName": "<string>",
"expands": {}
}
],
"nextCursor": "<string>",
"hasMore": true
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errorCode": "<string>",
"traceId": "<string>",
"errors": [
{
"code": "<string>",
"path": "<string>",
"data": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errorCode": "<string>",
"traceId": "<string>",
"errors": [
{
"code": "<string>",
"path": "<string>",
"data": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errorCode": "<string>",
"traceId": "<string>",
"errors": [
{
"code": "<string>",
"path": "<string>",
"data": {}
}
]
}{
"type": "urn:ds365:error:rest-request-quota-exceeded",
"title": "Request quota exceeded",
"status": 429,
"detail": "The request quota of 10000 requests per period is exhausted until 2026-12-01T00:00:00.0000000+00:00.",
"instance": "/api/v1/assets",
"errorCode": "REST_REQUEST_QUOTA_EXCEEDED",
"traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"errors": [
{
"code": "REST_REQUEST_QUOTA_EXCEEDED",
"data": {
"requestsLimit": 10000,
"requestsUsed": 10000,
"quotaResetAt": "2026-12-01T00:00:00+00:00"
}
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errorCode": "<string>",
"traceId": "<string>",
"errors": [
{
"code": "<string>",
"path": "<string>",
"data": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errorCode": "<string>",
"traceId": "<string>",
"errors": [
{
"code": "<string>",
"path": "<string>",
"data": {}
}
]
}Query
Read or continue an expand of one asset
Reads the related data (expandName) of one asset (parentId). Without cursor the request starts the expand with the given select, filter, sort and limit. With the cursor from incompleteExpands it continues that expand; the cursor carries the original query, and select, filter, sort and limit of the body are not applied. parentId and expandName must match the cursor.
The parent asset must be visible to the user, otherwise the answer is 404.
Requires the scope api_read (Read).
POST
/
assets
/
expand
Read or continue an expand of one asset
curl --request POST \
--url https://api.docusnap365.com/api/v1/assets/expand \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"parentId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
"expandName": "children",
"limit": 100
}
'import requests
url = "https://api.docusnap365.com/api/v1/assets/expand"
payload = {
"parentId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
"expandName": "children",
"limit": 100
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parentId: '3f2504e0-4f89-11d3-9a0c-0305e82c3301',
expandName: 'children',
limit: 100
})
};
fetch('https://api.docusnap365.com/api/v1/assets/expand', 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.docusnap365.com/api/v1/assets/expand",
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([
'parentId' => '3f2504e0-4f89-11d3-9a0c-0305e82c3301',
'expandName' => 'children',
'limit' => 100
]),
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 := "https://api.docusnap365.com/api/v1/assets/expand"
payload := strings.NewReader("{\n \"parentId\": \"3f2504e0-4f89-11d3-9a0c-0305e82c3301\",\n \"expandName\": \"children\",\n \"limit\": 100\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.docusnap365.com/api/v1/assets/expand")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"parentId\": \"3f2504e0-4f89-11d3-9a0c-0305e82c3301\",\n \"expandName\": \"children\",\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.docusnap365.com/api/v1/assets/expand")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parentId\": \"3f2504e0-4f89-11d3-9a0c-0305e82c3301\",\n \"expandName\": \"children\",\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"objectType": "<string>",
"type": "<string>",
"iconId": "<string>",
"sourceType": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"status": "<string>",
"isManually": true,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdByDisplayName": "<string>",
"modifiedAt": "2023-11-07T05:31:56Z",
"modifiedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"modifiedByDisplayName": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedByDisplayName": "<string>",
"expands": {}
}
],
"nextCursor": "<string>",
"hasMore": true
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errorCode": "<string>",
"traceId": "<string>",
"errors": [
{
"code": "<string>",
"path": "<string>",
"data": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errorCode": "<string>",
"traceId": "<string>",
"errors": [
{
"code": "<string>",
"path": "<string>",
"data": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errorCode": "<string>",
"traceId": "<string>",
"errors": [
{
"code": "<string>",
"path": "<string>",
"data": {}
}
]
}{
"type": "urn:ds365:error:rest-request-quota-exceeded",
"title": "Request quota exceeded",
"status": 429,
"detail": "The request quota of 10000 requests per period is exhausted until 2026-12-01T00:00:00.0000000+00:00.",
"instance": "/api/v1/assets",
"errorCode": "REST_REQUEST_QUOTA_EXCEEDED",
"traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"errors": [
{
"code": "REST_REQUEST_QUOTA_EXCEEDED",
"data": {
"requestsLimit": 10000,
"requestsUsed": 10000,
"quotaResetAt": "2026-12-01T00:00:00+00:00"
}
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errorCode": "<string>",
"traceId": "<string>",
"errors": [
{
"code": "<string>",
"path": "<string>",
"data": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errorCode": "<string>",
"traceId": "<string>",
"errors": [
{
"code": "<string>",
"path": "<string>",
"data": {}
}
]
}Authorizations
The API key of the subscription. Each operation names the scope it needs in x-pat-scopes: api_read (in the interface Read) or api_write (Read and Write). The key is created under Administration › Integrations › API Keys.
Body
application/json
The asset whose related data is read.
The related data. The same names as in ApiExpandDefinition.
Available options:
object_data, object_essentials, object_blocks, children The cursor from incompleteExpands or nextCursor. With a cursor, select, filter, sort and limit are not applied.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
A page of expand rows.
The rows of the expand. For children these are assets.
An asset. With select on POST /assets/query an item holds only the selected properties and the lifted expands under their names (object_data as an object, the others as a list).
- Asset
- Expand row
Show child attributes
Show child attributes
Present when more rows exist.
True when more rows exist.