Skip to content
This repository has been archived by the owner on Mar 31, 2020. It is now read-only.

2. ArcREST package structure

Jump to bottom
AlexArcPy edited this page Oct 31, 2015 · 1 revision

###General description of the ArcREST package The package includes two folders, arcrest and arcresthelper.

Arcresthelper folder includes modules that are used most often internally; arcrest, in contrast, contains the modules you will be working with. arcrest folder has folders which have in turn modules that are used for accessing your ArcGIS for Server or Portal for ArcGIS installations as well as ArcGIS Online organization. Keep in mind that ArcREST package can be used not only for administering the site or your organization, but also for automation of operations that are usually done by end users of the system.

For instance, you could use ArcREST to restart all of your services at the midnight (sysadmin operation), but you could also build a geoprocessing script that can be executed by a GIS Analyst which will with the help of ArcREST upload features from a local file geodatabase into a hosted feature service (end user operation).

The ArcREST layout of the functions and classes follows the REST API/URL structure; however, ArcREST has many useful functions that are not present in the REST API. Learn more about ArcGIS REST API and what operations are accessible.

Below is the list of the links to the REST API Help pages.

Detailed description of the arcrest folder structure

Let’s take a look at each of the folders inside the arcrest folder to find out what they are used for.

  • _abstract: system operations and helper functions that are used internally.
  • agol: modules that are used for using ArcGIS Online organization resources (no administrative access).
  • ags: modules that are used for using ArcGIS for Server site resources (no administrative access).
  • common: system operations and helper functions that are used internally.
  • enrichment: modules that are used for accessing ArcGIS Online geoenrichment service programmatically. Learn more about geoenrichment.
  • geometryservice: module used for accessing ArcGIS for Server Geometry service for performing geometric operations on features.
  • hostedservice: module used for accessing ArcGIS Online or Portal for ArcGIS hosted services.
  • manageags: modules used for administering ArcGIS for Server site.
  • manageorg: modules used for administering ArcGIS Online organization.
  • manageportal: modules used for administering Portal for ArcGIS installations.
  • security: system operations and helper functions that are used internally for all security related operations such as obtaining tokens, establishing connections and many more.
  • web: system operations and helper functions that are used internally for managing web requests and responses in the communication with the system you administer or access programmatically.
  • webmap: system operations and helper functions that are used internally for managing web maps in ArcGIS Online or Portal for ArcGIS.

Most of the time you will likely spend working with modules in ags/manageags and agol/manageorg depending on whether you will be using/administering ArcGIS for Server or ArcGIS Online organization. However, it’s not uncommon to access certain operations available in the helper modules when automating a certain workflow.

Clone this wiki locally