GetPortalDescription

Краткая информация

GetPortalDescription используется для получения информации о портале, которая доступна текущему пользователю, который произвел вход или работает в анонимном режиме. Эта информация включает название организации, логотип, избранные элементы и поддерживаемые протоколы (HTTP или HTTPS) для данного портала. Если пользователь не произвел вход, то возвращается стандартный вид портала. Если пользователь произвел вход, то возвращаемый вид портала будет зависеть от организации, участником которой является данный пользователь. Стандартный вид портала зависит от настроек региона пользователя, которые можно получить из профиля пользователя.

Обсуждение

В таблице ниже содержится список наиболее важных свойств портала.

СвойствоПодробности
access

Уровень доступа к организации для анонимных пользователей Если задан как private, то доступ к сайту имеют только участники организации, хотя настройка public разрешает публичный доступ.

allSSL

Определяет, будет ли в организации использоваться HTTPS. Если задано true, то все обращения к ресурсам, принадлежащим организации, будут требовать HTTPS. По умолчанию – false.

analysisLayersGroupQuery

Этот запрос определяет группу, которая содержит слои, показанные в галерее Слои анализа для инструментов анализа.

appInfo

Информация о приложении, через которое доступен данный ресурс. Эта информация основана на токене, который используется для доступа к ресурсу.

authorizedCrossOriginDomains

Массив доверенных серверов, на которые клиент может отправлять учетные данные при выполнении запросов Совместного использования ресурсов между разными источниками (CORS) для доступа к защищенным сервисам на веб-уровне.

allowedRedirectUris

Массив JSON разрешенных URI перенаправления, которые представляют экземпляры портала для размещения защищенных ресурсов. Это позволит пользователям вашей организации использовать корпоративные учетные записи для доступа к защищенным ресурсам через веб-приложения, размещенные на этих порталах.

availableCredits

Общее количество кредитов в организации.

backgroundImage

Фоновый рисунок, который располагается позади всех других компонентов на Главной странице. Примите фоновый рисунок по умолчанию, укажите URL для пользовательского фонового рисунка, либо укажите, чтобы фонового рисунка не было.

basemapGalleryGroupQuery

Запрос, который определяет группу, содержащую веб-карты, отображающиеся в галерее базовых карт Map Viewer.

bingKey

Ключ Bing для веб-карт, которые используют Bing Maps.

canListApps

Организация может разместить приложения в Marketplace только в том случае, если canListApps задан как true.

canListData

Организация может разместить сервисы данных в Marketplace только в случае, если canListData указан как true.

canListPreProvisionedItems

Организация может разместить преднастроенные элементы в Marketplace только в случае, если canListPreProvisionedItems указан как true.

canProvisionDirectPurchase

Организация может разрешить прямые заказы на MarketPlace без запроса пользователя только в случае, если canProvisionDirectPurchase задан как true.

canSearchPublic

Включает или исключает публичные элементы, группы и пользователей в поисковых запросах Когда canSearchPublic задан как false, то публичные элементы за пределами организации не доступны для поиска. Однако возвращаются публичные элементы, которые являются частью элементов организации. По умолчанию – true.

canShareBingPublic

Ключ Bing может быть опубликован публично и возвращен как часть вызова описания портала (/sharing/rest/portals/<orgid>). Для этого необходимо, чтобы свойство access портала было задано как public. Свойство canShareBingPublic публично не возвращается, и показывается только пользователям, входящим в организацию.

canSharePublic

Показывает, может ли организация открывать публичный доступ к элементам или группам. Когда для canSharePublic выбрано false, ресурс не может быть опубликован для всех. По умолчанию – true.

canSignInArcGIS

Позволяет организация с настроенным корпоративным IDP включать или выключать вход в ArcGIS. По умолчанию – true.

canSignInIDP

Позволяет организациям с настроенным корпоративным IDP выключать или выключать корпоративный вход. По умолчанию – true.

colorSetsGroupQuery

Запрос, определяющий группу, содержащую цветовые наборы, использующиеся для отображения в Map Viewer.

