iManage Work

iManage Work connector enables users to automate repetitive tasks and approval processes while they keep all their files secure in the iManage Work environment.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	iManage LLC
URL	https://docs.imanage.com
Email	cloudsupport@imanage.com

Connector Metadata
Publisher	iManage LLC
Website	https://imanage.com
Privacy policy	https://imanage.com/about/privacy-notice/
Categories	Content and Files;Productivity

iManage Work

iManage is the industry-leading provider of document and email management solutions for knowledge workers. iManage platform organizes and secures the information in documents and emails, so professionals can search for what they need, act on it, and collaborate more effectively. The iManage Work connector enables users to automate repetitive tasks and approval processes while they keep all their files secure in the iManage Work environment.

Prerequisites

The connector is available for all iManage Work customers connecting to cloudimanage.com. First, the Power Automate application will need to be enabled by an administrator of your iManage Work environment. Once enabled, you will need the specific URL for your environment and a login account and password under which the connector can execute actions. For more information, see the FAQ.

How to get credentials

If you are an existing iManage Work user, provide your iManage Work credentials to login. Otherwise, contact your System Administrator for assistance.

Get started with iManage Work connector

Perform the following steps to get started with the iManage Work connector:

• Create an Instant cloud flow and select + New step.
• Search for iManage Work to see all the available iManage Work actions.
• Select the desired iManage Work action.
• If you are not already signed in to iManage Work, you are prompted for signing in.
  • Select Sign in.
  • Enter the URL you use to connect to iManage Work, for example cloudimanage.com.
  • Enter your iManage Work User ID.
  • Enter the password for the chosen account and select Login. From this point on, all flows that use iManage Work actions connect using these user credentials. A different iManage user account can be used by adding a new connection under My Connections and switching to it.

Known issues and limitations

For a list of known issues and limitations, visit https://docs.imanage.com/power-automate/index.html.

Common errors and remedies

For a list of common errors and remedies, visit https://docs.imanage.com/power-automate/index.html.

FAQ

For a list of Frequently Asked Questions, visit https://docs.imanage.com/power-automate/index.html.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add document history entry	Adds an entry as an event in the document's history.
Add document reference	Adds document reference or document shortcut in another folder.
Copy document	Copies a document to the specified folder.
Copy permissions	Copies the access permissions, and optionally the default security, from one iManage Work object to another. 'Copy Type' gives you options for how to handle the combination of source and destination permissions. 'Overwrite' updates the target object's users, groups, and permission levels to exactly match the source object's. 'Merge' keeps all the users and groups on the destination object and combines them with the source, but in case of a conflict of permission level on an individual or group: 'Merge (Pessimistic)' takes the lower permission, while 'Merge (Optimistic)' takes the higher permission for the conflicting user or group.
Create workspace	Creates a new workspace based on the selected template. A workspace template is a predefined workspace whose structure is copied to the new workspace. Restrictions on the workspace template are automatically enforced when creating the new workspace.
Delete document reference	Deletes document reference from the specified folder.
Download document	Downloads a version of a specific document, based on the document ID. If latest is true, the latest version of this document is downloaded. The download is a stream and is not saved locally.
Edit name-value pairs	Creates, updates or deletes name-value pair properties of a document, folder or workspace. To delete a name-value pair, set the value of the key to an empty string wrapped in single or double quotes.
Get classes	Gets the list of document classes available in a library that match the specified criteria.
Get core extended metadata properties of a document	Gets core extended metadata properties of a document.
Get document profile	Gets the document properties associated with a specific document ID.
Get document versions	Gets profiles for all versions the current user has access to for a specified document.
Get group members	Get details of users that belong to the specified group and match the specified criteria.
Get libraries	Gets a list of libraries to which the user has access.
Get permissions	Gets user or group access permission properties of a document, folder or workspace. Response properties can vary with user or group permissions.
Get subclasses	Gets all the library subclasses that match the specified criteria.
Get trustees	Gets a list of trustees with certain permissions for a document, folder or workspace. A trustee can be a user or group.
Get user details	Gets information about a user from the specified library.
Get workspace profile	Gets the workspace profile, and optionally the list of allowed operations for the workspace.
Get workspace templates	Gets list of templates available in a library. A workspace template is a predefined workspace whose structure is copied for the new workspace.
Move document	Moves a document to the specified folder.
Promote document version	Promotes an existing version of a document to the latest version. A new version is created from a specified Journal ID or Version and then promoted to latest. You must specify either Journal ID or Version, but not both.
Search core extended metadata taxonomy node values	Searches for core extended metadata taxonomy node values matching the specified search criteria.
Search for folders	Search for folders.
Search for workspaces	Search for workspaces.
Search users	Searches for iManage Work users matching the specified search criteria.
Set core extended metadata properties on a document	Sets core extended metadata properties on a document.
Update current or create new document version	Updates the specified version of a document, or creates a new version. This action can update the profile and content of a document. If 'Update Current Version' option is specified, the document is replaced with a new one and the profile of the previous document is maintained. If 'Create New Version' is specified, a new version of the document is created that inherits the profile of the folder. Upon successful execution of the operation, the document profile is returned.
Update default security	Updates the default security of a document, folder or workspace.
Update document profile	Performs updates on the document profile. A document must not be in use while updating its profile and the profile of a document that is checked out cannot be updated. Returns an updated document profile after the operation.
Update permissions	Updates permissions of an object.
Update workflow state	Updates the state of a workflow run. This action can only be used in a workflow that has been created to start with a trigger provided by iManage.
Update workspace	Updates information of the specified workspace. To delete the existing value of a string field, set the value of the field to an empty string wrapped in single or double quotes.
Upload document	Uploads a file as a new document to the specified folder.

Add document history entry

Operation ID:

AddDocumentHistoryEntry

Adds an entry as an event in the document's history.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.
Activity	activity_code	True	integer	Specifies the type of activity performed on the document.
Comments	comments		string	Specifies any additional information about the activity.
Duration	duration		integer	Specifies the number of seconds the user spent working on the document.

Returns

Name	Path	Type	Description
data	data	object

Add document reference

Operation ID:

AddDocumentReference

Adds document reference or document shortcut in another folder.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.
Folder ID	folderId	True	string	Specifies the ID of the folder. For example, 'ACTIVE_US!773'.

Returns

Name	Path	Type	Description
Document reference ID	data.id	string	Indicates document reference and document_shortcut.
Wstype	data.wstype	string	Indicates the iManage Work type of the object. Possible values are 'document', 'document_shortcut', 'email'.

Copy document

Operation ID:

CopyDocument

Copies a document to the specified folder.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.
Destination Folder ID	folderId	True	string	Specifies the destination folder ID to which the document is to be copied. For example, 'ACTIVE_US!987'.

Returns

Name	Path	Type	Description
Document Access	data.access	string	Indicates the access level permission set for a document or container. The access level is set by the author or a user with full access to the item. Possible values are 'no_access', 'read', 'read_write', 'full_access'.
Alias	data.alias	string	Indicates the alias of this document.
Author	data.author	string	Indicates the ID of the user that created the document. For example, 'JSMITH'.
Author Description	data.author_description	string	Indicates additional information about the document's author.
Cc	data.cc	string	Indicates recipients to whom the email is carbon copied. Only applicable to emails.
Document Class	data.class	string	Indicates the document's class.
Document Class Description	data.class_description	string	Indicates additional information about the document class.
Content Type	data.content_type	string	Indicates the document content type.
Document Creation Date	data.create_date	string	Indicates the date and time (in ISO 8601 format) the document was imported into the iManage Work system. This date can be different than 'file_create_date'.
Database	data.database	string	Indicates the library where the document is stored.
Document Default Security	data.default_security	string	Indicates the default security access level. Possible values are 'inherit', 'private', 'view', 'public'.
Document Number	data.document_number	integer	Indicates the document number of a document.
Document URL	data.document_url	string	Indicates the sharable link for the document.
Document Edit Date	data.edit_date	string	Indicates the date and time (in ISO 8601 format) of the most recent change to the document.
Profile Edit Date	data.edit_profile_date	string	Indicates the date and time (in ISO 8601 format) of the most recent change to the document profile.
Document Extension	data.extension	string	Indicates the file name extension, also called the application extension, of the document.
File Creation Date	data.file_create_date	string	Indicates the date and time (in ISO 8601 format) the file was created. The file may have been created outside of the iManage Work system. This date can be different than 'create_date'.
File Editing Date	data.file_edit_date	string	Indicates the date and time (in ISO 8601 format) of the most recent change to the file. The file may have been changed before being uploaded into the iManage Work system.
From	data.from	string	Indicates the sender of the email. Only applicable to emails.
Full File Name	data.full_file_name	string	Indicates the full file name of the document. Includes the file name extension.
Has Attachment	data.has_attachment	boolean	Indicates if email has attachments. Only applicable to emails.
Basic Document Properties	data.basic_properties	string	Indicates an embeddable '' element that contains basic document properties.
Document ID	data.id	string	Indicates the ID of the document. For example, 'ACTIVE_US!453.1'.
Is Indexable	data.indexable	boolean	Indicates if the document is indexed by the system.
Is Checked Out	data.is_checked_out	boolean	Indicates if the document is checked out.
Is Declared	data.is_declared	boolean	Indicates if the document is declared as a record. A document that is declared as a record can not be edited or deleted, except by an iManage Work system administrator.
Is External	data.is_external	boolean	Indicates if the document is shared with external users.
Is External As Normal	data.is_external_as_normal	boolean	Indicates if the document is external as normal.
Is HIPAA	data.is_hipaa	boolean	Indicates if the document is encrypted.
Is In-use	data.is_in_use	boolean	Indicates if the document is in use.
Document Link	data.iwl	string	Indicates the iManage Work Link (iWL) for the document. The iWL is used to open the document in Protected View Mode by the user who has 'read_write' or 'full_access'.
Last User	data.last_user	string	Indicates the ID of the user that edited the document most recently. For example, 'JSMITH'.
Last User Description	data.last_user_description	string	Indicates additional information about the last user that edited the document most recently.
Document Name	data.name	string	Indicates the file name of the document.
Operator	data.operator	string	Indicates the ID of the user that has the document checked out or is currently editing its profile. For example, 'JSMITH'.
Operator Description	data.operator_description	string	Indicates additional information about the operator.
Received Date	data.received_date	string	Indicates the date and time (in ISO 8601 format) the email was received. Only applicable to emails.
Retain Days	data.retain_days	integer	Indicates the number of days before the document is eligible for archiving. Only applicable to inactive documents.
Sent Date	data.sent_date	string	Indicates the date and time (in ISO 8601 format) the email was sent. Only applicable to emails.
Document Size	data.size	integer	Indicates the size of the document in bytes.
Subclass	data.subclass	string	Indicates the subclass of the document.
Subclass Description	data.subclass_description	string	Indicates additional information about the document's subclass.
To	data.to	string	Indicates the recipient of the email. Only applicable to emails.
Type	data.type	string	Indicates the document type. For example, WORD for Microsoft Word. For a current list of types, contact your iManage Work system administrator.
Type Description	data.type_description	string	Indicates additional information about the document's type.
Document Version	data.version	integer	Indicates the version number of the document.
Workspace ID	data.workspace_id	string	Indicates the ID of the document's workspace. For example, 'ACTIVE_US!427'.
Workspace Name	data.workspace_name	string	Indicates the name of the document's workspace.
Wstype	data.wstype	string	Indicates the iManage Work type of the object. Possible values are 'document', 'folder', 'workspace', 'email', 'document_shortcut', 'folder_shortcut', 'workspace_shortcut', 'user'.
Custom13	data.custom13	string	Indicates value of custom13.
Custom14	data.custom14	string	Indicates value of custom14.
Custom15	data.custom15	string	Indicates value of custom15.
Custom16	data.custom16	string	Indicates value of custom16.
Custom21	data.custom21	string	Indicates value of the custom21 property in ISO 8601 datetime format.
Custom22	data.custom22	string	Indicates value of the custom22 property in ISO 8601 datetime format.

