Поделиться через


CMI (предварительная версия)

Для обмена данными с низким кодом: передача данных из M365 непосредственно в CMI. Передача данных на основе dossier CMI, включая задачи и контакты, из M365 в решение CMI. Настраиваемый соединитель CMI обеспечивает еще большую совместную работу из обоих миров. Их сильные стороны объединяются в непобедимое сочетание. С помощью нашей базовой функциональности вы можете использовать почти каждое приложение M365 для создания новых или обновлений заданных объектов в решении CMI.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга 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)
Контакт
Имя CM Informatik AG
URL http://www.cmiag.ch
Адрес электронной почты support@cmiag.ch
Метаданные соединителя
Publisher CM Informatik AG
Website http://www.cmiag.ch
Политика конфиденциальности https://cmiag.ch/rechtliches/
Категории Содержимое и файлы

Для обмена данными с низким кодом: передача данных из M365 непосредственно в CMI. Передача данных на основе dossier CMI, включая задачи и контакты, из M365 в решение CMI. Настраиваемый соединитель CMI обеспечивает еще большую совместную работу из обоих миров. Их сильные стороны объединяются в непобедимое сочетание. С помощью нашей базовой функциональности вы можете использовать почти каждое приложение M365 для создания новых или обновлений заданных объектов в решении CMI.

Предпосылки

Допустимая подписка в CMI Cloud.

Получение учетных данных

Запрос доступа путем обращения в службу поддержки CM Informatik AG

Начало работы с соединителем

Создайте первый поток: отправьте документ из SharePoint в CMI. После получения всех метаданных для файла, который вы хотите отправить, выполните следующие действия:

  1. Найдите досье, в котором нужно отправить документ с помощью метода "Поиск dossiers с синтаксисом TentaQl".
  2. Создайте папку и вложенную папку внутри заданного dossier с помощью метода Create folder.
  3. Отправьте документ в ранее созданную папку с помощью метода "Создать новый документ".

Известные проблемы и ограничения

N/A

Распространенные ошибки и средства устранения неполадок

Существуют поля, которые требуются, даже если API явно не говорит. Сообщение об ошибке должно указывать, какое поле отсутствует. Не все подписки имеют все доступные конечные точки, что означает, что может быть, вы увидите действие, которое не будет работать с текущей подпиской.

Часто задаваемые вопросы

Вопрос. Нужна ли подписка для использования этого соединителя? Ответ. Да, для использования соединителя CMI потребуется активная подписка на лицензию CMI.

Вопрос. Что делать, если у меня возникли проблемы с использованием пользовательского соединителя? Ответ. Если при использовании пользовательского соединителя возникли проблемы, вы можете обратиться в документацию по Power Automate или обратиться в службу поддержки CMI. Они помогут вам устранить любые проблемы и убедиться, что пользовательский соединитель работает правильно.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Адрес обновления

Адрес обновления

Адреса поиска с синтаксисом TentaQl

Адреса поиска с синтаксисом TentaQl

Возврат абстрактного действия по GUID

Возврат абстрактного действия по GUID

Возврат документа

Возврат документа

Выполнение меню действий

Выполнение меню действий

Действия поиска с синтаксисом TentaQl

Действия поиска с синтаксисом TentaQl

Обновление действия

Обновление действия

Обновление документа

Обновление документа

Обновление досье

Обновление досье

Обновление контакта

Обновление контакта

Обновление папки

Обновление папки

Ознакомьтесь с документом

Ознакомьтесь с документом

Отмена извлеченного документа

Отмена извлеченного документа

Отправка HTTP-запроса

Создайте запрос REST API для вызова.

Поиск dossiers с синтаксисом TentaQl

Поиск dossiers с синтаксисом TentaQl

Поиск абстрактного dossier с синтаксисом TentaQl

Поиск абстрактного dossier с синтаксисом TentaQl

Поиск абстрактных действий с помощью синтаксиса TentaQl

Поиск абстрактных действий с помощью синтаксиса TentaQl

Поиск документов с синтаксисом TentaQl

Поиск документов с синтаксисом TentaQl

Поиск контактов с помощью синтаксиса TentaQl

Поиск контактов с помощью синтаксиса TentaQl

Поиск лиц с синтаксисом TentaQl

Поиск лиц с синтаксисом TentaQl

Поиск папок с синтаксисом TentaQl

Поиск папок с синтаксисом TentaQl

Получение абстрактного dossier по GUID

Получение абстрактного dossier по GUID

Получение адреса по GUID

Получение адреса по GUID

Получение действия по GUID

Получение действия по GUID

Получение документа по GUID

Получение документа по GUID

Получение контакта по GUID

Получение контакта по GUID

Получение одного dossier по GUID

Получение одного dossier по GUID

Получение папки по GUID

Получение папки по GUID

Получение пользователя по GUID

Получение пользователя по GUID

Скачивание содержимого документа

Скачивание содержимого документа (определенной версии)

