ArcGIS REST APIs

https://gis.maine.gov/mapservices/help/en/rest/services-reference/
Admin
ArcGIS REST APIs provide a comprehensive set of web services for interacting with geographic...
Tokens:4,253,495
Snippets:12,625
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### Raster Analytics Service - Get Started

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/wmts-capabilities-map-service

Introduction and setup information for the Raster Analytics service, including input/output types and job status checking.

```APIDOC
## Raster Analytics Service - Get Started API

### Description
Provides introductory information and setup guidelines for the Raster Analytics service, covering raster and feature inputs/outputs, and how to check job status.

### Endpoints
- **GET /raster_analytics/get_started**
  General information and getting started guide for Raster Analytics.

- **GET /raster_analytics/service_tasks**
  Lists available Raster Analysis service tasks.

- **GET /raster_analytics/raster_input**
  Information on raster input requirements.

- **GET /raster_analytics/raster_output**
  Information on raster output formats.

- **GET /raster_analytics/feature_input**
  Information on feature input requirements.

- **GET /raster_analytics/feature_output**
  Information on feature output formats.

- **GET /raster_analytics/check_job_status**
  Endpoint to check the status of a Raster Analytics job.

### Parameters
(Specific parameters depend on each endpoint and are not detailed here)

### Request Example
(Request examples vary per endpoint)

### Response
(Response formats vary per endpoint)
```

--------------------------------

### Raster Analytics (Get Started)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

Introduction and overview of Raster Analysis service tasks.

```APIDOC
## Raster Analytics (Get Started)

### Description
Introduction and overview of Raster Analysis service tasks.

### Endpoints
- Raster Analysis service tasks
- Get started with the Raster Analysis service
- Raster input
- Raster output
- Feature Input
- Feature Output
- Check job status
```

--------------------------------

### Output Table Name Examples (JSON)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/zonal-statistics-as-table

Examples for specifying the output table name, including creating a new service or referencing an existing portal item or URL.

```json
{
  "outputTableName": {"serviceProperties": {"name": "testrasteranalysis"}}
}
{
  "outputTableName": {"itemId": <portal item id>}
}
{
  "outputTableName": {"url": <feature service url>
}
{
  "outputTableName": {
    "serviceProperties": {
      "name": "testrasteranalysis",
      "serviceUrl": "https://<server name>/server/rest/services/Hosted/testrasteranalysis/FeatureServer/0"
    },
    "itemProperties": {
      "itemId": "351fe8441a1a436d8001124487b02550",
      "folderId": "sdfwerfbd3ec25584d0d8f4"
    }
  }
}
```

--------------------------------

### Input Zone Feature Examples (JSON)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/zonal-statistics-as-table

Examples of how to specify feature input for zones using feature service layer URLs or feature collections.

```json
{
  "inputZoneRasterOrFeatures": {"url": <feature service layer url>}
}
{
  "inputZoneRasterOrFeatures": {"layerDefinition": {}, "featureSet": {}}
}
```

--------------------------------

### Geoprocessing Service Input JSON URL Formatting Example

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise

A concrete example of formatting a URL to an input JSON object file for geoprocessing services.

```text
geometries={"url": "https://myserver/mygeometries/afile.txt"}
```

--------------------------------

### Input Zone Raster Examples (JSON)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/zonal-statistics-as-table

Examples of how to specify raster input for zones using portal item IDs or URLs to image service layers.

```json
{
  "inputZoneRasterOrFeatures": {"itemId": <portal item Id>}
}
{
  "inputZoneRasterOrFeatures": {"url": <image service layer url>}
}
```

--------------------------------

### Zone Field Example (JSON)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/zonal-statistics-as-table

Example of specifying the field to use for defining zones from the input zone raster or features.

```json
{
  "zoneField": ParcelID
}
```

--------------------------------

### Input Value Raster Examples (JSON)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/zonal-statistics-as-table