Copy permissions

Operation ID:

CopyPermissions

Copies the access permissions, and optionally the default security, from one iManage Work object to another. 'Copy Type' gives you options for how to handle the combination of source and destination permissions. 'Overwrite' updates the target object's users, groups, and permission levels to exactly match the source object's. 'Merge' keeps all the users and groups on the destination object and combines them with the source, but in case of a conflict of permission level on an individual or group: 'Merge (Pessimistic)' takes the lower permission, while 'Merge (Optimistic)' takes the higher permission for the conflicting user or group.

Parameters

Name	Key	Required	Type	Description
Source Object Type	sourceObjectType	True	string	Specifies the type of the source object.
Source Object ID	sourceObjectId	True	string	Specifies the ID of the object from which the permissions are copied. An example of a document ID is 'ACTIVE_US!453.1'. An example of a folder or workspace ID is 'ACTIVE_US!123'.
Target Object Type	targetObjectType	True	string	Specifies the type of the target object.
Target Object ID	targetObjectId	True	string	Specifies the ID of the object to which the permissions are copied. An example of a document ID is 'ACTIVE_US!453.1'. An example of a folder or workspace ID is 'ACTIVE_US!123'.
Copy Type	copyType	True	string	Specifies to merge the source object permissions with target object permissions or to overwrite target object permissions with source permissions. For details, see the action description.
Copy Default Security	copyDefaultSecurity	True	boolean	Specifies to copy the default security of the source object to the target object. If the default security of the source object is 'inherit', the inherited default security is copied from the source to the target object.

Returns

Body

UpdatePermissionsResponse

Create workspace

Operation ID:

CreateWorkspace

Creates a new workspace based on the selected template. A workspace template is a predefined workspace whose structure is copied to the new workspace. Restrictions on the workspace template are automatically enforced when creating the new workspace.

Parameters

Name	Key	Required	Type	Description
Library ID	libraryId	True	string	Specifies the library ID of the target workspace.
Template	templateId	True	string	Specifies the workspace template to use for creating the workspace and its children.
Name	name	True	string	Specifies the name of the workspace.
Create Children	createChildren	True	string	Specifies to create all folders (optional and required) or only the required folders.
Workspace Owner	owner		string	Specifies the owner of the workspace. You must be an iManage Work system administrator to set the owner of a workspace.
Default Security	default_security		string	Specifies the default access level. If it is not specified, the default access level of the selected template is used.
Description	description		string	Specifies additional information about the workspace.
Custom1	custom1		string	Specifies the value of custom1 to associate with the newly created workspace. This value overrides the custom1 value of the selected template workspace, if present. If the child folders have a custom1 value set, the custom1 value of those child folders is not overwritten.
Custom2	custom2		string	Specifies the value of custom2 to associate with the newly created workspace. To specify a value for custom2, you must also specify a value for custom1 in the same request, which is due to their parent-child relationship. This value overrides the custom2 value of the selected template workspace, if present. If the child folders have a custom2 value set, the custom2 value of those child folders is not overwritten.
Custom3	custom3		string	Specifies the value of custom3.
Custom4	custom4		string	Specifies the value of custom4.
Custom5	custom5		string	Specifies the value of custom5.
Custom6	custom6		string	Specifies the value of custom6.
Custom7	custom7		string	Specifies the value of custom7.
Custom8	custom8		string	Specifies the value of custom8.
Custom9	custom9		string	Specifies the value of custom9.
Custom10	custom10		string	Specifies the value of custom10.
Custom11	custom11		string	Specifies the value of custom11.
Custom12	custom12		string	Specifies the value of custom12.
Custom13	custom13		string	Specifies the value of custom13.
Custom14	custom14		string	Specifies the value of custom14.
Custom15	custom15		string	Specifies the value of custom15.
Custom16	custom16		string	Specifies the value of custom16.
Custom17	custom17		double	Specifies the value of custom17.
Custom18	custom18		double	Specifies the value of custom18.
Custom19	custom19		double	Specifies the value of custom19.
Custom20	custom20		double	Specifies the value of custom20.
Custom21	custom21		string	Specifies the value of custom21 in ISO 8601 datetime format.
Custom22	custom22		string	Specifies the value of custom22 in ISO 8601 datetime format.
Custom23	custom23		string	Specifies the value of custom23 in ISO 8601 datetime format.
Custom24	custom24		string	Specifies the value of custom24 in ISO 8601 datetime format.
Custom25	custom25		boolean	Specifies the value of custom25.
Custom26	custom26		boolean	Specifies the value of custom26.
Custom27	custom27		boolean	Specifies the value of custom27.
Custom28	custom28		boolean	Specifies the value of custom28.
Custom29	custom29		string	Specifies the value of custom29.
Custom30	custom30		string	Specifies the value of custom30. To specify a value for custom30, you must also specify a value for custom29 in the same request, which is due to their parent-child relationship.
Is External As Normal	is_external_as_normal		boolean	Specifies the workspace can be treated as a public workspace. If set to 'true' and 'default_security' is not 'private', sets 'is_external' to 'true'.
Project Custom1	project_custom1		string	Specifies additional information about the workspace. This field is different than the metadata custom field associated with content items, such as documents, workspaces or folders. This is descriptive text that does not have to be formatted, and is not validated.
Project Custom2	project_custom2		string	Specifies additional information about the workspace. This field is different than the metadata custom field associated with content items, such as documents, workspaces or folders. This is descriptive text that does not have to be formatted, and is not validated.
Project Custom3	project_custom3		string	Specifies additional information about the workspace. This field is different than the metadata custom field associated with content items, such as documents, workspaces or folders. This is descriptive text that does not have to be formatted, and is not validated.
Workspace Subclass	subclass		string	Specifies the subclass of the workspace based on the subclass of the document it contains.

Delete document reference

Operation ID:

DeleteDocumentReference

Deletes document reference from the specified folder.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.
Folder ID	folderId	True	string	Specifies the ID of the folder. For example, 'ACTIVE_US!773'.

Returns

response

object

Download document

Operation ID:

DownloadDocument

Downloads a version of a specific document, based on the document ID. If latest is true, the latest version of this document is downloaded. The download is a stream and is not saved locally.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_USE!453.1'.
Get Latest Version	latest		boolean	Specifies to download the latest version of the document.

Returns

Indicates the contents of the file.

File Content

binary

Edit name-value pairs

Operation ID:

EditNVP

Creates, updates or deletes name-value pair properties of a document, folder or workspace. To delete a name-value pair, set the value of the key to an empty string wrapped in single or double quotes.

Parameters

Name	Key	Required	Type	Description
Object Type	objectType	True	string	Specifies the type of object. Possible values are 'document', 'folder', 'workspace'.
Object ID	objectId	True	string	Specifies the ID of the document, folder or workspace. An example of a document ID is 'ACTIVE_US!453.1'. An example of a folder or workspace ID is 'ACTIVE_US!123'.
Name-value Pairs	nameValuePairs		object	Specifies the free-form name and value pairs for this document.

Get classes

Operation ID:

GetClasses

Gets the list of document classes available in a library that match the specified criteria.

Parameters

Name	Key	Required	Type	Description
Library ID	libraryId	True	string	Specifies the library ID of the target class.
Class ID	alias		string	Specifies the ID of a class or classes to search for. Can be a comma-separated list. This search is not case-sensitive. The wildcard character (*) and partial matches are supported.
Default Security	default_security		string	Specifies the default security access level.
Description	description		string	Specifies the text to match in the description field. This search is not case-sensitive. The wildcard character (*) is supported. Partial matches are not supported.
Echo	echo		boolean	Specifies if documents of this class can echo documents.
HIPAA	hipaa		boolean	Specifies if documents of this class use HIPAA compliant encryption.
Indexable	indexable		boolean	Specifies if documents of this class are indexed by the system's full-text indexer.
Query	query		string	Specifies the text to match with the ID or description fields. This search is not case-sensitive. The wildcard character (*) and partial matches are supported.
Subclass Required	subclass_required		boolean	Specifies if the class has a required subclass.

Returns

Name	Path	Type	Description
Top Matching Class ID	data.topMatchingId	string	Indicates the ID of the top matching class. For example, 'PETITION'.
Top Matching Class Description	data.topMatchingDescription	string	Indicates the description of the top matching class.
results	data.results	array of object	Indicates the list of classes available in a library that match the specified criteria.
Description	data.results.description	string	Indicates additional information about the class.
Is HIPAA	data.results.hipaa	boolean	Indicates if the document is encrypted.
ID	data.results.id	string	Indicates the ID of the class. For example, 'PETITION'.
Is Indexable	data.results.indexable	boolean	Indicates if the document is indexed by the system.
Default Security	data.results.default_security	string	Indicates the default security access level. Possible values are 'public', 'view', 'private'.
Retain	data.results.retain	integer	Indicates the number of days before marking inactive documents of this class as expired.
Required Fields	data.results.required_fields	array of string	Indicates the mandatory custom properties to be entered when creating or updating a document of this class.
Is Shadowed	data.results.shadow	boolean	Indicates if a document of this class is shadowed (retained) on a user's local computer after checking it in.
Is Subclass Required	data.results.subclass_required	boolean	Indicates if a subclass is required for this class.