Создание адреса

Создание адреса

Создание действия

Создание действия

Создание документа

Создание документа

Создание контакта

Создание контакта

Создание нового dossier

Создание нового dossier

Создать папку

Создать папку

Удаление адреса

Удаление адреса

Удаление действия

Удаление действия

Удаление документа

Удаление документа

Удаление досье

Удаление досье

Удаление контакта

Удаление контакта

Удаление папки

Удаление папки

Адрес обновления

Адрес обновления

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

GUID адреса
guid uuid
Версия
version integer
Имя типа
typeName string
Улица
strasse string
Почтовый индекс
plz string
Город
ort string
Неактивное
inaktiv True boolean
Допустимый из - в
gueltigVonBis string
GUID контакта
guid uuid
Имя контактного лица
displayName string
URL-адрес контакта
url string
GUID типа адреса
guid uuid
Имя типа адреса
displayName string
URL-адрес типа адреса
url string
GUID страны
guid uuid
Имя страны
displayName string
URL-адрес страны
url string

Адреса поиска с синтаксисом TentaQl

Адреса поиска с синтаксисом TentaQl

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Запрос TentaQl
body string

Запрос TentaQl

Возвращаемое значение

response
array of Adresse

Возврат абстрактного действия по GUID

Возврат абстрактного действия по GUID

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

Объект абстрактного действия типа GUID

Возвращаемое значение

Возврат документа

Возврат документа

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Файл
file file

Файл

Проверка примечания
checkInComment string

Проверка примечания

Состояние документа
dokumentStatus string

Состояние документа

Выполнение меню действий

Выполнение меню действий

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

Клавиша меню
menu True string

Клавиша меню

Действия поиска с синтаксисом TentaQl

Действия поиска с синтаксисом TentaQl

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Запрос TentaQl
body string

Запрос TentaQl

Возвращаемое значение

Обновление действия

Обновление действия

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

GUID действия
guid uuid
Версия
version integer
Имя типа
typeName string
Название
titel True string
Срок
termin string
Дата начала
beginn string
Дата завершения
erledigung string
Состояние
status True string

NochNichtBegonnen, Erfasst, InBearbeitung, Fertig, Abgeschlossen, Abgebrochen

Замечание
bemerkung string
Внешний ключ
schluesselFremdsystem string
Тип действия
aktivitaetstyp string
GUID документа
guid uuid
Имя документа
displayName string
URL-адрес документа
url string
GUID основного действия
guid uuid
Имя основного действия
displayName string
URL-адрес основного действия
url string
Dossier GUID
guid uuid
Dossier Name
displayName string
Url-адрес dossier
url string
Из GUID
guid uuid
Имя
displayName string
Из URL-адреса
url string
Для GUID
guid uuid
Имя
displayName string
Url-адрес
url string
Идентификатор GUID, доступный для ответственного использования
guid uuid
Ответственное имя
displayName string
Url-адрес с ответом
url string

Обновление документа

Обновление документа

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

GUID документа
guid uuid
Версия
version integer
Имя типа
typeName string

Имя типа объекта

Название
titel True string
EDocument в процессе
inBearbeitungBei string
Версия
version integer
Имя файла
fileName string
Файл
file string
Задание создателя
creatorJob string
Дата документа
dokumentdatum string
Дата исходящего данных
ausgangsdatum string
Заготовка даты
eingangsdatum string
Author
autor string
Замечание
bemerkung string
Внешний ключ
schluesselFremdsystem string
Декиссия
beschuss True boolean
Доступно декиссия
beschlussvorhanden True boolean
Опубликовано
istPubliziert True boolean
ВИП
vip True boolean
Dossier GUID
guid uuid
Dossier Name
displayName string
Url-адрес dossier
url string
GUID категории
guid uuid
Имя категории
displayName string
URL-адрес категории
url string
GUID папки
guid uuid
Имя папки
displayName string
URL-адрес папки
url string

Обновление досье

Обновление досье

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

Dossier GUID
guid uuid
Версия
version integer
Имя типа
typeName string
Название
titel True string
Управление доступом
zugriffsteuerung True string

Offen, Restriktiv

Конец
ende string
Start
beginn True string
Серийный номер
laufnummer True string
Внешний ключ системы
schluesselFremdsystem string
Состояние жизненного цикла
lifecycleStatus True string

InBearbeitung, Abgeschlossen, Passiv, Angeboten, ZurKassationVorgesehen, Выборка, Abgeliefert, Kassiert, ZurAufbewahrungVorgesehen, Aufbewahrt, ZurKassationFreigegeben, Archiviert, KassiertAufbewahrt

GUID реестра
guid uuid
Имя реестра
displayName string
URL-адрес реестра
url string
Состояние dossier
geschaeftsstatus True string

InBearbeitung, Storniert, Zusammengefuehrt, Abgeschlossen