Examples of how to specify raster input for values to be summarized, using portal item IDs or URLs to image service layers.

```json
{
  "inputValueRaster": {"itemId": <portal item Id>}
}
{
  "inputValueRaster": {"url": <image service layer url>}
}
```

--------------------------------

### Create Replica JSON Response Example

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

This JSON response provides the URL for the created replica file. It is generated after a successful 'createReplica' operation and is used to download the replica data.

```json
{
  "URL" : "https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example4/replicafiles/87fe042ede17493a8cdeac0f2d062a69.json"
}
```

--------------------------------

### JSON Response Example for Output Table

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/zonal-statistics-as-table

This is a concrete example of a JSON response for the 'outputTable' parameter. It shows the actual values for the URL and itemId, representing a hosted feature service containing the analysis results.

```json
{
  "paramName": "outputTable",
  "dataType": "GPString",
  "value": {
    "url": "https://<server name>/server/rest/services/Hosted/<service name>/FeatureServer/0",
    "itemId": "351fe8441a1a436d8001124487b02550"
  }
}
```

--------------------------------

### Create Replica JSON Response

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

Example JSON response after successfully creating a replica. It indicates the transport type and response type, and provides a URL for accessing the replica files.

```json
{
   "transportType": "esriTransportTypeUrl",
   "responseType": "esriReplicaResponseTypeData",
   "URL" : "https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example2/replicafiles/712ccg2726d14bfebfcb8576b29ecc43.json"
}
```

--------------------------------

### Info Resource JSON Response Example

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/mission/site-info

A concrete example of a JSON response from the Info resource, showing typical values for software version information.

```json
{
    "fullVersion": "10.8.1",
    "currentVersion": 10.8
}
```

--------------------------------

### Example WMTS Capabilities Request URL

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/wmts-capabilities-image-service

An example of a RESTful URL used to request the WMTS capabilities document from an image service. This URL format is used by WMTS clients to obtain service metadata, which is crucial for accessing tiled map data.

```URL
https://machine.domain.com/webadaptor/rest/services/Toronto/ImageServer/WMTS/1.0.0/WMTSCapabilities.xml
```

--------------------------------

### Create Replica JSON Response Example

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

This JSON object represents a successful response from a createReplica operation. It contains information about the transport type, response type, and the URL for the replica files.

```json
{
  "transportType": "esriTransportTypeUrl",
  "responseType": "esriReplicaResponseTypeInfo",
  "URL" : "https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example3/replicafiles/6627df2726d14bfebfcb8576b29f6d5a2.json"
}
```

--------------------------------

### Sample Request URL for ZonalStatisticsAsTable

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/zonal-statistics-as-table

This is an example of a complete URL used to submit a job to the ZonalStatisticsAsTable REST service. It specifies the service endpoint and the submitJob operation.

```bash
https://services.myserver.com/arcgis/rest/services/System/RasterAnalysisTools/GPServer/ZonalStatisticsAsTable/submitJob
```

--------------------------------

### Create Replica (Initial)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

Creates an initial replica for a specified area and layers, returning a URL to a JSON file containing replica metadata.

