CobbleStone – Contract Insight (versão prévia)
Aprimore o processo de gerenciamento de contratos conectando-se à nossa API do Contract Insight para interação perfeita entre sistemas. A funcionalidade uma vez conectada inclui: – Criar novos registros. - Atualizando registros existentes. - Puxando uma lista de registros para uma determinada entidade. - Puxando todos os metadados, restrições e sinalizadores. - Puxando uma lista de registros editáveis, atualizáveis ou viewveis.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | CobbleStone Software |
| URL | https://www.cobblestonesoftware.com |
| AppDev@cobblestonesystems.com |
| Metadados do conector | |
|---|---|
| Publicador | Cobblestone Software |
| Site | https://www.cobblestonesoftware.com |
| Política de Privacidade | https://www.cobblestonesoftware.com/company/privacy-policy |
| Categorias | Gestão de empresas; Vendas e CRM |
Paralelepípedo
Permite as operações básicas em nosso software do Contract Insight (Adicionar, Inserir, Atualizar) e informações de esquema para uma entidade.
Publisher: CobbleStone Software
Pré-requisitos
Requer a licença existente para o CobbleStone Software (Contact Insight).
Operações com suporte
Get
Efetuar pull de registros para uma determinada entidade com critérios específicos, ordem por marca, grupo por marca e número de registros. Observação: não há limite no número de registros a serem extraídos, mas o usuário precisa considerar que os resultados maiores serão mais lentos para serem processados.
Adicionar
Adicione um registro (limitado a um registro por chamada) à entidade especificada. A resposta será a ID gerada pelo sistema.
Update
Atualize os registros de uma entidade/área especificada com critérios específicos e um TriggerWorkflow como sinalizador para executar o fluxo de trabalho depois que a solicitação de atualização for bem-sucedida ou não. O número máximo de registros que podem ser atualizados é de 500 por chamada.
Schema
Lista colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Comprimento, Chave Primária etc.) em uma tabela.
Lista de entidades
Retorna a lista de nomes e três propriedades sinalizadas indicando se ela pode ser editada, atualizada ou exibida/consultada por meio dessa interface.
Obtendo credenciais
Autorização (OAUTH 2.0)
- O CobbleStone Software oferece dois métodos de autorização para acesso:
- Código de autorização: https://oauth.net/2/grant-types/authorization-code/
- Concessão Implícita: https://oauth.net/2/grant-types/implicit/
As credenciais podem ser configuradas/geradas por meio do sistema de software CobbleStone.
Introdução
Para criar as credenciais do cliente de API por meio do sistema de software CobbleStone, use as seguintes etapas:
Em seu sistema de Software CobbleStone, um administrador do sistema pode navegar até a seguinte página para configurar/configurar credenciais:
- Para clientes SaaS: https://yourCompanyName.cobblestone.software/core/MyAPI.aspx
- Para clientes implantados (normalmente): https://yourCompanyName/core/MyAPI.aspx
(OBSERVAÇÃO: isso está no item de menu superior "Meu" e, em seguida, selecione "Meus Clientes de API")
Isso permite que um administrador do sistema crie credenciais do OAuth 2.0 (ID do cliente e segredo do cliente) para uso com o conector.
Do logon em seu sistema de software CobbleStone:
Para começar, você abrirá o CobbleStone Software e passará por Meus > Clientes de API...
Crie uma nova entrada de Cliente de API clicando em Adicionar Cliente de API e dê a ela um nome exclusivo. O nome é apenas interno e pode ser qualquer coisa significativa para sua finalidade. É recomendável usar uma chave de API diferente para organizar as coisas em tarefas pequenas, gerenciáveis e propositadas.
Isso gerará uma chave e somente o pessoal administrador terá acesso à página. Ele associa a pessoa que gerou a chave e ela é a única que pode vê-la. Você pode compartilhar a chave, mas somente o usuário conectado pode vê-la.
Neste ponto, terminamos de configurar a entrada do Cliente de API. Essa ID do cliente e o Client Securet são usados para que o conector se comunique com seu sistema de software CobbleStone.
Problemas e limitações conhecidos
Atualmente, o conector não dá suporte ao envio ou recebimento de arquivos binários.
O ponto de extremidade "Atualização" é limitado a um máximo de 500 linhas afetadas por ocorrência. Se mais de 500 registros precisarem ser atualizados, eles precisarão ser processados em vários acessos.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| ID do cliente - Sua CobbleStone ClientId | cadeia | Insira a ID do cliente. | Verdade |
| Segredo do cliente - Seu CobbleStone ClientSecret | secureString | Insira o segredo do cliente. | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar registros para uma entidade especificada |
Atualize os registros de uma entidade/área especificada com critérios específicos e um TriggerWorkflow como sinalizador para executar o fluxo de trabalho depois que a solicitação de atualização for bem-sucedida ou não. O número máximo de registros que podem ser atualizados é de 500 por chamada. |
| Criar um novo registro para uma entidade especificada |
Adicione um registro (limitado a um registro por chamada) à entidade especificada. A resposta será a ID gerada pelo sistema. |
| Efetuar pull de metadados sobre todas as colunas em uma entidade específica |
Lista colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Comprimento, Chave Primária etc.) em uma tabela. |
| Efetuar pull de metadados sobre todas as colunas no modo de exibição de banco de dados específico |
Lista colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Comprimento, Chave Primária etc.) em um modo de exibição de banco de dados. |
| Executar uma exibição de banco de dados específica |
Execute uma exibição de banco de dados específica (limitada a um registro por chamada). A resposta será o status. |
| Lista de pull de entidades com as quais a API tem permissão para trabalhar |
Retorna a lista de nomes e três propriedades sinalizadas indicando se ela pode ser editada, atualizada ou exibida/consultada. |
| Lista de pull de registros para uma determinada entidade |
Efetuar pull de registros para uma determinada entidade com critérios específicos, ordem por marca, grupo por marca e número de registros. Observação: não há limite no número de registros a serem extraídos, mas o usuário precisa considerar que os resultados maiores serão mais lentos para serem processados. |
| Recuperar lista de entidades disponíveis para fins de atualização |
Recuperar lista de entidades disponíveis desses clientes tem permissão para atualizar dados, uso interno para preenchimento automático dinâmico das caixas de listagem |
| Recuperar lista de entidades disponíveis para fins de inserção |
Recuperar lista de entidades disponíveis desses clientes tem a permissão para adicionar dados, uso interno para preencher dinamicamente as caixas de listagem automaticamente |
| Recuperar lista de entidades disponíveis para fins de seleção |
Recuperar lista de entidades disponíveis desses clientes tem permissão para consultar dados, uso interno para preenchimento automático dinâmico das caixas de listagem |
| Recuperar lista de exibições de banco de dados disponíveis |
Recuperar a lista de exibições de banco de dados disponíveis desses clientes tem a permissão para consultar dados, uso interno para preencher dinamicamente as caixas de Exibição de Banco de Dados |
Atualizar registros para uma entidade especificada
Atualize os registros de uma entidade/área especificada com critérios específicos e um TriggerWorkflow como sinalizador para executar o fluxo de trabalho depois que a solicitação de atualização for bem-sucedida ou não. O número máximo de registros que podem ser atualizados é de 500 por chamada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da Entidade
|
entityName | True | string |
Nome da tabela na qual atualizar os registros. |
|
Condição
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
ID
|
Id | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condição
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Tipo
|
Type | string | ||
|
Value
|
Value | string | ||
|
Tipo
|
Type | string | ||
|
Value
|
Value | string | ||
|
Nome
|
Name | string | ||
|
Value
|
Value | string | ||
|
TriggerWorkflow
|
TriggerWorkflow | boolean |
Retornos
- Corpo
- APIUpdateResponse
Criar um novo registro para uma entidade especificada
Adicione um registro (limitado a um registro por chamada) à entidade especificada. A resposta será a ID gerada pelo sistema.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da Entidade
|
entityName | True | string |
Nome da tabela ao qual adicionar registro. |
|
Nome
|
Name | string | ||
|
Value
|
Value | string |
Retornos
- Corpo
- APIAddRequest
Efetuar pull de metadados sobre todas as colunas em uma entidade específica
Lista colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Comprimento, Chave Primária etc.) em uma tabela.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da Entidade
|
entityName | True | string |
Nome da tabela para a qual recuperar o esquema. |
Retornos
Lista de colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Comprimento, Chave Primária etc.) em uma tabela
- Itens
- APISchemaResponse
Efetuar pull de metadados sobre todas as colunas no modo de exibição de banco de dados específico
Lista colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Comprimento, Chave Primária etc.) em um modo de exibição de banco de dados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da Entidade
|
databaseViewName | True | string |
Nome do Modo de Exibição de Banco de Dados para o qual recuperar o esquema. |
Retornos
Lista de colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Comprimento, Chave Primária etc.) em uma tabela
- Itens
- APISchemaResponse
Executar uma exibição de banco de dados específica
Execute uma exibição de banco de dados específica (limitada a um registro por chamada). A resposta será o status.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da exibição do banco de dados
|
databaseViewName | True | string |
Nome do Modo de Exibição de Banco de Dados a ser executado. |
|
Attribute
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Condição
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condição
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Tipo
|
Type | string | ||
|
Value
|
Value | string | ||
|
Fields
|
Fields | array of string | ||
|
Direção
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Qual índice iniciar, Padrão = 0 |
|
|
Length
|
Length | integer |
Contagem de linhas a partir de StartIndex, não pode excceed 1000, Default = 100 |
Retornos
Lista de colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Comprimento, Chave Primária etc.) em uma tabela
- Itens
- APISchemaResponse
Lista de pull de entidades com as quais a API tem permissão para trabalhar
Retorna a lista de nomes e três propriedades sinalizadas indicando se ela pode ser editada, atualizada ou exibida/consultada.
Retornos
Lista de entidades
- Itens
- APIEntityListResponse
Lista de pull de registros para uma determinada entidade
Efetuar pull de registros para uma determinada entidade com critérios específicos, ordem por marca, grupo por marca e número de registros. Observação: não há limite no número de registros a serem extraídos, mas o usuário precisa considerar que os resultados maiores serão mais lentos para serem processados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da Entidade
|
entityName | True | string |
Nome da tabela da qual consultar dados. |
|
Attribute
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Condição
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condição
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Tipo
|
Type | string | ||
|
Value
|
Value | string | ||
|
Fields
|
Fields | array of string | ||
|
Direção
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Qual índice iniciar, Padrão = 0 |
|
|
Length
|
Length | integer |
Contagem de linhas a partir de StartIndex, não pode excceed 1000, Default = 100 |
Retornos
- Itens
- APIQueryResponse
Recuperar lista de entidades disponíveis para fins de atualização
Recuperar lista de entidades disponíveis desses clientes tem permissão para atualizar dados, uso interno para preenchimento automático dinâmico das caixas de listagem
Retornos
Lista de entidades
- Itens
- APIEntityListResponse
Recuperar lista de entidades disponíveis para fins de inserção
Recuperar lista de entidades disponíveis desses clientes tem a permissão para adicionar dados, uso interno para preencher dinamicamente as caixas de listagem automaticamente
Retornos
Lista de entidades
- Itens
- APIEntityListResponse
Recuperar lista de entidades disponíveis para fins de seleção
Recuperar lista de entidades disponíveis desses clientes tem permissão para consultar dados, uso interno para preenchimento automático dinâmico das caixas de listagem
Retornos
Lista de entidades
- Itens
- APIEntityListResponse
Recuperar lista de exibições de banco de dados disponíveis
Recuperar a lista de exibições de banco de dados disponíveis desses clientes tem a permissão para consultar dados, uso interno para preencher dinamicamente as caixas de Exibição de Banco de Dados
Retornos
Resposta de consulta para exibições de banco de dados
- Itens
- APIViewListResponse
Definições
APIEntityListResponse
Lista de entidades
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
APIEntity |
Definir cada entidade |
Entidade de API
Definir cada entidade
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome da entidade
|
EntityName | string |
Nome da entidade como está no banco de dados |
|
EntityNameDisplay
|
EntityNameDisplay | string |
Nome de exibição da entidade |
|
AllowAdd
|
AllowAdd | boolean |
Indica se há permissão para adicionar novo registro |
|
AllowEdit
|
AllowEdit | boolean |
Indica se há permissão para editar registro(S) |
|
AllowView
|
AllowView | boolean |
Indica se há permissão para exibir registros |
|
EntityNameForAPI
|
EntityNameForAPI | string |
Nome da entidade usado na API do CSS |
APISchemaResponse
Lista de colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Comprimento, Chave Primária etc.) em uma tabela
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
APISchema |
APISchema
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
Name | string | |
|
IsPrimaryKey
|
IsPrimaryKey | boolean | |
|
IsIdentity
|
IsIdentity | boolean | |
|
IsNullable
|
IsNullable | boolean | |
|
DBType
|
DBType | string | |
|
MaxLength
|
MaxLength | integer | |
|
DataPrecision
|
DataPrecision | integer | |
|
DataScale
|
DataScale | integer | |
|
HasDefaultValue
|
HasDefaultValue | boolean | |
|
IsComputedColumn
|
IsComputedColumn | boolean | |
|
IsPassword
|
IsPassword | boolean |
APIAddRequestTuple
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
Name | string | |
|
Value
|
Value | string |
APIUpdateResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
TotalAffected
|
TotalAffected | integer | |
|
Total de Falha
|
TotalFailed | integer | |
|
Message
|
Message | string |
APIAddRequest
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tuplas
|
Tuples | array of APIAddRequestTuple |
APIQueryResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
object |
APIViewListResponse
Resposta de consulta para exibições de banco de dados
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
object |