Class: QgsArcGisPortalUtils

Utility functions for working with ArcGIS REST services.

See also

QgsArcGisRestUtils

Added in version 3.18.

List of all members, including inherited members

Static Methods

retrieveGroupContent

Retrieves JSON definitions for all items which belong the the specified groupId.

retrieveGroupItemsOfType

Retrieves JSON definitions for all items which belong the the specified groupId.

retrieveUserGroups

Retrieves JSON definitions for all groups which the specified user name is a member of.

retrieveUserInfo

Retrieves JSON user info for the specified user name.
class qgis.core.QgsArcGisPortalUtils[source]

Bases: object

ItemType

alias of ArcGisRestServiceType

static retrieveGroupContent(contentUrl: str | None, groupId: str | None, authcfg: str | None, requestHeaders: QgsHttpHeaders = QgsHttpHeaders(), feedback: QgsFeedback | None = None, pageSize: int = 100, urlPrefix: str | None = '', forceRefresh: bool = False)[source]

Retrieves JSON definitions for all items which belong the the specified groupId.

Parameters:

  • contentUrl (Optional[str]) – should be set to the Portal’s content URL, e.g. https://mysite.com/portal/sharing/rest/content

  • groupId (Optional[str]) – ID of group to query

  • authcfg (Optional[str]) – authentication configuration ID

  • requestHeaders (QgsHttpHeaders = QgsHttpHeaders()) – optional additional request headers

  • feedback (Optional[QgsFeedback] = None) – optional feedback argument for cancellation support

  • pageSize (int = 100) – number of results to retrieve for each request. Maximum value is 100.

  • urlPrefix (Optional[str] = '') – http web proxy url prefix

  • forceRefresh (bool = False) – if False then previously cached replies may be used for the request. If it is set to True then a new query is always performed. (since QGIS 4.0)

Returns:

  • a list of JSON item info for all items within the group

  • errorTitle: title summary of any encountered errors

  • errorText: error text of any encountered errors

Added in version 3.24.

retrieveGroupContent(contentUrl: Optional[str], groupId: Optional[str], authcfg: Optional[str], requestHeaders: dict[Optional[str], Any], feedback: Optional[QgsFeedback] = None, pageSize: int = 100, urlPrefix: Optional[str] = ‘’) -> (list[Any], str, str) Retrieves JSON definitions for all items which belong the the specified groupId. Only to avoid API break.

Parameters:

  • contentUrl – should be set to the Portal’s content URL, e.g. https://mysite.com/portal/sharing/rest/content

  • groupId – ID of group to query

  • authcfg – authentication configuration ID

  • requestHeaders – optional additional request headers

  • feedback – optional feedback argument for cancellation support

  • pageSize – number of results to retrieve for each request. Maximum value is 100.

  • urlPrefix – http web proxy url prefix

Return type:

(list[Any], str, str)

Returns:

  • a list of JSON item info for all items within the group

  • errorTitle: title summary of any encountered errors

  • errorText: error text of any encountered errors

Deprecated since version 3.24: Use the version with QgsHttpHeaders instead.

static retrieveGroupItemsOfType(contentUrl: str | None, groupId: str | None, authcfg: str | None, itemTypes: Iterable[int], requestHeaders: QgsHttpHeaders = QgsHttpHeaders(), feedback: QgsFeedback | None = None, pageSize: int = 100, urlPrefix: str | None = '', forceRefresh: bool = False)[source]

Retrieves JSON definitions for all items which belong the the specified groupId.

Parameters:

  • contentUrl (Optional[str]) – should be set to the Portal’s content URL, e.g. https://mysite.com/portal/sharing/rest/content

  • groupId (Optional[str]) – ID of group to query

  • authcfg (Optional[str]) – authentication configuration ID

  • itemTypes (Iterable[int]) – list of desired item types (using Qgis.ArcGisRestServiceType values)

  • requestHeaders (QgsHttpHeaders = QgsHttpHeaders()) – optional additional request headers

  • feedback (Optional[QgsFeedback] = None) – optional feedback argument for cancellation support

  • pageSize (int = 100) – number of results to retrieve for each request. Maximum value is 100.

  • urlPrefix (Optional[str] = '') – http web proxy url prefix

  • forceRefresh (bool = False) – if False then previously cached replies may be used for the request. If it is set to True then a new query is always performed. (since QGIS 4.0)

Returns:

  • a list of JSON item info for all items within the group

  • errorTitle: title summary of any encountered errors

  • errorText: error text of any encountered errors

Added in version 3.24.

retrieveGroupItemsOfType(contentUrl: Optional[str], groupId: Optional[str], authcfg: Optional[str], itemTypes: Iterable[int], requestHeaders: dict[Optional[str], Any], feedback: Optional[QgsFeedback] = None, pageSize: int = 100, urlPrefix: Optional[str] = ‘’) -> (list[Any], str, str) Retrieves JSON definitions for all items which belong the the specified groupId. Only to avoid API break.