Get core extended metadata properties of a document

Operation ID:

GetCoreEMPropertiesForDocument

Gets core extended metadata properties of a document.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.
Latest	latest		boolean	Specifies to get the latest version of the document.

Get document profile

Operation ID:

GetDocumentProfile

Gets the document properties associated with a specific document ID.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.
Get Latest Version	latest		boolean	Specifies to get the latest version of the document.

Get document versions

Operation ID:

GetDocumentVersions

Gets profiles for all versions the current user has access to for a specified document.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.

Returns

Name	Path	Type	Description
Document Profiles	data	array of MinimalDocumentProfileInArray

Get group members

Operation ID:

GetGroupMembers

Get details of users that belong to the specified group and match the specified criteria.

Parameters

Name	Key	Required	Type	Description
Library ID	libraryId	True	string	Specifies the library ID of the target group.
Group ID	groupId	True	string	Specifies the ID of the group. For example, 'MARKETING'.
Logon Status	logon_status		string	Specifies a filter for users based on the current 'allow_logon' property value for each user.
Limit	limit		integer	Specifies the maximum number of members to return regardless of the total number of members in the group.
Preferred Library	preferred_library		string	Specifies that only users whose preferred library matches the provided value be returned.
Location	location		string	Specifies the location to use to find users based on their geographic location. This search is not case-sensitive. The wildcard character (*) is not supported.

Returns

Name	Path	Type	Description
data	data	array of UserProfileInArray	Indicates the list of users that belong to the specified group and match the specified criteria.

Get libraries

Operation ID:

GetLibraries

Gets a list of libraries to which the user has access.

Returns

Name	Path	Type	Description
data	data	array of object	Indicates the list of libraries to which the user has access.
ID	data.id	string	Indicates the name of the library.
Name	data.display_name	string	Indicates the display name of the library.
Type	data.type	string	Indicates the type of the library. Possible values are 'worksite' or 'linksite'.
Is Hidden	data.is_hidden	boolean	Indicates if the library is hidden.

Get permissions

Operation ID:

GetPermissions

Gets user or group access permission properties of a document, folder or workspace. Response properties can vary with user or group permissions.

Parameters

Name	Key	Required	Type	Description
Object Type	objectType	True	string	Specifies the type of object.
Object ID	objectId	True	string	Specifies the ID of the document, folder or workspace. An example of a document ID is 'ACTIVE_US!453.1'. An example of a folder or workspace ID is 'ACTIVE_US!123'.

Returns

Name	Path	Type	Description
Default Security	data.default_security	string	Indicates the default security of the object. Possible values are 'inherit', 'public', 'view' or 'private'.
Inherited Default Security	data.inherited_default_security	string	Indicates the inherited default security of a folder when the default security is set to 'inherit'. Possible values are 'public', 'view' or 'private'.
Access Permissions	data.acl	AccessPermissions	Indicates a collection of access permissions for one or more users and/or groups.
All User IDs	data.all_user_ids	string	Indicates a list of all user IDs, concatenated as a string and separated by semicolons.
All Group IDs	data.all_group_ids	string	Indicates a list of all group IDs, concatenated as a string and separated by semicolons.

Get subclasses

Operation ID:

GetSubclasses

Gets all the library subclasses that match the specified criteria.

Parameters

Name	Key	Required	Type	Description
Library ID	libraryId	True	string	Specifies the library ID of the target subclass.
Class ID	classId	True	string	Specifies the ID of the Class that is the parent of this subclass. For example, 'PETITION'.
Subclass ID	alias		string	Specifies the ID of subclasses to search for. Can be a comma-separated list. The wildcard character (*) is supported. Partial matches are supported when the wildcard character is used.
Default Security	default_security		string	Specifies the default security access level.
Description	description		string	Specifies the text to match in the description field. The wildcard character (*) is supported. Partial matches are supported when the wildcard character is used.
Echo	echo		boolean	Specifies if the subclasses can be echoed to a user's local hard drive. This is to facilitate working offline.
HIPAA	hipaa		boolean	Specifies if HIPAA compliant subclasses are to be returned.
Query	query		string	Specifies the text to match with the Subclass ID or description fields. The wildcard character (*) is supported. Partial matches are supported.

Returns

Name	Path	Type	Description
Top Matching Subclass ID	data.topMatchingId	string	Indicates ID of the top matching subclass.
Top Matching Subclass Description	data.topMatchingDescription	string	Indicates description of the top matching subclass.
results	data.results	array of object
Default Security	data.results.default_security	string	Indicates default security access level. Possible values are 'public', 'view', 'private'.
Description	data.results.description	string	Indicates additional information about the subclass. Maximum length is 255 characters.
Is HIPAA	data.results.hipaa	boolean	Indicates if the document is encrypted.
ID	data.results.id	string	Indicates the ID of a subclass used to create or modify the document profile information. For example, 'GUARDIANSHIP'.
Parent ID	data.results.parent.id	string	Indicates the parent class ID of the subclass.
Required Fields	data.results.required_fields	array of string	Indicates the mandatory custom properties to be entered when creating or updating a document of this subclass.
Retain	data.results.retain	integer	Indicates the number of days before marking inactive documents of this subclass as expired.
Is Shadowed	data.results.shadow	boolean	Indicates if a document of this subclass is shadowed (retained) on a user's local computer after checking it in.

Get trustees

Operation ID:

GetTrustees

Gets a list of trustees with certain permissions for a document, folder or workspace. A trustee can be a user or group.

Parameters

Name	Key	Required	Type	Description
Object Type	objectType	True	string	Specifies the type of object.
Object ID	objectId	True	string	Specifies the ID of the document, folder or workspace. An example of a document ID is 'ACTIVE_US!453.1'. An example of a folder or workspace ID is 'ACTIVE_US!123'.

Returns

Name	Path	Type	Description
data	data	array of object	Indicates the list of trustees with certain permissions for a document, folder or workspace. A trustee can be a user or group.
Full Name	data.full_name	string	Indicates the full name of the trustee.
ID	data.id	string	Indicates the ID of the trustee. This can be a group ID or user ID. For example, 'JSMITH' or 'MARKETING'.
SSID	data.ssid	string	Indicates the unique, system-generated ID of the trustee.
Type	data.type	string	Indicates the type of entity returned. Possible values are 'user' or 'group'.

Get user details

Operation ID:

GetUserDetails

Gets information about a user from the specified library.

Parameters

Name	Key	Required	Type	Description
Library ID	libraryId	True	string	Specifies the library ID of the target user.
User ID	userId	True	string	Specifies the ID of the user for which to get detailed profile information. For example, 'JSMITH'.

Returns

Name	Path	Type	Description
data	data	UserProfile	Indicates information about a user.

Get workspace profile

Operation ID:

GetWorkspaceProfile

Gets the workspace profile, and optionally the list of allowed operations for the workspace.

Parameters

Name	Key	Required	Type	Description
Workspace ID	workspaceId	True	string	Specifies the ID of the workspace. For example, 'ACTIVE_US!427'.

Get workspace templates

Operation ID:

GetWorkspaceTemplates

Gets list of templates available in a library. A workspace template is a predefined workspace whose structure is copied for the new workspace.

Parameters

Name	Key	Required	Type	Description
Library ID	libraryId	True	string	Specifies the library ID of the target workspace.
Custom1	custom1		string	Specifies a value to match with custom1 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom2	custom2		string	Specifies a value to match with custom2 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom3	custom3		string	Specifies a value to match with custom3 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom4	custom4		string	Specifies a value to match with custom4 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom5	custom5		string	Specifies a value to match with custom5 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom6	custom6		string	Specifies a value to match with custom6 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom7	custom7		string	Specifies a value to match with custom7 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom8	custom8		string	Specifies a value to match with custom8 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom9	custom9		string	Specifies a value to match with custom9 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom10	custom10		string	Specifies a value to match with custom10 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom11	custom11		string	Specifies a value to match with custom11 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom12	custom12		string	Specifies a value to match with custom12 value associated with the workspace template. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom17	custom17		double	Specifies the value for custom17.
Custom18	custom18		double	Specifies the value for custom18.
Custom19	custom19		double	Specifies the value for custom19.
Custom20	custom20		double	Specifies the value for custom20.
Custom21	custom21		string	Specifies the value (in ISO 8601 datetime format) to search for in custom21 associated with the workspace template. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom22	custom22		string	Specifies the value (in ISO 8601 datetime format) to search for in custom22 associated with the workspace template. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom23	custom23		string	Specifies the value (in ISO 8601 datetime format) to search for in custom23 associated with the workspace template. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom24	custom24		string	Specifies the value (in ISO 8601 datetime format) to search for in custom24 associated with the workspace template. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom21 (Lower Limit)	custom21_from		string	Specifies the lower limit of custom21 (in ISO 8601 datetime format) to search. This property is not reserved by iManage Work and is not a validated value. It is intended to be customized for your company's requirements.
Custom21 (Upper Limit)	custom21_to		string	Specifies the upper limit of custom21 (in ISO 8601 datetime format) to search. This property is not reserved by iManage Work and is not a validated value. It is intended to be customized for your company's requirements.
Custom21 (Relative)	custom21_relative		string	Specifies a date range to search, relative to the current date. This parameter has a format of [begin]:[end][time units (d, m or y)]. For example, -15:1d specifies a date range from 15 days prior to the current date through one day after the current date (one day in the future).
Custom22 (Lower Limit)	custom22_from		string	Specifies the lower limit of custom22 (in ISO 8601 datetime format) to search. This property is not reserved by iManage Work and is not a validated value. It is intended to be customized for your company's requirements.
Custom22 (Upper Limit)	custom22_to		string	Specifies the upper limit of custom22 (in ISO 8601 datetime format) to search. This property is not reserved by iManage Work and is not a validated value. It is intended to be customized for your company's requirements.
Custom22 (Relative)	custom22_relative		string	Specifies a date range to search, relative to the current date. This parameter has a format of [begin]:[end][time units (d, m or y)]. For example, -15:1d specifies a date range from 15 days prior to the current date through one day after the current date (one day in the future).
Custom23 (Lower Limit)	custom23_from		string	Specifies the lower limit of custom23 (in ISO 8601 datetime format) to search. This property is not reserved by iManage Work and is not a validated value. It is intended to be customized for your company's requirements.
Custom23 (Upper Limit)	custom23_to		string	Specifies the upper limit of custom23 (in ISO 8601 datetime format) to search. This property is not reserved by iManage Work and is not a validated value. It is intended to be customized for your company's requirements.
Custom23 (Relative)	custom23_relative		string	Specifies a date range to search, relative to the current date. This parameter has a format of [begin]:[end][time units (d, m or y)]. For example, -15:1d specifies a date range from 15 days prior to the current date through one day after the current date (one day in the future).
Custom24 (Lower Limit)	custom24_from		string	Specifies the lower limit of custom24 (in ISO 8601 datetime format) to search. This property is not reserved by iManage Work and is not a validated value. It is intended to be customized for your company's requirements.
Custom24 (Upper Limit)	custom24_to		string	Specifies the upper limit of custom24 (in ISO 8601 datetime format) to search. This property is not reserved by iManage Work and is not a validated value. It is intended to be customized for your company's requirements.
Custom24 (Relative)	custom24_relative		string	Specifies a date range to search, relative to the current date. This parameter has a format of [begin]:[end][time units (d, m or y)]. For example, -15:1d specifies a date range from 15 days prior to the current date through one day after the current date (one day in the future).
Custom25	custom25		boolean	Specifies the custom25 value to search for.
Custom26	custom26		boolean	Specifies the custom26 value to search for.
Custom27	custom27		boolean	Specifies the custom27 value to search for.
Custom28	custom28		boolean	Specifies the custom28 value to search for.
Custom29	custom29		string	Specifies a value to match with custom29. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom30	custom30		string	Specifies a value to match with custom30. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.

