Attribute Summary for Item Type - ALL |
CAN_ACQUIRE_MANUAL_LOCK |
Whether a MANUAL lock may be acquired, based on capabilities and object state.
Available on: ALL
Name: CAN_ACQUIRE_MANUAL_LOCK
Data Type: Boolean
|
CAN_RELEASE_DAV_LOCK |
Whether a DAV lock may be released, based on capabilities and object state.
Available on: ALL
Name: CAN_RELEASE_DAV_LOCK
Data Type: Boolean
|
CAN_RELEASE_MANUAL_LOCK |
Whether a MANUAL lock may be released, based on capabilities and object state.
Available on: ALL
Name: CAN_RELEASE_MANUAL_LOCK
Data Type: Boolean
|
CAPABILITIES |
The capabilities bitmap for the current user on an Item.
Takes into account access control, lock restrictions, and restrictions based on object type or configuration.
Value is a long bitmap (64 bits), each of which may represent a single capability. Capability constants are defined in FdkConstants. To check if a capability is enabled, perform a bitwise AND operation with one of the capability constants. Example:
boolean canDelete = (capabilities & FdkConstants.CAPABILITY_DELETE) == FdkConstants.CAPABILITY_DELETE;
- Available on: ALL
- Name: CAPABILITIES
- Data Type: Long
|
CREATE_DATE |
The creation date.
Available on: ALL
Name: CREATE_DATE
Data Type: Date
|
CREATED_BY |
The user that created the object.
Available on: ALL
Name: CREATED_BY
Data Type: Item (USER)
|
DESCRIPTION |
The description of an object.
Available on: ALL
Name: DESCRIPTION
Data Type: String
|
ID |
The unique ID of the object. This attribute is included by default in all Items. It is useful only when chaining attributes, for example when asking for the ID of the owner without getting back the owner as an Item, one can use OWNER + SEPARATOR + ID
- Available on: ALL
- Name: ID
- Data Type: Long
|
IS_IN_ARCHIVE |
Whether the item is in the Archive.
Available on: ALL
Name: IS_IN_ARCHIVE
Data Type: Boolean
|
IS_IN_TRASH |
Whether the item is in the trash.
Available on: ALL
Name: IS_IN_TRASH
Data Type: Boolean
|
LAST_MODIFIED_BY |
The last user that modified the item.
Available on: ALL
Name: LAST_MODIFIED_BY
Data Type: Item (USER)
|
LAST_MODIFIED_DATE |
The last modification date.
Available on: ALL
Name: LAST_MODIFIED_DATE
Data Type: Date
|
LOCKS |
The set of locks on an item. May return null.
Available on: ALL
Name: LOCKS
Data Type: Item[]
|
NAME |
The name of the object. This attribute is included by default in all Items. It is useful only when chaining attributes, for example when asking for the name of the owner without getting back the owner as an Item, one can use OWNER + SEPARATOR + NAME
- Available on: ALL
- Name: NAME
- Data Type: String
|
REQUEST_TYPES |
The list of Request types.
Available on: ALL
Name: REQUEST_TYPES
Data Type: String[]
|
TYPE |
The type of the object. This attribute is included by default in all Items. It is useful only when chaining attributes, for example when asking for the type of the owner without getting back the owner as an Item, one can use OWNER + SEPARATOR + TYPE
- Available on: ALL
- Name: TYPE
- Data Type: String
|
WORKFLOW_OPERATIONS |
The names of operations that can be workflow-enabled (and configured) for an Item.
Available on: ALL
Name: WORKFLOW_OPERATIONS
Data Type: String[]
|
Attribute Summary for Item Type - ATTRIBUTE_OVERRIDE |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
ATTRIBUTE_OVERRIDE_ATTRIBUTE |
Specifies the attribute to be overriden
Available on: ATTRIBUTE_OVERRIDE
Name: ATTRIBUTE_OVERRIDE_ATTRIBUTE
Data Type: String
|
ATTRIBUTE_OVERRIDE_CATEGORY_CLASS |
Specifies the category class of the attribute to be overriden. The Attribute will only be overriden on the specific class on which it is specified, and not on any subclasses.
If not specified, defaults to the class on which the attribute specified in ATTRIBUTE_OVERRIDE_ATTRIBUTE is defined.
Available on: ATTRIBUTE_OVERRIDE
Name: ATTRIBUTE_OVERRIDE_CATEGORY_CLASS
Data Type: Item
|
ATTRIBUTE_OVERRIDE_DEFAULT |
Default for this attribute override.
Available on: ATTRIBUTE_OVERRIDE
Name: ATTRIBUTE_OVERRIDE_DEFAULT
Data Type: (determined by ATTRIBUTE_TYPE of the attribute)
|
ATTRIBUTE_OVERRIDE_PROMPT |
Should this value be prompted for?
Available on: ATTRIBUTE_OVERRIDE
Name: ATTRIBUTE_OVERRIDE_PROMPT
Data Type: Boolean
|
ATTRIBUTE_OVERRIDE_REQUIRED |
Is this value required?
Available on: ATTRIBUTE_OVERRIDE
Name: ATTRIBUTE_OVERRIDE_REQUIRED
Data Type: Boolean
|
ATTRIBUTE_OVERRIDE_SETTABLE |
Is this value settable/updateable?
Available on: ATTRIBUTE_OVERRIDE
Name: ATTRIBUTE_OVERRIDE_SETTABLE
Data Type: Boolean
|
Attribute Summary for Item Type - CATEGORY_CLASS |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
ATTRIBUTE_DETAIL |
An array with the details of a metadata attribute (name, type, etc). Used for creating metadata attributes.
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: ATTRIBUTE_DETAIL
Data Type: NamedValue[]
|
ATTRIBUTE_DETAILS |
An array of ATTRIBUTE_DETAIL with the details of a metadata attribute (name, type, etc).
Available on: RECORD_CATEGORY , CATEGORY_CLASS
Name: ATTRIBUTE_DETAILS
Data Type: NamedValue[]
|
CLASS_ABSTRACT |
Is this Class abstract.
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: CLASS_ABSTRACT
Data Type: Boolean
|
CLASS_COPIED |
Are instances of this class copied when associated object is copied or versioned?
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: CLASS_COPIED
Data Type: Boolean
|
CLASS_FINAL |
Is this Class final (can it be extended.
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: CLASS_FINAL
Data Type: Boolean
|
CLASS_HAS_SUBCLASSES |
Does this class have subclasses?
Available on: CATEGORY_CLASS
Name: CLASS_HAS_SUBCLASSES
Data Type: Boolean
|
CLASS_HIDDEN |
Is this Class hidden from the UI. Must be enforced by the client.
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: CLASS_HIDDEN
Data Type: Boolean
|
CLASS_NAME |
Class Name. This name gets mangled when the class is created. See DISPLAY_NAME.
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: CLASS_NAME
Data Type: String
|
SUPERCLASS |
Id of class from which this class inherits (or null if not extending a class).
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: SUPERCLASS
Data Type: String
|
Attribute Summary for Item Type - CATEGORY_CLASS_OBJECT |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
DIRECT_CATEGORY_SUBCLASSES |
All category class objects that are a subclass of this class.
Available on: CATEGORY_CLASS_OBJECT
Name: DIRECT_CATEGORY_SUBCLASSES
Data Type: Item[]
|
DISPLAY_NAME |
The display name of a user or MetaData object.
Available on: USER , CATEGORY_CLASS_OBJECT , RECORD , METADATA_ATTRIBUTE
Name: DISPLAY_NAME
Data Type: String
|
METADATA_ATTRIBUTES |
MetaData Attributes. The Attributes of this Category Class or Record Category
Available on: CATEGORY_CLASS_OBJECT , RECORD_CATEGORY
Name: METADATA_ATTRIBUTES
Data Type: Item[]
|
METADATA_DIRECT_ATTRIBUTES |
MetaData Direct Attributes. The Attributes of this Category Class or Record Category that are not inherited.
Available on: CATEGORY_CLASS_OBJECT , RECORD_CATEGORY
Name: METADATA_DIRECT_ATTRIBUTES
Data Type: Item[]
|
Attribute Summary for Item Type - CATEGORY_CONFIGURATION |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
ALLOW_ALL_CATEGORIES |
Allow all categories on the objects that reside under the folder which has this category configuration.
Available on: CATEGORY_CONFIGURATION
Name: ALLOW_ALL_CATEGORIES
Data Type: Boolean
|
ALLOWED_CATEGORIES |
Allowed categories on the objects that reside under the folder which has this category configuration.
Available on: CATEGORY_CONFIGURATION
Name: ALLOWED_CATEGORIES
Data Type: Item []
|
ATTRIBUTE_OVERRIDE |
Specifies an Attribute Override on a CategoryConfiguration or RecordConfiguration
Available on: RECORD_CONFIGURATION , CATEGORY_CONFIGURATION
Name: ATTRIBUTE_OVERRIDE
Data Type: Item
|
ATTRIBUTE_OVERRIDES |
The Attribute Overrides on a CategoryConfiguration or RecordConfiguration
Available on: RECORD_CONFIGURATION , CATEGORY_CONFIGURATION
Name: ATTRIBUTE_OVERRIDES
Data Type: Item []
|
CONFIGURATION_ENABLED |
Whether the Configuration is enabled.
Available on: CATEGORY_CONFIGURATION
Name: CONFIGURATION_ENABLED
Data Type: Boolean
|
CONFIGURATION_FINAL |
Whether the Configuration is final (cannot be overridden).
Available on: CATEGORY_CONFIGURATION
Name: CONFIGURATION_FINAL
Data Type: Boolean
|
REQUIRED_CATEGORIES |
Required categories on the objects that reside under the folder which has this category configuration.
Available on: CATEGORY_CONFIGURATION
Name: REQUIRED_CATEGORIES
Data Type: Item []
|
Attribute Summary for Item Type - DISPOSITION_PHASE |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
ACTION |
The action for a disposition phase. Used while creating the disposition instructions for a record category or record folder
Available on: DISPOSITION_PHASE
Name: ACTION
Data Type: String
|
DESTINATION_FOLDER |
The destination folder attribute for a disposition phase of MOVE or TRANSFER
Available on: DISPOSITION_PHASE
Name: DESTINATION_FOLDER
Data Type: Item
|
DESTINATION_STRING |
The destination string attribute for a disposition phase of MOVE or TRANSFER
Available on: DISPOSITION_PHASE
Name: DESTINATION_STRING
Data Type: String
|
DISPOSITION_ACTION_ACCESSION |
String value for the disposition action for ACCESSION This is not an attribute but one of the possible enumerated values for the ACTION attribute. This is used when the action attribute of a record category is retrieved
(Unpublished)
- Available on: DISPOSITION_PHASE
- Name: DISPOSITION_ACTION_ACCESSION
- Data Type: String
|
DISPOSITION_ACTION_DELETE |
String value for the disposition action for DELETE This is not an attribute but one of the possible enumerated values for the ACTION attribute. This is used when the action attribute of a record category is retrieved
Available on: DISPOSITION_PHASE
Name: DISPOSITION_ACTION_DELETE
Data Type: String
|
DISPOSITION_ACTION_MOVE |
String value for the disposition action for MOVE This is not an attribute but one of the possible enumerated values for the ACTION attribute. This is used when the action attribute of a record category is retrieved
Available on: DISPOSITION_PHASE
Name: DISPOSITION_ACTION_MOVE
Data Type: String
|
DISPOSITION_ACTION_RETAIN |
String value for the disposition action for RETAIN This is not an attribute but one of the possible enumerated values for the ACTION attribute. This is used when the action attribute of a record category is retrieved
Available on: DISPOSITION_PHASE
Name: DISPOSITION_ACTION_RETAIN
Data Type: String
|
DISPOSITION_ACTION_TRANSFER |
String value for the disposition action for TRANSFER This is not an attribute but one of the possible enumerated values for the ACTION attribute. This is used when the action attribute of a record category is retrieved
(Unpublished)
- Available on: DISPOSITION_PHASE
- Name: DISPOSITION_ACTION_TRANSFER
- Data Type: String
|
DISPOSITION_EVENT |
The event that ends or triggers the disposition phase
Available on: DISPOSITION_PHASE
Name: DISPOSITION_EVENT
Data Type: Item
|
RETENTION |
The retention period for a disposition phase of RETAIN
Available on: DISPOSITION_PHASE
Name: RETENTION
Data Type: Long
|
STORAGE_DEVICE |
The storage device to be used for a disposition phase of RETAIN.
Available on: DISPOSITION_PHASE
Name: STORAGE_DEVICE
Data Type: String
|
STORAGE_DEVICE_BFILE |
String value for using Bfiles as a storage device for a phase of RETENTION. This is not an attribute but one of the possible enumerated values for the STORAGE_DEVICE attribute.
Available on: DISPOSITION_PHASE
Name: STORAGE_DEVICE_BFILE
Data Type: String
|
STORAGE_DEVICE_DATABASE |
String value for using Database as a storage device for a phase of RETENTION. This is the default for a retention phase. This is not an attribute but one of the possible enumerated values for the STORAGE_DEVICE attribute.
Available on: DISPOSITION_PHASE
Name: STORAGE_DEVICE_DATABASE
Data Type: String
|
STORAGE_DEVICE_HSM |
String value for using a HSM device as a storage device for a phase of RETENTION. The system must be HSM enabled. This is not an attribute but one of the possible enumerated values for the STORAGE_DEVICE attribute.
Available on: DISPOSITION_PHASE
Name: STORAGE_DEVICE_HSM
Data Type: String
|
Attribute Summary for Item Type - DOCUMENT |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
CAN_CHECKIN |
Whether a DOCUMENT Item can be checked in.
Available on: DOCUMENT
Name: CAN_CHECKIN
Data Type: Boolean
|
CAN_CHECKOUT |
Whether a DOCUMENT Item can be checked out.
Available on: DOCUMENT
Name: CAN_CHECKOUT
Data Type: Boolean
|
CAN_RECORDIZE |
Indicates whether a document can be recordized
Available on: DOCUMENT
Name: CAN_RECORDIZE
Data Type: Boolean
|
CAN_UNCOMPRESS |
Whether a Document can be uncompressed.
Available on: DOCUMENT
Name: CAN_UNCOMPRESS
Data Type: Boolean
|
CAN_UPDATE_CONTENT |
Whether a Document can have its content updated.
Available on: DOCUMENT
Name: CAN_UPDATE_CONTENT
Data Type: Boolean
|
CATEGORIES |
The Categories associated with this Document, if any
Available on: DOCUMENT
Name: CATEGORIES
Data Type: Item[]
|
CATEGORY_CONFIGURATION |
The category configuration of an item.
Available on: FOLDER , DOCUMENT
Name: CATEGORY_CONFIGURATION
Data Type: Item
|
CHARACTER_SET_RELEVANT |
Indication as to whether the character set is relevant for a document.
Available on: DOCUMENT
Name: CHARACTER_SET_RELEVANT
Data Type: Boolean
|
CHECKED_OUT_BY |
The user who has the document checked-out, or null if the document is not checked-out. The document must be version-controlled.
Available on: DOCUMENT
Name: CHECKED_OUT_BY
Data Type: Item
|
|
The reservation comment for a checked-out document. The document must be version-controlled and checked-out.
Available on: DOCUMENT
Name: CHECKOUT_COMMENT
Data Type: String
|
CHECKOUT_DATE |
The reservation date for a checked-out document. The document must be version-controlled and checked-out.
Available on: DOCUMENT
Name: CHECKOUT_DATE
Data Type: String
|
DOCUMENT_CHARACTER_SET |
The character set of a document.
Available on: DOCUMENT
Name: DOCUMENT_CHARACTER_SET
Data Type: String
|
DOCUMENT_LANGUAGE |
The language of a document.
Available on: DOCUMENT
Name: DOCUMENT_LANGUAGE
Data Type: String
|
EFFECTIVE_ROLES |
The roles the current user has on the target object, either via a direct grant, a propagating grant, or a grant to a group that the user is a member of.
Available on: FOLDER , DOCUMENT
Name: EFFECTIVE_ROLES
Data Type: Item[]
|
ETAG |
The ETAG (unique identifier) for a Document.
Available on: DOCUMENT
Name: ETAG
Data Type: Long
|
FAMILY |
The Family of a version-controlled DOCUMENT Item or of a VERSION Item.
Available on: DOCUMENT , VERSION
Name: FAMILY
Data Type: Item (type FAMILY)
|
HAS_RECORD_BEHAVIOR |
Indicates whether a document has record behavior
Available on: DOCUMENT
Name: HAS_RECORD_BEHAVIOR
Data Type: Boolean
|
ICON_URL |
The URL to the icon for an item.
Available on: DOCUMENT , LINK , FOLDER
Name: ICON_URL
Data Type: String
|
ID_URL |
The ID-based (static, not path-based) URL to an item.
Available on: DOCUMENT_DEFINITION , DOCUMENT , FOLDER , LINK
Name: ID_URL
Data Type: String
|
IS_QUARANTINED |
Whether the Item has been quarantined by the anti-virus system
Available on: DOCUMENT
Name: IS_QUARANTINED
Data Type: Boolean
|
IS_RECOGNIZED_MIME_TYPE |
Whether the document's MIME_TYPE is recognized; false if it is unknown.
Available on: DOCUMENT
Name: IS_RECOGNIZED_MIME_TYPE
Data Type: Boolean
|
IS_RECORD |
Indicator of whether this publicobject is a record
Available on: DOCUMENT
Name: IS_RECORD
Data Type: Boolean
|
IS_VERSION_CONTROLLED |
Whether a DOCUMENT Item is under version control
Available on: DOCUMENT
Name: IS_VERSION_CONTROLLED
Data Type: Boolean
|
LAST_SCANNED_DEFINITION_DATE |
Returns the date of the last virus definition update that content was verified against.
Available on: DOCUMENT
Name: LAST_SCANNED_DEFINITION_DATE
Data Type: Date
|
LAST_VERSION |
Latest VERSION of a version-controlled DOCUMENT Item (or of a FAMILY Item); null if the Item is not under version control.
Available on: DOCUMENT , FAMILY
Name: LAST_VERSION
Data Type: Item (type VERSION)
|
MIME_TYPE |
The MIME type of the contents of a document.
Available on: DOCUMENT , LINK
Name: MIME_TYPE
Data Type: String
|
PARENT_FOLDER |
The parent folder of an Item.
Available on: DOCUMENT , LINK , FOLDER
Name: PARENT_FOLDER
Data Type: Item
|
PATH |
The path of an Item.
Available on: DOCUMENT , LINK , FOLDER
Name: PATH
Data Type: String
|
QUARANTINED_DATE |
Whether the Item has been quarantined by the anti-virus system
Available on: DOCUMENT
Name: QUARANTINED_DATE
Data Type: Date
|
QUOTA_ALLOCATED |
Quota allocated to the closest parent folder that has a QuotaConfiguration (could be the item itself, in the case of a Folder item).
Available on: DOCUMENT , FOLDER
Name: QUOTA_ALLOCATED
Data Type: Long
|
QUOTA_CONSUMED |
Quota consumed by the subtree of the closest parent folder that has a QuotaConfiguration.
Available on: DOCUMENT , FOLDER
Name: QUOTA_CONSUMED
Data Type: Long
|
RECORD |
The Record associated with this Document, if any
Available on: DOCUMENT
Name: RECORD
Data Type: Item
|
REPAIR_ATTEMPTS |
Returns the number of times a repair was attempted against a document. A repair only counts if it is checked against a more recent virus definitions than the last time an attempt was made or it is the first attempt after initial detection.
Available on: DOCUMENT
Name: REPAIR_ATTEMPTS
Data Type: Integer
|
RETENTION_DATE |
Retrieves the retention date of the document if set and content is stored on a compliance-enabled HSM device.
Available on: DOCUMENT
Name: RENTENTION_DATE
Data Type: Date
|
SECURITY_CONFIGURATION |
A list of users and their roles on a folder. May represent either the SecurityConfiguration that is explicitly set on the item, or the SecurityConfiguration that is inherited from a parent folder. To discern the difference, use the Attribute HAS_EXPLICIT_SECURITY_CONFIGURATION on the item.
Available on: FOLDER , DOCUMENT
Name: SECURITY_CONFIGURATION
Data Type: Item
|
SIZE |
The size of the content of a document in bytes.
Available on: DOCUMENT
Name: SIZE
Data Type: Long
|
TRASH_FOLDER |
The TrashFolder for a given Item.
Available on: DOCUMENT , LINK , FOLDER , WORKSPACE
Name: TRASH_FOLDER
Data Type: Item
|
URL |
The URL to an item, derived from the path.
Available on: DOCUMENT_DEFINITION , DOCUMENT , FOLDER , LINK
Name: URL
Data Type: String
|
VERSIONING_CONFIGURATION |
The configuration that governs versioning behavior on the item. May represent either the VersioningConfiguration that is explicitly set on the item, or the VersioningConfiguration that is inherited from a parent folder. To discern the difference, use the Attribute HAS_EXPLICIT_VERSIONING_CONFIGURATION on the item.
Available on: FOLDER , DOCUMENT
Name: VERSIONING_CONFIGURATION
Data Type: Item
|
VERSIONS |
All versions of a document. Returns the same list as VersionManager.listVersions() with default sorting.
Available on: DOCUMENT , FAMILY
Name: VERSIONS
Data Type: Item[] (elements of type VERSION)
|
WORKING_COPY |
Working copy of a version-controlled DOCUMENT Item. (or of a FAMILY Item).
Available on: DOCUMENT , FAMILY
Name: WORKING_COPY
Data Type: Item (type DOCUMENT)
|
Attribute Summary for Item Type - DOD5015RECORD |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
ADDRESSEES |
Primary users to whom a record was sent
(Unpublished)
- Available on: DOD5015RECORD
- Name: ADDRESSEES
- Data Type: Item array (USERs)
|
AUTHOR |
Author of a record
(Unpublished)
- Available on: DOD5015RECORD
- Name: AUTHOR
- Data Type: Item (USER)
|
FILED_BY |
User that filed a record
(Unpublished)
- Available on: DOD5015RECORD
- Name: FILED_BY
- Data Type: Item (USER)
|
FILED_DATE |
Date that the record was filed
(Unpublished)
- Available on: DOD5015RECORD
- Name: FILED_DATE
- Data Type: Date
|
FORMAT |
Format of the record
(Unpublished)
- Available on: DOD5015RECORD
- Name: FORMAT
- Data Type: String
|
LOCATION |
Location of the record
(Unpublished)
- Available on: DOD5015RECORD
- Name: LOCATION
- Data Type: String
|
MEDIA_TYPE |
Type of media that holds the content of the record
(Unpublished)
- Available on: DOD5015RECORD
- Name: MEDIA_TYPE
- Data Type: String
|
ORIGINATING_ORGANIZATION |
Organization where this record originated
(Unpublished)
- Available on: DOD5015RECORD
- Name: ORIGINATING_ORGANIZATION
- Data Type: String
|
OTHER_ADDRESSEES |
Secondary users to whom a record was sent
(Unpublished)
- Available on: DOD5015RECORD
- Name: OTHER_ADDRESSEES
- Data Type: Item array (USERs)
|
PUBLICATION_DATE |
Date that the record was published
(Unpublished)
- Available on: DOD5015RECORD
- Name: PUBLICATION_DATE
- Data Type: Date
|
RECEIVED_DATE |
Date that the record was recieved
(Unpublished)
- Available on: DOD5015RECORD
- Name: RECEIVED_DATE
- Data Type: Date
|
SUBJECT |
Subject of the record
(Unpublished)
- Available on: DOD5015RECORD
- Name: SUBJECT
- Data Type: String
|
Attribute Summary for Item Type - DOMAIN |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
ALL_ADMIN_USERS_GROUP |
The group used to model all domain-admin users in the Domain.
Available on: DOMAIN
Name: ALL_ADMIN_USERS_GROUP
Data Type: Item
|
ALL_USERS_GROUP |
The group used to model all users in the Domain.
Available on: DOMAIN
Name: ALL_USERS_GROUP
Data Type: Item
|
ARCHIVE |
The Archive for a given Item.
Available on: DOMAIN
Name: ARCHIVE
Data Type: Item
|
CATEGORY_CLASSES |
All category class objects.
Available on: DOMAIN
Name: CATEGORY_CLASSES
Data Type: Item[]
|
COMPOSITE_QUOTA_CONSUMED |
Quota consumed by the QuotaConfigurations below the target object. Currently only supported for Domains.
Available on: DOMAIN
Name: COMPOSITE_QUOTA_CONSUMED
Data Type: Long
|
CREATE_WORKSPACE_REQUEST_ALLOWED |
Whether requests for workspace creation are allowed.
Available on: DOMAIN , CONTAINER
Name: CREATE_WORKSPACE_REQUEST_ALLOWED
Data Type: Boolean
|
DEFAULT_QUOTA_ALLOCATION |
Default amount of quota allocated to new workspaces in the domain.
Available on: DOMAIN
Name: DEFAULT_QUOTA_ALLOCATION
Data Type: Long
|
DEFAULT_WORKSPACE_ROLES |
The default set of roles that should be presented when a Workspace role is to be selected for use in a security definition.
Available on: DOMAIN
Name: DEFAULT_WORKSPACE_ROLES
Data Type: Item[]
|
DOMAIN_ENABLED |
Whether a domain is enabled.
Available on: DOMAIN
Name: DOMAIN_ENABLED
Data Type: Boolean
|
IS_DEFAULT_DOMAIN |
Whether a domain is the default domain.
Available on: DOMAIN
Name: IS_DEFAULT_DOMAIN
Data Type: Boolean
|
MOST_RECENT_DOCS_MAX_ITEMS |
Domain enforced max items limits for most recent documents.
Available on: DOMAIN
Name: MOST_RECENT_DOCS_MAX_ITEMS
Data Type: Int
|
PERSONAL_WORKSPACES_ENABLED |
Whether a domain allows the creation of personal workspaces
Available on: DOMAIN
Name: PERSONAL_WORKSPACES_ENABLED
Data Type: Boolean
|
ROOT_CATEGORY_CLASSES |
All category class objects that do not have a SuperClass
Available on: DOMAIN
Name: ROOT_CATEGORY_CLASSES
Data Type: Item[]
|
USER_WORKSPACES_ROOT |
Root of workspaces inside the domain.
Available on: DOMAIN
Name: USER_WORKSPACES_ROOT
Data Type: String
|
WORLD_GRANTS_ENABLED |
Whether a domain allows the use of public grants.
Available on: DOMAIN
Name: WORLD_GRANTS_ENABLED
Data Type: Boolean
|
WORLD_GROUP |
The group used to represent any user, used for grants intended for "guest" access.
Available on: DOMAIN
Name: WORLD_GROUP
Data Type: Item
|
Attribute Summary for Item Type - FOLDER |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
CATEGORY_CONFIGURATION |
The category configuration of an item.
Available on: FOLDER , DOCUMENT
Name: CATEGORY_CONFIGURATION
Data Type: Item
|
EFFECTIVE_ROLES |
The roles the current user has on the target object, either via a direct grant, a propagating grant, or a grant to a group that the user is a member of.
Available on: FOLDER , DOCUMENT
Name: EFFECTIVE_ROLES
Data Type: Item[]
|
FOLDER_ITEMS |
The contents of a FOLDER Item.
Available on: FOLDER
Name: FOLDER_ITEMS
Data Type: Item[] (elements of mixed types: FOLDER , CONTAINER , WORKSPACE , ARCHIVE , TRASH_FOLDER , DOCUMENT , LINK)
|
HAS_EXPLICIT_CATEGORY_CONFIGURATION |
Whether the Item has an explicit Category configuration
Available on: FOLDER
Name: HAS_EXPLICIT_CATEGORY_CONFIGURATION
Data Type: Boolean
|
HAS_EXPLICIT_RECORD_CONFIGURATION |
Whether the Item has an explicit record configuration
Available on: FOLDER
Name: HAS_EXPLICIT_RECORD_CONFIGURATION
Data Type: Boolean
|
HAS_EXPLICIT_SECURITY_CONFIGURATION |
Whether the Item has an explicit security configuration
Available on: FOLDER
Name: HAS_EXPLICIT_SECURITY_CONFIGURATION
Data Type: Boolean
|
HAS_EXPLICIT_VERSIONING_CONFIGURATION |
Whether the Item has an explicit versioning configuration (if true, the Item overrides the versioning configuration; if false, the Item inherits its versioning configuration).
Available on: FOLDER
Name: HAS_EXPLICIT_VERSIONING_CONFIGURATION
Data Type: Boolean
|
HAS_ITEMS |
Whether a FOLDER Item contains any Items.
Available on: FOLDER
Name: HAS_ITEMS
Data Type: Boolean
|
HAS_SUBFOLDERS |
Whether a Folder has subfolders.
Available on: FOLDER
Name: HAS_SUBFOLDERS
Data Type: Boolean
|
ICON_URL |
The URL to the icon for an item.
Available on: DOCUMENT , LINK , FOLDER
Name: ICON_URL
Data Type: String
|
ID_URL |
The ID-based (static, not path-based) URL to an item.
Available on: DOCUMENT_DEFINITION , DOCUMENT , FOLDER , LINK
Name: ID_URL
Data Type: String
|
PARENT_FOLDER |
The parent folder of an Item.
Available on: DOCUMENT , LINK , FOLDER
Name: PARENT_FOLDER
Data Type: Item
|
PATH |
The path of an Item.
Available on: DOCUMENT , LINK , FOLDER
Name: PATH
Data Type: String
|
QUOTA_ALLOCATED |
Quota allocated to the closest parent folder that has a QuotaConfiguration (could be the item itself, in the case of a Folder item).
Available on: DOCUMENT , FOLDER
Name: QUOTA_ALLOCATED
Data Type: Long
|
QUOTA_CONSUMED |
Quota consumed by the subtree of the closest parent folder that has a QuotaConfiguration.
Available on: DOCUMENT , FOLDER
Name: QUOTA_CONSUMED
Data Type: Long
|
RECORD_CONFIGURATION |
The configuration that governs the recordization behavior on the folder. May represent either the RecordConfiguration that is explicitly set on the folder item or the RecordConfiguration that is inherited from the parent To discern the difference, use the Attribute HAS_EXPLICIT_RECORD_CONFIGURATION on the item.
Available on: FOLDER
Name: RECORD_CONFIGURATION
Data Type: Item
|
SECURITY_CONFIGURATION |
A list of users and their roles on a folder. May represent either the SecurityConfiguration that is explicitly set on the item, or the SecurityConfiguration that is inherited from a parent folder. To discern the difference, use the Attribute HAS_EXPLICIT_SECURITY_CONFIGURATION on the item.
Available on: FOLDER , DOCUMENT
Name: SECURITY_CONFIGURATION
Data Type: Item
|
SUBFOLDER_ITEMS |
The contents of a FOLDER Item, whose item type is FOLDER.
Available on: FOLDER
Name: SUBFOLDER_ITEMS
Data Type: Item[] (elements of mixed types: FOLDER , CONTAINER , WORKSPACE , ARCHIVE , TRASH_FOLDER)
|
TRASH_FOLDER |
The TrashFolder for a given Item.
Available on: DOCUMENT , LINK , FOLDER , WORKSPACE
Name: TRASH_FOLDER
Data Type: Item
|
URL |
The URL to an item, derived from the path.
Available on: DOCUMENT_DEFINITION , DOCUMENT , FOLDER , LINK
Name: URL
Data Type: String
|
VERSIONING_CONFIGURATION |
The configuration that governs versioning behavior on the item. May represent either the VersioningConfiguration that is explicitly set on the item, or the VersioningConfiguration that is inherited from a parent folder. To discern the difference, use the Attribute HAS_EXPLICIT_VERSIONING_CONFIGURATION on the item.
Available on: FOLDER , DOCUMENT
Name: VERSIONING_CONFIGURATION
Data Type: Item
|
Attribute Summary for Item Type - GRANT |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
GRANTEE |
The id of the directory object to which a role is granted
Available on: GRANT
Name: GRANTEE
Data Type: Item
|
HAS_ADMIN_ROLES |
Whether the grant includes any Roles which are only realized when the user has switched into admin mode.
Available on: GRANT
Name: HAS_ADMIN_ROLES
Data Type: Boolean
|
HAS_NORMAL_ROLES |
Whether the grant includes any Roles which are realized when the user is in normal mode.
Available on: GRANT
Name: HAS_NORMAL_ROLES
Data Type: Boolean
|
PROPAGATED_FROM |
The folder from which a security configuration grant is propagated (the grant is inherited from a parent folder's security configuration). If the grant is not inherited, the value will be the current folder.
Available on: GRANT
Name: PROPAGATED_FROM
Data Type: Item
|
PROPAGATING |
Whether a security configuration grant is propagating (sub-folders of the item will inherit this grant). Also, whether a role propagates by default.
Available on: GRANT , ROLE
Name: PROPAGATING
Data Type: Boolean
|
ROLES |
The roles specified on a grant
Available on: GRANT
Name: ROLES
Data Type: Item[]
|
Attribute Summary for Item Type - GROUP |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
ALL_USER_MEMBERS |
The list of all user members of this group.
Available on: GROUP
Name: ALL_USER_MEMBERS
Data Type: Item[]
|
GROUP_MEMBER_LIST |
The list of direct members of this group that are themselves groups. Note that this list is a direct subset of the MEMBER_LIST attribute.
Available on: GROUP
Name: GROUP_MEMBER_LIST
Data Type: Item[]
|
IS_ALL_ADMIN_USERS_GROUP |
Whether the group is an internal group used by Domains to represent all administration users in the Domain.
Available on: GROUP
Name: IS_ALL_ADMIN_USERS_GROUP
Data Type: Boolean
|
IS_ALL_USERS_GROUP |
Whether the group is an internal group used by Domains to represent all users in the Domain.
Available on: GROUP
Name: IS_ALL_USERS_GROUP
Data Type: Boolean
|
IS_EXTERNALLY_MANAGED |
Whether the group is an externally managed UserGroup or an internal group.
Available on: GROUP
Name: IS_EXTERNALLY_MANAGED
Data Type: Boolean
|
IS_INTERNAL |
Whether the group is an internal group.
Available on: GROUP
Name: IS_INTERNAL
Data Type: Boolean
|
IS_WORLD |
Whether the group is the "World" internal group.
Available on: GROUP
Name: IS_WORLD
Data Type: Boolean
|
MANAGER_LIST |
The list of users who can manage the item.
Available on: GROUP
Name: MANAGER_LIST
Data Type: Item[]
|
MEMBER_LIST |
The list of direct members of this group. Note that this list does not include managers, who are implicit members.
Available on: GROUP
Name: MEMBER_LIST
Data Type: Item[]
|
Attribute Summary for Item Type - LINK |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
ICON_URL |
The URL to the icon for an item.
Available on: DOCUMENT , LINK , FOLDER
Name: ICON_URL
Data Type: String
|
ID_URL |
The ID-based (static, not path-based) URL to an item.
Available on: DOCUMENT_DEFINITION , DOCUMENT , FOLDER , LINK
Name: ID_URL
Data Type: String
|
LINK_DESTINATION |
The destination to which a Link points. Returns null if the Link is broken, or if the Link's destination is not accessible because of access control.
Available on: LINK
Name: LINK_DESTINATION
Data Type: Item (DOCUMENT or FOLDER)
|
LINK_IS_BROKEN |
Whether a Link is broken.
Available on: LINK
Name: LINK_IS_BROKEN
Data Type: Boolean
|
MIME_TYPE |
The MIME type of the contents of a document.
Available on: DOCUMENT , LINK
Name: MIME_TYPE
Data Type: String
|
PARENT_FOLDER |
The parent folder of an Item.
Available on: DOCUMENT , LINK , FOLDER
Name: PARENT_FOLDER
Data Type: Item
|
PATH |
The path of an Item.
Available on: DOCUMENT , LINK , FOLDER
Name: PATH
Data Type: String
|
TRASH_FOLDER |
The TrashFolder for a given Item.
Available on: DOCUMENT , LINK , FOLDER , WORKSPACE
Name: TRASH_FOLDER
Data Type: Item
|
URL |
The URL to an item, derived from the path.
Available on: DOCUMENT_DEFINITION , DOCUMENT , FOLDER , LINK
Name: URL
Data Type: String
|
Attribute Summary for Item Type - LOCK |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
LOCK_DAV_OWNER |
The DavOwner value of a Lock.
Available on: LOCK
Name: LOCK_DAV_OWNER
Data Type: String
|
LOCK_DEPTH |
The depth value of a Lock.
Available on: LOCK
Name: LOCK_DEPTH
Data Type: Integer
|
LOCK_EXCEPTED_USER |
User for which the restrictions described by the LockEntry does not apply
Value:
Available on: LOCK
Data Type: User
|
LOCK_INFO |
The optional Item associated with a Lock.
Available on: LOCK
Name: LOCK_INFO
Data Type: Item
|
LOCK_RESTRICTIONS |
The lock restrictions bitmap for a LOCK.
Value is a long bitmap (64 bits), each of which may represent a single capability. Capability constants are defined in FdkConstants. To check if a capability is restricted by a LOCK, perform a bitwise AND operation with one of the capability constants. Example:
boolean deleteRestricted = (restrictions & FdkConstants.CAPABILITY_DELETE) == FdkConstants.CAPABILITY_DELETE;
- Available on: LOCK
- Name: LOCK_RESTRICTIONS
- Data Type: Long
|
LOCK_TIMEOUT |
The timeout value of a Lock.
Available on: LOCK
Name: LOCK_TIMEOUT
Data Type: Date
|
LOCK_TOKEN |
The token value of a Lock.
Available on: LOCK
Name: LOCK_TOKEN
Data Type: String
|
LOCK_TYPE |
An integer representing a type of Lock.
Available on: LOCK
Name: LOCK_TYPE
Data Type: Integer
|
Attribute Summary for Item Type - METADATA_ATTRIBUTE |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
ATTRIBUTE_CLASS_OBJECT |
The class (either Category or RecordCategory) to which this attribute belongs.
Available on: METADATA_ATTRIBUTE
Name: ATTRIBUTE_CLASS_OBJECT
Data Type: Item (CATEGORY_CLASS_OBJECT or RECORD_CATEGORY).
|
ATTRIBUTE_DEFAULT |
Default for this attribute.
Available on: METADATA_ATTRIBUTE
Name: ATTRIBUTE_DEFAULT
Data Type: (determined by ATTRIBUTE_TYPE)
|
ATTRIBUTE_ENUMERATION |
Enumeration for this attribute.
Available on: METADATA_ATTRIBUTE
Name: ATTRIBUTE_ENUMERATION
Data Type: (determined by ATTRIBUTE_TYPE)
|
ATTRIBUTE_HIDDEN |
Is this Attribute updateable. Must be enforced by the client.
Available on: METADATA_ATTRIBUTE
Name: ATTRIBUTE_HIDDEN
Data Type: Boolean
|
ATTRIBUTE_NAME |
Attribute Name. This name must start with "CUSTOM_". Or it can be generated if not specified (see DISPLAY_NAME).
Available on: METADATA_ATTRIBUTE
Name: ATTRIBUTE_NAME
Data Type: String
|
ATTRIBUTE_OVERRIDEABLE |
Can the constraints of this attribute be changed (overridden) at the folder level (via a CategoryConfiguration or RecordConfiguration).
Available on: METADATA_ATTRIBUTE
Name: ATTRIBUTE_OVERRIDEABLE
Data Type: Boolean
|
ATTRIBUTE_PROMPTED |
Should the client prompt for the value of this attribute?
Available on: METADATA_ATTRIBUTE
Name: ATTRIBUTE_PROMPTED
Data Type: Boolean
|
ATTRIBUTE_REQUIRED |
Is this Attribute required.
Available on: METADATA_ATTRIBUTE
Name: ATTRIBUTE_REQUIRED
Data Type: Boolean
|
ATTRIBUTE_SETTABLE |
Is this Attribute settable.
Available on: METADATA_ATTRIBUTE
Name: ATTRIBUTE_SETTABLE
Data Type: Boolean
|
ATTRIBUTE_TYPE |
Attribute Type (String, Integer, etc.). Values are in FdkConstants class.
Available on: METADATA_ATTRIBUTE
Name: ATTRIBUTE_TYPE
Data Type: Integer
|
ATTRIBUTE_UPDATEABLE |
Is this Attribute updateable.
Available on: METADATA_ATTRIBUTE
Name: ATTRIBUTE_UPDATEABLE
Data Type: Boolean
|
DISPLAY_NAME |
The display name of a user or MetaData object.
Available on: USER , CATEGORY_CLASS_OBJECT , RECORD , METADATA_ATTRIBUTE
Name: DISPLAY_NAME
Data Type: String
|
Attribute Summary for Item Type - RECORD |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
CURRENT_DISPOSITION_PHASE |
The integer number of the current disposition phase the record is going through
Available on: RECORD
Name: CURRENT_DISPOSITION_PHASE
Data Type: Integer
|
DISPLAY_NAME |
The display name of a user or MetaData object.
Available on: USER , CATEGORY_CLASS_OBJECT , RECORD , METADATA_ATTRIBUTE
Name: DISPLAY_NAME
Data Type: String
|
END_DATE |
The end date for a RETAIN disposition phase of a record
Available on: RECORD
Name: END_DATE
Data Type: Date
|
END_EVENT |
The event that ends a RETAIN disposition phase of a record
(Unpublished)
- Available on: RECORD
- Name: END_EVENT
- Data Type: Item (RECORDS_MANAGEMENT_EVENT)
|
ERROR_FLAG |
Indicates whether the record has encountered an error in the current Disposition phase
Available on: RECORD
Name: ERROR_FLAG
Data Type: Boolean
|
IS_FROZEN |
Indicator of whether this record category is frozen
Available on: RECORD , RECORD_CATEGORY , RECORD_FOLDER
Name: IS_FROZEN
Data Type: Boolean
|
RECORD_CATEGORY |
The Record category that a record belongs to
Available on: RECORD
Name: RECORD_CATEGORY
Data Type: Item (RECORD_CATEGORY)
|
RECORDIZED_OBJECT |
The object that is recordized using this record.
Available on: RECORD
Name: RECORDIZED_OBJECT
Data Type: Item
|
RECORDS_MANAGEMENT_PARENT |
The parent of a Records management object
Available on: RECORD_SERIES , RECORD_CATEGORY , RECORD_FOLDER , RECORD
Name: RECORDS_MANAGEMENT_PARENT
Data Type: Item
|
START_DATE |
The start date for a RETAIN disposition phase of a record
Available on: RECORD
Name: START_DATE
Data Type: Date
|
Attribute Summary for Item Type - RECORD_CATEGORY |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
ATTRIBUTE_DETAIL |
An array with the details of a metadata attribute (name, type, etc). Used for creating metadata attributes.
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: ATTRIBUTE_DETAIL
Data Type: NamedValue[]
|
ATTRIBUTE_DETAILS |
An array of ATTRIBUTE_DETAIL with the details of a metadata attribute (name, type, etc).
Available on: RECORD_CATEGORY , CATEGORY_CLASS
Name: ATTRIBUTE_DETAILS
Data Type: NamedValue[]
|
CLASS_ABSTRACT |
Is this Class abstract.
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: CLASS_ABSTRACT
Data Type: Boolean
|
CLASS_COPIED |
Are instances of this class copied when associated object is copied or versioned?
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: CLASS_COPIED
Data Type: Boolean
|
CLASS_FINAL |
Is this Class final (can it be extended.
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: CLASS_FINAL
Data Type: Boolean
|
CLASS_HIDDEN |
Is this Class hidden from the UI. Must be enforced by the client.
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: CLASS_HIDDEN
Data Type: Boolean
|
CLASS_NAME |
Class Name. This name gets mangled when the class is created. See DISPLAY_NAME.
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: CLASS_NAME
Data Type: String
|
CLOSE_EVENT |
The event that triggers the closing off of a RecordCategory
(Unpublished)
- Available on: RECORD_CATEGORY
- Name: CLOSE_EVENT
- Data Type: Item
|
CUTOFF_EVENT |
The event that triggers thecut off of a RecordCategory
(Unpublished)
- Available on: RECORD_CATEGORY , RECORD_FOLDER
- Name: CUTOFF_EVENT
- Data Type: Item
|
CUTOFF_FREQUENCY |
The cut off frequency of a record category
Available on: RECORD_CATEGORY
Name: CUTOFF_FREQUENCY
Data Type: Integer
|
CUTOFF_FREQUENCY_DAILY |
The cut off frequency which represents a daily cut off for a a record category.
Available on: RECORD_CATEGORY
Name: CUTOFF_FREQUENCY_DAILY
Data Type: String
|
CUTOFF_FREQUENCY_MONTHLY |
The cut off frequency which represents a monthly cut off for a a record category.
(Published)
- Available on: RECORD_CATEGORY
- Name: CUTOFF_FREQUENCY_MONTHLY
- Data Type: String
|
CUTOFF_FREQUENCY_MULTIPLIER |
The cut off frequency multiplier of a record category
(Unpublished)
- Available on: RECORD_CATEGORY
- Name: CUTOFF_FREQUENCY_MULTIPLIER
- Data Type: Integer
|
CUTOFF_FREQUENCY_NONE |
The cut off frequency of NONE for a record category. This represents a single one time non repeating cut off.
Available on: RECORD_CATEGORY
Name: CUTOFF_FREQUENCY_NONE
Data Type: String
|
CUTOFF_FREQUENCY_WEEKLY |
The cut off frequency which represents a weekly cut off for a a record category.
(Published)
- Available on: RECORD_CATEGORY
- Name: CUTOFF_FREQUENCY_WEEKLY
- Data Type: String
|
CUTOFF_FREQUENCY_YEARLY |
The cut off frequency which represents a yearly cut off for a a record category.
(Published)
- Available on: RECORD_CATEGORY
- Name: CUTOFF_FREQUENCY_YEARLY
- Data Type: String
|
DISPOSITION_PHASES |
The disposition phases for a record category
Available on: RECORD_CATEGORY
Name: DISPOSITION_PHASES
Data Type: Item[] (DISPOSITION_PHASE)
|
HAS_IMMEDIATE_CHILDREN |
Indicator of whether a records management object has immediate children
Available on: FILE_PLAN , RECORD_SERIES , RECORD_CATEGORY
Name: HAS_IMMEDIATE_CHILDREN
Data Type: Boolean
|
INITIAL_CUTOFF_DATE |
The first cut off date for a record category. Can only be set when the record category item is first created.
Available on: RECORD_CATEGORY
Name: INITIAL_CUTOFF_DATE
Data Type: Date
|
IS_CLOSED |
Indicator of whether this record category is closed
Available on: RECORD_CATEGORY , RECORD_FOLDER
Name: IS_CLOSED
Data Type: Boolean
|
IS_FROZEN |
Indicator of whether this record category is frozen
Available on: RECORD , RECORD_CATEGORY , RECORD_FOLDER
Name: IS_FROZEN
Data Type: Boolean
|
LAST_CUTOFF_DATE |
The date on which the record category was last cut off
Available on: RECORD_CATEGORY , RECORD_FOLDER
Name: LAST_CUTOFF_DATE
Data Type: Date
|
METADATA_ATTRIBUTES |
MetaData Attributes. The Attributes of this Category Class or Record Category
Available on: CATEGORY_CLASS_OBJECT , RECORD_CATEGORY
Name: METADATA_ATTRIBUTES
Data Type: Item[]
|
METADATA_DIRECT_ATTRIBUTES |
MetaData Direct Attributes. The Attributes of this Category Class or Record Category that are not inherited.
Available on: CATEGORY_CLASS_OBJECT , RECORD_CATEGORY
Name: METADATA_DIRECT_ATTRIBUTES
Data Type: Item[]
|
NEXT_CUTOFF_DATE |
The date for the next cut off for a record category. Can only be set when the record category item is updated
Available on: RECORD_CATEGORY , RECORD_FOLDER
Name: NEXT_CUTOFF_DATE
Data Type: Date
|
QUALIFIED_NAME |
The qualified name of a Records management object
Available on: FILE_PLAN , RECORD_SERIES , RECORD_CATEGORY , RECORD_FOLDER
Name: QUALIFIED_NAME
Data Type: String
|
RECORDS_MANAGEMENT_PARENT |
The parent of a Records management object
Available on: RECORD_SERIES , RECORD_CATEGORY , RECORD_FOLDER , RECORD
Name: RECORDS_MANAGEMENT_PARENT
Data Type: Item
|
SUPERCLASS |
Id of class from which this class inherits (or null if not extending a class).
Available on: CATEGORY_CLASS , RECORD_CATEGORY
Name: SUPERCLASS
Data Type: String
|
Attribute Summary for Item Type - RECORD_CONFIGURATION |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
ALLOW_ALL_RECORD_CATEGORIES |
Allowed record categories on the objects that reside under the folder which has this record configuration.
Available on: RECORD_CONFIGURATION
Name: ALLOW_ALL_RECORD_CATEGORIES
Data Type: Boolean
|
ALLOWED_RECORD_CATEGORIES |
Allowed record categories on the objects that reside under the folder which has this record configuration.
Available on: RECORD_CONFIGURATION
Name: ALLOWED_RECORD_CATEGORIES
Data Type: Item []
|
ATTRIBUTE_OVERRIDE |
Specifies an Attribute Override on a CategoryConfiguration or RecordConfiguration
Available on: RECORD_CONFIGURATION , CATEGORY_CONFIGURATION
Name: ATTRIBUTE_OVERRIDE
Data Type: Item
|
ATTRIBUTE_OVERRIDES |
The Attribute Overrides on a CategoryConfiguration or RecordConfiguration
Available on: RECORD_CONFIGURATION , CATEGORY_CONFIGURATION
Name: ATTRIBUTE_OVERRIDES
Data Type: Item []
|
REQUIRED_RECORD_CATEGORY |
Required record on the objects that reside under the folder which has this record configuration.
Available on: RECORD_CONFIGURATION
Name: REQUIRED_RECORD_CATEGORY
Data Type: Item
|
Attribute Summary for Item Type - RECORD_FOLDER |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
CUTOFF_EVENT |
The event that triggers thecut off of a RecordCategory
(Unpublished)
- Available on: RECORD_CATEGORY , RECORD_FOLDER
- Name: CUTOFF_EVENT
- Data Type: Item
|
IS_CLOSED |
Indicator of whether this record category is closed
Available on: RECORD_CATEGORY , RECORD_FOLDER
Name: IS_CLOSED
Data Type: Boolean
|
IS_CUTOFF_INHERITED |
Indicator of whether a Record folder inherits its cut off instructions from the parent record category
Available on: RECORD_FOLDER
Name: IS_CUTOFF_INHERITED
Data Type: Boolean
|
IS_FROZEN |
Indicator of whether this record category is frozen
Available on: RECORD , RECORD_CATEGORY , RECORD_FOLDER
Name: IS_FROZEN
Data Type: Boolean
|
LAST_CUTOFF_DATE |
The date on which the record category was last cut off
Available on: RECORD_CATEGORY , RECORD_FOLDER
Name: LAST_CUTOFF_DATE
Data Type: Date
|
NEXT_CUTOFF_DATE |
The date for the next cut off for a record category. Can only be set when the record category item is updated
Available on: RECORD_CATEGORY , RECORD_FOLDER
Name: NEXT_CUTOFF_DATE
Data Type: Date
|
QUALIFIED_NAME |
The qualified name of a Records management object
Available on: FILE_PLAN , RECORD_SERIES , RECORD_CATEGORY , RECORD_FOLDER
Name: QUALIFIED_NAME
Data Type: String
|
RECORD_FOLDER_ID |
The Category ID of a record folder
Available on: RECORD_FOLDER
Name: RECORD_FOLDER_ID
Data Type: String
|
RECORD_FOLDER_LOCATION |
The location of a record folder
Available on: RECORD_FOLDER
Name: RECORD_FOLDER_LOCATION
Data Type: String
|
RECORDS_MANAGEMENT_PARENT |
The parent of a Records management object
Available on: RECORD_SERIES , RECORD_CATEGORY , RECORD_FOLDER , RECORD
Name: RECORDS_MANAGEMENT_PARENT
Data Type: Item
|
Attribute Summary for Item Type - RECORD_SERIES |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
HAS_IMMEDIATE_CHILDREN |
Indicator of whether a records management object has immediate children
Available on: FILE_PLAN , RECORD_SERIES , RECORD_CATEGORY
Name: HAS_IMMEDIATE_CHILDREN
Data Type: Boolean
|
QUALIFIED_NAME |
The qualified name of a Records management object
Available on: FILE_PLAN , RECORD_SERIES , RECORD_CATEGORY , RECORD_FOLDER
Name: QUALIFIED_NAME
Data Type: String
|
RECORDS_MANAGEMENT_PARENT |
The parent of a Records management object
Available on: RECORD_SERIES , RECORD_CATEGORY , RECORD_FOLDER , RECORD
Name: RECORDS_MANAGEMENT_PARENT
Data Type: Item
|
Attribute Summary for Item Type - REQUEST |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
REQUEST_CAN_CANCEL |
Whether the request can be canceled.
Available on: REQUEST
Name: REQUEST_CAN_CANCEL
Data Type: Boolean
|
REQUEST_CAN_RESPOND |
Whether the request can be responded to (approved, denied, acknowledged).
Available on: REQUEST
Name: REQUEST_CAN_RESPOND
Data Type: Boolean
|
REQUEST_CREATED |
The Request create date
Available on: REQUEST
Name: REQUEST_CREATED
Data Type: Date
|
REQUEST_DEFINITIONS |
The Request target definitions, which provide options for the type of operation that has been requested and will be performed on the target items if the Request is approved.
Available on: REQUEST
Name: REQUEST_DEFINITIONS
Data Type: NamedValueSet[]
|
REQUEST_FAILURE_CAUSE |
The cause of a Request failure.
Available on: REQUEST
Name: REQUEST_FAILURE_CAUSE
Data Type: String
|
REQUEST_RESPONSE |
The Request response.
Available on: REQUEST
Name: REQUEST_RESPONSE
Data Type: Boolean
|
REQUEST_RESPONSE_DATE |
The Request response date.
Available on: REQUEST
Name: REQUEST_RESPONSE_DATE
Data Type: Date
|
REQUEST_STATUS |
The Request status: PENDING, CANCELED, SUCCEEDED, ABORTED, EXPIRED, FAILED.
Available on: REQUEST
Name: REQUEST_STATUS
Data Type: Integer
|
REQUEST_TARGETS |
The Request target items.
Available on: REQUEST
Name: REQUEST_TARGETS
Data Type: Item[] (elements can be of any object type; usually Document)
|
REQUEST_TRIGGERED |
Whether the Request is triggered (non-blocking).
Available on: REQUEST
Name: REQUEST_TRIGGERED
Data Type: Boolean
|
REQUEST_TYPE |
The Request operation type.
Available on: REQUEST
Name: REQUEST_TYPE
Data Type: String
|
REQUEST_WORKFLOW |
The Workflow started by the Request.
Available on: REQUEST
Name: REQUEST_WORKFLOW
Data Type: WORKFLOW (Item)
|
REQUEST_WORKFLOW_PARAMETERS |
The workflow parameters sent to the external workflow engine as part of the workflow process initiated by this Request.
Available on: REQUEST
Name: REQUEST_WORKFLOW_PARAMETERS
Data Type: NamedValue[] (set of {name , value} pairs of type String)
|
Attribute Summary for Item Type - USER |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
CHARACTER_SET |
The default character set of a User.
Available on: USER
Name: CHARACTER_SET
Data Type: String
|
DISPLAY_NAME |
The display name of a user or MetaData object.
Available on: USER , CATEGORY_CLASS_OBJECT , RECORD , METADATA_ATTRIBUTE
Name: DISPLAY_NAME
Data Type: String
|
DOMAIN |
The domain of a User.
Available on: USER
Name: DOMAIN
Data Type: Item
|
DOMAIN_ADMIN_USER |
The domain user attribute of a user.
Available on: USER
Name: DOMAIN_ADMIN_USER
Data Type: Item
|
DOMAIN_USER |
The domain user attribute of a user.
Available on: USER
Name: DOMAIN_USER
Data Type: Item
|
EMAIL_ADDRESS |
A user's e-mail address.
Available on: USER
Name: EMAIL_ADDRESS
Data Type: String
|
FIRST_NAME |
A user's first name.
Available on: USER
Name: FIRST_NAME
Data Type: String
|
LANGUAGE |
The default language of a User
Available on: USER
Name: LANGUAGE
Data Type: String
|
LAST_NAME |
A user's last name.
Available on: USER
Name: LAST_NAME
Data Type: String
|
LOCALE |
The locale of a User.
Available on: USER
Name: LOCALE
Data Type: String
|
PERSONAL_WORKSPACE |
The personal workspace for a User.
Available on: USER
Name: PERSONAL_WORKSPACE
Data Type: Item
|
REALM |
The realm attribute of a user.
Available on: USER
Name: REALM
Data Type: String
|
TIME_ZONE |
The time zone of a User.
Available on: USER
Name: TIME_ZONE
Data Type: String
|
USER_NAME |
The name of a user, expressed as the User ID of the user in normal mode.
Available on: USER
Name: USER_NAME
Data Type: String
|
Attribute Summary for Item Type - VERSION |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
CAN_COPY_VERSION |
Whether a version may be copied.
Available on: VERSION
Name: CAN_COPY_VERSION
Data Type: Boolean
|
CAN_COPY_VERSION_TO_LATEST |
Whether a version may be copied to the latest version.
Available on: VERSION
Name: CAN_COPY_VERSION_TO_LATEST
Data Type: Boolean
|
CAN_COPY_VERSION_TO_WORKING_COPY |
Whether a version may be copied to the working copy.
Available on: VERSION
Name: CAN_COPY_VERSION_TO_WORKING_COPY
Data Type: Boolean
|
CAN_DELETE_VERSION |
Whether a version may be deleted.
Available on: VERSION
Name: CAN_DELETE_VERSION
Data Type: Boolean
|
CAN_MOVE_VERSION |
Whether a version may be moved.
Available on: VERSION
Name: CAN_MOVE_VERSION
Data Type: Boolean
|
DO_NOT_PURGE |
Whether the version may not be automatically purged.
Available on: VERSION
Name: DO_NOT_PURGE
Data Type: Boolean
|
FAMILY |
The Family of a version-controlled DOCUMENT Item or of a VERSION Item.
Available on: DOCUMENT , VERSION
Name: FAMILY
Data Type: Item (type FAMILY)
|
|
The version comment for a version.
Available on: VERSION
Name: VERSION_COMMENT
Data Type: String
|
VERSION_LABEL |
The version label of a version.
Available on: VERSION
Name: VERSION_LABEL
Data Type: String
|
VERSION_NUMBER |
The version number of a version.
Available on: VERSION
Name: VERSION_NUMBER
Data Type: Long
|
VERSIONED_DOCUMENT |
The underlying versioned Document of a Version.
Available on: VERSION
Name: VERSIONED_DOCUMENT
Data Type: Item
|
Attribute Summary for Item Type - VERSIONING_CONFIGURATION |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
VERSIONING_CONFIGURATION_AUTO_LABEL |
Whether auto-labeling is enabled.
Available on: VERSIONING_CONFIGURATION
Name: VERSIONING_CONFIGURATION_AUTO_LABEL
Data Type: Boolean
|
VERSIONING_CONFIGURATION_AUTO_VERSION |
Whether auto-versioning is enabled.
Available on: VERSIONING_CONFIGURATION
Name: VERSIONING_CONFIGURATION_AUTO_VERSION
Data Type: Boolean
|
VERSIONING_CONFIGURATION_LABEL_TYPE |
Automatic labeling type.
Available on: VERSIONING_CONFIGURATION
Name: VERSIONING_CONFIGURATION_LABEL_TYPE
Data Type: Integer
|
VERSIONING_CONFIGURATION_MAX_VERSIONS |
Maximum number of versions to keep.
Available on: VERSIONING_CONFIGURATION
Name: VERSIONING_CONFIGURATION_MAX_VERSIONS
Data Type: Integer
|
Attribute Summary for Item Type - WORKFLOW_CONFIGURATION |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
WORKFLOW_CONFIGURATION_IS_TRIGGERED |
Specifies whether the WorkflowConfiguration is configured such that Requests created will be triggered, as opposed to approval.
Available on: WORKFLOW_CONFIGURATION
Name: WORKFLOW_CONFIGURATION_IS_TRIGGERED
Data Type: Boolean
|
WORKFLOW_CONFIGURATION_OPERATION |
The operation that the WorkflowConfiguration is for.
Available on: WORKFLOW_CONFIGURATION
Name: WORKFLOW_CONFIGURATION_OPERATION
Data Type: String
|
WORKFLOW_CONFIGURATION_RESPONDERS |
The list of Responders attached to a WorkflowConfiguration.
Available on: WORKFLOW_CONFIGURATION
Name: WORKFLOW_CONFIGURATION_RESPONDERS
Data Type: Item[]
|
WORKFLOW_CONFIGURATION_RESPONDERS_BYPASS |
Specifies whether responders that start a request bypass workflow.
Available on: WORKFLOW_CONFIGURATION
Name: WORKFLOW_CONFIGURATION_RESPONDERS_BYPASS
Data Type: Boolean
|
WORKFLOW_CONFIGURATION_WORKFLOW |
The Workflow specified for a WorkflowConfiguration.
Available on: WORKFLOW_CONFIGURATION
Name: WORKFLOW_CONFIGURATION_WORKFLOW
Data Type: Item
|
Attribute Summary for Item Type - WORKFLOW_PARAMETER |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
WORKFLOW_PARAMETER_DEFAULT_VALUE |
Default value of the WorkflowParameter.
Available on: WORKFLOW_PARAMETER
Name: WORKFLOW_PARAMETER_DEFAULT_VALUE
Data Type: String
|
WORKFLOW_PARAMETER_DESCRIPTION |
Description of the WorkflowParameter.
Available on: WORKFLOW_PARAMETER
Name: WORKFLOW_PARAMETER_DESCRIPTION
Data Type: String
|
WORKFLOW_PARAMETER_FINAL |
Whether the WorkflowParameter is final (immutable), which means its default value cannot be set for a WorkflowConfiguration.
Available on: WORKFLOW_PARAMETER
Name: WORKFLOW_PARAMETER_FINAL
Data Type: String
|
WORKFLOW_PARAMETER_HIDDEN |
Whether the WorkflowParameter is hidden.
Available on: WORKFLOW_PARAMETER
Name: WORKFLOW_PARAMETER_HIDDEN
Data Type: String
|
WORKFLOW_PARAMETER_NAME |
Name of the WorkflowParameter.
Available on: WORKFLOW_PARAMETER
Name: WORKFLOW_PARAMETER_NAME
Data Type: String
|
WORKFLOW_PARAMETER_PROMPTED |
Whether the WorkflowParameter should be prompted.
Available on: WORKFLOW_PARAMETER
Name: WORKFLOW_PARAMETER_PROMPTED
Data Type: String
|
WORKFLOW_PARAMETER_REQUIRED |
Whether the WorkflowParameter is required.
Available on: WORKFLOW_PARAMETER
Name: WORKFLOW_PARAMETER_REQUIRED
Data Type: String
|
Attribute Summary for Item Type - WORKSPACE |
Inherited attributes |
CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS |
JOINABLE |
Whether a workspace can be joined by submitting a request
Available on: WORKSPACE
Name: JOINABLE
Data Type: Boolean
|
JOINABLE_WORKSPACE_DESCRIPTION |
A joinable workspace's description. Will return an attribute if and only if the underlying object is a a joinable workspace.
Available on: WORKSPACE
Name: JOINABLE_WORKSPACE_DESCRIPTION
Data Type: String
|
TRASH_FOLDER |
The TrashFolder for a given Item.
Available on: DOCUMENT , LINK , FOLDER , WORKSPACE
Name: TRASH_FOLDER
Data Type: Item
|
UNDERLYING_WORKSPACE_ID |
A joinable workspace's underlying workspace's ID. Will return an attribute if and only if the object is a a joinable workspace.
Available on: WORKSPACE
Name: UNDERLYING_WORKSPACE_ID
Data Type: Long
|