Parameters:

  • contentUrl – should be set to the Portal’s content URL, e.g. https://mysite.com/portal/sharing/rest/content

  • groupId – ID of group to query

  • authcfg – authentication configuration ID

  • itemTypes – list of desired item types (using Qgis.ArcGisRestServiceType values)

  • requestHeaders – optional additional request headers

  • feedback – optional feedback argument for cancellation support

  • pageSize – number of results to retrieve for each request. Maximum value is 100.

  • urlPrefix – http web proxy url prefix

Return type:

(list[Any], str, str)

Returns:

  • a list of JSON item info for all items within the group

  • errorTitle: title summary of any encountered errors

  • errorText: error text of any encountered errors

Deprecated since version 3.24: Use the version with QgsHttpHeaders instead.

static retrieveUserGroups(communityUrl: str | None, user: str | None, authcfg: str | None, requestHeaders: QgsHttpHeaders = QgsHttpHeaders(), feedback: QgsFeedback | None = None, urlPrefix: str | None = '', forceRefresh: bool = False)[source]

Retrieves JSON definitions for all groups which the specified user name is a member of.

If user is blank then the user associated with the current logon details will be retrieved

Parameters:

  • communityUrl (Optional[str]) – should be set to the Portal’s community URL, e.g. https://mysite.com/portal/sharing/rest/community

  • user (Optional[str]) – username to query, or an empty string to query the current user

  • authcfg (Optional[str]) – authentication configuration ID

  • requestHeaders (QgsHttpHeaders = QgsHttpHeaders()) – optional additional request headers

  • feedback (Optional[QgsFeedback] = None) – optional feedback argument for cancellation support

  • urlPrefix (Optional[str] = '') – http web proxy url prefix

  • forceRefresh (bool = False) – if False then previously cached replies may be used for the request. If it is set to True then a new query is always performed. (since QGIS 4.0)

Returns:

  • a list of JSON group info

  • errorTitle: title summary of any encountered errors

  • errorText: error text of any encountered errors

Added in version 3.24.

retrieveUserGroups(communityUrl: Optional[str], user: Optional[str], authcfg: Optional[str], requestHeaders: dict[Optional[str], Any], feedback: Optional[QgsFeedback] = None, urlPrefix: Optional[str] = ‘’) -> (list[Any], str, str) Retrieves JSON definitions for all groups which the specified user name is a member of. Only to avoid API break.

If user is blank then the user associated with the current logon details will be retrieved

Parameters:

  • communityUrl – should be set to the Portal’s community URL, e.g. https://mysite.com/portal/sharing/rest/community

  • user – username to query, or an empty string to query the current user

  • authcfg – authentication configuration ID

  • requestHeaders – optional additional request headers

  • feedback – optional feedback argument for cancellation support

  • urlPrefix – http web proxy url prefix

Return type:

(list[Any], str, str)

Returns:

  • a list of JSON group info

  • errorTitle: title summary of any encountered errors

  • errorText: error text of any encountered errors

Deprecated since version 3.24: Use the version with QgsHttpHeaders instead.

static retrieveUserInfo(communityUrl: str | None, user: str | None, authcfg: str | None, requestHeaders: QgsHttpHeaders = QgsHttpHeaders(), feedback: QgsFeedback | None = None, urlPrefix: str | None = '', forceRefresh: bool = False)[source]

Retrieves JSON user info for the specified user name.

If user is blank then the user associated with the current logon details will be retrieved

Parameters:

  • communityUrl (Optional[str]) – should be set to the Portal’s community URL, e.g. https://mysite.com/portal/sharing/rest/community

  • user (Optional[str]) – username to query, or an empty string to query the current user

  • authcfg (Optional[str]) – authentication configuration ID

  • requestHeaders (QgsHttpHeaders = QgsHttpHeaders()) – optional additional request headers

  • feedback (Optional[QgsFeedback] = None) – optional feedback argument for cancellation support

  • urlPrefix (Optional[str] = '') – http web proxy url prefix

  • forceRefresh (bool = False) – if False then previously cached replies may be used for the request. If it is set to True then a new query is always performed. (since QGIS 4.0)

Returns:

  • JSON user info

  • errorTitle: title summary of any encountered errors

  • errorText: error text of any encountered errors

Added in version 3.24.

retrieveUserInfo(communityUrl: Optional[str], user: Optional[str], authcfg: Optional[str], requestHeaders: dict[Optional[str], Any], feedback: Optional[QgsFeedback] = None, urlPrefix: Optional[str] = ‘’) -> (dict[str, Any], str, str) Retrieves JSON user info for the specified user name. Only to avoid API break.

If user is blank then the user associated with the current logon details will be retrieved

Parameters:

  • communityUrl – should be set to the Portal’s community URL, e.g. https://mysite.com/portal/sharing/rest/community

  • user – username to query, or an empty string to query the current user

  • authcfg – authentication configuration ID

  • requestHeaders – optional additional request headers

  • feedback – optional feedback argument for cancellation support

  • urlPrefix – http web proxy url prefix

Return type:

(dict[str, Any], str, str)

Returns:

  • JSON user info

  • errorTitle: title summary of any encountered errors

  • errorText: error text of any encountered errors

Deprecated since version 3.24: Use the version with QgsHttpHeaders instead.