Public interfaces
ArcGIS Earth Automation API provides the following public interfaces:
| API | Description |
|---|---|
| GET /arcgisearth/camera | Get the current viewing perspective of the scene. |
| PUT /arcgisearth/camera | Set or update the viewing perspective of the scene to a specified position. |
| POST /arcgisearth/flight | Set or update the camera animation when you fly to a target position. |
| POST /arcgisearth/drawings | Add a drawing to ArcGIS Earth. |
| DELETE /arcgisearth/drawings | Remove all existing drawings in ArcGIS Earth. |
| DELETE /arcgisearth/drawings/{id} | Delete an existing drawing in ArcGIS Earth. |
| POST /arcgisearth/layer | Add a layer to the table of contents, basemap, or terrain of ArcGIS Earth. |
| GET /arcgisearth/layer/{id} | Get the loading status of a layer by specifying the layer ID. |
| DELETE /arcgisearth/layer/{id} | Delete a layer by specifying the layer ID. |
| DELETE /arcgisearth/layers/{target} | Remove layers from ArcGIS Earth by target. |
| GET /arcgisearth/graphics/{id} | Get a graphic by specifying the graphic ID. |
| POST /arcgisearth/graphics | Add a graphic to ArcGIS Earth. |
| PATCH /arcgisearth/graphics | Update an existing graphic in ArcGIS Earth. |
| DELETE /arcgisearth/graphics/{id} | Delete a graphic by specifying the graphic ID. |
| DELETE /arcgisearth/graphics | Remove all graphics from ArcGIS Earth. |
| POST /arcgisearth/project | Create a new project. |
| POST /arcgisearth/project/open | Open an existing project. |
| POST /arcgisearth/project/save | Save the current project in place. |
| POST /arcgisearth/project/saveAs | Save the current project to a new location. |
| GET /arcgisearth/project/recent | Get recently opened projects, grouped by project type. |
| GET /arcgisearth/project/recent/{type} | Get recently opened projects of a single type. |
| GET /arcgisearth/snapshot | Take a snapshot of the current view of ArcGIS Earth. |
Project API
ArcGIS Earth 3.0 introduces the Project API, a single set of endpoints for creating, opening, and saving projects. Global scene, local scene, and movie projects are all handled through the same requests; the project type is either supplied when creating a project or resolved from the file path.
Scene projects use the .aescx extension and movie projects use the .aemvx extension.
Note:
The movie module is released as Beta in ArcGIS Earth 3.0. Movie projects can be created, opened, and saved through the Project API, but the movie document format is not yet final and may change in a future release.Workspace API
The Workspace API is not available in ArcGIS Earth 3.0 and later. The Project API replaces it.
| Workspace API | Use instead in 3.0 |
|---|---|
GET /arcgisearth/workspace | POST /arcgisearth/project/saveAs writes the current project to a file. |
PUT /arcgisearth/workspace | POST /arcgisearth/project/open opens a project file. |
DELETE /arcgisearth/workspace | POST /arcgisearth/project creates a new project, replacing the current one. |
In ArcGIS Earth 3.0 a request to /arcgisearth/workspace without an api-version, or with api-version=1.0, 1.12, or 1.16, returns 409 Conflict with a message pointing to the Project API. A request with api-version=3.0 returns UnsupportedApiVersion.
The Workspace API pages are retained for ArcGIS Earth 1.x and 2.x, where these endpoints still work as documented.
Versioning
The API version is supplied as a query parameter, for example ?api-version=3.0. The default is 3.0. URL path segments such as /v3.0/arcgisearth/... are not supported.