Move document

Operation ID:

MoveDocument

Moves a document to the specified folder.

Parameters

Name	Key	Required	Type	Description
Parent Folder ID	folderId	True	string	Specifies the folder ID of the parent folder. For example, 'ACTIVE_US!987'.
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.
Destination Folder ID	destination_folder_id	True	string	Specifies the destination folder ID to which the document is to be moved. For example, 'ACTIVE_US!987'.
Apply Destination Profile	update_profile		boolean	Specifies if the document profile is to be updated with destination folder profile.
Apply Destination Security	update_security		boolean	Specifies if the document security is to be updated with destination folder security. This parameter is applicable only when Update Profile is set to true.
Timeline Comments	comments		string	Specifies additional information about the operation. These comments are visible in the timeline of the document.

Promote document version

Operation ID:

PromoteDocumentVersion

Promotes an existing version of a document to the latest version. A new version is created from a specified Journal ID or Version and then promoted to latest. You must specify either Journal ID or Version, but not both.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.
Version	version		integer	Specifies the version number to use as the basis for the new, promoted version.
Journal ID	journalId		string	Specifies the journal ID to use as the basis for the new, promoted version.
Comment	comment		string	Specifies additional information about the document.
Alias	alias		string	Specifies the alias of this document.
Author	author		string	Specifies the ID of the user that created the document. For example, 'JSMITH'.
Document Class	class		string	Specifies the document class.
Document Default Security	default_security		string	Specifies the default security access level.
Is Declared	is_declared		boolean	Specifies if the new version of the document is to be declared as a record. A document that is declared as a record can not be edited or deleted, except by an iManage Work system administrator.
Is HIPAA	is_hipaa		boolean	Specifies if the new version of the document is to be encrypted.
Document Name	name		string	Specifies the file name of the document.
Operator	operator		string	Specifies the ID of the user that has the document checked out or is currently editing the document's profile. For example, 'JSMITH'.
Retain Days	retain_days		integer	Specifies the number of days before the inactive document is eligible for archiving.
Subclass	subclass		string	Specifies the document's subclass.
Custom1	custom1		string	Specifies the value of custom1.
Custom2	custom2		string	Specifies the value of custom2. To specify a value for custom2, you must also specify a value for custom1 in the same request, which is due to their parent-child relationship.
Custom3	custom3		string	Specifies the value of custom3.
Custom4	custom4		string	Specifies the value of custom4.
Custom5	custom5		string	Specifies the value of custom5.
Custom6	custom6		string	Specifies the value of custom6.
Custom7	custom7		string	Specifies the value of custom7.
Custom8	custom8		string	Specifies the value of custom8.
Custom9	custom9		string	Specifies the value of custom9.
Custom10	custom10		string	Specifies the value of custom10.
Custom11	custom11		string	Specifies the value of custom11.
Custom12	custom12		string	Specifies the value of custom12.
Custom13	custom13		string	Specifies the value of custom13.
Custom14	custom14		string	Specifies the value of custom14.
Custom15	custom15		string	Specifies the value of custom15.
Custom16	custom16		string	Specifies the value of custom16.
Custom17	custom17		double	Specifies the value of custom17.
Custom18	custom18		double	Specifies the value of custom18.
Custom19	custom19		double	Specifies the value of custom19.
Custom20	custom20		double	Specifies the value of custom20.
Custom21	custom21		string	Specifies the value of the custom21 property in ISO 8601 datetime format.
Custom22	custom22		string	Specifies the value of the custom22 property in ISO 8601 datetime format.
Custom23	custom23		string	Specifies the value of the custom23 property in ISO 8601 datetime format.
Custom24	custom24		string	Specifies the value of the custom24 property in ISO 8601 datetime format.
Custom25	custom25		boolean	Specifies the value of custom25.
Custom26	custom26		boolean	Specifies the value of custom26.
Custom27	custom27		boolean	Specifies the value of custom27.
Custom28	custom28		boolean	Specifies the value of custom28.
Custom29	custom29		string	Specifies the value of custom29.
Custom30	custom30		string	Specifies the value of custom30. To specify a value for custom30, you must also specify a value for custom29 in the same request, which is due to their parent-child relationship.

Search core extended metadata taxonomy node values

Operation ID:

SearchCoreEMTaxonomyNodeValues

Searches for core extended metadata taxonomy node values matching the specified search criteria.

Parameters

Name	Key	Required	Type	Description
Library ID	libraryId	True	string	Specifies the ID of the library on which to perform the search.
Taxonomy Property	taxonomyProperty	True	string	Specifies the taxonomy property for which to search node values.
ID	id		string	Specifies the display identifier of the taxonomy node value. This search is not case-sensitive. Partial matches are not supported.
Query	query		string	Specifies a query for matching taxonomy node values using a wildcard (*) search, providing partial matches for the display identifier or description.
Node State	enabled_state		string	Specifies to return only taxonomy node values that are enabled or disabled or both.
Include Path	include_path		boolean	Specifies to return the full path to the matching node value. A path is an ordered list beginning with the top-level node in the taxonomy and then all nodes through to the matching node's immediate parent.
Ancestor Node SSID	children_of_ssid		string	Specifies the unique, system-generated ID of the ancestor taxonomy node to limit the search to.
Immediate Children Only	immediate_children_only		boolean	Specifies to limit the search results to direct descendants of the taxonomy node specified by 'Ancestor Node SSID'. Search can be limited to the root level of the taxonomy by specifying an empty string for 'Ancestor Node SSID' wrapped in single or double quotes.

Returns

Name	Path	Type	Description
SSID	data.topMatchingResult.created_by.ssid	string	Indicates the unique, system-generated ID for the user who created the top matching node value.
Create Date	data.topMatchingResult.create_date	string	Indicates the date and time (in ISO 8601 format) the top matching node value was created.
Description	data.topMatchingResult.description	string	Indicates the description of the top matching node value.
SSID	data.topMatchingResult.edited_by.ssid	string	Indicates the unique, system-generated ID for the user who last edited the top matching node value.
Edit Date	data.topMatchingResult.edit_date	string	Indicates the date and time (in ISO 8601 format) the top matching node value was last edited.
Is Enabled	data.topMatchingResult.enabled	boolean	Indicates if the top matching node value is enabled.
ID	data.topMatchingResult.id	string	Indicates the display identifier for the top matching node value.
SSID	data.topMatchingResult.parent.ssid	string	Indicates the unique, system-generated ID for the immediate parent node of the top matching node value.
SSID	data.topMatchingResult.ssid	string	Indicates the unique, system-generated ID for the top matching node value.
Path	data.topMatchingResult.path	array of object	Indicates the full path to the top matching node value. A path is an ordered list beginning with the top-level node in the taxonomy and then all nodes through to the matching node's immediate parent.
Each ID	data.topMatchingResult.path.id	string	Indicates the display identifier for a node value in the path of the top matching node.
Each SSID	data.topMatchingResult.path.ssid	string	Indicates the unique, system-generated ID for a node value in the path of the top matching node.
Core Extended Metadata Taxonomy Search Results	data.results	array of TaxonomyNodeValue	Indicates one or more core extended metadata taxonomy node values matching the search.
All Taxonomy Node SSIDs	data.all_taxonomy_ssids	string	Indicates a list of all taxonomy node SSIDs, concatenated as a string and separated by semicolons.

Search for folders

Operation ID:

SearchFolders

Search for folders.

Parameters

Name	Key	Required	Type	Description
Library ID	libraryId	True	string	Specifies the library ID of the target folder.
Container ID	container_id		string	Specifies the ID of the workspace or folder from which to return folders. For example, 'ACTIVE_US!987'. If this parameter is provided, it returns folders only from the specified workspace or folder.
Folder Description	description		string	Specifies a value to be found in the description property of the folder. This search is not case-sensitive. Partial matches are supported.
Folder Email Address	email		string	Specifies the email address to match with the folder email address. For example, 'email1234@ajubalaw.com'.
Folder Name	name		string	Specifies a value to be found in the name property of the folder. This search is not case-sensitive. Partial matches are supported.
Folder Owner	owner		string	Specifies the string to match with the owner associated with the folder. This search is not case-sensitive. Partial matches are supported.
Workspace Name	workspace_name		string	Specifies the name of the parent workspace to which the folder belongs. This search is not case-sensitive. Partial matches are supported.

Search for workspaces

Operation ID:

SearchWorkspaces

Search for workspaces.

Parameters

