File metadata

This page covers:

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

`GET /api/FileAttributes`

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

Item	Value
Method	`GET`
Path	`/api/FileAttributes`
Auth	User bearer token
Response	Array of `FileAttribute` objects

Typical response shape

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

Example

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

`PUT /api/FileAttributes`

Add or replace attributes on a file.

Item	Value
Method	`PUT`
Path	`/api/FileAttributes`
Auth	User bearer token
Content-Type	`application/json`
Response	Boolean

Query parameters

Parameter	Required	Notes
`fileUID`	One of `fileUID` or `fileName`	File UID to update
`fileName`	One of `fileUID` or `fileName`	Full stored file path. The API resolves this to a UID first.
`deleteExisting`	No	Defaults to `true`. When `true`, this acts as a full replace.

Request body format

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

That means the wire body looks like this:

"[\"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[].

Attribute format

Single value: document_number=AX-1000
Multiple values in one field: region=North America|Europe
Unit-bearing field: weight(kg)=12.3

Python example

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())

`DELETE /api/FileAttributes`

Remove all attributes from a file.

Item	Value
Method	`DELETE`
Path	`/api/FileAttributes`
Auth	User bearer token
Response	Boolean

Example

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

`GET /api/AttributeValues`

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

Item	Value
Method	`GET`
Path	`/api/AttributeValues`
Auth	User bearer token
Response	Array of `{ "Name": string, "Count": int }`

Query parameters

Parameter	Required	Notes
`attribute`	Yes	Attribute name to aggregate

Example response

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

Example

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

`GET /api/PMIData`

Return the extracted PMI payload for a file.

Item	Value
Method	`GET`
Path	`/api/PMIData`
Auth	User bearer token
Response	`PMIData` JSON

Query parameters

Parameter	Required	Notes
`fileUID`	Yes	File UID to read PMI from

Response fields

Field	Meaning
`PMI`	JSON text string containing the PMI array
`UnstructuredText`	Extracted free text
`ExtractedAttributes`	Extracted attributes as `name=value` strings

Example response

{
  "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"
  ]
}

Example

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

`PUT /api/ExtractedAttributeFeedback`

Send feedback about attributes VizSeek extracted from a file.

Item	Value
Method	`PUT`
Path	`/api/ExtractedAttributeFeedback`
Auth	User bearer token
Content-Type	`application/json`
Response	Plain feedback ID string

Query parameters

Parameter	Required	Notes
`fileUID`	Yes	File UID the feedback applies to
`feedback`	Yes	URL-encoded explanation of what should have been extracted differently
`user`	No	URL-encoded external user identifier
`feedbackId`	No	Optional GUID you want to control

Request body format

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

"Document Type=Drawing,Region=North America"

Example

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)

`GET /api/CustomProductCategory`

Create a custom product category for the authenticated user’s company.

Item	Value
Method	`GET`
Path	`/api/CustomProductCategory`
Auth	User bearer token
Response	`ProductCategory` JSON

Query parameters

Parameter	Required	Notes
`name`	Yes	URL-encoded category name

Typical response shape

{
  "Name": "My New Category",
  "NameZH": null,
  "ID": 1234,
  "RasterSearchMethod": 0,
  "VectorSearchMethod": 0,
  "ImageAsDrawing": 0,
  "Parent": null,
  "UsageCount": 0,
  "FullName": "My New Category",
  "FullNameZH": null
}

Example

curl -G "https://your-server.example.com/api/CustomProductCategory" \
  -H "Authorization: Bearer USER_BEARER_TOKEN" \
  --data-urlencode "name=Prototype Parts"