v1

latestOpenAPI 3.0.02026-07-1717466209.0 KB

Projects

Get project JSON field by JSON Pointer

Returns a single value from the same project JSON document produced by Get project JSON (/editor/json/{id}), addressed by a JSON Pointer (RFC 6901). Examples: /idno, /type, /identification/title, /variables/0/name (when variables are included in the export).

get/editor/json-field/{id}

Path parameters

idstring required

Project ID or IDNO

Query parameters

pathstring required

JSON Pointer (RFC 6901) to the value, starting with /. Must be URL-encoded if it contains reserved characters (e.g. ~0, ~1 for ~ and / in keys).

versionstring

Use metadata for a specific version number (e.g. 1.0.0)

exclude_variables0 | 1

Same as Get project JSON; when 1, /variables/... is not available.

exclude_private_fields0 | 1

external_resources0 | 1

admin_metadata0 | 1

Response

Value resolved or path missing in document

status'success'

pathstring

foundboolean

{"stackTrail":"paths:/editor/json-field/{id}:get:responses:200:content:application/json:schema:properties:value","oasType":"schema","type":"unknown","description":"Present when found is true; null when found is false"}