Run parsing with tag detection for files
Required capabilities:
diagramParsingAcl:WRITEdataModelInstancesAcl:WRITE
A parsing job will be started on the files to detect their entities and connections and map assets.
POST
/
api
/
v1
/
projects
/
{project}
/
diagram-parsing
/
parsing
/
full
Run parsing with tag detection for files
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
}
],
"filters": {
"Asset": {},
"File": {}
},
"libraryId": {
"externalId": "my.known.id"
},
"nonce": "<string>",
"minTokens": 123,
"partialMatch": true,
"searchField": "<string>"
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full"
payload = {
"documents": [
{
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
}
],
"filters": {
"Asset": {},
"File": {}
},
"libraryId": { "externalId": "my.known.id" },
"nonce": "<string>",
"minTokens": 123,
"partialMatch": True,
"searchField": "<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({
documents: [{fileId: {space: '<string>', externalId: 'my.known.id'}, pageNumber: 123}],
filters: {Asset: {}, File: {}},
libraryId: {externalId: 'my.known.id'},
nonce: '<string>',
minTokens: 123,
partialMatch: true,
searchField: '<string>'
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full', 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://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full",
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([
'documents' => [
[
'fileId' => [
'space' => '<string>',
'externalId' => 'my.known.id'
],
'pageNumber' => 123
]
],
'filters' => [
'Asset' => [
],
'File' => [
]
],
'libraryId' => [
'externalId' => 'my.known.id'
],
'nonce' => '<string>',
'minTokens' => 123,
'partialMatch' => true,
'searchField' => '<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://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full"
payload := strings.NewReader("{\n \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"filters\": {\n \"Asset\": {},\n \"File\": {}\n },\n \"libraryId\": {\n \"externalId\": \"my.known.id\"\n },\n \"nonce\": \"<string>\",\n \"minTokens\": 123,\n \"partialMatch\": true,\n \"searchField\": \"<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://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"filters\": {\n \"Asset\": {},\n \"File\": {}\n },\n \"libraryId\": {\n \"externalId\": \"my.known.id\"\n },\n \"nonce\": \"<string>\",\n \"minTokens\": 123,\n \"partialMatch\": true,\n \"searchField\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full")
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 \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"filters\": {\n \"Asset\": {},\n \"File\": {}\n },\n \"libraryId\": {\n \"externalId\": \"my.known.id\"\n },\n \"nonce\": \"<string>\",\n \"minTokens\": 123,\n \"partialMatch\": true,\n \"searchField\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
"my.known.id"
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Scopes
Path Parameters
Body
application/json
Defines parsing options needed for symbol and tag detection jobs.
⌘I
Run parsing with tag detection for files
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
}
],
"filters": {
"Asset": {},
"File": {}
},
"libraryId": {
"externalId": "my.known.id"
},
"nonce": "<string>",
"minTokens": 123,
"partialMatch": true,
"searchField": "<string>"
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full"
payload = {
"documents": [
{
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
}
],
"filters": {
"Asset": {},
"File": {}
},
"libraryId": { "externalId": "my.known.id" },
"nonce": "<string>",
"minTokens": 123,
"partialMatch": True,
"searchField": "<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({
documents: [{fileId: {space: '<string>', externalId: 'my.known.id'}, pageNumber: 123}],
filters: {Asset: {}, File: {}},
libraryId: {externalId: 'my.known.id'},
nonce: '<string>',
minTokens: 123,
partialMatch: true,
searchField: '<string>'
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full', 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://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full",
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([
'documents' => [
[
'fileId' => [
'space' => '<string>',
'externalId' => 'my.known.id'
],
'pageNumber' => 123
]
],
'filters' => [
'Asset' => [
],
'File' => [
]
],
'libraryId' => [
'externalId' => 'my.known.id'
],
'nonce' => '<string>',
'minTokens' => 123,
'partialMatch' => true,
'searchField' => '<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://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full"
payload := strings.NewReader("{\n \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"filters\": {\n \"Asset\": {},\n \"File\": {}\n },\n \"libraryId\": {\n \"externalId\": \"my.known.id\"\n },\n \"nonce\": \"<string>\",\n \"minTokens\": 123,\n \"partialMatch\": true,\n \"searchField\": \"<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://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"filters\": {\n \"Asset\": {},\n \"File\": {}\n },\n \"libraryId\": {\n \"externalId\": \"my.known.id\"\n },\n \"nonce\": \"<string>\",\n \"minTokens\": 123,\n \"partialMatch\": true,\n \"searchField\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full")
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 \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"filters\": {\n \"Asset\": {},\n \"File\": {}\n },\n \"libraryId\": {\n \"externalId\": \"my.known.id\"\n },\n \"nonce\": \"<string>\",\n \"minTokens\": 123,\n \"partialMatch\": true,\n \"searchField\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
"my.known.id"
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}