Диспетчер содержимого Power Connect
Content Manager — это система управления корпоративным контентом, предназначенная для поддержки государственных учреждений, регулируемых отраслей и глобальных организаций, управлять бизнес-контентом от создания до удаления. Подключитесь к Content Manager для выполнения действий, включая создание или обновление записей или расположений, отправку или скачивание электронных файлов, поиск и многое другое. (1.0.4.757)
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Капиш Услуги Pty Ltd |
| URL | https://kapish.com.au/products/power_connect/ |
| Адрес электронной почты | sales@kapish.com.au |
| Метаданные соединителя | |
|---|---|
| Publisher | Капиш Услуги Pty Ltd |
| Веб-сайт | https://kapish.com.au/products/power_connect/ |
| Политика конфиденциальности | https://kapish.com.au/products/privacy-policy/ |
| Категории | Данные; Содержимое и файлы |
Диспетчер содержимого Power Connect by Kapish — это соединитель, который предоставляет функции автоматизации и интеграции в Content Manager, чтобы упростить возможности вашей организации в соответствии с требованиями к управлению информацией и управлению.
Pre-requisites
- Внешний доступ к Content Manager ServiceAPI
- Ключ подписки, предоставляемый Капиш Services Pty Ltd
Подробный список спецификаций и требований или дополнительные сведения о том, как соединитель может помочь вашей организации, обратитесь к Капиш Services Pty Ltd
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| OAuth (конфиденциальный поток клиента) | Подключение к Диспетчеру содержимого с помощью OAuth | Все регионы | Недоступен для совместного использования |
| Управление системой | Использование имени пользователя и пароля для подключения к Content Manager | Все регионы | Недоступен для совместного использования |
| По умолчанию [не рекомендуется] | Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости. | Все регионы | Недоступен для совместного использования |
OAuth (конфиденциальный поток клиента)
Идентификатор проверки подлинности: OAuth
Применимо: все регионы
Подключение к Диспетчеру содержимого с помощью OAuth
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ подписки KPC | securestring | Ключ API для доступа к Капиш Power Connect | True |
| URL-адрес СЛУЖБЫ CMAPI (например, https://myserver/CMServiceAPI/) | струна | URL-адрес, в котором можно достичь cm ServiceAPI | True |
| URL-адрес сервера авторизации (например, https://myserver/adfs/oauth2/token) | струна | URL-адрес для получения маркера доступа | True |
| Идентификатор клиента | струна | Идентификатор клиента для проверки подлинности | True |
| Секрет клиента | securestring | Секрет клиента для проверки подлинности | True |
Управление системой
Идентификатор проверки подлинности: базовый
Применимо: все регионы
Использование имени пользователя и пароля для подключения к Content Manager
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ подписки KPC | securestring | Ключ API для доступа к Капиш Power Connect | True |
| URL-адрес СЛУЖБЫ CMAPI (например, https://myserver/CMServiceAPI/) | струна | URL-адрес, в котором можно достичь cm ServiceAPI | True |
| Имя пользователя | струна | Имя пользователя для проверки подлинности | True |
| Пароль | securestring | Пароль для проверки подлинности | True |
По умолчанию [не рекомендуется]
Применимо: все регионы
Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ подписки KPC | securestring | Ключ API для доступа к Капиш Power Connect | True |
| URL-адрес СЛУЖБЫ CMAPI (например, https://myserver/CMServiceAPI/) | струна | URL-адрес, в котором можно достичь cm ServiceAPI | True |
| URL-адрес сервера авторизации (например, https://myserver/adfs/oauth2/token) | струна | URL-адрес для получения маркера доступа | True |
| Идентификатор клиента | струна | Идентификатор клиента для проверки подлинности | True |
| Секрет клиента | securestring | Секрет клиента для проверки подлинности | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Запись обновления (действия перепланирования) |
Перепланирует все действия, присоединенные к этой записи |
| Запись обновления (представление запроса) |
Позволяет создать запрос на автоматическое отображение записи. |
| Обновление записи (set Assignee) |
Задайте получателю определенное расположение, вернитесь к домой или зарегистрируйтесь в качестве отсутствующих |
| Обновление записи (undispose) |
Отменяет состояние записи (и любое из его содержимого), чтобы он больше не был удален |
| Обновление записи (unfinalise — установка в качестве черновика) |
Обновление окончательной записи до черновика |
| Обновление записи (действие переназначение) |
Переназначает номинированное действие в указанное расположение |
| Обновление записи (добавление элементов управления доступом) |
AddAccessControl |
| Обновление записи (дополнительно) |
Обновление записи с помощью дополнительных свойств |
| Обновление записи (дополнительные поля) |
Обновление дополнительных полей записи |
| Обновление записи (завершение) |
Обновление черновика записи |
| Обновление записи (закрытие) |
Используйте функцию CloseRecord, чтобы закрыть контейнер. Оставьте дату пустой, если вы хотите, чтобы дата закрытия была "сейчас". Так как закрытие записи может потребовать обновления многих содержащихся записей, эта функция фиксирует изменения автоматически. |
| Обновление записи (замена элементов управления доступом) |
SetAccessControl |
| Обновление записи (классификация) |
Обновление классификации записи |
| Обновление записи (отмена проверки) |
Отмените предыдущий возврат электронного документа для этой записи, не учитывая внесенные изменения, так как он был извлечен |
| Обновление записи (повторное открытие) |
Используйте функцию OpenRecord для повторного открытия закрытого контейнера. Так как повторное открытие записи может потребовать обновления многих содержащихся записей, эта функция фиксирует изменения автоматически. |
| Обновление записи (полные действия) |
Выполнение одного или всех действий из-за определенной записи |
| Обновление записи (присоединение действия или процедуры) |
Присоединение действия или процедуры к записи |
| Обновление записи (присоединение контакта) |
Присоединение контакта к записи |
| Обновление записи (присоединение термина Тезауруса) |
Присоединение термина Тезауруса к записи |
| Обновление записи (присоединение электронного файла) |
Присоединение электронного файла к записи |
| Обновление записи (проверка) |
Задайте состояние извлеченной записи |
| Обновление записи (свойства) |
Обновление записи |
| Обновление записи (удаление) |
Удаление записи |
| Обновление записи (удаление всех действий) |
Удаляет все действия, подключенные к указанной записи |
| Обновление записи (удаление расположения из элементов управления доступом) |
RemoveAccessControl |
| Обновление записи (установка метки пользователя) |
Позволяет задать метку пользователя в записи |
| Обновление записи (установка неограниченного доступа или на основе контейнера) |
InheritAccessControl |
| Обновление расположения (человек) |
Обновление расположения пользователя с помощью уникального идентификатора |
| Отправка электронного файла |
Отправка электронного файла, который позже может быть присоединен к записи |
| Поиск записей |
Поиск записей (получение коллекции записей с помощью строки поиска) |
| Поиск записей (дополнительно) |
Поиск записей (получение коллекции записей с помощью строки поиска). Возвращает необработанный ответ ServiceAPI диспетчера содержимого. |
| Поиск записи по идентификатору |
Получение одной записи по уникальному идентификатору или имени |
| Поиск объектов CM |
Поиск объектов CM |
| Поиск расположений |
Поиск расположений (получение коллекции расположений с помощью строки поиска) |
| Поиск расположения по идентификатору |
Получение одного расположения по уникальному идентификатору или имени |
| Поиск уникального идентификатора адреса расположения |
Получение уникального идентификатора дочернего адреса расположения |
| Получение файла из URL-адреса |
Скачивание файла из URL-адреса в промежуточную область с помощью подключаемого модуля API службы CM GetFileFromUrl |
| Расположение обновления (адрес) |
Создание и обновление адреса расположения с помощью уникального идентификатора адреса |
| Расположение обновления (дополнительные поля) |
Обновление дополнительных полей в расположении |
| Расположение обновления (другое) |
Обновление расположения |
| Скачивание электронного файла |
Скачивание электронного файла записи |
| Создание записи (документ) |
Создание записи |
| Создание записи (дополнительно) |
Создание записи с расширенными полями |
| Создание записи (папка) |
Создание записи |
| Создание расположения (person) |
Создание расположения пользователя |
| Создание расположения (другое) |
Создание расположения любого типа |
| Удаление записи |
Удаление записи |
| Чтение данных о событиях |
Преобразование данных события Kapish Dispatch для потребления потока |
Запись обновления (действия перепланирования)
Перепланирует все действия, присоединенные к этой записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Начиная с базовой даты
|
FromBaseDate | date | ||
|
Использование фактических длительности
|
UseActualDurations | boolean | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Запись обновления (представление запроса)
Позволяет создать запрос на автоматическое отображение записи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Тип представления
|
RenditionType | True | string | |
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (set Assignee)
Задайте получателю определенное расположение, вернитесь к домой или зарегистрируйтесь в качестве отсутствующих
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Новый назначаемый
|
NewAssignee | string |
Уникальный идентификатор или адрес электронной почты нового назначаемого |
|
|
Тип Назначаемого
|
AssigneeType | string | ||
|
Срок возврата по дате
|
DueForReturnByDate | date | ||
|
Произошло фактическое изменение времени
|
ActualTimeChangeOccurred | date-time | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (undispose)
Отменяет состояние записи (и любое из его содержимого), чтобы он больше не был удален
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Продолжить ошибку?
|
ContinueOnError | boolean | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (unfinalise — установка в качестве черновика)
Обновление окончательной записи до черновика
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (действие переназначение)
Переназначает номинированное действие в указанное расположение
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Новый назначаемый
|
NewAssignee | True | string |
Уникальный идентификатор или адрес электронной почты нового назначаемого |
|
Действие переназначение
|
RecordActionUri | True | integer | |
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (добавление элементов управления доступом)
AddAccessControl
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Уникальный идентификатор
|
Uri | integer |
Уникальный идентификатор расположения |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (дополнительно)
Обновление записи с помощью дополнительных свойств
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Тип записи
|
RecordRecordType | string | ||
|
Classification
|
RecordClassification | string |
Укажите уникальный идентификатор классификации |
|
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
|
|
Author
|
RecordAuthor | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Номер присоединения
|
RecordAccessionNumber | string | ||
|
Адресат
|
RecordAddressee | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Альтернативный контейнер
|
RecordAlternativeContainer | string | ||
|
Назначенное лицо
|
RecordAssignee | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Уровень достоверности авто классификации
|
RecordAutoClassificationConfidenceLevel | string | ||
|
Автоматическая отрисовка в PDF-файл при сохранении
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Обход элементов управления доступом к типу записи
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Обход сохранения?
|
ByPassSave | boolean |
Значение true, чтобы не сохранить объект. Одним из этих способов является задание одного или нескольких свойств записи записи и возвращение формы записи данных. Форма записи данных будет отражать различные свойства, заданные в исходной записи. |
|
|
Изменение позиции в избранном
|
ChangePositionWithinFavorites | string |
При поиске избранного они будут возвращены в этом порядке, если не используется другой сорт. |
|
|
Изменение позиции в метки пользователя
|
ChangePositionWithinUserLabel | string |
При поиске пользователем UserLabel они будут возвращены в этом порядке, если не используется другой сорт. |
|
|
Вход как
|
CheckinAs | string |
Задайте свойство Source электронного документа. |
|
|
Класс записи
|
RecordClassOfRecord | string | ||
|
Клиент
|
RecordClient | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Запись клиента
|
RecordClientRecord | string | ||
|
Comments
|
comments | string |
Примечания для перехода в заметки записей при отправке документа. |
|
|
Груз
|
RecordConsignment | string | ||
|
Объект consignment
|
RecordConsignmentObject | string | ||
|
Контейнер
|
RecordContainer | string | ||
|
Копирование документа из записи
|
CopyDocumentFromRecord | string |
Укажите уникальный идентификатор записи, из которой нужно скопировать электронный документ для этой записи. |
|
|
Создатель
|
RecordCreator | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Дата создания
|
RecordDateCreated | string | ||
|
Дата выполнения
|
RecordDateDue | string | ||
|
Дата публикации
|
RecordDatePublished | string | ||
|
Дата получения
|
RecordDateReceived | string | ||
|
Editor
|
RecordEditor | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Электронное хранилище документов
|
RecordEStore | string | ||
|
Внешний справочник
|
RecordExternalReference | string | ||
|
Сбой предупреждений?
|
FailOnWarnings | boolean |
Значение true, чтобы не создавать и сохранять объект, если есть предупреждения. |
|
|
Имя файла в папке "Отправка"
|
RecordFilePath | string |
Имя файла, отображаемое в папке "Отправка". |
|
|
Завершение сохранения
|
RecordFinalizeOnSave | boolean | ||
|
Внешний штрихкод
|
RecordForeignBarcode | string | ||
|
Расположение GPS
|
RecordGpsLocation | string | ||
|
Расположение дома
|
RecordHomeLocation | string |
Уникальный идентификатор расположения |
|
|
Домашнее пространство
|
RecordHomeSpace | string | ||
|
Заключен
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Сохранить извлеченную
|
keepBookedOut | boolean |
Значение true, чтобы оставить запись извлеченной после отправки электронного документа. |
|
|
Дата последнего действия
|
RecordLastActionDate | string | ||
|
Длинное число
|
RecordLongNumber | string | ||
|
Сделать активным
|
MakeActive | string |
Отменяет состояние записи (и любого из его содержимого), чтобы она больше неактивна. При обработке содержимого можно указать, должна ли задача остановиться, если возникают сбои. |
|
|
Сделать неактивным
|
MakeInactive | string |
Задает dateInactive для этой записи и любого из его содержимого. При обработке содержимого можно указать, должна ли задача остановиться, если возникают сбои. |
|
|
Создание новой редакции
|
makeNewRevision | boolean |
True, чтобы создать новую редакцию с этим электронным документом false, чтобы заменить текущую редакцию. |
|
|
Дата уничтожения вручную
|
RecordManualDestructionDate | string | ||
|
Запись материи
|
RecordMatterRecord | string | ||
|
Тип носителя
|
RecordMediaType | string | ||
|
Мои комментарии авторизации
|
RecordMyAuthorizationComments | string | ||
|
Моя авторизация завершена
|
RecordMyAuthorizationComplete | boolean | ||
|
Мои комментарии к рецензированием
|
RecordMyReviewComments | string | ||
|
Проверка завершена
|
RecordMyReviewComplete | boolean | ||
|
Требуется авторизация?
|
RecordNeedsAuthorization | boolean | ||
|
Требуется проверка?
|
RecordNeedsReview | boolean | ||
|
Правило создания новых частей
|
RecordNewPartCreationRule | string |
Уникальный идентификатор правила автоматического создания частей |
|
|
Примечания.
|
RecordNotes | string | ||
|
Тип обновления заметок
|
NotesUpdateType | string | ||
|
Другой контакт
|
RecordOtherContact | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Расположение владельца
|
RecordOwnerLocation | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Иерархия хранителя в записи данных?
|
RecordPreserveHierarchyOnDataEntry | boolean | ||
|
Предыдущая запись части
|
RecordPrevPartRecord | string | ||
|
Priority
|
RecordPriority | string | ||
|
Запись нового типа
|
RecordNewType | string |
Оставьте значение по умолчанию, если только не создайте новую версию части или копию. |
|
|
Связанная запись
|
RecordRelatedRecord | string | ||
|
Уполномоченный
|
RecordRepresentative | string | ||
|
Расписание хранения
|
RecordRetentionSchedule | string | ||
|
Дата проверки
|
RecordReviewDate | string | ||
|
Проверка даты выполнения
|
RecordReviewDueDate | string | ||
|
Состояние проверки
|
RecordReviewState | string | ||
|
Безопасность
|
RecordSecurity | string | ||
|
Запись серии
|
RecordSeriesRecord | string | ||
|
Заголовок (часть свободного текста)
|
RecordTypedTitle | string | ||
|
Строка запроса
|
q | string |
Укажите здесь запрос, чтобы применить обновление к набору записей, а не только к одному (как указано в уникальном идентификаторе). |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (дополнительные поля)
Обновление дополнительных полей записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | integer | ||
|
Имя
|
SearchClause | string | ||
|
Ценность
|
Value | string | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (завершение)
Обновление черновика записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Удаление старых редакций
|
SetAsFinalRemoveOldRevisions | boolean | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (закрытие)
Используйте функцию CloseRecord, чтобы закрыть контейнер. Оставьте дату пустой, если вы хотите, чтобы дата закрытия была "сейчас". Так как закрытие записи может потребовать обновления многих содержащихся записей, эта функция фиксирует изменения автоматически.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Продолжить ошибку?
|
ContinueOnError | boolean | ||
|
Заключите содержимое?
|
EncloseContents | boolean | ||
|
Завершение содержимого?
|
FinalizeContents | boolean | ||
|
Только ошибки журнала?
|
LogErrorsOnly | boolean | ||
|
Результаты журнала?
|
LogResults | boolean |
Возвращает текстовый журнал записей, закрытых в свойстве "Сообщение журнала"? |
|
|
Очистка исправлений содержимого?
|
PurgeContentRevisions | boolean | ||
|
Конкретная дата закрытия?
|
SpecificCloseDate | date | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMLogResponse
Обновление записи (замена элементов управления доступом)
SetAccessControl
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Уникальный идентификатор
|
Uri | integer |
Уникальный идентификатор расположения |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (классификация)
Обновление классификации записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Classification
|
RecordClassification | True | string |
Укажите уникальный идентификатор классификации |
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (отмена проверки)
Отмените предыдущий возврат электронного документа для этой записи, не учитывая внесенные изменения, так как он был извлечен
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Comments
|
Comments | string | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (повторное открытие)
Используйте функцию OpenRecord для повторного открытия закрытого контейнера. Так как повторное открытие записи может потребовать обновления многих содержащихся записей, эта функция фиксирует изменения автоматически.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Продолжить ошибку?
|
ContinueOnError | boolean | ||
|
Результаты журнала?
|
LogResults | boolean |
Возвращает текстовый журнал записей, вновь открытых в свойстве "Сообщение журнала"? |
|
|
Неопределенное содержимое?
|
UnfinalizeContents | boolean | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMLogResponse
Обновление записи (полные действия)
Выполнение одного или всех действий из-за определенной записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Завершено
|
Complete | True | string |
Укажите, какие действия записи необходимо выполнить |
|
Выполнение предыдущих действий
|
CompletePrevious | boolean |
Выполните все действия записи до указанного |
|
|
Дата завершения
|
CompletionDate | date |
Дата завершения, заданная в качестве даты завершения |
|
|
Уникальный идентификатор действия записи
|
RecordActionUri | integer |
Уникальный идентификатор действия записи для завершения, если выбран параметр "Для уникального идентификатора" |
|
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (присоединение действия или процедуры)
Присоединение действия или процедуры к записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Действие для присоединения
|
ActionToAttach | True | integer | |
|
Уникальный идентификатор назначаемого получателя
|
NewAssignee | integer | ||
|
Параметр Назначаемого
|
AssigneeOption | string | ||
|
Дата начала расписания
|
ScheduleStartDate | date | ||
|
Существующее действие
|
RecordAction | integer | ||
|
Вставка позиции
|
InsertPos | string | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (присоединение контакта)
Присоединение контакта к записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Тип контакта
|
ContactType | True | string | |
|
Расположение контакта
|
ContactLocation | True | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
Задайте в качестве основного контакта?
|
IsPrimary | True | boolean | |
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (присоединение термина Тезауруса)
Присоединение термина Тезауруса к записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Запись
|
Uri | True | integer |
Уникальный идентификатор записи для присоединения термина Тезаурус к |
|
Термин Тезауруса
|
Keyword | True | string |
Уникальный идентификатор или имя термина Тезаурус для присоединения |
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (присоединение электронного файла)
Присоединение электронного файла к записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Файл
|
File | True | file |
Содержимое файла или текст электронного документа для присоединения |
|
Уникальный идентификатор
|
Uri | True | string |
Уникальный идентификатор записи |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (проверка)
Задайте состояние извлеченной записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Comments
|
Comments | string | ||
|
Сохранить путь к извлечению как
|
SaveCheckoutPathAs | string | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (свойства)
Обновление записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | integer | ||
|
Query
|
q | string |
Укажите здесь запрос, чтобы применить обновление к набору записей, а не только к одному (как указано в уникальном идентификаторе). |
|
|
Заголовок (часть свободного текста)
|
RecordTypedTitle | string | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
|
|
Author
|
RecordAuthor | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Контейнер
|
RecordContainer | string | ||
|
Classification
|
RecordClassification | string |
Укажите уникальный идентификатор классификации |
|
|
Адресат
|
RecordAddressee | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Альтернативный контейнер
|
RecordAlternativeContainer | string | ||
|
Назначенное лицо
|
RecordAssignee | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Автоматическая отрисовка в PDF-файл при сохранении
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Обход элементов управления доступом к типу записи
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Вход как
|
CheckinAs | string |
Задайте свойство Source электронного документа. |
|
|
Клиент
|
RecordClient | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Запись клиента
|
RecordClientRecord | string | ||
|
Копирование документа из записи
|
CopyDocumentFromRecord | string |
Укажите уникальный идентификатор записи, из которой нужно скопировать электронный документ для этой записи. |
|
|
Создатель
|
RecordCreator | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Дата создания
|
RecordDateCreated | string | ||
|
Дата выполнения
|
RecordDateDue | string | ||
|
Дата публикации
|
RecordDatePublished | string | ||
|
Дата получения
|
RecordDateReceived | string | ||
|
Внешний справочник
|
RecordExternalReference | string | ||
|
Сбой предупреждений?
|
FailOnWarnings | boolean |
Значение true, чтобы не создавать и сохранять объект, если есть предупреждения. |
|
|
Имя файла в папке "Отправка"
|
RecordFilePath | string |
Имя файла, отображаемое в папке "Отправка". |
|
|
Завершение сохранения
|
RecordFinalizeOnSave | boolean | ||
|
Внешний штрихкод
|
RecordForeignBarcode | string | ||
|
Расположение GPS
|
RecordGpsLocation | string | ||
|
Расположение дома
|
RecordHomeLocation | string |
Уникальный идентификатор расположения |
|
|
Домашнее пространство
|
RecordHomeSpace | string | ||
|
Заключен
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Сохранить извлеченную
|
keepBookedOut | boolean |
Значение true, чтобы оставить запись извлеченной после отправки электронного документа. |
|
|
Длинное число
|
RecordLongNumber | string | ||
|
Тип носителя
|
RecordMediaType | string | ||
|
Примечания.
|
RecordNotes | string | ||
|
Тип обновления заметок
|
NotesUpdateType | string | ||
|
Другой контакт
|
RecordOtherContact | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Расположение владельца
|
RecordOwnerLocation | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Связанная запись
|
RecordRelatedRecord | string | ||
|
Уполномоченный
|
RecordRepresentative | string | ||
|
Дата проверки
|
RecordReviewDate | string | ||
|
Проверка даты выполнения
|
RecordReviewDueDate | string | ||
|
Состояние проверки
|
RecordReviewState | string | ||
|
Безопасность
|
RecordSecurity | string |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (удаление)
Удаление записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Продолжить ошибку?
|
ContinueOnError | boolean | ||
|
Метод удаления
|
MethodOfDisposal | string | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (удаление всех действий)
Удаляет все действия, подключенные к указанной записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (удаление расположения из элементов управления доступом)
RemoveAccessControl
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Уникальный идентификатор
|
Uri | integer |
Уникальный идентификатор расположения |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (установка метки пользователя)
Позволяет задать метку пользователя в записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Запись
|
Uri | True | integer |
Уникальный идентификатор записи для присоединения метки пользователя к |
|
Метка пользователя
|
UserLabel | True | string |
Уникальный идентификатор или имя метки пользователя для применения |
|
Любимый тип
|
FavouriteType | string | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление записи (установка неограниченного доступа или на основе контейнера)
InheritAccessControl
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Уникальный идентификатор
|
Uri | integer |
Уникальный идентификатор расположения |
Возвращаемое значение
- Тело
- CMRecordsResponse
Обновление расположения (человек)
Обновление расположения пользователя с помощью уникального идентификатора
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | integer | ||
|
Строка запроса
|
q | string |
Укажите здесь запрос, чтобы применить обновление к набору расположений, а не только к одному (как указано в уникальном идентификаторе). |
|
|
Название
|
LocationHonorific | string | ||
|
Фамилия
|
LocationSurname | string | ||
|
Имя (Первое имя)
|
LocationGivenNames | string | ||
|
Внутреннее
|
LocationIsWithin | boolean | ||
|
Должность
|
LocationJobDescription | string | ||
|
Дата рождения
|
LocationDateOfBirth | string | ||
|
Приветствие
|
LocationSalutation | string | ||
|
Уникальное имя
|
LocationNickName | string | ||
|
Номер идентификатора
|
LocationIdNumber | string | ||
|
Рабочий телефон
|
LocationPhoneNumber | string | ||
|
Мобильный телефон
|
LocationMobileNumber | string | ||
|
Факс
|
LocationFaxNumber | string | ||
|
Домашний телефон
|
LocationAfterHoursPhoneNumber | string | ||
|
Тот же адрес, что и адрес
|
LocationUseAddressOf | integer |
Уникальный идентификатор расположения |
|
|
Сделать по умолчанию
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Связанный уникальный идентификатор
|
AddRelationshipRelatedLocation | integer | ||
|
Тип
|
AddRelationshipRelationshipType | string | ||
|
Электронная почта
|
LocationEmailAddress | string | ||
|
Gender
|
LocationGenderValue | string | ||
|
Принятие имен входа
|
LocationCanLogin | boolean | ||
|
Имя входа в сеть
|
LocationLogsInAs | string | ||
|
Дополнительное имя входа в сеть
|
LocationAdditionalLogin | string | ||
|
Срок действия входа истекает
|
LocationLoginExpires | string | ||
|
Профиль пользователя
|
LocationUseProfileOf | integer |
Уникальный идентификатор расположения |
|
|
Тип пользователя
|
LocationUserType | string | ||
|
Строка безопасности
|
LocationSecurityString | string | ||
|
От
|
SetActiveDateRangeValidFromDate | string |
dd/mm/гггг |
|
|
Кому
|
SetActiveDateRangeValidToDate | string |
dd/mm/гггг |
|
|
Примечания.
|
LocationNotes | string | ||
|
Тип обновления заметок
|
NotesUpdateType | string | ||
|
Связанный уникальный идентификатор
|
RemoveRelationshipRelatedLocation | integer |
Возвращаемое значение
- Тело
- CMLocationsResponse
Отправка электронного файла
Отправка электронного файла, который позже может быть присоединен к записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Имя файла
|
RecordFilePath | True | string | |
|
Уникальный идентификатор
|
Uri | True | string |
Поиск записей
Поиск записей (получение коллекции записей с помощью строки поиска)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Query
|
q | True | string |
Поисковый запрос |
|
Свойства
|
properties | True | string |
Разделенный запятыми список свойств, возвращаемых |
Возвращаемое значение
- Тело
- CMRecordsResponse
Поиск записей (дополнительно)
Поиск записей (получение коллекции записей с помощью строки поиска). Возвращает необработанный ответ ServiceAPI диспетчера содержимого.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Query
|
q | True | string |
Поисковый запрос |
|
Свойства
|
properties | True | string |
Разделенный запятыми список свойств, возвращаемых |
Возвращаемое значение
- response
- object
Поиск записи по идентификатору
Получение одной записи по уникальному идентификатору или имени
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Идентификатор
|
Id | True | string |
Уникальный идентификатор объекта или имя |
|
Включение определений свойств
|
IncludePropertyDefs | boolean |
Значение true для возврата массива определений свойств, используемых свойствами в этом ответе |
|
|
Свойства потомка
|
descendantProperties | string |
Разделенный запятыми список свойств объекта применяется только к свойствам объекта этого и нижнего уровня, например RecordNumber,RecordTitle. |
|
|
Свойства
|
properties | string |
Разделенный запятыми список свойств объекта, например RecordNumber,RecordTitle. |
|
|
Наборы свойств
|
propertySets | string |
Один или несколько предварительно определенных наборов свойств, выберите из DataGridVisible, Detailed, FromSearch, All или настраиваемый набор свойств, как определено в конфигурации службы. |
|
|
Значение свойства
|
PropertyValue | string |
Включите необработанное значение, строковое значение или оба в результаты |
|
|
Тип отображения строки
|
stringDisplayType | string |
При возврате строкового значения, которое следует использовать в формате |
Возвращаемое значение
- Тело
- CMRecordsResponse
Поиск объектов CM
Поиск объектов CM
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Искать
|
TrimType | True | string | |
|
Строка запроса
|
q | True | string |
Введите поисковый запрос, например "all", чтобы получить все объекты. |
|
Применение значений по умолчанию
|
ApplyDefaults | boolean |
Значение true, чтобы применить фильтр пользователя по умолчанию и отсортировать его к этому поиску. |
|
|
Подсчет результатов
|
CountResults | boolean |
CountResults возвращает наиболее надежный и самый медленный счетчик общих результатов поиска. Результирующее число находится в свойстве count ответа. |
|
|
Свойства потомка
|
DescendantProperties | string |
Разделенный запятыми список свойств объекта применяется только к свойствам объекта этого и нижнего уровня, например RecordNumber,RecordTitle. |
|
|
Исключить число
|
ExcludeCount | boolean |
Возврат TotalResults и SearchTitle может снизить производительность. Задайте значение true, если TotalResults и SearchTitle не требуются. |
|
|
Filter
|
Filter | string |
Разделенный пробелом список предложений поиска для применения в качестве фильтра. |
|
|
Поиск из
|
FromSearch | integer |
Уникальный идентификатор сохраненного поиска, из которого создается этот поиск. |
|
|
Включение дефекации свойств
|
IncludePropertyDefs | boolean |
Значение true для возврата массива определений свойств, используемых свойствами в этом ответе. |
|
|
Options
|
Options | string |
Задайте один или несколько параметров, которые обычно задаются только в параметрах пользователя для этого поиска. Используйте идентификаторы из /PropertyDef? Служба Get=SearchOptions, добавьте знак минуса, чтобы задать значение false, в противном случае предполагается значение true. |
|
|
Размер страницы
|
pageSize | integer |
Количество элементов, возвращаемых на каждой странице результатов. Если пусто, по умолчанию используется значение по умолчанию, заданное в конфигурации. |
|
|
Значение свойства
|
PropertyValue | string |
Включите необработанное значение, строковое значение или оба в результаты. |
|
|
Наборы свойств
|
PropertySets | string |
Один или несколько предварительно определенных наборов свойств, выберите из DataGridVisible, Detailed, FromSearch, All или настраиваемый набор свойств, как определено в конфигурации службы. |
|
|
Цель
|
purpose | integer |
Специальное свойство для фильтрации результатов поиска на основе значений перечисления объектов. |
|
|
Дополнительное назначение
|
purposeExtra | integer |
Необходимо в качестве дополнения к некоторым целям. Служба ObjectDef предоставляет сведения о перечислении или типе TrimMainObject для указания, в частности ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes и HaveExtraPurposeParameter. |
|
|
Сортировка по
|
sortBy | string |
Разделенный запятыми список идентификаторов предложения поиска. Используется для указания убыванию. Например, |
|
|
Start
|
start | integer |
Позиция в результирующем наборе для запуска, пустого (или 1) начала, 2, начинаемого во втором объекте, 3 в третьем и т. д. |
|
|
StringDisplayType
|
StringDisplayType | string |
При возврате строкового значения, используемого формата. |
|
|
Свойства
|
properties | string |
Разделенный запятыми список свойств объекта, например Uri,NameString |
Возвращаемое значение
- Тело
- CMBobResponse
Поиск расположений
Поиск расположений (получение коллекции расположений с помощью строки поиска)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Query
|
q | True | string |
Введите поисковый запрос, например "all", чтобы получить все объекты. |
|
Применение значений по умолчанию
|
ApplyDefaults | boolean |
Значение true для применения фильтра пользователя по умолчанию и сортировки к этому поиску |
|
|
Подсчет результатов
|
CountResults | boolean |
Значение true для включения количества результатов |
|
|
Исключить число
|
ExcludeCount | boolean |
Значение true, чтобы исключить количество результатов |
|
|
Filter
|
filter | string |
Разделенный пробелом список предложений поиска для применения в качестве фильтра. |
|
|
Поиск из
|
fromSearch | string |
Уникальный идентификатор сохраненного поиска, из которого создается этот поиск. |
|
|
Свойства потомка
|
descendantProperties | string |
Разделенный запятыми список свойств объекта применяется только к свойствам объекта этого и нижнего уровня, например RecordNumber,RecordTitle. |
|
|
Включение определений свойств
|
IncludePropertyDefs | boolean |
Значение true для возврата массива определений свойств, используемых свойствами в этом ответе |
|
|
Options
|
Options | string |
Задайте один или несколько параметров, которые обычно задаются только в параметрах пользователя для этого поиска. Используйте идентификаторы из /PropertyDef? Служба Get=SearchOptions, добавьте знак минуса, чтобы задать значение false, в противном случае предполагается значение true. |
|
|
Свойства
|
properties | string |
Разделенный запятыми список свойств объекта, например RecordNumber,RecordTitle |
|
|
Наборы свойств
|
propertySets | string |
Один или несколько предварительно определенных наборов свойств, выберите из DataGridVisible, Detailed, FromSearch, All или настраиваемый набор свойств, как определено в конфигурации службы. |
|
|
Значение свойства
|
PropertyValue | string |
Включите необработанное значение, строковое значение или оба в результаты |
|
|
Размер страницы
|
pageSize | string |
Количество элементов, возвращаемых на каждой странице результатов |
|
|
Цель
|
purpose | string |
Специальное свойство для фильтрации результатов поиска на основе значений перечисления "Назначение объекта" |
|
|
Дополнительное назначение
|
purposeExtra | string |
Необходимо в качестве дополнения к некоторым целям. Служба ObjectDef предоставляет сведения о перечислении или типе TrimMainObject для указания, в частности ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes и HaveExtraPurposeParameter. |
|
|
Сортировка по
|
sortBy | string |
Разделенный запятыми список идентификаторов предложения поиска |
|
|
Start
|
start | string |
Позиция в результирующем наборе для запуска, пустого (или 1) начала, 2 для запуска второго объекта, 3 в третьем и т. д. |
|
|
Тип отображения строки
|
stringDisplayType | string |
При возврате строкового значения, которое следует использовать в формате |
Возвращаемое значение
- Тело
- CMLocationsResponse
Поиск расположения по идентификатору
Получение одного расположения по уникальному идентификатору или имени
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Id | True | string |
Уникальный идентификатор объекта или имя |
|
Свойства потомка
|
descendantProperties | string |
Разделенный запятыми список свойств объекта применяется только к свойствам объекта этого и нижнего уровня, например "Фамилия", "GivenNames" |
|
|
Включение определений свойств
|
IncludePropertyDefs | boolean |
Значение true для возврата массива определений свойств, используемых свойствами в этом ответе |
|
|
Свойства
|
properties | string |
Разделенный запятыми список свойств объекта, например "Фамилия", "GivenNames" |
|
|
Наборы свойств
|
propertySets | string |
Один или несколько предварительно определенных наборов свойств, выберите из DataGridVisible, Detailed, FromSearch, All или настраиваемый набор свойств, как определено в конфигурации службы. |
|
|
Значение свойства
|
PropertyValue | string |
Включите необработанное значение, строковое значение или оба в результаты |
|
|
Тип отображения строки
|
stringDisplayType | string |
Возвращает строковое значение, формат которого используется |
Возвращаемое значение
- Тело
- CMLocationsResponse
Поиск уникального идентификатора адреса расположения
Получение уникального идентификатора дочернего адреса расположения
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип
|
type | string |
Выбор типа адреса |
|
|
Уникальный идентификатор
|
LocationUri | True | string |
Уникальный идентификатор расположения |
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
Возвращаемое значение
- Дочерний адрес
- CMLocationAddressUri
Получение файла из URL-адреса
Скачивание файла из URL-адреса в промежуточную область с помощью подключаемого модуля API службы CM GetFileFromUrl
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
URL-адрес файла
|
url | True | string |
Незакодированный URL-адрес файла для скачивания |
|
Имя файла для сохранения как
|
filename | string |
Имя файла, чтобы сохранить скачанный URL-адрес как (только имя файла с суффиксом, не включайте полный каталог) |
|
|
Тип контента
|
contentType | string |
Типичная строка, найденная в большинстве заголовков Content-Type (например, image/png, text/plain, application/pdf). |
Возвращаемое значение
Ответ от подключаемого модуля API службы CM GetFileFromUrl.
Расположение обновления (адрес)
Создание и обновление адреса расположения с помощью уникального идентификатора адреса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer |
Универсальный код ресурса (URI) существующего расположения, который необходимо обновить |
|
Уникальный идентификатор
|
Uri | integer |
URI существующего почтового адреса или адреса рассылки, который требуется обновить |
|
|
Тип
|
LocationAddressAddressType | string |
Выберите тип адреса. Ограничение одного типа. |
|
|
Улица
|
LocationAddressAddressLines | string | ||
|
Пригород / Город
|
LocationAddressCity | string | ||
|
Государство
|
LocationAddressState | string | ||
|
Почтовый индекс
|
LocationAddressPostcode | string | ||
|
Страна
|
LocationAddressCountry | string |
Возвращаемое значение
- Тело
- CMLocationsResponse
Расположение обновления (дополнительные поля)
Обновление дополнительных полей в расположении
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | integer | ||
|
Имя
|
SearchClause | string | ||
|
Ценность
|
Value | string |
Возвращаемое значение
- Тело
- CMLocationsResponse
Расположение обновления (другое)
Обновление расположения
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | integer | ||
|
Строка запроса
|
q | string |
Укажите здесь запрос, чтобы применить обновление к набору расположений, а не только к одному (как указано в уникальном идентификаторе). |
|
|
Имя
|
LocationSortName | string | ||
|
Уникальное имя
|
LocationNickName | string | ||
|
Номер идентификатора
|
LocationIdNumber | string | ||
|
Рабочий телефон
|
LocationPhoneNumber | string | ||
|
Мобильный телефон
|
LocationMobileNumber | string | ||
|
Факс
|
LocationFaxNumber | string | ||
|
Домашний телефон
|
LocationAfterHoursPhoneNumber | string | ||
|
Тот же адрес, что и адрес
|
LocationUseAddressOf | integer |
Уникальный идентификатор расположения |
|
|
Сделать по умолчанию
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Связанный уникальный идентификатор
|
AddRelationshipRelatedLocation | integer | ||
|
Тип
|
AddRelationshipRelationshipType | string | ||
|
Электронная почта
|
LocationEmailAddress | string | ||
|
От
|
SetActiveDateRangeValidFromDate | string |
dd/mm/гггг |
|
|
Кому
|
SetActiveDateRangeValidToDate | string |
dd/mm/гггг |
|
|
Примечания.
|
LocationNotes | string | ||
|
Тип обновления заметок
|
NotesUpdateType | string | ||
|
Связанный уникальный идентификатор
|
RemoveRelationshipRelatedLocation | integer |
Возвращаемое значение
- Тело
- CMLocationsResponse
Скачивание электронного файла
Скачивание электронного файла записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор
|
uri | True | string |
Уникальный идентификатор или номер записи |
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
Возвращаемое значение
- response
- binary
Создание записи (документ)
Создание записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Тип записи
|
RecordRecordType | True | string | |
|
Заголовок (часть свободного текста)
|
RecordTypedTitle | True | string | |
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
|
|
Author
|
RecordAuthor | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Адресат
|
RecordAddressee | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Альтернативный контейнер
|
RecordAlternativeContainer | string | ||
|
Назначенное лицо
|
RecordAssignee | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Автоматическая отрисовка в PDF-файл при сохранении
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Обход элементов управления доступом к типу записи
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Вход как
|
CheckinAs | string |
Задайте свойство Source электронного документа. |
|
|
Classification
|
RecordClassification | string |
Укажите уникальный идентификатор классификации |
|
|
Клиент
|
RecordClient | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Запись клиента
|
RecordClientRecord | string | ||
|
Контейнер
|
RecordContainer | string | ||
|
Копирование документа из записи
|
CopyDocumentFromRecord | string |
Укажите уникальный идентификатор записи, из которой нужно скопировать электронный документ для этой записи. |
|
|
Создатель
|
RecordCreator | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Дата создания
|
RecordDateCreated | string | ||
|
Дата выполнения
|
RecordDateDue | string | ||
|
Дата публикации
|
RecordDatePublished | string | ||
|
Дата получения
|
RecordDateReceived | string | ||
|
Внешний справочник
|
RecordExternalReference | string | ||
|
Сбой предупреждений?
|
FailOnWarnings | boolean |
Значение true, чтобы не создавать и сохранять объект, если есть предупреждения. |
|
|
Имя файла в папке "Отправка"
|
RecordFilePath | string |
Имя файла, отображаемое в папке "Отправка". |
|
|
Завершение сохранения
|
RecordFinalizeOnSave | boolean | ||
|
Внешний штрихкод
|
RecordForeignBarcode | string | ||
|
Расположение GPS
|
RecordGpsLocation | string | ||
|
Расположение дома
|
RecordHomeLocation | string |
Уникальный идентификатор расположения |
|
|
Домашнее пространство
|
RecordHomeSpace | string | ||
|
Заключен
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Сохранить извлеченную
|
keepBookedOut | boolean |
Значение true, чтобы оставить запись извлеченной после отправки электронного документа. |
|
|
Дата последнего действия
|
RecordLastActionDate | string | ||
|
Длинное число
|
RecordLongNumber | string | ||
|
Тип носителя
|
RecordMediaType | string | ||
|
Примечания.
|
RecordNotes | string | ||
|
Тип обновления заметок
|
NotesUpdateType | string | ||
|
Другой контакт
|
RecordOtherContact | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Расположение владельца
|
RecordOwnerLocation | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Связанная запись
|
RecordRelatedRecord | string | ||
|
Уполномоченный
|
RecordRepresentative | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Дата проверки
|
RecordReviewDate | string | ||
|
Проверка даты выполнения
|
RecordReviewDueDate | string | ||
|
Состояние проверки
|
RecordReviewState | string | ||
|
Безопасность
|
RecordSecurity | string |
Возвращаемое значение
- Тело
- CMRecordsResponse
Создание записи (дополнительно)
Создание записи с расширенными полями
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Тип записи
|
RecordRecordType | True | string | |
|
Заголовок (часть свободного текста)
|
RecordTypedTitle | True | string | |
|
Classification
|
RecordClassification | string |
Укажите уникальный идентификатор классификации |
|
|
Author
|
RecordAuthor | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
|
|
Номер присоединения
|
RecordAccessionNumber | string | ||
|
Адресат
|
RecordAddressee | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Альтернативный контейнер
|
RecordAlternativeContainer | string | ||
|
Назначенное лицо
|
RecordAssignee | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Уровень достоверности авто классификации
|
RecordAutoClassificationConfidenceLevel | string | ||
|
Автоматическая отрисовка в PDF-файл при сохранении
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Обход элементов управления доступом к типу записи
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Обход сохранения?
|
ByPassSave | boolean |
Значение true, чтобы не сохранить объект. Одним из этих способов является задание одного или нескольких свойств записи записи и возвращение формы записи данных. Форма записи данных будет отражать различные свойства, заданные в исходной записи. |
|
|
Изменение позиции в избранном
|
ChangePositionWithinFavorites | string |
При поиске избранного они будут возвращены в этом порядке, если не используется другой сорт. |
|
|
Изменение позиции в метки пользователя
|
ChangePositionWithinUserLabel | string |
При поиске пользователем UserLabel они будут возвращены в этом порядке, если не используется другой сорт. |
|
|
Вход как
|
CheckinAs | string |
Задайте свойство Source электронного документа. |
|
|
Класс записи
|
RecordClassOfRecord | string | ||
|
Клиент
|
RecordClient | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Запись клиента
|
RecordClientRecord | string | ||
|
Comments
|
comments | string |
Примечания для перехода в заметки записей при отправке документа. |
|
|
Груз
|
RecordConsignment | string | ||
|
Объект consignment
|
RecordConsignmentObject | string | ||
|
Контейнер
|
RecordContainer | string | ||
|
Копирование документа из записи
|
CopyDocumentFromRecord | string |
Укажите уникальный идентификатор записи, из которой нужно скопировать электронный документ для этой записи. |
|
|
Создатель
|
RecordCreator | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Дата создания
|
RecordDateCreated | string | ||
|
Дата выполнения
|
RecordDateDue | string | ||
|
Дата публикации
|
RecordDatePublished | string | ||
|
Дата получения
|
RecordDateReceived | string | ||
|
Editor
|
RecordEditor | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Внешний справочник
|
RecordExternalReference | string | ||
|
Сбой предупреждений?
|
FailOnWarnings | boolean |
Значение true, чтобы не создавать и сохранять объект, если есть предупреждения. |
|
|
Имя файла в папке "Отправка"
|
RecordFilePath | string |
Имя файла, отображаемое в папке "Отправка". |
|
|
Завершение сохранения
|
RecordFinalizeOnSave | boolean | ||
|
Внешний штрихкод
|
RecordForeignBarcode | string | ||
|
Расположение GPS
|
RecordGpsLocation | string | ||
|
Расположение дома
|
RecordHomeLocation | string |
Уникальный идентификатор расположения |
|
|
Домашнее пространство
|
RecordHomeSpace | string | ||
|
Запуск шаблона
|
RecordInitiateTemplate | string | ||
|
Заключен
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Сохранить извлеченную
|
keepBookedOut | boolean |
Значение true, чтобы оставить запись извлеченной после отправки электронного документа. |
|
|
Дата последнего действия
|
RecordLastActionDate | string | ||
|
Длинное число
|
RecordLongNumber | string | ||
|
Сделать активным
|
MakeActive | string |
Отменяет состояние записи (и любого из его содержимого), чтобы она больше неактивна. При обработке содержимого можно указать, должна ли задача остановиться, если возникают сбои. |
|
|
Сделать неактивным
|
MakeInactive | string |
Задает dateInactive для этой записи и любого из его содержимого. При обработке содержимого можно указать, должна ли задача остановиться, если возникают сбои. |
|
|
Создание новой редакции
|
makeNewRevision | boolean |
True, чтобы создать новую редакцию с этим электронным документом false, чтобы заменить текущую редакцию. |
|
|
Дата уничтожения вручную
|
RecordManualDestructionDate | string | ||
|
Запись материи
|
RecordMatterRecord | string | ||
|
Тип носителя
|
RecordMediaType | string | ||
|
Мои комментарии авторизации
|
RecordMyAuthorizationComments | string | ||
|
Моя авторизация завершена
|
RecordMyAuthorizationComplete | boolean | ||
|
Мои комментарии к рецензированием
|
RecordMyReviewComments | string | ||
|
Проверка завершена
|
RecordMyReviewComplete | boolean | ||
|
Требуется авторизация?
|
RecordNeedsAuthorization | boolean | ||
|
Требуется проверка?
|
RecordNeedsReview | boolean | ||
|
Правило создания новых частей
|
RecordNewPartCreationRule | string |
Уникальный идентификатор правила автоматического создания частей |
|
|
Примечания.
|
RecordNotes | string | ||
|
Тип обновления заметок
|
NotesUpdateType | string | ||
|
Другой контакт
|
RecordOtherContact | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Расположение владельца
|
RecordOwnerLocation | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Иерархия хранителя в записи данных?
|
RecordPreserveHierarchyOnDataEntry | boolean | ||
|
Предыдущая запись части
|
RecordPrevPartRecord | string | ||
|
Priority
|
RecordPriority | string | ||
|
Запись нового типа
|
RecordNewType | string |
Оставьте значение по умолчанию, если только не создайте новую версию части или копию. |
|
|
Связанная запись
|
RecordRelatedRecord | string | ||
|
Уполномоченный
|
RecordRepresentative | string | ||
|
Расписание хранения
|
RecordRetentionSchedule | string | ||
|
Дата проверки
|
RecordReviewDate | string | ||
|
Проверка даты выполнения
|
RecordReviewDueDate | string | ||
|
Состояние проверки
|
RecordReviewState | string | ||
|
Безопасность
|
RecordSecurity | string | ||
|
Запись серии
|
RecordSeriesRecord | string | ||
|
Наборы свойств
|
propertySets | string |
Укажите наборы свойств в дополнение к тем, которые будут возвращены запросом. |
|
|
Строка запроса
|
q | string |
Укажите здесь запрос, чтобы применить обновление к набору записей, а не только к одному (как указано в уникальном идентификаторе). |
Возвращаемое значение
- Тело
- CMRecordsResponse
Создание записи (папка)
Создание записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Тип записи
|
RecordRecordType | True | string | |
|
Заголовок (часть свободного текста)
|
RecordTypedTitle | True | string | |
|
Classification
|
RecordClassification | string |
Укажите уникальный идентификатор классификации |
|
|
Контейнер
|
RecordContainer | string | ||
|
Свойства
|
Properties | string |
Список свойств с разделителями-запятыми для возврата |
|
|
Author
|
RecordAuthor | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Адресат
|
RecordAddressee | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Альтернативный контейнер
|
RecordAlternativeContainer | string | ||
|
Назначенное лицо
|
RecordAssignee | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Обход элементов управления доступом к типу записи
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Клиент
|
RecordClient | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Создатель
|
RecordCreator | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Дата создания
|
RecordDateCreated | string | ||
|
Дата выполнения
|
RecordDateDue | string | ||
|
Дата публикации
|
RecordDatePublished | string | ||
|
Внешний справочник
|
RecordExternalReference | string | ||
|
Сбой предупреждений?
|
FailOnWarnings | boolean |
Значение true, чтобы не создавать и сохранять объект, если есть предупреждения. |
|
|
Имя файла в папке "Отправка"
|
RecordFilePath | string |
Имя файла, отображаемое в папке "Отправка". |
|
|
Внешний штрихкод
|
RecordForeignBarcode | string | ||
|
Расположение GPS
|
RecordGpsLocation | string | ||
|
Расположение дома
|
RecordHomeLocation | string |
Уникальный идентификатор расположения |
|
|
Домашнее пространство
|
RecordHomeSpace | string | ||
|
Заключен
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Дата последнего действия
|
RecordLastActionDate | string | ||
|
Длинное число
|
RecordLongNumber | string | ||
|
Примечания.
|
RecordNotes | string | ||
|
Тип обновления заметок
|
NotesUpdateType | string | ||
|
Другой контакт
|
RecordOtherContact | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Расположение владельца
|
RecordOwnerLocation | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Связанная запись
|
RecordRelatedRecord | string | ||
|
Уполномоченный
|
RecordRepresentative | string |
Уникальный идентификатор или адрес электронной почты расположения |
|
|
Дата проверки
|
RecordReviewDate | string | ||
|
Проверка даты выполнения
|
RecordReviewDueDate | string | ||
|
Состояние проверки
|
RecordReviewState | string | ||
|
Безопасность
|
RecordSecurity | string |
Возвращаемое значение
- Тело
- CMRecordsResponse
Создание расположения (person)
Создание расположения пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Название
|
LocationHonorific | string | ||
|
Фамилия
|
LocationSurname | string | ||
|
Имя (Первое имя)
|
LocationGivenNames | string | ||
|
Внутреннее
|
LocationIsWithin | boolean | ||
|
Должность
|
LocationJobDescription | string | ||
|
Дата рождения
|
LocationDateOfBirth | string | ||
|
Приветствие
|
LocationSalutation | string | ||
|
Уникальное имя
|
LocationNickName | string | ||
|
Номер идентификатора
|
LocationIdNumber | string | ||
|
Рабочий телефон
|
LocationPhoneNumber | string | ||
|
Мобильный телефон
|
LocationMobileNumber | string | ||
|
Факс
|
LocationFaxNumber | string | ||
|
Домашний телефон
|
LocationAfterHoursPhoneNumber | string | ||
|
Тот же адрес, что и адрес
|
LocationUseAddressOf | integer |
Уникальный идентификатор расположения |
|
|
Тип адреса
|
LocationAddressAddressType | string |
Выберите тип адреса. Ограничение одного типа. |
|
|
Улица
|
LocationAddressAddressLines | string | ||
|
Пригород / Город
|
LocationAddressCity | string | ||
|
Государство
|
LocationAddressState | string | ||
|
Почтовый индекс
|
LocationAddressPostcode | string | ||
|
Страна
|
LocationAddressCountry | string | ||
|
Сделать по умолчанию
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Связанный уникальный идентификатор
|
AddRelationshipRelatedLocation | integer | ||
|
Тип
|
AddRelationshipRelationshipType | string | ||
|
Электронная почта
|
LocationEmailAddress | string | ||
|
Gender
|
LocationGenderValue | string | ||
|
Принятие имен входа
|
LocationCanLogin | boolean | ||
|
Имя входа в сеть
|
LocationLogsInAs | string | ||
|
Дополнительное имя входа в сеть
|
LocationAdditionalLogin | string | ||
|
Срок действия входа истекает
|
LocationLoginExpires | string | ||
|
Профиль пользователя
|
LocationUseProfileOf | integer |
Уникальный идентификатор расположения |
|
|
Тип пользователя
|
LocationUserType | string | ||
|
Строка безопасности
|
LocationSecurityString | string | ||
|
От
|
SetActiveDateRangeValidFromDate | string |
dd/mm/гггг |
|
|
Кому
|
SetActiveDateRangeValidToDate | string |
dd/mm/гггг |
|
|
Примечания.
|
LocationNotes | string | ||
|
Тип обновления заметок
|
NotesUpdateType | string |
Возвращаемое значение
- Тело
- CMLocationsResponse
Создание расположения (другое)
Создание расположения любого типа
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Тип расположения
|
LocationTypeOfLocation | string | ||
|
Имя
|
LocationSortName | True | string | |
|
Уникальное имя
|
LocationNickName | string | ||
|
Номер идентификатора
|
LocationIdNumber | string | ||
|
Внутреннее
|
LocationIsWithin | boolean | ||
|
Рабочий телефон
|
LocationPhoneNumber | string | ||
|
Мобильный телефон
|
LocationMobileNumber | string | ||
|
Факс
|
LocationFaxNumber | string | ||
|
Домашний телефон
|
LocationAfterHoursPhoneNumber | string | ||
|
Тот же адрес, что и адрес
|
LocationUseAddressOf | integer |
Уникальный идентификатор расположения |
|
|
Тип адреса
|
LocationAddressAddressType | string |
Выберите тип адреса. Ограничение одного типа. |
|
|
Улица
|
LocationAddressAddressLines | string | ||
|
Пригород / Город
|
LocationAddressCity | string | ||
|
Государство
|
LocationAddressState | string | ||
|
Почтовый индекс
|
LocationAddressPostcode | string | ||
|
Страна
|
LocationAddressCountry | string | ||
|
Сделать по умолчанию
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Связанный уникальный идентификатор
|
AddRelationshipRelatedLocation | integer | ||
|
Тип
|
AddRelationshipRelationshipType | string | ||
|
Электронная почта
|
LocationEmailAddress | string | ||
|
От
|
SetActiveDateRangeValidFromDate | string |
dd/mm/гггг |
|
|
Кому
|
SetActiveDateRangeValidToDate | string |
dd/mm/гггг |
|
|
Примечания.
|
LocationNotes | string | ||
|
Тип обновления заметок
|
NotesUpdateType | string |
Возвращаемое значение
- Тело
- CMLocationsResponse
Удаление записи
Удаление записи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользователь для олицетворения
|
userToImpersonate | string |
Имя входа в сеть или альтернативное имя входа расположения в CM для олицетворения |
|
|
Уникальный идентификатор
|
Uri | True | integer |
Уникальный идентификатор записи, который необходимо удалить |
|
Удаление содержимого?
|
DeleteContents | True | boolean | |
|
Новый дом для содержимого
|
NewHomeForContents | string |
Уникальный идентификатор или адрес электронной почты нового расположения дома для содержимого |
Возвращаемое значение
- Тело
- CMRecordsResponse
Чтение данных о событиях
Преобразование данных события Kapish Dispatch для потребления потока
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Content
|
Content | string |
Содержимое действия служебной шины, которое извлекло данные событий CM |
Возвращаемое значение
- Тело
- CMEventData
Определения
CMRecord
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Путь к файлу
|
RecordFilePath | string |
Имя файла, отображаемое в папке "Отправка" |
|
Номер присоединения
|
RecordAccessionNumber | integer | |
|
Адресат
|
RecordAddressee | integer | |
|
Альтернативный контейнер
|
RecordAlternativeContainer | integer | |
|
Назначенное лицо
|
RecordAssignee | integer | |
|
Author
|
RecordAuthor | integer | |
|
Метод авторизации
|
RecordAuthorizationMethod | string | |
|
Уровень достоверности авто классификации
|
RecordAutoClassificationConfidenceLevel | integer | |
|
Автоматическая отрисовка в PDF-файл при сохранении
|
RecordAutoRenderToPDFOnSave | boolean | |
|
Заголовок синей печати
|
RecordBlueprintTitle | string | |
|
Обход элементов управления доступом к типу записи
|
RecordBypassRecordTypeAccessControls | boolean | |
|
Возвращено по
|
RecordCheckedInBy | integer | |
|
Извлечено
|
RecordCheckedOutTo | integer | |
|
Classification
|
RecordClassification | integer | |
|
Класс записи
|
RecordClassOfRecord | string | |
|
Клиент
|
RecordClient | integer | |
|
Запись клиента
|
RecordClientRecord | integer | |
|
Груз
|
RecordConsignment | string | |
|
Объект consignment
|
RecordConsignmentObject | string | |
|
Контейнер
|
RecordContainer | integer | |
|
Создатель
|
RecordCreator | integer | |
|
Текущая версия
|
RecordCurrentVersion | string | |
|
Дата закрыта
|
RecordDateClosed | date-time | |
|
Дата создания
|
RecordDateCreated | date-time | |
|
Дата выполнения
|
RecordDateDue | date-time | |
|
Дата завершения
|
RecordDateFinalized | date-time | |
|
Дата импорта
|
RecordDateImported | date-time | |
|
Неактивная дата
|
RecordDateInactive | date-time | |
|
Дата изменения
|
RecordDateModified | date-time | |
|
Дата публикации
|
RecordDatePublished | date-time | |
|
Дата получения
|
RecordDateReceived | date-time | |
|
Дата регистрации
|
RecordDateRegistered | date-time | |
|
Ожидание присоединения документа
|
RecordDocumentAttachPending | boolean | |
|
Размер документа
|
RecordDocumentSize | integer | |
|
Тип документа
|
RecordDocumentType | string | |
|
Editor
|
RecordEditor | integer | |
|
Электронное хранилище документов
|
RecordEStore | integer | |
|
Расширение документа
|
RecordExtension | string | |
|
Внешний справочник
|
RecordExternalReference | string | |
|
Завершение сохранения
|
RecordFinalizeOnSave | boolean | |
|
Источник папки
|
RecordFolderOrigin | integer | |
|
Внешний штрихкод
|
RecordForeignBarcode | string | |
|
Созданное название
|
RecordGeneratedTitle | string | |
|
Расположение GPS
|
RecordGpsLocation | string | |
|
Расположение дома
|
RecordHomeLocation | integer | |
|
Домашнее пространство
|
RecordHomeSpace | integer | |
|
Запуск шаблона
|
RecordInitiateTemplate | string |
Уникальный идентификатор шаблона рабочего процесса |
|
Заключен
|
RecordIsEnclosed | boolean | |
|
Jurisdiction
|
RecordJurisdictions | string | |
|
Дата последнего действия
|
RecordLastActionDate | date-time | |
|
Последняя запись части
|
RecordLastPartRecord | integer | |
|
Последняя версия
|
RecordLatestVersion | integer | |
|
Развернутое число
|
RecordLongNumber | string | |
|
Номер записи
|
RecordNumber | string | |
|
Дата уничтожения вручную
|
RecordManualDestructionDate | date-time | |
|
Запись материи
|
RecordMatterRecord | integer | |
|
Тип носителя
|
RecordMediaType | string | |
|
Собрание
|
RecordMeeting | integer | |
|
Тип Mime
|
RecordMimeType | string | |
|
Мои комментарии авторизации
|
RecordMyAuthorizationComments | string | |
|
Моя авторизация завершена
|
RecordMyAuthorizationComplete | boolean | |
|
Мои комментарии к рецензированием
|
RecordMyReviewComments | string | |
|
Проверка завершена
|
RecordMyReviewComplete | boolean | |
|
Числовые страницы?
|
RecordNbrPages | integer | |
|
Требуется авторизация?
|
RecordNeedsAuthorization | boolean | |
|
Требуется проверка?
|
RecordNeedsReview | boolean | |
|
Правило создания новых частей
|
RecordNewPartCreationRule | string |
Уникальный идентификатор правила автоматического создания частей |
|
Следующая запись части
|
RecordNextPartRecord | integer | |
|
Тип обновления заметок
|
NotesUpdateType | string | |
|
Примечания.
|
RecordNotes | string | |
|
Исходная из
|
RecordOriginatedFrom | string | |
|
Исходная из запуска
|
RecordOriginatedFromRun | string | |
|
Другой контакт
|
RecordOtherContact | integer | |
|
Расположение владельца
|
RecordOwnerLocation | integer | |
|
Иерархия хранителя в записи данных?
|
RecordPreserveHierarchyOnDataEntry | boolean | |
|
Предыдущая запись части
|
RecordPrevPartRecord | integer | |
|
Основной контакт
|
RecordPrimaryContact | integer | |
|
Priority
|
RecordPriority | string | |
|
Тип записи
|
RecordRecordType | integer | |
|
Связанная запись
|
RecordRelatedRecord | integer | |
|
Уполномоченный
|
RecordRepresentative | integer | |
|
Расписание хранения
|
RecordRetentionSchedule | integer | |
|
Дата проверки
|
RecordReviewDate | date-time | |
|
Проверка даты выполнения
|
RecordReviewDueDate | date-time | |
|
Состояние проверки
|
RecordReviewState | string | |
|
Запись корневой части
|
RecordRootPartRecord | integer | |
|
Безопасность
|
RecordSecurity | string | |
|
Запись серии
|
RecordSeriesRecord | integer | |
|
Название
|
RecordTitle | string | |
|
Заголовок (часть свободного текста)
|
RecordTypedTitle | string | |
|
Уникальный идентификатор
|
Uri | integer | |
|
Дополнительные поля
|
Fields | object |
CMEventData
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Уникальный идентификатор события
|
OnlineEventUri | integer | |
|
Идентификатор типа события
|
EventType | integer | |
|
Тип события
|
EventTypeString | string | |
|
Дата события
|
EventDate | date-time | |
|
Идентификатор типа объекта
|
ObjectType | integer | |
|
Тип объекта
|
ObjectTypeString | string | |
|
Уникальный идентификатор объекта
|
ObjectUri | integer | |
|
Идентификатор связанного типа объекта
|
RelatedObjectType | integer | |
|
Связанный тип объекта
|
RelatedObjectTypeString | string | |
|
Уникальный идентификатор связанного объекта
|
RelatedObjectUri | integer | |
|
С компьютера
|
FromMachine | string | |
|
IP-адрес подключения
|
ConnectionIPAddress | string | |
|
IP-адрес клиента
|
ClientIPAddress | string | |
|
Из часового пояса
|
FromTimeZone | integer | |
|
Имя входа
|
LoginName | string | |
|
Уникальный идентификатор входа
|
LoginUri | integer | |
|
Дополнительные сведения
|
ExtraDetails | string |
CMLogMessage
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Сообщение журнала
|
LogMessage | string | |
|
Искать
|
TrimType | CMTrimType | |
|
Уникальный идентификатор
|
Uri | integer |
CMRecordsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
Results | array of CMRecord | |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Всего результатов
|
TotalResults | integer | |
|
Подсчет строк
|
CountStringEx | string | |
|
Минимальное число
|
MinimumCount | integer | |
|
Численность
|
Count | integer | |
|
Дополнительные элементы
|
HasMoreItems | boolean | |
|
Заголовок поиска
|
SearchTitle | string | |
|
Строка выделения попаданий
|
HitHighlightString | string | |
|
Искать
|
TrimType | CMTrimType | |
|
Состояние ответа
|
ResponseStatus | CMResponseStatus |
Состояние ответа |
CMLogResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
Results | array of CMLogMessage | |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Всего результатов
|
TotalResults | integer | |
|
Подсчет строк
|
CountStringEx | string | |
|
Минимальное число
|
MinimumCount | integer | |
|
Численность
|
Count | integer | |
|
Дополнительные элементы
|
HasMoreItems | boolean | |
|
Заголовок поиска
|
SearchTitle | string | |
|
Строка выделения попаданий
|
HitHighlightString | string | |
|
Искать
|
TrimType | CMTrimType | |
|
Состояние ответа
|
ResponseStatus | CMResponseStatus |
Состояние ответа |
CMUpdateErrorResponse
Обновление ответа об ошибке
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код ошибки
|
ErrorCode | string | |
|
Уникальный идентификатор
|
Uri | integer | |
|
Message
|
Message | string | |
|
Имя
|
Name | string | |
|
Имя (дополнительно)
|
NameExtra | string |
CMResponseStatus
Состояние ответа
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код ошибки
|
ErrorCode | string | |
|
Message
|
Message | string | |
|
StackTrace
|
StackTrace | string | |
|
Errors
|
Errors | array of CMResponseError | |
|
Meta
|
Meta | object |
Строка словаря<, строка> |
CMResponseError
Ошибка ответа
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код ошибки
|
ErrorCode | string | |
|
Имя поля
|
FieldName | string | |
|
Message
|
Message | string | |
|
Meta
|
Meta | object |
Строка словаря<, строка> |
CMTrimType
- Искать
- string
CMLocation
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Уникальный идентификатор
|
Uri | integer | |
|
Имя
|
NameString | string | |
|
Полное форматирование расположения
|
LocationFullFormattedName | string | |
|
Имя сортировки расположения
|
LocationSortName | string |
CMBob
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Уникальный идентификатор
|
Uri | integer | |
|
Имя
|
NameString | string |
CMLocationsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
Results | array of CMLocation |
Results |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Всего результатов
|
TotalResults | integer | |
|
Подсчет строк
|
CountStringEx | string | |
|
Минимальное число
|
MinimumCount | integer | |
|
Численность
|
Count | integer | |
|
Дополнительные элементы
|
HasMoreItems | boolean | |
|
Заголовок поиска
|
SearchTitle | string | |
|
Строка выделения попаданий
|
HitHighlightString | string | |
|
Искать
|
TrimType | CMTrimType | |
|
Состояние ответа
|
ResponseStatus | CMResponseStatus |
Состояние ответа |
CMBobResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Results
|
Results | array of CMBob |
Results |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Всего результатов
|
TotalResults | integer | |
|
Подсчет строк
|
CountStringEx | string | |
|
Минимальное число
|
MinimumCount | integer | |
|
Численность
|
Count | integer | |
|
Дополнительные элементы
|
HasMoreItems | boolean | |
|
Заголовок поиска
|
SearchTitle | string | |
|
Строка выделения попаданий
|
HitHighlightString | string | |
|
Искать
|
TrimType | CMTrimType | |
|
Состояние ответа
|
ResponseStatus | CMResponseStatus |
Состояние ответа |
GetFileFromUrlResponse
Ответ от подключаемого модуля API службы CM GetFileFromUrl.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Filepath
|
Filepath | string |
Локальный путь к файлу, скачанного из URL-адреса. |
|
Message
|
Message | string |
CMLocationAddressUri
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Уникальный идентификатор
|
Uri | integer |
бинарный
Это базовый тип данных binary.
объект
Это тип object.