GUID документа
guid uuid
Имя документа
displayName string
URL-адрес документа
url string
GUID действий
guid uuid
Имя действий
displayName string
URL-адрес действий
url string
GUID обозревателя документов
guid uuid
Имя обозревателя документов
displayName string
URL-адрес обозревателя документов
url string
GUID папки
guid uuid
Имя папки
displayName string
URL-адрес папки
url string
GUID владельца бизнеса
guid uuid
Имя владельца бизнеса
displayName string
URL-адрес владельца бизнеса
url string
Основной dossier GUID
guid uuid
Имя главного досье
displayName string
URL-адрес главного досье
url string
GUID участия
guid uuid
Имя участия
displayName string
URL-адрес участия
url string
Guid заметки
guid uuid
Имя заметки
displayName string
Url-адрес заметки
url string
Guid "Ссылка на"
guid uuid
Имя "Ссылка на"
displayName string
Url-адрес "Ссылка на"
url string
Guid "Reference From" (Ссылка из)
guid uuid
Имя "Ссылка из"
displayName string
Url-адрес "Ссылка из"
url string
Subdossier GUID
guid uuid
Имя поддоссьера
displayName string
URL-адрес subdossier
url string

Обновление контакта

Обновление контакта

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

GUID контакта
guid uuid
Номер версии
version integer
Имя типа
typeName string
Внешний ключ
fremdkey string
Частный номер телефона
telefonPrivat string
Номер телефона для бизнеса
telefonGeschaeft string
Организация
organisation string
Номер мобильного телефона
natel string
Дата рождения
geburtsdatum string
Вторичная электронная почта
email2 string
Основной адрес электронной почты
email string
Фамилия
name string
Имя (первое имя)
vorname string
Приветствие
anrede string
EDocument в процессе
inBearbeitungBei string
Версия
version integer
Имя файла
fileName string
Файл
file string
Задание создателя
creatorJob string
Неактивное
inaktiv True boolean
Сотрудник
mitarbeiter True boolean
Дата смерти
todesdatum string
Опубликовано
istPubliziert True boolean
Настройка проверки подлинности Google
googleAuthKonfiguriert True boolean
Disabled
behindert True boolean
Увеличение потребности в уходе
erhoehterBetreuungsbedarf True boolean
Резиденция неизвестна
aufenthaltUnbekannt True boolean
GUID адреса
guid uuid
Имя адреса
displayName string
URL-адрес
url string
GUID участия
guid uuid
Имя участия
displayName string
URL-адрес участия
url string
GUID языка соответствия
guid uuid
Имя языка соответствия
displayName string
URL-адрес языка соответствия
url string
GUID пола
guid uuid
Гендерное имя
displayName string
URL-адрес пола
url string
GUID для домашних городов
guid uuid
Имя родной города
displayName string
Url-адрес родной города
url string
GUID национальностей
guid uuid
Имя национальностей
displayName string
URL-адрес национальностей
url string

Обновление папки

Обновление папки

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

GUID папки
guid uuid
Номер версии
version integer
Имя типа
typeName string
Название
titel True string
Родительский GUID
guid uuid
Родительское имя
displayName string
Родительский URL-адрес
url string
Guid дочерних элементов
guid uuid
Имя дочерних элементов
displayName string
URL-адрес дочерних объектов
url string
Dossier GUID
guid uuid
Dossier Name
displayName string
Url-адрес dossier
url string

Ознакомьтесь с документом

Ознакомьтесь с документом

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Отмена извлеченного документа

Отмена извлеченного документа

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Возвращаемое значение

response
binary

Отправка HTTP-запроса

Создайте запрос REST API для вызова.

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Метод
method True string

Метод Http

Путь
path True string

Относительный URL-адрес после /api/proxy/префикс. Пример: AbstraktesGeschaeft/Search

Headers
headers object

Введите объект JSON заголовков запросов

Тело
body string

Ввод содержимого запроса в ФОРМАТЕ JSON

Поиск dossiers с синтаксисом TentaQl

Поиск dossiers с синтаксисом TentaQl

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Запрос TentaQl
body string

Запрос TentaQl

Возвращаемое значение

Поиск абстрактного dossier с синтаксисом TentaQl

Поиск абстрактного dossier с синтаксисом TentaQl

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Запрос TentaQl
body string

Запрос TentaQl

Возвращаемое значение

Поиск абстрактных действий с помощью синтаксиса TentaQl

Поиск абстрактных действий с помощью синтаксиса TentaQl

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Запрос TentaQl
body string

Запрос TentaQl

Возвращаемое значение

Поиск документов с синтаксисом TentaQl

Поиск документов с синтаксисом TentaQl

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Запрос TentaQl
body string

Запрос TentaQl

Возвращаемое значение

Поиск контактов с помощью синтаксиса TentaQl

Поиск контактов с помощью синтаксиса TentaQl

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Запрос TentaQl
body string

Запрос TentaQl

Возвращаемое значение

response
array of Kontakt

