Поделиться через

iManage Work for Admins

  • Reference

iManage Work for Admins connector enables administrators to automate their repetitive or integration tasks, such as adding users or updating custom fields.

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 [email protected]
Connector Metadata
Publisher iManage Power Platform Connector
Website https://imanage.com
Privacy policy https://imanage.com/about/privacy-notice/
Categories Content and Files;Productivity

iManage Work for Admins

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 for Admins supports automation of iManage Administrator features that are available in Control Center. For example, updating metadata fields, adding users, and so on.

Prerequisites

The connector is available for all iManage Work customers connecting to cloudimanage.com. First, the iManage Work Admin for 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. Actions respect the same permissions as applied in Work, so for many of these actions you must have NRT Admin or Tier 1 or Tier 2 support. 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 for Admins connector

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

  • Create an Instant cloud flow and select + New step.
  • Search for iManage Work for Admins to see all the available iManage Work Admin actions.
  • Select the desired iManage Work Admin 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 Admin 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, please visit https://docs.imanage.com/power-automate/index.html.

Common errors and remedies

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

FAQ

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

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add folder

Adds a new folder under a workspace, tab or folder.
Add shortcuts to user's My Matters

Adds workspace shortcuts to a user's 'My Matters'. If a Category ID is specified, shortcuts are placed under that category.
Add tab

Adds a new tab under a workspace.
Assign user to library

Assigns an existing user to a library.
Create alias for custom or property lookup

Creates a custom property alias for custom1 through custom12, custom29, and custom30.
Create user

Creates user and assigns the user to the preferred library.
Get library roles

Gets the list of user roles for a library.
Get lookup aliases

Gets a list of lookup aliases for the specified lookup field ID.
Get My Matters categories

Gets categories created in 'My Matters'. Administrators can specify a user ID to get 'My Matters' categories for that user.
Get rows from CSV document

Gets rows from a CSV document in iManage Work.
Update custom field

Updates a custom field description or enabled state for custom1 through custom12, custom29, and custom30.

Add folder

Operation ID:
AddFolder

Adds a new folder under a workspace, tab or folder.

Parameters

Name Key Required Type Description
body
 body True dynamic

Add shortcuts to user's My Matters

Operation ID:
AddShortcutsToMyMattersAdmin

Adds workspace shortcuts to a user's 'My Matters'. If a Category ID is specified, shortcuts are placed under that category.

Parameters

Name Key Required Type Description
User ID
 user_id True string

Specifies the ID of the 'My Matters' owner.
Workspace ID
 workspace_id True string

Specifies one or more workspace IDs, separated by a semicolon. An example of a workspace ID is 'ACTIVE_US!123'.
Category ID
 category_id string

Specifies the ID of the category under 'My Matters'. An example of a category ID is 'ACTIVE_US!123'.

Returns

Name Path Type Description
Workspace Shortcuts
 data.shortcuts array of MyMattersShortcutsInArray

Indicates a collection of workspace shortcuts added to 'My Matters'.
All Workspace Shortcut IDs
 data.all_workspace_shortcut_ids string

Indicates a list of all workspace shortcut IDs, concatenated as a string and separated by semicolons.

Add tab

Operation ID:
AddTab

Adds a new tab under a workspace.

Parameters

Name Key Required Type Description
Name
 name True string

Specifies the name of the tab.
Parent Workspace ID
 parentId True string

Specifies the ID of the target workspace. An example of a workspace ID is 'ACTIVE_US!123'.
Default Security
 default_security True string

Specifies the default security for the tab.
Description
 description string

Specifies the description of the tab.
Tab Owner
 owner string

Specifies the user ID for the owner of the tab. An example user ID is 'ACASE'.

Assign user to library

Operation ID:
AssignUserToLibrary

Assigns an existing user to a library.

Parameters

Name Key Required Type Description
Library ID
 libraryId True string

Specifies the ID of the target library.
User ID
 user_id True string

Specifies the name of the user to be assigned to target library.
Role
 role True string

Specifies the role of the user in the target library.
Is Preferred Library
 is_preferred_library True boolean

Specifies to set library ID as the user's preferred library.

Returns

Name Path Type Description
User Number
 data.user_num number

Indicates the internal user number.

Create alias for custom or property lookup

Operation ID:
CreateCustomOrPropertyLookup

Creates a custom property alias for custom1 through custom12, custom29, and custom30.

Parameters

Name Key Required Type Description
body
 body True dynamic

Returns

response
object

Create user

Operation ID:
CreateUser

Creates user and assigns the user to the preferred library.

Parameters

Name Key Required Type Description
body
 body True dynamic

Returns

Name Path Type Description
User Number
 data.user_num integer

Indicates the internal user number.
Full Name
 data.full_name string

Indicates the user's full name.
User ID
 data.id string

