Trabajo de iManage
El conector iManage Work permite a los usuarios automatizar tareas repetitivas y procesos de aprobación mientras mantienen todos sus archivos seguros en el entorno de trabajo de iManage.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | iManage LLC |
| URL | https://docs.imanage.com |
| Correo Electrónico | cloudsupport@imanage.com |
| Metadatos del conector | |
|---|---|
| Publicador | Conector de Power Platform de iManage |
| Sitio web | https://imanage.com |
| Directiva de privacidad | https://imanage.com/about/privacy-notice/ |
| Categorías | Contenido y archivos; Productividad |
Trabajo de iManage
iManage es el proveedor líder del sector de soluciones de administración de documentos y correo electrónico para los trabajadores del conocimiento. La plataforma iManage organiza y protege la información en documentos y correos electrónicos, para que los profesionales puedan buscar lo que necesitan, actuar en él y colaborar de forma más eficaz. El conector iManage Work permite a los usuarios automatizar tareas repetitivas y procesos de aprobación mientras mantienen todos sus archivos seguros en el entorno de trabajo de iManage.
Prerrequisitos
El conector está disponible para todos los clientes de iManage Work que se conectan a cloudimanage.com. En primer lugar, la aplicación Power Automate deberá habilitarla un administrador del entorno de trabajo de iManage. Una vez habilitado, necesitará la dirección URL específica del entorno y una cuenta de inicio de sesión y una contraseña con las que el conector puede ejecutar acciones. Para obtener más información, consulte las preguntas más frecuentes.
Obtención de credenciales
Si es un usuario de iManage Work existente, proporcione sus credenciales de trabajo de iManage para iniciar sesión. De lo contrario, póngase en contacto con el administrador del sistema para obtener ayuda.
Introducción al conector de trabajo de iManage
Realice los pasos siguientes para empezar a trabajar con el conector iManage Work:
- Cree un flujo de nube instantánea y seleccione + Nuevo paso.
- Busque iManage Work para ver todas las acciones disponibles de iManage Work.
- Seleccione la acción Trabajo de iManage deseada.
- Si aún no ha iniciado sesión en iManage Work, se le pedirá que inicie sesión.
- Selecciona Iniciar sesión.
- Escriba la dirección URL que usa para conectarse a iManage Work, por ejemplo, cloudimanage.com.
- Escriba el identificador de usuario del trabajo de iManage.
- Escriba la contraseña de la cuenta elegida y seleccione Iniciar sesión. Desde este punto, todos los flujos que usan acciones de trabajo de iManage se conectan mediante estas credenciales de usuario. Se puede usar otra cuenta de usuario de iManage agregando una nueva conexión en Mis conexiones y cambiando a ella.
Problemas y limitaciones conocidos
Para obtener una lista de problemas conocidos y limitaciones, visite https://docs.imanage.com/power-automate/index.html.
Errores y soluciones comunes
Para obtener una lista de errores y soluciones comunes, visite https://docs.imanage.com/power-automate/index.html.
Preguntas más frecuentes
Para obtener una lista de las preguntas más frecuentes, visite https://docs.imanage.com/power-automate/index.html.
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de la seguridad predeterminada |
Actualiza la seguridad predeterminada de un documento, una carpeta o un área de trabajo. |
| Actualizar el estado del flujo de trabajo |
Actualiza el estado de una ejecución de flujo de trabajo. Esta acción solo se puede usar en un flujo de trabajo que se ha creado para empezar con un desencadenador proporcionado por iManage. |
| Actualizar la versión actual o crear un nuevo documento |
Actualiza la versión especificada de un documento o crea una nueva versión. Esta acción puede actualizar el perfil y el contenido de un documento. Si se especifica la opción "Actualizar versión actual", el documento se reemplaza por uno nuevo y se mantiene el perfil del documento anterior. Si se especifica "Crear nueva versión", se crea una nueva versión del documento que hereda el perfil de la carpeta. Tras la ejecución correcta de la operación, se devuelve el perfil de documento. |
| Actualizar perfil de documento |
Realiza actualizaciones en el perfil de documento. Un documento no debe estar en uso al actualizar su perfil y no se puede actualizar el perfil de un documento que se desprotegió. Devuelve un perfil de documento actualizado después de la operación. |
| Actualizar permisos |
Actualiza los permisos de un objeto. |
| Actualizar área de trabajo |
Actualiza la información del área de trabajo especificada. Para eliminar el valor existente de un campo de cadena, establezca el valor del campo en una cadena vacía ajustada entre comillas simples o dobles. |
| Agregar entrada del historial de documentos |
Agrega una entrada como evento en el historial del documento. |
| Agregar referencia de documento |
Agrega referencia de documento o acceso directo a documentos en otra carpeta. |
| Buscar carpetas |
Busque carpetas. |
| Buscar usuarios |
Busca usuarios de iManage Work que coincidan con los criterios de búsqueda especificados. |
| Buscar valores de nodo de taxonomía de metadatos extendidos principales |
Busca los valores de nodo de taxonomía de metadatos extendidos principales que coinciden con los criterios de búsqueda especificados. |
| Búsqueda de áreas de trabajo |
Busque áreas de trabajo. |
| Cargar documento |
Carga un archivo como un nuevo documento en la carpeta especificada. |
| Copiar documento |
Copia un documento en la carpeta especificada. |
| Creación de un área de trabajo |
Crea una nueva área de trabajo basada en la plantilla seleccionada. Una plantilla de área de trabajo es un área de trabajo predefinida cuya estructura se copia en la nueva área de trabajo. Las restricciones en la plantilla de área de trabajo se aplican automáticamente al crear el área de trabajo. |
| Crear relación de documento |
Crea una relación entre documentos especificados en una biblioteca. |
| Descargar documento |
Descarga una versión de un documento específico, en función del identificador del documento. Si latest es true, se descarga la versión más reciente de este documento. La descarga es una secuencia y no se guarda localmente. |
| Editar pares nombre-valor |
Crea, actualiza o elimina las propiedades del par nombre-valor de un documento, una carpeta o un área de trabajo. Para eliminar un par nombre-valor, establezca el valor de la clave en una cadena vacía encapsulada entre comillas simples o dobles. |
| Eliminar documento |
Elimina el documento especificado. |
| Eliminar referencia de documento |
Elimina la referencia de documento de la carpeta especificada. |
| Eliminar relación de documento |
Elimina una relación entre los documentos especificados en una biblioteca. |
| Establecimiento de las propiedades de metadatos extendidas principales en un documento |
Establece las propiedades principales de metadatos extendidos en un documento. |
| Mover documento |
Mueve un documento a la carpeta especificada. |
| Obtención de detalles del usuario |
Obtiene información sobre un usuario de la biblioteca especificada. |
| Obtención de versiones de documentos |
Obtiene perfiles para todas las versiones a las que el usuario actual tiene acceso para un documento especificado. |
| Obtención del perfil del área de trabajo |
Obtiene el perfil del área de trabajo y, opcionalmente, la lista de operaciones permitidas para el área de trabajo. |
| Obtener administradores |
Obtiene una lista de administradores con determinados permisos para un documento, carpeta o área de trabajo. Un administrador de confianza puede ser un usuario o grupo. |
| Obtener bibliotecas |
Obtiene una lista de bibliotecas a las que el usuario tiene acceso. |
| Obtener clases |
Obtiene la lista de clases de documento disponibles en una biblioteca que coincida con los criterios especificados. |
| Obtener las propiedades principales de metadatos extendidos de un documento |
Obtiene las propiedades de metadatos extendidas principales de un documento. |
| Obtener miembros del grupo |
Obtenga los detalles de los usuarios que pertenecen al grupo especificado y que coincidan con los criterios especificados. |
| Obtener perfil de documento |
Obtiene las propiedades del documento asociadas a un identificador de documento específico. |
| Obtener permisos |
Obtiene las propiedades de permiso de acceso de usuario o grupo de un documento, carpeta o área de trabajo. Las propiedades de respuesta pueden variar con permisos de usuario o grupo. |
| Obtener plantillas de área de trabajo |
Obtiene la lista de plantillas disponibles en una biblioteca. Una plantilla de área de trabajo es un área de trabajo predefinida cuya estructura se copia para la nueva área de trabajo. |
| Obtener subclases |
Obtiene todas las subclases de biblioteca que coinciden con los criterios especificados. |
| Permisos de copia |
Copia los permisos de acceso y, opcionalmente, la seguridad predeterminada, de un objeto iManage Work a otro. "Tipo de copia" proporciona opciones para controlar la combinación de permisos de origen y destino. "Sobrescribir" actualiza los niveles de permisos, grupos y usuarios del objeto de destino para que coincidan exactamente con los del objeto de origen. 'Merge' mantiene todos los usuarios y grupos en el objeto de destino y los combina con el origen, pero en caso de conflicto de nivel de permiso en un grupo o individual: 'Merge (Pessimistic)' toma el permiso inferior, mientras que 'Merge (Optimista)' toma el permiso más alto para el usuario o grupo en conflicto. |
| Promover la versión del documento |
Promueve una versión existente de un documento a la versión más reciente. Se crea una nueva versión a partir de un identificador de diario o una versión especificados y, a continuación, se promueve a la versión más reciente. Debe especificar el identificador de diario o la versión, pero no ambos. |
Actualización de la seguridad predeterminada
Actualiza la seguridad predeterminada de un documento, una carpeta o un área de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Especifica el tipo de objeto. |
|
Id. de objeto
|
objectId | True | string |
Especifica el identificador del documento, la carpeta o el área de trabajo. Un ejemplo de un identificador de documento es "ACTIVE_US!453.1". Un ejemplo de un identificador de carpeta o área de trabajo es "ACTIVE_US!123". |
|
Seguridad predeterminada
|
default_security | True | string |
Especifica la seguridad predeterminada para el objeto . |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Seguridad predeterminada
|
data.default_security | string |
Indica la seguridad predeterminada del objeto. Los valores posibles son "inherit", "public", "view" o "private". |
|
Permisos de acceso
|
data.acl | AccessPermissions |
Indica una colección de permisos de acceso para uno o varios usuarios o grupos. |
Actualizar el estado del flujo de trabajo
Actualiza el estado de una ejecución de flujo de trabajo. Esta acción solo se puede usar en un flujo de trabajo que se ha creado para empezar con un desencadenador proporcionado por iManage.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de la biblioteca para la que se define el flujo de trabajo. |
|
Estado
|
state | True | string |
Especifica el estado actual de la ejecución del flujo de trabajo. |
|
Estado
|
status | string |
Especifica el estado actual de la ejecución del flujo de trabajo. La longitud máxima es de 128 caracteres. |
|
|
Mensaje de estado
|
statusMessage | string |
Especifica el mensaje personalizado para el estado actual de la ejecución del flujo de trabajo. La longitud máxima es de 256 caracteres. |
Devoluciones
- response
- object
Actualizar la versión actual o crear un nuevo documento
Actualiza la versión especificada de un documento o crea una nueva versión. Esta acción puede actualizar el perfil y el contenido de un documento. Si se especifica la opción "Actualizar versión actual", el documento se reemplaza por uno nuevo y se mantiene el perfil del documento anterior. Si se especifica "Crear nueva versión", se crea una nueva versión del documento que hereda el perfil de la carpeta. Tras la ejecución correcta de la operación, se devuelve el perfil de documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Actualizar o crear una nueva versión
|
updateOrCreate | True | string |
Especifica para actualizar la versión actual del documento o para crear una nueva versión. |
|
Identificador de documento existente
|
documentId | True | string |
Especifica el identificador del documento existente. Por ejemplo, "ACTIVE_US!556.1". |
|
Mantener bloqueado
|
keep_locked | boolean |
Especifica si se mantiene un bloqueo de documento después de la carga. |
|
|
Comentario
|
comment | string |
Especifica información adicional sobre la actualización. |
|
|
Nombre del documento
|
name | string |
Especifica el nombre del documento. |
|
|
Autor
|
author | string |
Especifica el identificador de trabajo de iManage del usuario que creó el documento. |
|
|
Operator
|
operator | string |
Especifica el identificador del usuario que tiene el documento desprotegido o está editando el perfil del documento. Por ejemplo, "JSMITH". |
|
|
Class
|
class | string |
Especifica la clase para identificar y diferenciar el documento. La clase de documento se clasifica por género, departamento, región, etc. |
|
|
Subclase
|
subclass | string |
Especifica la subclase para identificar y diferenciar el documento. La subclase de documentos se clasifica por género, departamento, región, etc. |
|
|
Seguridad predeterminada
|
default_security | string |
Especifica el nivel de acceso de seguridad predeterminado. Los valores posibles son "inherit", "private", "view", "public". |
|
|
¿Es HIPAA?
|
is_hipaa | boolean |
Especifica si el documento se va a cifrar. |
|
|
Conservar días
|
retain_days | integer |
Especifica el número de días que un documento debe estar inactivo antes de marcarlo para el archivado. |
|
|
Contenido del archivo
|
file | True | file |
Especifica el contenido del archivo. |
|
Fecha de creación del archivo
|
file_create_date | date-time |
Especifica la fecha y hora (en formato ISO 8601) que se creó el archivo. El archivo podría haberse creado fuera del sistema iManage Work. Esta fecha puede ser diferente de "create_date". El create_date es la fecha en que el sistema iManage Work creó o importó el archivo. |
|
|
Fecha de edición de archivo
|
file_edit_date | date-time |
Especifica la fecha y hora (en formato ISO 8601) del cambio más reciente al archivo. El archivo podría haber cambiado antes de cargarse en el sistema iManage Work. |
|
|
Custom1
|
custom1 | string |
Especifica el valor de custom1. |
|
|
Custom2
|
custom2 | string |
Especifica el valor de custom2. Para especificar un valor para custom2, también debe especificar un valor para custom1 en la misma solicitud, que se debe a su relación primario-secundario. |
|
|
Custom3
|
custom3 | string |
Especifica el valor de custom3. |
|
|
Custom4
|
custom4 | string |
Especifica el valor de custom4. |
|
|
Custom5
|
custom5 | string |
Especifica el valor de custom5. |
|
|
Custom6
|
custom6 | string |
Especifica el valor de custom6. |
|
|
Custom7
|
custom7 | string |
Especifica el valor de custom7. |
|
|
Custom8
|
custom8 | string |
Especifica el valor de custom8. |
|
|
Custom9
|
custom9 | string |
Especifica el valor de custom9. |
|
|
Custom10
|
custom10 | string |
Especifica el valor de custom10. |
|
|
Custom11
|
custom11 | string |
Especifica el valor de custom11. |
|
|
Custom12
|
custom12 | string |
Especifica el valor de custom12. |
|
|
Custom13
|
custom13 | string |
Especifica el valor de custom13. |
|
|
Custom14
|
custom14 | string |
Especifica el valor de custom14. |
|
|
Custom15
|
custom15 | string |
Especifica el valor de custom15. |
|
|
Custom16
|
custom16 | string |
Especifica el valor de custom16. |
|
|
Custom17
|
custom17 | double |
Especifica el valor de custom17. |
|
|
Custom18
|
custom18 | double |
Especifica el valor de custom18. |
|
|
Custom19
|
custom19 | double |
Especifica el valor de custom19. |
|
|
Custom20
|
custom20 | double |
Especifica el valor de custom20. |
|
|
Custom21
|
custom21 | string |
Especifica el valor de custom21 en formato datetime ISO 8601. |
|
|
Custom22
|
custom22 | string |
Especifica el valor de custom22 en formato datetime ISO 8601. |
|
|
Custom23
|
custom23 | string |
Especifica el valor de custom23 en formato datetime ISO 8601. |
|
|
Custom24
|
custom24 | string |
Especifica el valor de custom24 en formato datetime ISO 8601. |
|
|
Custom25
|
custom25 | boolean |
Especifica el valor de custom25. |
|
|
Custom26
|
custom26 | boolean |
Especifica el valor de custom26. |
|
|
Custom27
|
custom27 | boolean |
Especifica el valor de custom27. |
|
|
Custom28
|
custom28 | boolean |
Especifica el valor de custom28. |
|
|
Custom29
|
custom29 | string |
Especifica el valor de custom29. |
|
|
Custom30
|
custom30 | string |
Especifica el valor de custom30. Para especificar un valor para custom30, también debe especificar un valor para custom29 en la misma solicitud, que se debe a su relación de elementos primarios y secundarios. |
Actualizar perfil de documento
Realiza actualizaciones en el perfil de documento. Un documento no debe estar en uso al actualizar su perfil y no se puede actualizar el perfil de un documento que se desprotegió. Devuelve un perfil de documento actualizado después de la operación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Alias
|
alias | string |
Especifica el alias de este documento. |
|
|
Autor
|
author | string |
Especifica el identificador del usuario que creó el documento. Por ejemplo, "JSMITH". |
|
|
Comentario
|
comment | string |
Especifica información adicional sobre el documento. |
|
|
Seguridad predeterminada del documento
|
default_security | string |
Especifica el nivel de acceso de seguridad predeterminado. |
|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Se declara
|
is_declared | boolean |
Especifica si el documento se va a declarar como un registro. Un documento declarado como registro no se puede editar ni eliminar, excepto por un administrador del sistema iManage Work. |
|
|
¿Es HIPAA?
|
is_hipaa | boolean |
Especifica si el documento se va a cifrar. |
|
|
Comentario de auditoría
|
audit_comment | string |
Especifica información adicional sobre la actualización del perfil de documento. |
|
|
Clase Document
|
class | string |
Especifica la clase de documento. |
|
|
Nombre del documento
|
name | string |
Especifica el nombre de archivo del documento. |
|
|
Operator
|
operator | string |
Especifica el identificador del usuario que tiene el documento desprotegido o está editando el perfil del documento. Por ejemplo, "JSMITH". |
|
|
Conservar días
|
retain_days | integer |
Especifica el número de días antes de que el documento inactivo sea apto para el archivado. |
|
|
Subclase
|
subclass | string |
Especifica la subclase del documento. |
|
|
Custom1
|
custom1 | string |
Especifica el valor de custom1. |
|
|
Custom2
|
custom2 | string |
Especifica el valor de custom2. Para especificar un valor para custom2, también debe especificar un valor para custom1 en la misma solicitud, que se debe a su relación primario-secundario. |
|
|
Custom3
|
custom3 | string |
Especifica el valor de custom3. |
|
|
Custom4
|
custom4 | string |
Especifica el valor de custom4. |
|
|
Custom5
|
custom5 | string |
Especifica el valor de custom5. |
|
|
Custom6
|
custom6 | string |
Especifica el valor de custom6. |
|
|
Custom7
|
custom7 | string |
Especifica el valor de custom7. |
|
|
Custom8
|
custom8 | string |
Especifica el valor de custom8. |
|
|
Custom9
|
custom9 | string |
Especifica el valor de custom9. |
|
|
Custom10
|
custom10 | string |
Especifica el valor de custom10. |
|
|
Custom11
|
custom11 | string |
Especifica el valor de custom11. |
|
|
Custom12
|
custom12 | string |
Especifica el valor de custom12. |
|
|
Custom13
|
custom13 | string |
Especifica el valor de custom13. |
|
|
Custom14
|
custom14 | string |
Especifica el valor de custom14. |
|
|
Custom15
|
custom15 | string |
Especifica el valor de custom15. |
|
|
Custom16
|
custom16 | string |
Especifica el valor de custom16. |
|
|
Custom17
|
custom17 | double |
Especifica el valor de custom17. |
|
|
Custom18
|
custom18 | double |
Especifica el valor de custom18. |
|
|
Custom19
|
custom19 | double |
Especifica el valor de custom19. |
|
|
Custom20
|
custom20 | double |
Especifica el valor de custom20. |
|
|
Custom21
|
custom21 | string |
Especifica el valor de la propiedad custom21 en formato datetime ISO 8601. |
|
|
Custom22
|
custom22 | string |
Especifica el valor de la propiedad custom22 en formato datetime ISO 8601. |
|
|
Custom23
|
custom23 | string |
Especifica el valor de la propiedad custom23 en formato datetime ISO 8601. |
|
|
Custom24
|
custom24 | string |
Especifica el valor de la propiedad custom24 en formato datetime ISO 8601. |
|
|
Custom25
|
custom25 | boolean |
Especifica el valor de custom25. |
|
|
Custom26
|
custom26 | boolean |
Especifica el valor de custom26. |
|
|
Custom27
|
custom27 | boolean |
Especifica el valor de custom27. |
|
|
Custom28
|
custom28 | boolean |
Especifica el valor de custom28. |
|
|
Custom29
|
custom29 | string |
Especifica el valor de custom29. |
|
|
Custom30
|
custom30 | string |
Especifica el valor de custom30. Para especificar un valor para custom30, también debe especificar un valor para custom29 en la misma solicitud, que se debe a su relación de elementos primarios y secundarios. |
Actualizar permisos
Actualiza los permisos de un objeto.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Especifica el tipo de objeto. |
|
Id. de objeto
|
objectId | True | string |
Especifica el identificador del documento, la carpeta o el área de trabajo. Un ejemplo de un identificador de documento es "ACTIVE_US!453.1". Un ejemplo de un identificador de carpeta o área de trabajo es "ACTIVE_US!123". |
|
Nivel de entrada
|
access_level | True | string |
Especifica el nivel de acceso. |
|
Users
|
users | string |
Especifica uno o varios usuarios para establecer el nivel de acceso, separados por un punto y coma. |
|
|
Groups
|
groups | string |
Especifica uno o varios grupos para establecer el nivel de acceso, separados por un punto y coma. |
Devoluciones
Actualizar área de trabajo
Actualiza la información del área de trabajo especificada. Para eliminar el valor existente de un campo de cadena, establezca el valor del campo en una cadena vacía ajustada entre comillas simples o dobles.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID del espacio de trabajo
|
id | True | string |
Especifica el identificador del área de trabajo que se va a actualizar. Por ejemplo, "ACTIVE_US!427". |
|
Nombre
|
name | string |
Especifica el nombre del área de trabajo. |
|
|
Propietario del área de trabajo
|
owner | string |
Especifica el propietario del área de trabajo. |
|
|
Custom1
|
custom1 | string |
Especifica el valor de custom1. |
|
|
Custom2
|
custom2 | string |
Especifica el valor de custom2. Para especificar un valor para custom2, también debe especificar un valor para custom1 en la misma solicitud, que se debe a su relación primario-secundario. |
|
|
Custom3
|
custom3 | string |
Especifica el valor de custom3. |
|
|
Custom4
|
custom4 | string |
Especifica el valor de custom4. |
|
|
Custom5
|
custom5 | string |
Especifica el valor de custom5. |
|
|
Custom6
|
custom6 | string |
Especifica el valor de custom6. |
|
|
Custom7
|
custom7 | string |
Especifica el valor de custom7. |
|
|
Custom8
|
custom8 | string |
Especifica el valor de custom8. |
|
|
Custom9
|
custom9 | string |
Especifica el valor de custom9. |
|
|
Custom10
|
custom10 | string |
Especifica el valor de custom10. |
|
|
Custom11
|
custom11 | string |
Especifica el valor de custom11. |
|
|
Custom12
|
custom12 | string |
Especifica el valor de custom12. |
|
|
Custom13
|
custom13 | string |
Especifica el valor de custom13. |
|
|
Custom14
|
custom14 | string |
Especifica el valor de custom14. |
|
|
Custom15
|
custom15 | string |
Especifica el valor de custom15. |
|
|
Custom16
|
custom16 | string |
Especifica el valor de custom16. |
|
|
Custom17
|
custom17 | double |
Especifica el valor de custom17. |
|
|
Custom18
|
custom18 | double |
Especifica el valor de custom18. |
|
|
Custom19
|
custom19 | double |
Especifica el valor de custom19. |
|
|
Custom20
|
custom20 | double |
Especifica el valor de custom20. |
|
|
Custom21
|
custom21 | string |
Especifica el valor de custom21, en formato datetime ISO 8601. |
|
|
Custom22
|
custom22 | string |
Especifica el valor de custom22, en formato datetime ISO 8601. |
|
|
Custom23
|
custom23 | string |
Especifica el valor de custom23, en formato datetime ISO 8601. |
|
|
Custom24
|
custom24 | string |
Especifica el valor de custom24, en formato datetime ISO 8601. |
|
|
Custom25
|
custom25 | boolean |
Especifica el valor de custom25. |
|
|
Custom26
|
custom26 | boolean |
Especifica el valor de custom26. |
|
|
Custom27
|
custom27 | boolean |
Especifica el valor de custom27. |
|
|
Custom28
|
custom28 | boolean |
Especifica el valor de custom28. |
|
|
Custom29
|
custom29 | string |
Especifica el valor de custom29. |
|
|
Custom30
|
custom30 | string |
Especifica el valor de custom30. Para especificar un valor para custom30, también debe especificar un valor para custom29 en la misma solicitud, que se debe a su relación de elementos primarios y secundarios. |
|
|
Seguridad predeterminada
|
default_security | string |
Especifica el nivel de acceso de seguridad predeterminado. |
|
|
Description
|
description | string |
Especifica información adicional sobre el área de trabajo. |
|
|
Es externo como normal
|
is_external_as_normal | boolean |
Especifica si el área de trabajo se puede tratar como un área de trabajo pública. Si se establece en "true" y "default_security" no es "private", "is_external" se establece en "true". |
|
|
Project Custom1
|
project_custom1 | string |
Especifica información adicional sobre el área de trabajo. Este campo es diferente del campo personalizado de metadatos asociado a elementos de contenido, como documentos, áreas de trabajo o carpetas. Se trata de texto descriptivo que no tiene que dar formato y no se valida. |
|
|
Project Custom2
|
project_custom2 | string |
Especifica información adicional sobre el área de trabajo. Este campo es diferente del campo personalizado de metadatos asociado a elementos de contenido, como documentos, áreas de trabajo o carpetas. Se trata de texto descriptivo que no tiene que dar formato y no se valida. |
|
|
Project Custom3
|
project_custom3 | string |
Especifica información adicional sobre el área de trabajo. Este campo es diferente del campo personalizado de metadatos asociado a elementos de contenido, como documentos, áreas de trabajo o carpetas. Se trata de texto descriptivo que no tiene que dar formato y no se valida. |
|
|
Subclase del área de trabajo
|
subclass | string |
Especifica la subclase del área de trabajo en función de la subclase del documento que contiene. |
Agregar entrada del historial de documentos
Agrega una entrada como evento en el historial del documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Activity
|
activity_code | True | integer |
Especifica el tipo de actividad realizada en el documento. |
|
Comentarios
|
comments | string |
Especifica cualquier información adicional sobre la actividad. |
|
|
Duración
|
duration | integer |
Especifica el número de segundos que el usuario ha dedicado a trabajar en el documento. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | object |
Agregar referencia de documento
Agrega referencia de documento o acceso directo a documentos en otra carpeta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Id. de carpeta
|
folderId | True | string |
Especifica el identificador de la carpeta. Por ejemplo, "ACTIVE_US!773". |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de referencia del documento
|
data.id | string |
Indica la referencia del documento y document_shortcut. |
|
Wstype
|
data.wstype | string |
Indica el tipo de trabajo iManage del objeto . Los valores posibles son "document", "document_shortcut", "email". |
Buscar carpetas
Busque carpetas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de biblioteca de la carpeta de destino. |
|
ID de contenedor
|
container_id | string |
Especifica el identificador del área de trabajo o carpeta desde la que se van a devolver carpetas. Por ejemplo, "ACTIVE_US!987". Si se proporciona este parámetro, solo devuelve carpetas del área de trabajo o carpeta especificadas. |
|
|
Descripción de la carpeta
|
description | string |
Especifica un valor que se va a encontrar en la propiedad description de la carpeta. Esta búsqueda no distingue mayúsculas de minúsculas. Se admiten coincidencias parciales. |
|
|
Dirección de correo electrónico de carpeta
|
string |
Especifica la dirección de correo electrónico que debe coincidir con la dirección de correo electrónico de la carpeta. Por ejemplo, "email1234@ajubalaw.com". |
||
|
Nombre de carpeta
|
name | string |
Especifica un valor que se va a encontrar en la propiedad name de la carpeta. Esta búsqueda no distingue mayúsculas de minúsculas. Se admiten coincidencias parciales. |
|
|
Propietario de la carpeta
|
owner | string |
Especifica la cadena que debe coincidir con el propietario asociado a la carpeta . Esta búsqueda no distingue mayúsculas de minúsculas. Se admiten coincidencias parciales. |
|
|
Nombre del área de trabajo
|
workspace_name | string |
Especifica el nombre del área de trabajo primaria a la que pertenece la carpeta. Esta búsqueda no distingue mayúsculas de minúsculas. Se admiten coincidencias parciales. |
Buscar usuarios
Busca usuarios de iManage Work que coincidan con los criterios de búsqueda especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de correo electrónico
|
string |
Especifica el identificador de correo electrónico que se va a buscar. Por ejemplo, "JSMITH@XYZ.COM". |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Permitir inicio de sesión
|
data.topMatchingUser.allow_logon | boolean |
Indica si el usuario puede iniciar sesión. |
|
Custom1
|
data.topMatchingUser.custom1 | string |
Indica información adicional sobre el usuario. |
|
Custom2
|
data.topMatchingUser.custom2 | string |
Indica información adicional sobre el usuario. |
|
Custom3
|
data.topMatchingUser.custom3 | string |
Indica información adicional sobre el usuario. |
|
Id. de directorio
|
data.topMatchingUser.directory_id | string |
Indica el identificador de un directorio externo (como ADFS), que se usa para la sincronización de perfiles de usuario. |
|
Nombre distintivo
|
data.topMatchingUser.distinguished_name | string |
Indica el nombre del objeto que representa la ruta de acceso completa de los nombres que rastrean la entrada de nuevo a la raíz del árbol LDAP. |
|
Fecha de edición
|
data.topMatchingUser.edit_date | string |
Indica la fecha y hora (en formato ISO 8601) del cambio más reciente al perfil de usuario. |
|
Correo Electrónico
|
data.topMatchingUser.email | string |
Indica el identificador de correo electrónico del usuario. |
|
Dirección URL de detección automática de Exchange
|
data.topMatchingUser.exch_autodiscover | string |
Indica los detalles del servidor exchange del usuario. |
|
Extension
|
data.topMatchingUser.extension | string |
Indica la extensión de número de teléfono del usuario. |
|
Intentos de inicio de sesión erróneos
|
data.topMatchingUser.failed_logins | integer |
Indica el número actual de intentos de inicio de sesión erróneos del usuario. |
|
Fax
|
data.topMatchingUser.fax | string |
Indica el número de fax del usuario. |
|
Forzar el cambio de contraseña
|
data.topMatchingUser.force_password_change | boolean |
Indica que el usuario debe cambiar su contraseña en el siguiente inicio de sesión. Solo se aplica a los usuarios virtuales, indicados por el valor "user_nos" "2". |
|
Nombre completo
|
data.topMatchingUser.full_name | string |
Indica el nombre completo del usuario. |
|
General
|
data.topMatchingUser.general | string |
Indica información general sobre el usuario. |
|
identificación
|
data.topMatchingUser.id | string |
Indica el identificador del usuario. Por ejemplo, "JSMITH". |
|
Es externo
|
data.topMatchingUser.is_external | boolean |
Indica un usuario externo. Un usuario externo tiene acceso limitado y se usa normalmente para miembros temporales del equipo, consultores o aquellos externos a la organización. |
|
Hora de la última sincronización
|
data.topMatchingUser.last_sync_ts | string |
Indica la hora de la última sincronización (en formato de fecha y hora ISO 8601) del perfil del usuario con un directorio externo, como LDAP o Microsoft Active Directory (ADFS). |
|
Ubicación
|
data.topMatchingUser.location | string |
Indica la ubicación geográfica del usuario. |
|
La contraseña nunca expira
|
data.topMatchingUser.password_never_expire | boolean |
Indica si la contraseña del usuario nunca expira. |
|
Número de teléfono
|
data.topMatchingUser.phone | string |
Indica el número de teléfono del usuario. |
|
Biblioteca preferida
|
data.topMatchingUser.preferred_library | string |
Indica la biblioteca preferida. Una biblioteca preferida es la biblioteca predeterminada del usuario. Cada usuario debe tener una biblioteca preferida. |
|
Hora de cambio de contraseña
|
data.topMatchingUser.pwd_changed_ts | string |
Indica la hora (en formato de fecha y hora ISO 8601) cuando se cambió por última vez la contraseña del usuario. Esto solo es aplicable a los usuarios virtuales (cuyo usuario NOS es 2). |
|
SSID
|
data.topMatchingUser.ssid | string |
Indica el identificador único generado por el sistema para el usuario. |
|
Dominio
|
data.topMatchingUser.user_domain | string |
Indica el nombre de dominio completo para el servicio de directorio del usuario. |
|
Identificador extendido
|
data.topMatchingUser.user_id_ex | string |
Indica el valor original del identificador de usuario que se recibe de un directorio externo, como Microsoft Active Directory (ADFS). |
|
NOS
|
data.topMatchingUser.user_nos | integer |
Indica el tipo de sistema operativo desde el que se sincroniza el usuario. Los valores posibles son 2 (usuario virtual) y 6 (usuario empresarial). Para obtener más información, póngase en contacto con el administrador del sistema iManage Work. |
|
Number
|
data.topMatchingUser.user_num | integer |
Indica el identificador numérico del sistema del usuario. |
|
results
|
data.results | array of UserProfileInArray |
Buscar valores de nodo de taxonomía de metadatos extendidos principales
Busca los valores de nodo de taxonomía de metadatos extendidos principales que coinciden con los criterios de búsqueda especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de la biblioteca en la que se va a realizar la búsqueda. |
|
Taxonomy (propiedad)
|
taxonomyProperty | True | string |
Especifica la propiedad taxonomía para la que buscar valores de nodo. |
|
identificación
|
id | string |
Especifica el identificador para mostrar del valor del nodo de taxonomía. Esta búsqueda no distingue mayúsculas de minúsculas. No se admiten coincidencias parciales. |
|
|
Query
|
query | string |
Especifica una consulta para buscar valores de nodo de taxonomía coincidentes mediante una búsqueda con caracteres comodín (*) y proporciona coincidencias parciales para el identificador para mostrar o la descripción. |
|
|
Estado del nodo
|
enabled_state | string |
Especifica que solo se devuelvan valores de nodo de taxonomía habilitados o deshabilitados o ambos. |
|
|
Ruta de acceso de inclusión
|
include_path | boolean |
Especifica que se devuelve la ruta de acceso completa al valor de nodo coincidente. Una ruta de acceso es una lista ordenada que comienza con el nodo de nivel superior en la taxonomía y, a continuación, todos los nodos a través del elemento primario inmediato del nodo coincidente. |
|
|
SSID del nodo antecesor
|
children_of_ssid | string |
Especifica el identificador único generado por el sistema del nodo de taxonomía antecesor para limitar la búsqueda. |
|
|
Solo elementos secundarios inmediatos
|
immediate_children_only | boolean |
Especifica para limitar los resultados de búsqueda a descendientes directos del nodo de taxonomía especificado por "SSID del nodo antecesor". La búsqueda se puede limitar al nivel raíz de la taxonomía especificando una cadena vacía para "SSID del nodo antecesor" encapsulado entre comillas simples o dobles. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
SSID
|
data.topMatchingResult.created_by.ssid | string |
Indica el identificador único generado por el sistema para el usuario que creó el valor de nodo coincidente superior. |
|
Fecha de creación
|
data.topMatchingResult.create_date | string |
Indica la fecha y hora (en formato ISO 8601) que se creó el valor de nodo coincidente superior. |
|
Description
|
data.topMatchingResult.description | string |
Indica la descripción del valor de nodo coincidente superior. |
|
SSID
|
data.topMatchingResult.edited_by.ssid | string |
Indica el identificador único generado por el sistema para el usuario que editó por última vez el valor de nodo coincidente superior. |
|
Fecha de edición
|
data.topMatchingResult.edit_date | string |
Indica la fecha y hora (en formato ISO 8601) el valor del nodo coincidente superior se editó por última vez. |
|
Está habilitado
|
data.topMatchingResult.enabled | boolean |
Indica si el valor del nodo coincidente superior está habilitado. |
|
identificación
|
data.topMatchingResult.id | string |
Indica el identificador para mostrar del valor de nodo coincidente superior. |
|
SSID
|
data.topMatchingResult.parent.ssid | string |
Indica el identificador único generado por el sistema para el nodo primario inmediato del valor de nodo coincidente superior. |
|
SSID
|
data.topMatchingResult.ssid | string |
Indica el identificador único generado por el sistema para el valor de nodo coincidente superior. |
|
Ruta
|
data.topMatchingResult.path | array of object |
Indica la ruta de acceso completa al valor del nodo coincidente superior. Una ruta de acceso es una lista ordenada que comienza con el nodo de nivel superior en la taxonomía y, a continuación, todos los nodos a través del elemento primario inmediato del nodo coincidente. |
|
Cada identificador
|
data.topMatchingResult.path.id | string |
Indica el identificador para mostrar de un valor de nodo en la ruta de acceso del nodo coincidente superior. |
|
Cada SSID
|
data.topMatchingResult.path.ssid | string |
Indica el identificador único generado por el sistema para un valor de nodo en la ruta de acceso del nodo coincidente superior. |
|
Resultados de búsqueda de taxonomía de metadatos extendidos principales
|
data.results | array of TaxonomyNodeValue |
Indica uno o varios valores de nodo de taxonomía de metadatos extendidos principales que coinciden con la búsqueda. |
|
Todos los SSID de nodo de taxonomía
|
data.all_taxonomy_ssids | string |
Indica una lista de todos los SSID de nodo de taxonomía, concatenados como una cadena y separados por punto y coma. |
Búsqueda de áreas de trabajo
Busque áreas de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de biblioteca del área de trabajo de destino. |
|
Title
|
name | string |
Especifica la cadena que se va a buscar en la propiedad name del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. |
|
|
Propietario
|
owner | string |
Especifica la cadena que debe coincidir con el propietario asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. |
|
|
Keyword
|
anywhere | string |
Especifica el texto que se va a buscar en cualquier parte del perfil del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. |
|
|
Description
|
description | string |
Especifica el texto que se va a buscar en la propiedad description del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. |
|
|
Subclase
|
subclass | string |
Especifica un valor que debe coincidir con el valor de subclase asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. |
|
|
Custom1
|
custom1 | string |
Especifica un valor que debe coincidir con el valor custom1 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom2
|
custom2 | string |
Especifica un valor que debe coincidir con el valor custom2 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom3
|
custom3 | string |
Especifica un valor que debe coincidir con el valor custom3 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom4
|
custom4 | string |
Especifica un valor que debe coincidir con el valor custom4 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom5
|
custom5 | string |
Especifica un valor que debe coincidir con el valor custom5 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom6
|
custom6 | string |
Especifica un valor que debe coincidir con el valor custom6 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom7
|
custom7 | string |
Especifica un valor que debe coincidir con el valor custom7 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom8
|
custom8 | string |
Especifica un valor que debe coincidir con el valor custom8 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom9
|
custom9 | string |
Especifica un valor que debe coincidir con el valor personalizado9 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom10
|
custom10 | string |
Especifica un valor que debe coincidir con el valor custom10 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom11
|
custom11 | string |
Especifica un valor que debe coincidir con el valor custom11 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom12
|
custom12 | string |
Especifica un valor que debe coincidir con el valor custom12 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom13
|
custom13 | string |
Especifica un valor que debe coincidir con el valor custom13 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. Se admiten el carácter comodín (*) y las coincidencias parciales. |
|
|
Custom14
|
custom14 | string |
Especifica un valor que debe coincidir con el valor custom14 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. Se admiten el carácter comodín (*) y las coincidencias parciales. |
|
|
Custom15
|
custom15 | string |
Especifica un valor que debe coincidir con el valor custom15 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. Se admiten el carácter comodín (*) y las coincidencias parciales. |
|
|
Custom16
|
custom16 | string |
Especifica un valor que debe coincidir con el valor custom16 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. Se admiten el carácter comodín (*) y las coincidencias parciales. |
|
|
Custom17
|
custom17 | string |
Especifica un valor que debe coincidir con el valor custom17 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom18
|
custom18 | string |
Especifica un valor que debe coincidir con el valor custom18 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom19
|
custom19 | string |
Especifica un valor que debe coincidir con el valor custom19 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom20
|
custom20 | string |
Especifica un valor que debe coincidir con el valor custom20 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom21 (límite inferior)
|
custom21_from | string |
Especifica el límite inferior (en formato datetime ISO 8601) para buscar en la propiedad custom21 asociada al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom21 (límite superior)
|
custom21_to | string |
Especifica el límite superior (en formato datetime ISO 8601) para buscar en la propiedad custom21 asociada al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom22 (límite inferior)
|
custom22_from | string |
Especifica el límite inferior (en formato datetime ISO 8601) para buscar en la propiedad custom22 asociada al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom22 (límite superior)
|
custom22_to | string |
Especifica el límite superior (en formato datetime ISO 8601) para buscar en la propiedad custom22 asociada al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom23 (límite inferior)
|
custom23_from | string |
Especifica el límite inferior (en formato datetime ISO 8601) para buscar en la propiedad custom23 asociada al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom23 (límite superior)
|
custom23_to | string |
Especifica el límite superior (en formato datetime ISO 8601) para buscar en la propiedad custom23 asociada al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom24 (límite inferior)
|
custom24_from | string |
Especifica el límite inferior (en formato datetime ISO 8601) para buscar en la propiedad custom24 asociada al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom24 (límite superior)
|
custom24_to | string |
Especifica el límite superior (en formato datetime ISO 8601) para buscar en la propiedad custom24 asociada al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom25
|
custom25 | boolean |
Especifica un valor que debe coincidir con el valor custom25 asociado al área de trabajo. |
|
|
Custom26
|
custom26 | boolean |
Especifica un valor que debe coincidir con el valor custom26 asociado al área de trabajo. |
|
|
Custom27
|
custom27 | boolean |
Especifica un valor que debe coincidir con el valor custom27 asociado al área de trabajo. |
|
|
Custom28
|
custom28 | boolean |
Especifica un valor que debe coincidir con el valor custom28 asociado al área de trabajo. |
|
|
Custom29
|
custom29 | string |
Especifica un valor que debe coincidir con el valor custom29 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom30
|
custom30 | string |
Especifica un valor que debe coincidir con el valor custom30 asociado al área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. Para especificar un valor para custom30, también debe especificar un valor para custom29 en la misma solicitud, que se debe a su relación de elementos primarios y secundarios. |
Cargar documento
Carga un archivo como un nuevo documento en la carpeta especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de la biblioteca de destino. |
|
Id. de carpeta
|
folderId | True | string |
Especifica el identificador de carpeta de la carpeta de destino. Por ejemplo, "ACTIVE_US!987". |
|
Heredar perfil de carpeta
|
inherit_profile_from_folder | True | boolean |
Especifica si los datos del perfil se heredan de la carpeta primaria. |
|
Mantener bloqueado
|
keep_locked | boolean |
Especifica si se mantiene un bloqueo de documento después de la carga. |
|
|
Comentario
|
comment | string |
Especifica información adicional sobre la actualización. |
|
|
Autor
|
author | string |
Especifica el identificador de trabajo de iManage del usuario que creó el documento. |
|
|
Operator
|
operator | string |
Especifica el identificador del usuario que tiene el documento desprotegido o está editando el perfil del documento. Por ejemplo, "JSMITH". |
|
|
Class
|
class | string |
Especifica la clase para identificar y diferenciar el documento. La clase de documento se clasifica por género, departamento, región, etc. |
|
|
Subclase
|
subclass | string |
Especifica la subclase para identificar y diferenciar el documento. La subclase de documentos se clasifica por género, departamento, región, etc. |
|
|
Seguridad predeterminada
|
default_security | string |
Especifica el nivel de acceso de seguridad predeterminado. Los valores posibles son "inherit", "private", "view", "public". |
|
|
¿Es HIPAA?
|
is_hipaa | boolean |
Especifica si el documento se va a cifrar. |
|
|
Conservar días
|
retain_days | integer |
Especifica el número de días que un documento debe estar inactivo antes de marcarlo para el archivado. |
|
|
Contenido del archivo
|
file | True | file |
Especifica el contenido del archivo. |
|
Fecha de creación del archivo
|
file_create_date | date-time |
Especifica la fecha y hora (en formato ISO 8601) que se creó el archivo. El archivo podría haberse creado fuera del sistema iManage Work. Esta fecha puede ser diferente de "create_date". El create_date es la fecha en que el sistema iManage Work creó o importó el archivo. |
|
|
Fecha de edición de archivo
|
file_edit_date | date-time |
Especifica la fecha y hora (en formato ISO 8601) del cambio más reciente al archivo. El archivo podría haber cambiado antes de cargarse en el sistema iManage Work. |
|
|
Custom1
|
custom1 | string |
Especifica el valor de custom1. |
|
|
Custom2
|
custom2 | string |
Especifica el valor de custom2. Para especificar un valor para custom2, también debe especificar un valor para custom1 en la misma solicitud, que se debe a su relación primario-secundario. |
|
|
Custom3
|
custom3 | string |
Especifica el valor de custom3. |
|
|
Custom4
|
custom4 | string |
Especifica el valor de custom4. |
|
|
Custom5
|
custom5 | string |
Especifica el valor de custom5. |
|
|
Custom6
|
custom6 | string |
Especifica el valor de custom6. |
|
|
Custom7
|
custom7 | string |
Especifica el valor de custom7. |
|
|
Custom8
|
custom8 | string |
Especifica el valor de custom8. |
|
|
Custom9
|
custom9 | string |
Especifica el valor de custom9. |
|
|
Custom10
|
custom10 | string |
Especifica el valor de custom10. |
|
|
Custom11
|
custom11 | string |
Especifica el valor de custom11. |
|
|
Custom12
|
custom12 | string |
Especifica el valor de custom12. |
|
|
Custom13
|
custom13 | string |
Especifica el valor de custom13. |
|
|
Custom14
|
custom14 | string |
Especifica el valor de custom14. |
|
|
Custom15
|
custom15 | string |
Especifica el valor de custom15. |
|
|
Custom16
|
custom16 | string |
Especifica el valor de custom16. |
|
|
Custom17
|
custom17 | double |
Especifica el valor de custom17. |
|
|
Custom18
|
custom18 | double |
Especifica el valor de custom18. |
|
|
Custom19
|
custom19 | double |
Especifica el valor de custom19. |
|
|
Custom20
|
custom20 | double |
Especifica el valor de custom20. |
|
|
Custom21
|
custom21 | string |
Especifica el valor de custom21 en formato datetime ISO 8601. |
|
|
Custom22
|
custom22 | string |
Especifica el valor de custom22 en formato datetime ISO 8601. |
|
|
Custom23
|
custom23 | string |
Especifica el valor de custom23 en formato datetime ISO 8601. |
|
|
Custom24
|
custom24 | string |
Especifica el valor de custom24 en formato datetime ISO 8601. |
|
|
Custom25
|
custom25 | boolean |
Especifica el valor de custom25. |
|
|
Custom26
|
custom26 | boolean |
Especifica el valor de custom26. |
|
|
Custom27
|
custom27 | boolean |
Especifica el valor de custom27. |
|
|
Custom28
|
custom28 | boolean |
Especifica el valor de custom28. |
|
|
Custom29
|
custom29 | string |
Especifica el valor de custom29. |
|
|
Custom30
|
custom30 | string |
Especifica el valor de custom30. Para especificar un valor para custom30, también debe especificar un valor para custom29 en la misma solicitud, que se debe a su relación de elementos primarios y secundarios. |
Copiar documento
Copia un documento en la carpeta especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Id. de carpeta de destino
|
folderId | True | string |
Especifica el identificador de carpeta de destino al que se va a copiar el documento. Por ejemplo, "ACTIVE_US!987". |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Acceso a documentos
|
data.access | string |
Indica el conjunto de permisos de nivel de acceso para un documento o contenedor. El autor o un usuario establecen el nivel de acceso con acceso completo al elemento. Los valores posibles son "no_access", "read", "read_write", "full_access". |
|
Alias
|
data.alias | string |
Indica el alias de este documento. |
|
Autor
|
data.author | string |
Indica el identificador del usuario que creó el documento. Por ejemplo, "JSMITH". |
|
Descripción del autor
|
data.author_description | string |
Indica información adicional sobre el autor del documento. |
|
CC
|
data.cc | string |
Indica a los destinatarios a los que se copia el correo electrónico. Solo se aplica a los correos electrónicos. |
|
Clase Document
|
data.class | string |
Indica la clase del documento. |
|
Descripción de la clase document
|
data.class_description | string |
Indica información adicional sobre la clase de documento. |
|
Tipo de contenido
|
data.content_type | string |
Indica el tipo de contenido del documento. |
|
Fecha de creación del documento
|
data.create_date | string |
Indica la fecha y hora (en formato ISO 8601) que el documento se importó en el sistema iManage Work. Esta fecha puede ser diferente de "file_create_date". |
|
Base de datos
|
data.database | string |
Indica la biblioteca donde se almacena el documento. |
|
Seguridad predeterminada del documento
|
data.default_security | string |
Indica el nivel de acceso de seguridad predeterminado. Los valores posibles son "inherit", "private", "view", "public". |
|
Número de documento
|
data.document_number | integer |
Indica el número de documento de un documento. |
|
Dirección URL del documento
|
data.document_url | string |
Indica el vínculo que se puede compartir para el documento. |
|
Fecha de edición del documento
|
data.edit_date | string |
Indica la fecha y hora (en formato ISO 8601) del cambio más reciente al documento. |
|
Fecha de edición del perfil
|
data.edit_profile_date | string |
Indica la fecha y hora (en formato ISO 8601) del cambio más reciente al perfil de documento. |
|
Extensión de documento
|
data.extension | string |
Indica la extensión de nombre de archivo, también denominada extensión de aplicación, del documento. |
|
Fecha de creación del archivo
|
data.file_create_date | string |
Indica la fecha y hora (en formato ISO 8601) que se creó el archivo. Es posible que el archivo se haya creado fuera del sistema iManage Work. Esta fecha puede ser diferente de "create_date". |
|
Fecha de edición de archivos
|
data.file_edit_date | string |
Indica la fecha y hora (en formato ISO 8601) del cambio más reciente al archivo. Es posible que el archivo se haya cambiado antes de cargarse en el sistema iManage Work. |
|
De
|
data.from | string |
Indica el remitente del correo electrónico. Solo se aplica a los correos electrónicos. |
|
Nombre de archivo completo
|
data.full_file_name | string |
Indica el nombre de archivo completo del documento. Incluye la extensión de nombre de archivo. |
|
Tiene datos adjuntos
|
data.has_attachment | boolean |
Indica si el correo electrónico tiene datos adjuntos. Solo se aplica a los correos electrónicos. |
|
Propiedades básicas del documento
|
data.basic_properties | string |
Indica un elemento '' incrustable que contiene propiedades básicas del documento. |
|
Id. de documento
|
data.id | string |
Indica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Es indexable
|
data.indexable | boolean |
Indica si el sistema indexa el documento. |
|
Está desprotegido
|
data.is_checked_out | boolean |
Indica si el documento está desprotegido. |
|
Se declara
|
data.is_declared | boolean |
Indica si el documento se declara como un registro. Un documento declarado como registro no se puede editar ni eliminar, excepto por un administrador del sistema iManage Work. |
|
Es externo
|
data.is_external | boolean |
Indica si el documento se comparte con usuarios externos. |
|
Es externo como normal
|
data.is_external_as_normal | boolean |
Indica si el documento es externo como normal. |
|
¿Es HIPAA?
|
data.is_hipaa | boolean |
Indica si el documento está cifrado. |
|
Está en uso
|
data.is_in_use | boolean |
Indica si el documento está en uso. |
|
Vínculo de documento
|
data.iwl | string |
Indica el vínculo de trabajo iManage (iWL) para el documento. El iWL se usa para abrir el documento en modo de vista protegida por el usuario que tiene "read_write" o "full_access". |
|
Último usuario
|
data.last_user | string |
Indica el identificador del usuario que editó el documento más recientemente. Por ejemplo, "JSMITH". |
|
Descripción del último usuario
|
data.last_user_description | string |
Indica información adicional sobre el último usuario que editó el documento más recientemente. |
|
Nombre del documento
|
data.name | string |
Indica el nombre de archivo del documento. |
|
Operator
|
data.operator | string |
Indica el identificador del usuario que tiene el documento desprotegido o está editando su perfil. Por ejemplo, "JSMITH". |
|
Descripción del operador
|
data.operator_description | string |
Indica información adicional sobre el operador . |
|
Fecha de recepción
|
data.received_date | string |
Indica la fecha y hora (en formato ISO 8601) que se recibió el correo electrónico. Solo se aplica a los correos electrónicos. |
|
Conservar días
|
data.retain_days | integer |
Indica el número de días antes de que el documento sea apto para el archivado. Solo se aplica a los documentos inactivos. |
|
Fecha de envío
|
data.sent_date | string |
Indica la fecha y hora (en formato ISO 8601) que se envió el correo electrónico. Solo se aplica a los correos electrónicos. |
|
Tamaño del documento
|
data.size | integer |
Indica el tamaño del documento en bytes. |
|
Subclase
|
data.subclass | string |
Indica la subclase del documento. |
|
Descripción de la subclase
|
data.subclass_description | string |
Indica información adicional sobre la subclase del documento. |
|
Para
|
data.to | string |
Indica el destinatario del correo electrónico. Solo se aplica a los correos electrónicos. |
|
Tipo
|
data.type | string |
Indica el tipo de documento. Por ejemplo, WORD para Microsoft Word. Para obtener una lista actual de tipos, póngase en contacto con el administrador del sistema iManage Work. |
|
Descripción del tipo
|
data.type_description | string |
Indica información adicional sobre el tipo del documento. |
|
Versión del documento
|
data.version | integer |
Indica el número de versión del documento. |
|
ID del espacio de trabajo
|
data.workspace_id | string |
Indica el identificador del área de trabajo del documento. Por ejemplo, "ACTIVE_US!427". |
|
Nombre del área de trabajo
|
data.workspace_name | string |
Indica el nombre del área de trabajo del documento. |
|
Wstype
|
data.wstype | string |
Indica el tipo de trabajo iManage del objeto . Los valores posibles son "document", "folder", "workspace", "email", "document_shortcut", "folder_shortcut", "workspace_shortcut", "user". |
|
Custom13
|
data.custom13 | string |
Indica el valor de custom13. |
|
Custom14
|
data.custom14 | string |
Indica el valor de custom14. |
|
Custom15
|
data.custom15 | string |
Indica el valor de custom15. |
|
Custom16
|
data.custom16 | string |
Indica el valor de custom16. |
|
Custom21
|
data.custom21 | string |
Indica el valor de la propiedad custom21 en formato datetime ISO 8601. |
|
Custom22
|
data.custom22 | string |
Indica el valor de la propiedad custom22 en formato datetime ISO 8601. |
Creación de un área de trabajo
Crea una nueva área de trabajo basada en la plantilla seleccionada. Una plantilla de área de trabajo es un área de trabajo predefinida cuya estructura se copia en la nueva área de trabajo. Las restricciones en la plantilla de área de trabajo se aplican automáticamente al crear el área de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de biblioteca del área de trabajo de destino. |
|
Template
|
templateId | True | string |
Especifica la plantilla de área de trabajo que se va a usar para crear el área de trabajo y sus elementos secundarios. |
|
Nombre
|
name | True | string |
Especifica el nombre del área de trabajo. |
|
Crear elementos secundarios
|
createChildren | True | string |
Especifica para crear todas las carpetas (opcionales y necesarias) o solo las carpetas necesarias. |
|
Propietario del área de trabajo
|
owner | string |
Especifica el propietario del área de trabajo. Debe ser administrador del sistema iManage Work para establecer el propietario de un área de trabajo. |
|
|
Seguridad predeterminada
|
default_security | string |
Especifica el nivel de acceso predeterminado. Si no se especifica, se usa el nivel de acceso predeterminado de la plantilla seleccionada. |
|
|
Description
|
description | string |
Especifica información adicional sobre el área de trabajo. |
|
|
Custom1
|
custom1 | string |
Especifica el valor de custom1 que se va a asociar al área de trabajo recién creada. Este valor invalida el valor custom1 del área de trabajo de plantilla seleccionada, si está presente. Si las carpetas secundarias tienen establecido un valor custom1, no se sobrescribe el valor custom1 de esas carpetas secundarias. |
|
|
Custom2
|
custom2 | string |
Especifica el valor de custom2 que se va a asociar al área de trabajo recién creada. Para especificar un valor para custom2, también debe especificar un valor para custom1 en la misma solicitud, que se debe a su relación primario-secundario. Este valor invalida el valor custom2 del área de trabajo de plantilla seleccionada, si está presente. Si las carpetas secundarias tienen establecido un valor custom2, el valor custom2 de esas carpetas secundarias no se sobrescribe. |
|
|
Custom3
|
custom3 | string |
Especifica el valor de custom3. |
|
|
Custom4
|
custom4 | string |
Especifica el valor de custom4. |
|
|
Custom5
|
custom5 | string |
Especifica el valor de custom5. |
|
|
Custom6
|
custom6 | string |
Especifica el valor de custom6. |
|
|
Custom7
|
custom7 | string |
Especifica el valor de custom7. |
|
|
Custom8
|
custom8 | string |
Especifica el valor de custom8. |
|
|
Custom9
|
custom9 | string |
Especifica el valor de custom9. |
|
|
Custom10
|
custom10 | string |
Especifica el valor de custom10. |
|
|
Custom11
|
custom11 | string |
Especifica el valor de custom11. |
|
|
Custom12
|
custom12 | string |
Especifica el valor de custom12. |
|
|
Custom13
|
custom13 | string |
Especifica el valor de custom13. |
|
|
Custom14
|
custom14 | string |
Especifica el valor de custom14. |
|
|
Custom15
|
custom15 | string |
Especifica el valor de custom15. |
|
|
Custom16
|
custom16 | string |
Especifica el valor de custom16. |
|
|
Custom17
|
custom17 | double |
Especifica el valor de custom17. |
|
|
Custom18
|
custom18 | double |
Especifica el valor de custom18. |
|
|
Custom19
|
custom19 | double |
Especifica el valor de custom19. |
|
|
Custom20
|
custom20 | double |
Especifica el valor de custom20. |
|
|
Custom21
|
custom21 | string |
Especifica el valor de custom21 en formato datetime ISO 8601. |
|
|
Custom22
|
custom22 | string |
Especifica el valor de custom22 en formato datetime ISO 8601. |
|
|
Custom23
|
custom23 | string |
Especifica el valor de custom23 en formato datetime ISO 8601. |
|
|
Custom24
|
custom24 | string |
Especifica el valor de custom24 en formato datetime ISO 8601. |
|
|
Custom25
|
custom25 | boolean |
Especifica el valor de custom25. |
|
|
Custom26
|
custom26 | boolean |
Especifica el valor de custom26. |
|
|
Custom27
|
custom27 | boolean |
Especifica el valor de custom27. |
|
|
Custom28
|
custom28 | boolean |
Especifica el valor de custom28. |
|
|
Custom29
|
custom29 | string |
Especifica el valor de custom29. |
|
|
Custom30
|
custom30 | string |
Especifica el valor de custom30. Para especificar un valor para custom30, también debe especificar un valor para custom29 en la misma solicitud, que se debe a su relación de elementos primarios y secundarios. |
|
|
Es externo como normal
|
is_external_as_normal | boolean |
Especifica que el área de trabajo se puede tratar como un área de trabajo pública. Si se establece en "true" y "default_security" no es "private", establece "is_external" en "true". |
|
|
Project Custom1
|
project_custom1 | string |
Especifica información adicional sobre el área de trabajo. Este campo es diferente del campo personalizado de metadatos asociado a elementos de contenido, como documentos, áreas de trabajo o carpetas. Se trata de texto descriptivo que no tiene que dar formato y no se valida. |
|
|
Project Custom2
|
project_custom2 | string |
Especifica información adicional sobre el área de trabajo. Este campo es diferente del campo personalizado de metadatos asociado a elementos de contenido, como documentos, áreas de trabajo o carpetas. Se trata de texto descriptivo que no tiene que dar formato y no se valida. |
|
|
Project Custom3
|
project_custom3 | string |
Especifica información adicional sobre el área de trabajo. Este campo es diferente del campo personalizado de metadatos asociado a elementos de contenido, como documentos, áreas de trabajo o carpetas. Se trata de texto descriptivo que no tiene que dar formato y no se valida. |
|
|
Subclase del área de trabajo
|
subclass | string |
Especifica la subclase del área de trabajo en función de la subclase del documento que contiene. |
Crear relación de documento
Crea una relación entre documentos especificados en una biblioteca.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento principal
|
primaryDocumentId | True | string |
Especifica el identificador del documento principal que se va a relacionar. Por ejemplo, "ACTIVE_US!453.1". |
|
Id. de documento relacionado
|
relatedDocumentId | True | string |
Especifica el identificador del documento que se va a relacionar. Por ejemplo, "ACTIVE_US!453.1". |
Devoluciones
- response
- object
Descargar documento
Descarga una versión de un documento específico, en función del identificador del documento. Si latest es true, se descarga la versión más reciente de este documento. La descarga es una secuencia y no se guarda localmente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_USE!453.1". |
|
Obtener la versión más reciente
|
latest | boolean |
Especifica para descargar la versión más reciente del documento. |
Devoluciones
Indica el contenido del archivo.
- Contenido del archivo
- binary
Editar pares nombre-valor
Crea, actualiza o elimina las propiedades del par nombre-valor de un documento, una carpeta o un área de trabajo. Para eliminar un par nombre-valor, establezca el valor de la clave en una cadena vacía encapsulada entre comillas simples o dobles.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Especifica el tipo de objeto. Los valores posibles son "document", "folder", "workspace". |
|
Id. de objeto
|
objectId | True | string |
Especifica el identificador del documento, la carpeta o el área de trabajo. Un ejemplo de un identificador de documento es "ACTIVE_US!453.1". Un ejemplo de un identificador de carpeta o área de trabajo es "ACTIVE_US!123". |
|
Pares nombre-valor
|
nameValuePairs | object |
Especifica los pares de nombre y valor de forma libre para este documento. |
Eliminar documento
Elimina el documento especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Eliminar todas las versiones
|
deleteAllVersions | True | boolean |
Especifica para eliminar todas las versiones del documento. |
Eliminar referencia de documento
Elimina la referencia de documento de la carpeta especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Id. de carpeta
|
folderId | True | string |
Especifica el identificador de la carpeta. Por ejemplo, "ACTIVE_US!773". |
Devoluciones
- response
- object
Eliminar relación de documento
Elimina una relación entre los documentos especificados en una biblioteca.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento principal
|
primaryDocumentId | True | string |
Especifica el identificador del documento principal. Por ejemplo, "ACTIVE_US!453.1". |
|
Id. de documento relacionado
|
relatedDocumentId | True | string |
Especifica el identificador del documento relacionado. Por ejemplo, "ACTIVE_US!453.1". |
Devoluciones
- response
- object
Establecimiento de las propiedades de metadatos extendidas principales en un documento
Establece las propiedades principales de metadatos extendidos en un documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Nombre
|
key | True | string |
Especifica el nombre de la propiedad de metadatos extendidos principal. |
|
Importancia
|
value | True | string |
Especifica uno o varios valores que se van a establecer para la propiedad de metadatos extendidos principal, separadas por punto y coma. Para anular el valor, establezca el valor de la clave en una cadena vacía ajustada entre comillas simples o dobles. |
Mover documento
Mueve un documento a la carpeta especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de carpeta principal
|
folderId | True | string |
Especifica el identificador de carpeta de la carpeta primaria. Por ejemplo, "ACTIVE_US!987". |
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Id. de carpeta de destino
|
destination_folder_id | True | string |
Especifica el identificador de carpeta de destino al que se va a mover el documento. Por ejemplo, "ACTIVE_US!987". |
|
Aplicar perfil de destino
|
update_profile | boolean |
Especifica si el perfil de documento se va a actualizar con el perfil de carpeta de destino. |
|
|
Aplicar seguridad de destino
|
update_security | boolean |
Especifica si la seguridad del documento se va a actualizar con la seguridad de carpetas de destino. Este parámetro solo es aplicable cuando Update Profile se establece en true. |
|
|
Comentarios de escala de tiempo
|
comments | string |
Especifica información adicional sobre la operación. Estos comentarios son visibles en la escala de tiempo del documento. |
Obtención de detalles del usuario
Obtiene información sobre un usuario de la biblioteca especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de biblioteca del usuario de destino. |
|
Id. de usuario
|
userId | True | string |
Especifica el identificador del usuario para el que se va a obtener información detallada del perfil. Por ejemplo, "JSMITH". |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | UserProfile |
Indica información sobre un usuario. |
Obtención de versiones de documentos
Obtiene perfiles para todas las versiones a las que el usuario actual tiene acceso para un documento especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Perfiles de documento
|
data | array of MinimalDocumentProfileInArray |
Obtención del perfil del área de trabajo
Obtiene el perfil del área de trabajo y, opcionalmente, la lista de operaciones permitidas para el área de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID del espacio de trabajo
|
workspaceId | True | string |
Especifica el identificador del área de trabajo. Por ejemplo, "ACTIVE_US!427". |
Obtener administradores
Obtiene una lista de administradores con determinados permisos para un documento, carpeta o área de trabajo. Un administrador de confianza puede ser un usuario o grupo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Especifica el tipo de objeto. |
|
Id. de objeto
|
objectId | True | string |
Especifica el identificador del documento, la carpeta o el área de trabajo. Un ejemplo de un identificador de documento es "ACTIVE_US!453.1". Un ejemplo de un identificador de carpeta o área de trabajo es "ACTIVE_US!123". |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of object |
Indica la lista de administradores con determinados permisos para un documento, carpeta o área de trabajo. Un administrador de confianza puede ser un usuario o grupo. |
|
Nombre completo
|
data.full_name | string |
Indica el nombre completo del administrador de confianza. |
|
identificación
|
data.id | string |
Indica el identificador del administrador de confianza. Puede ser un identificador de grupo o un identificador de usuario. Por ejemplo, "JSMITH" o "MARKETING". |
|
SSID
|
data.ssid | string |
Indica el identificador único generado por el sistema del administrador de confianza. |
|
Tipo
|
data.type | string |
Indica el tipo de entidad devuelta. Los valores posibles son "usuario" o "grupo". |
Obtener bibliotecas
Obtiene una lista de bibliotecas a las que el usuario tiene acceso.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of object |
Indica la lista de bibliotecas a las que tiene acceso el usuario. |
|
identificación
|
data.id | string |
Indica el nombre de la biblioteca. |
|
Nombre
|
data.display_name | string |
Indica el nombre para mostrar de la biblioteca. |
|
Tipo
|
data.type | string |
Indica el tipo de la biblioteca. Los valores posibles son "worksite" o "linksite". |
|
Está oculto
|
data.is_hidden | boolean |
Indica si la biblioteca está oculta. |
Obtener clases
Obtiene la lista de clases de documento disponibles en una biblioteca que coincida con los criterios especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de biblioteca de la clase de destino. |
|
Id. de clase
|
alias | string |
Especifica el identificador de una clase o clases que se van a buscar. Puede ser una lista separada por comas. Esta búsqueda no distingue mayúsculas de minúsculas. Se admiten el carácter comodín (*) y las coincidencias parciales. |
|
|
Seguridad predeterminada
|
default_security | string |
Especifica el nivel de acceso de seguridad predeterminado. |
|
|
Description
|
description | string |
Especifica el texto que debe coincidir en el campo de descripción. Esta búsqueda no distingue mayúsculas de minúsculas. Se admite el carácter comodín (*) . No se admiten coincidencias parciales. |
|
|
Eco
|
echo | boolean |
Especifica si los documentos de esta clase pueden reproducir documentos. |
|
|
HIPAA
|
hipaa | boolean |
Especifica si los documentos de esta clase usan el cifrado compatible con HIPAA. |
|
|
Indexables
|
indexable | boolean |
Especifica si el indexador de texto completo del sistema indexa los documentos de esta clase. |
|
|
Query
|
query | string |
Especifica el texto que debe coincidir con los campos id. o description. Esta búsqueda no distingue mayúsculas de minúsculas. Se admiten el carácter comodín (*) y las coincidencias parciales. |
|
|
Subclase requerida
|
subclass_required | boolean |
Especifica si la clase tiene una subclase necesaria. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de clase de coincidencia superior
|
data.topMatchingId | string |
Indica el identificador de la clase coincidente superior. Por ejemplo, "PETICIÓN". |
|
Descripción de la clase coincidente superior
|
data.topMatchingDescription | string |
Indica la descripción de la clase coincidente superior. |
|
results
|
data.results | array of object |
Indica la lista de clases disponibles en una biblioteca que coincida con los criterios especificados. |
|
Description
|
data.results.description | string |
Indica información adicional sobre la clase . |
|
¿Es HIPAA?
|
data.results.hipaa | boolean |
Indica si el documento está cifrado. |
|
identificación
|
data.results.id | string |
Indica el identificador de la clase . Por ejemplo, "PETICIÓN". |
|
Es indexable
|
data.results.indexable | boolean |
Indica si el sistema indexa el documento. |
|
Seguridad predeterminada
|
data.results.default_security | string |
Indica el nivel de acceso de seguridad predeterminado. Los valores posibles son "public", "view", "private". |
|
Retain
|
data.results.retain | integer |
Indica el número de días antes de marcar los documentos inactivos de esta clase como expirados. |
|
Campos obligatorios
|
data.results.required_fields | array of string |
Indica las propiedades personalizadas obligatorias que se van a escribir al crear o actualizar un documento de esta clase. |
|
Está sombreado
|
data.results.shadow | boolean |
Indica si un documento de esta clase está sombreado (retenido) en el equipo local de un usuario después de protegerla. |
|
¿Se requiere la subclase?
|
data.results.subclass_required | boolean |
Indica si se requiere una subclase para esta clase. |
Obtener las propiedades principales de metadatos extendidos de un documento
Obtiene las propiedades de metadatos extendidas principales de un documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Más reciente
|
latest | boolean |
Especifica para obtener la versión más reciente del documento. |
Obtener miembros del grupo
Obtenga los detalles de los usuarios que pertenecen al grupo especificado y que coincidan con los criterios especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de biblioteca del grupo de destino. |
|
Identificador de grupo
|
groupId | True | string |
Especifica el identificador del grupo. Por ejemplo, "MARKETING". |
|
Estado de inicio de sesión
|
logon_status | string |
Especifica un filtro para los usuarios en función del valor de propiedad "allow_logon" actual para cada usuario. |
|
|
Limit
|
limit | integer |
Especifica el número máximo de miembros que se van a devolver independientemente del número total de miembros del grupo. |
|
|
Biblioteca preferida
|
preferred_library | string |
Especifica que solo se devuelven los usuarios cuya biblioteca preferida coincide con el valor proporcionado. |
|
|
Ubicación
|
location | string |
Especifica la ubicación que se va a usar para buscar usuarios en función de su ubicación geográfica. Esta búsqueda no distingue mayúsculas de minúsculas. No se admite el carácter comodín (*) . |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of UserProfileInArray |
Indica la lista de usuarios que pertenecen al grupo especificado y que coinciden con los criterios especificados. |
Obtener perfil de documento
Obtiene las propiedades del documento asociadas a un identificador de documento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Obtener la versión más reciente
|
latest | boolean |
Especifica para obtener la versión más reciente del documento. |
Obtener permisos
Obtiene las propiedades de permiso de acceso de usuario o grupo de un documento, carpeta o área de trabajo. Las propiedades de respuesta pueden variar con permisos de usuario o grupo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Especifica el tipo de objeto. |
|
Id. de objeto
|
objectId | True | string |
Especifica el identificador del documento, la carpeta o el área de trabajo. Un ejemplo de un identificador de documento es "ACTIVE_US!453.1". Un ejemplo de un identificador de carpeta o área de trabajo es "ACTIVE_US!123". |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Seguridad predeterminada
|
data.default_security | string |
Indica la seguridad predeterminada del objeto. Los valores posibles son "inherit", "public", "view" o "private". |
|
Seguridad predeterminada heredada
|
data.inherited_default_security | string |
Indica la seguridad predeterminada heredada de una carpeta cuando la seguridad predeterminada está establecida en "heredar". Los valores posibles son "public", "view" o "private". |
|
Permisos de acceso
|
data.acl | AccessPermissions |
Indica una colección de permisos de acceso para uno o varios usuarios o grupos. |
|
Todos los identificadores de usuario
|
data.all_user_ids | string |
Indica una lista de todos los identificadores de usuario, concatenados como una cadena y separados por punto y coma. |
|
Todos los identificadores de grupo
|
data.all_group_ids | string |
Indica una lista de todos los identificadores de grupo, concatenados como una cadena y separados por punto y coma. |
Obtener plantillas de área de trabajo
Obtiene la lista de plantillas disponibles en una biblioteca. Una plantilla de área de trabajo es un área de trabajo predefinida cuya estructura se copia para la nueva área de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de biblioteca del área de trabajo de destino. |
|
Custom1
|
custom1 | string |
Especifica un valor que debe coincidir con el valor custom1 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom2
|
custom2 | string |
Especifica un valor que debe coincidir con el valor custom2 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom3
|
custom3 | string |
Especifica un valor que debe coincidir con el valor custom3 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom4
|
custom4 | string |
Especifica un valor que debe coincidir con el valor custom4 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom5
|
custom5 | string |
Especifica un valor que debe coincidir con el valor custom5 asociado a la plantilla de área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom6
|
custom6 | string |
Especifica un valor que debe coincidir con el valor personalizado6 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom7
|
custom7 | string |
Especifica un valor que debe coincidir con el valor personalizado7 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom8
|
custom8 | string |
Especifica un valor que debe coincidir con el valor custom8 asociado a la plantilla de área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom9
|
custom9 | string |
Especifica un valor que debe coincidir con el valor personalizado9 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom10
|
custom10 | string |
Especifica un valor que debe coincidir con el valor custom10 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom11
|
custom11 | string |
Especifica un valor que debe coincidir con el valor custom11 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom12
|
custom12 | string |
Especifica un valor que debe coincidir con el valor custom12 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom17
|
custom17 | double |
Especifica el valor de custom17. |
|
|
Custom18
|
custom18 | double |
Especifica el valor de custom18. |
|
|
Custom19
|
custom19 | double |
Especifica el valor de custom19. |
|
|
Custom20
|
custom20 | double |
Especifica el valor de custom20. |
|
|
Custom21
|
custom21 | string |
Especifica el valor (en formato datetime ISO 8601) para buscar en custom21 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom22
|
custom22 | string |
Especifica el valor (en formato datetime ISO 8601) para buscar en custom22 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom23
|
custom23 | string |
Especifica el valor (en formato datetime ISO 8601) para buscar en custom23 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom24
|
custom24 | string |
Especifica el valor (en formato datetime ISO 8601) para buscar en custom24 asociado a la plantilla del área de trabajo. Esta búsqueda no distingue mayúsculas de minúsculas. En el caso de las áreas de trabajo, el uso de esta propiedad se personaliza para la instalación de iManage Work. |
|
|
Custom21 (límite inferior)
|
custom21_from | string |
Especifica el límite inferior de custom21 (en formato datetime ISO 8601) que se va a buscar. IManage Work no reserva esta propiedad y no es un valor validado. Está pensado para personalizarse para los requisitos de su empresa. |
|
|
Custom21 (límite superior)
|
custom21_to | string |
Especifica el límite superior de custom21 (en formato datetime ISO 8601) que se va a buscar. IManage Work no reserva esta propiedad y no es un valor validado. Está pensado para personalizarse para los requisitos de su empresa. |
|
|
Custom21 (relativo)
|
custom21_relative | string |
Especifica un intervalo de fechas que se va a buscar, en relación con la fecha actual. Este parámetro tiene un formato de [begin]:[end][unidades de tiempo (d, m o y)]. Por ejemplo, -15:1d especifica un intervalo de fechas de 15 días antes de la fecha actual hasta un día después de la fecha actual (un día en el futuro). |
|
|
Custom22 (límite inferior)
|
custom22_from | string |
Especifica el límite inferior de custom22 (en formato datetime ISO 8601) que se va a buscar. IManage Work no reserva esta propiedad y no es un valor validado. Está pensado para personalizarse para los requisitos de su empresa. |
|
|
Custom22 (límite superior)
|
custom22_to | string |
Especifica el límite superior de custom22 (en formato datetime ISO 8601) que se va a buscar. IManage Work no reserva esta propiedad y no es un valor validado. Está pensado para personalizarse para los requisitos de su empresa. |
|
|
Custom22 (relativo)
|
custom22_relative | string |
Especifica un intervalo de fechas que se va a buscar, en relación con la fecha actual. Este parámetro tiene un formato de [begin]:[end][unidades de tiempo (d, m o y)]. Por ejemplo, -15:1d especifica un intervalo de fechas de 15 días antes de la fecha actual hasta un día después de la fecha actual (un día en el futuro). |
|
|
Custom23 (límite inferior)
|
custom23_from | string |
Especifica el límite inferior de custom23 (en formato datetime ISO 8601) que se va a buscar. IManage Work no reserva esta propiedad y no es un valor validado. Está pensado para personalizarse para los requisitos de su empresa. |
|
|
Custom23 (límite superior)
|
custom23_to | string |
Especifica el límite superior de custom23 (en formato datetime ISO 8601) que se va a buscar. IManage Work no reserva esta propiedad y no es un valor validado. Está pensado para personalizarse para los requisitos de su empresa. |
|
|
Custom23 (relativo)
|
custom23_relative | string |
Especifica un intervalo de fechas que se va a buscar, en relación con la fecha actual. Este parámetro tiene un formato de [begin]:[end][unidades de tiempo (d, m o y)]. Por ejemplo, -15:1d especifica un intervalo de fechas de 15 días antes de la fecha actual hasta un día después de la fecha actual (un día en el futuro). |
|
|
Custom24 (límite inferior)
|
custom24_from | string |
Especifica el límite inferior de custom24 (en formato datetime ISO 8601) que se va a buscar. IManage Work no reserva esta propiedad y no es un valor validado. Está pensado para personalizarse para los requisitos de su empresa. |
|
|
Custom24 (límite superior)
|
custom24_to | string |
Especifica el límite superior de custom24 (en formato datetime ISO 8601) que se va a buscar. IManage Work no reserva esta propiedad y no es un valor validado. Está pensado para personalizarse para los requisitos de su empresa. |
|
|
Custom24 (relativo)
|
custom24_relative | string |
Especifica un intervalo de fechas que se va a buscar, en relación con la fecha actual. Este parámetro tiene un formato de [begin]:[end][unidades de tiempo (d, m o y)]. Por ejemplo, -15:1d especifica un intervalo de fechas de 15 días antes de la fecha actual hasta un día después de la fecha actual (un día en el futuro). |
|
|
Custom25
|
custom25 | boolean |
Especifica el valor custom25 que se va a buscar. |
|
|
Custom26
|
custom26 | boolean |
Especifica el valor custom26 que se va a buscar. |
|
|
Custom27
|
custom27 | boolean |
Especifica el valor custom27 que se va a buscar. |
|
|
Custom28
|
custom28 | boolean |
Especifica el valor custom28 que se va a buscar. |
|
|
Custom29
|
custom29 | string |
Especifica un valor que debe coincidir con custom29. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
|
|
Custom30
|
custom30 | string |
Especifica un valor que debe coincidir con custom30. Esta búsqueda no distingue mayúsculas de minúsculas. El carácter comodín (*) y las coincidencias parciales no se admiten. |
Obtener subclases
Obtiene todas las subclases de biblioteca que coinciden con los criterios especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de biblioteca de la subclase de destino. |
|
Id. de clase
|
classId | True | string |
Especifica el identificador de la clase que es el elemento primario de esta subclase. Por ejemplo, "PETICIÓN". |
|
Id. de subclase
|
alias | string |
Especifica el identificador de las subclases que se van a buscar. Puede ser una lista separada por comas. Se admite el carácter comodín (*) . Las coincidencias parciales se admiten cuando se usa el carácter comodín. |
|
|
Seguridad predeterminada
|
default_security | string |
Especifica el nivel de acceso de seguridad predeterminado. |
|
|
Description
|
description | string |
Especifica el texto que debe coincidir en el campo de descripción. Se admite el carácter comodín (*) . Las coincidencias parciales se admiten cuando se usa el carácter comodín. |
|
|
Eco
|
echo | boolean |
Especifica si las subclases se pueden reproducir en el disco duro local de un usuario. Esto es para facilitar el trabajo sin conexión. |
|
|
HIPAA
|
hipaa | boolean |
Especifica si se van a devolver las subclases compatibles con HIPAA. |
|
|
Query
|
query | string |
Especifica el texto que debe coincidir con los campos id. de subclase o descripción. Se admite el carácter comodín (*) . Se admiten coincidencias parciales. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de subclase coincidente principales
|
data.topMatchingId | string |
Indica el identificador de la subclase coincidente superior. |
|
Descripción de la subclase coincidente superior
|
data.topMatchingDescription | string |
Indica la descripción de la subclase coincidente superior. |
|
results
|
data.results | array of object | |
|
Seguridad predeterminada
|
data.results.default_security | string |
Indica el nivel de acceso de seguridad predeterminado. Los valores posibles son "public", "view", "private". |
|
Description
|
data.results.description | string |
Indica información adicional sobre la subclase. La longitud máxima son 255 caracteres. |
|
¿Es HIPAA?
|
data.results.hipaa | boolean |
Indica si el documento está cifrado. |
|
identificación
|
data.results.id | string |
Indica el identificador de una subclase que se usa para crear o modificar la información del perfil del documento. Por ejemplo, "GUARDIANSHIP". |
|
Id. primario
|
data.results.parent.id | string |
Indica el identificador de clase primario de la subclase. |
|
Campos obligatorios
|
data.results.required_fields | array of string |
Indica las propiedades personalizadas obligatorias que se van a escribir al crear o actualizar un documento de esta subclase. |
|
Retain
|
data.results.retain | integer |
Indica el número de días antes de marcar los documentos inactivos de esta subclase como expirada. |
|
Está sombreado
|
data.results.shadow | boolean |
Indica si un documento de esta subclase está sombreado (retenido) en el equipo local de un usuario después de comprobarlo. |
Permisos de copia
Copia los permisos de acceso y, opcionalmente, la seguridad predeterminada, de un objeto iManage Work a otro. "Tipo de copia" proporciona opciones para controlar la combinación de permisos de origen y destino. "Sobrescribir" actualiza los niveles de permisos, grupos y usuarios del objeto de destino para que coincidan exactamente con los del objeto de origen. 'Merge' mantiene todos los usuarios y grupos en el objeto de destino y los combina con el origen, pero en caso de conflicto de nivel de permiso en un grupo o individual: 'Merge (Pessimistic)' toma el permiso inferior, mientras que 'Merge (Optimista)' toma el permiso más alto para el usuario o grupo en conflicto.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto de origen
|
sourceObjectType | True | string |
Especifica el tipo del objeto de origen. |
|
Id. de objeto de origen
|
sourceObjectId | True | string |
Especifica el identificador del objeto desde el que se copian los permisos. Un ejemplo de un identificador de documento es "ACTIVE_US!453.1". Un ejemplo de un identificador de carpeta o área de trabajo es "ACTIVE_US!123". |
|
Tipo de objeto de destino
|
targetObjectType | True | string |
Especifica el tipo del objeto de destino. |
|
Id. de objeto de destino
|
targetObjectId | True | string |
Especifica el identificador del objeto al que se copian los permisos. Un ejemplo de un identificador de documento es "ACTIVE_US!453.1". Un ejemplo de un identificador de carpeta o área de trabajo es "ACTIVE_US!123". |
|
Tipo de copia
|
copyType | True | string |
Especifica combinar los permisos de objeto de origen con permisos de objeto de destino o para sobrescribir los permisos de objeto de destino con permisos de origen. Para obtener más información, consulte la descripción de la acción. |
|
Copiar seguridad predeterminada
|
copyDefaultSecurity | True | boolean |
Especifica para copiar la seguridad predeterminada del objeto de origen en el objeto de destino. Si la seguridad predeterminada del objeto de origen es "heredar", la seguridad predeterminada heredada se copia del origen al objeto de destino. |
Devoluciones
Promover la versión del documento
Promueve una versión existente de un documento a la versión más reciente. Se crea una nueva versión a partir de un identificador de diario o una versión especificados y, a continuación, se promueve a la versión más reciente. Debe especificar el identificador de diario o la versión, pero no ambos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Especifica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Versión
|
version | integer |
Especifica el número de versión que se va a usar como base para la nueva versión promocionada. |
|
|
Id. de diario
|
journalId | string |
Especifica el identificador de diario que se va a usar como base para la nueva versión promocionada. |
|
|
Comentario
|
comment | string |
Especifica información adicional sobre el documento. |
|
|
Alias
|
alias | string |
Especifica el alias de este documento. |
|
|
Autor
|
author | string |
Especifica el identificador del usuario que creó el documento. Por ejemplo, "JSMITH". |
|
|
Clase Document
|
class | string |
Especifica la clase de documento. |
|
|
Seguridad predeterminada del documento
|
default_security | string |
Especifica el nivel de acceso de seguridad predeterminado. |
|
|
Se declara
|
is_declared | boolean |
Especifica si la nueva versión del documento se va a declarar como un registro. Un documento declarado como registro no se puede editar ni eliminar, excepto por un administrador del sistema iManage Work. |
|
|
¿Es HIPAA?
|
is_hipaa | boolean |
Especifica si se va a cifrar la nueva versión del documento. |
|
|
Nombre del documento
|
name | string |
Especifica el nombre de archivo del documento. |
|
|
Operator
|
operator | string |
Especifica el identificador del usuario que tiene el documento desprotegido o está editando el perfil del documento. Por ejemplo, "JSMITH". |
|
|
Conservar días
|
retain_days | integer |
Especifica el número de días antes de que el documento inactivo sea apto para el archivado. |
|
|
Subclase
|
subclass | string |
Especifica la subclase del documento. |
|
|
Custom1
|
custom1 | string |
Especifica el valor de custom1. |
|
|
Custom2
|
custom2 | string |
Especifica el valor de custom2. Para especificar un valor para custom2, también debe especificar un valor para custom1 en la misma solicitud, que se debe a su relación primario-secundario. |
|
|
Custom3
|
custom3 | string |
Especifica el valor de custom3. |
|
|
Custom4
|
custom4 | string |
Especifica el valor de custom4. |
|
|
Custom5
|
custom5 | string |
Especifica el valor de custom5. |
|
|
Custom6
|
custom6 | string |
Especifica el valor de custom6. |
|
|
Custom7
|
custom7 | string |
Especifica el valor de custom7. |
|
|
Custom8
|
custom8 | string |
Especifica el valor de custom8. |
|
|
Custom9
|
custom9 | string |
Especifica el valor de custom9. |
|
|
Custom10
|
custom10 | string |
Especifica el valor de custom10. |
|
|
Custom11
|
custom11 | string |
Especifica el valor de custom11. |
|
|
Custom12
|
custom12 | string |
Especifica el valor de custom12. |
|
|
Custom13
|
custom13 | string |
Especifica el valor de custom13. |
|
|
Custom14
|
custom14 | string |
Especifica el valor de custom14. |
|
|
Custom15
|
custom15 | string |
Especifica el valor de custom15. |
|
|
Custom16
|
custom16 | string |
Especifica el valor de custom16. |
|
|
Custom17
|
custom17 | double |
Especifica el valor de custom17. |
|
|
Custom18
|
custom18 | double |
Especifica el valor de custom18. |
|
|
Custom19
|
custom19 | double |
Especifica el valor de custom19. |
|
|
Custom20
|
custom20 | double |
Especifica el valor de custom20. |
|
|
Custom21
|
custom21 | string |
Especifica el valor de la propiedad custom21 en formato datetime ISO 8601. |
|
|
Custom22
|
custom22 | string |
Especifica el valor de la propiedad custom22 en formato datetime ISO 8601. |
|
|
Custom23
|
custom23 | string |
Especifica el valor de la propiedad custom23 en formato datetime ISO 8601. |
|
|
Custom24
|
custom24 | string |
Especifica el valor de la propiedad custom24 en formato datetime ISO 8601. |
|
|
Custom25
|
custom25 | boolean |
Especifica el valor de custom25. |
|
|
Custom26
|
custom26 | boolean |
Especifica el valor de custom26. |
|
|
Custom27
|
custom27 | boolean |
Especifica el valor de custom27. |
|
|
Custom28
|
custom28 | boolean |
Especifica el valor de custom28. |
|
|
Custom29
|
custom29 | string |
Especifica el valor de custom29. |
|
|
Custom30
|
custom30 | string |
Especifica el valor de custom30. Para especificar un valor para custom30, también debe especificar un valor para custom29 en la misma solicitud, que se debe a su relación de elementos primarios y secundarios. |
Desencadenadores
| Para un documento seleccionado |
Este desencadenador permite iniciar un flujo de trabajo para un documento seleccionado en una biblioteca de trabajo de iManage. Proporcione un nombre para mostrar que se mostrará a los usuarios en aplicaciones iManage Work. Si "Esperar finalización" está establecido en "Sí", debe usar la acción "Actualizar estado de flujo de trabajo" en el flujo de trabajo; de lo contrario, las aplicaciones agotarán el tiempo de espera sin indicar el estado de finalización al usuario. |
| Para un área de trabajo seleccionada |
Este desencadenador permite iniciar un flujo de trabajo para un área de trabajo seleccionada en una biblioteca de trabajo de iManage. Proporcione un nombre para mostrar que se mostrará a los usuarios en aplicaciones iManage Work. Si "Esperar finalización" está establecido en "Sí", debe usar la acción "Actualizar estado de flujo de trabajo" en el flujo de trabajo; de lo contrario, las aplicaciones agotarán el tiempo de espera sin indicar el estado de finalización al usuario. |
| Para varias áreas de trabajo seleccionadas |
Este desencadenador permite iniciar un flujo de trabajo para una o varias áreas de trabajo seleccionadas en iManage Work. Proporcione un nombre para mostrar que se mostrará a los usuarios en aplicaciones iManage Work. Si "Esperar finalización" está establecido en "Sí", debe usar la acción "Actualizar estado de flujo de trabajo" en el flujo de trabajo; de lo contrario, las aplicaciones agotarán el tiempo de espera sin indicar el estado de finalización al usuario. (Disponible sólo para Power Automate.) |
| Para varios documentos seleccionados |
Este desencadenador permite iniciar un flujo de trabajo para uno o varios documentos seleccionados en iManage Work. Proporcione un nombre para mostrar que se mostrará a los usuarios en aplicaciones iManage Work. Si "Esperar finalización" está establecido en "Sí", debe usar la acción "Actualizar estado de flujo de trabajo" en el flujo de trabajo; de lo contrario, las aplicaciones agotarán el tiempo de espera sin indicar el estado de finalización al usuario. |
Para un documento seleccionado
Este desencadenador permite iniciar un flujo de trabajo para un documento seleccionado en una biblioteca de trabajo de iManage. Proporcione un nombre para mostrar que se mostrará a los usuarios en aplicaciones iManage Work. Si "Esperar finalización" está establecido en "Sí", debe usar la acción "Actualizar estado de flujo de trabajo" en el flujo de trabajo; de lo contrario, las aplicaciones agotarán el tiempo de espera sin indicar el estado de finalización al usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre para mostrar del flujo de trabajo
|
workflowName | True | string |
Especifica el nombre para mostrar del flujo de trabajo que será visible para los usuarios de iManage Work. |
|
Description
|
description | True | string |
Especifica la descripción del flujo de trabajo. |
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de la biblioteca donde está disponible el flujo de trabajo. |
|
Id. de formulario
|
formId | True | string |
Especifica el identificador del formulario que se presenta al usuario para recopilar entradas usadas por el flujo de trabajo. |
|
Id. de carpeta de devolución
|
inferFolderId | True | boolean |
Especifica si el flujo de trabajo requiere el identificador de carpeta del documento. |
|
Disponible para los usuarios
|
users | string |
Especifica uno o varios identificadores de usuario, separados por punto y coma, a los que está disponible el flujo de trabajo. |
|
|
Disponible para grupos
|
groups | string |
Especifica uno o varios identificadores de grupo, separados por punto y coma, a los que está disponible el flujo de trabajo. |
|
|
Disponible en áreas de trabajo
|
workspaces | string |
Especifica uno o varios identificadores de área de trabajo, separados por punto y coma, en los que el flujo de trabajo está disponible. |
|
|
Clases de documento
|
classes | string |
Especifica uno o varios identificadores de clase de documento, separados por punto y coma, para los que el flujo de trabajo está disponible. |
|
|
Esperar finalización
|
waitForCompletion | boolean |
Especifica si las aplicaciones esperan hasta que el flujo de trabajo finaliza la ejecución. Si se establece en "Sí", debe usar la acción "Actualizar estado de flujo de trabajo". |
Devoluciones
Para un área de trabajo seleccionada
Este desencadenador permite iniciar un flujo de trabajo para un área de trabajo seleccionada en una biblioteca de trabajo de iManage. Proporcione un nombre para mostrar que se mostrará a los usuarios en aplicaciones iManage Work. Si "Esperar finalización" está establecido en "Sí", debe usar la acción "Actualizar estado de flujo de trabajo" en el flujo de trabajo; de lo contrario, las aplicaciones agotarán el tiempo de espera sin indicar el estado de finalización al usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre para mostrar del flujo de trabajo
|
workflowName | True | string |
Especifica el nombre para mostrar del flujo de trabajo que será visible para los usuarios de iManage Work. |
|
Description
|
description | True | string |
Especifica la descripción del flujo de trabajo. |
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de la biblioteca donde está disponible el flujo de trabajo. |
|
Id. de formulario
|
formId | True | string |
Especifica el identificador del formulario que se presenta al usuario para recopilar entradas usadas por el flujo de trabajo. |
|
Disponible para los usuarios
|
users | string |
Especifica uno o varios identificadores de usuario, separados por punto y coma, a los que está disponible el flujo de trabajo. |
|
|
Disponible para grupos
|
groups | string |
Especifica uno o varios identificadores de grupo, separados por punto y coma, a los que está disponible el flujo de trabajo. |
|
|
Esperar finalización
|
waitForCompletion | boolean |
Especifica si las aplicaciones esperan hasta que el flujo de trabajo finaliza la ejecución. Si se establece en "Sí", debe usar la acción "Actualizar estado de flujo de trabajo". |
Devoluciones
Para varias áreas de trabajo seleccionadas
Este desencadenador permite iniciar un flujo de trabajo para una o varias áreas de trabajo seleccionadas en iManage Work. Proporcione un nombre para mostrar que se mostrará a los usuarios en aplicaciones iManage Work. Si "Esperar finalización" está establecido en "Sí", debe usar la acción "Actualizar estado de flujo de trabajo" en el flujo de trabajo; de lo contrario, las aplicaciones agotarán el tiempo de espera sin indicar el estado de finalización al usuario. (Disponible sólo para Power Automate.)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
body
|
body | True | object |
Para varios documentos seleccionados
Este desencadenador permite iniciar un flujo de trabajo para uno o varios documentos seleccionados en iManage Work. Proporcione un nombre para mostrar que se mostrará a los usuarios en aplicaciones iManage Work. Si "Esperar finalización" está establecido en "Sí", debe usar la acción "Actualizar estado de flujo de trabajo" en el flujo de trabajo; de lo contrario, las aplicaciones agotarán el tiempo de espera sin indicar el estado de finalización al usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre para mostrar del flujo de trabajo
|
workflowName | True | string |
Especifica el nombre para mostrar del flujo de trabajo que será visible para los usuarios de iManage Work. |
|
Description
|
description | True | string |
Especifica la descripción del flujo de trabajo. |
|
Id. de biblioteca
|
libraryId | True | string |
Especifica el identificador de la biblioteca donde está disponible el flujo de trabajo. |
|
Id. de formulario
|
formId | True | string |
Especifica el identificador del formulario que se presenta al usuario para recopilar entradas usadas por el flujo de trabajo. |
|
Id. de carpeta de devolución
|
inferFolderId | True | boolean |
Especifica si el flujo de trabajo requiere el identificador de carpeta del documento. |
|
Disponible para los usuarios
|
users | string |
Especifica uno o varios identificadores de usuario, separados por punto y coma, a los que está disponible el flujo de trabajo. |
|
|
Disponible para grupos
|
groups | string |
Especifica uno o varios identificadores de grupo, separados por punto y coma, a los que está disponible el flujo de trabajo. |
|
|
Esperar finalización
|
waitForCompletion | boolean |
Especifica si las aplicaciones esperan hasta que el flujo de trabajo finaliza la ejecución. Si se establece en "Sí", debe usar la acción "Actualizar estado de flujo de trabajo". |
Devoluciones
Definiciones
MinimalDocumentProfileInArray
Indica el perfil de cada versión del documento.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Autor
|
author | string |
Indica el identificador del usuario que creó el documento. Por ejemplo, "JSMITH". |
|
Descripción del autor
|
author_description | string |
Indica información adicional sobre el autor del documento. |
|
Propiedades básicas del documento
|
basic_properties | string |
Indica un elemento '' incrustable que contiene propiedades básicas del documento. |
|
Clase Document
|
class | string |
Indica la clase del documento. |
|
Comentario
|
comment | string |
Indica información adicional sobre el documento. |
|
Tipo de contenido
|
content_type | string |
Indica el tipo de contenido del documento. |
|
Fecha de creación del documento
|
create_date | string |
Indica la fecha y hora (en formato ISO 8601) que el documento se importó en el sistema iManage Work. Esta fecha puede ser diferente de "file_create_date". |
|
Custom1
|
custom1 | string |
Indica el valor de custom1. |
|
Descripción de Custom1
|
custom1_description | string |
Indica información adicional sobre la propiedad custom1. |
|
Custom2
|
custom2 | string |
Indica el valor de custom2. |
|
Descripción de Custom2
|
custom2_description | string |
Indica información adicional sobre la propiedad custom2. |
|
Custom3
|
custom3 | string |
Indica el valor de custom3. |
|
Descripción de Custom3
|
custom3_description | string |
Indica información adicional sobre la propiedad custom3. |
|
Custom4
|
custom4 | string |
Indica el valor de custom4. |
|
Descripción personalizada4
|
custom4_description | string |
Indica información adicional sobre la propiedad custom4. |
|
Custom5
|
custom5 | string |
Indica el valor de custom5. |
|
Descripción de Custom5
|
custom5_description | string |
Indica información adicional sobre la propiedad custom5. |
|
Custom6
|
custom6 | string |
Indica el valor de custom6. |
|
Descripción de Custom6
|
custom6_description | string |
Indica información adicional sobre la propiedad custom6. |
|
Custom7
|
custom7 | string |
Indica el valor de custom7. |
|
Descripción de Custom7
|
custom7_description | string |
Indica información adicional sobre la propiedad custom7. |
|
Custom8
|
custom8 | string |
Indica el valor de custom8. |
|
Descripción de Custom8
|
custom8_description | string |
Indica información adicional sobre la propiedad custom8. |
|
Custom9
|
custom9 | string |
Indica el valor de custom9. |
|
Descripción de Custom9
|
custom9_description | string |
Indica información adicional sobre la propiedad custom9. |
|
Custom10
|
custom10 | string |
Indica el valor de custom10. |
|
Custom10 Description
|
custom10_description | string |
Indica información adicional sobre la propiedad custom10. |
|
Custom11
|
custom11 | string |
Indica el valor de custom11. |
|
Custom11 Description
|
custom11_description | string |
Indica información adicional sobre la propiedad custom11. |
|
Custom12
|
custom12 | string |
Indica el valor de custom12. |
|
Descripción de Custom12
|
custom12_description | string |
Indica información adicional sobre la propiedad custom12. |
|
Custom13
|
custom13 | string |
Indica el valor de custom13. |
|
Custom14
|
custom14 | string |
Indica el valor de custom14. |
|
Custom15
|
custom15 | string |
Indica el valor de custom15. |
|
Custom16
|
custom16 | string |
Indica el valor de custom16. |
|
Custom17
|
custom17 | double |
Indica el valor de custom17. |
|
Custom18
|
custom18 | double |
Indica el valor de custom18. |
|
Custom19
|
custom19 | double |
Indica el valor de custom19. |
|
Custom20
|
custom20 | double |
Indica el valor de custom20. |
|
Custom21
|
custom21 | string |
Indica el valor de la propiedad custom21 en formato datetime ISO 8601. |
|
Custom22
|
custom22 | string |
Indica el valor de la propiedad custom22 en formato datetime ISO 8601. |
|
Custom23
|
custom23 | string |
Indica el valor de la propiedad custom23 en formato datetime ISO 8601. |
|
Custom24
|
custom24 | string |
Indica el valor de la propiedad custom24 en formato datetime ISO 8601. |
|
Custom25
|
custom25 | boolean |
Indica el valor de custom25. |
|
Custom26
|
custom26 | boolean |
Indica el valor de custom26. |
|
Custom27
|
custom27 | boolean |
Indica el valor de custom27. |
|
Custom28
|
custom28 | boolean |
Indica el valor de custom28. |
|
Custom29
|
custom29 | string |
Indica el valor de custom29. |
|
Descripción de Custom29
|
custom29_description | string |
Indica información adicional sobre la propiedad custom29. |
|
Custom30
|
custom30 | string |
Indica el valor de custom30. |
|
Descripción de Custom30
|
custom30_description | string |
Indica información adicional sobre la propiedad custom30. |
|
Base de datos
|
database | string |
Indica la biblioteca donde se almacena el documento. |
|
Seguridad predeterminada del documento
|
default_security | string |
Indica el nivel de acceso de seguridad predeterminado. Los valores posibles son "inherit", "private", "view", "public". |
|
Número de documento
|
document_number | integer |
Indica el número de documento de un documento. |
|
Dirección URL del documento
|
document_url | string |
Indica el vínculo que se puede compartir para el documento. |
|
Fecha de edición del documento
|
edit_date | string |
Indica la fecha y hora (en formato ISO 8601) del cambio más reciente al documento. |
|
Fecha de edición del perfil
|
edit_profile_date | string |
Indica la fecha y hora (en formato ISO 8601) del cambio más reciente al perfil de documento. |
|
Extensión de documento
|
extension | string |
Indica la extensión de nombre de archivo, también denominada extensión de aplicación, del documento. |
|
Nombre de archivo completo
|
full_file_name | string |
Indica el nombre de archivo completo del documento. Incluye la extensión de nombre de archivo. |
|
Id. de documento
|
id | string |
Indica el identificador del documento. Por ejemplo, "ACTIVE_US!453.1". |
|
Es indexable
|
indexable | boolean |
Indica si el sistema indexa el documento. |
|
Está desprotegido
|
is_checked_out | boolean |
Indica si el documento está desprotegido. |
|
Se declara
|
is_declared | boolean |
Indica si el documento se declara como un registro. Un documento declarado como registro no se puede editar ni eliminar, excepto por un administrador del sistema iManage Work. |
|
Es externo
|
is_external | boolean |
Indica si el documento se comparte con usuarios externos. |
|
¿Es HIPAA?
|
is_hipaa | boolean |
Indica si el documento está cifrado. |
|
Está en uso
|
is_in_use | boolean |
Indica si el documento está en uso. |
|
Vínculo de documento
|
iwl | string |
Indica el vínculo de trabajo iManage (iWL) para el documento. El iWL se usa para abrir el documento en modo de vista protegida por el usuario que tiene "read_write" o "full_access". |
|
Último usuario
|
last_user | string |
Indica el identificador del usuario que editó el documento más recientemente. Por ejemplo, "JSMITH". |
|
Descripción del último usuario
|
last_user_description | string |
Indica información adicional sobre el último usuario que editó el documento más recientemente. |
|
Nombre del documento
|
name | string |
Indica el nombre de archivo del documento. |
|
Operator
|
operator | string |
Indica el identificador del usuario que tiene el documento desprotegido o está editando su perfil. Por ejemplo, "JSMITH". |
|
Descripción del operador
|
operator_description | string |
Indica información adicional sobre el operador . |
|
Está relacionado
|
is_related | boolean |
Indica si el documento está relacionado con otro documento. |
|
Tamaño del documento
|
size | integer |
Indica el tamaño del documento en bytes. |
|
Tipo
|
type | string |
Indica el tipo de documento. Por ejemplo, WORD para Microsoft Word. Para obtener una lista actual de tipos, póngase en contacto con el administrador del sistema iManage Work. |
|
Versión del documento
|
version | integer |
Indica el número de versión del documento. |
|
Wstype
|
wstype | string |
Indica el tipo de trabajo iManage del objeto . Los valores posibles son "document", "folder", "workspace", "email", "document_shortcut", "folder_shortcut", "workspace_shortcut", "user". |
PerfilDeUsuario
Indica información sobre un usuario.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Permitir inicio de sesión
|
allow_logon | boolean |
Indica si el usuario puede iniciar sesión. |
|
Custom1
|
custom1 | string |
Indica información adicional sobre el usuario. |
|
Custom2
|
custom2 | string |
Indica información adicional sobre el usuario. |
|
Custom3
|
custom3 | string |
Indica información adicional sobre el usuario. |
|
Id. de directorio
|
directory_id | string |
Indica el identificador de un directorio externo (como ADFS), que se usa para la sincronización de perfiles de usuario. |
|
Nombre distintivo
|
distinguished_name | string |
Indica el nombre del objeto que representa la ruta de acceso completa de los nombres que rastrean la entrada de nuevo a la raíz del árbol LDAP. |
|
Fecha de edición
|
edit_date | string |
Indica la fecha y hora (en formato ISO 8601) del cambio más reciente al perfil de usuario. |
|
Correo Electrónico
|
string |
Indica el identificador de correo electrónico del usuario. |
|
|
Dirección URL de detección automática de Exchange
|
exch_autodiscover | string |
Indica los detalles del servidor exchange del usuario. |
|
Extension
|
extension | string |
Indica la extensión de número de teléfono del usuario. |
|
Intentos de inicio de sesión erróneos
|
failed_logins | integer |
Indica el número actual de intentos de inicio de sesión erróneos del usuario. |
|
Fax
|
fax | string |
Indica el número de fax del usuario. |
|
Forzar el cambio de contraseña
|
force_password_change | boolean |
Indica que el usuario debe cambiar su contraseña en el siguiente inicio de sesión. Solo se aplica a los usuarios virtuales, indicados por el valor "user_nos" "2". |
|
Nombre completo
|
full_name | string |
Indica el nombre completo del usuario. |
|
General
|
general | string |
Indica información general sobre el usuario. |
|
Id. de usuario
|
id | string |
Indica el identificador del usuario. Por ejemplo, "JSMITH". |
|
Es usuario externo
|
is_external | boolean |
Indica un usuario externo. Un usuario externo tiene acceso limitado y se usa normalmente para miembros temporales del equipo, consultores o aquellos externos a la organización. |
|
Hora de la última sincronización
|
last_sync_ts | string |
Indica la hora de la última sincronización (en formato de fecha y hora ISO 8601) del perfil del usuario con un directorio externo, como LDAP o Microsoft Active Directory (ADFS). |
|
Ubicación
|
location | string |
Indica la ubicación geográfica del usuario. |
|
La contraseña nunca expira
|
password_never_expire | boolean |
Indica si la contraseña del usuario nunca expira. |
|
Número de teléfono
|
phone | string |
Indica el número de teléfono del usuario. |
|
Biblioteca preferida
|
preferred_library | string |
Indica la biblioteca preferida. Una biblioteca preferida es la biblioteca predeterminada del usuario. Cada usuario debe tener una biblioteca preferida. |
|
Hora de cambio de contraseña
|
pwd_changed_ts | string |
Indica la hora (en formato de fecha y hora ISO 8601) cuando se cambió por última vez la contraseña del usuario. Esto solo es aplicable a los usuarios virtuales (cuyo usuario NOS es 2). |
|
SSID
|
ssid | string |
Indica el identificador único generado por el sistema para el usuario. |
|
Dominio de usuario
|
user_domain | string |
Indica el nombre de dominio completo para el servicio de directorio del usuario. |
|
Identificador de usuario extendido
|
user_id_ex | string |
Indica el valor original del identificador de usuario que se recibe de un directorio externo, como Microsoft Active Directory (ADFS). |
|
Usuario NOS
|
user_nos | integer |
Indica el tipo de sistema operativo desde el que se sincroniza el usuario. Los valores posibles son 2 (usuario virtual) y 6 (usuario empresarial). Para obtener más información, póngase en contacto con el administrador del sistema iManage Work. |
|
Número de usuario
|
user_num | integer |
Indica el identificador numérico del sistema del usuario. |
UserProfileInArray
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Permitir inicio de sesión
|
allow_logon | boolean |
Indica si el usuario puede iniciar sesión. |
|
Custom1
|
custom1 | string |
Indica información adicional sobre el usuario. |
|
Custom2
|
custom2 | string |
Indica información adicional sobre el usuario. |
|
Custom3
|
custom3 | string |
Indica información adicional sobre el usuario. |
|
Id. de directorio
|
directory_id | string |
Indica el identificador de un directorio externo (como ADFS), que se usa para la sincronización de perfiles de usuario. |
|
Nombre distintivo
|
distinguished_name | string |
Indica el nombre del objeto que representa la ruta de acceso completa de los nombres que rastrean la entrada de nuevo a la raíz del árbol LDAP. |
|
Fecha de edición
|
edit_date | string |
Indica la fecha y hora (en formato ISO 8601) del cambio más reciente al perfil de usuario. |
|
Correo Electrónico
|
string |
Indica el identificador de correo electrónico del usuario. |
|
|
Dirección URL de detección automática de Exchange
|
exch_autodiscover | string |
Indica los detalles del servidor exchange del usuario. |
|
Extension
|
extension | string |
Indica la extensión de número de teléfono del usuario. |
|
Intentos de inicio de sesión erróneos
|
failed_logins | integer |
Indica el número actual de intentos de inicio de sesión erróneos del usuario. |
|
Fax
|
fax | string |
Indica el número de fax del usuario. |
|
Forzar el cambio de contraseña
|
force_password_change | boolean |
Indica que el usuario debe cambiar su contraseña en el siguiente inicio de sesión. Solo se aplica a los usuarios virtuales, indicados por el valor "user_nos" "2". |
|
Nombre completo
|
full_name | string |
Indica el nombre completo del usuario. |
|
General
|
general | string |
Indica información general sobre el usuario. |
|
identificación
|
id | string |
Indica el identificador del usuario. Por ejemplo, "JSMITH". |
|
Es usuario externo
|
is_external | boolean |
Indica un usuario externo. Un usuario externo tiene acceso limitado y se usa normalmente para miembros temporales del equipo, consultores o aquellos externos a la organización. |
|
Hora de la última sincronización
|
last_sync_ts | string |
Indica la hora de la última sincronización (en formato de fecha y hora ISO 8601) del perfil del usuario con un directorio externo, como LDAP o Microsoft Active Directory (ADFS). |
|
Ubicación
|
location | string |
Indica la ubicación geográfica del usuario. |
|
La contraseña nunca expira
|
password_never_expire | boolean |
Indica si la contraseña del usuario nunca expira. |
|
Número de teléfono
|
phone | string |
Indica el número de teléfono del usuario. |
|
Biblioteca preferida
|
preferred_library | string |
Indica la biblioteca preferida. Una biblioteca preferida es la biblioteca predeterminada del usuario. Cada usuario debe tener una biblioteca preferida. |
|
Hora de cambio de contraseña
|
pwd_changed_ts | string |
Indica la hora (en formato de fecha y hora ISO 8601) cuando se cambió por última vez la contraseña del usuario. Esto solo es aplicable a los usuarios virtuales (cuyo usuario NOS es 2). |
|
SSID
|
ssid | string |
Indica el identificador único generado por el sistema para el usuario. |
|
Dominio
|
user_domain | string |
Indica el nombre de dominio completo para el servicio de directorio del usuario. |
|
Identificador de usuario extendido
|
user_id_ex | string |
Indica el valor original del identificador de usuario que se recibe de un directorio externo, como Microsoft Active Directory (ADFS). |
|
NOS
|
user_nos | integer |
Indica el tipo de sistema operativo desde el que se sincroniza el usuario. Los valores posibles son 2 (usuario virtual) y 6 (usuario empresarial). Para obtener más información, póngase en contacto con el administrador del sistema iManage Work. |
|
Number
|
user_num | integer |
Indica el identificador numérico del sistema del usuario. |
TaxonomyNodeValue
Indica cada valor de nodo de taxonomía.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
SSID
|
created_by.ssid | string |
Indica el identificador único generado por el sistema para el usuario que creó el valor del nodo. |
|
Fecha de creación
|
create_date | date-time |
Indica la fecha y hora (en formato ISO 8601) que se creó el valor del nodo. |
|
Description
|
description | string |
Indica la descripción del valor del nodo. |
|
SSID
|
edited_by.ssid | string |
Indica el identificador único generado por el sistema para el usuario que editó por última vez el valor del nodo. |
|
Fecha de edición
|
edit_date | date-time |
Indica la fecha y hora (en formato ISO 8601) que el valor del nodo se editó por última vez. |
|
Está habilitado
|
enabled | boolean |
Indica si el valor del nodo está habilitado. |
|
identificación
|
id | string |
Indica el identificador para mostrar del valor del nodo. |
|
SSID
|
parent.ssid | string |
Indica el identificador único generado por el sistema para el nodo primario inmediato. |
|
SSID
|
ssid | string |
Indica el identificador único generado por el sistema para el valor del nodo. |
|
Ruta
|
path | array of object |
Indica la ruta de acceso completa al valor del nodo. Una ruta de acceso es una lista ordenada que comienza con el nodo de nivel superior en la taxonomía y, a continuación, todos los nodos a través del elemento primario inmediato del nodo coincidente. |
|
Cada identificador
|
path.id | string |
Indica el identificador para mostrar de un valor de nodo en la ruta de acceso. |
|
Cada SSID
|
path.ssid | string |
Indica el identificador único generado por el sistema para un valor de nodo en la ruta de acceso. |
UpdatePermissionsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Seguridad predeterminada
|
data.default_security | string |
Indica la seguridad predeterminada del objeto. Los valores posibles son "inherit", "public", "view" o "private". |
|
Permisos de acceso
|
data.acl | AccessPermissions |
Indica una colección de permisos de acceso para uno o varios usuarios o grupos. |
|
Todos los identificadores de usuario
|
data.all_user_ids | string |
Indica una lista de todos los identificadores de usuario, concatenados como una cadena y separados por punto y coma. |
|
Todos los identificadores de grupo
|
data.all_group_ids | string |
Indica una lista de todos los identificadores de grupo, concatenados como una cadena y separados por punto y coma. |
AccessPermissions
Indica una colección de permisos de acceso para uno o varios usuarios o grupos.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre del administrador de confianza
|
name | string |
Indica el nombre del administrador de confianza. |
|
Id. de administrador de confianza
|
id | string |
Indica el identificador del administrador de confianza. Puede ser un identificador de usuario o un identificador de grupo. |
|
SID de administrador de confianza
|
sid | string |
Indica el identificador de seguridad del usuario o grupo. |
|
Tipo de administrador
|
type | string |
Indica el tipo de administrador de confianza devuelto. Los valores posibles son "usuario" o "grupo". |
|
Nivel de entrada
|
access_level | string |
Indica el permiso de acceso que el usuario o grupo tiene en el objeto . Los valores posibles son "no_access", "read", "read_write" o "full_access". |
|
Nombre para mostrar de nivel de acceso
|
access_level_display_name | string |
Indica el nombre para mostrar de nivel de acceso legible asignado al usuario o grupo para este objeto. Los valores posibles son "Sin acceso", "Solo lectura", "Lectura y escritura" o "Acceso completo". |
|
Acceso
|
access | integer |
Indica el valor numérico del permiso de acceso que el usuario o grupo tiene en el objeto . Los valores posibles son 0 (no_access), 1 (lectura), 2 (read_write) o 3 (full_access). |
|
Es externo
|
is_external | boolean |
Indica si el usuario es un usuario externo o si el grupo está restringido a usuarios externos. |
|
Permitir inicio de sesión
|
allow_logon | boolean |
Indica si el usuario puede iniciar sesión. No es aplicable a los grupos. |
|
Está habilitado
|
enabled | boolean |
Indica si el grupo está habilitado. No es aplicable a los usuarios. |
|
Tiene miembro restringido
|
has_restricted_member | boolean |
Indica si el grupo tiene al menos un usuario con acceso a este objeto denegado por iManage Security Policy Manager. |
objeto
Este es el tipo 'objeto'.
binary
Este es el tipo de datos básico "binary".