Поиск лиц с синтаксисом TentaQl

Поиск лиц с синтаксисом TentaQl

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Запрос TentaQl
body string

Запрос TentaQl

Возвращаемое значение

response
array of Person

Поиск папок с синтаксисом TentaQl

Поиск папок с синтаксисом TentaQl

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Запрос TentaQl
body string

Запрос TentaQl

Возвращаемое значение

response
array of Ordner

Получение абстрактного dossier по GUID

Получение абстрактного dossier по GUID

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Возвращаемое значение

Получение адреса по GUID

Получение адреса по GUID

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Возвращаемое значение

Тело
Adresse

Получение действия по GUID

Получение действия по GUID

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Возвращаемое значение

Тело
Aktivitaet

Получение документа по GUID

Получение документа по GUID

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Возвращаемое значение

Тело
Dokument

Получение контакта по GUID

Получение контакта по GUID

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Возвращаемое значение

Тело
Kontakt

Получение одного dossier по GUID

Получение одного dossier по GUID

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Возвращаемое значение

Тело
Geschaeft

Получение папки по GUID

Получение папки по GUID

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Возвращаемое значение

Тело
Ordner

Получение пользователя по GUID

Получение пользователя по GUID

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Возвращаемое значение

Тело
Person

Скачивание содержимого документа

Скачивание содержимого документа (определенной версии)

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID объекта

Версия
Version integer

Версия документа

Возвращаемое значение

response
binary

Создание адреса

Создание адреса

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Путь к шаблону
Vorlage string

Путь к шаблону объекта

GUID адреса
guid uuid
Версия
version integer
Имя типа
typeName string
Улица
strasse string
Почтовый индекс
plz string
Город
ort string
Неактивное
inaktiv True boolean
Допустимый из - в
gueltigVonBis string
GUID контакта
guid uuid
Имя контактного лица
displayName string
URL-адрес контакта
url string
GUID типа адреса
guid uuid
Имя типа адреса
displayName string
URL-адрес типа адреса
url string
GUID страны
guid uuid
Имя страны
displayName string
URL-адрес страны
url string

Возвращаемое значение

response
uuid

Создание действия

Создание действия

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Путь к шаблону
Vorlage string

Путь к шаблону объекта

GUID действия
guid uuid
Версия
version integer
Имя типа
typeName string
Название
titel True string
Срок
termin string
Дата начала
beginn string
Дата завершения
erledigung string
Состояние
status True string

NochNichtBegonnen, Erfasst, InBearbeitung, Fertig, Abgeschlossen, Abgebrochen

Замечание
bemerkung string
Внешний ключ
schluesselFremdsystem string
Тип действия
aktivitaetstyp string
GUID документа
guid uuid
Имя документа
displayName string
URL-адрес документа
url string
GUID основного действия
guid uuid
Имя основного действия
displayName string
URL-адрес основного действия
url string
Dossier GUID
guid uuid
Dossier Name
displayName string
Url-адрес dossier
url string
Из GUID
guid uuid
Имя
displayName string
Из URL-адреса
url string
Для GUID
guid uuid
Имя
displayName string
Url-адрес
url string
Идентификатор GUID, доступный для ответственного использования
guid uuid
Ответственное имя
displayName string
Url-адрес с ответом
url string

Возвращаемое значение

response
uuid

Создание документа

Создание документа

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Путь к шаблону
Vorlage string

Путь к шаблону объекта

GUID документа
guid uuid
Версия
version integer
Имя типа
typeName string

Имя типа объекта

Название
titel True string
EDocument в процессе
inBearbeitungBei string
Версия
version integer
Имя файла
fileName string
Файл
file string
Задание создателя
creatorJob string
Дата документа
dokumentdatum string
Дата исходящего данных
ausgangsdatum string
Заготовка даты
eingangsdatum string
Author
autor string
Замечание
bemerkung string
Внешний ключ
schluesselFremdsystem string
Декиссия
beschuss True boolean
Доступно декиссия
beschlussvorhanden True boolean
Опубликовано
istPubliziert True boolean
ВИП
vip True boolean
Dossier GUID
guid uuid
Dossier Name
displayName string
Url-адрес dossier
url string
GUID категории
guid uuid
Имя категории
displayName string
URL-адрес категории
url string
GUID папки
guid uuid
Имя папки
displayName string
URL-адрес папки
url string

Возвращаемое значение

response
uuid

Создание контакта

Создание контакта

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Путь к шаблону
Vorlage string

Путь к шаблону объекта

