CobbleStone - Contract Insight (préversion)
Améliorez votre processus de gestion des contrats en vous connectant à notre API Contract Insight pour une interaction transparente entre les systèmes. La fonctionnalité une fois connectée inclut : - Création d’enregistrements. - Mise à jour des enregistrements existants. - Extraction d’une liste d’enregistrements pour une entité donnée. - Extraction de toutes les métadonnées, restrictions et indicateurs. - Extraction d’une liste d’enregistrements modifiables, pouvant être mis à jour ou visibles.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | CobbleStone Software |
| URL | https://www.cobblestonesoftware.com |
| Messagerie électronique | AppDev@cobblestonesystems.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Logiciel cobblestone |
| Site internet | https://www.cobblestonesoftware.com |
| Politique de confidentialité | https://www.cobblestonesoftware.com/company/privacy-policy |
| Catégories | Gestion de l’entreprise ; Ventes et CRM |
Pavé
Autorise les opérations de base sur notre logiciel Contract Insight (Ajouter, Insérer, Mettre à jour) et les informations de schéma pour une entité.
Éditeur : CobbleStone Software
Prerequisites
Nécessite une licence existante pour CobbleStone Software (Contact Insight).
Opérations prises en charge
Get
Liste des enregistrements d’une entité donnée avec des critères spécifiques, ordre par balise, groupe par balise et nombre d’enregistrements. Remarque : Il n’existe aucune limite quant au nombre d’enregistrements à extraire, mais l’utilisateur doit considérer que les résultats plus volumineux seront plus lents à traiter.
Ajouter
Ajoutez un enregistrement (limité à un enregistrement par appel) à une entité spécifiée. La réponse sera l’ID généré par le système.
Update
Mettez à jour les enregistrements pour une entité/zone spécifiée avec des critères spécifiques et un TriggerWorkflow comme indicateur pour exécuter le flux de travail une fois la demande de mise à jour réussie ou non. Le nombre maximal d’enregistrements pouvant être mis à jour est de 500 par appel.
Schema
Répertorie les colonnes, les types de données et toutes les restrictions ou indicateurs (NULL, Longueur, Clé primaire, etc.) dans une table.
Liste des entités
Retourne la liste des noms et trois propriétés marquées indiquant s’il peut être modifié, mis à jour ou consulté/interrogé via cette interface.
Obtention des informations d’identification
Autorisation (OAUTH 2.0)
- CobbleStone Software offre deux méthodes d’autorisation pour l’accès :
- Code d’autorisation : https://oauth.net/2/grant-types/authorization-code/
- Octroi implicite : https://oauth.net/2/grant-types/implicit/
Les informations d’identification peuvent être configurées/générées via votre système CobbleStone Software.
Getting Started
Pour créer les informations d’identification du client API via votre système CobbleStone Software, procédez comme suit :
Dans votre système CobbleStone Software, un administrateur système peut accéder à la page suivante pour configurer/configurer les informations d’identification :
- Pour les clients SaaS : https://yourCompanyName.cobblestone.software/core/MyAPI.aspx
- Pour les clients déployés (généralement) : https://yourCompanyName/core/MyAPI.aspx
(REMARQUE : Il s’agit de l’élément de menu « Mon » supérieur, puis sélectionnez « Mes clients API »)
Cela permet à un administrateur système de créer des informations d’identification OAuth 2.0 (ID client et secret client) à utiliser avec le connecteur.
À partir de la connexion à votre système CobbleStone Software :
Pour commencer, vous allez ouvrir CobbleStone Software et passer sous Mes > clients API...
Créez une entrée de client d’API en cliquant sur Ajouter un client d’API et en lui attribuant un nom unique. Le nom est uniquement interne et peut être quelque chose de significatif à son objectif. Nous vous recommandons d’utiliser une autre clé API pour organiser les éléments en tâches petites, gérables et délibérées.
Cela génère une clé et seul le personnel administrateur a accès à la page. Il est lié à la personne qui a généré la clé et ils sont les seuls qui peuvent le voir. Vous pouvez partager leur clé, mais seul l’utilisateur connecté peut le voir.
À ce stade, nous avons terminé la configuration de l’entrée du client d’API. Cet ID client et Client Securet sont utilisés pour que le connecteur communique avec votre système CobbleStone Software.
Problèmes connus et limitations
Actuellement, le connecteur ne prend pas en charge l’envoi ou la réception de fichiers binaires.
Le point de terminaison « Mettre à jour » est limité à un maximum de 500 lignes affectées par accès. Si plus de 500 enregistrements doivent être mis à jour, ils doivent être traités dans plusieurs accès.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| ID client - Votre Id client CobbleStone | ficelle | Entrez l’ID client. | Vrai |
| Clé secrète client - Votre ClientSecret CobbleStone | securestring | Entrez la clé secrète client. | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Créer un enregistrement pour une entité spécifiée |
Ajoutez un enregistrement (limité à un enregistrement par appel) à une entité spécifiée. La réponse sera l’ID généré par le système. |
| Extraire des métadonnées sur toutes les colonnes dans une vue de base de données spécifique |
Répertorie les colonnes, les types de données et toutes les restrictions ou indicateurs (NULL, Longueur, Clé primaire, etc.) dans une vue de base de données. |
| Extraire des métadonnées sur toutes les colonnes d’une entité spécifique |
Répertorie les colonnes, les types de données et toutes les restrictions ou indicateurs (NULL, Longueur, Clé primaire, etc.) dans une table. |
| Exécuter une vue de base de données spécifique |
Exécutez une vue de base de données spécifique (limitée à un enregistrement par appel). La réponse sera l’état. |
| Liste de tirage (pull) des entités que l’API est autorisée à utiliser |
Retourne la liste des noms et trois propriétés marquées indiquant s’il peut être modifié, mis à jour ou consulté/interrogé. |
| Liste d’enregistrements extraits pour une entité donnée |
Liste des enregistrements d’une entité donnée avec des critères spécifiques, ordre par balise, groupe par balise et nombre d’enregistrements. Remarque : Il n’existe aucune limite quant au nombre d’enregistrements à extraire, mais l’utilisateur doit considérer que les résultats plus volumineux seront plus lents à traiter. |
| Mettre à jour les enregistrements d’une entité spécifiée |
Mettez à jour les enregistrements pour une entité/zone spécifiée avec des critères spécifiques et un TriggerWorkflow comme indicateur pour exécuter le flux de travail une fois la demande de mise à jour réussie ou non. Le nombre maximal d’enregistrements pouvant être mis à jour est de 500 par appel. |
| Récupérer la liste des entités disponibles à des fins de mise à jour |
Récupérer la liste des entités disponibles de ces clients dispose de l’autorisation de mettre à jour les données, utilisation interne pour remplir dynamiquement les zones de liste |
| Récupérer la liste des entités disponibles à des fins de sélection |
Récupérer la liste des entités disponibles de ces clients dispose de l’autorisation d’interroger des données, utilisation interne pour remplir dynamiquement automatiquement les zones de liste |
| Récupérer la liste des entités disponibles à des fins d’insertion |
Récupérer la liste des entités disponibles de ces clients dispose de l’autorisation d’ajouter des données, utilisation interne pour remplir dynamiquement automatiquement les zones de liste |
| Récupérer la liste des vues de base de données disponibles |
Récupérer la liste des vues de base de données disponibles de ces clients disposent de l’autorisation d’interroger des données, une utilisation interne pour remplir dynamiquement les zones d’affichage de base de données |
Créer un enregistrement pour une entité spécifiée
Ajoutez un enregistrement (limité à un enregistrement par appel) à une entité spécifiée. La réponse sera l’ID généré par le système.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’entité
|
entityName | True | string |
Nom du nom de la table à laquelle ajouter un enregistrement. |
|
Nom
|
Name | string | ||
|
Valeur
|
Value | string |
Retours
- Corps
- APIAddRequest
Extraire des métadonnées sur toutes les colonnes dans une vue de base de données spécifique
Répertorie les colonnes, les types de données et toutes les restrictions ou indicateurs (NULL, Longueur, Clé primaire, etc.) dans une vue de base de données.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’entité
|
databaseViewName | True | string |
Nom de la vue de base de données pour laquelle récupérer le schéma. |
Retours
Liste des colonnes, types de données et restrictions ou indicateurs (NULL, Longueur, Clé primaire, etc.) dans une table
- Objets
- APISchemaResponse
Extraire des métadonnées sur toutes les colonnes d’une entité spécifique
Répertorie les colonnes, les types de données et toutes les restrictions ou indicateurs (NULL, Longueur, Clé primaire, etc.) dans une table.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’entité
|
entityName | True | string |
Nom de la table pour laquelle récupérer le schéma. |
Retours
Liste des colonnes, types de données et restrictions ou indicateurs (NULL, Longueur, Clé primaire, etc.) dans une table
- Objets
- APISchemaResponse
Exécuter une vue de base de données spécifique
Exécutez une vue de base de données spécifique (limitée à un enregistrement par appel). La réponse sera l’état.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de la vue de base de données
|
databaseViewName | True | string |
Nom de la vue base de données à exécuter. |
|
Caractéristique
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Condition
|
Condition | string | ||
|
Terrain
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
Terrain
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Type
|
Type | string | ||
|
Valeur
|
Value | string | ||
|
Fields
|
Fields | array of string | ||
|
Direction
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Quel index démarrer à, Valeur par défaut = 0 |
|
|
Length
|
Length | integer |
Nombre de lignes commençant par StartIndex, impossible d’exccéder 1000, Valeur par défaut = 100 |
Retours
Liste des colonnes, types de données et restrictions ou indicateurs (NULL, Longueur, Clé primaire, etc.) dans une table
- Objets
- APISchemaResponse
Liste de tirage (pull) des entités que l’API est autorisée à utiliser
Retourne la liste des noms et trois propriétés marquées indiquant s’il peut être modifié, mis à jour ou consulté/interrogé.
Retours
Liste des entités
- Objets
- APIEntityListResponse
Liste d’enregistrements extraits pour une entité donnée
Liste des enregistrements d’une entité donnée avec des critères spécifiques, ordre par balise, groupe par balise et nombre d’enregistrements. Remarque : Il n’existe aucune limite quant au nombre d’enregistrements à extraire, mais l’utilisateur doit considérer que les résultats plus volumineux seront plus lents à traiter.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’entité
|
entityName | True | string |
Nom de la table à partir duquel interroger les données. |
|
Caractéristique
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Condition
|
Condition | string | ||
|
Terrain
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
Terrain
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Type
|
Type | string | ||
|
Valeur
|
Value | string | ||
|
Fields
|
Fields | array of string | ||
|
Direction
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Quel index démarrer à, Valeur par défaut = 0 |
|
|
Length
|
Length | integer |
Nombre de lignes commençant par StartIndex, impossible d’exccéder 1000, Valeur par défaut = 100 |
Retours
- Objets
- APIQueryResponse
Mettre à jour les enregistrements d’une entité spécifiée
Mettez à jour les enregistrements pour une entité/zone spécifiée avec des critères spécifiques et un TriggerWorkflow comme indicateur pour exécuter le flux de travail une fois la demande de mise à jour réussie ou non. Le nombre maximal d’enregistrements pouvant être mis à jour est de 500 par appel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’entité
|
entityName | True | string |
Nom de table dans lequel mettre à jour les enregistrements. |
|
Condition
|
Condition | string | ||
|
Terrain
|
Field | string | ||
|
Id
|
Id | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
Terrain
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Type
|
Type | string | ||
|
Valeur
|
Value | string | ||
|
Type
|
Type | string | ||
|
Valeur
|
Value | string | ||
|
Nom
|
Name | string | ||
|
Valeur
|
Value | string | ||
|
TriggerWorkflow
|
TriggerWorkflow | boolean |
Retours
- Corps
- APIUpdateResponse
Récupérer la liste des entités disponibles à des fins de mise à jour
Récupérer la liste des entités disponibles de ces clients dispose de l’autorisation de mettre à jour les données, utilisation interne pour remplir dynamiquement les zones de liste
Retours
Liste des entités
- Objets
- APIEntityListResponse
Récupérer la liste des entités disponibles à des fins de sélection
Récupérer la liste des entités disponibles de ces clients dispose de l’autorisation d’interroger des données, utilisation interne pour remplir dynamiquement automatiquement les zones de liste
Retours
Liste des entités
- Objets
- APIEntityListResponse
Récupérer la liste des entités disponibles à des fins d’insertion
Récupérer la liste des entités disponibles de ces clients dispose de l’autorisation d’ajouter des données, utilisation interne pour remplir dynamiquement automatiquement les zones de liste
Retours
Liste des entités
- Objets
- APIEntityListResponse
Récupérer la liste des vues de base de données disponibles
Récupérer la liste des vues de base de données disponibles de ces clients disposent de l’autorisation d’interroger des données, une utilisation interne pour remplir dynamiquement les zones d’affichage de base de données
Retours
Réponse aux requêtes pour les vues de base de données
- Objets
- APIViewListResponse
Définitions
APIEntityListResponse
Liste des entités
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
APIEntity |
Définir chaque entité |
APIEntity
Définir chaque entité
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom de l'Entité
|
EntityName | string |
Nom d’entité tel qu’il se trouve dans la base de données |
|
EntityNameDisplay
|
EntityNameDisplay | string |
Nom complet de l’entité |
|
AllowAdd
|
AllowAdd | boolean |
Indique si l’enregistrement est autorisé à ajouter un nouvel enregistrement |
|
AllowEdit
|
AllowEdit | boolean |
Indique s’il est autorisé à modifier les enregistrements |
|
AllowView
|
AllowView | boolean |
Indique si le ou les enregistrements sont autorisés à afficher les enregistrements |
|
EntityNameForAPI
|
EntityNameForAPI | string |
Nom d’entité utilisé dans l’API CSS |
APISchemaResponse
Liste des colonnes, types de données et restrictions ou indicateurs (NULL, Longueur, Clé primaire, etc.) dans une table
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
APISchema |
APISchema
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
Name | string | |
|
IsPrimaryKey
|
IsPrimaryKey | boolean | |
|
IsIdentity
|
IsIdentity | boolean | |
|
IsNullable
|
IsNullable | boolean | |
|
DBType
|
DBType | string | |
|
LongueurMaximale
|
MaxLength | integer | |
|
DataPrecision
|
DataPrecision | integer | |
|
DataScale
|
DataScale | integer | |
|
HasDefaultValue
|
HasDefaultValue | boolean | |
|
IsComputedColumn
|
IsComputedColumn | boolean | |
|
IsPassword
|
IsPassword | boolean |
APIAddRequestTuple
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
Name | string | |
|
Valeur
|
Value | string |
APIUpdateResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
TotalAffected
|
TotalAffected | integer | |
|
TotalFailed
|
TotalFailed | integer | |
|
Message
|
Message | string |
APIAddRequest
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Tuples
|
Tuples | array of APIAddRequestTuple |
APIQueryResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
object |
APIViewListResponse
Réponse aux requêtes pour les vues de base de données
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
object |