Power Connect del Administrador de contenido
Content Manager es un sistema de administración de contenido empresarial basado en gobernanza diseñado para ayudar a las agencias gubernamentales, a las industrias reguladas y a las organizaciones globales a administrar su contenido empresarial desde la creación hasta la eliminación. Conéctese a Content Manager para realizar acciones como crear o actualizar registros o ubicaciones, cargar o descargar archivos electrónicos, buscar y mucho más. (1.0.4.757)
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 | Kapish Services Pty Ltd |
| URL | https://kapish.com.au/products/power_connect/ |
| Correo Electrónico | sales@kapish.com.au |
| Metadatos del conector | |
|---|---|
| Publicador | Kapish Services Pty Ltd |
| Sitio web | https://kapish.com.au/products/power_connect/ |
| Directiva de privacidad | https://kapish.com.au/products/privacy-policy/ |
| Categorías | Datos; Contenido y archivos |
Content Manager Power Connect by Kapish es un conector que proporciona funciones de automatización e integración en Content Manager para simplificar la capacidad de su organización para satisfacer sus requisitos de gobernanza y administración de información.
Requisitos previos
- Una instancia de Content Manager ServiceAPI accesible externamente
- Clave de suscripción proporcionada por Kapish Services Pty Ltd
Para obtener una lista detallada de especificaciones y requisitos, o para obtener más información sobre cómo el conector puede ayudar a su organización, póngase en contacto con Kapish Services Pty Ltd.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| OAuth (flujo de cliente confidencial) | Uso de OAuth para conectarse al Administrador de contenido | Todas las regiones | No se puede compartir |
| Administrado por el sistema | Uso de un nombre de usuario y una contraseña para conectarse a Content Manager | Todas las regiones | No se puede compartir |
| Valor predeterminado [EN DESUSO] | Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores. | Todas las regiones | No se puede compartir |
OAuth (flujo de cliente confidencial)
Identificador de autenticación: OAuth
Aplicable: Todas las regiones
Uso de OAuth para conectarse al Administrador de contenido
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de suscripción de KPC | securestring | La clave de API para acceder a Kapish Power Connect | Cierto |
| DIRECCIÓN URL de CM ServiceAPI (por ejemplo, https://myserver/CMServiceAPI/) | cuerda / cadena | Dirección URL a la que se puede acceder a CM ServiceAPI | Cierto |
| Dirección URL del servidor de autorización (por ejemplo, https://myserver/adfs/oauth2/token) | cuerda / cadena | Dirección URL para obtener el token de acceso | Cierto |
| Id. de cliente | cuerda / cadena | Identificador de cliente para la autenticación | Cierto |
| Secreto del cliente | securestring | Secreto de cliente para la autenticación | Cierto |
Administrado por el sistema
Identificador de autenticación: Básico
Aplicable: Todas las regiones
Uso de un nombre de usuario y una contraseña para conectarse a Content Manager
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de suscripción de KPC | securestring | La clave de API para acceder a Kapish Power Connect | Cierto |
| DIRECCIÓN URL de CM ServiceAPI (por ejemplo, https://myserver/CMServiceAPI/) | cuerda / cadena | Dirección URL a la que se puede acceder a CM ServiceAPI | Cierto |
| Nombre de usuario | cuerda / cadena | Nombre de usuario para la autenticación | Cierto |
| Contraseña | securestring | Contraseña para la autenticación | Cierto |
Valor predeterminado [EN DESUSO]
Aplicable: Todas las regiones
Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de suscripción de KPC | securestring | La clave de API para acceder a Kapish Power Connect | Cierto |
| DIRECCIÓN URL de CM ServiceAPI (por ejemplo, https://myserver/CMServiceAPI/) | cuerda / cadena | Dirección URL a la que se puede acceder a CM ServiceAPI | Cierto |
| Dirección URL del servidor de autorización (por ejemplo, https://myserver/adfs/oauth2/token) | cuerda / cadena | Dirección URL para obtener el token de acceso | Cierto |
| Id. de cliente | cuerda / cadena | Identificador de cliente para la autenticación | Cierto |
| Secreto del cliente | securestring | Secreto de cliente para la autenticación | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualizar registro (acción reasignar) |
Reasigna la acción designada a una ubicación especificada |
| Actualizar registro (desprotección) |
Establecer el estado del registro en desprotegido |
| Actualizar registro (propiedades) |
Actualizar un registro |
| Buscar el identificador único de la dirección de ubicación |
Obtención del identificador único de la dirección secundaria de una ubicación |
| Buscar objetos CM |
Buscar objetos CM |
| Buscar registro por identificador |
Capturar un único registro por identificador único o nombre |
| Buscar registros |
Buscar registros (capturar una colección de registros mediante una cadena de búsqueda) |
| Buscar registros (avanzados) |
Busque Registros (capturar una colección de registros mediante una cadena de búsqueda). Devuelve una respuesta serviceAPI de Content Manager sin procesar. |
| Buscar ubicaciones |
Buscar ubicaciones (capturar una colección de ubicaciones mediante una cadena de búsqueda) |
| Buscar ubicación por identificador |
Capturar una sola ubicación por identificador único o nombre |
| Cargar archivo electrónico |
Cargar un archivo electrónico que se pueda adjuntar más adelante a un registro |
| Crear registro (avanzado) |
Crear un registro con campos avanzados |
| Crear registro (carpeta) |
Crear un registro |
| Crear registro (documento) |
Crear un registro |
| Crear ubicación (otro) |
Crear una ubicación de cualquier tipo |
| Crear ubicación (persona) |
Crear una ubicación de persona |
| Descargar archivo electrónico |
Descargar un archivo electrónico de un registro |
| Eliminar registro |
Eliminar un registro |
| Leer datos de eventos |
Transformación de datos de eventos de Kapish Dispatch para el consumo de flujo |
| Obtener archivo de la dirección URL |
Descarga de un archivo de la dirección URL a un área de almacenamiento provisional mediante el complemento de LA API del servicio CM "GetFileFromUrl" |
| Registro de actualización (acciones completas) |
Completar una o todas las acciones debidas en un registro determinado |
| Registro de actualización (acciones de reprogramación) |
Vuelve a programar todas las acciones adjuntas a este registro |
| Registro de actualización (adjuntar acción o procedimiento) |
Adjuntar una acción o un procedimiento a un registro |
| Registro de actualización (adjuntar archivo electrónico) |
Adjuntar un archivo electrónico a un registro |
| Registro de actualización (adjuntar contacto) |
Adjuntar un contacto a un registro |
| Registro de actualización (adjuntar término de sinónimos) |
Adjuntar un término de diccionario de sinónimos a un registro |
| Registro de actualización (agregar controles de acceso) |
AddAccessControl |
| Registro de actualización (avanzado) |
Actualizar un registro con propiedades avanzadas |
| Registro de actualización (campos adicionales) |
Actualizar campos adicionales en un registro |
| Registro de actualización (cerrar) |
Use la función CloseRecord para cerrar un contenedor: deje la fecha en blanco si desea que la fecha de cierre sea "now". Dado que el cierre de un registro puede requerir la actualización de muchos registros contenidos, esta función confirma los cambios automáticamente. |
| Registro de actualización (clasificación) |
Actualizar la clasificación de un registro |
| Registro de actualización (desdispose) |
Revierte el estado del registro (y cualquiera de sus contenidos) para que ya no se elimine. |
| Registro de actualización (deshacer desprotección) |
Deshacer una desprotección anterior del documento electrónico para este Registro, ignorando los cambios realizados desde que se desprotegió |
| Registro de actualización (Dispose) |
Eliminación de un registro |
| Registro de actualización (establecer acceso sin restricciones o basado en el contenedor) |
InheritAccessControl |
| Registro de actualización (establecer asignado) |
Establezca assignee en una ubicación determinada, vuelva a Inicio o regístrese como Falta. |
| Registro de actualización (establecer etiqueta de usuario) |
Permite la configuración de una etiqueta de usuario en un registro |
| Registro de actualización (finalización) |
Actualizar un borrador de registro |
| Registro de actualización (quitar la ubicación de los controles de acceso) |
RemoveAccessControl |
| Registro de actualización (quitar todas las acciones) |
Quita todas las acciones adjuntas al registro especificado. |
| Registro de actualización (reemplazar controles de acceso) |
SetAccessControl |
| Registro de actualización (representación de solicitudes) |
Permite crear una solicitud para que el motor de representación automático realice una representación de un registro. |
| Registro de actualización (unfinalise: establecer como borrador) |
Actualizar un registro finalizado a borrador |
| Registro de actualización (volver a abrir) |
Use la función ReopenRecord para volver a abrir un contenedor cerrado. Dado que volver a abrir un registro puede requerir la actualización de muchos registros contenidos, esta función confirma los cambios automáticamente. |
| Ubicación de actualización (campos adicionales) |
Actualizar campos adicionales en una ubicación |
| Ubicación de actualización (dirección) |
Crear o actualizar la dirección de una ubicación mediante el identificador único de la dirección |
| Ubicación de actualización (otra) |
Actualizar una ubicación |
| Ubicación de actualización (persona) |
Actualizar una ubicación de persona mediante su identificador único |
Actualizar registro (acción reasignar)
Reasigna la acción designada a una ubicación especificada
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Nuevo asignado
|
NewAssignee | True | string |
Identificador único o dirección de correo electrónico del nuevo receptor |
|
Acción para reasignar
|
RecordActionUri | True | integer | |
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Actualizar registro (desprotección)
Establecer el estado del registro en desprotegido
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Comentarios
|
Comments | string | ||
|
Guardar ruta de acceso de desprotección como
|
SaveCheckoutPathAs | string | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Actualizar registro (propiedades)
Actualizar un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | integer | ||
|
Query
|
q | string |
Especifique una consulta aquí para aplicar la actualización a un conjunto de registros en lugar de solo una (según lo especificado por el identificador único). |
|
|
Título (parte de texto libre)
|
RecordTypedTitle | string | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
|
|
Autor
|
RecordAuthor | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Contenedor
|
RecordContainer | string | ||
|
Classification
|
RecordClassification | string |
Proporcione el identificador único de la clasificación. |
|
|
Destinatario
|
RecordAddressee | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Contenedor alternativo
|
RecordAlternativeContainer | string | ||
|
Persona asignada
|
RecordAssignee | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Representación automática en PDF al guardar
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Omitir controles de acceso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Proteger como
|
CheckinAs | string |
Establezca la propiedad Source del documento electrónico. |
|
|
Client
|
RecordClient | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Registro de cliente
|
RecordClientRecord | string | ||
|
Copiar documento del registro
|
CopyDocumentFromRecord | string |
Especifique un identificador único para el registro desde el que copiar el documento electrónico de este registro. |
|
|
Creador
|
RecordCreator | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Fecha de creación
|
RecordDateCreated | string | ||
|
Fecha de vencimiento
|
RecordDateDue | string | ||
|
Fecha de publicación
|
RecordDatePublished | string | ||
|
Fecha de recepción
|
RecordDateReceived | string | ||
|
Referencia externa
|
RecordExternalReference | string | ||
|
¿Se produce un error en las advertencias?
|
FailOnWarnings | boolean |
True para no crear o guardar un objeto si hay advertencias. |
|
|
Nombre de archivo en la carpeta Uploads
|
RecordFilePath | string |
Nombre de archivo tal como aparece en la carpeta Cargas. |
|
|
Finalizar en Guardar
|
RecordFinalizeOnSave | boolean | ||
|
Código de barras externo
|
RecordForeignBarcode | string | ||
|
Ubicación GPS
|
RecordGpsLocation | string | ||
|
Ubicación principal
|
RecordHomeLocation | string |
Identificador único de ubicación |
|
|
Espacio principal
|
RecordHomeSpace | string | ||
|
Está encerrada
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Mantener desprotegido
|
keepBookedOut | boolean |
True para dejar el registro desprotegido después de cargar el documento electrónico. |
|
|
Número largo
|
RecordLongNumber | string | ||
|
Tipo de medio
|
RecordMediaType | string | ||
|
Notas
|
RecordNotes | string | ||
|
Tipo de actualización de notas
|
NotesUpdateType | string | ||
|
Otro contacto
|
RecordOtherContact | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Ubicación del propietario
|
RecordOwnerLocation | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Registro relacionado
|
RecordRelatedRecord | string | ||
|
Representante
|
RecordRepresentative | string | ||
|
Fecha de revisión
|
RecordReviewDate | string | ||
|
Revisar fecha de vencimiento
|
RecordReviewDueDate | string | ||
|
Revisar estado
|
RecordReviewState | string | ||
|
Security
|
RecordSecurity | string |
Devoluciones
- Body
- CMRecordsResponse
Buscar el identificador único de la dirección de ubicación
Obtención del identificador único de la dirección secundaria de una ubicación
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo
|
type | string |
Seleccionar tipo de dirección |
|
|
Identificador único
|
LocationUri | True | string |
Identificador único de ubicación |
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
Devoluciones
- Dirección secundaria
- CMLocationAddressUri
Buscar objetos CM
Buscar objetos CM
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Buscar
|
TrimType | True | string | |
|
Cadena de consulta
|
q | True | string |
Escriba una consulta de búsqueda, por ejemplo, "all" para obtener todos los objetos. |
|
Aplicar valores predeterminados
|
ApplyDefaults | boolean |
True para aplicar el filtro predeterminado del usuario y ordenar esta búsqueda. |
|
|
Resultados de recuento
|
CountResults | boolean |
CountResults devuelve el recuento más confiable y el recuento más lento de los resultados de búsqueda totales. El recuento resultante está en la propiedad Count de respuesta. |
|
|
Propiedades descendientes
|
DescendantProperties | string |
Una lista separada por comas de propiedades de objeto, solo se aplica a las propiedades de objeto de esta y propiedades de nivel inferior, por ejemplo, RecordNumber,RecordTitle. |
|
|
Recuento de exclusión
|
ExcludeCount | boolean |
La devolución de TotalResults y SearchTitle puede degradar el rendimiento. Se establece en true si no se requieren TotalResults y SearchTitle. |
|
|
Filter
|
Filter | string |
Lista separada por espacios de cláusulas de búsqueda que se van a aplicar como filtro. |
|
|
De búsqueda
|
FromSearch | integer |
Identificador único de una búsqueda guardada desde la que se va a construir esta búsqueda. |
|
|
Incluir propiedad Defs
|
IncludePropertyDefs | boolean |
True para devolver una matriz de las definiciones de propiedad usadas por las propiedades de esta respuesta. |
|
|
Options
|
Options | string |
Establezca una o varias de las opciones establecidas normalmente en Opciones de usuario solo para esta búsqueda. Use ids de /PropertyDef? Get=SearchOptions service, anexe un signo menos para establecer en false; en caso contrario, se supone que es true. |
|
|
Tamaño de página
|
pageSize | integer |
Número de elementos que se van a devolver en cada página de resultados. Si está vacío, el valor predeterminado es el valor predeterminado establecido en la configuración. |
|
|
Valor de propiedad
|
PropertyValue | string |
Incluya el valor sin procesar, el valor de cadena o ambos en los resultados. |
|
|
Conjuntos de propiedades
|
PropertySets | string |
Uno o varios conjuntos de propiedades predefinidos, seleccione entre DataGridVisible, Detailed, FromSearch, All o un conjunto de propiedades personalizados tal como se define en la configuración del servicio. |
|
|
Propósito
|
purpose | integer |
Propiedad especial para filtrar los resultados de búsqueda en función de los valores de enumeración De propósito del objeto. |
|
|
Propósito adicional
|
purposeExtra | integer |
Necesario como complemento para algunos propósitos. El servicio ObjectDef proporciona información sobre el tipo enum o TrimMainObject que se va a especificar, en particular ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes y HaveExtraPurposeParameter. |
|
|
Ordenar por
|
sortBy | string |
Lista separada por comas de identificadores de cláusula de búsqueda. Use : para especificar descendente. Por ejemplo, |
|
|
Comenzar
|
start | integer |
Posición del conjunto de resultados que se va a iniciar, vacía (o 1) para comenzar al principio, 2 para comenzar en el segundo objeto, 3 en la tercera, etc. |
|
|
StringDisplayType
|
StringDisplayType | string |
Si devuelve el valor de cadena que se va a usar. |
|
|
Propiedades
|
properties | string |
Lista separada por comas de propiedades de objeto, por ejemplo, Uri,NameString |
Devoluciones
- Body
- CMBobResponse
Buscar registro por identificador
Capturar un único registro por identificador único o nombre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
identificación
|
Id | True | string |
Identificador único o Nombre del objeto |
|
Incluir definiciones de propiedad
|
IncludePropertyDefs | boolean |
True para devolver una matriz de las definiciones de propiedad usadas por las propiedades de esta respuesta |
|
|
Propiedades descendientes
|
descendantProperties | string |
Una lista separada por comas de propiedades de objeto, solo se aplica a las propiedades de objeto de esta y propiedades de nivel inferior, por ejemplo, RecordNumber,RecordTitle. |
|
|
Propiedades
|
properties | string |
Lista separada por comas de propiedades de objeto, por ejemplo, RecordNumber,RecordTitle. |
|
|
Conjuntos de propiedades
|
propertySets | string |
Uno o varios conjuntos de propiedades predefinidos, seleccione entre DataGridVisible, Detailed, FromSearch, All o un conjunto de propiedades personalizados tal como se define en la configuración del servicio. |
|
|
Valor de propiedad
|
PropertyValue | string |
Incluir el valor sin procesar, el valor de cadena o ambos en los resultados |
|
|
Tipo de presentación de cadena
|
stringDisplayType | string |
Si devuelve el valor de cadena que se va a usar |
Devoluciones
- Body
- CMRecordsResponse
Buscar registros
Buscar registros (capturar una colección de registros mediante una cadena de búsqueda)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Query
|
q | True | string |
Consulta de búsqueda |
|
Propiedades
|
properties | True | string |
Lista separada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Buscar registros (avanzados)
Busque Registros (capturar una colección de registros mediante una cadena de búsqueda). Devuelve una respuesta serviceAPI de Content Manager sin procesar.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Query
|
q | True | string |
Consulta de búsqueda |
|
Propiedades
|
properties | True | string |
Lista separada por comas de propiedades que se van a devolver |
Devoluciones
- response
- object
Buscar ubicaciones
Buscar ubicaciones (capturar una colección de ubicaciones mediante una cadena de búsqueda)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Query
|
q | True | string |
Escriba una consulta de búsqueda, por ejemplo, "all" para obtener todos los objetos. |
|
Aplicar valores predeterminados
|
ApplyDefaults | boolean |
True para aplicar el filtro predeterminado del usuario y ordenar esta búsqueda |
|
|
Resultados de recuento
|
CountResults | boolean |
True para incluir un recuento de los resultados |
|
|
Recuento de exclusión
|
ExcludeCount | boolean |
True para excluir un recuento de los resultados |
|
|
Filter
|
filter | string |
Lista separada por espacios de cláusulas de búsqueda que se van a aplicar como filtro. |
|
|
De búsqueda
|
fromSearch | string |
Identificador único de una búsqueda guardada desde la que se va a construir esta búsqueda. |
|
|
Propiedades descendientes
|
descendantProperties | string |
Una lista separada por comas de propiedades de objeto, solo se aplica a las propiedades de objeto de esta y propiedades de nivel inferior, por ejemplo, RecordNumber,RecordTitle |
|
|
Incluir definiciones de propiedad
|
IncludePropertyDefs | boolean |
True para devolver una matriz de las definiciones de propiedad usadas por las propiedades de esta respuesta |
|
|
Options
|
Options | string |
Establezca una o varias de las opciones establecidas normalmente en Opciones de usuario solo para esta búsqueda. Use ids de /PropertyDef? Get=SearchOptions service, anexe un signo menos para establecer en false; en caso contrario, se supone que es true. |
|
|
Propiedades
|
properties | string |
Lista separada por comas de propiedades de objeto, por ejemplo, RecordNumber,RecordTitle |
|
|
Conjuntos de propiedades
|
propertySets | string |
Uno o varios conjuntos de propiedades predefinidos, seleccione entre DataGridVisible, Detailed, FromSearch, All o un conjunto de propiedades personalizados tal y como se define en la configuración del servicio. |
|
|
Valor de propiedad
|
PropertyValue | string |
Incluir el valor sin procesar, el valor de cadena o ambos en los resultados |
|
|
Tamaño de página
|
pageSize | string |
Número de elementos que se van a devolver en cada página de resultados |
|
|
Propósito
|
purpose | string |
Propiedad especial para filtrar los resultados de la búsqueda en función de los valores de enumeración De propósito del objeto |
|
|
Propósito adicional
|
purposeExtra | string |
Necesario como complemento para algunos propósitos. El servicio ObjectDef proporciona información sobre el tipo enum o TrimMainObject que se va a especificar, en particular ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes y HaveExtraPurposeParameter. |
|
|
Ordenar por
|
sortBy | string |
Lista separada por comas de identificadores de cláusula de búsqueda |
|
|
Comenzar
|
start | string |
Posición del conjunto de resultados que se va a iniciar, vacía (o 1) para empezar al principio, 2 para comenzar en el segundo objeto, 3 en la tercera, etc. |
|
|
Tipo de presentación de cadena
|
stringDisplayType | string |
Si devuelve el valor de cadena que se va a usar |
Devoluciones
- Body
- CMLocationsResponse
Buscar ubicación por identificador
Capturar una sola ubicación por identificador único o nombre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Id | True | string |
Identificador único o Nombre del objeto |
|
Propiedades descendientes
|
descendantProperties | string |
Una lista separada por comas de propiedades de objeto, solo se aplica a las propiedades de objeto de esta y propiedades de nivel inferior, por ejemplo, Apellido,GivenNames |
|
|
Incluir definiciones de propiedad
|
IncludePropertyDefs | boolean |
True para devolver una matriz de las definiciones de propiedad usadas por las propiedades de esta respuesta |
|
|
Propiedades
|
properties | string |
Lista separada por comas de propiedades de objeto, por ejemplo, Apellido,GivenNames |
|
|
Conjuntos de propiedades
|
propertySets | string |
Uno o varios conjuntos de propiedades predefinidos, seleccione entre DataGridVisible, Detailed, FromSearch, All o un conjunto de propiedades personalizados tal y como se define en la configuración del servicio. |
|
|
Valor de propiedad
|
PropertyValue | string |
Incluir el valor sin procesar, el valor de cadena o ambos en los resultados |
|
|
Tipo de presentación de cadena
|
stringDisplayType | string |
Devuelve el valor de cadena que se va a usar. |
Devoluciones
- Body
- CMLocationsResponse
Cargar archivo electrónico
Cargar un archivo electrónico que se pueda adjuntar más adelante a un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Nombre de archivo
|
RecordFilePath | True | string | |
|
Identificador único
|
Uri | True | string |
Crear registro (avanzado)
Crear un registro con campos avanzados
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Tipo de registro
|
RecordRecordType | True | string | |
|
Título (parte de texto libre)
|
RecordTypedTitle | True | string | |
|
Classification
|
RecordClassification | string |
Proporcione el identificador único de la clasificación. |
|
|
Autor
|
RecordAuthor | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
|
|
Número de adhesión
|
RecordAccessionNumber | string | ||
|
Destinatario
|
RecordAddressee | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Contenedor alternativo
|
RecordAlternativeContainer | string | ||
|
Persona asignada
|
RecordAssignee | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Nivel de confianza de clasificación automática
|
RecordAutoClassificationConfidenceLevel | string | ||
|
Representación automática en PDF al guardar
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Omitir controles de acceso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
¿Omitir Guardar?
|
ByPassSave | boolean |
True para no guardar el objeto. Un uso de esto es establecer una o varias propiedades en una entrada registro y devolver el formulario de entrada de datos. A continuación, el formulario de entrada de datos reflejará las distintas propiedades establecidas en el registro original. |
|
|
Cambiar posición dentro de favoritos
|
ChangePositionWithinFavorites | string |
Cuando busque favoritos, se devolverán en este orden a menos que se use otra ordenación. |
|
|
Cambiar posición dentro de la etiqueta de usuario
|
ChangePositionWithinUserLabel | string |
Al buscar por UserLabel, se devolverán en este orden a menos que se use otra ordenación. |
|
|
Proteger como
|
CheckinAs | string |
Establezca la propiedad Source del documento electrónico. |
|
|
Clase de registro
|
RecordClassOfRecord | string | ||
|
Client
|
RecordClient | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Registro de cliente
|
RecordClientRecord | string | ||
|
Comentarios
|
comments | string |
Comentarios que se van a ir en las notas de registro cuando se carga el documento. |
|
|
Consignación
|
RecordConsignment | string | ||
|
Objeto de envío
|
RecordConsignmentObject | string | ||
|
Contenedor
|
RecordContainer | string | ||
|
Copiar documento del registro
|
CopyDocumentFromRecord | string |
Especifique un identificador único para el registro desde el que copiar el documento electrónico de este registro. |
|
|
Creador
|
RecordCreator | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Fecha de creación
|
RecordDateCreated | string | ||
|
Fecha de vencimiento
|
RecordDateDue | string | ||
|
Fecha de publicación
|
RecordDatePublished | string | ||
|
Fecha de recepción
|
RecordDateReceived | string | ||
|
Editor
|
RecordEditor | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Referencia externa
|
RecordExternalReference | string | ||
|
¿Se produce un error en las advertencias?
|
FailOnWarnings | boolean |
True para no crear o guardar un objeto si hay advertencias. |
|
|
Nombre de archivo en la carpeta Uploads
|
RecordFilePath | string |
Nombre de archivo tal como aparece en la carpeta Cargas. |
|
|
Finalizar en Guardar
|
RecordFinalizeOnSave | boolean | ||
|
Código de barras externo
|
RecordForeignBarcode | string | ||
|
Ubicación GPS
|
RecordGpsLocation | string | ||
|
Ubicación principal
|
RecordHomeLocation | string |
Identificador único de ubicación |
|
|
Espacio principal
|
RecordHomeSpace | string | ||
|
Iniciar plantilla
|
RecordInitiateTemplate | string | ||
|
Está encerrada
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Mantener desprotegido
|
keepBookedOut | boolean |
True para dejar el registro desprotegido después de cargar el documento electrónico. |
|
|
Fecha de última acción
|
RecordLastActionDate | string | ||
|
Número largo
|
RecordLongNumber | string | ||
|
Activar
|
MakeActive | string |
Revierte el estado del registro (y cualquiera de sus contenidos) para que ya no esté inactivo. Al procesar el contenido, puede especificar si la tarea debe detenerse si se producen errores. |
|
|
Hacer inactivo
|
MakeInactive | string |
Establece dateInactive para este registro y cualquiera de sus contenidos. Al procesar el contenido, puede especificar si la tarea debe detenerse si se producen errores. |
|
|
Crear nueva revisión
|
makeNewRevision | boolean |
True para crear una nueva revisión con este documento electrónico false para reemplazar la revisión actual. |
|
|
Fecha de destrucción manual
|
RecordManualDestructionDate | string | ||
|
Registro de materia
|
RecordMatterRecord | string | ||
|
Tipo de medio
|
RecordMediaType | string | ||
|
Mis comentarios de autorización
|
RecordMyAuthorizationComments | string | ||
|
Mi autorización completada
|
RecordMyAuthorizationComplete | boolean | ||
|
Mis comentarios de revisión
|
RecordMyReviewComments | string | ||
|
Mi revisión completada
|
RecordMyReviewComplete | boolean | ||
|
¿Necesita autorización?
|
RecordNeedsAuthorization | boolean | ||
|
¿Necesita revisión?
|
RecordNeedsReview | boolean | ||
|
Nueva regla de creación de elementos
|
RecordNewPartCreationRule | string |
Identificador único de la regla de creación de elementos automáticos |
|
|
Notas
|
RecordNotes | string | ||
|
Tipo de actualización de notas
|
NotesUpdateType | string | ||
|
Otro contacto
|
RecordOtherContact | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Ubicación del propietario
|
RecordOwnerLocation | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
¿Jerarquía del preservador en la entrada de datos?
|
RecordPreserveHierarchyOnDataEntry | boolean | ||
|
Registro de elemento anterior
|
RecordPrevPartRecord | string | ||
|
Priority
|
RecordPriority | string | ||
|
Registrar nuevo tipo
|
RecordNewType | string |
Deje como predeterminado a menos que cree una nueva versión de elemento o una copia. |
|
|
Registro relacionado
|
RecordRelatedRecord | string | ||
|
Representante
|
RecordRepresentative | string | ||
|
Programación de retención
|
RecordRetentionSchedule | string | ||
|
Fecha de revisión
|
RecordReviewDate | string | ||
|
Revisar fecha de vencimiento
|
RecordReviewDueDate | string | ||
|
Revisar estado
|
RecordReviewState | string | ||
|
Security
|
RecordSecurity | string | ||
|
Registro de serie
|
RecordSeriesRecord | string | ||
|
Conjuntos de propiedades
|
propertySets | string |
Especifique conjuntos de propiedades además de los publicados que se devolverán mediante la solicitud. |
|
|
Cadena de consulta
|
q | string |
Especifique una consulta aquí para aplicar la actualización a un conjunto de registros en lugar de solo una (según lo especificado por el identificador único). |
Devoluciones
- Body
- CMRecordsResponse
Crear registro (carpeta)
Crear un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Tipo de registro
|
RecordRecordType | True | string | |
|
Título (parte de texto libre)
|
RecordTypedTitle | True | string | |
|
Classification
|
RecordClassification | string |
Proporcione el identificador único de la clasificación. |
|
|
Contenedor
|
RecordContainer | string | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
|
|
Autor
|
RecordAuthor | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Destinatario
|
RecordAddressee | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Contenedor alternativo
|
RecordAlternativeContainer | string | ||
|
Persona asignada
|
RecordAssignee | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Omitir controles de acceso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Client
|
RecordClient | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Creador
|
RecordCreator | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Fecha de creación
|
RecordDateCreated | string | ||
|
Fecha de vencimiento
|
RecordDateDue | string | ||
|
Fecha de publicación
|
RecordDatePublished | string | ||
|
Referencia externa
|
RecordExternalReference | string | ||
|
¿Se produce un error en las advertencias?
|
FailOnWarnings | boolean |
True para no crear o guardar un objeto si hay advertencias. |
|
|
Nombre de archivo en la carpeta Uploads
|
RecordFilePath | string |
Nombre de archivo tal como aparece en la carpeta Cargas. |
|
|
Código de barras externo
|
RecordForeignBarcode | string | ||
|
Ubicación GPS
|
RecordGpsLocation | string | ||
|
Ubicación principal
|
RecordHomeLocation | string |
Identificador único de ubicación |
|
|
Espacio principal
|
RecordHomeSpace | string | ||
|
Está encerrada
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Fecha de última acción
|
RecordLastActionDate | string | ||
|
Número largo
|
RecordLongNumber | string | ||
|
Notas
|
RecordNotes | string | ||
|
Tipo de actualización de notas
|
NotesUpdateType | string | ||
|
Otro contacto
|
RecordOtherContact | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Ubicación del propietario
|
RecordOwnerLocation | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Registro relacionado
|
RecordRelatedRecord | string | ||
|
Representante
|
RecordRepresentative | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Fecha de revisión
|
RecordReviewDate | string | ||
|
Revisar fecha de vencimiento
|
RecordReviewDueDate | string | ||
|
Revisar estado
|
RecordReviewState | string | ||
|
Security
|
RecordSecurity | string |
Devoluciones
- Body
- CMRecordsResponse
Crear registro (documento)
Crear un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Tipo de registro
|
RecordRecordType | True | string | |
|
Título (parte de texto libre)
|
RecordTypedTitle | True | string | |
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
|
|
Autor
|
RecordAuthor | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Destinatario
|
RecordAddressee | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Contenedor alternativo
|
RecordAlternativeContainer | string | ||
|
Persona asignada
|
RecordAssignee | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Representación automática en PDF al guardar
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Omitir controles de acceso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Proteger como
|
CheckinAs | string |
Establezca la propiedad Source del documento electrónico. |
|
|
Classification
|
RecordClassification | string |
Proporcione el identificador único de la clasificación. |
|
|
Client
|
RecordClient | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Registro de cliente
|
RecordClientRecord | string | ||
|
Contenedor
|
RecordContainer | string | ||
|
Copiar documento del registro
|
CopyDocumentFromRecord | string |
Especifique un identificador único para el registro desde el que copiar el documento electrónico de este registro. |
|
|
Creador
|
RecordCreator | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Fecha de creación
|
RecordDateCreated | string | ||
|
Fecha de vencimiento
|
RecordDateDue | string | ||
|
Fecha de publicación
|
RecordDatePublished | string | ||
|
Fecha de recepción
|
RecordDateReceived | string | ||
|
Referencia externa
|
RecordExternalReference | string | ||
|
¿Se produce un error en las advertencias?
|
FailOnWarnings | boolean |
True para no crear o guardar un objeto si hay advertencias. |
|
|
Nombre de archivo en la carpeta Uploads
|
RecordFilePath | string |
Nombre de archivo tal como aparece en la carpeta Cargas. |
|
|
Finalizar en Guardar
|
RecordFinalizeOnSave | boolean | ||
|
Código de barras externo
|
RecordForeignBarcode | string | ||
|
Ubicación GPS
|
RecordGpsLocation | string | ||
|
Ubicación principal
|
RecordHomeLocation | string |
Identificador único de ubicación |
|
|
Espacio principal
|
RecordHomeSpace | string | ||
|
Está encerrada
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Mantener desprotegido
|
keepBookedOut | boolean |
True para dejar el registro desprotegido después de cargar el documento electrónico. |
|
|
Fecha de última acción
|
RecordLastActionDate | string | ||
|
Número largo
|
RecordLongNumber | string | ||
|
Tipo de medio
|
RecordMediaType | string | ||
|
Notas
|
RecordNotes | string | ||
|
Tipo de actualización de notas
|
NotesUpdateType | string | ||
|
Otro contacto
|
RecordOtherContact | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Ubicación del propietario
|
RecordOwnerLocation | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Registro relacionado
|
RecordRelatedRecord | string | ||
|
Representante
|
RecordRepresentative | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Fecha de revisión
|
RecordReviewDate | string | ||
|
Revisar fecha de vencimiento
|
RecordReviewDueDate | string | ||
|
Revisar estado
|
RecordReviewState | string | ||
|
Security
|
RecordSecurity | string |
Devoluciones
- Body
- CMRecordsResponse
Crear ubicación (otro)
Crear una ubicación de cualquier tipo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Tipo de ubicación
|
LocationTypeOfLocation | string | ||
|
Nombre
|
LocationSortName | True | string | |
|
Nombre único
|
LocationNickName | string | ||
|
Número de id.
|
LocationIdNumber | string | ||
|
Interno
|
LocationIsWithin | boolean | ||
|
Teléfono del trabajo
|
LocationPhoneNumber | string | ||
|
Teléfono móvil
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Teléfono fijo
|
LocationAfterHoursPhoneNumber | string | ||
|
Igual que la dirección
|
LocationUseAddressOf | integer |
Identificador único de ubicación |
|
|
Tipo de dirección
|
LocationAddressAddressType | string |
Seleccione tipo de dirección. Límite de uno por tipo. |
|
|
Calle
|
LocationAddressAddressLines | string | ||
|
Suburbio/Ciudad
|
LocationAddressCity | string | ||
|
Estado
|
LocationAddressState | string | ||
|
Cp
|
LocationAddressPostcode | string | ||
|
País
|
LocationAddressCountry | string | ||
|
Convertir el valor predeterminado
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Id. único relacionado
|
AddRelationshipRelatedLocation | integer | ||
|
Tipo
|
AddRelationshipRelationshipType | string | ||
|
Dirección de correo electrónico
|
LocationEmailAddress | string | ||
|
De
|
SetActiveDateRangeValidFromDate | string |
dd/mm/aaaa |
|
|
Para
|
SetActiveDateRangeValidToDate | string |
dd/mm/aaaa |
|
|
Notas
|
LocationNotes | string | ||
|
Tipo de actualización de notas
|
NotesUpdateType | string |
Devoluciones
- Body
- CMLocationsResponse
Crear ubicación (persona)
Crear una ubicación de persona
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Title
|
LocationHonorific | string | ||
|
Apellido
|
LocationSurname | string | ||
|
Nombre
|
LocationGivenNames | string | ||
|
Interno
|
LocationIsWithin | boolean | ||
|
Título del Puesto
|
LocationJobDescription | string | ||
|
Fecha de nacimiento
|
LocationDateOfBirth | string | ||
|
Saludo
|
LocationSalutation | string | ||
|
Nombre único
|
LocationNickName | string | ||
|
Número de id.
|
LocationIdNumber | string | ||
|
Teléfono del trabajo
|
LocationPhoneNumber | string | ||
|
Teléfono móvil
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Teléfono fijo
|
LocationAfterHoursPhoneNumber | string | ||
|
Igual que la dirección
|
LocationUseAddressOf | integer |
Identificador único de ubicación |
|
|
Tipo de dirección
|
LocationAddressAddressType | string |
Seleccione tipo de dirección. Límite de uno por tipo. |
|
|
Calle
|
LocationAddressAddressLines | string | ||
|
Suburbio/Ciudad
|
LocationAddressCity | string | ||
|
Estado
|
LocationAddressState | string | ||
|
Cp
|
LocationAddressPostcode | string | ||
|
País
|
LocationAddressCountry | string | ||
|
Convertir el valor predeterminado
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Id. único relacionado
|
AddRelationshipRelatedLocation | integer | ||
|
Tipo
|
AddRelationshipRelationshipType | string | ||
|
Dirección de correo electrónico
|
LocationEmailAddress | string | ||
|
Gender
|
LocationGenderValue | string | ||
|
Aceptar inicios de sesión
|
LocationCanLogin | boolean | ||
|
Inicio de sesión de red
|
LocationLogsInAs | string | ||
|
Inicio de sesión de red adicional
|
LocationAdditionalLogin | string | ||
|
El inicio de sesión expira al
|
LocationLoginExpires | string | ||
|
Perfil de usuario de
|
LocationUseProfileOf | integer |
Identificador único de ubicación |
|
|
Tipo de usuario
|
LocationUserType | string | ||
|
Cadena de seguridad
|
LocationSecurityString | string | ||
|
De
|
SetActiveDateRangeValidFromDate | string |
dd/mm/aaaa |
|
|
Para
|
SetActiveDateRangeValidToDate | string |
dd/mm/aaaa |
|
|
Notas
|
LocationNotes | string | ||
|
Tipo de actualización de notas
|
NotesUpdateType | string |
Devoluciones
- Body
- CMLocationsResponse
Descargar archivo electrónico
Descargar un archivo electrónico de un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único
|
uri | True | string |
Identificador único o número de registro |
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
Devoluciones
- response
- binary
Eliminar registro
Eliminar un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer |
Identificador único del registro que se va a eliminar |
|
¿Eliminar contenido?
|
DeleteContents | True | boolean | |
|
Nuevo inicio para contenido
|
NewHomeForContents | string |
El identificador único o la dirección de correo electrónico de la nueva ubicación principal del contenido |
Devoluciones
- Body
- CMRecordsResponse
Leer datos de eventos
Transformación de datos de eventos de Kapish Dispatch para el consumo de flujo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Content
|
Content | string |
Contenido de la acción de Service Bus que recuperó los datos de eventos de CM. |
Devoluciones
- Body
- CMEventData
Obtener archivo de la dirección URL
Descarga de un archivo de la dirección URL a un área de almacenamiento provisional mediante el complemento de LA API del servicio CM "GetFileFromUrl"
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Dirección URL del archivo
|
url | True | string |
Dirección URL sin codificar del archivo que se va a descargar |
|
Nombre de archivo que se va a guardar como
|
filename | string |
Nombre de archivo para guardar la dirección URL descargada como (solo el nombre de archivo con sufijo, no incluya el directorio completo) |
|
|
Tipo de contenido
|
contentType | string |
Cadena típica que se encuentra en la mayoría del encabezado Content-Type (por ejemplo, image/png, text/plain, application/pdf). |
Devoluciones
Respuesta del complemento de LA API del servicio CM "GetFileFromUrl".
- Archivo
- GetFileFromUrlResponse
Registro de actualización (acciones completas)
Completar una o todas las acciones debidas en un registro determinado
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Completo
|
Complete | True | string |
Especificar qué acciones de registro se van a completar |
|
Completar acciones anteriores
|
CompletePrevious | boolean |
Completar todas las acciones de registro antes de la especificada |
|
|
Fecha de finalización
|
CompletionDate | date |
Fecha que se va a establecer como fecha de finalización |
|
|
Identificador único de acción de registro
|
RecordActionUri | integer |
Identificador único de la acción de registro que se va a completar si se selecciona "Para identificador único" |
|
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (acciones de reprogramación)
Vuelve a programar todas las acciones adjuntas a este registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Fecha base
|
FromBaseDate | date | ||
|
Usar duraciones reales
|
UseActualDurations | boolean | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (adjuntar acción o procedimiento)
Adjuntar una acción o un procedimiento a un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Acción que se va a adjuntar
|
ActionToAttach | True | integer | |
|
Id. único del receptor
|
NewAssignee | integer | ||
|
Opción Assignee
|
AssigneeOption | string | ||
|
Fecha de inicio de programación
|
ScheduleStartDate | date | ||
|
Acción existente
|
RecordAction | integer | ||
|
Insertar posición
|
InsertPos | string | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (adjuntar archivo electrónico)
Adjuntar un archivo electrónico a un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Archivo
|
File | True | file |
Contenido o cuerpo del archivo del documento electrónico que se va a adjuntar |
|
Identificador único
|
Uri | True | string |
Identificador único del registro |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (adjuntar contacto)
Adjuntar un contacto a un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Tipo de contacto
|
ContactType | True | string | |
|
Ubicación de contacto
|
ContactLocation | True | string |
Identificador único o dirección de correo electrónico de ubicación |
|
¿Se establece como contacto principal?
|
IsPrimary | True | boolean | |
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (adjuntar término de sinónimos)
Adjuntar un término de diccionario de sinónimos a un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Registro
|
Uri | True | integer |
Identificador único del registro al que se va a adjuntar el término del diccionario de sinónimos. |
|
Término de diccionario de sinónimos
|
Keyword | True | string |
Identificador único o nombre del término de diccionario de sinónimos que se va a adjuntar |
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (agregar controles de acceso)
AddAccessControl
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Id. único
|
Uri | integer |
Identificador único de ubicación |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (avanzado)
Actualizar un registro con propiedades avanzadas
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Tipo de registro
|
RecordRecordType | string | ||
|
Classification
|
RecordClassification | string |
Proporcione el identificador único de la clasificación. |
|
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
|
|
Autor
|
RecordAuthor | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Número de adhesión
|
RecordAccessionNumber | string | ||
|
Destinatario
|
RecordAddressee | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Contenedor alternativo
|
RecordAlternativeContainer | string | ||
|
Persona asignada
|
RecordAssignee | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Nivel de confianza de clasificación automática
|
RecordAutoClassificationConfidenceLevel | string | ||
|
Representación automática en PDF al guardar
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Omitir controles de acceso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
¿Omitir Guardar?
|
ByPassSave | boolean |
True para no guardar el objeto. Un uso de esto es establecer una o varias propiedades en una entrada registro y devolver el formulario de entrada de datos. A continuación, el formulario de entrada de datos reflejará las distintas propiedades establecidas en el registro original. |
|
|
Cambiar posición dentro de favoritos
|
ChangePositionWithinFavorites | string |
Cuando busque favoritos, se devolverán en este orden a menos que se use otra ordenación. |
|
|
Cambiar posición dentro de la etiqueta de usuario
|
ChangePositionWithinUserLabel | string |
Al buscar por UserLabel, se devolverán en este orden a menos que se use otra ordenación. |
|
|
Proteger como
|
CheckinAs | string |
Establezca la propiedad Source del documento electrónico. |
|
|
Clase de registro
|
RecordClassOfRecord | string | ||
|
Client
|
RecordClient | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Registro de cliente
|
RecordClientRecord | string | ||
|
Comentarios
|
comments | string |
Comentarios que se van a ir en las notas de registro cuando se carga el documento. |
|
|
Consignación
|
RecordConsignment | string | ||
|
Objeto de envío
|
RecordConsignmentObject | string | ||
|
Contenedor
|
RecordContainer | string | ||
|
Copiar documento del registro
|
CopyDocumentFromRecord | string |
Especifique un identificador único para el registro desde el que copiar el documento electrónico de este registro. |
|
|
Creador
|
RecordCreator | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Fecha de creación
|
RecordDateCreated | string | ||
|
Fecha de vencimiento
|
RecordDateDue | string | ||
|
Fecha de publicación
|
RecordDatePublished | string | ||
|
Fecha de recepción
|
RecordDateReceived | string | ||
|
Editor
|
RecordEditor | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Almacén electrónico de documentos
|
RecordEStore | string | ||
|
Referencia externa
|
RecordExternalReference | string | ||
|
¿Se produce un error en las advertencias?
|
FailOnWarnings | boolean |
True para no crear o guardar un objeto si hay advertencias. |
|
|
Nombre de archivo en la carpeta Uploads
|
RecordFilePath | string |
Nombre de archivo tal como aparece en la carpeta Cargas. |
|
|
Finalizar en Guardar
|
RecordFinalizeOnSave | boolean | ||
|
Código de barras externo
|
RecordForeignBarcode | string | ||
|
Ubicación GPS
|
RecordGpsLocation | string | ||
|
Ubicación principal
|
RecordHomeLocation | string |
Identificador único de ubicación |
|
|
Espacio principal
|
RecordHomeSpace | string | ||
|
Está encerrada
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Mantener desprotegido
|
keepBookedOut | boolean |
True para dejar el registro desprotegido después de cargar el documento electrónico. |
|
|
Fecha de última acción
|
RecordLastActionDate | string | ||
|
Número largo
|
RecordLongNumber | string | ||
|
Activar
|
MakeActive | string |
Revierte el estado del registro (y cualquiera de sus contenidos) para que ya no esté inactivo. Al procesar el contenido, puede especificar si la tarea debe detenerse si se producen errores. |
|
|
Hacer inactivo
|
MakeInactive | string |
Establece dateInactive para este registro y cualquiera de sus contenidos. Al procesar el contenido, puede especificar si la tarea debe detenerse si se producen errores. |
|
|
Crear nueva revisión
|
makeNewRevision | boolean |
True para crear una nueva revisión con este documento electrónico false para reemplazar la revisión actual. |
|
|
Fecha de destrucción manual
|
RecordManualDestructionDate | string | ||
|
Registro de materia
|
RecordMatterRecord | string | ||
|
Tipo de medio
|
RecordMediaType | string | ||
|
Mis comentarios de autorización
|
RecordMyAuthorizationComments | string | ||
|
Mi autorización completada
|
RecordMyAuthorizationComplete | boolean | ||
|
Mis comentarios de revisión
|
RecordMyReviewComments | string | ||
|
Mi revisión completada
|
RecordMyReviewComplete | boolean | ||
|
¿Necesita autorización?
|
RecordNeedsAuthorization | boolean | ||
|
¿Necesita revisión?
|
RecordNeedsReview | boolean | ||
|
Nueva regla de creación de elementos
|
RecordNewPartCreationRule | string |
Identificador único de la regla de creación de elementos automáticos |
|
|
Notas
|
RecordNotes | string | ||
|
Tipo de actualización de notas
|
NotesUpdateType | string | ||
|
Otro contacto
|
RecordOtherContact | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
Ubicación del propietario
|
RecordOwnerLocation | string |
Identificador único o dirección de correo electrónico de ubicación |
|
|
¿Jerarquía del preservador en la entrada de datos?
|
RecordPreserveHierarchyOnDataEntry | boolean | ||
|
Registro de elemento anterior
|
RecordPrevPartRecord | string | ||
|
Priority
|
RecordPriority | string | ||
|
Registrar nuevo tipo
|
RecordNewType | string |
Deje como predeterminado a menos que cree una nueva versión de elemento o una copia. |
|
|
Registro relacionado
|
RecordRelatedRecord | string | ||
|
Representante
|
RecordRepresentative | string | ||
|
Programación de retención
|
RecordRetentionSchedule | string | ||
|
Fecha de revisión
|
RecordReviewDate | string | ||
|
Revisar fecha de vencimiento
|
RecordReviewDueDate | string | ||
|
Revisar estado
|
RecordReviewState | string | ||
|
Security
|
RecordSecurity | string | ||
|
Registro de serie
|
RecordSeriesRecord | string | ||
|
Título (parte de texto libre)
|
RecordTypedTitle | string | ||
|
Cadena de consulta
|
q | string |
Especifique una consulta aquí para aplicar la actualización a un conjunto de registros en lugar de solo una (según lo especificado por el identificador único). |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (campos adicionales)
Actualizar campos adicionales en un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | integer | ||
|
Nombre
|
SearchClause | string | ||
|
Importancia
|
Value | string | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (cerrar)
Use la función CloseRecord para cerrar un contenedor: deje la fecha en blanco si desea que la fecha de cierre sea "now". Dado que el cierre de un registro puede requerir la actualización de muchos registros contenidos, esta función confirma los cambios automáticamente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
¿Continúa con error?
|
ContinueOnError | boolean | ||
|
¿Encierra contenido?
|
EncloseContents | boolean | ||
|
¿Finalizar el contenido?
|
FinalizeContents | boolean | ||
|
¿Solo errores de registro?
|
LogErrorsOnly | boolean | ||
|
¿Resultados del registro?
|
LogResults | boolean |
¿Devuelve un registro de texto de los registros cerrados en la propiedad Mensaje de registro? |
|
|
¿Purgar revisiones de contenido?
|
PurgeContentRevisions | boolean | ||
|
¿Fecha de cierre específica?
|
SpecificCloseDate | date | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMLogResponse
Registro de actualización (clasificación)
Actualizar la clasificación de un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Classification
|
RecordClassification | True | string |
Proporcione el identificador único de la clasificación. |
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (desdispose)
Revierte el estado del registro (y cualquiera de sus contenidos) para que ya no se elimine.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
¿Continúa con el error?
|
ContinueOnError | boolean | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (deshacer desprotección)
Deshacer una desprotección anterior del documento electrónico para este Registro, ignorando los cambios realizados desde que se desprotegió
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Comentarios
|
Comments | string | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (Dispose)
Eliminación de un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
¿Continúa con el error?
|
ContinueOnError | boolean | ||
|
Método de eliminación
|
MethodOfDisposal | string | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (establecer acceso sin restricciones o basado en el contenedor)
InheritAccessControl
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Id. único
|
Uri | integer |
Identificador único de ubicación |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (establecer asignado)
Establezca assignee en una ubicación determinada, vuelva a Inicio o regístrese como Falta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Nuevo asignado
|
NewAssignee | string |
Identificador único o dirección de correo electrónico del nuevo receptor |
|
|
Tipo asignado
|
AssigneeType | string | ||
|
Vencimiento de devolución por fecha
|
DueForReturnByDate | date | ||
|
Cambio de tiempo real
|
ActualTimeChangeOccurred | date-time | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (establecer etiqueta de usuario)
Permite la configuración de una etiqueta de usuario en un registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Registro
|
Uri | True | integer |
Identificador único del registro al que se va a adjuntar la etiqueta de usuario. |
|
Etiqueta de usuario
|
UserLabel | True | string |
Identificador único o nombre de la etiqueta de usuario que se va a aplicar |
|
Tipo favorito
|
FavouriteType | string | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (finalización)
Actualizar un borrador de registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Quitar revisiones antiguas
|
SetAsFinalRemoveOldRevisions | boolean | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (quitar la ubicación de los controles de acceso)
RemoveAccessControl
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Id. único
|
Uri | integer |
Identificador único de ubicación |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (quitar todas las acciones)
Quita todas las acciones adjuntas al registro especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (reemplazar controles de acceso)
SetAccessControl
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Id. único
|
Uri | integer |
Identificador único de ubicación |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (representación de solicitudes)
Permite crear una solicitud para que el motor de representación automático realice una representación de un registro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
Tipo de representación
|
RenditionType | True | string | |
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (unfinalise: establecer como borrador)
Actualizar un registro finalizado a borrador
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer |
Devoluciones
- Body
- CMRecordsResponse
Registro de actualización (volver a abrir)
Use la función ReopenRecord para volver a abrir un contenedor cerrado. Dado que volver a abrir un registro puede requerir la actualización de muchos registros contenidos, esta función confirma los cambios automáticamente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer | |
|
¿Continúa con error?
|
ContinueOnError | boolean | ||
|
¿Resultados del registro?
|
LogResults | boolean |
¿Devuelve un registro de texto de los registros vueltos a abrir en la propiedad Mensaje de registro? |
|
|
¿Definalizar contenido?
|
UnfinalizeContents | boolean | ||
|
Propiedades
|
Properties | string |
Lista delimitada por comas de propiedades que se van a devolver |
Devoluciones
- Body
- CMLogResponse
Ubicación de actualización (campos adicionales)
Actualizar campos adicionales en una ubicación
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | integer | ||
|
Nombre
|
SearchClause | string | ||
|
Importancia
|
Value | string |
Devoluciones
- Body
- CMLocationsResponse
Ubicación de actualización (dirección)
Crear o actualizar la dirección de una ubicación mediante el identificador único de la dirección
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | True | integer |
URI de la ubicación existente que se va a actualizar |
|
Id. único
|
Uri | integer |
El URI de la calle o dirección postal existente que se va a actualizar. |
|
|
Tipo
|
LocationAddressAddressType | string |
Seleccione tipo de dirección. Límite de uno por tipo. |
|
|
Calle
|
LocationAddressAddressLines | string | ||
|
Suburbio/Ciudad
|
LocationAddressCity | string | ||
|
Estado
|
LocationAddressState | string | ||
|
Cp
|
LocationAddressPostcode | string | ||
|
País
|
LocationAddressCountry | string |
Devoluciones
- Body
- CMLocationsResponse
Ubicación de actualización (otra)
Actualizar una ubicación
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | integer | ||
|
Cadena de consulta
|
q | string |
Especifique una consulta aquí para aplicar la actualización a un conjunto de ubicaciones en lugar de solo una (según lo especificado por el identificador único). |
|
|
Nombre
|
LocationSortName | string | ||
|
Nombre único
|
LocationNickName | string | ||
|
Número de id.
|
LocationIdNumber | string | ||
|
Teléfono del trabajo
|
LocationPhoneNumber | string | ||
|
Teléfono móvil
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Teléfono fijo
|
LocationAfterHoursPhoneNumber | string | ||
|
Igual que la dirección
|
LocationUseAddressOf | integer |
Identificador único de ubicación |
|
|
Convertir el valor predeterminado
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Id. único relacionado
|
AddRelationshipRelatedLocation | integer | ||
|
Tipo
|
AddRelationshipRelationshipType | string | ||
|
Dirección de correo electrónico
|
LocationEmailAddress | string | ||
|
De
|
SetActiveDateRangeValidFromDate | string |
dd/mm/aaaa |
|
|
Para
|
SetActiveDateRangeValidToDate | string |
dd/mm/aaaa |
|
|
Notas
|
LocationNotes | string | ||
|
Tipo de actualización de notas
|
NotesUpdateType | string | ||
|
Id. único relacionado
|
RemoveRelationshipRelatedLocation | integer |
Devoluciones
- Body
- CMLocationsResponse
Ubicación de actualización (persona)
Actualizar una ubicación de persona mediante su identificador único
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Usuario para suplantar
|
userToImpersonate | string |
Inicio de sesión de red o inicio de sesión alternativo de la ubicación en CM para suplantar |
|
|
Identificador único
|
Uri | integer | ||
|
Cadena de consulta
|
q | string |
Especifique una consulta aquí para aplicar la actualización a un conjunto de ubicaciones en lugar de solo una (según lo especificado por el identificador único). |
|
|
Title
|
LocationHonorific | string | ||
|
Apellido
|
LocationSurname | string | ||
|
Nombre
|
LocationGivenNames | string | ||
|
Interno
|
LocationIsWithin | boolean | ||
|
Título del Puesto
|
LocationJobDescription | string | ||
|
Fecha de nacimiento
|
LocationDateOfBirth | string | ||
|
Saludo
|
LocationSalutation | string | ||
|
Nombre único
|
LocationNickName | string | ||
|
Número de id.
|
LocationIdNumber | string | ||
|
Teléfono del trabajo
|
LocationPhoneNumber | string | ||
|
Teléfono móvil
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Teléfono fijo
|
LocationAfterHoursPhoneNumber | string | ||
|
Igual que la dirección
|
LocationUseAddressOf | integer |
Identificador único de ubicación |
|
|
Convertir el valor predeterminado
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Id. único relacionado
|
AddRelationshipRelatedLocation | integer | ||
|
Tipo
|
AddRelationshipRelationshipType | string | ||
|
Dirección de correo electrónico
|
LocationEmailAddress | string | ||
|
Gender
|
LocationGenderValue | string | ||
|
Aceptar inicios de sesión
|
LocationCanLogin | boolean | ||
|
Inicio de sesión de red
|
LocationLogsInAs | string | ||
|
Inicio de sesión de red adicional
|
LocationAdditionalLogin | string | ||
|
El inicio de sesión expira al
|
LocationLoginExpires | string | ||
|
Perfil de usuario de
|
LocationUseProfileOf | integer |
Identificador único de ubicación |
|
|
Tipo de usuario
|
LocationUserType | string | ||
|
Cadena de seguridad
|
LocationSecurityString | string | ||
|
De
|
SetActiveDateRangeValidFromDate | string |
dd/mm/aaaa |
|
|
Para
|
SetActiveDateRangeValidToDate | string |
dd/mm/aaaa |
|
|
Notas
|
LocationNotes | string | ||
|
Tipo de actualización de notas
|
NotesUpdateType | string | ||
|
Id. único relacionado
|
RemoveRelationshipRelatedLocation | integer |
Devoluciones
- Body
- CMLocationsResponse
Definiciones
CMRecord
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Ruta de acceso del archivo
|
RecordFilePath | string |
El nombre de archivo tal y como aparece en la carpeta Uploads |
|
Número de adhesión
|
RecordAccessionNumber | integer | |
|
Destinatario
|
RecordAddressee | integer | |
|
Contenedor alternativo
|
RecordAlternativeContainer | integer | |
|
Persona asignada
|
RecordAssignee | integer | |
|
Autor
|
RecordAuthor | integer | |
|
Método de autorización
|
RecordAuthorizationMethod | string | |
|
Nivel de confianza de clasificación automática
|
RecordAutoClassificationConfidenceLevel | integer | |
|
Representación automática en PDF al guardar
|
RecordAutoRenderToPDFOnSave | boolean | |
|
Título de impresión azul
|
RecordBlueprintTitle | string | |
|
Omitir controles de acceso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | |
|
Protegido por
|
RecordCheckedInBy | integer | |
|
Desprotegido para
|
RecordCheckedOutTo | integer | |
|
Classification
|
RecordClassification | integer | |
|
Clase de registro
|
RecordClassOfRecord | string | |
|
Client
|
RecordClient | integer | |
|
Registro de cliente
|
RecordClientRecord | integer | |
|
Consignación
|
RecordConsignment | string | |
|
Objeto de envío
|
RecordConsignmentObject | string | |
|
Contenedor
|
RecordContainer | integer | |
|
Creador
|
RecordCreator | integer | |
|
Versión actual
|
RecordCurrentVersion | string | |
|
Fecha cerrada
|
RecordDateClosed | date-time | |
|
Fecha de creación
|
RecordDateCreated | date-time | |
|
Fecha de vencimiento
|
RecordDateDue | date-time | |
|
Fecha de finalización
|
RecordDateFinalized | date-time | |
|
Fecha importada
|
RecordDateImported | date-time | |
|
Fecha inactiva
|
RecordDateInactive | date-time | |
|
Fecha de modificación
|
RecordDateModified | date-time | |
|
Fecha de publicación
|
RecordDatePublished | date-time | |
|
Fecha de recepción
|
RecordDateReceived | date-time | |
|
Fecha registrada
|
RecordDateRegistered | date-time | |
|
Adjuntar documentos pendientes
|
RecordDocumentAttachPending | boolean | |
|
Tamaño del documento
|
RecordDocumentSize | integer | |
|
Tipo documento
|
RecordDocumentType | string | |
|
Editor
|
RecordEditor | integer | |
|
Almacén electrónico de documentos
|
RecordEStore | integer | |
|
Extensión de documento
|
RecordExtension | string | |
|
Referencia externa
|
RecordExternalReference | string | |
|
Finalizar en Guardar
|
RecordFinalizeOnSave | boolean | |
|
Origen de la carpeta
|
RecordFolderOrigin | integer | |
|
Código de barras externo
|
RecordForeignBarcode | string | |
|
Título generado
|
RecordGeneratedTitle | string | |
|
Ubicación GPS
|
RecordGpsLocation | string | |
|
Ubicación principal
|
RecordHomeLocation | integer | |
|
Espacio principal
|
RecordHomeSpace | integer | |
|
Iniciar plantilla
|
RecordInitiateTemplate | string |
Identificador único de plantilla de flujo de trabajo |
|
Está encerrada
|
RecordIsEnclosed | boolean | |
|
Jurisdiction
|
RecordJurisdictions | string | |
|
Fecha de última acción
|
RecordLastActionDate | date-time | |
|
Último registro de parte
|
RecordLastPartRecord | integer | |
|
Versión más reciente
|
RecordLatestVersion | integer | |
|
Número expandido
|
RecordLongNumber | string | |
|
Número de registro
|
RecordNumber | string | |
|
Fecha de destrucción manual
|
RecordManualDestructionDate | date-time | |
|
Registro de materia
|
RecordMatterRecord | integer | |
|
Tipo de medio
|
RecordMediaType | string | |
|
Reunión
|
RecordMeeting | integer | |
|
Tipo mime
|
RecordMimeType | string | |
|
Mis comentarios de autorización
|
RecordMyAuthorizationComments | string | |
|
Mi autorización completada
|
RecordMyAuthorizationComplete | boolean | |
|
Mis comentarios de revisión
|
RecordMyReviewComments | string | |
|
Mi revisión completada
|
RecordMyReviewComplete | boolean | |
|
¿Páginas de números?
|
RecordNbrPages | integer | |
|
¿Necesita autorización?
|
RecordNeedsAuthorization | boolean | |
|
¿Necesita revisión?
|
RecordNeedsReview | boolean | |
|
Nueva regla de creación de elementos
|
RecordNewPartCreationRule | string |
Identificador único de la regla de creación de elementos automáticos |
|
Siguiente registro de parte
|
RecordNextPartRecord | integer | |
|
Tipo de actualización de notas
|
NotesUpdateType | string | |
|
Notas
|
RecordNotes | string | |
|
Se originó desde
|
RecordOriginatedFrom | string | |
|
Se originó desde la ejecución
|
RecordOriginatedFromRun | string | |
|
Otro contacto
|
RecordOtherContact | integer | |
|
Ubicación del propietario
|
RecordOwnerLocation | integer | |
|
¿Jerarquía del preservador en la entrada de datos?
|
RecordPreserveHierarchyOnDataEntry | boolean | |
|
Registro de elemento anterior
|
RecordPrevPartRecord | integer | |
|
Contacto principal
|
RecordPrimaryContact | integer | |
|
Priority
|
RecordPriority | string | |
|
Tipo de registro
|
RecordRecordType | integer | |
|
Registro relacionado
|
RecordRelatedRecord | integer | |
|
Representante
|
RecordRepresentative | integer | |
|
Programación de retención
|
RecordRetentionSchedule | integer | |
|
Fecha de revisión
|
RecordReviewDate | date-time | |
|
Revisar fecha de vencimiento
|
RecordReviewDueDate | date-time | |
|
Revisar estado
|
RecordReviewState | string | |
|
Registro de elemento raíz
|
RecordRootPartRecord | integer | |
|
Security
|
RecordSecurity | string | |
|
Registro de serie
|
RecordSeriesRecord | integer | |
|
Title
|
RecordTitle | string | |
|
Título (parte de texto libre)
|
RecordTypedTitle | string | |
|
Identificador único
|
Uri | integer | |
|
Campos adicionales
|
Fields | object |
CMEventData
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador único de evento
|
OnlineEventUri | integer | |
|
Id. de tipo de evento
|
EventType | integer | |
|
Tipo de evento
|
EventTypeString | string | |
|
Fecha de evento
|
EventDate | date-time | |
|
Id. de tipo de objeto
|
ObjectType | integer | |
|
Tipo de objeto
|
ObjectTypeString | string | |
|
Id. único de objeto
|
ObjectUri | integer | |
|
Id. de tipo de objeto relacionado
|
RelatedObjectType | integer | |
|
Tipo de objeto relacionado
|
RelatedObjectTypeString | string | |
|
Id. único de objeto relacionado
|
RelatedObjectUri | integer | |
|
Desde la máquina
|
FromMachine | string | |
|
Dirección IP de conexión
|
ConnectionIPAddress | string | |
|
Dirección IP de cliente
|
ClientIPAddress | string | |
|
Desde zona horaria
|
FromTimeZone | integer | |
|
Nombre de inicio de sesión
|
LoginName | string | |
|
Id. único de inicio de sesión
|
LoginUri | integer | |
|
Detalles adicionales
|
ExtraDetails | string |
CMLogMessage
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Mensaje de registro
|
LogMessage | string | |
|
Buscar
|
TrimType | CMTrimType | |
|
Identificador único
|
Uri | integer |
CMRecordsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
Results | array of CMRecord | |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Total de resultados
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Recuento mínimo
|
MinimumCount | integer | |
|
Contar
|
Count | integer | |
|
Tiene más elementos
|
HasMoreItems | boolean | |
|
Título de búsqueda
|
SearchTitle | string | |
|
Presione La cadena de resaltado
|
HitHighlightString | string | |
|
Buscar
|
TrimType | CMTrimType | |
|
Estado de respuesta
|
ResponseStatus | CMResponseStatus |
Estado de respuesta |
CMLogResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
Results | array of CMLogMessage | |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Total de resultados
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Recuento mínimo
|
MinimumCount | integer | |
|
Contar
|
Count | integer | |
|
Tiene más elementos
|
HasMoreItems | boolean | |
|
Título de búsqueda
|
SearchTitle | string | |
|
Presione La cadena de resaltado
|
HitHighlightString | string | |
|
Buscar
|
TrimType | CMTrimType | |
|
Estado de respuesta
|
ResponseStatus | CMResponseStatus |
Estado de respuesta |
CMUpdateErrorResponse
Respuesta de error de actualización
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de error
|
ErrorCode | string | |
|
Identificador único
|
Uri | integer | |
|
Message
|
Message | string | |
|
Nombre
|
Name | string | |
|
Nombre (adicional)
|
NameExtra | string |
CMResponseStatus
Estado de respuesta
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de error
|
ErrorCode | string | |
|
Message
|
Message | string | |
|
StackTrace
|
StackTrace | string | |
|
Errors
|
Errors | array of CMResponseError | |
|
Meta
|
Meta | object |
Dictionary<String,String> |
CMResponseError
Error de respuesta
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de error
|
ErrorCode | string | |
|
Nombre del campo
|
FieldName | string | |
|
Message
|
Message | string | |
|
Meta
|
Meta | object |
Dictionary<String,String> |
CMTrimType
- Buscar
- string
CMLocation
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador único
|
Uri | integer | |
|
Nombre
|
NameString | string | |
|
Nombre con formato completo de ubicación
|
LocationFullFormattedName | string | |
|
Nombre de ordenación de ubicación
|
LocationSortName | string |
CMBob
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador único
|
Uri | integer | |
|
Nombre
|
NameString | string |
CMLocationsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
Results | array of CMLocation |
Results |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Total de resultados
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Recuento mínimo
|
MinimumCount | integer | |
|
Contar
|
Count | integer | |
|
Tiene más elementos
|
HasMoreItems | boolean | |
|
Título de búsqueda
|
SearchTitle | string | |
|
Presione La cadena de resaltado
|
HitHighlightString | string | |
|
Buscar
|
TrimType | CMTrimType | |
|
Estado de respuesta
|
ResponseStatus | CMResponseStatus |
Estado de respuesta |
CMBobResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
Results | array of CMBob |
Results |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Total de resultados
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Recuento mínimo
|
MinimumCount | integer | |
|
Contar
|
Count | integer | |
|
Tiene más elementos
|
HasMoreItems | boolean | |
|
Título de búsqueda
|
SearchTitle | string | |
|
Presione La cadena de resaltado
|
HitHighlightString | string | |
|
Buscar
|
TrimType | CMTrimType | |
|
Estado de respuesta
|
ResponseStatus | CMResponseStatus |
Estado de respuesta |
GetFileFromUrlResponse
Respuesta del complemento de LA API del servicio CM "GetFileFromUrl".
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Filepath
|
Filepath | string |
Ruta de acceso del archivo local al archivo descargado de la dirección URL. |
|
Message
|
Message | string |
CMLocationAddressUri
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. único
|
Uri | integer |
binary
Este es el tipo de datos básico "binary".
objeto
Este es el tipo 'objeto'.