Docrelationshiptype
Class: metadata
Document relationship types define the type on relationship between two documents.
Learn about Document Relationships in Vault Help.
| Attribute | Metadata | Description |
|---|---|---|
label | Type: String Required Max length: 40 | UI-friendly string in the Vault’s base language. |
active | Type: Boolean Required | Indicates whether the component is active. |
single_use | Type: Boolean | True when only one relationship of this type can be created for the source document. |
target_doctype | Type: String Max length: 1500 | The Doctype of the related document. |
source_version_specific | Type: Boolean | Whether the relationship is bound to the current version of the source document. |
carry_forward_source_specific | Type: Boolean | Whether the relationship will be brought forward when the source document is versioned. |
target_version_specific | Type: Boolean | Whether the relationship is bound to the current version of the target document. |
carry_forward_target_specific | Type: Boolean | Whether the relationship will be brought forward when the target document is versioned. |
relationship_filter | Type: XMLString Max length: 32000 | A criteria which restricts the documents that can be related using this type. |
Supported Operations
Section link for Supported Operations| Operation | Support |
|---|---|
| Create | |
| Recreate | |
| Alter | |
| Drop | |
| Rename | |
| Describe | |
| Generate Recreate | |
| Queryable |
Notes:
- Create, Recreate, Alter: MDL Operation is supported, but the Component Type contains field(s) that use proprietary XML. Direct modification of the XML is not supported or recommended. Instead, creating and/or updating the component is better suited through the Admin UI.