Aller au contenu principal

DocumentReferenceResponse

Where the document is filed (asset/documentation/folder) — present when requested via include=references or include=all

asset object
oneOf

name/type/externalIdentifier are null when the referenced asset can't be resolved; identifier is always present

identifierstringrequired
namestring | nullnullable
typestring | nullnullable
externalIdentifierstring | nullnullable

The asset's identifier in an external system (e.g. an ERP), when known

documentation object
oneOf
identifierstringrequired
names objectrequired
property name*string
folder object
oneOf
identifierstringrequired
names objectrequired
property name*string
manuallyValidatedbooleanrequired
DocumentReferenceResponse
{
"asset": {
"identifier": "string",
"name": "string",
"type": "string",
"externalIdentifier": "string"
},
"documentation": {
"identifier": "string",
"names": {}
},
"folder": {
"identifier": "string",
"names": {},
"manuallyValidated": true
}
}