CobbleStone — Аналитика контракта (предварительная версия)
Улучшение процесса управления контрактами путем подключения к API Аналитики контрактов для эффективного взаимодействия между системами. Функция после подключения включает: — создание новых записей. — обновление существующих записей. — извлечение списка записей для определенной сущности. — извлечение всех метаданных, ограничений и флагов. — извлечение списка редактируемых, обновляемых или просматриваемых записей.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | CobbleStone Software |
| URL | https://www.cobblestonesoftware.com |
| Адрес электронной почты | AppDev@cobblestonesystems.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Cobblestone Software |
| Веб-сайт | https://www.cobblestonesoftware.com |
| Privacy Policy (Политика конфиденциальности) | https://www.cobblestonesoftware.com/company/privacy-policy |
| Категории | Управление бизнесом; Продажи и CRM |
Булыжник
Позволяет выполнять основные операции с нашим программным обеспечением Contract Insights (добавление, вставка, обновление) и сведения о схеме для сущности.
Издатель: CobbleStone Software
Предпосылки
Требуется существующая лицензия на CobbleStone Software (Contact Insights).
Поддерживаемые операции
Get
Список записей для определенной сущности с определенными критериями, порядок по тегу, группирование по тегу и количеству записей. Примечание. Количество записей, которые требуется извлечь, не ограничено, но пользователь должен учитывать, что более крупные результаты будут медленнее для обработки.
Добавить
Добавьте запись (ограниченную одной записью на вызов) в указанную сущность. Ответ будет идентификатором, созданным системой.
Update
Обновите записи для указанной сущности или области с определенными критериями и флагом TriggerWorkflow, чтобы запустить рабочий процесс после успешного выполнения запроса на обновление. Максимальное количество записей, которые можно обновить, составляет 500 за вызов.
Schema
Перечисляет столбцы, типы данных и все ограничения или флаги (NULL, длина, первичный ключ и т. д.) в таблице.
Список сущностей
Возвращает список имен и три помеченных свойства, указывающие, можно ли изменять, обновлять или просматривать или запрашивать с помощью этого интерфейса.
Получение учетных данных
Авторизация (OAUTH 2.0)
- CobbleStone Software предлагает два метода авторизации для доступа:
- Код авторизации: https://oauth.net/2/grant-types/authorization-code/
- Неявное предоставление: https://oauth.net/2/grant-types/implicit/
Учетные данные можно настроить или создать с помощью системы CobbleStone Software.
Начало работы
Чтобы создать учетные данные клиента API с помощью системы CobbleStone Software, выполните следующие действия:
В системе CobbleStone Software системный администратор может перейти на следующую страницу, чтобы настроить и настроить учетные данные:
- Для клиентов SaaS: https://yourCompanyName.cobblestone.software/core/MyAPI.aspx
- Для развернутых клиентов (обычно): https://yourCompanyName/core/MyAPI.aspx
(ПРИМЕЧАНИЕ. Это находится в верхнем меню "Мои" и выберите "Мои клиенты API")
Это позволяет системным администратору создавать учетные данные OAuth 2.0 (идентификатор клиента и секрет клиента) для использования с соединителем.
Войдите в систему CobbleStone Software:
Чтобы начать, вы откроете CobbleStone Software и перейдите под мои > клиенты API...
Создайте запись клиента API, нажав кнопку "Добавить клиент API" и присвойте ему уникальное имя. Имя является только внутренним и может быть любым значимым для его цели. Мы рекомендуем использовать другой ключ API для упорядочивания в небольших, управляемых и целевых задачах.
Это приведет к созданию ключа и доступ к странице имеют только сотрудники администраторов. Он привязан к человеку, который создал ключ, и они единственный, кто может видеть его. Вы можете поделиться ключом, но только пользователь, вошедший в систему, может видеть его.
На этом этапе мы настроим запись клиента API. Этот идентификатор клиента и защита клиента используются для взаимодействия соединителя с системой CobbleStone Software.
Известные проблемы и ограничения
В настоящее время соединитель не поддерживает отправку или получение двоичных файлов.
Конечная точка Update ограничена максимальной 500 затронутыми строками на попадание. Если требуется обновить более 500 записей, их необходимо обработать в нескольких попаданиях.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Идентификатор клиента — your CobbleStone ClientId | струна | Введите идентификатор клиента. | True |
| Секрет клиента — your CobbleStone ClientSecret | securestring | Введите секрет клиента. | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Выполнение определенного представления базы данных |
Выполните определенное представление базы данных (ограничено одной записью для каждого вызова). Ответ будет состоянием. |
| Извлечение метаданных обо всех столбцах в определенной сущности |
Перечисляет столбцы, типы данных и все ограничения или флаги (NULL, длина, первичный ключ и т. д.) в таблице. |
| Извлечение метаданных обо всех столбцах в определенном представлении базы данных |
Перечисляет столбцы, типы данных и все ограничения или флаги (NULL, длина, первичный ключ и т. д.) в представлении базы данных. |
| Обновление записей для указанной сущности |
Обновите записи для указанной сущности или области с определенными критериями и флагом TriggerWorkflow, чтобы запустить рабочий процесс после успешного выполнения запроса на обновление. Максимальное количество записей, которые можно обновить, составляет 500 за вызов. |
| Получение списка доступных представлений базы данных |
Получение списка доступных представлений базы данных этих клиентов имеет разрешение на запрос данных, внутреннее использование для динамического заполнения полей представления базы данных |
| Получение списка доступных сущностей для выбора назначения |
Получение списка доступных сущностей этих клиентов имеет разрешение на запрос данных, внутреннее использование для динамического заполнения списков |
| Получение списка доступных сущностей для назначения вставки |
Получение списка доступных сущностей этих клиентов имеет разрешение на добавление данных, внутреннее использование для динамического автоматического заполнения списков |
| Получение списка доступных сущностей для назначения обновления |
Получение списка доступных сущностей этих клиентов имеет разрешение на обновление данных, внутреннее использование для динамического заполнения списков |
| Создание записи для указанной сущности |
Добавьте запись (ограниченную одной записью на вызов) в указанную сущность. Ответ будет идентификатором, созданным системой. |
| Список записей для определенной сущности |
Список записей для определенной сущности с определенными критериями, порядок по тегу, группирование по тегу и количеству записей. Примечание. Количество записей, которые требуется извлечь, не ограничено, но пользователь должен учитывать, что более крупные результаты будут медленнее для обработки. |
| Список сущностей, с которым разрешено работать с API |
Возвращает список имен и три помеченных свойства, указывающие, можно ли изменять, обновлять или просматривать или запрашивать. |
Выполнение определенного представления базы данных
Выполните определенное представление базы данных (ограничено одной записью для каждого вызова). Ответ будет состоянием.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя представления базы данных
|
databaseViewName | True | string |
Имя представления базы данных для выполнения. |
|
Свойство
|
Attribute | string | ||
|
Псевдоним
|
Alias | string | ||
|
Состояние
|
Condition | string | ||
|
Поле
|
Field | string | ||
|
Идентификатор
|
ID | string | ||
|
Ввод
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Состояние
|
Condition | string | ||
|
Поле
|
Field | string | ||
|
Идентификатор
|
ID | string | ||
|
Ввод
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Тип
|
Type | string | ||
|
Ценность
|
Value | string | ||
|
Fields
|
Fields | array of string | ||
|
Направление
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Какой индекс начинается с, Default = 0 |
|
|
Length
|
Length | integer |
Число строк, начиная с StartIndex, не может вычлено 1000, Default = 100 |
Возвращаемое значение
Список столбцов, типов данных и любых ограничений или флагов (NULL, длина, первичный ключ и т. д.) в таблице
- Товары
- APISchemaResponse
Извлечение метаданных обо всех столбцах в определенной сущности
Перечисляет столбцы, типы данных и все ограничения или флаги (NULL, длина, первичный ключ и т. д.) в таблице.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя сущности
|
entityName | True | string |
Имя таблицы для получения схемы. |
Возвращаемое значение
Список столбцов, типов данных и любых ограничений или флагов (NULL, длина, первичный ключ и т. д.) в таблице
- Товары
- APISchemaResponse
Извлечение метаданных обо всех столбцах в определенном представлении базы данных
Перечисляет столбцы, типы данных и все ограничения или флаги (NULL, длина, первичный ключ и т. д.) в представлении базы данных.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя сущности
|
databaseViewName | True | string |
Имя представления базы данных для получения схемы. |
Возвращаемое значение
Список столбцов, типов данных и любых ограничений или флагов (NULL, длина, первичный ключ и т. д.) в таблице
- Товары
- APISchemaResponse
Обновление записей для указанной сущности
Обновите записи для указанной сущности или области с определенными критериями и флагом TriggerWorkflow, чтобы запустить рабочий процесс после успешного выполнения запроса на обновление. Максимальное количество записей, которые можно обновить, составляет 500 за вызов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя сущности
|
entityName | True | string |
Имя таблицы для обновления записей. |
|
Состояние
|
Condition | string | ||
|
Поле
|
Field | string | ||
|
Идентификатор
|
Id | string | ||
|
Ввод
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Состояние
|
Condition | string | ||
|
Поле
|
Field | string | ||
|
Идентификатор
|
ID | string | ||
|
Ввод
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Тип
|
Type | string | ||
|
Ценность
|
Value | string | ||
|
Тип
|
Type | string | ||
|
Ценность
|
Value | string | ||
|
Имя
|
Name | string | ||
|
Ценность
|
Value | string | ||
|
TriggerWorkflow
|
TriggerWorkflow | boolean |
Возвращаемое значение
- Тело
- APIUpdateResponse
Получение списка доступных представлений базы данных
Получение списка доступных представлений базы данных этих клиентов имеет разрешение на запрос данных, внутреннее использование для динамического заполнения полей представления базы данных
Возвращаемое значение
Ответ запроса для представлений базы данных
- Товары
- APIViewListResponse
Получение списка доступных сущностей для выбора назначения
Получение списка доступных сущностей этих клиентов имеет разрешение на запрос данных, внутреннее использование для динамического заполнения списков
Возвращаемое значение
Список сущностей
- Товары
- APIEntityListResponse
Получение списка доступных сущностей для назначения вставки
Получение списка доступных сущностей этих клиентов имеет разрешение на добавление данных, внутреннее использование для динамического автоматического заполнения списков
Возвращаемое значение
Список сущностей
- Товары
- APIEntityListResponse
Получение списка доступных сущностей для назначения обновления
Получение списка доступных сущностей этих клиентов имеет разрешение на обновление данных, внутреннее использование для динамического заполнения списков
Возвращаемое значение
Список сущностей
- Товары
- APIEntityListResponse
Создание записи для указанной сущности
Добавьте запись (ограниченную одной записью на вызов) в указанную сущность. Ответ будет идентификатором, созданным системой.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя сущности
|
entityName | True | string |
Имя таблицы для добавления записи. |
|
Имя
|
Name | string | ||
|
Ценность
|
Value | string |
Возвращаемое значение
- Тело
- APIAddRequest
Список записей для определенной сущности
Список записей для определенной сущности с определенными критериями, порядок по тегу, группирование по тегу и количеству записей. Примечание. Количество записей, которые требуется извлечь, не ограничено, но пользователь должен учитывать, что более крупные результаты будут медленнее для обработки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя сущности
|
entityName | True | string |
Имя таблицы для запроса данных из. |
|
Свойство
|
Attribute | string | ||
|
Псевдоним
|
Alias | string | ||
|
Состояние
|
Condition | string | ||
|
Поле
|
Field | string | ||
|
Идентификатор
|
ID | string | ||
|
Ввод
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Состояние
|
Condition | string | ||
|
Поле
|
Field | string | ||
|
Идентификатор
|
ID | string | ||
|
Ввод
|
Input | string | ||
|
Operator
|
Operator | string | ||
|
Тип
|
Type | string | ||
|
Ценность
|
Value | string | ||
|
Fields
|
Fields | array of string | ||
|
Направление
|
Direction | string | ||
|
GroupByTag
|
GroupByTag | array of string | ||
|
StartIndex
|
StartIndex | integer |
Какой индекс начинается с, Default = 0 |
|
|
Length
|
Length | integer |
Число строк, начиная с StartIndex, не может вычлено 1000, Default = 100 |
Возвращаемое значение
- Товары
- APIQueryResponse
Список сущностей, с которым разрешено работать с API
Возвращает список имен и три помеченных свойства, указывающие, можно ли изменять, обновлять или просматривать или запрашивать.
Возвращаемое значение
Список сущностей
- Товары
- APIEntityListResponse
Определения
APIEntityListResponse
Список сущностей
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Товары
|
APIEntity |
Определение каждой сущности |
APIEntity
Определение каждой сущности
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
EntityName (ИмяСущности)
|
EntityName | string |
Имя сущности в базе данных |
|
EntityNameDisplay
|
EntityNameDisplay | string |
Отображаемое имя сущности |
|
AllowAdd
|
AllowAdd | boolean |
Указывает, разрешено ли добавить новую запись |
|
AllowEdit
|
AllowEdit | boolean |
Указывает, разрешено ли изменять записи |
|
AllowView
|
AllowView | boolean |
Указывает, разрешено ли просматривать записи |
|
EntityNameForAPI
|
EntityNameForAPI | string |
Имя сущности, используемое в API CSS |
APISchemaResponse
Список столбцов, типов данных и любых ограничений или флагов (NULL, длина, первичный ключ и т. д.) в таблице
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Товары
|
APISchema |
APISchema
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
Name | string | |
|
IsPrimaryKey
|
IsPrimaryKey | boolean | |
|
IsIdentity
|
IsIdentity | boolean | |
|
IsNullable
|
IsNullable | boolean | |
|
DBType
|
DBType | string | |
|
МаксДлина
|
MaxLength | integer | |
|
DataPrecision
|
DataPrecision | integer | |
|
DataScale
|
DataScale | integer | |
|
HasDefaultValue
|
HasDefaultValue | boolean | |
|
IsComputedColumn
|
IsComputedColumn | boolean | |
|
IsPassword
|
IsPassword | boolean |
APIAddRequestTuple
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
Name | string | |
|
Ценность
|
Value | string |
APIUpdateResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
TotalAffected
|
TotalAffected | integer | |
|
TotalFailed
|
TotalFailed | integer | |
|
Message
|
Message | string |
APIAddRequest
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Кортежей
|
Tuples | array of APIAddRequestTuple |
APIQueryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Товары
|
object |
APIViewListResponse
Ответ запроса для представлений базы данных
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Товары
|
object |