```APIDOC
## POST /createReplica

### Description
Creates a replica for a specified geographic area and set of layers. This is typically used to generate a shared replica for distribution.

### Method
POST

### Endpoint
`https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example3/FeatureServer/createReplica`

### Parameters
#### Query Parameters
- **f** (string) - Optional - The response format. Default is json.

#### Request Body
- **geometry** (object) - Required - Defines the spatial extent of the replica. Example: `{"xmin": -117.2037, "ymin": 33.4455, "xmax": -117.0593, "ymax": 33.569}`
- **geometryType** (string) - Required - The type of geometry. Example: `"esriGeometryEnvelope"`
- **inSR** (integer) - Required - The spatial reference of the input geometry.
- **layerQueries** (object) - Optional - Defines queries for specific layers.
- **layers** (string) - Required - Comma-separated list of layer IDs to include in the replica. Example: `"0,1,2"`
- **replicaName** (string) - Required - A name for the replica.
- **returnAttachments** (boolean) - Optional - Whether to include attachments.
- **returnAttachmentsDataByUrl** (boolean) - Optional - Whether to return attachment data by URL.
- **transportType** (string) - Required - The transport type for the replica data. Example: `"esriTransportTypeURL"`
- **async** (boolean) - Optional - Whether to create the replica asynchronously.
- **syncModel** (string) - Required - The synchronization model. Example: `"perLayer"`
- **dataFormat** (string) - Required - The format of the replica data. Example: `"json"`
- **replicaOptions** (object) - Optional - Options for replica creation.

### Request Example
```json
{
  "geometry": {"xmin": -117.2037, "ymin": 33.4455, "xmax": -117.0593, "ymax": 33.569},
  "geometryType": "esriGeometryEnvelope",
  "inSR": 4326,
  "layers": "0,1,2",
  "replicaName": "shared_replica_for_project_A",
  "returnAttachments": true,
  "returnAttachmentsDataByUrl": true,
  "transportType": "esriTransportTypeURL",
  "async": false,
  "syncModel": "perLayer",
  "dataFormat": "json",
  "f": "json"
}
```

### Response
#### Success Response (200)
- **transportType** (string) - The transport type used for the replica.
- **responseType** (string) - The type of response returned.
- **URL** (string) - A URL to a JSON file containing replica metadata.

#### Response Example
```json
{
  "transportType": "esriTransportTypeUrl",
  "responseType": "esriReplicaResponseTypeData",
  "URL" : "https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example3/replicafiles/895ddf2726d14bfebfcb8576b29ee55d.json"
}
```
```

--------------------------------

### Get Info Resource (JSON)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/mission/site-info

Example of how to request information about the ArcGIS server site in JSON format. This requires constructing a URL with the 'f=json' parameter.

```url
https://machine.domain.com/webadaptor/rest/info?f=json
```

--------------------------------

### Statistic Type Examples (JSON)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/zonal-statistics-as-table

Examples of specifying different statistical summary types for raster analysis.

```json
{
  "statisticType": "ALL"
}
{
  "statisticType": "MEAN"
}
{
  "statisticType": "MAJORITY"
}
{
  "statisticType": "MAJORITY_COUNT"
}
{
  "statisticType": "MAJORITY_PERCENT"
}
{
  "statisticType": "MAXIMUM"
}
{
  "statisticType": "MEDIAN"
}
```

--------------------------------

### Ignore NoData Example (JSON)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/zonal-statistics-as-table

Example of setting the 'ignoreNodata' parameter to control how NoData values affect the analysis.

```json
{
  "ignoreNodata": true
}
```

--------------------------------

### Configuration and Query Operations

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

Operations for managing and querying configuration settings, locks, and data.

```APIDOC
## Configuration and Query Operations

### Description
Operations for managing and querying configuration settings, locks, and data.

### Endpoints
- Get Calibration Configuration
- Get Cartographic Realignment Configuration
- Query Attribute Set
- Query Edit Log
- Query Locks
- Query Lookup Table
- Query Route Associations
- Set Calibration Configuration
- Set Cartographic Realignment Configuration
```

--------------------------------

### Create Replica

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

Creates a new replica based on existing replica data. Returns metadata for the new replica.