Name	Key	Required	Type	Description
Library ID	libraryId	True	string	Specifies the library ID of the target workspace.
Title	name		string	Specifies the string to be searched for in the name property of the workspace. This search is not case-sensitive.
Owner	owner		string	Specifies the string to match with the owner associated with the workspace. This search is not case-sensitive.
Keyword	anywhere		string	Specifies the text to be searched for anywhere in the workspace profile. This search is not case-sensitive.
Description	description		string	Specifies the text to be searched for in the description property of the workspace. This search is not case-sensitive.
Subclass	subclass		string	Specifies a value to match with subclass value associated with the workspace. This search is not case-sensitive.
Custom1	custom1		string	Specifies a value to match with custom1 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom2	custom2		string	Specifies a value to match with custom2 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom3	custom3		string	Specifies a value to match with custom3 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom4	custom4		string	Specifies a value to match with custom4 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom5	custom5		string	Specifies a value to match with custom5 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom6	custom6		string	Specifies a value to match with custom6 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom7	custom7		string	Specifies a value to match with custom7 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom8	custom8		string	Specifies a value to match with custom8 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom9	custom9		string	Specifies a value to match with custom9 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom10	custom10		string	Specifies a value to match with custom10 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom11	custom11		string	Specifies a value to match with custom11 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom12	custom12		string	Specifies a value to match with custom12 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom13	custom13		string	Specifies a value to match with custom13 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are supported.
Custom14	custom14		string	Specifies a value to match with custom14 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are supported.
Custom15	custom15		string	Specifies a value to match with custom15 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are supported.
Custom16	custom16		string	Specifies a value to match with custom16 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are supported.
Custom17	custom17		string	Specifies a value to match with custom17 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom18	custom18		string	Specifies a value to match with custom18 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom19	custom19		string	Specifies a value to match with custom19 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom20	custom20		string	Specifies a value to match with custom20 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom21 (Lower Limit)	custom21_from		string	Specifies the lower limit (in ISO 8601 datetime format) to search for in custom21 property associated with the workspace. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom21 (Upper Limit)	custom21_to		string	Specifies the upper limit (in ISO 8601 datetime format) to search for in custom21 property associated with the workspace. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom22 (Lower Limit)	custom22_from		string	Specifies the lower limit (in ISO 8601 datetime format) to search for in custom22 property associated with the workspace. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom22 (Upper Limit)	custom22_to		string	Specifies the upper limit (in ISO 8601 datetime format) to search for in custom22 property associated with the workspace. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom23 (Lower Limit)	custom23_from		string	Specifies the lower limit (in ISO 8601 datetime format) to search for in custom23 property associated with the workspace. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom23 (Upper Limit)	custom23_to		string	Specifies the upper limit (in ISO 8601 datetime format) to search for in custom23 property associated with the workspace. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom24 (Lower Limit)	custom24_from		string	Specifies the lower limit (in ISO 8601 datetime format) to search for in custom24 property associated with the workspace. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom24 (Upper Limit)	custom24_to		string	Specifies the upper limit (in ISO 8601 datetime format) to search for in custom24 property associated with the workspace. This search is not case-sensitive. For workspaces, the use of this property is customized for your iManage Work installation.
Custom25	custom25		boolean	Specifies a value to match with custom25 value associated with the workspace.
Custom26	custom26		boolean	Specifies a value to match with custom26 value associated with the workspace.
Custom27	custom27		boolean	Specifies a value to match with custom27 value associated with the workspace.
Custom28	custom28		boolean	Specifies a value to match with custom28 value associated with the workspace.
Custom29	custom29		string	Specifies a value to match with custom29 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported.
Custom30	custom30		string	Specifies a value to match with custom30 value associated with the workspace. This search is not case-sensitive. The wildcard character (*) and partial matches are not supported. To specify a value for custom30, you must also specify a value for custom29 in the same request, which is due to their parent-child relationship.

Search users

Operation ID:

SearchUsers

Searches for iManage Work users matching the specified search criteria.

Parameters

Name	Key	Required	Type	Description
Email ID	email		string	Specifies the email ID to search for. For example, 'JSMITH@XYZ.COM'.

Returns

Name	Path	Type	Description
Allow Logon	data.topMatchingUser.allow_logon	boolean	Indicates if the user is allowed to logon.
Custom1	data.topMatchingUser.custom1	string	Indicates additional information about the user.
Custom2	data.topMatchingUser.custom2	string	Indicates additional information about the user.
Custom3	data.topMatchingUser.custom3	string	Indicates additional information about the user.
Directory ID	data.topMatchingUser.directory_id	string	Indicates the ID from an external directory (such as ADFS), which is used for user profile synchronization.
Distinguished Name	data.topMatchingUser.distinguished_name	string	Indicates the name of the object that represents the fully qualified path of names that trace the entry back to the root of the LDAP tree.
Edit Date	data.topMatchingUser.edit_date	string	Indicates the date and time (in ISO 8601 format) of the most recent change to the user profile.
Email	data.topMatchingUser.email	string	Indicates the email ID of the user.
Exchange Auto-discover URL	data.topMatchingUser.exch_autodiscover	string	Indicates the exchange server details of the user.
Extension	data.topMatchingUser.extension	string	Indicates the phone number extension of the user.
Failed Logon Attempts	data.topMatchingUser.failed_logins	integer	Indicates the current number of failed sign-in attempts of the user.
Fax	data.topMatchingUser.fax	string	Indicates the fax number of the user.
Force Password Change	data.topMatchingUser.force_password_change	boolean	Indicates the user must change their password on next sign-in. Only applicable to virtual users, indicated by 'user_nos' value '2'.
Full Name	data.topMatchingUser.full_name	string	Indicates the full name of the user.
General	data.topMatchingUser.general	string	Indicates general information about the user.
ID	data.topMatchingUser.id	string	Indicates the ID of the user. For example, 'JSMITH'.
Is External	data.topMatchingUser.is_external	boolean	Indicates an external user. An external user has limited access and is commonly used for temporary team members, consultants, or those external to the organization.
Last Sync Time	data.topMatchingUser.last_sync_ts	string	Indicates the last sync time (in ISO 8601 datetime format) of the user's profile with an external directory, such as LDAP or Microsoft Active Directory (ADFS).
Location	data.topMatchingUser.location	string	Indicates the geographical location of the user.
Password Never Expires	data.topMatchingUser.password_never_expire	boolean	Indicates if the user's password never expires.
Phone Number	data.topMatchingUser.phone	string	Indicates the phone number of the user.
Preferred Library	data.topMatchingUser.preferred_library	string	Indicates the preferred library. A preferred library is the user's default library. Each user must have one preferred library.
Password Changed Time	data.topMatchingUser.pwd_changed_ts	string	Indicates the time (in ISO 8601 datetime format) when the user's password was last changed. This is applicable to virtual users only (whose User NOS is 2).
SSID	data.topMatchingUser.ssid	string	Indicates the unique, system-generated ID for the user.
Domain	data.topMatchingUser.user_domain	string	Indicates the fully qualified domain name for the user's directory service.
Extended ID	data.topMatchingUser.user_id_ex	string	Indicates the original value of the user ID that is received from an external directory such as Microsoft Active Directory (ADFS).
NOS	data.topMatchingUser.user_nos	integer	Indicates the type of operating system from which the user is synced. Possible values are 2 (Virtual user) and 6 (Enterprise user). For more information, contact your iManage Work system administrator.
Number	data.topMatchingUser.user_num	integer	Indicates the numeric system ID of the user.
results	data.results	array of UserProfileInArray

Set core extended metadata properties on a document

Operation ID:

SetCoreEMPropertiesForDocument

Sets core extended metadata properties on a document.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.
Name	key	True	string	Specifies name of the core extended metadata property.
Value	value	True	string	Specifies one or more values to set for the core extended metadata property, separated by semicolons. To unset the value, set the value of the key to an empty string wrapped in single or double quotes.

Update current or create new document version

Operation ID:

UpdateOrCreateNewDocVersion

Updates the specified version of a document, or creates a new version. This action can update the profile and content of a document. If 'Update Current Version' option is specified, the document is replaced with a new one and the profile of the previous document is maintained. If 'Create New Version' is specified, a new version of the document is created that inherits the profile of the folder. Upon successful execution of the operation, the document profile is returned.

Parameters

Name	Key	Required	Type	Description
Update Or Create New Version	updateOrCreate	True	string	Specifies to update the current version of the document or to create a new version.
Existing Document ID	documentId	True	string	Specifies the ID of the existing document. For example, 'ACTIVE_US!556.1'.
Keep Locked	keep_locked		boolean	Specifies if a document lock is kept after upload.
Comment	comment		string	Specifies additional information about the update.
Document Name	name		string	Specifies the name of the document.
Author	author		string	Specifies the iManage Work ID of the user who created the document.
Operator	operator		string	Specifies the ID of the user that has the document checked out or is currently editing the document's profile. For example, 'JSMITH'.
Class	class		string	Specifies the class for identifying and differentiating the document. Document class is categorized by genre, department, region, and so on.
Subclass	subclass		string	Specifies the subclass for identifying and differentiating the document. Document subclass is categorized by genre, department, region, and so on.
Default Security	default_security		string	Specifies the default security access level. Possible values are 'inherit', 'private', 'view', 'public'.
Is HIPAA	is_hipaa		boolean	Specifies if the document is to be encrypted.
Retain Days	retain_days		integer	Specifies the number of days a document must be inactive before marking it for archiving.
File Contents	file	True	file	Specifies the contents of the file.
File Creation Date	file_create_date		date-time	Specifies the date and time (in ISO 8601 format) the file was created. The file could have been created outside of the iManage Work system. This date can be different than 'create_date'. The create_date is the date when the file was created or imported by the iManage Work system.
File Edit Date	file_edit_date		date-time	Specifies the date and time (in ISO 8601 format) of the most recent change to the file. The file could have been changed before being uploaded into the iManage Work system.
Custom1	custom1		string	Specifies the value for custom1.
Custom2	custom2		string	Specifies the value for custom2. To specify a value for custom2, you must also specify a value for custom1 in the same request, which is due to their parent-child relationship.
Custom3	custom3		string	Specifies the value for custom3.
Custom4	custom4		string	Specifies the value for custom4.
Custom5	custom5		string	Specifies the value for custom5.
Custom6	custom6		string	Specifies the value for custom6.
Custom7	custom7		string	Specifies the value for custom7.
Custom8	custom8		string	Specifies the value for custom8.
Custom9	custom9		string	Specifies the value for custom9.
Custom10	custom10		string	Specifies the value for custom10.
Custom11	custom11		string	Specifies the value for custom11.
Custom12	custom12		string	Specifies the value for custom12.
Custom13	custom13		string	Specifies the value for custom13.
Custom14	custom14		string	Specifies the value for custom14.
Custom15	custom15		string	Specifies the value for custom15.
Custom16	custom16		string	Specifies the value for custom16.
Custom17	custom17		double	Specifies the value for custom17.
Custom18	custom18		double	Specifies the value for custom18.
Custom19	custom19		double	Specifies the value for custom19.
Custom20	custom20		double	Specifies the value for custom20.
Custom21	custom21		string	Specifies the value for custom21 in ISO 8601 datetime format.
Custom22	custom22		string	Specifies the value for custom22 in ISO 8601 datetime format.
Custom23	custom23		string	Specifies the value for custom23 in ISO 8601 datetime format.
Custom24	custom24		string	Specifies the value for custom24 in ISO 8601 datetime format.
Custom25	custom25		boolean	Specifies the value for custom25.
Custom26	custom26		boolean	Specifies the value for custom26.
Custom27	custom27		boolean	Specifies the value for custom27.
Custom28	custom28		boolean	Specifies the value for custom28.
Custom29	custom29		string	Specifies the value for custom29.
Custom30	custom30		string	Specifies the value for custom30. To specify a value for custom30, you must also specify a value for custom29 in the same request, which is due to their parent-child relationship.

