CobbleStone- Información de contrato (versión preliminar)
Mejore el proceso de administración de contratos mediante la conexión a contract Insight API para una interacción sin problemas entre sistemas. La funcionalidad una vez conectada incluye: - Crear nuevos registros. - Actualización de registros existentes. - Extracción de una lista de registros para una entidad determinada. - Extraer todos los metadatos, restricciones y marcas. - Extraer una lista de registros editables, actualizables o visibles.
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 | Software de Adoquín |
| URL | https://www.cobblestonesoftware.com |
| Correo Electrónico | AppDev@cobblestonesystems.com |
| Metadatos del conector | |
|---|---|
| Publicador | Software de empedrado |
| Sitio web | https://www.cobblestonesoftware.com |
| Directiva de privacidad | https://www.cobblestonesoftware.com/company/privacy-policy |
| Categorías | Gestión empresarial; Ventas y CRM |
Guijarro
Permite las operaciones básicas en nuestro software Contract Insight (Agregar, Insertar, Actualizar) e información de esquema para una entidad.
Publicador: Software de Adoquín
Prerrequisitos
Requiere una licencia existente para El software de CobbleStone (Información de contacto).
Operaciones admitidas
Obtener
Extraer la lista de registros de una entidad determinada con criterios específicos, ordenar por etiqueta, agrupar por etiqueta y número de registros. Nota: No hay ningún límite en el número de registros que se van a extraer, pero el usuario tiene que tener en cuenta que los resultados más grandes serán más lentos de procesar.
Agregar
Agregue un registro (limitado a un registro por llamada) a la entidad especificada. La respuesta será el identificador generado por el sistema.
Update
Actualice los registros de una entidad o área especificadas con criterios específicos y triggerWorkflow como marca para ejecutar el flujo de trabajo después de que la solicitud de actualización se realice correctamente o no. El número máximo de registros que se pueden actualizar es de 500 por llamada.
Schema
Enumera las columnas, los tipos de datos y las restricciones o marcas (NULL, Length, Primary Key, etc.) de una tabla.
Lista de entidades
Devuelve la lista de nombres y tres propiedades marcadas que indican si se puede editar, actualizar o consultar mediante esta interfaz.
Obtención de credenciales
Autorización (OAUTH 2.0)
- CobbleStone Software ofrece dos métodos de autorización para el acceso:
- Código de autorización: https://oauth.net/2/grant-types/authorization-code/
- Concesión implícita: https://oauth.net/2/grant-types/implicit/
Las credenciales se pueden configurar o generar a través del sistema de software de CobbleStone.
Introducción
Para crear las credenciales del cliente de API a través del sistema de software de CobbleStone, siga estos pasos:
En el sistema de software de CobbleStone, un administrador del sistema puede ir a la página siguiente para configurar o configurar credenciales:
- Para clientes SaaS: https://yourCompanyName.cobblestone.software/core/MyAPI.aspx
- Para clientes implementados (normalmente): https://yourCompanyName/core/MyAPI.aspx
(NOTA: Se encuentra en el elemento de menú superior "Mi" y, a continuación, selecciona "Mis clientes de API")
Esto permite a un administrador del sistema crear credenciales de OAuth 2.0 (id. de cliente y secreto de cliente) para su uso con el conector.
Desde iniciar sesión en el sistema de software de CobbleStone:
Para comenzar, abrirá El software de CobbleStone y irá en Mis clientes de API > ...
Cree una nueva entrada de cliente de API haciendo clic en Agregar cliente de API y asígnele un nombre único. El nombre solo es interno y puede ser cualquier cosa significativa para su propósito. Se recomienda usar una clave de API diferente para organizar las cosas en tareas pequeñas, administrables y intencionadas.
Esto generará una clave y solo el personal administrador tendrá acceso a la página. Está enlazado a la persona que generó la clave y es la única que puede verlo. Puede compartir la clave, pero solo el usuario que ha iniciado sesión puede verlo.
En este momento hemos terminado de configurar la entrada de cliente de API. Este identificador de cliente y client Securet se usan para que el conector se comunique con el sistema de software de CobbleStone.
Problemas conocidos y limitaciones
Actualmente, el conector no admite el envío ni la recepción de archivos binarios.
El punto de conexión de "Actualización" está limitado a un máximo de 500 filas afectadas por acierto. Si es necesario actualizar más de 500 registros, deben procesarse en varios aciertos.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
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 |
|---|---|---|---|
| Id. de cliente: clientId de La piedra empedrada | cuerda / cadena | Escriba el identificador de cliente. | Cierto |
| Secreto de cliente: clientSecret de CobbleStone | securestring | Escriba el secreto de cliente. | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualizar registros para una entidad especificada |
Actualice los registros de una entidad o área especificadas con criterios específicos y triggerWorkflow como marca para ejecutar el flujo de trabajo después de que la solicitud de actualización se realice correctamente o no. El número máximo de registros que se pueden actualizar es de 500 por llamada. |
| Creación de un registro para una entidad especificada |
Agregue un registro (limitado a un registro por llamada) a la entidad especificada. La respuesta será el identificador generado por el sistema. |
| Ejecución de una vista de base de datos específica |
Ejecute una vista de base de datos específica (limitada a un registro por llamada). La respuesta será el estado. |
| Extracción de metadatos sobre todas las columnas de una entidad específica |
Enumera las columnas, los tipos de datos y las restricciones o marcas (NULL, Length, Primary Key, etc.) de una tabla. |
| Extracción de metadatos sobre todas las columnas en una vista de base de datos específica |
Enumera columnas, tipos de datos y cualquier restricción o marca (NULL, Longitud, Clave principal, etc.) en una vista de base de datos. |
| Lista de extracción de entidades con las que puede trabajar la API |
Devuelve la lista de nombres y tres propiedades marcadas que indican si se puede editar, actualizar o consultar. |
| Lista de extracción de registros para una entidad determinada |
Extraer la lista de registros de una entidad determinada con criterios específicos, ordenar por etiqueta, agrupar por etiqueta y número de registros. Nota: No hay ningún límite en el número de registros que se van a extraer, pero el usuario tiene que tener en cuenta que los resultados más grandes serán más lentos de procesar. |
| Recuperar lista de entidades disponibles para fines de actualización |
Recuperar lista de entidades disponibles de esos clientes tiene el permiso para actualizar datos, uso interno para rellenar dinámicamente los cuadros de lista de forma dinámica |
| Recuperar lista de entidades disponibles para insertar |
Recuperar lista de entidades disponibles de esos clientes tiene permiso para agregar datos, uso interno para rellenar dinámicamente los cuadros de lista de forma automática. |
| Recuperar lista de entidades disponibles para seleccionar el propósito |
Recuperar lista de entidades disponibles de esos clientes tiene permiso para consultar datos, uso interno para rellenar dinámicamente los cuadros de lista de forma automática |
| Recuperar lista de vistas de base de datos disponibles |
Recuperar lista de vistas de base de datos disponibles de esos clientes tiene permiso para consultar datos, uso interno para rellenar dinámicamente los cuadros Vista de base de datos |
Actualizar registros para una entidad especificada
Actualice los registros de una entidad o área especificadas con criterios específicos y triggerWorkflow como marca para ejecutar el flujo de trabajo después de que la solicitud de actualización se realice correctamente o no. El número máximo de registros que se pueden actualizar es de 500 por llamada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de entidad
|
entityName | True | string |
Nombre de tabla en el que se van a actualizar los registros. |
|
Condición
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
Id
|
Id | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condición
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
identificación
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Tipo
|
Type | string | ||
|
Importancia
|
Value | string | ||
|
Tipo
|
Type | string | ||
|
Importancia
|
Value | string | ||
|
Nombre
|
Name | string | ||
|
Importancia
|
Value | string | ||
|
TriggerWorkflow
|
TriggerWorkflow | boolean |
Devoluciones
- Body
- APIUpdateResponse
Creación de un registro para una entidad especificada
Agregue un registro (limitado a un registro por llamada) a la entidad especificada. La respuesta será el identificador generado por el sistema.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de entidad
|
entityName | True | string |
Nombre de tabla al que se va a agregar el registro. |
|
Nombre
|
Name | string | ||
|
Importancia
|
Value | string |
Devoluciones
- Body
- APIAddRequest
Ejecución de una vista de base de datos específica
Ejecute una vista de base de datos específica (limitada a un registro por llamada). La respuesta será el estado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de la vista de base de datos
|
databaseViewName | True | string |
Nombre de la vista de base de datos que se va a ejecutar. |
|
Atributo
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Condición
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
identificación
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condición
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
identificación
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Tipo
|
Type | string | ||
|
Importancia
|
Value | string | ||
|
Fields
|
Fields | array of string | ||
|
Dirección
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Qué índice se va a iniciar, Valor predeterminado = 0 |
|
|
Length
|
Length | integer |
Recuento de filas a partir de StartIndex, no se puede excedir 1000, Valor predeterminado = 100 |
Devoluciones
Lista de columnas, tipos de datos y cualquier restricción o marcas (NULL, Longitud, Clave principal, etc.) en una tabla
- Productos
- APISchemaResponse
Extracción de metadatos sobre todas las columnas de una entidad específica
Enumera las columnas, los tipos de datos y las restricciones o marcas (NULL, Length, Primary Key, etc.) de una tabla.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de entidad
|
entityName | True | string |
Nombre de la tabla para la que se va a recuperar el esquema. |
Devoluciones
Lista de columnas, tipos de datos y cualquier restricción o marcas (NULL, Longitud, Clave principal, etc.) en una tabla
- Productos
- APISchemaResponse
Extracción de metadatos sobre todas las columnas en una vista de base de datos específica
Enumera columnas, tipos de datos y cualquier restricción o marca (NULL, Longitud, Clave principal, etc.) en una vista de base de datos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de entidad
|
databaseViewName | True | string |
Nombre de la vista de base de datos para la que se va a recuperar el esquema. |
Devoluciones
Lista de columnas, tipos de datos y cualquier restricción o marcas (NULL, Longitud, Clave principal, etc.) en una tabla
- Productos
- APISchemaResponse
Lista de extracción de entidades con las que puede trabajar la API
Devuelve la lista de nombres y tres propiedades marcadas que indican si se puede editar, actualizar o consultar.
Devoluciones
Lista de entidades
- Productos
- APIEntityListResponse
Lista de extracción de registros para una entidad determinada
Extraer la lista de registros de una entidad determinada con criterios específicos, ordenar por etiqueta, agrupar por etiqueta y número de registros. Nota: No hay ningún límite en el número de registros que se van a extraer, pero el usuario tiene que tener en cuenta que los resultados más grandes serán más lentos de procesar.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de entidad
|
entityName | True | string |
Nombre de tabla desde el que se van a consultar los datos. |
|
Atributo
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Condición
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
identificación
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condición
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
identificación
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Tipo
|
Type | string | ||
|
Importancia
|
Value | string | ||
|
Fields
|
Fields | array of string | ||
|
Dirección
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Qué índice se va a iniciar, Valor predeterminado = 0 |
|
|
Length
|
Length | integer |
Recuento de filas a partir de StartIndex, no se puede excedir 1000, Valor predeterminado = 100 |
Devoluciones
- Productos
- APIQueryResponse
Recuperar lista de entidades disponibles para fines de actualización
Recuperar lista de entidades disponibles de esos clientes tiene el permiso para actualizar datos, uso interno para rellenar dinámicamente los cuadros de lista de forma dinámica
Devoluciones
Lista de entidades
- Productos
- APIEntityListResponse
Recuperar lista de entidades disponibles para insertar
Recuperar lista de entidades disponibles de esos clientes tiene permiso para agregar datos, uso interno para rellenar dinámicamente los cuadros de lista de forma automática.
Devoluciones
Lista de entidades
- Productos
- APIEntityListResponse
Recuperar lista de entidades disponibles para seleccionar el propósito
Recuperar lista de entidades disponibles de esos clientes tiene permiso para consultar datos, uso interno para rellenar dinámicamente los cuadros de lista de forma automática
Devoluciones
Lista de entidades
- Productos
- APIEntityListResponse
Recuperar lista de vistas de base de datos disponibles
Recuperar lista de vistas de base de datos disponibles de esos clientes tiene permiso para consultar datos, uso interno para rellenar dinámicamente los cuadros Vista de base de datos
Devoluciones
Respuesta de consulta para vistas de base de datos
- Productos
- APIViewListResponse
Definiciones
APIEntityListResponse
Lista de entidades
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
APIEntity |
Definición de cada entidad |
APIEntity
Definición de cada entidad
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
EntityName (Nombre de la entidad)
|
EntityName | string |
Nombre de entidad tal como está en la base de datos |
|
EntityNameDisplay
|
EntityNameDisplay | string |
Nombre para mostrar de entidad |
|
AllowAdd
|
AllowAdd | boolean |
Indica si se permite agregar un nuevo registro. |
|
AllowEdit
|
AllowEdit | boolean |
Indica si se permite editar registros |
|
AllowView
|
AllowView | boolean |
Indica si se permite ver los registros. |
|
EntityNameForAPI
|
EntityNameForAPI | string |
Nombre de entidad que se usa en la API css |
APISchemaResponse
Lista de columnas, tipos de datos y cualquier restricción o marcas (NULL, Longitud, Clave principal, etc.) en una tabla
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
APISchema |
APISchema
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre
|
Name | string | |
|
IsPrimaryKey
|
IsPrimaryKey | boolean | |
|
IsIdentity
|
IsIdentity | boolean | |
|
IsNullable
|
IsNullable | boolean | |
|
DBType
|
DBType | string | |
|
Longitud máxima
|
MaxLength | integer | |
|
DataPrecision
|
DataPrecision | integer | |
|
DataScale
|
DataScale | integer | |
|
HasDefaultValue
|
HasDefaultValue | boolean | |
|
IsComputedColumn
|
IsComputedColumn | boolean | |
|
IsPassword
|
IsPassword | boolean |
APIAddRequestTuple
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre
|
Name | string | |
|
Importancia
|
Value | string |
APIUpdateResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
TotalAffected
|
TotalAffected | integer | |
|
TotalFailed
|
TotalFailed | integer | |
|
Message
|
Message | string |
APIAddRequest
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Tuplas
|
Tuples | array of APIAddRequestTuple |
APIQueryResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
object |
APIViewListResponse
Respuesta de consulta para vistas de base de datos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
object |