```APIDOC
## Create Replica

### Description
Creates a new replica using provided parameters and existing replica information. The response includes the new replica ID and associated metadata.

### Method
POST

### Endpoint
/createReplica

### Parameters
#### Request Body
- **replicaName** (string) - Required - A name for the replica.
- **replicaID** (string) - Required - The ID of the replica to reference.
- **layerServerGens** (array) - Required - An array of objects, each containing 'id' and 'serverGen' for layers.
- **responseType** (string) - Optional - Specifies the response type.
- **syncModel** (string) - Optional - The synchronization model to use.

### Request Example
```json
{
  "replicaName": "Project_A_Device_ID_2500",
  "replicaID": "{043d4cbc-1faf-4d14-a293-b957d150e646}",
  "layerServerGens": [
    {
      "id": 0,
      "serverGen": 26428
    },
    {
      "id": 1,
      "serverGen": 26428
    },
    {
      "id": 2,
      "serverGen": 26428
    }
  ],
  "responseType": "esriReplicaResponseTypeInfo",
  "syncModel": "perLayer"
}
```

### Response
#### Success Response (200)
- **transportType** (string) - The transport type for the replica.
- **responseType** (string) - The response type for the replica.
- **URL** (string) - The URL to access the replica files.

#### Response Example
```json
{
  "transportType": "esriTransportTypeUrl",
  "responseType": "esriReplicaResponseTypeInfo",
  "URL" : "https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example3/replicafiles/6627df2726d14bfebfcb8576b29f6d5a2.json"
}
```
```

--------------------------------

### Example JSON Response for Successful Update Attachment

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/update-attachment

This is an example of a successful JSON response after updating an attachment. It confirms the objectId of the updated attachment and indicates success.

```json
{
  "updateAttachmentResult": {
    "objectId": 58,
    "globalId": null,
    "success": true
  }
}
```

--------------------------------

### Create Replica API

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

This section details the request and response for creating a replica. The createReplica operation is used to set up a local copy of the data for offline use. The response includes a URL to download the replica data.

```APIDOC
## Create Replica

### Description
Used to create a replica of the feature service for offline use. The response contains a URL to download the replica data and metadata.

### Method
POST

### Endpoint
`https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example1/FeatureServer/createReplica`

### Parameters
#### Query Parameters
- **f** (string) - Optional - The response format. Default is json.

#### Request Body
- **transportType** (string) - Required - Specifies the transport type, e.g., `esriTransportTypeURL`.
- **responseType** (string) - Required - Specifies the response type, e.g., `esriReplicaResponseTypeData`.
- **geometry** (object) - Required - The map extent for the replica.
- **syncModel** (string) - Required - The synchronization model, e.g., `perReplica`.
- **layers** (array) - Required - An array of layer definitions for the replica.

### Request Example
```json
{
  "transportType": "esriTransportTypeURL",
  "responseType": "esriReplicaResponseTypeData",
  "geometry": { ... },
  "syncModel": "perReplica",
  "layers": [ ... ]
}
```

### Response
#### Success Response (200)
- **transportType** (string) - The transport type used for the replica.
- **responseType** (string) - The type of response data.
- **URL** (string) - A URL to download the replica data.

#### Response Example
```json
{
  "transportType": "esriTransportTypeURL",
  "responseType": "esriReplicaResponseTypeData",
  "URL" : "https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example1/replicafiles/600ccf2726d14bfebfcb8576b29edb6f.json"
}
```
```

--------------------------------

### Create Replica (for Client Sync)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

Creates a new replica based on a shared replica definition, typically for a client device to use for independent synchronization.

