Extender metadata parameters
The following metadata parameters are available for use in creating custom URLs and the metadata filters that control which objects the extender should show for:
For all of the supported extender object types, the following are common metadata parameters:
|
Metadata parameter |
Notes |
|---|---|
|
$type |
|
|
$dateCreated |
This is a date/time string in UTC format. e.g., "2017-08-09T01:05:34.527Z" |
|
$dateUpdated |
This is a date/time string in UTC format. e.g., "2017-08-09T01:05:34.527Z" |
|
$createdBy.type |
|
|
$createdBy.id |
|
|
$updateBy.type |
|
|
$updateBy.id |
|
|
$definition.type |
|
|
$definition.id |
|
|
$instance.type |
|
|
$instance.id |
|
|
$linkCount |
|
|
$owner.type |
|
|
$owner.id |
|
|
$parent.type |
|
|
$parent.id |
|
|
$id |
|
|
$ref |
A URL reference to the object. |
|
$name |
|
|
$relationships.href |
|
|
$relationships.rel |
|
|
$relationships.title |
|
|
$relationships.property |
|
|
$etag |
|
|
$lastModified |
This is a date/time string in UTC format. e.g., "2017-08-09T01:05:34.527Z" |
|
$iconRef |
The following table lists the specific metadata parameters for documents in addition to the common parameters:
|
Metadata parameter |
Notes |
|---|---|
|
$isTemplate |
==true (or false) |
|
$state |
=="DRAFT" =="EDITING_DRAFT" =="PUBLISHED" =="EDITING_PUBLISHED" =="AWAITING_APPROVAL" =="APPROVED" =="EDITING_APPROVED" =="AWAITING_PUBLICATION" =="CANCELLED_DRAFT" =="PUBLISH_PENDING" =="APPROVAL_PENDING" |
|
$fileSize |
|
|
$extension |
|
|
$currentVersionNumber |
|
|
$lastPublishedVersionNumber |
|
|
$publishedBy.type |
|
|
$publishedBy.id |
|
|
$latestOpenableVersion.type |
|
|
$latestOpenableVersion.id |
|
|
$dateFileCreated |
This is a date/time string in UTC format. e.g., "2017-08-09T01:05:34.527Z" |
The following table lists the specific metadata parameters for files in addition to the common parameters:
|
Metadata parameter |
Notes |
|---|---|
|
$currentFilePart.type |
|
|
$currentFilePart.id |
|
|
$contentFrom |
This is a date/time string in UTC format. e.g. "2017-08-09T01:05:34.527Z" |
|
$dateContentFrom |
This is a date/time string in UTC format. e.g. "2017-08-09T01:05:34.527Z" |
|
$homeRepository.type |
|
|
$homeRepository.id |
|
|
$currentRepository.type |
|
|
$currentRepository.id |
|
|
$fileNumber |
|
|
$title |
|
|
$fileState |
== "ARCHIVED" =="AWAITING_SENTENCING" =="EXPORT" =="EXPORTED_AND_DESTROYED" =="DESTROYED" =="NONE" =="RETAINED" =="RETURNED_TO_ORIGINATOR" =="REVIEW" =="SENTENCED" =="TRANSFERRED" |
|
$disposition |
e.g., "AWAITING_SENTENCING" |
|
$fileType |
e.g. "PHYSICAL" |
|
$filePartCount |