Skip to main content
Server path: /mfiles | Type: Application | PCID required: Yes

Tools

ToolDescription
mfiles_create_objectCreate a new object
mfiles_get_checkout_statusGet the checkout status of an object version
mfiles_get_classGet a single object class
mfiles_get_object_commentsGet the comments of an object
mfiles_get_object_deleted_statusGet the deleted status of an object
mfiles_get_object_historyGet the version history of an object
mfiles_get_object_infoGet the latest version info of an object
mfiles_get_object_propertiesGet the properties of an object version
mfiles_get_object_versionGet a specific version of an object
mfiles_get_object_workflow_stateGet the workflow state of an object
mfiles_get_property_definitionGet a single property definition
mfiles_get_recently_accessedList objects recently accessed by the current user
mfiles_get_session_infoGet the current session info
mfiles_list_classesList the object classes of the vault
mfiles_list_favoritesList the current user’s favorite objects
mfiles_list_object_filesList the files of an object version
mfiles_list_object_typesList the object types of the vault
mfiles_list_property_definitionsList the property definitions of the vault
mfiles_list_root_viewsList the root views of the vault
mfiles_list_value_list_itemsList the items of a value list
mfiles_list_value_listsList the value lists of the vault
mfiles_list_view_itemsList the items inside a view
mfiles_list_workflowsList the workflows of the vault
mfiles_search_objectsSearch objects in the vault
mfiles_set_checkout_statusCheck an object out or in
mfiles_set_object_deleted_statusDelete or undelete an object
mfiles_undo_checkoutUndo a checkout (discard checked-out changes)
mfiles_update_object_propertiesUpdate a subset of object properties

mfiles_create_object

Create a new object Parameters:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document). Use the list_object_types tool to discover type IDs.
PropertyValuesobject[]YesThe 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:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.
objectVersionstringYesVersion number, or ‘latest’ for the newest version.

mfiles_get_class

Get a single object class Parameters:
ParameterTypeRequiredDefaultDescription
classIdintegerYesClass ID.

mfiles_get_object_comments

Get the comments of an object Parameters:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.
objectVersionstringYesVersion number, or ‘latest’ for the newest version.

mfiles_get_object_deleted_status

Get the deleted status of an object Parameters:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.

mfiles_get_object_history

Get the version history of an object Parameters:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.

mfiles_get_object_info

Get the latest version info of an object Parameters:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.

mfiles_get_object_properties

Get the properties of an object version Parameters:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.
objectVersionstringYesVersion number, or ‘latest’ for the newest version.
forDisplaybooleanNoSet 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:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.
objectVersionstringYesVersion number, or ‘latest’ for the newest version.

mfiles_get_object_workflow_state

Get the workflow state of an object Parameters:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.
objectVersionstringYesVersion number, or ‘latest’ for the newest version.

mfiles_get_property_definition

Get a single property definition Parameters:
ParameterTypeRequiredDefaultDescription
propertyDefIdintegerYesProperty definition ID.

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 Parameters:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.
objectVersionstringYesVersion number, or ‘latest’ for the newest 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 Parameters:
ParameterTypeRequiredDefaultDescription
valueListIdintegerYesValue list ID.
filterstringNoOptional name filter; returns only items whose name matches the filter text.

mfiles_list_value_lists

List the value lists of the vault

mfiles_list_view_items

List the items inside a view Parameters:
ParameterTypeRequiredDefaultDescription
viewPathstringYesView path segment, e.g. ‘v15’ for view ID 15.

mfiles_list_workflows

List the workflows of the vault

mfiles_search_objects

Search objects in the vault Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoFull-text quick search string. Matches object metadata and indexed file contents. Omit to list objects without a text filter.
objectTypeIdintegerNoRestrict results to a single object type by its ID (e.g. 0 = Document). Use the list_object_types tool to discover type IDs.
deletedFilterstringNoDeleted-items filter. Set to ‘include’ to also return deleted objects; omit to exclude them (default).
limitintegerNoMaximum number of results to return.

mfiles_set_checkout_status

Check an object out or in Parameters:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.
objectVersionstringYesVersion number, or ‘latest’ for the newest version.
ValueintegerYesCheckout 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:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.
ValuebooleanYestrue = mark deleted, false = undelete.

mfiles_undo_checkout

Undo a checkout (discard checked-out changes) Parameters:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.
objectVersionstringYesVersion number, or ‘latest’ for the newest version.

mfiles_update_object_properties

Update a subset of object properties Parameters:
ParameterTypeRequiredDefaultDescription
typeintegerYesObject type ID (e.g. 0 = Document).
objectIdintegerYesObject ID within the type.
objectVersionstringYesVersion number, or ‘latest’ for the newest version.
bodyobject[]YesArray of property values to set on the object.