```APIDOC
## POST /createReplica

### Description
Creates a new replica based on an existing shared replica definition. This is used by client devices to establish their own replica for synchronization.

### Method
POST

### Endpoint
`https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example3/FeatureServer/createReplica`

### Parameters
#### Query Parameters
- **f** (string) - Optional - The response format. Default is json.

#### Request Body
- **replicaName** (string) - Required - A unique name for the client's replica.
- **transportType** (string) - Required - The transport type for the replica data. Example: `"esriTransportTypeURL"`
- **async** (boolean) - Optional - Whether to create the replica asynchronously.
- **dataFormat** (string) - Required - The format of the replica data. Example: `"json"`
- **replicaOptions** (object) - Required - Options for replica creation, including referencing an existing replica.
  - **registerExistingData** (object)
    - **refReplicaId** (string) - Required - The ID of the shared replica to base this new replica on.
    - **refLayerServerGens** (array) - Required - An array of layer generation information from the shared replica.
      - **id** (integer) - Required - The layer ID.
      - **serverGen** (integer) - Required - The server generation number for the layer.

### Request Example
```json
{
  "replicaName": "Project_A_Device_ID_2500",
  "transportType": "esriTransportTypeURL",
  "async": false,
  "dataFormat": "json",
  "replicaOptions": {
    "registerExistingData": {
      "refReplicaId": "{9b98603c-a24e-4a74-ac5a-988d899e3393}",
      "refLayerServerGens": [
        {
          "id": 0,
          "serverGen": 26428
        },
        {
          "id": 1,
          "serverGen": 26428
        },
        {
          "id": 2,
          "serverGen": 26428
        }
      ]
    }
  },
  "f": "json"
}
```

### Response
#### Success Response (200)
- **replicaName** (string) - The name of the newly created replica.
- **replicaID** (string) - The unique ID of the newly created replica.
- **layerServerGens** (array) - Generation information for each layer in the replica.
  - **id** (integer) - The layer ID.
  - **serverGen** (integer) - The server generation number for the layer.
- **responseType** (string) - The type of response returned.
- **syncModel** (string) - The synchronization model used.
- **layers** (array) - Information about the layers included in the replica.

#### Response Example
```json
{
  "replicaName": "Project_A_Device_ID_2500",
  "replicaID": "{a1b2c3d4-e5f6-7890-1234-567890abcdef}",
  "layerServerGens": [
    {
      "id": 0,
      "serverGen": 26428
    },
    {
      "id": 1,
      "serverGen": 26428
    },
    {
      "id": 2,
      "serverGen": 26428
    }
  ],
  "responseType": "esriReplicaResponseTypeData",
  "syncModel": "perLayer",
  "layers": [
    // layer data and attachments information would be here if returnAttachments was true
  ]
}
```
```

--------------------------------

### Example Update Attachment Request Parameter

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/update-attachment

This snippet shows an example of how to specify the attachmentId parameter for updating an attachment. This parameter is crucial for identifying the specific attachment to be modified.

```text
attachmentId=58
```

--------------------------------

### Create Replica

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

Creates a replica of the feature service for a specified area and layers. This is used to set up synchronization for mobile devices or offline use.

