CobbleStone — Analiza kontraktu (wersja zapoznawcza)
Usprawnij proces zarządzania kontraktami, łącząc się z interfejsem API analizy kontraktów w celu zapewnienia bezproblemowej interakcji między systemami. Funkcjonalność po nawiązaniu połączenia obejmuje: — tworzenie nowych rekordów. - Aktualizowanie istniejących rekordów. — Ściąganie listy rekordów dla danej jednostki. — Ściąganie wszystkich metadanych, ograniczeń i flag. — Ściąganie listy rekordów możliwych do edycji, aktualizowalnych lub możliwych do wyświetlenia.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | CobbleStone Software |
| adres URL | https://www.cobblestonesoftware.com |
| AppDev@cobblestonesystems.com |
| Metadane łącznika | |
|---|---|
| Publisher | Cobblestone Software |
| Witryna internetowa | https://www.cobblestonesoftware.com |
| Zasady ochrony prywatności | https://www.cobblestonesoftware.com/company/privacy-policy |
| Kategorie | Zarządzanie biznesem; Sprzedaż i CRM |
Brukowiec
Umożliwia wykonywanie podstawowych operacji na naszym oprogramowaniu Contract Insight (Dodawanie, wstawianie, aktualizowanie) i informacje o schemacie dla jednostki.
Wydawca: CobbleStone Software
Wymagania wstępne
Wymaga istniejącej licencji na oprogramowanie CobbleStone (Contact Insight).
Obsługiwane operacje
Pobierz
Lista ściągnięcia rekordów dla danej jednostki z określonymi kryteriami, kolejność według tagów, grupowanie według tagów i liczba rekordów. Uwaga: nie ma limitu liczby rekordów do ściągnięcia, ale użytkownik musi wziąć pod uwagę, że większe wyniki będą wolniejsze do przetworzenia.
Dodaj
Dodaj rekord (ograniczony do jednego rekordu na wywołanie) do określonej jednostki. Odpowiedź będzie identyfikatorem wygenerowany przez system.
Update
Zaktualizuj rekordy dla określonej jednostki/obszaru z określonymi kryteriami i triggerWorkflow jako flagą do uruchomienia przepływu pracy po pomyślnym lub nie pomyślnym żądaniu aktualizacji. Maksymalna liczba rekordów, które można zaktualizować, wynosi 500 na wywołanie.
Schema
Wyświetla w tabeli kolumny, typy danych oraz wszelkie ograniczenia lub flagi (NULL, Długość, Klucz podstawowy itp.).
Lista jednostek
Zwraca listę nazw i trzech oflagowanych właściwości wskazujących, czy można je edytować, aktualizować lub wyświetlać/wykonywać zapytania za pośrednictwem tego interfejsu.
Uzyskiwanie poświadczeń
Autoryzacja (OAUTH 2.0)
- CobbleStone Software oferuje dwie metody autoryzacji dostępu:
- Kod autoryzacji: https://oauth.net/2/grant-types/authorization-code/
- Niejawne udzielanie: https://oauth.net/2/grant-types/implicit/
Poświadczenia można skonfigurować/wygenerować za pośrednictwem systemu Oprogramowania CobbleStone.
Wprowadzenie
Aby utworzyć poświadczenia klienta interfejsu API za pomocą systemu Oprogramowania CobbleStone, wykonaj następujące kroki:
W systemie CobbleStone Software administrator systemu może przejść do następującej strony, aby skonfigurować/skonfigurować poświadczenia:
- W przypadku klientów SaaS: https://yourCompanyName.cobblestone.software/core/MyAPI.aspx
- W przypadku wdrożonych klientów (zazwyczaj): https://yourCompanyName/core/MyAPI.aspx
(UWAGA: Znajduje się to w górnym elemencie menu "Moje", a następnie wybierz pozycję "Moi klienci interfejsu API")
Dzięki temu administrator systemu może utworzyć poświadczenia protokołu OAuth 2.0 (identyfikator klienta i klucz tajny klienta) do użycia z łącznikiem.
Po zalogowaniu się do systemu CobbleStone Software:
Aby rozpocząć, otworzysz oprogramowanie CobbleStone i przejdziesz w obszarze Moje > klienci interfejsu API...
Utwórz nowy wpis klienta interfejsu API, klikając pozycję Dodaj klienta interfejsu API i nadaj mu unikatową nazwę. Nazwa jest tylko wewnętrzna i może być niczym zrozumiałym dla jego celu. Zalecamy użycie innego klucza interfejsu API w celu organizowania elementów w małe, możliwe do zarządzania i celowe zadania.
Spowoduje to wygenerowanie klucza i tylko personel administracyjny ma dostęp do strony. Jest to powiązana osoba, która wygenerowała klucz i jest jedyną osobą, która ją widzi. Klucz można udostępnić, ale tylko zalogowany użytkownik może go zobaczyć.
Na tym etapie skonfigurujemy wpis klienta interfejsu API. Ten identyfikator klienta i securet klienta są używane do komunikacji łącznika z systemem Oprogramowania CobbleStone.
Znane problemy i ograniczenia
Obecnie łącznik nie obsługuje wysyłania ani odbierania plików binarnych.
Punkt końcowy aktualizacji jest ograniczony do maksymalnie 500 wierszy na trafienie. Jeśli trzeba zaktualizować więcej niż 500 rekordów, należy je przetworzyć w wielu trafieniach.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Identyfikator klienta — Identyfikator klienta CobbleStone ClientId | ciąg | Wprowadź identyfikator klienta. | Prawda |
| Klucz tajny klienta — Klient CobbleStoneSecret | securestring | Wprowadź klucz tajny klienta. | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie rekordów dla określonej jednostki |
Zaktualizuj rekordy dla określonej jednostki/obszaru z określonymi kryteriami i triggerWorkflow jako flagą do uruchomienia przepływu pracy po pomyślnym lub nie pomyślnym żądaniu aktualizacji. Maksymalna liczba rekordów, które można zaktualizować, wynosi 500 na wywołanie. |
| Lista ściągnięcia jednostek, z którymi interfejs API może pracować |
Zwraca listę nazw i trzech oflagowanych właściwości wskazujących, czy można ją edytować, zaktualizować lub wyświetlić/odpytać. |
| Lista ściągnięcia rekordów dla danej jednostki |
Lista ściągnięcia rekordów dla danej jednostki z określonymi kryteriami, kolejność według tagów, grupowanie według tagów i liczba rekordów. Uwaga: nie ma limitu liczby rekordów do ściągnięcia, ale użytkownik musi wziąć pod uwagę, że większe wyniki będą wolniejsze do przetworzenia. |
| Pobieranie listy dostępnych jednostek do wstawiania celu |
Pobieranie listy dostępnych jednostek tych klientów ma uprawnienia do dodawania danych, użytku wewnętrznego do dynamicznego wypełniania pól listy |
| Pobieranie listy dostępnych jednostek do wybrania celu |
Pobieranie listy dostępnych jednostek tych klientów ma uprawnienia do wykonywania zapytań dotyczących danych, użytku wewnętrznego na potrzeby dynamicznego automatycznego wypełniania pól listy |
| Pobieranie listy dostępnych jednostek na potrzeby aktualizacji |
Pobieranie listy dostępnych jednostek tych klientów ma uprawnienia do aktualizowania danych, użytku wewnętrznego do dynamicznego wypełniania pól listy |
| Pobieranie listy dostępnych widoków bazy danych |
Pobieranie listy dostępnych widoków bazy danych tych klientów ma uprawnienia do wykonywania zapytań dotyczących danych, użytku wewnętrznego do dynamicznego wypełniania pól Widok bazy danych |
| Tworzenie nowego rekordu dla określonej jednostki |
Dodaj rekord (ograniczony do jednego rekordu na wywołanie) do określonej jednostki. Odpowiedź będzie identyfikatorem wygenerowany przez system. |
| Wykonywanie określonego widoku bazy danych |
Wykonaj określony widok bazy danych (ograniczony do jednego rekordu na wywołanie). Odpowiedź będzie stanem. |
| Ściąganie metadanych dotyczących wszystkich kolumn w określonej jednostce |
Wyświetla w tabeli kolumny, typy danych oraz wszelkie ograniczenia lub flagi (NULL, Długość, Klucz podstawowy itp.). |
| Ściąganie metadanych dotyczących wszystkich kolumn w określonym widoku bazy danych |
Wyświetla kolumny, typy danych i wszelkie ograniczenia lub flagi (NULL, Długość, Klucz podstawowy itp.) w widoku bazy danych. |
Aktualizowanie rekordów dla określonej jednostki
Zaktualizuj rekordy dla określonej jednostki/obszaru z określonymi kryteriami i triggerWorkflow jako flagą do uruchomienia przepływu pracy po pomyślnym lub nie pomyślnym żądaniu aktualizacji. Maksymalna liczba rekordów, które można zaktualizować, wynosi 500 na wywołanie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa encji
|
entityName | True | string |
Nazwa tabeli do aktualizowania rekordów. |
|
Condition
|
Condition | string | ||
|
(No changes needed)
|
Field | string | ||
|
Id
|
Id | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
(No changes needed)
|
Field | string | ||
|
identyfikator
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Typ
|
Type | string | ||
|
Wartość
|
Value | string | ||
|
Typ
|
Type | string | ||
|
Wartość
|
Value | string | ||
|
Name
|
Name | string | ||
|
Wartość
|
Value | string | ||
|
TriggerWorkflow
|
TriggerWorkflow | boolean |
Zwraca
- Body
- APIUpdateResponse
Lista ściągnięcia jednostek, z którymi interfejs API może pracować
Zwraca listę nazw i trzech oflagowanych właściwości wskazujących, czy można ją edytować, zaktualizować lub wyświetlić/odpytać.
Zwraca
Lista jednostek
- Przedmioty
- APIEntityListResponse
Lista ściągnięcia rekordów dla danej jednostki
Lista ściągnięcia rekordów dla danej jednostki z określonymi kryteriami, kolejność według tagów, grupowanie według tagów i liczba rekordów. Uwaga: nie ma limitu liczby rekordów do ściągnięcia, ale użytkownik musi wziąć pod uwagę, że większe wyniki będą wolniejsze do przetworzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa encji
|
entityName | True | string |
Nazwa tabeli do wykonywania zapytań o dane z. |
|
Attribute
|
Attribute | string | ||
|
Pseudonim
|
Alias | string | ||
|
Condition
|
Condition | string | ||
|
(No changes needed)
|
Field | string | ||
|
identyfikator
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
(No changes needed)
|
Field | string | ||
|
identyfikator
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Typ
|
Type | string | ||
|
Wartość
|
Value | string | ||
|
Pola formularza
|
Fields | array of string | ||
|
Direction
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Jaki indeks ma zaczynać się od, Wartość domyślna = 0 |
|
|
Długość
|
Length | integer |
Liczba wierszy rozpoczynająca się od początkowego indeksu, nie można wyostrzyć wartości 1000, wartość domyślna = 100 |
Zwraca
- Przedmioty
- APIQueryResponse
Pobieranie listy dostępnych jednostek do wstawiania celu
Pobieranie listy dostępnych jednostek tych klientów ma uprawnienia do dodawania danych, użytku wewnętrznego do dynamicznego wypełniania pól listy
Zwraca
Lista jednostek
- Przedmioty
- APIEntityListResponse
Pobieranie listy dostępnych jednostek do wybrania celu
Pobieranie listy dostępnych jednostek tych klientów ma uprawnienia do wykonywania zapytań dotyczących danych, użytku wewnętrznego na potrzeby dynamicznego automatycznego wypełniania pól listy
Zwraca
Lista jednostek
- Przedmioty
- APIEntityListResponse
Pobieranie listy dostępnych jednostek na potrzeby aktualizacji
Pobieranie listy dostępnych jednostek tych klientów ma uprawnienia do aktualizowania danych, użytku wewnętrznego do dynamicznego wypełniania pól listy
Zwraca
Lista jednostek
- Przedmioty
- APIEntityListResponse
Pobieranie listy dostępnych widoków bazy danych
Pobieranie listy dostępnych widoków bazy danych tych klientów ma uprawnienia do wykonywania zapytań dotyczących danych, użytku wewnętrznego do dynamicznego wypełniania pól Widok bazy danych
Zwraca
Odpowiedź na zapytanie dla widoków bazy danych
- Przedmioty
- APIViewListResponse
Tworzenie nowego rekordu dla określonej jednostki
Dodaj rekord (ograniczony do jednego rekordu na wywołanie) do określonej jednostki. Odpowiedź będzie identyfikatorem wygenerowany przez system.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa encji
|
entityName | True | string |
Nazwa tabeli do dodania rekordu. |
|
Name
|
Name | string | ||
|
Wartość
|
Value | string |
Zwraca
- Body
- APIAddRequest
Wykonywanie określonego widoku bazy danych
Wykonaj określony widok bazy danych (ograniczony do jednego rekordu na wywołanie). Odpowiedź będzie stanem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa widoku bazy danych
|
databaseViewName | True | string |
Nazwa widoku bazy danych do wykonania. |
|
Attribute
|
Attribute | string | ||
|
Pseudonim
|
Alias | string | ||
|
Condition
|
Condition | string | ||
|
(No changes needed)
|
Field | string | ||
|
identyfikator
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Condition
|
Condition | string | ||
|
(No changes needed)
|
Field | string | ||
|
identyfikator
|
ID | string | ||
|
Input
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Typ
|
Type | string | ||
|
Wartość
|
Value | string | ||
|
Pola formularza
|
Fields | array of string | ||
|
Direction
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Jaki indeks ma zaczynać się od, Wartość domyślna = 0 |
|
|
Długość
|
Length | integer |
Liczba wierszy rozpoczynająca się od początkowego indeksu, nie można wyostrzyć wartości 1000, wartość domyślna = 100 |
Zwraca
Lista kolumn, typów danych i wszelkich ograniczeń lub flag (NULL, Długość, Klucz podstawowy itp.) w tabeli
- Przedmioty
- APISchemaResponse
Ściąganie metadanych dotyczących wszystkich kolumn w określonej jednostce
Wyświetla w tabeli kolumny, typy danych oraz wszelkie ograniczenia lub flagi (NULL, Długość, Klucz podstawowy itp.).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa encji
|
entityName | True | string |
Nazwa tabeli do pobrania schematu. |
Zwraca
Lista kolumn, typów danych i wszelkich ograniczeń lub flag (NULL, Długość, Klucz podstawowy itp.) w tabeli
- Przedmioty
- APISchemaResponse
Ściąganie metadanych dotyczących wszystkich kolumn w określonym widoku bazy danych
Wyświetla kolumny, typy danych i wszelkie ograniczenia lub flagi (NULL, Długość, Klucz podstawowy itp.) w widoku bazy danych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa encji
|
databaseViewName | True | string |
Nazwa widoku bazy danych do pobrania schematu. |
Zwraca
Lista kolumn, typów danych i wszelkich ograniczeń lub flag (NULL, Długość, Klucz podstawowy itp.) w tabeli
- Przedmioty
- APISchemaResponse
Definicje
APIEntityListResponse
Lista jednostek
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
APIEntity |
Definiowanie każdej jednostki |
APIEntity
Definiowanie każdej jednostki
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa jednostki
|
EntityName | string |
Nazwa jednostki, która znajduje się w bazie danych |
|
EntityNameDisplay
|
EntityNameDisplay | string |
Nazwa wyświetlana jednostki |
|
AllowAdd
|
AllowAdd | boolean |
Wskazuje, czy można dodać nowy rekord |
|
AllowEdit
|
AllowEdit | boolean |
Wskazuje, czy można edytować rekordy |
|
AllowView
|
AllowView | boolean |
Wskazuje, czy można wyświetlać rekordy |
|
EntityNameForAPI
|
EntityNameForAPI | string |
Nazwa jednostki używana w interfejsie API CSS |
APISchemaResponse
Lista kolumn, typów danych i wszelkich ograniczeń lub flag (NULL, Długość, Klucz podstawowy itp.) w tabeli
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
APISchema |
APISchema
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
Name | string | |
|
IsPrimaryKey
|
IsPrimaryKey | boolean | |
|
IsIdentity
|
IsIdentity | boolean | |
|
IsNullable
|
IsNullable | boolean | |
|
DbType
|
DBType | string | |
|
Maksymalna długość
|
MaxLength | integer | |
|
DataPrecision
|
DataPrecision | integer | |
|
DataScale
|
DataScale | integer | |
|
HasDefaultValue
|
HasDefaultValue | boolean | |
|
IsComputedColumn
|
IsComputedColumn | boolean | |
|
IsPassword
|
IsPassword | boolean |
Interfejs APIAddRequestTuple
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
Name | string | |
|
Wartość
|
Value | string |
APIUpdateResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Suma, której dotyczy problem
|
TotalAffected | integer | |
|
TotalFailed
|
TotalFailed | integer | |
|
Message
|
Message | string |
ApiAddRequest
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Krotek
|
Tuples | array of APIAddRequestTuple |
ApiQueryResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
object |
APIViewListResponse
Odpowiedź na zapytanie dla widoków bazy danych
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
object |