Руководство пользователя HubEx

Краткие инcтрукции по работе, основные понятия и первые шаги по освоению платформы.

ADM — схемы

Что здесь: определения типов запросов/ответов сервиса ADM. Ручки, ссылающиеся на них — endpoints/ADM.md.

type ActionDataOfShort { data: int[], userTemplateID: int }
type ADDONPackageAddData { addonID?: str, addonUrl?: str, iconUrl?: str, isMobile?: bool, name: str, resourceID?: int, version?: str }
type ADDONPackageAddTenantPackageData { addonID?: str, isMobile?: bool, version?: str }
type ADDONPackagePackageIdentifier { addonID?: str, version?: str }
type ADDONPackageUpdateData { addonID?: str, name: str, version?: str }
type ADMInvitationAddData { allowRegisterWithoutVerification: bool, allowSelfRegistration: bool, description?: str, isForSupport: bool, isPublic: bool, pinCode?: str, requiredSelfRegistration?: bool, userTemplateID?: int, validFrom: datetime, validTill: datetime }
type ADMInvitationUpdateData { allowRegisterWithoutVerification: bool, allowSelfRegistration: bool, description?: str, id: uuid, isForSupport: bool, isPublic: bool, pinCode?: str, requiredSelfRegistration?: bool, userTemplateID?: int, validFrom: datetime, validTill: datetime }
type ADMPermissionUiAddData { allowReadonlyOnly: bool, code: str, description?: str, mustBeAssignedToRole: bool }
type ADMPermissionUiUpdateData { allowReadonlyOnly: bool, code: str, description?: str, id: int, mustBeAssignedToRole: bool }
type ADMRoleAddData { description?: str, name: str }
type ADMRoleAttachmentAddData { attachmentID?: int, roleID?: int }
type ADMRoleAttachmentDeleteData { attachmentID?: int, roleID?: int }
type ADMRoleCopyData { copiedRoleID: int, description?: str, name: str }
type ADMRolePackageAddData { isEnabled?: bool, packageID: str, packageVersion: str }
type ADMRolePermissionApiAddData { data: int[], roleID: int }
type ADMRolePermissionApiDeleteData { data: int[], roleID: int }
type ADMRolePermissionExtAddData { data: int[], roleID: int }
type ADMRolePermissionExtDeleteData { data: int[], roleID: int }
type ADMRolePermissionUiAddData { capabilityID: int, data: int[], roleID: int }
type ADMRolePermissionUiDeleteData { capabilityID: int, data: int[], roleID: int }
type ADMRoleTaskListQueryAddData { data: int[], roleID?: int }
type ADMRoleTaskListQueryDeleteData { data: int[], roleID?: int }
type ADMRoleUpdateData { description?: str, id: int, name: str }
type ADMTenantCreationRequestAddData { accountID: int, companiesCount?: int, licenseID?: int, ownerFirstName?: str, ownerLastName?: str, ownerMiddleName?: str, publicTaskTemplatesCount?: int, techniciansCount?: int, templateID?: int, tenantFullName?: str, tenantName: str, tenantUriName: str }
type ADMTenantCreationRequestRejectData { id: str, reason: str }
type ADMTenantLicenseAddData { dateFrom: datetime, dateTill: datetime, licenseID: int, paymentInfo: ADMTenantLicensePaymentData, quantity?: int }
type ADMTenantLicensePaymentData { bankName: str, bic: str, checkingAccount: str, contactPerson: str, correspondingAccount: str, email?: str, iec: str, lawAddress: str, payer: str, phone?: str, postAddress: str, tin: str }
type ADMTenantLicenseUpdateData { dateFrom: datetime, dateTill: datetime, id: int, licenseID: int, quantity?: int }
type ADMTenantMemberAddData { accountID: int, description?: str, invitationID?: uuid, userID: int, validTill: datetime }
type ADMTenantMemberUpdateData { description?: str, id?: int, validTill: datetime }
type ADMTenantVariableAddData { description?: str, name: str, value: str }
type ADMTenantVariableUpdateData { description?: str, name: str, value: str }
type ADMUserAddData { accountDomainLogin: str, banReasonID?: int, banTill?: datetime, email: str, firstName: str, geotrackingModeID?: int, isCustomer: bool, isEmailVerified: bool, isMobilePhoneVerified: bool, isTeam: bool, isTechnician: bool, lastName: str, middleName?: str, mobilePhone: str, mobilityID?: int, otherPhone?: str, rate?: float, rateCurrencyID?: int, sexID?: int, userTypeID?: int, verificationCodeHash?: str, workPhone?: str }
type ADMUserAssetListQueryAddData { data: int[], userID?: int }
type ADMUserAssetListQueryDeleteData { data: int[], userID?: int }
type ADMUserAttributeAttributeData { attributeID: int, sortOrder: int, value: str }
type ADMUserCompanyListQueryAddData { data: int[], userID?: int }
type ADMUserCompanyListQueryDeleteData { data: int[], userID?: int }
type ADMUserDefaultPagesUserStartPageDto { mobilePage?: str, userID?: int, webPage?: str }
type ADMUserDisabledNotificationMergeData { isOn?: bool, providerID?: int }
type ADMUserDistrictAddData { districtID: int, scheduleRuleID?: int }
type ADMUserDistrictUpdateData { districtID: int, scheduleRuleID?: int }
type ADMUserTaskListQueryAddData { data: int[], userID?: int }
type ADMUserTaskListQueryDeleteData { data: int[], userID?: int }
type ADMUserTemplateAddData { banReasonID?: int, banTill?: datetime, defaultLocationID?: int, description?: str, geoTrackingModeID?: int, isCustomer?: bool, isTeam?: bool, isTechnician?: bool, mobilityID?: int, name: str, userTypeID?: int }
type ADMUserTemplateUpdateData { banReasonID?: int, banTill?: datetime, defaultLocationID?: int, description?: str, geoTrackingModeID?: int, id: int, isCustomer?: bool, isTeam?: bool, isTechnician?: bool, mobilityID?: int, name: str, userTypeID?: int }
type ADMUserUpdateData { accountDomainLogin: str, banReasonID?: int, banTill?: datetime, email: str, firstName: str, geotrackingModeID?: int, isCustomer: bool, isDelegationOn: bool, isEmailVerified: bool, isMobilePhoneVerified: bool, isTeam: bool, isTechnician: bool, lastName: str, middleName?: str, mobilePhone: str, mobilityID?: int, otherPhone?: str, rate?: float, rateCurrencyID?: int, sexID?: int, userTypeID?: int, verificationCodeHash?: str, workPhone?: str }
type ApiEnumsSortDirection enum(Ascending, Descending)
type AspNetCoreResultsAssetResult { deleted?: datetime, host?: IdNameDeletedResultOfInt, id?: int, name?: str, parentID?: int }
type CommonAuxiliaryCoordinate { latitude?: float, longitude?: float }
type CommonResultsPeriodResult { from?: datetime, till?: datetime }
type DataADMRoleTaskAttributeDto { attributeID?: int, isAccessable?: bool, roleID?: int }
type DataADMUserGeolocationDto { coordinateAccuracyID?: int, userID?: int }
type DataAttachmentsFromBodyUploadData { checkSum?: str, contentLength?: int, contentStream?: file, contentType: str, coordinate?: str, description?: str, file: str, fileName: str, isIgnorePossibleDuplication?: bool, isPublic?: bool, md5Hash?: str, roles?: int[], uid?: uuid }
type DataAuxiliaryExportFlagFilter { noData?: bool }
type DataAuxiliaryFlagFilter { isDeleted?: bool, isExternal?: bool, isHidden?: bool, isPublic?: bool, isPublished?: bool, isRead?: bool, isSystem?: bool }
type DataAuxiliaryLocationFilter { pointCenter?: CommonAuxiliaryCoordinate, pointNorthEast?: CommonAuxiliaryCoordinate, pointSouthWest?: CommonAuxiliaryCoordinate, radius?: float }
type DataAuxiliaryRangeData { fetch?: int, offset?: int }
type DataAuxiliarySortData { direction?: ApiEnumsSortDirection, orderBy?: int }
type DataUserDisabledNotificationsPostData { data: ADMUserDisabledNotificationMergeData[] /* Набор данных уведомлений */, userID: int /* Идентификатор пользователя */ }
type DataUserRolesDeleteData { roleIDs: int[] /* Набор идентификаторов ролей */, userID: int /* Идентификатор пользователя */ }
type DataUserRolesPostData { roleIDs: int[] /* Набор идентификаторов ролей */, userID: int /* Идентификатор пользователя */ }
type DataUsersRegisterData { accountDomainLogin?: str /* Логин домена аккаунта пользователя */, email?: str /* Адрес электронной почты */, firstName: str /* Имя */, invitationID: uuid /* Идентификатор приглашения */, lastName: str /* Фамилия */, middleName?: str /* Отчество */, mobilePhone?: str /* Номер мобильного телефона */ }
type DataUsersRegistrationVerifyData { accountID: int /* Идентификатор учетной записи */, tenantID: int /* Идентификатор тенанта */ }
type DataUsersServiceUserResult { tenantMemberID?: int /* Идентификатор члена тенанта */, userID?: int /* Идентификатор пользователя */ }
type DataUserTagsDeleteData { tags: str[] /* Набор тегов */, userID: int /* Идентификатор пользователя */ }
type DataUserTagsPostData { tags: str[] /* Набор тегов */, userID: int /* Идентификатор пользователя */ }
type ESAuxiliaryAssetFilterData { assetClasses?: int[], assetFlags?: ESAuxiliaryAssetFlagFilter, assetText?: ESAuxiliaryAssetTextFilter, assetTypes?: int[], assets?: int[], attributeValues?: JsonLinqJToken, attributes?: int[], checkLists?: int[], companies?: int[], companyRegistrationTypes?: int[], contacts?: int[], contracts?: int[], creationPeriod?: CommonResultsPeriodResult, criticalities?: int[], dateRangePeriod?: CommonResultsPeriodResult, districts?: int[], erpIDs?: str[], eventTransportTypes?: int[], exportFlags?: DataAuxiliaryExportFlagFilter, flags?: DataAuxiliaryFlagFilter, geoViewPort?: DataAuxiliaryLocationFilter, materials?: int[], orgUnits?: int[], parents?: int[], responsiblePersons?: int[], scheduleRules?: int[], skills?: int[], startWithAssets?: int[], systemTags?: int[], tags?: str[], taskTypes?: int[], tasks?: int[], users?: int[], validityOnDates?: datetime[], validityPeriod?: CommonResultsPeriodResult, warehouses?: int[], warrantyPeriod?: CommonResultsPeriodResult, workTypes?: int[] }
type ESAuxiliaryAssetFlagFilter { hasSchema?: bool, isAssigned?: bool, isMobile?: bool }
type ESAuxiliaryAssetTextFilter { name?: str }
type ESAuxiliaryCompanyFilterData { assetClasses?: int[], assetTypes?: int[], assets?: int[], attributeValues?: JsonLinqJToken, attributes?: int[], checkLists?: int[], companies?: int[], companyFlags?: ESAuxiliaryCompanyFlagFilter, companyRegistrationTypes?: int[], contacts?: int[], contracts?: int[], creationPeriod?: CommonResultsPeriodResult, criticalities?: int[], dateRangePeriod?: CommonResultsPeriodResult, districts?: int[], erpIDs?: str[], eventTransportTypes?: int[], exportFlags?: DataAuxiliaryExportFlagFilter, flags?: DataAuxiliaryFlagFilter, geoViewPort?: DataAuxiliaryLocationFilter, materials?: int[], orgUnits?: int[], parents?: int[], scheduleRules?: int[], skills?: int[], startWithAssets?: int[], systemTags?: int[], tags?: str[], taskTypes?: int[], tasks?: int[], users?: int[], validityOnDates?: datetime[], validityPeriod?: CommonResultsPeriodResult, warehouses?: int[], workTypes?: int[] }
type ESAuxiliaryCompanyFlagFilter { isContractorHolder?: bool, isEmployer?: bool, isOurCompany?: bool, isVATTaxpayer?: bool }
type ExceptionHandlingModelsErrorModel { arguments?: map<str>, code?: str, message?: str, traceIdentifier?: str }
type IdCodeNameResultOfByte { code?: str, id?: int, name?: str }
type IdNameDeletedResultOfInt { deleted?: datetime, id?: int, name?: str }
type IdNameDescriptionEntityOfByte { descriptionRu?: str, id?: int, nameRu?: str }
type IdNameDescriptionResultOfByteNullable { description?: str, id?: int, name?: str }
type IdNameDescriptionResultOfShort { description?: str, id?: int, name?: str }
type IdNameErpIDResultOfShort { erpID?: str, id?: int, name?: str }
type IdNameResultOfByte { id?: int, name?: str }
type IdNameResultOfShort { id?: int, name?: str }
type IdNameResultOfShortNullable { id?: int, name?: str }
type InterfacesEntitiesITenantEntity { banReasonID?: int, banTill?: datetime, created?: datetime, deleted?: datetime, deletedBy?: int, fullName?: str, id?: int, isTemplate?: bool, modified?: datetime, modifiedBy?: int, name?: str, powerTenantMemberID?: int, uriName?: str }
type JsonLinqJToken JsonLinqJToken[]
type OperationDataOfAddData { data: ADMUserDistrictAddData[] /* Данные непосредственно участка */, userID: int /* Идентификатор пользователя */ }
type OperationDataOfShort { data: int[] /* Данные непосредственно участка */, userID: int /* Идентификатор пользователя */ }
type OperationDataOfUpdateData { data: ADMUserDistrictUpdateData[] /* Данные непосредственно участка */, userID: int /* Идентификатор пользователя */ }
type ProjectionsADMUserAddProjection { id?: int, isEmailVerified?: bool, isMobilePhoneVerified?: bool, isNewAccount?: bool, isPasswordDefined?: bool, tenantID?: int, tenantMemberID?: int, userID?: int, verificationRequestValidTill?: datetime }
type ProjectionsADMUserRoleAddProjection { roleID?: int, tenantID?: int, userID?: int }
type ResultsBanReasonsListResult { code?: str /* Код */, description?: str /* Описание */, name?: str /* Название */ }
type ResultsCapabilitiesListResult { code?: str /* Код возможности */, name?: str /* Название */, weightCoefficient?: int /* Весовой коэффициент */ }
type ResultsCommonAttachmentResult { contentType?: str /* MIME-тип вложенного файла */, description?: str /* Описание */, fileName?: str /* Название файла (с расширением) */, isUploaded?: bool, publicUrl?: str /* Публичная ссылка на файл (только для опубликованных файлов) */ }
type ResultsCommonBanResult { banReason?: IdNameDescriptionResultOfByteNullable, dateTill?: datetime /* Срок действия бана */ }
type ResultsCommonCurrencyResult { asciiCode?: str /* ASCII код валюты */, id?: int /* Идентификатор */, shortName?: str /* Краткое название */ }
type ResultsCommonDefaultLocationResult { address?: str /* Адрес */, coordinate?: str /* Координаты */, description?: str /* Описание локации */, id?: int /* Идентификатор локации */, timeZone?: IdNameResultOfShortNullable }
type ResultsCoordinateAccuracy { id?: int /* Идентификатор настройки */, isDefault?: bool /* Признак дефолтности настройки */, parametersJson?: str /* Настройки в виде JSON-строки */ }
type ResultsCoordinateAccuracyUserGeolocationSettings { coordinateAccuracy?: ResultsCoordinateAccuracy, tenantID?: int /* Идентификатор тенанта */, userID?: int /* Идентификатор пользователя */ }
type ResultsDefaultPagesAllowedPageResult { code?: str, nameRu?: str, resourceID?: int, resourceNameRu?: str, tenantID?: int, version?: str }
type ResultsInvitationsAddResult { id?: uuid /* Идентификатор приглашения */, tenantID?: int /* Идентификатор тенанта */ }
type ResultsInvitationsGetResult { allowRegisterWithoutVerification?: bool /* Признак разрешения регистрации без верификации */, allowSelfRegistration?: bool /* Флаг, указывающий на разрешение саморегистрации по данному приглашению */, description?: str /* Описание */, id?: uuid /* Идентификатор приглашения */, isForSupport?: bool /* Флаг, указывающий на предназначение приглашения для поддержки */, isPublic?: bool /* Флаг публичности приглашения */, pinCode?: str /* Пин-код */, requiredSelfRegistration?: bool /* Флаг, указывающий на обязательную саморегистрацию по данному приглашению */, tenant?: ResultsTenantsListResult, userTemplate?: IdNameDescriptionResultOfShort, validFrom?: datetime /* Начало периода действия приглашения */, validTill?: datetime /* Окончание периода действия приглашения */ }
type ResultsInvitationsGetShortResult { allowRegisterWithoutVerification?: bool /* Признак разрешения регистрации без верификации */, allowSelfRegistration?: bool /* Флаг, указывающий на разрешение саморегистрации по данному приглашению */, description?: str /* Описание */, id?: uuid /* Идентификатор приглашения */, isPublic?: bool /* Флаг публичности приглашения */, requiredSelfRegistration?: bool /* Флаг, указывающий на обязательную саморегистрацию по данному приглашению */, tenant?: ResultsTenantsListResult, validFrom?: datetime /* Начало периода действия приглашения */, validTill?: datetime /* Окончание периода действия приглашения */ }
type ResultsPermissionsApiListResult { code?: str /* Код полномочия */, description?: str /* Описание полномочия */ }
type ResultsPermissionsApiTagListResult { code?: str /* Код полномочия */, description?: str /* Описание полномочия */, id?: int, name?: str, permissionApiID?: int /* Идентификатор полномочия */ }
type ResultsPermissionsExtListResult { code?: str /* Код полномочия */, description?: str /* Описание полномочия */ }
type ResultsPermissionsExtTagListResult { code?: str /* Код полномочия */, description?: str /* Описание полномочия */, id?: int, name?: str, permissionExtID?: int /* Идентификатор полномочия */ }
type ResultsPermissionsUiGetResult { allowReadonlyOnly?: bool /* Флаг "только для чтения" */, allowRewritableOnly?: bool /* Флаг разрешения полномочия только для чтения и записи */, code?: str /* Код полномочия */, deleted?: datetime /* Дата удаления UI полномочия (null, если не удалено) */, description?: str /* Описание полномочия */, isSystem?: bool /* Флаг системного полномочия */, mustBeAssignedToRole?: bool /* Флаг ассоциации полномочия с ролью */ }
type ResultsPermissionsUiTagListResult { allowReadonlyOnly?: bool /* Флаг "только для чтения" */, allowRewritableOnly?: bool /* Флаг разрешения полномочия только для чтения и записи */, code?: str /* Код полномочия */, description?: str /* Описание полномочия */, id?: int, mustBeAssignedToRole?: bool /* Флаг ассоциации полномочия с ролью */, name?: str, permissionUiID?: int /* Идентификатор полномочия */ }
type ResultsRoleApplicationListResult { applicationCode?: str /* Код приложения */, applicationName?: str /* Название приложения */ }
type ResultsRoleApplicationMergeResult { applicationID?: int /* ID приложения */, roleID?: int /* ID роли */, tenantID?: int /* ID тенанта */ }
type ResultsRoleAttachmentsPostResult { attachmentID?: int /* Идентификатор вложенного файла */, roleID?: int /* Идентификатор роли */ }
type ResultsRolePackagesListResult { isEnabled?: bool /* Флаг что расширение включено у роли */, packageID?: str /* Идентификатор связанного с ролью расширения */, packageName?: str /* Наименование расширения */, packageVersion?: str /* Версия связанного с ролью расширения */, resource?: IdCodeNameResultOfByte }
type ResultsRolePackagesPostResult { id?: int /* Идентификатор расширения роли */, packageID?: str /* Идентификатор расширения */, packageVersion?: str /* Версия расширения */, roleID?: int /* Идентификатор роли */ }
type ResultsRolePermissionsApiListResult { code?: str /* Код связанного с ролью API-полномочия */, description?: str /* Описание связанного с ролью API-полномочия */, isChecked?: bool /* Флаг что полномочие выбрано у роли */, permissionApiID?: int /* Идентификатор API полномочия пользователя */, systemTag?: IdNameResultOfByte }
type ResultsRolePermissionsApiPostResult { permissionApiID?: int /* Идентификатор связанного с ней API-полномочия */, roleID?: int /* Идентификатор роли */ }
type ResultsRolePermissionsExtListResult { code?: str /* Код связанного с ролью EXT-полномочия */, description?: str /* Описание связанного с ролью EXT-полномочия */, isChecked?: bool /* Флаг что полномочие выбрано у роли */, permissionExtID?: int /* Идентификатор расширенного полномочия пользователя */, systemTag?: IdNameResultOfByte }
type ResultsRolePermissionsExtPostResult { permissionExtID?: int /* Идентификатор связанного с ней Ext-полномочия */, roleID?: int /* Идентификатор роли */ }
type ResultsRolePermissionsUiListResult { allowReadonlyOnly?: bool /* Флаг разрешения полномочия только для чтения */, allowRewritableOnly?: bool /* Флаг разрешения полномочия только для чтения и записи */, capabilityID?: int /* Идентификатор возможности для UI-полномочия роли */, code?: str /* Код связанного с ролью UI-полномочия */, description?: str /* Описание связанного с ролью UI-полномочия */, isChecked?: bool /* Флаг что полномочие выбрано у роли */, isSystem?: bool /* Флаг системного полномочия */, mustBeAssignedToRole?: bool /* Флаг обязательности связи с ролью */, permissionUiID?: int /* Идентификатор UI полномочия пользователя */, systemTag?: IdNameResultOfByte }
type ResultsRolePermissionsUiPostResult { permissionUiID?: int /* Идентификатор связанного с ней UI-полномочия */, roleID?: int /* Идентификатор роли */ }
type ResultsRolesGetResult { deleted?: datetime /* Дата удаления роли (null, если не удалено) */, description?: str /* Описание роли */, id?: int /* Идентификатор роли */, name?: str /* Имя роли */, systemRoles?: IdNameResultOfShort[] /* Системные роли */ }
type ResultsRoleTaskAttributeRoleTaskAttributeSettings { attributeID?: int /* Идентификатор атрибута */, isAccessable?: bool /* Признак доступности атрибута для роли */, isDefault?: bool /* Признак наличия кастомной записи по доступности атрибута для роли */, roleID?: int /* Идентификатор роли */ }
type ResultsRoleTaskListQueriesPostResult { roleID?: int /* Идентификатор роли */, taskListQueryID?: int /* Идентификатор сохраненного запроса */ }
type ResultsSkillsSkillResult { dateFrom?: datetime /* Дата начала действия навыка */, dateTill?: datetime /* Дата окончания действия навыка */, id?: int, name?: str }
type ResultsTenantCreationRequestsGetResult { approved?: datetime /* Метка времени, когда запрос был утвержден */, created?: datetime /* Метка времени, когда запрос был создан */, id?: str, processed?: datetime /* Метка времени, когда запрос был обработан */, rejected?: datetime /* Метка времени, когда запрос был отклонен */, rejectionReason?: str /* Причина отклонения запроса */, tenant?: IdNameResultOfShort }
type ResultsTenantCreationRequestsPostResult { id?: str /* Идентификатор только что созданного запроса */ }
type ResultsTenantLicenseLicenseResult { code?: str /* Код лицензии */, description?: str, id?: int, name?: str }
type ResultsTenantLicenseListTenantLicenseResult { dateFrom?: datetime /* Действие лицензии с */, dateTill?: datetime /* Действие лицензии до */, license?: ResultsTenantLicenseLicenseResult, remainig?: ResultsTenantLicenseTotalCountTenantLicenseResult, status?: IdNameResultOfByte, total?: ResultsTenantLicenseTotalCountTenantLicenseResult, trialPeriodDays?: int /* Количество дней триального периода */, type?: IdNameResultOfByte }
type ResultsTenantLicenseTotalCountTenantLicenseResult { companiesCount?: int /* Количество компаний */, publicTaskTemplatesCount?: int /* Количество публичных шаблонов задач */, techniciansCount?: int /* Количество технических специалистов */ }
type ResultsTenantMembersAccountResult { ban?: ResultsCommonBanResult, email?: str /* Адрес эл.почты, используемый для входа в систему */, id?: int /* Идентификатор */, login?: str /* Логин, используемый для входа в систему */, mobilePhone?: str /* Номер телефона, используемый для входа в систему */ }
type ResultsTenantMembersGetResult { accountID?: int /* Идентификатор учетной записи */, description?: str /* Описание */, id?: int /* Идентификатор члена тенанта */, userID?: int /* Идентификатор пользователя */, validTill?: datetime /* Срок действия */ }
type ResultsTenantMembersListResult { account?: ResultsTenantMembersAccountResult, description?: str /* Описание */, id?: int /* Идентификатор члена тенанта */, tokens?: ResultsTenantMembersTenantMemberTokensResult, user?: ResultsTenantMembersUserResult, validTill?: datetime /* Срок действия */ }
type ResultsTenantMembersTenantMemberTokensResult { oneTimeLoginToken?: ResultsTenantMembersTokenResult, refreshToken?: ResultsTenantMembersTokenResult, serviceToken?: ResultsTenantMembersTokenResult }
type ResultsTenantMembersTokenResult { created?: datetime /* Дата создания токена */, validTill?: datetime /* Срок действия токена */ }
type ResultsTenantMembersUserResult { ban?: ResultsCommonBanResult, firstName?: str /* Имя */, id?: int /* Идентификатор пользователя */, lastName?: str /* Фамилия */, middleName?: str /* Отчество */ }
type ResultsTenantPackagesListResult { package?: ResultsTenantPackagesPackageResult, resource?: IdNameResultOfByte }
type ResultsTenantPackagesPackageResult { iconUrl?: str /* URL-адрес изображения для иконки */, id?: str, isAddAuthorizeParameters?: bool, name?: str, version?: str /* Версия расширения */ }
type ResultsTenantSettingsGetResult { defaultCurrency?: ResultsCommonCurrencyResult, defaultMailBoxID?: int /* Идентификатор почты по умолчанию */, defaultTimezoneID?: int /* Идентификатор часового пояса тенанта */, geoDataRetentionMonths?: int /* Срок хранения геоданных пользователя в месяцах */, realm?: str /* Realm тенанта */, storageApiUrl?: str /* URL API хранилища файлов */, storageProviderID?: int /* Идентификатор типа хранилища */, storageUrl?: str /* URL хранилища файлов */, supportEmail?: str /* Адрес электронной почты поддержки тенанта */, supportPhone?: str /* Номер телефона поддержки тенанта */ }
type ResultsTenantsGetResult { fullName?: str /* Полное название тенанта */, id?: int, name?: str, owner?: ResultsTenantsTenantOwnerResult, paymentInfo?: ResultsTenantsPaymentResult, uriName?: str /* Uri тенанта */ }
type ResultsTenantsListResult { banned?: ResultsCommonBanResult, fullName?: str /* Полное название тенанта */, id?: int, isCurrent?: bool /* Является ли тенант текущим для пользователя */, name?: str, owner?: ResultsTenantsTenantMemberResult, tenantMembers?: ResultsTenantsTenantMemberResult[] /* Учетные записи в тенанте */, uriName?: str /* Uri тенанта */ }
type ResultsTenantsPaymentResult { bankName?: str /* Банк */, bic?: str /* БИК (Банковский Идентификационный Код) */, checkingAccount?: str /* Расчётный счёт */, contactPerson?: str /* Контактное лицо */, correspondingAccount?: str /* Корреспондентский счёт */, email?: str /* Email */, iec?: str /* КПП (Код Постановки на Учет) */, lawAddress?: str /* Юридический адрес */, payer?: str /* Плательщик */, phone?: str /* Телефон */, postAddress?: str /* Почтовый адрес */, tin?: str /* ИНН (Идентификационный Номер Налогоплательщика) */ }
type ResultsTenantsTenantMemberResult { accountID?: int /* Идентификатор учетной записи */, description?: str /* Описание */, firstName?: str /* Имя */, id?: int, lastName?: str /* Фамилия */, middleName?: str /* Отчество */ }
type ResultsTenantsTenantOwnerResult { accountID?: int /* Идентификатор учетной записи */, email?: str /* Почтовый адрес */, firstName?: str /* Имя */, lastName?: str /* Фамилия */, middleName?: str /* Отчество */, mobilePhone?: str /* Номер телефона */, tenantMemberID?: int /* Идентификатор владельца тенанта */, userID?: int /* Идентификатор пользователя */ }
type ResultsTenantVariablesListResult { description?: str /* Описание переменной окружения тенанта */, value?: str /* Значение переменной окружения тенанта */ }
type ResultsUserAssetListQueriesPostResult { assetListQueryID?: int /* Идентификатор сохраненного запроса */, userID?: int /* Идентификатор пользователя */ }
type ResultsUserAttributeDomainResult { code?: str, id?: int /* Внутренний идентификатор домена */, name?: str /* Описание для UI домена */ }
type ResultsUserAttributeUserAttributesResult { attributeID?: int /* Идентификатор атрибута */, attributeName?: str /* Наименование атрибута */, domain?: ResultsUserAttributeDomainResult, isExistsUserAttribute?: bool /* Является ли атрибут привязанным к пользователю */, listOfValues?: map<str> /* Список допустимых значений атрибута */, sortOrder?: int /* Порядковый номер для сортировки */, tenantID?: int /* Идентификатор Тенанта */, userID?: int /* Идентификатор пользователя */, value?: str /* Значение атрибута */ }
type ResultsUserCompanyListQueriesPostResult { companyListQueryID?: int /* Идентификатор сохраненного запроса */, userID?: int /* Идентификатор пользователя */ }
type ResultsUserDefaultPagesGetResult { mobilePage?: str /* Строка стартовой страницы для МП */, mobilePageNameRu?: str /* Название стартовой страницы МП на русском (из БД, `DefaultPageMobileNameRu`) */, tenantID?: int /* Идентификатор тенанта */, userID?: int /* Идентификатор пользователя */, webPage?: str /* Строка стартовой страницы для Web */, webPageNameRu?: str /* Название web-стартовой страницы на русском (из БД, `DefaultPageWebNameRu`) */ }
type ResultsUserDisabledNotificationsListResult { email?: str /* Адрес электронной почты */, mobilePhone?: str /* Номер мобильного телефона */, providers?: ResultsUserDisabledNotificationsProviderResult[] /* Провайдеры уведомлений */ }
type ResultsUserDisabledNotificationsMergeResult { isOn?: bool /* Флаг включения */, providerID?: int /* Идентификатор провайдера */ }
type ResultsUserDisabledNotificationsProviderResult { code?: str /* Код провайдера */, id?: int /* Идентификатор провайдера */, isAvailableForUser?: bool /* Флаг применимости провайдера для пользователя */, isOn?: bool /* Флаг включения */, name?: str /* Наименование провайдера */ }
type ResultsUserOrderByListResult { code?: str /* Код способа сортировки заявок */, name?: str /* Название способа сортировки заявок */ }
type ResultsUsersActualLocationResult { actuality?: datetime /* Актуальность */, coordinate?: str /* Координаты */, timeZone?: IdNameResultOfShortNullable }
type ResultsUsersAssetAssignmentResult { asset?: AspNetCoreResultsAssetResult, notes?: str /* Примечания */, validityPeriod?: CommonResultsPeriodResult }
type ResultsUsersAssetListQueryResult { filter?: ESAuxiliaryAssetFilterData, name?: str /* Название */, queryString?: str /* Query-сегмент Uri-строка запроса списка заявок по сохраненному фильтру */, range?: DataAuxiliaryRangeData, searchText?: str /* Текст поиска */, sort?: DataAuxiliarySortData }
type ResultsUsersCompanyListQueryResult { filter?: ESAuxiliaryCompanyFilterData, name?: str /* Название */, queryString?: str /* Query-сегмент Uri-cтрока запроса списка компаний по сохраненному фильтру */, range?: DataAuxiliaryRangeData, searchText?: str /* Текст поиска */, sort?: DataAuxiliarySortData }
type ResultsUsersDetailedInfoResult { accountDomainLogin?: str /* Доменный логин аккаунта пользователя */, actualLocation?: ResultsUsersActualLocationResult, avatarUrl?: str /* Url-к аватарке пользователя */, ban?: ResultsCommonBanResult, defaultLocation?: ResultsCommonDefaultLocationResult, email?: str /* Адрес электронной почты */, firstName?: str /* Имя */, flags?: map<bool> /* Флаги пользователя */, geoTrackingMode?: IdNameResultOfByte, isCustomer?: bool /* Признак клиента */, isEmailVerified?: bool /* Признак верифицированного адреса электронной почты */, isMobilePhoneVerified?: bool /* Признак верифицированного номера мобильного телефона */, isTeam?: bool /* Признак бригады */, isTechnician?: bool /* Признак полевого инженера */, lastName?: str /* Фамилия */, lastSeen?: datetime /* Метка времени последнего запроса на API */, middleName?: str /* Отчество */, mobilePhone?: str /* Номер мобильного телефона */, mobility?: IdNameResultOfByte, otherPhone?: str /* Прочий номер телефона */, rate?: float /* Ставка сотрудника в час */, rateCurrency?: ResultsCommonCurrencyResult, rating?: ResultsUsersRatingResult, sex?: IdNameResultOfByte, teamLeader?: ResultsUsersTeamLeaderResult, teamUserID?: int /* Идентификатор пользователя, как бригады */, workPhone?: str /* Номер рабочего телефона */ }
type ResultsUsersEmploymentResult { company?: IdNameResultOfShort, orgUnit?: ResultsUsersOrgUnitResult, position?: str /* Название должности */, scheduleRuleID?: int /* Идентификатор правила графика рабочего времени */ }
type ResultsUsersEmploymentShortResult { company?: str /* Название компании */, position?: str /* Название должности */, scheduleRuleID?: int /* Идентификатор правила графика рабочего времени */ }
type ResultsUsersEmploymentUserProfileResult { company?: IdNameResultOfShort, dateFrom?: datetime /* Дата начала периода */, dateTill?: datetime /* Дата окончания периода */, orgUnit?: ResultsUsersOrgUnitResult, position?: str /* Название должности */, scheduleRuleID?: int /* Идентификатор правила графика рабочего времени */ }
type ResultsUsersMarkRatingResult { countOfTotal?: float /* Количество текущей оценки от общего количества оценок */, direction?: int /* Показатель роста оценки */, markNumber?: int /* Оценка по рейтингу */ }
type ResultsUsersOrgUnitResult { id?: int, name?: str, parentID?: int /* Идентификатор родительского подразделения */ }
type ResultsUsersRatingListResult { averageRating?: float /* Среднее значение по критерию рейтинга */, id?: int /* ID критерия рейтинга */, name?: str /* Название критерия рейтинга */, rating?: ResultsUsersMarkRatingResult[] /* Данные по рейтингу */ }
type ResultsUsersRatingResult { timestamp?: datetime /* Метка времени рейтинга */, total?: float /* Общий рейтинг */, totalTrendDirection?: float /* Направление тренда рейтинга */ }
type ResultsUsersRatingTechnicianResult { averageRating?: float /* Средний общий рейтинг инженера */, maxMark?: int /* Максимально возможная оценка рейтинга */, ratingCriterias?: ResultsUsersRatingListResult[] /* Данные по критериям рейтинга */, technicianID?: int /* ID инженера */ }
type ResultsUsersSelfRegisterResult { accountID?: int /* Идентификатор учетной записи */, tenantID?: int /* Идентификатор тенанта */, userID?: int /* Идентификатор пользователя */, verificationCodeRepeatTimeout?: int /* Время в секундах по таймауту для повторной отправки верификационного сообщения */ }
type ResultsUsersTaskListQueryResult { filter?: WORKAuxiliaryTaskFilterData, isUserQuery?: bool, name?: str /* Название */, queryString?: str /* Query-сегмент Uri-строка запроса списка заявок по сохраненному фильтру */, range?: DataAuxiliaryRangeData, searchText?: str /* Текст поиска */, sort?: DataAuxiliarySortData }
type ResultsUsersTeamLeaderResult { leadFirstName?: str /* Имя бригадира */, leadID?: int /* Идентификатор бригадира */, leadLastName?: str /* Фамилия бригадира */, leadMiddleName?: str /* Отчество бригадира */ }
type ResultsUsersUserProfileResult { avatarUrl?: str /* Url-к аватарке пользователя */, averageRating?: float /* Средний рейтинг сотрудника */, email?: str /* Адрес электронной почты */, employments?: ResultsUsersEmploymentUserProfileResult[] /* Данные о трудоустройстве пользователя */, firstName?: str /* Имя */, geoTrackingMode?: IdNameResultOfByte, isCustomer?: bool /* Признак клиента */, isDelegationOn?: bool /* Флаг активации делегирования */, isEmailVerified?: bool /* Признак верифицированного адреса электронной почты */, isMobilePhoneVerified?: bool /* Признак верифицированного номера мобильного телефона */, isTeam?: bool /* Признак бригады */, isTechnician?: bool /* Признак полевого инженера */, lastName?: str /* Фамилия */, middleName?: str /* Отчество */, mobilePhone?: str /* Номер мобильного телефона */, otherPhone?: str /* Прочий номер телефона */, sex?: IdNameResultOfByte, userID?: int /* Идентификатор пользователя */, workPhone?: str /* Номер рабочего телефона */ }
type ResultsUsersUserRelevance { district?: int /* Релевантность по участку */, onShift?: int /* Релевантность по нахождению на смене */, responsibility?: int /* Релевантность по ответственности */, skill?: int /* Релевантность по навыкам */, workType?: int /* Релевантность по виду работ */ }
type ResultsUsersUserResult { avatarUrl?: str /* Url-к аватарке пользователя */, banTill?: datetime /* Срок блокировки пользователя */, coordinate?: str /* Актуальная координата сотрудника */, deleted?: datetime /* Метка времени удаления пользователя (UTC) */, districts?: IdNameResultOfShort[] /* Список участков пользователя (без иерархии) */, email?: str /* Адрес электронной почты */, employments?: ResultsUsersEmploymentResult[] /* Занятость сотрудника */, firstName?: str /* Имя */, isCustomer?: bool /* Признак клиента */, isEmailVerified?: bool /* Признак верифицированного адреса электронной почты */, isMobilePhoneVerified?: bool /* Признак верифицированного номера мобильного телефона */, isTeam?: bool /* Признак бригады */, isTechnician?: bool /* Признак полевого инженера */, lastName?: str /* Фамилия */, lastSeen?: datetime /* Метка времени последнего запроса на API */, locationActuality?: datetime /* Актуальность координаты */, middleName?: str /* Отчество */, mobilePhone?: str /* Номер мобильного телефона */, otherPhone?: str /* Прочий номер телефона */, rate?: float /* Ставка сотрудника в час */, rateCurrency?: ResultsCommonCurrencyResult, relevance?: ResultsUsersUserRelevance, sortOrder?: int /* Индекс сортировки */, taskActualities?: map<ResultsUsersUserTaskActualityResult> /* Актуальности заявок, назначенных на сотрудников */, totalRating?: float /* Рейтинг сотрудника */, userID?: int /* Идентификатор пользователя */, workPhone?: str /* Номер рабочего телефона */ }
type ResultsUsersUserShortResult { avatarUrl?: str /* Url-к аватарке пользователя */, deleted?: datetime /* Метка времени удаления пользователя (UTC) */, email?: str /* Адрес электронной почты */, employments?: ResultsUsersEmploymentShortResult[] /* Занятость сотрудника */, firstName?: str /* Имя */, isCustomer?: bool /* Признак клиента */, isEmailVerified?: bool /* Признак верифицированного адреса электронной почты */, isMobilePhoneVerified?: bool /* Признак верифицированного номера мобильного телефона */, isTeam?: bool /* Признак бригады */, isTechnician?: bool /* Признак полевого инженера */, lastName?: str /* Фамилия */, lastSeen?: datetime /* Метка времени последнего запроса на API */, middleName?: str /* Отчество */, mobilePhone?: str /* Номер мобильного телефона */, otherPhone?: str /* Прочий номер телефона */, rate?: float /* Ставка сотрудника в час */, rateCurrency?: ResultsCommonCurrencyResult, sortOrder?: int /* Индекс сортировки */, userID?: int /* Идентификатор пользователя */, workPhone?: str /* Номер рабочего телефона */ }
type ResultsUsersUserTaskActualityResult { assigned?: int /* Количество назначенных заявок */, requested?: int /* Количество поданных заявок */ }
type ResultsUserTagAddResult { tag?: str /* Тег */, userID?: int /* Идентификатор пользователя */ }
type ResultsUserTaskListQueriesPostResult { taskListQueryID?: int /* Идентификатор сохраненного запроса */, userID?: int /* Идентификатор пользователя */ }
type ResultsUserTemplatesGetResult { banned?: ResultsCommonBanResult, defaultLocation?: ResultsCommonDefaultLocationResult, description?: str /* Описание шаблона */, geoTrackingMode?: IdNameResultOfByte, id?: int /* Идентификатор шаблона пользователя */, isCustomer?: bool /* Признак клиента */, isTeam?: bool /* Признак бригады */, isTechnician?: bool /* Признак полевого инженера */, mobility?: IdNameResultOfByte, name?: str /* Наименование шаблона */ }
type ResultsUserTemplatesListResult { banned?: ResultsCommonBanResult, defaultLocationID?: int /* Идентификатор локации по умолчанию */, description?: str /* Описание шаблона */, districts?: IdNameResultOfShort[] /* Список участков, назначенных шаблонному пользователю */, geoTrackingModeID?: int /* Идентификатор режима отслеживания геопозиции */, id?: int /* Идентификатор шаблона пользователя */, isCustomer?: bool /* Признак клиента */, isTeam?: bool /* Признак бригады */, isTechnician?: bool /* Признак полевого инженера */, mobilityID?: int /* Идентификатор типа мобильности */, name?: str /* Наименование шаблона */, roles?: IdNameResultOfShort[] /* Список ролей, назначенных шаблонному пользователю */ }
type RoleApplicationBaseBaseData { data: int[], roleID: int }
type UserActionDataOfAttributeData { data: ADMUserAttributeAttributeData[], userID: int }
type UserActionDataOfShort { data: int[], userID: int }
type WHWarehouseUserUserWarehousesData { userID: int, warehouseIDs: int[] }
type WORKAuxiliaryTaskFilterData { approvalWith?: int[], assetClasses?: int[], assetResponsiblePersons?: int[], assetSchemas?: int[], assetTypes?: int[], assets?: int[], assignationPeriod?: CommonResultsPeriodResult, assignedTo?: int[], attributeValues?: JsonLinqJToken, attributes?: int[], branches?: int[], checkLists?: int[], closingPeriod?: CommonResultsPeriodResult, companies?: int[], companyRegistrationTypes?: int[], completedWorks?: int[], completionPeriod?: CommonResultsPeriodResult, contacts?: int[], contracts?: int[], creationPeriod?: CommonResultsPeriodResult, criticalities?: int[], dateRangePeriod?: CommonResultsPeriodResult, deadlinePeriod?: CommonResultsPeriodResult, districts?: int[], erpIDs?: str[], escalatedTo?: int[], eventTransportTypes?: int[], exportFlags?: DataAuxiliaryExportFlagFilter, flags?: DataAuxiliaryFlagFilter, geoViewPort?: DataAuxiliaryLocationFilter, lastModifiedPeriod?: CommonResultsPeriodResult, materials?: int[], orgUnits?: int[], parents?: int[], payeeCompanies?: int[], ratingCriterias?: int[], requestMethods?: int[], requestedBy?: int[], scheduleRules?: int[], sections?: str[], skills?: int[], startWithAssets?: int[], systemTags?: int[], tabs?: str[], tags?: str[], taskFlags?: WORKAuxiliaryTaskFlagFilter, taskNumbers?: str[], taskStages?: int[], taskStatuses?: int[], taskTemplates?: str[], taskTypes?: int[], tasks?: int[], users?: int[], validityOnDates?: datetime[], validityPeriod?: CommonResultsPeriodResult, warehouses?: int[], workTypes?: int[] }
type WORKAuxiliaryTaskFlagFilter { hasAssigneeCheckedIn?: bool, isAssigned?: bool, isClosed?: bool, isCompleted?: bool, isFavourite?: bool, isOutdated?: bool, isRated?: bool, isScheduled?: bool, topLevelTasksForHierarchy?: bool }