commentsEnabled

Позволяет организации отключить комментирование. По умолчанию – true. Когда для commentsEnabled задано false, комментарии скрываются, но не удаляются, а numComments устанавливается на ноль для всех элементов организации. Вызовы по добавлению или просмотру комментариев работать не будут. Если организация снова включит комментарии, они будут отображаться, а numComments также будут восстановлены.

contentCategorySetsGroupQuery

Запрос, определяющий группу, содержащую наборы категорий ресурсов ArcGIS Online.

created

Дата, когда была создана организация, формат UTC, используются милисекунды с начала эры.

creditAssignments

Определяет, включено ли в организации распределение кредитов. По умолчанию – disabled.

culture

Информация о локали или культурных особенностях организации (страна-язык), например, en-us.

cultureFormat

Предпочитаемый номер и формат даты, в соответствии с CLDR. Это свойство cultureFormat применимо только для английского и испанского языков, когда для свойства culture задано значение en или es.

Поддерживаемые форматы см. в разделе Языки.

customBaseUrl

Пользовательский URL-адрес портала.

defaultBasemap

Базовая карта по умолчанию, отображаемая в Map Viewer.

defaultExtent

Экстент по умолчанию для организации.

defaultUserCreditAssignment

Распределение кредитов по умолчанию для новых участников.

defaultVectorBasemap

Векторная базовая карта по умолчанию, отображаемая в Map Viewer, когда для useVectorBasemaps задано true.

description

Описание организации.

eueiEnabled

Показывает, разрешает ли организация ArcGIS Online собирать информацию об использовании участниками организации в целях улучшения взаимодействия с пользователем.

featuredGroups

Избранные группы для организации. Это группы, которые выделены на странице Группы.

featuredItemsGroupQuery

Запрос, определяющий группу, содержащую избранные элементы для галереи. Задайте ID группы или null, если хотите, чтобы в галерее отображались наиболее просматриваемые элементы организации.

galleryTemplatesGroupQuery

Запрос, который показывает, разрешено ли группе, содержащей шаблоны галереи, строить галереи для демонстрации веб-карт и картографических веб-приложений на основе элементов группы.

hasCategorySchema

Показывает, имеется ли в организации настроенная категория ресурсов.

helpBase

Указывает на базовый URL справочной документации. Используется для создания всех URL справки на портале. Начиная с ArcGIS Enterprise 10.8.1, helpBase может быть обновлен, таким образом источником документации по умолчанию будет веб-версия пользовательской документации ArcGIS Enterprise, а не локальная установленная версия справки. Более подробно см. Обновить.

Примечание:

Источник документации влияет только на документацию, доступ к которой идет с главной страницы приложения портала Enterprise, и не влияет ни на ArcGIS Server, ни на документацию по ArcGIS REST API.

helperServices

