/mfiles | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
mfiles_create_object | Create a new object |
mfiles_get_checkout_status | Get the checkout status of an object version |
mfiles_get_class | Get a single object class |
mfiles_get_object_comments | Get the comments of an object |
mfiles_get_object_deleted_status | Get the deleted status of an object |
mfiles_get_object_history | Get the version history of an object |
mfiles_get_object_info | Get the latest version info of an object |
mfiles_get_object_properties | Get the properties of an object version |
mfiles_get_object_version | Get a specific version of an object |
mfiles_get_object_workflow_state | Get the workflow state of an object |
mfiles_get_property_definition | Get a single property definition |
mfiles_get_recently_accessed | List objects recently accessed by the current user |
mfiles_get_session_info | Get the current session info |
mfiles_list_classes | List the object classes of the vault |
mfiles_list_favorites | List the current user’s favorite objects |
mfiles_list_object_files | List the files of an object version |
mfiles_list_object_types | List the object types of the vault |
mfiles_list_property_definitions | List the property definitions of the vault |
mfiles_list_root_views | List the root views of the vault |
mfiles_list_value_list_items | List the items of a value list |
mfiles_list_value_lists | List the value lists of the vault |
mfiles_list_view_items | List the items inside a view |
mfiles_list_workflows | List the workflows of the vault |
mfiles_search_objects | Search objects in the vault |
mfiles_set_checkout_status | Check an object out or in |
mfiles_set_object_deleted_status | Delete or undelete an object |
mfiles_undo_checkout | Undo a checkout (discard checked-out changes) |
mfiles_update_object_properties | Update a subset of object properties |
mfiles_create_object
Create a new object Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). Use the list_object_types tool to discover type IDs. |
PropertyValues | object[] | Yes | — | The properties of the new object. Minimum: [{PropertyDef: 100, TypedValue: {DataType: 9, Lookup: {Item: <classId>, Version: -1}}}, {PropertyDef: 0, TypedValue: {DataType: 1, Value: ‘<title>’}}]. |
mfiles_get_checkout_status
Get the checkout status of an object version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
objectVersion | string | Yes | — | Version number, or ‘latest’ for the newest version. |
mfiles_get_class
Get a single object class Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
classId | integer | Yes | — | Class ID. |
mfiles_get_object_comments
Get the comments of an object Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
objectVersion | string | Yes | — | Version number, or ‘latest’ for the newest version. |
mfiles_get_object_deleted_status
Get the deleted status of an object Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
mfiles_get_object_history
Get the version history of an object Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
mfiles_get_object_info
Get the latest version info of an object Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
mfiles_get_object_properties
Get the properties of an object version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
objectVersion | string | Yes | — | Version number, or ‘latest’ for the newest version. |
forDisplay | boolean | No | — | Set true to filter out built-in properties that are not typically shown to users. |
mfiles_get_object_version
Get a specific version of an object Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
objectVersion | string | Yes | — | Version number, or ‘latest’ for the newest version. |
mfiles_get_object_workflow_state
Get the workflow state of an object Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
objectVersion | string | Yes | — | Version number, or ‘latest’ for the newest version. |
mfiles_get_property_definition
Get a single property definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
propertyDefId | integer | Yes | — | Property definition ID. |
mfiles_get_recently_accessed
List objects recently accessed by the current usermfiles_get_session_info
Get the current session infomfiles_list_classes
List the object classes of the vaultmfiles_list_favorites
List the current user’s favorite objectsmfiles_list_object_files
List the files of an object version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
objectVersion | string | Yes | — | Version number, or ‘latest’ for the newest version. |
mfiles_list_object_types
List the object types of the vaultmfiles_list_property_definitions
List the property definitions of the vaultmfiles_list_root_views
List the root views of the vaultmfiles_list_value_list_items
List the items of a value list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
valueListId | integer | Yes | — | Value list ID. |
filter | string | No | — | Optional name filter; returns only items whose name matches the filter text. |
mfiles_list_value_lists
List the value lists of the vaultmfiles_list_view_items
List the items inside a view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
viewPath | string | Yes | — | View path segment, e.g. ‘v15’ for view ID 15. |
mfiles_list_workflows
List the workflows of the vaultmfiles_search_objects
Search objects in the vault Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | Full-text quick search string. Matches object metadata and indexed file contents. Omit to list objects without a text filter. |
objectTypeId | integer | No | — | Restrict results to a single object type by its ID (e.g. 0 = Document). Use the list_object_types tool to discover type IDs. |
deletedFilter | string | No | — | Deleted-items filter. Set to ‘include’ to also return deleted objects; omit to exclude them (default). |
limit | integer | No | — | Maximum number of results to return. |
mfiles_set_checkout_status
Check an object out or in Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
objectVersion | string | Yes | — | Version number, or ‘latest’ for the newest version. |
Value | integer | Yes | — | Checkout status: 0 = checked in (check in), 1 = checked out to me (check out), 2 = checked out. |
mfiles_set_object_deleted_status
Delete or undelete an object Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
Value | boolean | Yes | — | true = mark deleted, false = undelete. |
mfiles_undo_checkout
Undo a checkout (discard checked-out changes) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
objectVersion | string | Yes | — | Version number, or ‘latest’ for the newest version. |
mfiles_update_object_properties
Update a subset of object properties Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | integer | Yes | — | Object type ID (e.g. 0 = Document). |
objectId | integer | Yes | — | Object ID within the type. |
objectVersion | string | Yes | — | Version number, or ‘latest’ for the newest version. |
body | object[] | Yes | — | Array of property values to set on the object. |

