CobbleStone - Contract Insight (preview)
Verbeter uw contractbeheerproces door verbinding te maken met onze Contract Insight-API voor naadloze interactie tussen systemen. Functionaliteit zodra er verbinding is gemaakt, omvat: - Nieuwe records maken. - Bestaande records bijwerken. - Een lijst met records voor een bepaalde entiteit ophalen. - Alle metagegevens, beperkingen en vlaggen ophalen. - Een lijst met bewerkbare, bijwerkbare of bekijkbare records ophalen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | CobbleStone Software |
| URL | https://www.cobblestonesoftware.com |
| E-mailen | AppDev@cobblestonesystems.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Cobblestone Software |
| Webpagina | https://www.cobblestonesoftware.com |
| Privacybeleid | https://www.cobblestonesoftware.com/company/privacy-policy |
| Categorieën | Bedrijfsbeheer; Verkoop en CRM |
Geplaveide
Hiermee kunt u de basisbewerkingen voor onze Contract Insight-software (Toevoegen, Invoegen, Bijwerken) en schemagegevens voor een entiteit toestaan.
Uitgever: CobbleStone Software
Vereiste voorwaarden
Hiervoor is een bestaande licentie vereist voor CobbleStone Software (Contact Insight).
Ondersteunde bewerkingen
Ontvang
Haal een lijst met records voor een bepaalde entiteit op met specifieke criteria, volgorde per tag, groeperen op tag en aantal records. Opmerking: er is geen limiet voor het aantal records dat moet worden opgehaald, maar de gebruiker moet er rekening mee houden dat grotere resultaten langzamer worden verwerkt.
Toevoegen
Voeg een record (beperkt tot één record per aanroep) toe aan de opgegeven entiteit. Het antwoord is de door het systeem gegenereerde id.
bijwerken
Werk record(s) bij voor een opgegeven entiteit/gebied met specifieke criteria en een TriggerWorkflow als vlag om de werkstroom uit te voeren nadat de updateaanvraag is geslaagd of niet. Het maximum aantal records dat kan worden bijgewerkt, is 500 per aanroep.
Schema
Een lijst met kolommen, gegevenstypen en eventuele beperkingen of vlaggen (NULL, Lengte, Primaire sleutel, enzovoort) in een tabel.
Lijst met entiteiten
Retourneert de lijst met namen en drie gemarkeerde eigenschappen die aangeven of deze via deze interface kunnen worden bewerkt, bijgewerkt of bekeken/opgevraagd.
Referenties verkrijgen
Autorisatie (OAUTH 2.0)
- CobbleStone Software biedt twee autorisatiemethoden voor toegang:
- Autorisatiecode: https://oauth.net/2/grant-types/authorization-code/
- Impliciete toekenning: https://oauth.net/2/grant-types/implicit/
Referenties kunnen worden ingesteld/gegenereerd via uw CobbleStone Software-systeem.
Aan de slag komen
Als u de API-clientreferenties wilt maken via uw CobbleStone Software-systeem, gebruikt u de volgende stappen:
Binnen uw CobbleStone Software-systeem kan een systeembeheerder naar de volgende pagina navigeren om referenties in te stellen/te configureren:
- Voor SaaS-clients: https://yourCompanyName.cobblestone.software/core/MyAPI.aspx
- Voor geïmplementeerde clients (meestal): https://yourCompanyName/core/MyAPI.aspx
(OPMERKING: Dit bevindt zich onder het bovenste menu-item 'Mijn' en selecteer vervolgens 'Mijn API-clients')
Hiermee kan een systeembeheerder OAuth 2.0-referenties (client-id en clientgeheim) maken voor gebruik met de connector.
Meld u aan bij uw CobbleStone Software-systeem:
Om te beginnen opent u CobbleStone Software en gaat u onder Mijn > API-clients...
Maak een nieuwe API-clientvermelding door op API-client toevoegen te klikken en deze een unieke naam te geven. De naam is alleen intern en kan iets zinvols zijn voor het doel ervan. We raden u aan om een andere API-sleutel te gebruiken om dingen te organiseren in kleine, beheerbare en doelgerichte taken.
Hiermee wordt een sleutel gegenereerd en hebben alleen beheerderspersoneel toegang tot de pagina. Het is gebonden aan de persoon die de sleutel heeft gegenereerd en ze zijn de enige die de sleutel kan zien. U kunt de sleutel delen, maar alleen de aangemelde gebruiker kan deze zien.
Op dit moment zijn we klaar met het instellen van de API-clientvermelding. Deze client-id en Client Securet worden gebruikt voor de connector om te communiceren met uw CobbleStone Software-systeem.
Bekende problemen en beperkingen
Momenteel biedt de connector geen ondersteuning voor het verzenden of ontvangen van binaire bestanden.
Het eindpunt Update is beperkt tot maximaal 500 betrokken rijen per hit. Als meer dan 500 records moeten worden bijgewerkt, moeten ze in meerdere treffers worden verwerkt.
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| Client-id - Uw CobbleStone ClientId | touw | Voer de client-id in. | Klopt |
| Clientgeheim - Uw CobbleStone ClientSecret | beveiligde string | Voer het clientgeheim in. | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Een nieuwe record maken voor een opgegeven entiteit |
Voeg een record (beperkt tot één record per aanroep) toe aan de opgegeven entiteit. Het antwoord is de door het systeem gegenereerde id. |
| Een specifieke databaseweergave uitvoeren |
Voer een specifieke databaseweergave uit (beperkt tot één record per aanroep). Het antwoord is de status. |
| Lijst met beschikbare databaseweergaven ophalen |
Lijst met beschikbare databaseweergaven van die clients ophalen, heeft de machtiging om query's uit te voeren op gegevens, intern gebruik voor het dynamisch automatisch invullen van de vakken Databaseweergave |
| Lijst met beschikbare entiteiten ophalen voor doel selecteren |
Lijst met beschikbare entiteiten van die clients ophalen, heeft de machtiging om gegevens op te vragen, intern gebruik voor het dynamisch automatisch invullen van de keuzelijsten |
| Lijst met beschikbare entiteiten ophalen voor het invoegen van doel |
Lijst met beschikbare entiteiten van die clients ophalen, heeft de machtiging om gegevens toe te voegen, intern gebruik voor het dynamisch automatisch invullen van de keuzelijsten |
| Lijst met beschikbare entiteiten ophalen voor updatedoel |
Lijst met beschikbare entiteiten van die clients ophalen, heeft de machtiging om gegevens bij te werken, intern gebruik voor het dynamisch automatisch invullen van de keuzelijsten |
| Metagegevens ophalen over alle kolommen in een specifieke databaseweergave |
Lijsten met kolommen, gegevenstypen en eventuele beperkingen of vlaggen (NULL, Lengte, Primaire sleutel, enzovoort) in een databaseweergave. |
| Metagegevens ophalen over alle kolommen in een specifieke entiteit |
Een lijst met kolommen, gegevenstypen en eventuele beperkingen of vlaggen (NULL, Lengte, Primaire sleutel, enzovoort) in een tabel. |
| Pull-lijst met entiteiten waarmee API mag werken |
Retourneert de lijst met namen en drie gemarkeerde eigenschappen die aangeven of deze kunnen worden bewerkt, bijgewerkt of bekeken/opgevraagd. |
| Pull-lijst met records voor een bepaalde entiteit |
Haal een lijst met records voor een bepaalde entiteit op met specifieke criteria, volgorde per tag, groeperen op tag en aantal records. Opmerking: er is geen limiet voor het aantal records dat moet worden opgehaald, maar de gebruiker moet er rekening mee houden dat grotere resultaten langzamer worden verwerkt. |
| Record(s) bijwerken voor een opgegeven entiteit |
Werk record(s) bij voor een opgegeven entiteit/gebied met specifieke criteria en een TriggerWorkflow als vlag om de werkstroom uit te voeren nadat de updateaanvraag is geslaagd of niet. Het maximum aantal records dat kan worden bijgewerkt, is 500 per aanroep. |
Een nieuwe record maken voor een opgegeven entiteit
Voeg een record (beperkt tot één record per aanroep) toe aan de opgegeven entiteit. Het antwoord is de door het systeem gegenereerde id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De naam van de entiteit
|
entityName | True | string |
Naam van tabelnaam waaraan u een record wilt toevoegen. |
|
Naam
|
Name | string | ||
|
Waarde
|
Value | string |
Retouren
- Body
- APIAddRequest
Een specifieke databaseweergave uitvoeren
Voer een specifieke databaseweergave uit (beperkt tot één record per aanroep). Het antwoord is de status.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam van databaseweergave
|
databaseViewName | True | string |
De naam van de databaseweergave die moet worden uitgevoerd. |
|
Attribute
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Condition
|
Condition | string | ||
|
Veld
|
Field | string | ||
|
ID-kaart
|
ID | string | ||
|
Invoer
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
Veld
|
Field | string | ||
|
ID-kaart
|
ID | string | ||
|
Invoer
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Typologie
|
Type | string | ||
|
Waarde
|
Value | string | ||
|
Fields
|
Fields | array of string | ||
|
Richting
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Welke index moet worden gestart op, Standaard = 0 |
|
|
Length
|
Length | integer |
Aantal rijen vanaf StartIndex kan niet worden afgetrokken van 1000, Standaard = 100 |
Retouren
Lijst met kolommen, gegevenstypen en eventuele beperkingen of vlaggen (NULL, Lengte, Primaire sleutel, enzovoort) in een tabel
- Artikelen
- APISchemaResponse
Lijst met beschikbare databaseweergaven ophalen
Lijst met beschikbare databaseweergaven van die clients ophalen, heeft de machtiging om query's uit te voeren op gegevens, intern gebruik voor het dynamisch automatisch invullen van de vakken Databaseweergave
Retouren
Queryreactie voor databaseweergaven
- Artikelen
- APIViewListResponse
Lijst met beschikbare entiteiten ophalen voor doel selecteren
Lijst met beschikbare entiteiten van die clients ophalen, heeft de machtiging om gegevens op te vragen, intern gebruik voor het dynamisch automatisch invullen van de keuzelijsten
Retouren
Lijst met entiteiten
- Artikelen
- APIEntityListResponse
Lijst met beschikbare entiteiten ophalen voor het invoegen van doel
Lijst met beschikbare entiteiten van die clients ophalen, heeft de machtiging om gegevens toe te voegen, intern gebruik voor het dynamisch automatisch invullen van de keuzelijsten
Retouren
Lijst met entiteiten
- Artikelen
- APIEntityListResponse
Lijst met beschikbare entiteiten ophalen voor updatedoel
Lijst met beschikbare entiteiten van die clients ophalen, heeft de machtiging om gegevens bij te werken, intern gebruik voor het dynamisch automatisch invullen van de keuzelijsten
Retouren
Lijst met entiteiten
- Artikelen
- APIEntityListResponse
Metagegevens ophalen over alle kolommen in een specifieke databaseweergave
Lijsten met kolommen, gegevenstypen en eventuele beperkingen of vlaggen (NULL, Lengte, Primaire sleutel, enzovoort) in een databaseweergave.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De naam van de entiteit
|
databaseViewName | True | string |
Naam van de databaseweergave waarvoor het schema moet worden opgehaald. |
Retouren
Lijst met kolommen, gegevenstypen en eventuele beperkingen of vlaggen (NULL, Lengte, Primaire sleutel, enzovoort) in een tabel
- Artikelen
- APISchemaResponse
Metagegevens ophalen over alle kolommen in een specifieke entiteit
Een lijst met kolommen, gegevenstypen en eventuele beperkingen of vlaggen (NULL, Lengte, Primaire sleutel, enzovoort) in een tabel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De naam van de entiteit
|
entityName | True | string |
Naam van de tabel waarvoor het schema moet worden opgehaald. |
Retouren
Lijst met kolommen, gegevenstypen en eventuele beperkingen of vlaggen (NULL, Lengte, Primaire sleutel, enzovoort) in een tabel
- Artikelen
- APISchemaResponse
Pull-lijst met entiteiten waarmee API mag werken
Retourneert de lijst met namen en drie gemarkeerde eigenschappen die aangeven of deze kunnen worden bewerkt, bijgewerkt of bekeken/opgevraagd.
Retouren
Lijst met entiteiten
- Artikelen
- APIEntityListResponse
Pull-lijst met records voor een bepaalde entiteit
Haal een lijst met records voor een bepaalde entiteit op met specifieke criteria, volgorde per tag, groeperen op tag en aantal records. Opmerking: er is geen limiet voor het aantal records dat moet worden opgehaald, maar de gebruiker moet er rekening mee houden dat grotere resultaten langzamer worden verwerkt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De naam van de entiteit
|
entityName | True | string |
Tabelnaam waaruit een query moet worden uitgevoerd op gegevens. |
|
Attribute
|
Attribute | string | ||
|
Alias
|
Alias | string | ||
|
Condition
|
Condition | string | ||
|
Veld
|
Field | string | ||
|
ID-kaart
|
ID | string | ||
|
Invoer
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
Veld
|
Field | string | ||
|
ID-kaart
|
ID | string | ||
|
Invoer
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Typologie
|
Type | string | ||
|
Waarde
|
Value | string | ||
|
Fields
|
Fields | array of string | ||
|
Richting
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Welke index moet worden gestart op, Standaard = 0 |
|
|
Length
|
Length | integer |
Aantal rijen vanaf StartIndex kan niet worden afgetrokken van 1000, Standaard = 100 |
Retouren
- Artikelen
- APIQueryResponse
Record(s) bijwerken voor een opgegeven entiteit
Werk record(s) bij voor een opgegeven entiteit/gebied met specifieke criteria en een TriggerWorkflow als vlag om de werkstroom uit te voeren nadat de updateaanvraag is geslaagd of niet. Het maximum aantal records dat kan worden bijgewerkt, is 500 per aanroep.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De naam van de entiteit
|
entityName | True | string |
Tabelnaam waarin record(s) moeten worden bijgewerkt. |
|
Condition
|
Condition | string | ||
|
Veld
|
Field | string | ||
|
Identiteitsbewijs
|
Id | string | ||
|
Invoer
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
Veld
|
Field | string | ||
|
ID-kaart
|
ID | string | ||
|
Invoer
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Typologie
|
Type | string | ||
|
Waarde
|
Value | string | ||
|
Typologie
|
Type | string | ||
|
Waarde
|
Value | string | ||
|
Naam
|
Name | string | ||
|
Waarde
|
Value | string | ||
|
TriggerWorkflow
|
TriggerWorkflow | boolean |
Retouren
- Body
- APIUpdateResponse
Definities
APIEntityListResponse
Lijst met entiteiten
| Name | Pad | Type | Description |
|---|---|---|---|
|
Artikelen
|
APIEntity |
Elke entiteit definiëren |
APIEntity
Elke entiteit definiëren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Naam van de entiteit
|
EntityName | string |
Naam van entiteit zoals deze zich in de database bevindt |
|
EntityNameDisplay
|
EntityNameDisplay | string |
Weergavenaam van entiteit |
|
AllowAdd
|
AllowAdd | boolean |
Geeft aan of het toevoegen van een nieuwe record is toegestaan |
|
AllowEdit
|
AllowEdit | boolean |
Geeft aan of record(S) mag worden bewerkt |
|
AllowView
|
AllowView | boolean |
Geeft aan of record(s) mogen worden weergegeven |
|
EntityNameForAPI
|
EntityNameForAPI | string |
Entiteitsnaam die wordt gebruikt in CSS-API |
APISchemaResponse
Lijst met kolommen, gegevenstypen en eventuele beperkingen of vlaggen (NULL, Lengte, Primaire sleutel, enzovoort) in een tabel
| Name | Pad | Type | Description |
|---|---|---|---|
|
Artikelen
|
APISchema |
APISchema
| Name | Pad | Type | Description |
|---|---|---|---|
|
Naam
|
Name | string | |
|
IsPrimaryKey
|
IsPrimaryKey | boolean | |
|
IsIdentity
|
IsIdentity | boolean | |
|
IsNullable
|
IsNullable | boolean | |
|
DBType
|
DBType | string | |
|
MaxLengte
|
MaxLength | integer | |
|
DataPrecision
|
DataPrecision | integer | |
|
DataScale
|
DataScale | integer | |
|
HasDefaultValue
|
HasDefaultValue | boolean | |
|
IsComputedColumn
|
IsComputedColumn | boolean | |
|
IsPassword
|
IsPassword | boolean |
APIAddRequestTuple
| Name | Pad | Type | Description |
|---|---|---|---|
|
Naam
|
Name | string | |
|
Waarde
|
Value | string |
APIUpdateResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Totaal getroffen
|
TotalAffected | integer | |
|
TotalFailed
|
TotalFailed | integer | |
|
Message
|
Message | string |
APIAddRequest
| Name | Pad | Type | Description |
|---|---|---|---|
|
Tupels
|
Tuples | array of APIAddRequestTuple |
APIQueryResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Artikelen
|
object |
APIViewListResponse
Queryreactie voor databaseweergaven
| Name | Pad | Type | Description |
|---|---|---|---|
|
Artikelen
|
object |