Объект JSON для различных сервисов, которые требуются для клиентских приложений. Они могут быть перезаписаны организацией или порталом. Это следующие сервисы:

  • analysis—Размещенные сервисы геообработки для выполнения анализа.
  • asyncClosestFacility—Сервис геообработки ArcGIS для асинхронного анализа ближайшего пункта размещения.
  • asyncGeocode—Сервис геообработки ArcGIS для выполнения асинхронного пакетного геокодирования. (Этот вспомогательный сервис был добавлен в ArcGIS Enterprise 10.5.)
  • asyncLocationAllocation—Сервис геообработки ArcGIS для асинхронного сетевого анализа размещения-распределения.
  • asyncODCostMatrix—Сервис геообработки ArcGIS для асинхронного анализа построения матрицы стоимости источник-назначение.
  • asyncRoute—Сервис геообработки ArcGIS для асинхронного анализа построения маршрутов.
  • asyncServiceArea—Сервис геообработки ArcGIS для асинхронного анализа создания областей обслуживания.
  • asyncVRP—Сервис геообработки ArcGIS для синхронного решения задачи управления автопарком транспортных средств.
  • closestFacility—Сервис ArcGIS NAServer для выполнения синхронного анализа поиска ближайшего объекта.
  • creditEstimation—Сервис геообработки ArcGIS для оценки кредитов, которые будут затрачены на выполнение конкретной задачи.
  • elevation—Сервис геообработки ArcGIS для анализа высоты.
  • defaultElevationLayers—Сервис высот Limited Error Raster Compression (LERC), использующийся ArcGIS Pro и веб-Scene Viewer.
  • elevationSync—Сервис геообработки ArcGIS для анализа высоты.
  • geocode—Массив сервисов геообработки ArcGIS, которые используются для геокодирования.
  • geoenrichment—Сервис ArcGIS GeoenrichmentServer.
  • geometry—Сервис ArcGIS GeometryServer для функций геометрии.
  • hydrology—Сервис геообработки ArcGIS для проведения гидрологического анализа.
  • locationTracking—Сервис объектов ArcGIS для отслеживания местоположений в организации.
  • orthomappingElevation—Сервис изображений ArcGIS для Ortho Maker.
  • printTask—Задача ArcGIS PrintServer для выполнения печати.
  • rasterUtilities—Сервис геообработки ArcGIS, который запускает анализ и обработку растров.
  • route—Сервис ArcGIS NAServer для выполнения синхронного анализа маршрутов.
  • routingUtilities—Сервис геообработки ArcGIS, который преодоставляет общую информацию, например, режимы передвижения, которые используются разными сервисами построения маршрутов.
  • serviceArea—Сервис ArcGIS NAServer для выполнения синхронного анализа построения областей обслуживания.
  • syncVRP—Сервис геообработки ArcGIS для синхронного решения задач VRP.
  • traffic—Картографический сервис ArcGIS для отображения пробок и дорожных происшествий.
  • packaging—Сервис геообработки ArcGIS для создания автономных областей карты и пакетов из веб-карт.
  • iot—URL региона ArcGIS Velocity.
homePageFeaturedContent

Группа, которая содержит избранные ресурсы для отображения на домашней странице.

homePageFeaturedContentCount

Количество избранных элементов, которые будут отображаться на домашней странице. Максимальное количество равно 100. Только целочисленные значения.

httpPort

Порт, который используется порталом для HTTP-сообщения.

httpsPort

Порт, который используется порталом для HTTPS-сообщения.

id

ID организации. Если равно null, это портал по умолчанию для анонимных пользователей и пользователей, не являющихся участником организации.

ipCntryCode

Код страны вызывающего IP (только ArcGIS Online).

isPortal

Обозначает, размещен ли портал на ресурсах организации.

isVerified

Показывает, проверена ли Esri идентичность организации.

layerTemplatesGroupQuery

Запрос, определяющий группу, содержащую шаблоны редактирования, использующиеся в Map Viewer.

livingAtlasGroupQuery

Запрос, определяющий группу, содержащую слои, которые используются в галерее Слоев анализа.

maxTokenExpirationMinutes

Максимальный срок действия токенов OAuth и non-OAuth, выданных пользователям организации. -1 используется по умолчанию, это дает 2 недели для токенов доступа OAuth и токенов ArcGIS (не-OAuth), и максимум 90 дней для продлеваемых токенов OAuth. Это максимальные поддерживаемые значения. Выбор меньшего значения повлияет на все три типа токенов (ArcGIS, доступа OAuth и продлеваемые OAuth).

metadataEditable

Определяет, включено ли в организации использование метаданных.

metadataFormats

Стиль метаданных, который используется в организации.

Пример: metadataFormats:["fgdc"]

modified

Дата, когда в организации были внесены последние изменения, формат UTC, используются милисекунды с начала эры.

name

Имя организации.

orgEmail

Указанная электронная почта появится на вкладке Провайдер вашей организации на ArcGIS Marketplace.

orgPhone

Указанный номер телефона появится на вкладке Провайдер вашей организации на ArcGIS Marketplace.

orgUrl

URL веб-сайта, который появится на вкладке Провайдер вашей организации на ArcGIS Marketplace.

