File metadata

This page covers:

• GET /api/FileAttributes
• PUT /api/FileAttributes
• DELETE /api/FileAttributes
• GET /api/AttributeValues
• GET /api/PMIData
• PUT /api/ExtractedAttributeFeedback

Return the attributes currently used by the authenticated user’s company.

[
  {
    "ID": 12,
    "Name": "document_type",
    "Unit": "",
    "Value": null,
    "IsCustom": true,
    "Timestamp": null
  },
  {
    "ID": 13,
    "Name": "material",
    "Unit": "",
    "Value": null,
    "IsCustom": true,
    "Timestamp": null
  }
]

curl "https://your-server.example.com/api/FileAttributes" \
  -H "Authorization: Bearer USER_BEARER_TOKEN"

Add or replace attributes on a file.

The body is a JSON string whose contents are a JSON array of name=value strings.

The wire body therefore has the following form:

"[\"document_type=Assembly\",\"region=North America|Europe\",\"weight(kg)=12.3\"]"

Do not send a raw JSON array. The controller receives a string first and then deserializes that string into string[].

• Single value: document_number=AX-1000
• Multi-valued attribute: region=North America|Europe — see Multi-valued attributes
• Unit-bearing field: weight(kg)=12.3

import json
import requests

server = "https://your-server.example.com"
token = "USER_BEARER_TOKEN"
file_uid = "b5d3674c-488c-41cb-a9f7-58a42cac85dd"

attrs = [
    "document_type=Assembly",
    "region=North America|Europe",
    "weight(kg)=12.3",
]

body = json.dumps(json.dumps(attrs))

resp = requests.put(
    f"{server}/api/FileAttributes?fileUID={file_uid}",
    headers={
        "Authorization": f"Bearer {token}",
        "Content-Type": "application/json",
    },
    data=body,
)
resp.raise_for_status()
print(resp.json())

An attribute can hold more than one value for the same file — for example, a CAD file linked to several PLM part records, or a part approved for multiple regions. VizSeek models this as a single attribute whose values are separated by a pipe (|):

part_id=REC-001|REC-002|REC-003

Uploading. Send the complete value list as one name=value entry, with the values pipe-separated. The pipe is the reserved value delimiter, so an individual value must not itself contain a | character.

Indexing and search. Each value is indexed individually. A metadata or exact-match search on any single value returns the file — for the example above, FT=part_id=[REC-002] is a match. See Attribute-match conventions.

Response format. Every API surface returns a multi-valued attribute in the same pipe-separated form it was uploaded in:

To consume the values, split the string on |. A value that contains no pipe is a single-valued attribute, so the same parsing rule covers both cases.

Updating the value set. PUT /api/FileAttributes is a full replace by default (deleteExisting=true). To add or remove a single value, re-send the attribute with the complete, updated pipe-separated list. In PLM and ERP integrations, treat the source system as the system of record: whenever its records change, push the full merged attribute set for the file rather than attempting incremental edits.

Remove all attributes from a file.

curl -X DELETE "https://your-server.example.com/api/FileAttributes?fileUID=b5d3674c-488c-41cb-a9f7-58a42cac85dd" \
  -H "Authorization: Bearer USER_BEARER_TOKEN"

Return the unique values and counts for one attribute in the current company.

[
  {
    "Name": "North America",
    "Count": 1842
  },
  {
    "Name": "Europe",
    "Count": 731
  }
]

curl -G "https://your-server.example.com/api/AttributeValues" \
  -H "Authorization: Bearer USER_BEARER_TOKEN" \
  --data-urlencode "attribute=region"

Return the extracted PMI payload for a file.

{
  "PMI": "[{\"page\":0,\"ImageSize\":[2550,3300],\"PMI\":[{\"box\":[1274,356,29,125],\"type_id\":0,\"text\":\"11\"}]}]",
  "UnstructuredText": "Example drawing title",
  "ExtractedAttributes": [
    "document_number=AX-1000",
    "document_type=Drawing"
  ]
}

curl -G "https://your-server.example.com/api/PMIData" \
  -H "Authorization: Bearer USER_BEARER_TOKEN" \
  --data-urlencode "fileUID=b5d3674c-488c-41cb-a9f7-58a42cac85dd"

Send feedback about attributes VizSeek extracted from a file.

The body is a JSON string containing a comma-separated list of extracted attributes, for example:

"Document Type=Drawing,Region=North America"

import json
import requests
import urllib.parse

server = "https://your-server.example.com"
token = "USER_BEARER_TOKEN"
file_uid = "b5d3674c-488c-41cb-a9f7-58a42cac85dd"

body = json.dumps("Document Type=Drawing,Region=North America")
feedback = urllib.parse.quote("Region should have been Europe", safe="")

resp = requests.put(
    f"{server}/api/ExtractedAttributeFeedback?fileUID={file_uid}&feedback={feedback}",
    headers={
        "Authorization": f"Bearer {token}",
        "Content-Type": "application/json",
    },
    data=body,
)
resp.raise_for_status()
print(resp.text)