Indicates the unique ID of the user.
User Preferred Library
 data.preferred_library string

Indicates the user's preferred (default) library.
User NOS
 data.user_nos integer

Indicates the user's type. The user type can be virtual (2) or enterprise (6).
Extended User ID
 data.user_id_ex string

Indicates the original value of the user ID that is received from the source system such as Active Directory.
User SSID
 data.ssid string

Indicates the unique, system-generated ID of the user.
Password Never Expires
 data.pwd_never_expire boolean

Indicates if the user's password never expires.
Is Locked
 data.is_locked boolean

Indicates if the user is locked.
External User
 data.is_external boolean

Indicates if the user is an external user.
Has Password
 data.has_password boolean

Indicates if the user has a password.
Force Password Change
 data.force_password_change boolean

Indicates the user must change their password on next logon. Only applicable to virtual users, indicated by User NOS with value '2'.
Failed Logons
 data.failed_logins integer

Indicates the current number of failed logon attempts of the user.
User Email
 data.email string

Indicates the email address of the user.
Edit Date
 data.edit_date string

Indicates the date and time (in ISO 8601 format) of the most recent change to the user profile.
Create Date
 data.create_date string

Indicates the date and time (in ISO 8601 format) the user was created.
Password Changed Date
 data.pwd_changed_ts string

Indicates the date and time (in ISO 8601 format) the user's password was changed.
Allow Logon
 data.allow_logon boolean

Indicates if the user is allowed to logon.
User Created
 data.user_created boolean

Indicates if the user was created successfully. If true, a new user was created successfully. If false, the user already existed.

Get library roles

Operation ID:
GetLibraryRoles

Gets the list of user roles for a library.

Parameters

Name Key Required Type Description
Library ID
 libraryId True string

Specifies the ID of the target library.
External Library Roles
 is_external boolean

Specifies the library roles returned are external roles.

Returns

Name Path Type Description
data
 data array of object

Indicates the list of user roles for a library.
ID
 data.id string

Indicates the ID of the role.
Description
 data.description string

Indicates the description of the role.

Get lookup aliases

Operation ID:
GetLookupAliases

Gets a list of lookup aliases for the specified lookup field ID.

Parameters

Name Key Required Type Description
Library ID
 libraryId True string

Specifies the ID of the target library.
Lookup Field ID
 lookupFieldId True string

Specifies the lookup field ID.
Parent Alias
 parentAlias string

Specifies the parent of the custom property alias if custom2 or custom30 is selected.

Returns

Name Path Type Description
data
 data array of object

indicates the list of lookup aliases for the specified lookup field ID.
ID
 data.id string

Indicates the ID of the lookup alias.
Name
 data.description string

Indicates the name of the lookup alias.

Get My Matters categories

Operation ID:
GetMyMattersCategories

Gets categories created in 'My Matters'. Administrators can specify a user ID to get 'My Matters' categories for that user.

Parameters

Name Key Required Type Description
User ID
 user_id True string

Specifies the user ID of the 'My Matters' owner.

Returns

Name Path Type Description
data
 data array of object
Type
 data.category_type string

Indicates the category type. Possible values are 'my_matters', 'my_favorites'.
Default Security
 data.default_security string

Indicates the default security access level for the category. Possible values are 'inherit', 'public', 'view', 'private'.
Has Sub-folders
 data.has_subfolders boolean

Indicates if the category has subfolders. A subfolder can be a workspace, folder, or category.
ID
 data.id string

Indicates the ID of the category. For example, 'ACTIVE_US!987'.
Name
 data.name string

Indicates the name of the category.
Owner
 data.owner string

Indicates the user ID of the category owner.

Get rows from CSV document

Operation ID:
GetRowsFromCSVDocument

Gets rows from a CSV document in iManage Work.

Parameters

Name Key Required Type Description
Document ID
 documentId True string

Specifies the ID of the document. For example, 'ACTIVE_US!453.1'.
Column Names
 column_names True string

Specifies a comma-separated list of column names, or a document ID to fetch column names automatically using the first row.

Returns

The outputs of this operation are dynamic.

Update custom field

Operation ID:
UpdateCustomField

Updates a custom field description or enabled state for custom1 through custom12, custom29, and custom30.

Parameters

Name Key Required Type Description
body
 body True dynamic

Returns

response
object

Definitions

MyMattersShortcutsInArray

Indicates details of each shortcut.

Name Path Type Description
ID
 id string

Indicates the ID of the shortcut. For example, 'ACTIVE_US!987'.
Wstype
 wstype string

Indicates the iManage Work type of the object. Possible value is 'workspace_shortcut'.
ID
 target.id string

Indicates the target workspace ID for the shortcut. For example, 'ACTIVE_US!987'.

object

This is the type 'object'.