GUID контакта
guid uuid
Номер версии
version integer
Имя типа
typeName string
Внешний ключ
fremdkey string
Частный номер телефона
telefonPrivat string
Номер телефона для бизнеса
telefonGeschaeft string
Организация
organisation string
Номер мобильного телефона
natel string
Дата рождения
geburtsdatum string
Вторичная электронная почта
email2 string
Основной адрес электронной почты
email string
Фамилия
name string
Имя (первое имя)
vorname string
Приветствие
anrede string
EDocument в процессе
inBearbeitungBei string
Версия
version integer
Имя файла
fileName string
Файл
file string
Задание создателя
creatorJob string
Неактивное
inaktiv True boolean
Сотрудник
mitarbeiter True boolean
Дата смерти
todesdatum string
Опубликовано
istPubliziert True boolean
Настройка проверки подлинности Google
googleAuthKonfiguriert True boolean
Disabled
behindert True boolean
Увеличение потребности в уходе
erhoehterBetreuungsbedarf True boolean
Резиденция неизвестна
aufenthaltUnbekannt True boolean
GUID адреса
guid uuid
Имя адреса
displayName string
URL-адрес
url string
GUID участия
guid uuid
Имя участия
displayName string
URL-адрес участия
url string
GUID языка соответствия
guid uuid
Имя языка соответствия
displayName string
URL-адрес языка соответствия
url string
GUID пола
guid uuid
Гендерное имя
displayName string
URL-адрес пола
url string
GUID для домашних городов
guid uuid
Имя родной города
displayName string
Url-адрес родной города
url string
GUID национальностей
guid uuid
Имя национальностей
displayName string
URL-адрес национальностей
url string

Возвращаемое значение

response
uuid

Создание нового dossier

Создание нового dossier

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Путь к шаблону
Vorlage string

Путь к шаблону объекта

Dossier GUID
guid uuid
Версия
version integer
Имя типа
typeName string
Название
titel True string
Управление доступом
zugriffsteuerung True string

Offen, Restriktiv

Конец
ende string
Start
beginn True string
Серийный номер
laufnummer True string
Внешний ключ системы
schluesselFremdsystem string
Состояние жизненного цикла
lifecycleStatus True string

InBearbeitung, Abgeschlossen, Passiv, Angeboten, ZurKassationVorgesehen, Выборка, Abgeliefert, Kassiert, ZurAufbewahrungVorgesehen, Aufbewahrt, ZurKassationFreigegeben, Archiviert, KassiertAufbewahrt

GUID реестра
guid uuid
Имя реестра
displayName string
URL-адрес реестра
url string
Состояние dossier
geschaeftsstatus True string

InBearbeitung, Storniert, Zusammengefuehrt, Abgeschlossen

GUID документа
guid uuid
Имя документа
displayName string
URL-адрес документа
url string
GUID действий
guid uuid
Имя действий
displayName string
URL-адрес действий
url string
GUID обозревателя документов
guid uuid
Имя обозревателя документов
displayName string
URL-адрес обозревателя документов
url string
GUID папки
guid uuid
Имя папки
displayName string
URL-адрес папки
url string
GUID владельца бизнеса
guid uuid
Имя владельца бизнеса
displayName string
URL-адрес владельца бизнеса
url string
Основной dossier GUID
guid uuid
Имя главного досье
displayName string
URL-адрес главного досье
url string
GUID участия
guid uuid
Имя участия
displayName string
URL-адрес участия
url string
Guid заметки
guid uuid
Имя заметки
displayName string
Url-адрес заметки
url string
Guid "Ссылка на"
guid uuid
Имя "Ссылка на"
displayName string
Url-адрес "Ссылка на"
url string
Guid "Reference From" (Ссылка из)
guid uuid
Имя "Ссылка из"
displayName string
Url-адрес "Ссылка из"
url string
Subdossier GUID
guid uuid
Имя поддоссьера
displayName string
URL-адрес subdossier
url string

Возвращаемое значение

response
uuid

Создать папку

Создать папку

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

Путь к шаблону
Vorlage string

Путь к шаблону объекта

GUID папки
guid uuid
Номер версии
version integer
Имя типа
typeName string
Название
titel True string
Родительский GUID
guid uuid
Родительское имя
displayName string
Родительский URL-адрес
url string
Guid дочерних элементов
guid uuid
Имя дочерних элементов
displayName string
URL-адрес дочерних объектов
url string
Dossier GUID
guid uuid
Dossier Name
displayName string
Url-адрес dossier
url string

Возвращаемое значение

response
uuid

Удаление адреса

Удаление адреса

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

Удаление действия

Удаление действия

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

Удаление документа

Удаление документа

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

Удаление досье

Удаление досье

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

Удаление контакта

Удаление контакта

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

Удаление папки

Удаление папки

Параметры

Имя Ключ Обязательно Тип Описание
Клиент CMI
X-CMI-TENANT-NAME True string

Клиент CMI

ГУИД
guid True uuid

GUID из объекта

Определения

AbstrakteAktivitaet

Имя Путь Тип Описание
Guid абстрактного действия
guid uuid
Версия
version integer
Имя типа
typeName string
Название
titel string
Срок
termin string
Дата начала
beginn string
Дата завершения
erledigung string
Состояние
status string

NochNichtBegonnen, Erfasst, InBearbeitung, Fertig, Abgeschlossen, Abgebrochen