portalHostname

URL хоста портала.

portalMode

Определяет, multitenant или singletenant.

portalName

Имя портала.

portalProperties

Хранит свойства, относящиеся к организации, например, ссылку "связаться с нами". Если организация является публичной, то эти свойства будут видны анонимным пользователям.

portalThumbnail

URL иконки портала.

region

Регион организации.

rotatorPanels

Пользовательский HTML домашней страницы.

showHomePageDescription

Если true, то описание организации отображается на домашней странице.

storageQuota

Общий допустимый размер хранилища в байтах. Обычно это 2TB для организации, 2GB для не-организации.

storageUsage

Общий используемый объем хранилища в байтах.

stylesGroupQuery

Запрос, который определяет группу, содержащую различные стили со ссылкам на символы, которые могут использоваться платформой ArcGIS.

supportsHostedServices

Определяет, поддерживаются ли размещенные сервисы.

supportsOAuth

Определяет, поддерживается ли OAuth.

symbolSetsGroupQuery

Запрос, который определяет группу заданного символа для отображения в Map Viewer.

templatesGroupQuery

Запрос, определяющий группу шаблона, использующегося в Map Viewer.

thumbnail

URL иконки организации.

units

Определяет единицы измерения для пользователей организации. Значение для пользователя по умолчанию берется из региона организации. Задает единицы измерения для english по стандартам США или metric.

updateUserProfileDisabled

Определяет, можно ли разрешить участникам редактировать анкетные данные, а также выбирать тех, кто может видеть их профиль.

urlKey

Префикс, выбранный администратором организации, который будет использоваться в customBaseURL.

useStandardizedQuery

Если true, только простые выражения запроса WHERE, совместимые с SQL92, могут использоваться для запросов в слоях и таблицах. Рекомендуемая настройка безопасности – true.

useVectorBasemaps

Если true, организация использует векторные базовые карты Esri в поддерживающихся приложениях ArcGIS, а basemapGalleryGroupQuery не редактируется и задается запросом по умолчанию.

vectorBasemapGalleryGroupQuery

Запрос, который определяет группу, содержащую векторные базовые карты, отображающиеся в галерее базовых карт Map Viewer. Этот запрос должен использоваться только когда для useVectorBasemaps задано true.

allowedOrigins

Массив из 100 доменов веб-приложений для ограничения доступа CORS к ArcGIS Online REST API.

mfaAdmins

Массив из как минимум двух назначенных администраторов, окторые получают запросы на решение проблем при многофакторной аутентификации пользователей.

contacts

Массив выбранных администраторов и их адреса электронной почты, которые будут перечислены в качестве контактов при автоматической электронной рассылке, которая отправляется участникам организации, когда они запрашивают сброс пароля, помощь с именами пользователя, вносят какие-либо изменения в учетные записи, или при любых вопросах, связанными с распределением кредитов между учетными записями.

mfaEnabled

Определяет, разрешить ли участникам использовать многофакторную аутентификацию в индивидуальных учетных записях.

allowedBetaFeatures

Массив бета-объектов, которые доступны для организации.

user

Пользовательская информация для доступа пользователя возвращается, если токен прошел проверку. Информация о группе не предоставлена См. Пользователь для получения информации о получаемых свойствах.

Синтаксис

GetPortalDescription ({portal_URL})
ПараметрОписаниеТип данных
portal_URL

URL-адрес портала. Если не указано, то используется активный портал.

String
Возвращаемое значение
Тип данныхОписание
Dictionary

Словарь, содержащий информацию о портале

Пример кода

Пример 1 GetPortalDescription

Получение словаря ссылок URL служебных сервисов портала.

import arcpy
portal_desc = arcpy.GetPortalDescription()
helper_services = portal_desc['helperServices']
Пример 2 GetPortalDescription

Получение информации о правах пользователя в портале.

import arcpy
portal_desc = arcpy.GetPortalDescription()
user_name = portal_desc['user']['fullName']
user_privileges = portal_desc['user']['privileges']

Связанные разделы