Skip To Content

esri_portal_add (AutoLISP)

The esri_portal_add function adds the specified portal to the list of managed portals and returns a list that includes properties about the organization and user account.

Syntax

(esri_portal_add url)

Arguments

The following argument is included:

  • url | string | required | The URL of a valid ArcGIS Online or ArcGIS Enterprise portal.

    Example: ArcGIS Onlinehttps://www.arcgis.com or https://<yourorg>.maps.arcgis.com

    ArcGIS Enterprisehttps://<webadaptorhost>.<domain.com>/<webadaptorname>

Example usage

Add the specified portal.

(esri_portal_add  "https://cadteam.esri.com/portal")

Result example usage

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

(("IsActivePortal" . "False") ("IsSignedIn" . "False") ("OrganizationName" . "") ("PortalUrl" . "https://cadteam.esri.com/portal") ("CurrentUser" . "nil"))

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 any of the following reasons:

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

    The required argument is not supplied.

  • (nil ("Error" . "requires network....")))

    No network connection was found.

  • (nil ("Error" . "Invalid URL"))

    The URL provided is invalid.

See also

(esri_portal_remove)—An AutoLISP function that removes the specified portal connection.

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