Skip To Content

esri_portal_get (AutoLISP)

The esri_portal_get function gets an associated list of portal properties for the specified portal.

Syntax

(esri_portal_get portalName)

Arguments

The following argument is included:

  • portalName | string | required | An ArcGIS Online or ArcGIS Enterprise organization name. Use (esri_portal_names) to find a list of valid names.

Note:

The portal name is first accessed by the default portal name "ArcGIS Online" or "ArcGIS Enterprise". Once you're signed in, the portal name may be the organizational name set by your administrator. You can review the names using (esri_portal_names) after signing in.

Example usage

Get the specified portal properties.

(esri_portal_get  "CAD Team Enterprise 11.3")

Result example usage

Returns a list that includes properties about the organization and user account.

(("IsActivePortal" . "True") ("IsSignedIn" . "True") ("OrganizationName" . "CAD Team Enterprise 11.3") ("PortalUrl" . "https://cadteam.esri.com/portal") (("CurrentUser" . "portaladmin") ("CanShareHostedFeatureLayer" . "True") ("OrganizationId" . "0123456789ABCDEF")))

Return values

The following are the possible return values:

  • If successful, the function returns an associated list of portal properties.
  • If failed, it returns a list with the first value of nil and an associated list containing the key value "Error" and an associated error message as a string: (nil ( "Error" . "<message>")).

Failed return values

A failed return value can occur for the following reason:

  • (nil ("Error" . "Missing required argument."))

    The required argument was not supplied.

See also

(esri_portal_signin)—An AutoLISP function that issues a prompt to sign in to the specified portal.

(esri_portal_names)—An AutoLISP function that gets a list of portal names as strings from managed portals.