Update default security

Operation ID:

UpdateDefaultSecurity

Updates the default security of a document, folder or workspace.

Parameters

Name	Key	Required	Type	Description
Object Type	objectType	True	string	Specifies the type of object.
Object ID	objectId	True	string	Specifies the ID of the document, folder or workspace. An example of a document ID is 'ACTIVE_US!453.1'. An example of a folder or workspace ID is 'ACTIVE_US!123'.
Default Security	default_security	True	string	Specifies the default security for the object.

Returns

Name	Path	Type	Description
Default Security	data.default_security	string	Indicates the default security of the object. Possible values are 'inherit', 'public', 'view' or 'private'.
Access Permissions	data.acl	AccessPermissions	Indicates a collection of access permissions for one or more users and/or groups.

Update document profile

Operation ID:

UpdateDocumentProfile

Performs updates on the document profile. A document must not be in use while updating its profile and the profile of a document that is checked out cannot be updated. Returns an updated document profile after the operation.

Parameters

Name	Key	Required	Type	Description
Alias	alias		string	Specifies the alias of this document.
Author	author		string	Specifies the ID of the user that created the document. For example, 'JSMITH'.
Document Class	class		string	Specifies the document class.
Comment	comment		string	Specifies additional information about the document.
Document Default Security	default_security		string	Specifies the default security access level.
Document ID	documentId	True	string	Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.
Is Declared	is_declared		boolean	Specifies if the document is to be declared as a record. A document that is declared as a record can not be edited or deleted, except by an iManage Work system administrator.
Is HIPAA	is_hipaa		boolean	Specifies if the document is to be encrypted.
Document Name	name		string	Specifies the file name of the document.
Operator	operator		string	Specifies the ID of the user has the document checked out or is currently editing the document's profile. For example, 'JSMITH'.
Retain Days	retain_days		integer	Specifies the number of days before the inactive document is eligible for archiving.
Subclass	subclass		string	Specifies the document's subclass.
Custom1	custom1		string	Specifies the value of custom1.
Custom2	custom2		string	Specifies the value of custom2. To specify a value for custom2, you must also specify a value for custom1 in the same request, which is due to their parent-child relationship.
Custom3	custom3		string	Specifies the value of custom3.
Custom4	custom4		string	Specifies the value of custom4.
Custom5	custom5		string	Specifies the value of custom5.
Custom6	custom6		string	Specifies the value of custom6.
Custom7	custom7		string	Specifies the value of custom7.
Custom8	custom8		string	Specifies the value of custom8.
Custom9	custom9		string	Specifies the value of custom9.
Custom10	custom10		string	Specifies the value of custom10.
Custom11	custom11		string	Specifies the value of custom11.
Custom12	custom12		string	Specifies the value of custom12.
Custom13	custom13		string	Specifies the value of custom13.
Custom14	custom14		string	Specifies the value of custom14.
Custom15	custom15		string	Specifies the value of custom15.
Custom16	custom16		string	Specifies the value of custom16.
Custom17	custom17		double	Specifies the value of custom17.
Custom18	custom18		double	Specifies the value of custom18.
Custom19	custom19		double	Specifies the value of custom19.
Custom20	custom20		double	Specifies the value of custom20.
Custom21	custom21		string	Specifies the value of the custom21 property in ISO 8601 datetime format.
Custom22	custom22		string	Specifies the value of the custom22 property in ISO 8601 datetime format.
Custom23	custom23		string	Specifies the value of the custom23 property in ISO 8601 datetime format.
Custom24	custom24		string	Specifies the value of the custom24 property in ISO 8601 datetime format.
Custom25	custom25		boolean	Specifies the value of custom25.
Custom26	custom26		boolean	Specifies the value of custom26.
Custom27	custom27		boolean	Specifies the value of custom27.
Custom28	custom28		boolean	Specifies the value of custom28.
Custom29	custom29		string	Specifies the value of custom29.
Custom30	custom30		string	Specifies the value of custom30. To specify a value for custom30, you must also specify a value for custom29 in the same request, which is due to their parent-child relationship.

Update permissions

Operation ID:

UpdatePermissions

Updates permissions of an object.

Parameters

Name	Key	Required	Type	Description
Object Type	objectType	True	string	Specifies the type of object.
Object ID	objectId	True	string	Specifies the ID of the document, folder or workspace. An example of a document ID is 'ACTIVE_US!453.1'. An example of a folder or workspace ID is 'ACTIVE_US!123'.
Access Level	access_level	True	string	Specifies the access level.
Users	users		string	Specifies one or more users to set the access level, separated by a semicolon.
Groups	groups		string	Specifies one or more groups to set the access level, separated by a semicolon.

Returns

Body

UpdatePermissionsResponse

Update workflow state

Operation ID:

UpdateWorkflowState

Updates the state of a workflow run. This action can only be used in a workflow that has been created to start with a trigger provided by iManage.

Parameters

Name	Key	Required	Type	Description
Library ID	libraryId	True	string	Specifies the ID of the library for which the workflow is defined.
State	state	True	string	Specifies the current state of the workflow run.
Status	status		string	Specifies the current status for the workflow run. Maximum length is 128 characters.
Status Message	statusMessage		string	Specifies the customized message for the current status of the workflow run. Maximum length is 256 characters.

Returns

response

object

Update workspace

Operation ID:

UpdateWorkspace

Updates information of the specified workspace. To delete the existing value of a string field, set the value of the field to an empty string wrapped in single or double quotes.

Parameters

Name	Key	Required	Type	Description
Workspace ID	id	True	string	Specifies the ID of the workspace to be updated. For example, 'ACTIVE_US!427'.
Name	name		string	Specifies the name of the workspace.
Workspace Owner	owner		string	Specifies the owner of the workspace.
Custom1	custom1		string	Specifies the value of custom1.
Custom2	custom2		string	Specifies the value of custom2. To specify a value for custom2, you must also specify a value for custom1 in the same request, which is due to their parent-child relationship.
Custom3	custom3		string	Specifies the value of custom3.
Custom4	custom4		string	Specifies the value of custom4.
Custom5	custom5		string	Specifies the value of custom5.
Custom6	custom6		string	Specifies the value of custom6.
Custom7	custom7		string	Specifies the value of custom7.
Custom8	custom8		string	Specifies the value of custom8.
Custom9	custom9		string	Specifies the value of custom9.
Custom10	custom10		string	Specifies the value of custom10.
Custom11	custom11		string	Specifies the value of custom11.
Custom12	custom12		string	Specifies the value of custom12.
Custom13	custom13		string	Specifies the value of custom13.
Custom14	custom14		string	Specifies the value of custom14.
Custom15	custom15		string	Specifies the value of custom15.
Custom16	custom16		string	Specifies the value of custom16.
Custom17	custom17		double	Specifies the value of custom17.
Custom18	custom18		double	Specifies the value of custom18.
Custom19	custom19		double	Specifies the value of custom19.
Custom20	custom20		double	Specifies the value of custom20.
Custom21	custom21		string	Specifies the value of custom21, in ISO 8601 datetime format.
Custom22	custom22		string	Specifies the value of custom22, in ISO 8601 datetime format.
Custom23	custom23		string	Specifies the value of custom23, in ISO 8601 datetime format.
Custom24	custom24		string	Specifies the value of custom24, in ISO 8601 datetime format.
Custom25	custom25		boolean	Specifies the value of custom25.
Custom26	custom26		boolean	Specifies the value of custom26.
Custom27	custom27		boolean	Specifies the value of custom27.
Custom28	custom28		boolean	Specifies the value of custom28.
Custom29	custom29		string	Specifies the value of custom29.
Custom30	custom30		string	Specifies the value of custom30. To specify a value for custom30, you must also specify a value for custom29 in the same request, which is due to their parent-child relationship.
Default Security	default_security		string	Specifies the default security access level.
Description	description		string	Specifies additional information about the workspace.
Is External As Normal	is_external_as_normal		boolean	Specifies if the workspace can be treated as a public workspace. If set to 'true' and 'default_security' is not 'private', 'is_external' is set to 'true'.
Project Custom1	project_custom1		string	Specifies additional information about the workspace. This field is different than the metadata custom field associated with content items, such as documents, workspaces, or folders. This is descriptive text that does not have to be formatted, and is not validated.
Project Custom2	project_custom2		string	Specifies additional information about the workspace. This field is different than the metadata custom field associated with content items, such as documents, workspaces, or folders. This is descriptive text that does not have to be formatted, and is not validated.
Project Custom3	project_custom3		string	Specifies additional information about the workspace. This field is different than the metadata custom field associated with content items, such as documents, workspaces, or folders. This is descriptive text that does not have to be formatted, and is not validated.
Workspace Subclass	subclass		string	Specifies the subclass of the workspace based on the subclass of the document it contains.

Upload document

Operation ID:

UploadDocument

Uploads a file as a new document to the specified folder.

Parameters

