CobbleStone - Visão do contrato (Preview)
Melhore seu processo de gerenciamento de contratos conectando-se à nossa API Contract Insight para uma interação perfeita entre sistemas. A funcionalidade uma vez conectada inclui: - Criação de novos registros. - Atualização dos registos existentes. - Puxar uma lista de registros para uma determinada entidade. - Puxando todos os metadados, restrições e sinalizadores. - Puxar uma lista de registros editáveis, atualizáveis ou visíveis.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - 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 | |
|---|---|
| Editora | Software de paralelepípedos |
| Sítio Web | https://www.cobblestonesoftware.com |
| Política de Privacidade | https://www.cobblestonesoftware.com/company/privacy-policy |
| Categorias | Gestão Empresarial; Vendas e CRM |
Paralelepípedos
Permite as operações básicas em relação ao nosso software Contract Insight (Adicionar, Inserir, Atualizar) e informações de esquema para uma entidade.
Editora: CobbleStone Software
Pré-requisitos
Requer licença existente para CobbleStone Software (Contact Insight).
Operações suportadas
Obter
Pull list de registros para uma determinada entidade com critérios específicos, ordem por tag, grupo por tag e número de registros. Nota: Não há limite para o número de registros a serem extraídos, mas o usuário tem que considerar que resultados maiores serão mais lentos para processar.
Adicionar
Adicione um registro (limitado a um registro por chamada) à entidade especificada. A resposta será o ID gerado pelo sistema.
Atualização
Atualize o(s) registro(s) para uma entidade/área especificada com critérios específicos e um TriggerWorkflow como sinalizador para executar o fluxo de trabalho após a solicitação de atualização ser 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, Length, Primary Key, 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 visualizada/consultada por meio dessa interface.
Obtenção de credenciais
Autorização (OAUTH 2.0)
- CobbleStone Software oferece dois métodos de autorização de acesso:
- Código de autorização: https://oauth.net/2/grant-types/authorization-code/
- Subvenção implícita: https://oauth.net/2/grant-types/implicit/
As credenciais podem ser configuradas/geradas através do seu sistema CobbleStone Software.
Introdução
Para criar as credenciais do API Client através do seu sistema CobbleStone Software, use as seguintes etapas:
Dentro do seu sistema CobbleStone Software, um administrador de 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
(NOTA: Isto está sob o item de menu superior "Meu" e, em seguida, selecione "Meus clientes API")
Isso permite que um administrador do sistema crie credenciais OAuth 2.0 (ID do Cliente e Segredo do Cliente) para uso com o conector.
Ao fazer login no seu sistema CobbleStone Software:
Para começar, você abrirá o CobbleStone Software e irá em My > My API Clients...
Crie uma nova entrada de API Client clicando em Add API Client e dê a ela um nome exclusivo. O nome é apenas interno e pode ser qualquer coisa significativa para o seu propósito. Recomendamos o uso de uma chave de API diferente para organizar as coisas em tarefas pequenas, gerenciáveis e com propósito.
Isso gerará uma chave e apenas o pessoal administrativo terá acesso à página. Está ligada a pessoa que gerou a chave e ela é a única que pode vê-la. Você pode compartilhar a chave deles, mas apenas o usuário conectado pode vê-lo.
Neste ponto, terminamos de configurar a entrada do API Client. Este ID do Cliente e o Client Securet são usados para que o conector se comunique com o seu sistema CobbleStone Software.
Problemas conhecidos e limitações
Atualmente, o conector não suporta o envio ou recebimento de arquivos binários.
O ponto de extremidade "Atualizar" é limitado a um máximo de 500 linhas afetadas por acerto. Se mais de 500 registros precisarem ser atualizados, eles precisarão ser processados em vários acertos.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado 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 - Seu CobbleStone ClientId | cadeia (de caracteres) | Introduza o ID do cliente. | Verdade |
| Segredo do Cliente - Seu Segredo do Cliente CobbleStone | securestring | Introduza o segredo do cliente. | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar registro(s) para uma entidade especificada |
Atualize o(s) registro(s) para uma entidade/área especificada com critérios específicos e um TriggerWorkflow como sinalizador para executar o fluxo de trabalho após a solicitação de atualização ser 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á o ID gerado pelo sistema. |
| 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. |
| Extrair metadados sobre todas as colunas em entidade específica |
Lista colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Length, Primary Key, etc.) em uma tabela. |
| Extrair metadados sobre todas as colunas na exibição específica do banco de dados |
Lista colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Length, Primary Key, etc.) em uma exibição de banco de dados. |
| 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 visualizada/consultada. |
| Pull list de registro(s) para uma determinada entidade |
Pull list de registros para uma determinada entidade com critérios específicos, ordem por tag, grupo por tag e número de registros. Nota: Não há limite para o número de registros a serem extraídos, mas o usuário tem que considerar que resultados maiores serão mais lentos para processar. |
| Recuperar lista de entidades disponíveis para fins de atualização |
Recuperar Lista de Entidades disponíveis desses clientes têm permissão para atualizar dados, uso interno para preenchimento automático dinâmico das caixas de listagem |
| Recuperar lista de entidades disponíveis para inserir finalidade |
Recuperar Lista de Entidades disponíveis desses clientes têm a permissão para adicionar dados, uso interno para preencher automaticamente dinamicamente as caixas de listagem |
| Recuperar lista de entidades disponíveis para selecionar finalidade |
Recuperar Lista de Entidades disponíveis desses clientes têm permissão para consultar dados, uso interno para preencher automaticamente dinamicamente as caixas de listagem |
| Recuperar lista de exibições de banco de dados disponíveis |
Recuperar Lista de Exibições de Banco de Dados disponíveis desses clientes têm permissão para consultar dados, uso interno para preencher dinamicamente automaticamente as caixas de Exibição de Banco de Dados |
Atualizar registro(s) para uma entidade especificada
Atualize o(s) registro(s) para uma entidade/área especificada com critérios específicos e um TriggerWorkflow como sinalizador para executar o fluxo de trabalho após a solicitação de atualização ser bem-sucedida ou não. O número máximo de registros que podem ser atualizados é de 500 por chamada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da Entidade
|
entityName | True | string |
Nome da tabela para atualizar o(s) registro(s). |
|
Condition
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
Id
|
Id | string | ||
|
Entrada
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
ID
|
ID | string | ||
|
Entrada
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Tipo
|
Type | string | ||
|
Valor
|
Value | string | ||
|
Tipo
|
Type | string | ||
|
Valor
|
Value | string | ||
|
Nome
|
Name | string | ||
|
Valor
|
Value | string | ||
|
TriggerWorkflow
|
TriggerWorkflow | boolean |
Devoluções
- Body
- APIUpdateResponse
Criar um novo registro para uma entidade especificada
Adicione um registro (limitado a um registro por chamada) à entidade especificada. A resposta será o ID gerado pelo sistema.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da Entidade
|
entityName | True | string |
Nome do nome da tabela ao qual adicionar o registro. |
|
Nome
|
Name | string | ||
|
Valor
|
Value | string |
Devoluções
- Body
- APIAddRequest
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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da Visualização do Banco de Dados
|
databaseViewName | True | string |
Nome da Exibição de Banco de Dados a ser executada. |
|
Attribute
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Condition
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
ID
|
ID | string | ||
|
Entrada
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
ID
|
ID | string | ||
|
Entrada
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Tipo
|
Type | string | ||
|
Valor
|
Value | string | ||
|
Campos
|
Fields | array of string | ||
|
Direction
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Em que índice começar, Padrão = 0 |
|
|
Length
|
Length | integer |
Contagem de linhas a partir de StartIndex, não pode excceed 1000, Default = 100 |
Devoluções
Lista de colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Length, Primary Key, etc.) em uma tabela
- Itens
- APISchemaResponse
Extrair metadados sobre todas as colunas em entidade específica
Lista colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Length, Primary Key, etc.) em uma tabela.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da Entidade
|
entityName | True | string |
Nome da tabela para a qual recuperar o esquema. |
Devoluções
Lista de colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Length, Primary Key, etc.) em uma tabela
- Itens
- APISchemaResponse
Extrair metadados sobre todas as colunas na exibição específica do banco de dados
Lista colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Length, Primary Key, etc.) em uma exibição de banco de dados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da Entidade
|
databaseViewName | True | string |
Nome da Exibição de Banco de Dados para a qual recuperar o esquema. |
Devoluções
Lista de colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Length, Primary Key, 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 visualizada/consultada.
Devoluções
Lista de Entidades
- Itens
- APIEntityListResponse
Pull list de registro(s) para uma determinada entidade
Pull list de registros para uma determinada entidade com critérios específicos, ordem por tag, grupo por tag e número de registros. Nota: Não há limite para o número de registros a serem extraídos, mas o usuário tem que considerar que resultados maiores serão mais lentos para processar.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da Entidade
|
entityName | True | string |
Nome da tabela a partir da qual consultar dados. |
|
Attribute
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Condition
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
ID
|
ID | string | ||
|
Entrada
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
Campo
|
Field | string | ||
|
ID
|
ID | string | ||
|
Entrada
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Tipo
|
Type | string | ||
|
Valor
|
Value | string | ||
|
Campos
|
Fields | array of string | ||
|
Direction
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Em que índice começar, Padrão = 0 |
|
|
Length
|
Length | integer |
Contagem de linhas a partir de StartIndex, não pode excceed 1000, Default = 100 |
Devoluções
- Itens
- APIQueryResponse
Recuperar lista de entidades disponíveis para fins de atualização
Recuperar Lista de Entidades disponíveis desses clientes têm permissão para atualizar dados, uso interno para preenchimento automático dinâmico das caixas de listagem
Devoluções
Lista de Entidades
- Itens
- APIEntityListResponse
Recuperar lista de entidades disponíveis para inserir finalidade
Recuperar Lista de Entidades disponíveis desses clientes têm a permissão para adicionar dados, uso interno para preencher automaticamente dinamicamente as caixas de listagem
Devoluções
Lista de Entidades
- Itens
- APIEntityListResponse
Recuperar lista de entidades disponíveis para selecionar finalidade
Recuperar Lista de Entidades disponíveis desses clientes têm permissão para consultar dados, uso interno para preencher automaticamente dinamicamente as caixas de listagem
Devoluções
Lista de Entidades
- Itens
- APIEntityListResponse
Recuperar lista de exibições de banco de dados disponíveis
Recuperar Lista de Exibições de Banco de Dados disponíveis desses clientes têm permissão para consultar dados, uso interno para preencher dinamicamente automaticamente as caixas de Exibição de Banco de Dados
Devoluções
Resposta de consulta para Exibições de Banco de Dados
- Itens
- APIViewListResponse
Definições
APIEntityListResponse
Lista de Entidades
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
APIEntity |
Definir cada entidade |
APIEntity
Definir cada entidade
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
EntityName
|
EntityName | string |
Nome da entidade como está no banco de dados |
|
EntityNameDisplay
|
EntityNameDisplay | string |
Nome de exibição da entidade |
|
PermitirAdicionar
|
AllowAdd | boolean |
Indica se é permitido adicionar novo registro |
|
PermitirEditar
|
AllowEdit | boolean |
Indica se é permitido editar o(s) registro(s) |
|
AllowView
|
AllowView | boolean |
Indica se é permitido visualizar o(s) registro(s) |
|
EntityNameForAPI
|
EntityNameForAPI | string |
Nome da entidade usado na API CSS |
APISchemaResponse
Lista de colunas, tipos de dados e quaisquer restrições ou sinalizadores (NULL, Length, Primary Key, etc.) em uma tabela
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
APISchema |
APISchema
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
Name | string | |
|
IsPrimaryKey
|
IsPrimaryKey | boolean | |
|
IsIdentity
|
IsIdentity | boolean | |
|
IsNullable
|
IsNullable | boolean | |
|
DBTipo
|
DBType | string | |
|
Comprimento máximo
|
MaxLength | integer | |
|
DataPrecision
|
DataPrecision | integer | |
|
Escala de dados
|
DataScale | integer | |
|
HasDefaultValue
|
HasDefaultValue | boolean | |
|
IsComputedColumn
|
IsComputedColumn | boolean | |
|
IsPassword
|
IsPassword | boolean |
APIAddRequestTuple
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
Name | string | |
|
Valor
|
Value | string |
APIUpdateResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
TotalAfetado
|
TotalAffected | integer | |
|
TotalFailed
|
TotalFailed | integer | |
|
Message
|
Message | string |
APIAddRequest
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tuplas
|
Tuples | array of APIAddRequestTuple |
APIQueryResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
object |
APIViewListResponse
Resposta de consulta para Exibições de Banco de Dados
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
object |