Замечание
bemerkung string
Внешний ключ
schluesselFremdsystem string
Тип действия
aktivitaetstyp string
dokumente
dokumente array of object
GUID документа
dokumente.guid uuid
Имя документа
dokumente.displayName string
URL-адрес документа
dokumente.url string
GUID основного действия
ueberaktivitaet.guid uuid
Имя основного действия
ueberaktivitaet.displayName string
URL-адрес основного действия
ueberaktivitaet.url string
Dossier GUID
geschaeft.guid uuid
Dossier Name
geschaeft.displayName string
Url-адрес dossier
geschaeft.url string
Из GUID
von.guid uuid
Имя
von.displayName string
Из URL-адреса
von.url string
Для GUID
an.guid uuid
Имя
an.displayName string
Url-адрес
an.url string
Идентификатор GUID, доступный для ответственного использования
anChoice.guid uuid
Ответственное имя
anChoice.displayName string
Url-адрес с ответом
anChoice.url string

AbstraktesGeschaeft

Имя Путь Тип Описание
гид
guid uuid

Абстрактный GUID Dossier

Версия
version integer
Имя типа
typeName string
Название
titel string
Управление доступом
zugriffsteuerung string

Offen, Restriktiv

Дата начала
beginn string
Дата завершения
ende string
Замечание
bemerkung string
Порядковый номер
laufnummer string
Внешний ключ
schluesselFremdsystem string
Состояние жизненного цикла
lifecycleStatus string

InBearbeitung, Abgeschlossen, Passiv, Angeboten, ZurKassationVorgesehen, Выборка, Abgeliefert, Kassiert, ZurAufbewahrungVorgesehen, Aufbewahrt, ZurKassationFreigegeben, Archiviert, KassiertAufbewahrt

GUID реестра
customRegistraturplan.guid uuid
Имя реестра
customRegistraturplan.displayName string
URL-адрес реестра
customRegistraturplan.url string
GUID владельца бизнеса
geschaeftseigner.guid uuid
Имя владельца бизнеса
geschaeftseigner.displayName string
URL-адрес владельца бизнеса
geschaeftseigner.url string
Основной dossier GUID
hauptDossier.guid uuid
Имя главного досье
hauptDossier.displayName string
URL-адрес главного досье
hauptDossier.url string
dokumente
dokumente array of object
GUID документа
dokumente.guid uuid
Имя документа
dokumente.displayName string
URL-адрес документа
dokumente.url string
beteiligungen
beteiligungen array of object
GUID участия
beteiligungen.guid uuid
Имя участия
beteiligungen.displayName string
URL-адрес участия
beteiligungen.url string
нотизация
notizen array of object
Guid заметки
notizen.guid uuid
Имя заметки
notizen.displayName string
Url-адрес заметки
notizen.url string
verweisZu
verweisZu array of object
Guid "Ссылка на"
verweisZu.guid uuid
Имя "Ссылка на"
verweisZu.displayName string
Url-адрес "Ссылка на"
verweisZu.url string
verweisVon
verweisVon array of object
Guid "Reference From" (Ссылка из)
verweisVon.guid uuid
Имя "Ссылка из"
verweisVon.displayName string
Url-адрес "Ссылка из"
verweisVon.url string
subgeschaeft
subgeschaeft array of object
Subdossier GUID
subgeschaeft.guid uuid
Имя поддоссьера
subgeschaeft.displayName string
URL-адрес subdossier
subgeschaeft.url string

Адрессе

Имя Путь Тип Описание
GUID адреса
guid uuid
Версия
version integer
Имя типа
typeName string
Улица
strasse string
Почтовый индекс
plz string
Город
ort string
Неактивное
inaktiv boolean
Допустимый из - в
gueltigVonBis string
GUID контакта
kontakt.guid uuid
Имя контактного лица
kontakt.displayName string
URL-адрес контакта
kontakt.url string
GUID типа адреса
adressart.guid uuid
Имя типа адреса
adressart.displayName string
URL-адрес типа адреса
adressart.url string
GUID страны
land.guid uuid
Имя страны
land.displayName string
URL-адрес страны
land.url string

Aktivitaet

Имя Путь Тип Описание
GUID действия
guid uuid
Версия
version integer
Имя типа
typeName string
Название
titel string
Срок
termin string
Дата начала
beginn string
Дата завершения
erledigung string
Состояние
status string

NochNichtBegonnen, Erfasst, InBearbeitung, Fertig, Abgeschlossen, Abgebrochen

