CobbleStone - Contract Insight (Vorschau)
Verbessern Sie Ihren Vertragsverwaltungsprozess, indem Sie eine Verbindung mit unserer Contract Insight-API herstellen, um eine nahtlose Interaktion zwischen Systemen zu erhalten. Die Funktionalität, die einmal verbunden ist, umfasst: – Erstellen neuer Datensätze. – Aktualisieren vorhandener Datensätze. - Abrufen einer Liste von Datensätzen für eine bestimmte Entität. – Abrufen aller Metadaten, Einschränkungen und Kennzeichnungen. – Abrufen einer Liste bearbeitbarer, aktualisierbarer oder sichtbarer Datensätze.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | CobbleStone Software |
| URL | https://www.cobblestonesoftware.com |
| AppDev@cobblestonesystems.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Cobblestone Software |
| Webseite | https://www.cobblestonesoftware.com |
| Datenschutzrichtlinie | https://www.cobblestonesoftware.com/company/privacy-policy |
| Kategorien | Unternehmensführung; Vertrieb und CRM |
Pflasterstein
Ermöglicht die grundlegenden Vorgänge für unsere Contract Insight-Software (Add, Insert, Update) und Schemainformationen für eine Entität.
Herausgeber: CobbleStone Software
Voraussetzungen
Erfordert eine vorhandene Lizenz für CobbleStone Software (Contact Insight).
Unterstützte Vorgänge
Herunterladen
Pullliste von Datensätzen für eine bestimmte Entität mit bestimmten Kriterien, Reihenfolge nach Tag, Gruppierung nach Tag und Anzahl von Datensätzen. Hinweis: Es gibt keine Beschränkung für die Anzahl der abzurufenden Datensätze, aber der Benutzer muss berücksichtigen, dass größere Ergebnisse langsamer verarbeitet werden.
Add (Hinzufügen)
Hinzufügen eines Datensatzes (begrenzt auf einen Datensatz pro Aufruf) zur angegebenen Entität. Die Antwort ist die vom System generierte ID.
Update
Aktualisieren Sie Datensätze für eine angegebene Entität/einen bestimmten Bereich mit bestimmten Kriterien und einem TriggerWorkflow als Flag zum Ausführen des Workflows, nachdem die Updateanforderung erfolgreich war oder nicht. Die maximale Anzahl von Datensätzen, die aktualisiert werden können, beträgt 500 pro Anruf.
Schema
Listet Spalten, Datentypen und alle Einschränkungen oder Kennzeichnungen (NULL, Länge, Primärschlüssel usw.) in einer Tabelle auf.
Liste der Entitäten
Gibt die Liste der Namen und drei gekennzeichnete Eigenschaften zurück, die angeben, ob sie über diese Schnittstelle bearbeitet, aktualisiert oder angezeigt/abgefragt werden kann.
Abrufen von Anmeldeinformationen
Autorisierung (OAUTH 2.0)
- CobbleStone Software bietet zwei Methoden der Autorisierung für den Zugriff:
- Autorisierungscode: https://oauth.net/2/grant-types/authorization-code/
- Implizite Gewährung: https://oauth.net/2/grant-types/implicit/
Anmeldeinformationen können über Ihr CobbleStone-Softwaresystem eingerichtet/generiert werden.
Erste Schritte
Führen Sie die folgenden Schritte aus, um die API-Clientanmeldeinformationen über Ihr CobbleStone-Softwaresystem zu erstellen:
Innerhalb Ihres CobbleStone-Softwaresystems kann ein Systemadministrator zur folgenden Seite navigieren, um Anmeldeinformationen einzurichten/zu konfigurieren:
- Für SaaS-Clients: https://yourCompanyName.cobblestone.software/core/MyAPI.aspx
- Für bereitgestellte Clients (in der Regel): https://yourCompanyName/core/MyAPI.aspx
(HINWEIS: Dies befindet sich unter dem oberen Menüelement "Mein" und wählen Dann "Meine API-Clients") aus.
Auf diese Weise kann ein Systemadministrator OAuth 2.0-Anmeldeinformationen (Client-ID und geheimer Clientschlüssel) für die Verwendung mit dem Connector erstellen.
Von der Anmeldung bei Ihrem CobbleStone Software-System:
Zunächst öffnen Sie "CobbleStone Software" und wechseln unter "Meine > API-Clients"...
Erstellen Sie einen neuen API-Clienteintrag, indem Sie auf "API-Client hinzufügen" klicken und ihm einen eindeutigen Namen geben. Der Name ist nur intern und kann für seinen Zweck aussagekräftig sein. Es wird empfohlen, einen anderen API-Schlüssel zu verwenden, um Dinge in kleine, verwaltbare und zielgerichtete Aufgaben zu organisieren.
Dadurch wird ein Schlüssel generiert, und nur Administratoren haben Zugriff auf die Seite. Sie ist an die Person gebunden, die den Schlüssel generiert hat, und sie sind die einzige Person, die ihn sehen kann. Sie können ihn freigeben, aber nur der angemeldete Benutzer kann ihn sehen.
An diesem Punkt haben wir die Einrichtung des API-Clienteintrags abgeschlossen. Diese Client-ID und Client Securet werden für die Kommunikation mit Ihrem CobbleStone Software-System verwendet.
Bekannte Probleme und Einschränkungen
Derzeit unterstützt der Connector das Senden oder Empfangen von Binärdateien nicht.
Der Endpunkt "Update" ist auf maximal 500 betroffene Zeilen pro Treffer beschränkt. Wenn mehr als 500 Datensätze aktualisiert werden müssen, müssen sie in mehreren Treffern verarbeitet werden.
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Client-ID – Ihre CobbleStone ClientId | Schnur | Geben Sie die Client-ID ein. | Richtig |
| Geheimer Clientschlüssel – Ihr CobbleStone ClientSecret | securestring | Geben Sie den geheimen Clientschlüssel ein. | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen der Liste der verfügbaren Datenbankansichten |
Abrufen der Liste der verfügbaren Datenbankansichten dieser Clients verfügen über die Berechtigung zum Abfragen von Daten, die interne Verwendung zum dynamischen Ausfüllen der Datenbankansichtsfelder |
| Abrufen der Liste der verfügbaren Entitäten für den ausgewählten Zweck |
Abrufen der Liste der verfügbaren Entitäten dieser Clients über die Berechtigung zum Abfragen von Daten, interne Verwendung für das dynamisch automatische Ausfüllen der Listenfelder |
| Abrufen der Liste der verfügbaren Entitäten für Updatezwecke |
Abrufen der Liste der verfügbaren Entitäten dieser Clients verfügen über die Berechtigung zum Aktualisieren von Daten, die interne Verwendung zum dynamischen Ausfüllen der Listenfelder |
| Abrufen der Liste der verfügbaren Entitäten zum Einfügen |
Abrufen der Liste der verfügbaren Entitäten dieser Clients über die Berechtigung zum Hinzufügen von Daten, interne Verwendung zum dynamisch automatischen Ausfüllen der Listenfelder |
| Abrufen von Metadaten zu allen Spalten in einer bestimmten Datenbankansicht |
Listet Spalten, Datentypen und alle Einschränkungen oder Kennzeichnungen (NULL, Länge, Primärschlüssel usw.) in einer Datenbankansicht auf. |
| Abrufen von Metadaten zu allen Spalten in einer bestimmten Entität |
Listet Spalten, Datentypen und alle Einschränkungen oder Kennzeichnungen (NULL, Länge, Primärschlüssel usw.) in einer Tabelle auf. |
| Aktualisieren von Datensätzen für eine angegebene Entität |
Aktualisieren Sie Datensätze für eine angegebene Entität/einen bestimmten Bereich mit bestimmten Kriterien und einem TriggerWorkflow als Flag zum Ausführen des Workflows, nachdem die Updateanforderung erfolgreich war oder nicht. Die maximale Anzahl von Datensätzen, die aktualisiert werden können, beträgt 500 pro Anruf. |
| Ausführen einer bestimmten Datenbankansicht |
Führen Sie eine bestimmte Datenbankansicht aus (auf einen Datensatz pro Aufruf beschränkt). Die Antwort ist der Status. |
| Erstellen eines neuen Datensatzes für eine angegebene Entität |
Hinzufügen eines Datensatzes (begrenzt auf einen Datensatz pro Aufruf) zur angegebenen Entität. Die Antwort ist die vom System generierte ID. |
| Pullliste mit Datensätzen für eine bestimmte Entität |
Pullliste von Datensätzen für eine bestimmte Entität mit bestimmten Kriterien, Reihenfolge nach Tag, Gruppierung nach Tag und Anzahl von Datensätzen. Hinweis: Es gibt keine Beschränkung für die Anzahl der abzurufenden Datensätze, aber der Benutzer muss berücksichtigen, dass größere Ergebnisse langsamer verarbeitet werden. |
| Pullliste von Entitäten, mit denen DIE API arbeiten darf |
Gibt die Liste der Namen und drei gekennzeichnete Eigenschaften zurück, die angeben, ob sie bearbeitet, aktualisiert oder angezeigt/abgefragt werden kann. |
Abrufen der Liste der verfügbaren Datenbankansichten
Abrufen der Liste der verfügbaren Datenbankansichten dieser Clients verfügen über die Berechtigung zum Abfragen von Daten, die interne Verwendung zum dynamischen Ausfüllen der Datenbankansichtsfelder
Gibt zurück
Abfrageantwort für Datenbankansichten
- Gegenstände
- APIViewListResponse
Abrufen der Liste der verfügbaren Entitäten für den ausgewählten Zweck
Abrufen der Liste der verfügbaren Entitäten dieser Clients über die Berechtigung zum Abfragen von Daten, interne Verwendung für das dynamisch automatische Ausfüllen der Listenfelder
Gibt zurück
Liste der Entitäten
- Gegenstände
- APIEntityListResponse
Abrufen der Liste der verfügbaren Entitäten für Updatezwecke
Abrufen der Liste der verfügbaren Entitäten dieser Clients verfügen über die Berechtigung zum Aktualisieren von Daten, die interne Verwendung zum dynamischen Ausfüllen der Listenfelder
Gibt zurück
Liste der Entitäten
- Gegenstände
- APIEntityListResponse
Abrufen der Liste der verfügbaren Entitäten zum Einfügen
Abrufen der Liste der verfügbaren Entitäten dieser Clients über die Berechtigung zum Hinzufügen von Daten, interne Verwendung zum dynamisch automatischen Ausfüllen der Listenfelder
Gibt zurück
Liste der Entitäten
- Gegenstände
- APIEntityListResponse
Abrufen von Metadaten zu allen Spalten in einer bestimmten Datenbankansicht
Listet Spalten, Datentypen und alle Einschränkungen oder Kennzeichnungen (NULL, Länge, Primärschlüssel usw.) in einer Datenbankansicht auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Entitätsname
|
databaseViewName | True | string |
Name der Datenbankansicht, für die das Schema abgerufen werden soll. |
Gibt zurück
Liste der Spalten, Datentypen und aller Einschränkungen oder Kennzeichnungen (NULL, Länge, Primärschlüssel usw.) in einer Tabelle
- Gegenstände
- APISchemaResponse
Abrufen von Metadaten zu allen Spalten in einer bestimmten Entität
Listet Spalten, Datentypen und alle Einschränkungen oder Kennzeichnungen (NULL, Länge, Primärschlüssel usw.) in einer Tabelle auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Entitätsname
|
entityName | True | string |
Name der Tabelle, für die das Schema abgerufen werden soll. |
Gibt zurück
Liste der Spalten, Datentypen und aller Einschränkungen oder Kennzeichnungen (NULL, Länge, Primärschlüssel usw.) in einer Tabelle
- Gegenstände
- APISchemaResponse
Aktualisieren von Datensätzen für eine angegebene Entität
Aktualisieren Sie Datensätze für eine angegebene Entität/einen bestimmten Bereich mit bestimmten Kriterien und einem TriggerWorkflow als Flag zum Ausführen des Workflows, nachdem die Updateanforderung erfolgreich war oder nicht. Die maximale Anzahl von Datensätzen, die aktualisiert werden können, beträgt 500 pro Anruf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Entitätsname
|
entityName | True | string |
Tabellenname zum Aktualisieren von Datensätzen |
|
Zustand
|
Condition | string | ||
|
Feld
|
Field | string | ||
|
Id
|
Id | string | ||
|
Input
|
Input | string | ||
|
Bediener
|
Operator | string | ||
|
Zustand
|
Condition | string | ||
|
Feld
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Bediener
|
Operator | string | ||
|
Typ
|
Type | string | ||
|
Wert
|
Value | string | ||
|
Typ
|
Type | string | ||
|
Wert
|
Value | string | ||
|
Name
|
Name | string | ||
|
Wert
|
Value | string | ||
|
TriggerWorkflow
|
TriggerWorkflow | boolean |
Gibt zurück
- Body
- APIUpdateResponse
Ausführen einer bestimmten Datenbankansicht
Führen Sie eine bestimmte Datenbankansicht aus (auf einen Datensatz pro Aufruf beschränkt). Die Antwort ist der Status.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name der Datenbankansicht
|
databaseViewName | True | string |
Name der auszuführenden Datenbankansicht. |
|
Merkmal
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Zustand
|
Condition | string | ||
|
Feld
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Bediener
|
Operator | string | ||
|
Zustand
|
Condition | string | ||
|
Feld
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Bediener
|
Operator | string | ||
|
Typ
|
Type | string | ||
|
Wert
|
Value | string | ||
|
Felder
|
Fields | array of string | ||
|
Richtung
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Zu beginn des Indexes, Standard = 0 |
|
|
Length
|
Length | integer |
Zeilenanzahl beginnend mit StartIndex, kann 1000 nicht ausgelöst werden, Default = 100 |
Gibt zurück
Liste der Spalten, Datentypen und aller Einschränkungen oder Kennzeichnungen (NULL, Länge, Primärschlüssel usw.) in einer Tabelle
- Gegenstände
- APISchemaResponse
Erstellen eines neuen Datensatzes für eine angegebene Entität
Hinzufügen eines Datensatzes (begrenzt auf einen Datensatz pro Aufruf) zur angegebenen Entität. Die Antwort ist die vom System generierte ID.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Entitätsname
|
entityName | True | string |
Tabellenname, dem Datensatz hinzugefügt werden soll. |
|
Name
|
Name | string | ||
|
Wert
|
Value | string |
Gibt zurück
- Body
- APIAddRequest
Pullliste mit Datensätzen für eine bestimmte Entität
Pullliste von Datensätzen für eine bestimmte Entität mit bestimmten Kriterien, Reihenfolge nach Tag, Gruppierung nach Tag und Anzahl von Datensätzen. Hinweis: Es gibt keine Beschränkung für die Anzahl der abzurufenden Datensätze, aber der Benutzer muss berücksichtigen, dass größere Ergebnisse langsamer verarbeitet werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Entitätsname
|
entityName | True | string |
Tabellenname zum Abfragen von Daten aus. |
|
Merkmal
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Zustand
|
Condition | string | ||
|
Feld
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Bediener
|
Operator | string | ||
|
Zustand
|
Condition | string | ||
|
Feld
|
Field | string | ||
|
ID
|
ID | string | ||
|
Input
|
Input | string | ||
|
Bediener
|
Operator | string | ||
|
Typ
|
Type | string | ||
|
Wert
|
Value | string | ||
|
Felder
|
Fields | array of string | ||
|
Richtung
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Zu beginn des Indexes, Standard = 0 |
|
|
Length
|
Length | integer |
Zeilenanzahl beginnend mit StartIndex, kann 1000 nicht ausgelöst werden, Default = 100 |
Gibt zurück
- Gegenstände
- APIQueryResponse
Pullliste von Entitäten, mit denen DIE API arbeiten darf
Gibt die Liste der Namen und drei gekennzeichnete Eigenschaften zurück, die angeben, ob sie bearbeitet, aktualisiert oder angezeigt/abgefragt werden kann.
Gibt zurück
Liste der Entitäten
- Gegenstände
- APIEntityListResponse
Definitionen
APIEntityListResponse
Liste der Entitäten
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
APIEntity |
Definieren der einzelnen Entitäten |
APIEntity
Definieren der einzelnen Entitäten
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name der Entität
|
EntityName | string |
Entitätsname wie in der Datenbank |
|
EntityNameDisplay
|
EntityNameDisplay | string |
Anzeigename der Entität |
|
AllowAdd
|
AllowAdd | boolean |
Gibt an, ob ein neuer Datensatz hinzugefügt werden darf. |
|
AllowEdit
|
AllowEdit | boolean |
Gibt an, ob datensatz(s) bearbeitet werden darf. |
|
AllowView
|
AllowView | boolean |
Gibt an, ob Datensätze angezeigt werden dürfen |
|
EntityNameForAPI
|
EntityNameForAPI | string |
Entitätsname, der in der CSS-API verwendet wird |
APISchemaResponse
Liste der Spalten, Datentypen und aller Einschränkungen oder Kennzeichnungen (NULL, Länge, Primärschlüssel usw.) in einer Tabelle
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
APISchema |
APISchema
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
Name | string | |
|
IsPrimaryKey
|
IsPrimaryKey | boolean | |
|
IsIdentity
|
IsIdentity | boolean | |
|
IsNullable
|
IsNullable | boolean | |
|
DBType
|
DBType | string | |
|
Maximale Länge
|
MaxLength | integer | |
|
DataPrecision
|
DataPrecision | integer | |
|
DataScale
|
DataScale | integer | |
|
HasDefaultValue
|
HasDefaultValue | boolean | |
|
IsComputedColumn
|
IsComputedColumn | boolean | |
|
IsPassword
|
IsPassword | boolean |
APIAddRequestTuple
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
Name | string | |
|
Wert
|
Value | string |
APIUpdateResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gesamt betroffen
|
TotalAffected | integer | |
|
TotalFailed
|
TotalFailed | integer | |
|
Nachricht
|
Message | string |
APIAddRequest
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Tupel
|
Tuples | array of APIAddRequestTuple |
APIQueryResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
object |
APIViewListResponse
Abfrageantwort für Datenbankansichten
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
object |