Name	Key	Required	Type	Description
Library ID	libraryId	True	string	Specifies the ID of the target library.
Folder ID	folderId	True	string	Specifies the folder ID of the target folder. For example, 'ACTIVE_US!987'.
Inherit Folder Profile	inherit_profile_from_folder	True	boolean	Specifies if the profile data is inherited from the parent folder.
Keep Locked	keep_locked		boolean	Specifies if a document lock is kept after upload.
Comment	comment		string	Specifies additional information about the update.
Author	author		string	Specifies the iManage Work ID of the user who created the document.
Operator	operator		string	Specifies the ID of the user that has the document checked out or is currently editing the document's profile. For example, 'JSMITH'.
Class	class		string	Specifies the class for identifying and differentiating the document. Document class is categorized by genre, department, region, and so on.
Subclass	subclass		string	Specifies the subclass for identifying and differentiating the document. Document subclass is categorized by genre, department, region, and so on.
Default Security	default_security		string	Specifies the default security access level. Possible values are 'inherit', 'private', 'view', 'public'.
Is HIPAA	is_hipaa		boolean	Specifies if the document is to be encrypted.
Retain Days	retain_days		integer	Specifies the number of days a document must be inactive before marking it for archiving.
File Contents	file	True	file	Specifies the contents of the file.
File Creation Date	file_create_date		date-time	Specifies the date and time (in ISO 8601 format) the file was created. The file could have been created outside of the iManage Work system. This date can be different than 'create_date'. The create_date is the date when the file was created or imported by the iManage Work system.
File Edit Date	file_edit_date		date-time	Specifies the date and time (in ISO 8601 format) of the most recent change to the file. The file could have been changed before being uploaded into the iManage Work system.
Custom1	custom1		string	Specifies the value for custom1.
Custom2	custom2		string	Specifies the value for custom2. To specify a value for custom2, you must also specify a value for custom1 in the same request, which is due to their parent-child relationship.
Custom3	custom3		string	Specifies the value for custom3.
Custom4	custom4		string	Specifies the value for custom4.
Custom5	custom5		string	Specifies the value for custom5.
Custom6	custom6		string	Specifies the value for custom6.
Custom7	custom7		string	Specifies the value for custom7.
Custom8	custom8		string	Specifies the value for custom8.
Custom9	custom9		string	Specifies the value for custom9.
Custom10	custom10		string	Specifies the value for custom10.
Custom11	custom11		string	Specifies the value for custom11.
Custom12	custom12		string	Specifies the value for custom12.
Custom13	custom13		string	Specifies the value for custom13.
Custom14	custom14		string	Specifies the value for custom14.
Custom15	custom15		string	Specifies the value for custom15.
Custom16	custom16		string	Specifies the value for custom16.
Custom17	custom17		double	Specifies the value for custom17.
Custom18	custom18		double	Specifies the value for custom18.
Custom19	custom19		double	Specifies the value for custom19.
Custom20	custom20		double	Specifies the value for custom20.
Custom21	custom21		string	Specifies the value for custom21 in ISO 8601 datetime format.
Custom22	custom22		string	Specifies the value for custom22 in ISO 8601 datetime format.
Custom23	custom23		string	Specifies the value for custom23 in ISO 8601 datetime format.
Custom24	custom24		string	Specifies the value for custom24 in ISO 8601 datetime format.
Custom25	custom25		boolean	Specifies the value for custom25.
Custom26	custom26		boolean	Specifies the value for custom26.
Custom27	custom27		boolean	Specifies the value for custom27.
Custom28	custom28		boolean	Specifies the value for custom28.
Custom29	custom29		string	Specifies the value for custom29.
Custom30	custom30		string	Specifies the value for custom30. To specify a value for custom30, you must also specify a value for custom29 in the same request, which is due to their parent-child relationship.

Triggers

For a selected document	This trigger allows you to start a workflow for a selected document in an iManage Work library. Provide a display name that will be shown to users in iManage Work applications. If 'Wait For Completion' is set to 'Yes', you must use the 'Update workflow state' action in your workflow, otherwise applications will eventually time out without indicating the completion state to the user.
For multiple selected documents	This trigger allows you to start a workflow for two or more selected documents in iManage Work. Provide a display name that will be shown to users in iManage Work applications. If 'Wait For Completion' is set to 'Yes', you must use the 'Update workflow state' action in your workflow, otherwise applications will eventually time out without indicating the completion state to the user.

For a selected document

Operation ID:

SingleSelectedDocument

This trigger allows you to start a workflow for a selected document in an iManage Work library. Provide a display name that will be shown to users in iManage Work applications. If 'Wait For Completion' is set to 'Yes', you must use the 'Update workflow state' action in your workflow, otherwise applications will eventually time out without indicating the completion state to the user.

Parameters

Name	Key	Required	Type	Description
Workflow Display Name	workflowName	True	string	Specifies the display name of the workflow that will be visible to iManage Work users.
Description	description	True	string	Specifies the description of the workflow.
Library ID	libraryId	True	string	Specifies the ID of the library where the workflow is available.
Form ID	formId	True	string	Specifies the ID of the form that is presented to the user to collect inputs used by the workflow.
Return Folder ID	inferFolderId	True	boolean	Specifies whether the document's folder ID is required by the workflow.
Available To Users	users		string	Specifies one or more user IDs, separated by semicolons, to whom the workflow is available.
Available To Groups	groups		string	Specifies one or more group IDs, separated by semicolons, to which the workflow is available.
Available In Workspaces	workspaces		string	Specifies one or more workspace IDs, separated by semicolons, in which the workflow is available.
Document Classes	classes		string	Specifies one or more document class IDs, separated by semicolons, for which the workflow is available.
Wait For Completion	waitForCompletion		boolean	Specifies if applications wait until the workflow completes execution. If set to 'Yes', you must use the 'Update workflow state' action.

Returns

The outputs of this operation are dynamic.

For multiple selected documents

Operation ID:

MultipleSelectedDocuments

This trigger allows you to start a workflow for two or more selected documents in iManage Work. Provide a display name that will be shown to users in iManage Work applications. If 'Wait For Completion' is set to 'Yes', you must use the 'Update workflow state' action in your workflow, otherwise applications will eventually time out without indicating the completion state to the user.

Parameters

Name	Key	Required	Type	Description
Workflow Display Name	workflowName	True	string	Specifies the display name of the workflow that will be visible to iManage Work users.
Description	description	True	string	Specifies the description of the workflow.
Library ID	libraryId	True	string	Specifies the ID of the library where the workflow is available.
Form ID	formId	True	string	Specifies the ID of the form that is presented to the user to collect inputs used by the workflow.
Return Folder ID	inferFolderId	True	boolean	Specifies whether the document's folder ID is required by the workflow.
Available To Users	users		string	Specifies one or more user IDs, separated by semicolons, to whom the workflow is available.
Available To Groups	groups		string	Specifies one or more group IDs, separated by semicolons, to which the workflow is available.
Wait For Completion	waitForCompletion		boolean	Specifies if applications wait until the workflow completes execution. If set to 'Yes', you must use the 'Update workflow state' action.

Returns

The outputs of this operation are dynamic.

Definitions

MinimalDocumentProfileInArray

Indicates profile of each version of the document.

Name	Path	Type	Description
Author	author	string	Indicates the ID of the user that created the document. For example, 'JSMITH'.
Author Description	author_description	string	Indicates additional information about the document's author.
Basic Document Properties	basic_properties	string	Indicates an embeddable '' element that contains basic document properties.
Document Class	class	string	Indicates the document's class.
Comment	comment	string	Indicates additional information about the document.
Content Type	content_type	string	Indicates the document content type.
Document Creation Date	create_date	string	Indicates the date and time (in ISO 8601 format) the document was imported into the iManage Work system. This date can be different than 'file_create_date'.
Custom1	custom1	string	Indicates the value of custom1.
Custom1 Description	custom1_description	string	Indicates additional information about the custom1 property.
Custom2	custom2	string	Indicates the value of custom2.
Custom2 Description	custom2_description	string	Indicates additional information about the custom2 property.
Custom3	custom3	string	Indicates the value of custom3.
Custom3 Description	custom3_description	string	Indicates additional information about the custom3 property.
Custom4	custom4	string	Indicates the value of custom4.
Custom4 Description	custom4_description	string	Indicates additional information about the custom4 property.
Custom5	custom5	string	Indicates the value of custom5.
Custom5 Description	custom5_description	string	Indicates additional information about the custom5 property.
Custom6	custom6	string	Indicates the value of custom6.
Custom6 Description	custom6_description	string	Indicates additional information about the custom6 property.
Custom7	custom7	string	Indicates the value of custom7.
Custom7 Description	custom7_description	string	Indicates additional information about the custom7 property.
Custom8	custom8	string	Indicates the value of custom8.
Custom8 Description	custom8_description	string	Indicates additional information about the custom8 property.
Custom9	custom9	string	Indicates the value of custom9.
Custom9 Description	custom9_description	string	Indicates additional information about the custom9 property.
Custom10	custom10	string	Indicates the value of custom10.
Custom10 Description	custom10_description	string	Indicates additional information about the custom10 property.
Custom11	custom11	string	Indicates the value of custom11.
Custom11 Description	custom11_description	string	Indicates additional information about the custom11 property.
Custom12	custom12	string	Indicates the value of custom12.
Custom12 Description	custom12_description	string	Indicates additional information about the custom12 property.
Custom13	custom13	string	Indicates value of custom13.
Custom14	custom14	string	Indicates value of custom14.
Custom15	custom15	string	Indicates value of custom15.
Custom16	custom16	string	Indicates value of custom16.
Custom17	custom17	double	Indicates value of custom17.
Custom18	custom18	double	Indicates value of custom18.
Custom19	custom19	double	Indicates value of custom19.
Custom20	custom20	double	Indicates value of custom20.
Custom21	custom21	string	Indicates value of the custom21 property in ISO 8601 datetime format.
Custom22	custom22	string	Indicates value of the custom22 property in ISO 8601 datetime format.
Custom23	custom23	string	Indicates value of the custom23 property in ISO 8601 datetime format.
Custom24	custom24	string	Indicates value of the custom24 property in ISO 8601 datetime format.
Custom25	custom25	boolean	Indicates the value of custom25.
Custom26	custom26	boolean	Indicates the value of custom26.
Custom27	custom27	boolean	Indicates the value of custom27.
Custom28	custom28	boolean	Indicates the value of custom28.
Custom29	custom29	string	Indicates the value of custom29.
Custom29 Description	custom29_description	string	Indicates additional information about the custom29 property.
Custom30	custom30	string	Indicates the value of custom30.
Custom30 Description	custom30_description	string	Indicates additional information about the custom30 property.
Database	database	string	Indicates the library where the document is stored.
Document Default Security	default_security	string	Indicates the default security access level. Possible values are 'inherit', 'private', 'view', 'public'.
Document Number	document_number	integer	Indicates the document number of a document.
Document URL	document_url	string	Indicates the sharable link for the document.
Document Edit Date	edit_date	string	Indicates the date and time (in ISO 8601 format) of the most recent change to the document.
Profile Edit Date	edit_profile_date	string	Indicates the date and time (in ISO 8601 format) of the most recent change to the document profile.
Document Extension	extension	string	Indicates the file name extension, also called the application extension, of the document.
Full File Name	full_file_name	string	Indicates the full file name of the document. Includes the file name extension.
Document ID	id	string	Indicates the ID of the document. For example, 'ACTIVE_US!453.1'.
Is Indexable	indexable	boolean	Indicates if the document is indexed by the system.
Is Checked Out	is_checked_out	boolean	Indicates if the document is checked out.
Is Declared	is_declared	boolean	Indicates if the document is declared as a record. A document that is declared as a record can not be edited or deleted, except by an iManage Work system administrator.
Is External	is_external	boolean	Indicates if the document is shared with external users.
Is HIPAA	is_hipaa	boolean	Indicates if the document is encrypted.
Is In-use	is_in_use	boolean	Indicates if the document is in use.
Document Link	iwl	string	Indicates the iManage Work Link (iWL) for the document. The iWL is used to open the document in Protected View Mode by the user who has 'read_write' or 'full_access'.
Last User	last_user	string	Indicates the ID of the user that edited the document most recently. For example, 'JSMITH'.
Last User Description	last_user_description	string	Indicates additional information about the last user that edited the document most recently.
Document Name	name	string	Indicates the file name of the document.
Operator	operator	string	Indicates the ID of the user that has the document checked out or is currently editing its profile. For example, 'JSMITH'.
Operator Description	operator_description	string	Indicates additional information about the operator.
Is Related	is_related	boolean	Indicates if document is related to another document.
Document Size	size	integer	Indicates the size of the document in bytes.
Type	type	string	Indicates the document type. For example, WORD for Microsoft Word. For a current list of types, contact your iManage Work system administrator.
Document Version	version	integer	Indicates the version number of the document.
Wstype	wstype	string	Indicates the iManage Work type of the object. Possible values are 'document', 'folder', 'workspace', 'email', 'document_shortcut', 'folder_shortcut', 'workspace_shortcut', 'user'.