Замечание
bemerkung string
Внешний ключ
schluesselFremdsystem string
Тип действия
aktivitaetstyp string
dokumente
dokumente array of object
GUID документа
dokumente.guid uuid
Имя документа
dokumente.displayName string
URL-адрес документа
dokumente.url string
GUID основного действия
ueberaktivitaet.guid uuid
Имя основного действия
ueberaktivitaet.displayName string
URL-адрес основного действия
ueberaktivitaet.url string
Dossier GUID
geschaeft.guid uuid
Dossier Name
geschaeft.displayName string
Url-адрес dossier
geschaeft.url string
Из GUID
von.guid uuid
Имя
von.displayName string
Из URL-адреса
von.url string
Для GUID
an.guid uuid
Имя
an.displayName string
Url-адрес
an.url string
Идентификатор GUID, доступный для ответственного использования
anChoice.guid uuid
Ответственное имя
anChoice.displayName string
Url-адрес с ответом
anChoice.url string

Dokument

Имя Путь Тип Описание
GUID документа
guid uuid
Версия
version integer
Имя типа
typeName string

Имя типа объекта

Название
titel string
eDokument
eDokument EDokument
Дата документа
dokumentdatum string
Дата исходящего данных
ausgangsdatum string
Заготовка даты
eingangsdatum string
Author
autor string
Замечание
bemerkung string
Внешний ключ
schluesselFremdsystem string
Декиссия
beschuss boolean
Доступно декиссия
beschlussvorhanden boolean
Опубликовано
istPubliziert boolean
ВИП
vip boolean
Dossier GUID
geschaeft.guid uuid
Dossier Name
geschaeft.displayName string
Url-адрес dossier
geschaeft.url string
GUID категории
kategorie.guid uuid
Имя категории
kategorie.displayName string
URL-адрес категории
kategorie.url string
GUID папки
geschaeftPosteingangExplorer.guid uuid
Имя папки
geschaeftPosteingangExplorer.displayName string
URL-адрес папки
geschaeftPosteingangExplorer.url string

EDokument

Имя Путь Тип Описание
EDocument в процессе
inBearbeitungBei string
Представления
renditions array of Rendition

Geschaeft

Имя Путь Тип Описание
Dossier GUID
guid uuid
Версия
version integer
Имя типа
typeName string
Название
titel string
Управление доступом
zugriffsteuerung string

Offen, Restriktiv

Конец
ende string
Start
beginn string
Серийный номер
laufnummer string
Внешний ключ системы
schluesselFremdsystem string
Состояние жизненного цикла
lifecycleStatus string

InBearbeitung, Abgeschlossen, Passiv, Angeboten, ZurKassationVorgesehen, Выборка, Abgeliefert, Kassiert, ZurAufbewahrungVorgesehen, Aufbewahrt, ZurKassationFreigegeben, Archiviert, KassiertAufbewahrt

GUID реестра
customRegistraturplan.guid uuid
Имя реестра
customRegistraturplan.displayName string
URL-адрес реестра
customRegistraturplan.url string
Состояние dossier
geschaeftsstatus string

InBearbeitung, Storniert, Zusammengefuehrt, Abgeschlossen

dokumente
dokumente array of object
GUID документа
dokumente.guid uuid
Имя документа
dokumente.displayName string
URL-адрес документа
dokumente.url string
aktivitaeten
aktivitaeten array of object
GUID действий
aktivitaeten.guid uuid
Имя действий
aktivitaeten.displayName string
URL-адрес действий
aktivitaeten.url string
dokumenteExplorer
dokumenteExplorer array of object
GUID обозревателя документов
dokumenteExplorer.guid uuid
Имя обозревателя документов
dokumenteExplorer.displayName string
URL-адрес обозревателя документов
dokumenteExplorer.url string
ordner
ordner array of object
GUID папки
ordner.guid uuid
Имя папки
ordner.displayName string
URL-адрес папки
ordner.url string
GUID владельца бизнеса
geschaeftseigner.guid uuid
Имя владельца бизнеса
geschaeftseigner.displayName string
URL-адрес владельца бизнеса
geschaeftseigner.url string
Основной dossier GUID
hauptDossier.guid uuid
Имя главного досье
hauptDossier.displayName string
URL-адрес главного досье
hauptDossier.url string
beteiligungen
beteiligungen array of object
GUID участия
beteiligungen.guid uuid
Имя участия
beteiligungen.displayName string
URL-адрес участия
beteiligungen.url string
нотизация
notizen array of object
Guid заметки
notizen.guid uuid
Имя заметки
notizen.displayName string
Url-адрес заметки
notizen.url string
verweisZu
verweisZu array of object
Guid "Ссылка на"
verweisZu.guid uuid
Имя "Ссылка на"
verweisZu.displayName string
Url-адрес "Ссылка на"
verweisZu.url string
verweisVon
verweisVon array of object
Guid "Reference From" (Ссылка из)
verweisVon.guid uuid
Имя "Ссылка из"
verweisVon.displayName string
Url-адрес "Ссылка из"
verweisVon.url string
subgeschaeft
subgeschaeft array of object
Subdossier GUID
subgeschaeft.guid uuid
Имя поддоссьера
subgeschaeft.displayName string
URL-адрес subdossier
subgeschaeft.url string

Kontakt

