WorkSpan
WorkSpan — это платформа совместной работы для планирования, выполнения и вождения доходов с партнерами. Управляйте своими партнерскими программами и партнерскими инициативами в WorkSpan и легко подключайтесь к внутренним и партнерским приложениям. Вы можете интегрировать CRM, Центр партнеров, средства совместной работы и средства повышения производительности в WorkSpan.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Поддержка API WorkSpan |
| URL | https://support.workspan.com |
| Адрес электронной почты | api-team@workspan.com |
| Метаданные соединителя | |
|---|---|
| Publisher | WorkSpan |
| Website | https://www.workspan.com |
| Категории | Маркетинг; Продажи и CRM |
| Политика конфиденциальности | https://www.workspan.com/privacy-policy |
WorkSpan — это платформа совместной работы для подключения к партнерам и управления своими партнерскими программами. WorkSpan предоставляет успешные партнерские программы для некоторых ведущих технологических компаний мира. Подключите популярные и предпочтительные приложения с помощью WorkSpan Ecosystem Cloud, чтобы обогатить ценность ваших возможностей продаж с помощью вашей партнерской экосистемы. С помощью соединителя WorkSpan пользователи могут заряжить экосистему и партнерские движения, легко подключаясь к числу бизнес-приложений, таких как Dynamics 365 CRM и Salesforce CRM. Пользователи могут синхронизировать данные в своих премьер-приложениях CRM с WorkSpan. Пользователи также могут подключаться к приложениям для совместной работы и производительности, таким как Microsoft Teams, Slack и OneDrive. Пользователи могут получать уведомления о различных событиях, связанных с совместной работой, в WorkSpan, таких как назначенные задачи, комментарии по объектам и связанные с ним вхождения членства в объектах. Соединитель WorkSpan повышает производительность, поддерживает целостность данных в приложениях и предоставляет своевременные данные и ценность для пользователей бизнес-приложений. В результате организации, использующие соединитель, будут испытывать экономию затрат, увеличение доходов, упрощение и ускорение процессов продаж и расширенные отчеты.
Предпосылки
Организация должна быть зарегистрированной компанией в WorkSpan
Получение учетных данных
Пользователи должны пройти проверку подлинности для использования соединителя. WorkSpan предоставляет доступ к соединителю и данным в WorkSpan для настроенных пользователей приложений в WorkSpan. Подробные действия доступны по адресу https://support.workspan.com
Известные проблемы и ограничения
Известные проблемы отсутствуют
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Среда: песочница или рабочая среда | струна | Среда песочницы или рабочая среда | True |
| Идентификатор пользователя приложения | струна | Идентификатор пользователя приложения WorkSpan | True |
| Секрет пользователя приложения | securestring | Секрет пользователя приложения | True |
| Имя узла приложения WorkSpan. Пример: demo.workspan.com /app.workspan.com | струна | Введите имя узла (без https) Пример: demo.workspan.com / app.workspan.com | True |
| Примечания. | струна | Заметки о подключении | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Возможности массовой загрузки (вложение) |
Отправьте входной файл в интеграцию. Допустимые форматы: .xlsx, .json и .csv |
| Возможности массовой загрузки (данные в тексте) |
Отправьте входные данные в виде текста запроса в интеграцию. Допустимые форматы .csv и .json |
|
Добавление сведений аудита в объект Work |
Добавление сведений аудита в WorkSpanObject |
| Массовая загрузка данных (вложение) |
Отправьте входной файл в интеграцию. Допустимые форматы: .xlsx, .json и .csv |
| Массовая загрузка данных (данные в тексте) |
Отправьте входные данные в виде текста запроса в интеграцию. Допустимые форматы .csv и .json |
|
Подключение внешнего идентификатора к идентификатору Work |
Обновление объекта WorkSpan с помощью первичного уникального идентификатора внешнего приложения |
|
Получение внешнего идентификатора для идентификатора Work |
Получение первичного уникального идентификатора внешнего приложения |
| Получение состояния операции массового загрузки |
Получение состояния операции массового загрузки |
| Получение списка отчетов |
Вывод списка отчетов |
| Чтение данных отчета |
Чтение данных отчета |
Возможности массовой загрузки (вложение)
Отправьте входной файл в интеграцию. Допустимые форматы: .xlsx, .json и .csv
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Выбор интеграции, настроенной в WorkSpan
|
integration_id | True | string |
Идентификатор интеграции взаимодействия CRM, настроенный в WorkSpan |
|
Тип контента данных. Допустимые форматы: .csv .xlsx и .json
|
content_type | string |
Тип контента данных. Допустимые форматы: .csv .xlsx и .json |
|
|
Имеет ли файл Excel строку заголовка?
|
has_header_row | boolean |
Имеет ли файл Excel строку заголовка? |
|
|
файл для отправки
|
file | True | file |
файл для отправки |
Возвращаемое значение
Возможности массовой загрузки (данные в тексте)
Отправьте входные данные в виде текста запроса в интеграцию. Допустимые форматы .csv и .json
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Выбор интеграции, настроенной в WorkSpan
|
integration_id | True | string |
Идентификатор интеграции взаимодействия CRM, настроенный в WorkSpan |
|
Тип контента данных. Допустимые форматы .csv и .json
|
content_type | string |
Тип контента данных. Допустимые форматы .csv и .json |
|
|
Разделитель столбцов (используется, если content_type является csv)
|
column_delimiter | string |
Разделитель столбцов (используется, если content_type является csv) |
|
|
Тип контента данных. text/csv или application/json.
|
Content-Type | string |
Тип контента данных. text/csv или application/json. |
|
|
данные для отправки
|
bulkload_opportunity_request |
Для типа контента "CSV": строки данных в формате CSV. первая строка будет заголовками столбцов. Для типа контента JSON формат данных имеет массив: [ { key1 : value, key2 : value}, { key1 : value, key2 : value, key2 : value } |
Возвращаемое значение
Добавление сведений аудита в объект WorkSpan
Добавление сведений аудита в WorkSpanObject
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
field_name
|
field_name | True | string |
Имя поля аудита в WorkSpan. |
|
integration_id
|
integration_id | string |
Идентификатор интеграции (длинный идентификатор) связанной интеграции |
|
|
external_id
|
external_id | string |
Идентификатор из внешней системы (например. Идентификатор CRM) |
|
|
status_code
|
status_code | True | string |
Код, представляющий состояние запроса аудита. |
|
сообщение
|
message | True | string |
Дополнительные сведения о записи в журнале аудита |
|
Идентификатор объекта WorkSpan (длинный идентификатор)
|
object_id | True | string |
Идентификатор объекта WorkSpan (long ID) для обновления с состоянием интеграции |
Возвращаемое значение
- Тело
- audit_response
Массовая загрузка данных (вложение)
Отправьте входной файл в интеграцию. Допустимые форматы: .xlsx, .json и .csv
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Выбор интеграции, настроенной в WorkSpan
|
integration_id | True | string |
Идентификатор интеграции взаимодействия CRM, настроенный в WorkSpan |
|
Форматирование данных. Допустимые форматы: .csv .xlsx и .json
|
data_format | string |
Форматирование данных. Допустимые форматы: .csv .xlsx и .json |
|
|
файл для отправки
|
file | True | file |
файл для отправки |
Возвращаемое значение
- Тело
- bulkload_response
Массовая загрузка данных (данные в тексте)
Отправьте входные данные в виде текста запроса в интеграцию. Допустимые форматы .csv и .json
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Выбор интеграции, настроенной в WorkSpan
|
integration_id | True | string |
Идентификатор интеграции взаимодействия CRM, настроенный в WorkSpan |
|
Тип контента данных. Допустимые форматы .csv и .json
|
data_format | string |
Формат данных. Допустимые форматы— csv и json |
|
|
Разделитель столбцов (используется, если content_type является csv)
|
column_delimiter | string |
Разделитель столбцов (используется, если content_type является csv) |
|
|
Тип контента данных. text/csv или application/json.
|
Content-Type | string |
Тип контента данных. text/csv или application/json. |
|
|
данные для отправки
|
bulkload_request |
Для типа контента "CSV": строки данных в формате CSV. первая строка будет заголовками столбцов. Для типа контента JSON формат данных имеет массив: [ { key1 : value, key2 : value}, { key1 : value, key2 : value, key2 : value } |
Возвращаемое значение
- Тело
- bulkload_response
Подключение внешнего идентификатора к идентификатору WorkSpan
Обновление объекта WorkSpan с помощью первичного уникального идентификатора внешнего приложения
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор объекта WorkSpan (длинный идентификатор)
|
object_id | True | string |
Идентификатор объекта WorkSpan (длинный идентификатор) |
|
field_name
|
field_name | string |
Имя поля внешнего идентификатора в WorkSpan. Если пусто, будет использоваться имя поля внешнего идентификатора по умолчанию. Имена полей по умолчанию: объект возможности: "sales_details.crm_opportunity_id"; Объект Accound: "account_info.external_account_id" |
|
|
external_id
|
external_id | True | string |
Идентификатор внешней системы (например, CRM) |
Возвращаемое значение
- Тело
- external_id_response
Получение внешнего идентификатора для идентификатора WorkSpan
Получение первичного уникального идентификатора внешнего приложения
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор объекта WorkSpan (длинный идентификатор)
|
object_id | True | string |
Идентификатор объекта WorkSpan (длинный идентификатор) |
Возвращаемое значение
Получение состояния операции массового загрузки
Получение состояния операции массового загрузки
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор интеграции
|
integration_id | True | string |
Идентификатор интеграции |
|
Идентификатор выполнения (возвращенный шаг массового загрузки бу)
|
execution_id | True | string |
Идентификатор выполнения интеграции, возвращаемый из массового API |
|
Включение ошибок в ответ при возникновении ошибок
|
include_errors | boolean |
Включение ошибок в ответ при возникновении ошибок |
|
|
Максимальное количество ошибок, возвращаемых обратно в ответе
|
max_errors | number |
Максимальное количество ошибок, возвращаемых обратно в ответе |
Возвращаемое значение
Получение списка отчетов
Вывод списка отчетов
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
число/номер
|
number | integer |
число/номер |
|
|
size
|
size | integer |
size |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string |
id |
|
имя
|
name | string |
имя |
Чтение данных отчета
Чтение данных отчета
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор отчета
|
reportId | True | integer |
Идентификатор отчета |
|
colId
|
colId | string | ||
|
отрицать
|
negate | boolean | ||
|
оп
|
op | string | ||
|
type
|
type | string | ||
|
оп
|
op | string | ||
|
число/номер
|
number | True | integer | |
|
size
|
size | True | integer |
Возвращаемое значение
- Тело
- ReportDataResponse
Триггеры
|
Отправка ссылки в Центр партнеров Майкрософт из Work |
Этот триггер запускается, когда пользователь WorkSpan просит отправить возможность в Центр партнеров Майкрософт |
|
Подписка на события объектов Work |
Подпишитесь на различные события объектов, например создание и обновление возможностей для повышения видимости влияния партнера |
|
Подписка на события совместной работы Work |
Подпишитесь на различные события совместной работы, такие как создание и обновление членства, задач и комментариев, чтобы обеспечить взаимодействие с внутренней и партнерской сетью. |
Отправка ссылки в Центр партнеров Майкрософт из WorkSpan
Этот триггер запускается, когда пользователь WorkSpan просит отправить возможность в Центр партнеров Майкрософт
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
имя
|
name | True | string |
Имя подписчика события |
|
Выбор интеграции, настроенной в WorkSpan
|
integration_id | True | string |
Возвращаемое значение
Подписка на события объектов WorkSpan
Подпишитесь на различные события объектов, например создание и обновление возможностей для повышения видимости влияния партнера
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Подписка на события объектов
|
event | True | array of string | |
|
имя
|
name | True | string |
Имя подписчика события |
|
Выбор интеграции, настроенной в WorkSpan
|
integration_id | True | string | |
|
object_ids
|
object_ids | array of string | ||
|
Пример фильтра: (этап в [ "закрытый", "выиграл", "потерян" ]) AND (sales_details.partner = "P1")
|
filters | string |
Фильтры для событий |
Возвращаемое значение
Подписка на события совместной работы WorkSpan
Подпишитесь на различные события совместной работы, такие как создание и обновление членства, задач и комментариев, чтобы обеспечить взаимодействие с внутренней и партнерской сетью.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя события
|
event | True | string | |
|
Имя подписчика
|
name | True | string |
Имя, назначенное веб-перехватчику |
|
Идентификатор объекта WorkSpan
|
object_ids | array of string |
Идентификаторы объектов, для которых зарегистрирован веб-перехватчик |
|
|
Пример фильтра: (этап в [ "закрытый", "выиграл", "потерян" ]) AND (sales_details.partner = "P1")
|
filters | string |
Фильтры для событий |
Возвращаемое значение
Определения
bulkload_opportunity_response
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
integration_id
|
integration_id | string |
Идентификатор интеграции |
|
execution_id
|
execution_id | string |
Идентификатор выполнения |
|
создано_в
|
created_at | date-time |
Время создания |
bulkload_response
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
integration_id
|
integration_id | string |
Идентификатор интеграции |
|
execution_id
|
execution_id | string |
Идентификатор выполнения |
|
data_format
|
data_format | string |
Формат данных |
|
создано_в
|
created_at | date-time |
Время создания |
bulkload_status_response
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
integration_id
|
integration_id | string |
Идентификатор интеграции |
|
execution_id
|
execution_id | string |
Идентификатор выполнения |
|
статус
|
status | string |
Состояние выполнения |
|
succcess_count
|
succcess_count | number |
Количество записей, которые были успешно обработаны |
|
error_count
|
error_count | number |
Количество записей с ошибками |
|
input_count
|
input_count | number |
Количество полученных записей |
|
skip_count
|
skip_count | number |
Количество пропущенных записей |
|
started_at
|
started_at | date-time |
Метка времени запуска выполнения |
|
завершено_в
|
completed_at | date-time |
Метка времени завершения выполнения |
|
include_errors
|
include_errors | boolean |
Флаг, указывающий, будут ли возвращены ошибки в ответе, если таковые есть |
|
Ошибки
|
errors | array of object | |
|
сообщение
|
errors.message | string |
Сообщение об ошибке |
|
id
|
errors.id | string |
Идентификатор записи, которая завершилась сбоем |
|
data_row
|
errors.data_row | string |
Строка данных, которая завершилась сбоем |
external_id_response
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
external_id
|
external_id | string |
Идентификатор внешней системы (например, CRM) |
|
object_id
|
object_id | string |
Идентификатор объекта WorkSpan (длинный идентификатор) |
|
field_name
|
field_name | string |
Имя поля WorkSpan, в котором хранится external_id из внешней системы |
get_external_id_response
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
object_id
|
object_id | string |
Идентификатор объекта WorkSpan (длинный идентификатор) |
|
external_ids
|
external_ids | array of object | |
|
field_name
|
external_ids.field_name | string |
Имя поля WorkSpan, в котором хранится external_id из внешней системы |
|
external_id
|
external_ids.external_id | string |
Идентификатор внешней системы (например, CRM) |
audit_response
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
object_id
|
object_id | string |
Идентификатор объекта WorkSpan (длинный идентификатор), который был обновлен |
|
field_name
|
field_name | string |
Имя поля WorkSpan, которое было обновлено |
|
status_code
|
status_code | string |
Состояние обновления |
ReportDataResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
endOfList
|
endOfList | boolean | |
|
results
|
results | array of | |
|
version
|
version | integer |