UserProfile

Indicates information about a user.

Name	Path	Type	Description
Allow Logon	allow_logon	boolean	Indicates if the user is allowed to logon.
Custom1	custom1	string	Indicates additional information about the user.
Custom2	custom2	string	Indicates additional information about the user.
Custom3	custom3	string	Indicates additional information about the user.
Directory ID	directory_id	string	Indicates the ID from an external directory (such as ADFS), which is used for user profile synchronization.
Distinguished Name	distinguished_name	string	Indicates the name of the object that represents the fully qualified path of names that trace the entry back to the root of the LDAP tree.
Edit Date	edit_date	string	Indicates the date and time (in ISO 8601 format) of the most recent change to the user profile.
Email	email	string	Indicates the email ID of the user.
Exchange Auto-discover URL	exch_autodiscover	string	Indicates the exchange server details of the user.
Extension	extension	string	Indicates the phone number extension of the user.
Failed Logon Attempts	failed_logins	integer	Indicates the current number of failed sign-in attempts of the user.
Fax	fax	string	Indicates the fax number of the user.
Force Password Change	force_password_change	boolean	Indicates the user must change their password on next sign-in. Only applicable to virtual users, indicated by 'user_nos' value '2'.
Full Name	full_name	string	Indicates the full name of the user.
General	general	string	Indicates general information about the user.
User ID	id	string	Indicates the ID of the user. For example, 'JSMITH'.
Is External User	is_external	boolean	Indicates an external user. An external user has limited access and is commonly used for temporary team members, consultants, or those external to the organization.
Last Sync Time	last_sync_ts	string	Indicates the last sync time (in ISO 8601 datetime format) of the user's profile with an external directory, such as LDAP or Microsoft Active Directory (ADFS).
Location	location	string	Indicates the geographical location of the user.
Password Never Expires	password_never_expire	boolean	Indicates if the user's password never expires.
Phone Number	phone	string	Indicates the phone number of the user.
Preferred Library	preferred_library	string	Indicates the preferred library. A preferred library is the user's default library. Each user must have one preferred library.
Password Changed Time	pwd_changed_ts	string	Indicates the time (in ISO 8601 datetime format) when the user's password was last changed. This is applicable to virtual users only (whose User NOS is 2).
SSID	ssid	string	Indicates the unique, system-generated ID for the user.
User Domain	user_domain	string	Indicates the fully qualified domain name for the user's directory service.
Extended User ID	user_id_ex	string	Indicates the original value of the user ID that is received from an external directory such as Microsoft Active Directory (ADFS).
User NOS	user_nos	integer	Indicates the type of operating system from which the user is synced. Possible values are 2 (Virtual user) and 6 (Enterprise user). For more information, contact your iManage Work system administrator.
User Number	user_num	integer	Indicates the numeric system ID of the user.

UserProfileInArray

Name	Path	Type	Description
Allow Logon	allow_logon	boolean	Indicates if the user is allowed to logon.
Custom1	custom1	string	Indicates additional information about the user.
Custom2	custom2	string	Indicates additional information about the user.
Custom3	custom3	string	Indicates additional information about the user.
Directory ID	directory_id	string	Indicates the ID from an external directory (such as ADFS), which is used for user profile synchronization.
Distinguished Name	distinguished_name	string	Indicates the name of the object that represents the fully qualified path of names that trace the entry back to the root of the LDAP tree.
Edit Date	edit_date	string	Indicates the date and time (in ISO 8601 format) of the most recent change to the user profile.
Email	email	string	Indicates the email ID of the user.
Exchange Auto-discover URL	exch_autodiscover	string	Indicates the exchange server details of the user.
Extension	extension	string	Indicates the phone number extension of the user.
Failed Logon Attempts	failed_logins	integer	Indicates the current number of failed sign-in attempts of the user.
Fax	fax	string	Indicates the fax number of the user.
Force Password Change	force_password_change	boolean	Indicates the user must change their password on next sign-in. Only applicable to virtual users, indicated by 'user_nos' value '2'.
Full Name	full_name	string	Indicates the full name of the user.
General	general	string	Indicates general information about the user.
ID	id	string	Indicates the ID of the user. For example, 'JSMITH'.
Is External User	is_external	boolean	Indicates an external user. An external user has limited access and is commonly used for temporary team members, consultants, or those external to the organization.
Last Sync Time	last_sync_ts	string	Indicates the last sync time (in ISO 8601 datetime format) of the user's profile with an external directory, such as LDAP or Microsoft Active Directory (ADFS).
Location	location	string	Indicates the geographical location of the user.
Password Never Expires	password_never_expire	boolean	Indicates if the user's password never expires.
Phone Number	phone	string	Indicates the phone number of the user.
Preferred Library	preferred_library	string	Indicates the preferred library. A preferred library is the user's default library. Each user must have one preferred library.
Password Changed Time	pwd_changed_ts	string	Indicates the time (in ISO 8601 datetime format) when the user's password was last changed. This is applicable to virtual users only (whose User NOS is 2).
SSID	ssid	string	Indicates the unique, system-generated ID for the user.
Domain	user_domain	string	Indicates the fully qualified domain name for the user's directory service.
Extended User ID	user_id_ex	string	Indicates the original value of the user ID that is received from an external directory such as Microsoft Active Directory (ADFS).
NOS	user_nos	integer	Indicates the type of operating system from which the user is synced. Possible values are 2 (Virtual user) and 6 (Enterprise user). For more information, contact your iManage Work system administrator.
Number	user_num	integer	Indicates the numeric system ID of the user.

TaxonomyNodeValue

Indicates each taxonomy node value.

Name	Path	Type	Description
SSID	created_by.ssid	string	Indicates the unique, system-generated ID for the user who created the node value.
Create Date	create_date	date-time	Indicates the date and time (in ISO 8601 format) the node value was created.
Description	description	string	Indicates the description of the node value.
SSID	edited_by.ssid	string	Indicates the unique, system-generated ID for the user who last edited the node value.
Edit Date	edit_date	date-time	Indicates the date and time (in ISO 8601 format) the node value was last edited.
Is Enabled	enabled	boolean	Indicates if the node value is enabled.
ID	id	string	Indicates the display identifier for the node value.
SSID	parent.ssid	string	Indicates the unique, system-generated ID for the immediate parent node.
SSID	ssid	string	Indicates the unique, system-generated ID for the node value.
Path	path	array of object	Indicates the full path to the node value. A path is an ordered list beginning with the top-level node in the taxonomy and then all nodes through to the matching node's immediate parent.
Each ID	path.id	string	Indicates the display identifier for a node value in the path.
Each SSID	path.ssid	string	Indicates the unique, system-generated ID for a node value in the path.

UpdatePermissionsResponse

Name	Path	Type	Description
Default Security	data.default_security	string	Indicates the default security of the object. Possible values are 'inherit', 'public', 'view' or 'private'.
Access Permissions	data.acl	AccessPermissions	Indicates a collection of access permissions for one or more users and/or groups.
All User IDs	data.all_user_ids	string	Indicates a list of all user IDs, concatenated as a string and separated by semicolons.
All Group IDs	data.all_group_ids	string	Indicates a list of all group IDs, concatenated as a string and separated by semicolons.

AccessPermissions

Indicates a collection of access permissions for one or more users and/or groups.

Name	Path	Type	Description
Trustee Name	name	string	Indicates the name of the trustee.
Trustee ID	id	string	Indicates the ID of the trustee. This can be a user ID or a group ID.
Trustee SID	sid	string	Indicates the security identifier of the user or group.
Trustee Type	type	string	Indicates the type of trustee returned. Possible values are 'user' or 'group'.
Access Level	access_level	string	Indicates the access permission the user or group has on the object. Possible values are 'no_access', 'read', 'read_write' or 'full_access'.
Access-level Display Name	access_level_display_name	string	Indicates the human-readable access-level display name assigned to the user or group for this object. Possible values are 'No Access', 'Read Only', 'Read/Write' or 'Full Access'.
Access	access	integer	Indicates the numeric value of the access permission the user or group has on the object. Possible values are 0 (no_access), 1 (read), 2 (read_write) or 3 (full_access).
Is External	is_external	boolean	Indicates if the user is an external user, or if the group is restricted to external users.
Allow Logon	allow_logon	boolean	Indicates if the user is allowed to logon. Not applicable to groups.
Is Enabled	enabled	boolean	Indicates if the group is enabled. Not applicable to users.
Has Restricted Member	has_restricted_member	boolean	Indicates if the group has at least one user with access to this object denied by iManage Security Policy Manager.

object

This is the type 'object'.

binary

This is the basic data type 'binary'.