Имя Путь Тип Описание
GUID контакта
guid uuid
Номер версии
version integer
Имя типа
typeName string
Внешний ключ
fremdkey string
Частный номер телефона
telefonPrivat string
Номер телефона для бизнеса
telefonGeschaeft string
Организация
organisation string
Номер мобильного телефона
natel string
Дата рождения
geburtsdatum string
Вторичная электронная почта
email2 string
Основной адрес электронной почты
email string
Фамилия
name string
Имя (первое имя)
vorname string
Приветствие
anrede string
foto
foto EDokument
Неактивное
inaktiv boolean
Сотрудник
mitarbeiter boolean
Дата смерти
todesdatum string
Опубликовано
istPubliziert boolean
Настройка проверки подлинности Google
googleAuthKonfiguriert boolean
Disabled
behindert boolean
Увеличение потребности в уходе
erhoehterBetreuungsbedarf boolean
Резиденция неизвестна
aufenthaltUnbekannt boolean
adressen
adressen array of object
GUID адреса
adressen.guid uuid
Имя адреса
adressen.displayName string
URL-адрес
adressen.url string
beteiligungen
beteiligungen array of object
GUID участия
beteiligungen.guid uuid
Имя участия
beteiligungen.displayName string
URL-адрес участия
beteiligungen.url string
GUID языка соответствия
korrespondenzsprache.guid uuid
Имя языка соответствия
korrespondenzsprache.displayName string
URL-адрес языка соответствия
korrespondenzsprache.url string
GUID пола
geschlecht.guid uuid
Гендерное имя
geschlecht.displayName string
URL-адрес пола
geschlecht.url string
heimatorte
heimatorte array of object
GUID для домашних городов
heimatorte.guid uuid
Имя родной города
heimatorte.displayName string
Url-адрес родной города
heimatorte.url string
nationalitaeten
nationalitaeten array of object
GUID национальностей
nationalitaeten.guid uuid
Имя национальностей
nationalitaeten.displayName string
URL-адрес национальностей
nationalitaeten.url string

Орднер

Имя Путь Тип Описание
GUID папки
guid uuid
Номер версии
version integer
Имя типа
typeName string
Название
titel string
Родительский GUID
parent.guid uuid
Родительское имя
parent.displayName string
Родительский URL-адрес
parent.url string
children
children array of object
Guid дочерних элементов
children.guid uuid
Имя дочерних элементов
children.displayName string
URL-адрес дочерних объектов
children.url string
Dossier GUID
geschaeft.guid uuid
Dossier Name
geschaeft.displayName string
Url-адрес dossier
geschaeft.url string

Персона

Имя Путь Тип Описание
Глобальный уникальный идентификатор
guid uuid
Номер версии
version integer
Имя типа
typeName string
Внешний ключ
fremdkey string
Частный телефон
telefonPrivat string
Бизнес-телефон
telefonGeschaeft string
Организация
organisation string
Мобильный телефон
natel string
Дата рождения
geburtsdatum string
Вторичная электронная почта
email2 string
Адрес электронной почты
email string
Фамилия
name string
Имя (первое имя)
vorname string
foto
foto EDokument
Приветствие
anrede string
Неактивное
inaktiv boolean
Сотрудник
mitarbeiter boolean
Опубликовано
istPubliziert boolean
Настроенная проверка подлинности Google
googleAuthKonfiguriert boolean
Имена
vornamen string
adressen
adressen array of object
GUID адреса
adressen.guid uuid
Имя адреса
adressen.displayName string
URL-адрес
adressen.url string
GUID пола
geschlecht.guid uuid
Гендерное имя
geschlecht.displayName string
URL-адрес пола
geschlecht.url string
beteiligungen
beteiligungen array of object
GUID участия
beteiligungen.guid uuid
Имя участия
beteiligungen.displayName string
URL-адрес участия
beteiligungen.url string
GUID языка соответствия
korrespondenzsprache.guid uuid
Имя языка соответствия
korrespondenzsprache.displayName string
URL-адрес языка соответствия
korrespondenzsprache.url string
heimatorte
heimatorte array of object
GUID для домашних городов
heimatorte.guid uuid
Имя родной города
heimatorte.displayName string
Url-адрес родной города
heimatorte.url string
nationalitaeten
nationalitaeten array of object
GUID национальностей
nationalitaeten.guid uuid
Имя национальностей
nationalitaeten.displayName string
URL-адрес национальностей
nationalitaeten.url string
GUID вычисляемого адреса соответствия
computedKorrespondenzadresse.guid uuid
Имя адреса вычисленного соответствия
computedKorrespondenzadresse.displayName string
Url-адрес вычисляемого адреса соответствия
computedKorrespondenzadresse.url string

Перевод

Имя Путь Тип Описание
Версия
version integer
Имя файла
fileName string
Файл
file string
Задание создателя
creatorJob string

UUID (Универсальный уникальный идентификатор)

бинарный

Это базовый тип данных binary.