```APIDOC
## POST /createReplica

### Description
Creates a replica of the feature service for a specified area and layers. This is used to set up synchronization for mobile devices or offline use.

### Method
POST

### Endpoint
`https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example3/FeatureServer/createReplica`

### Parameters
#### Query Parameters
- **f** (string) - Optional - The response format. Defaults to json.

#### Request Body
- **geometry** (object) - Required - The bounding box or geometry defining the area for the replica.
  - **xmin** (number) - Required - Minimum x-coordinate.
  - **ymin** (number) - Required - Minimum y-coordinate.
  - **xmax** (number) - Required - Maximum x-coordinate.
  - **ymax** (number) - Required - Maximum y-coordinate.
- **geometryType** (string) - Required - The type of geometry provided (e.g., "esriGeometryEnvelope").
- **inSR** (integer) - Required - The spatial reference system for the input geometry.
- **layerQueries** (object) - Optional - Defines specific queries for layers to include in the replica.
  - **layerID** (object) - Key is the layer ID.
    - **queryOption** (string) - Required - The option for querying the layer (e.g., "useFilter").
    - **useGeometry** (boolean) - Required - Whether to use the provided geometry for the query.
    - **where** (string) - Required - The SQL where clause for filtering data.
- **layers** (string) - Required - A comma-separated list of layer IDs to include in the replica.
- **replicaName** (string) - Required - The name of the replica.
- **returnAttachments** (boolean) - Optional - Whether to return attachments with the replica.
- **returnAttachmentsDataByUrl** (boolean) - Optional - Whether to return attachment data by URL.
- **transportType** (string) - Optional - The type of transport for the replica (e.g., "esriTransportTypeURL").
- **async** (boolean) - Optional - Whether to create the replica asynchronously.
- **syncModel** (string) - Optional - The synchronization model (e.g., "perLayer").
- **replicaOptions** (object) - Optional - Additional options for replica creation.

### Request Example
```json
{
  "geometry": {"xmin": -117.2037, "ymin": 33.4455, "xmax": -117.0593, "ymax": 33.569},
  "geometryType": "esriGeometryEnvelope",
  "inSR": 4326,
  "layerQueries": {
    "1": {
      "queryOption": "useFilter",
      "useGeometry": false,
      "where": "region = 'Southwest'"
    }
  },
  "layers": "0,1,2",
  "replicaName": "replica_for_device_25",
  "returnAttachments": true,
  "returnAttachmentsDataByUrl": true,
  "transportType": "esriTransportTypeURL",
  "async": false,
  "syncModel": "perLayer",
  "f": "json"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the replica creation operation was successful.
- **replicaId** (string) - The ID of the created replica.
- **syncConfiguration** (object) - Information about the synchronization configuration.

#### Response Example
```json
{
  "success": true,
  "replicaId": "{some-replica-id}",
  "syncConfiguration": {
    "syncVersion": "1.0"
  }
}
```
```

--------------------------------

### Unregister Replica Request Example (URL)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/unregister-replica-feature-service

This example demonstrates how to construct a URL to unregister a replica from a feature service. It requires the replicaID as a parameter. The operation is performed via a POST request.

```url
https://services.myserver.com/lidGgNLxw9LL0SbI/ArcGIS/rest/services/SaveTheBay/FeatureServer/unRegisterReplica?replicaID={b7b70c50-7b8d-4938-a6f9-61f376e94c75}
```

--------------------------------

### Create Replica

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

This section describes the JSON response structure when creating a replica for GIS services.

```APIDOC
## Create Replica

### Description
This endpoint is used to create a replica for GIS services. It returns a JSON object containing the URL of the created replica.

### Method
POST

### Endpoint
`/ArcGIS/rest/services/{serviceName}/replicafiles/{replicaId}.json`

### Parameters
This documentation is for the response body, not the request parameters.

### Request Example
(Not applicable for response documentation)

### Response
#### Success Response (200)
- **URL** (string) - The URL to access the created replica file.

#### Response Example
```json
{
  "URL" : "https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example4/replicafiles/87fe042ede17493a8cdeac0f2d062a69.json"
}
```
```

--------------------------------

### Create Replica API

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

Creates a replica of a feature service, allowing for data synchronization.

```APIDOC
## POST /createReplica

### Description
Creates a replica of a specified feature service based on provided parameters, such as geometry, layers, and replica options.

### Method
POST

### Endpoint
`https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example2/FeatureServer/createReplica`

### Parameters
#### Query Parameters
- **f** (string) - Optional - The response format. Default is json.

#### Request Body
- **geometry** (object) - Required - Defines the spatial extent for the replica. Example: `{"xmin": -117.2037, "ymin": 33.4455, "xmax": -117.0593, "ymax": 33.569}
- **geometryType** (string) - Required - The type of geometry. Example: `esriGeometryEnvelope`
- **inSR** (integer) - Required - The spatial reference of the input geometry.
- **layerQueries** (object) - Optional - Defines queries for specific layers.
- **layers** (string) - Required - Comma-separated list of layer IDs to include in the replica.
- **replicaName** (string) - Required - A unique name for the replica.
- **returnAttachments** (boolean) - Optional - Whether to include attachments in the replica.
- **returnAttachmentsDataByUrl** (boolean) - Optional - Whether to return attachment data by URL.
- **transportType** (string) - Required - The transport type for data transfer. Example: `esriTransportTypeURL`
- **async** (boolean) - Optional - Whether the operation should be asynchronous.
- **syncModel** (string) - Required - The synchronization model. Example: `perReplica`
- **dataFormat** (string) - Required - The format of the data. Example: `json`
- **replicaOptions** (object) - Optional - Additional options for replica creation.

### Request Example
```json
{
    "geometry": {"xmin": -117.2037, "ymin": 33.4455, "xmax": -117.0593, "ymax": 33.569},
    "geometryType": "esriGeometryEnvelope",
    "inSR": 4326,
    "layers": "0,1,2,3,4",
    "replicaName": "read_only_replica_for_my_iphone",
    "returnAttachments": true,
    "returnAttachmentsDataByUrl": true,
    "transportType": "esriTransportTypeURL",
    "async": false,
    "syncModel": "perReplica",
    "dataFormat": "json"
}
```

### Response
#### Success Response (200)
- **transportType** (string) - The transport type used for the replica.
- **responseType** (string) - The type of response. Example: `esriReplicaResponseTypeData`
- **URL** (string) - A URL to access the replica data.

#### Response Example
```json
{
   "transportType": "esriTransportTypeUrl",
   "responseType": "esriReplicaResponseTypeData",
   "URL" : "https://services.myserver.com/ERmEceOGq5cHrItq/ArcGIS/rest/services/example2/replicafiles/712ccg2726d14bfebfcb8576b29ecc43.json"
}
```
```

--------------------------------

### Example JSON Response with Specific Job IDs

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/mission/site-jobs

This snippet provides a concrete example of a JSON response from the jobs resource, listing actual job IDs.

```json
{
  "asyncJobs": ["jbbb0be02-74dc-46b5-ac9b-edca3619871b", "jbbb0be02-74dc-46b5-ac9b-edca3619871b"]
}
```

--------------------------------

### Synchronize Replica POST Parameters Example

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

This JSON object details the POST parameters for the synchronizeReplica operation. It includes replica ID, transport type, edit data, sync direction, and layer-specific synchronization settings.

```json
{
    "replicaID": "{043d4cbc-1faf-4d14-a293-b957d150e646}",
    "replicaServerGen": , // not set
    "transportType": "esriTransportTypeURL",
    "closeReplica": false,
    "returnIdsForAdds": true,
    "edits": <Local edits for layer 2>,
    "returnAttachmentsDataByUrl": true,
    "syncDirection": , // not set
    "async": false,
    "dataFormat": "json",
    "syncLayers":
	    [
	      {
	        "id": 0,
	        "syncDirection": "download",
	        "serverGen": 26428
    	  },
	      {
	        "id": 1,
	        "syncDirection": "download",
	        "serverGen": 26428
	      },
	      {
	        "id": 2,
	        "syncDirection": "upload",
	        "serverGen": 26428
	      }
    	],
    "f": "json"
}
```

--------------------------------

### Example Update Attachment URL

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/update-attachment

This example URL demonstrates how to construct a request to update an attachment on a feature service. It includes the base URL, service details, layer information, feature ID, and the specific operation 'updateAttachment'.

```url
https://services.myserver.com/lidGgNLxw9LL0SbI/ArcGIS/rest/services/SanFrancisco/311Incidents/FeatureServer/0/818654/updateAttachment
```

--------------------------------

### Create Replica File Content

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

Structure of the content returned in the replica file after creation. Includes replica details like name, ID, generation number, sync model, and a list of layers with their data and attachments.

```json
{
    "replicaName": "read_only_replica_for_my_iphone",
    "replicaID": "{0ddfdadf-503f-4b8c-806b-1bdb3aeba2b2}",
    "replicaServerGen": 26812,
    "responseType": "esriReplicaResponseTypeData",
    "syncModel": "perReplica",
    "layers": [
	    // data and attachments
    ]
}
```

--------------------------------

### Add Report Sensor Info Example (JSON)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/mission/add-report

Example JSON object for the 'sensorInfo' parameter, required when the 'source' is set to 'sensor'. It defines the sensor ID and triggers for report generation.

```json
{
	  "sensorId": "Flic2",
	  "triggers": ["double-press","single-press"]
	}
```

--------------------------------

### JSON Response Example for Report Addition

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/mission/add-report

This is an example of a successful JSON response returned after submitting a sensor report. It includes a unique report ID, a success status, and the template ID used for the report.

```json
{
  "reportId": "a4d4228234af47978f787e75e7691498",
  "success": true,
  "templateId": "2fc4192579224368b2ac87d492392f66"
}
```

--------------------------------

### Example JSON Response for a GIS Diagram

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/unlock-diagram

This is a concrete example of a JSON response for a GIS diagram named 'ESTANCIA'. It populates the fields defined in the syntax with specific values, demonstrating how actual data would be represented. The 'extent' field includes detailed spatial reference information.

```json
{
  "name" : "ESTANCIA",
  "id" : "0-334",
  "templateIdentifier" : "0",
  "templateObjectID" : 3204,
  "schematicLayerIdentifier" : 0,
  "folderObjectID" : 1,
  "folderIdentifier" : "1",
  "objectID" : 334,
  "createdBy" : "NCA3885",
  "lastModificationBy" : "ABL4732",
  "lastUpdateBy" : "",
  "creationDate" : "01/21/2011 16:07:46",
  "lastModificationDate" : "02/14/2011 18:34:46",
  "lastUpdateDate" : "",
  "lockedBy" : "",
  "version" : "",
  "extent" : {
    "xmin" : 6.0370819091796868,
    "ymin" : -8.059234619140625,
    "xmax" : 29.909512329101563,
    "ymax" : 11.059844970703125,
    "spatialReference" : {
      "wkt" : "{B286C06B-0879-11D2-AACA-00C04FA33C20}"
    }
  },
  "rootNodes" : [
    "115"
  ],
  "endNodes" : [
  ]
}
```

--------------------------------

### Version Management

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

Operations for reconciling and updating versions.

```APIDOC
## Version Management

### Description
Operations for reconciling and updating versions.

### Endpoints
- Reconcile Version
- Update Measures From LRS
```

--------------------------------

### Add Report onReceiveAction Example (JSON)

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/mission/add-report

Example JSON object for the 'onReceiveAction' parameter, defining client actions upon report submission for different ArcGIS clients like Mission Manager and Mission Responder.

```json
{
		  "arcgisMissionManager": {
			"map": ["zoomToFeature", "showFeaturePopup", "animateFeatureSymbol"],
			"device": ["alert.mp4"]
		  },
		  "arcgisMissionResponder": {
			"map": ["zoomToFeature"],
			"device": ["vibrate-3", "notification"]
		  }
		}
```

--------------------------------

### Create Replica POST Parameters

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/enterprise/sync-workflow-examples

Defines the parameters required to create a replica of a feature service. This includes spatial extent, layer selection, replica naming, and transport/data format options. It supports creating read-only replicas for mobile devices.

```json
{
    "geometry": {"xmin": -117.2037, "ymin": 33.4455, "xmax": -117.0593, "ymax": 33.569},
    "geometryType": "esriGeometryEnvelope",
    "inSR": 4326,
    "layerQueries": null,
    "layers": "0,1,2,3,4",
    "replicaName": "read_only_replica_for_my_iphone",
    "returnAttachments": true,
    "returnAttachmentsDataByUrl": true,
    "transportType": "esriTransportTypeURL",
    "async": false,
    "syncModel": "perReplica",
    "dataFormat": "json",
    "replicaOptions": null,
    "f": "json"
}
```

--------------------------------

### Define Mission Capabilities Example

Source: https://gis.maine.gov/mapservices/help/en/rest/services-reference/mission/services-create-mission-service

An example demonstrating how to specify desired capabilities for a Mission Service using a comma-separated list. This snippet illustrates setting capabilities for chat, track, and task functionalities.

```text
capabilities=CHAT,TRACK,TASK
```
Tokens:
Raw