Copy To Data Store

URL:: https://<geoanalytics-url>/CopyToDataStore
Methods:: GET
Version Introduced:: 10.5

Description

The CopyToDataStore operation takes an input layer and copies it to a data store. Data is copied to ArcGIS Data Store, configured as either a relational or spatiotemporal big data store.

For example, you could copy features that are stored in a big data file share to a relational data store, and specify that only features within the current map extent be copied. This would create a hosted feature service with only those features within the specified map extent.

Request parameters

Parameter	Details
`inputLayer` (Required)	The table, point, line, or polygon features that will be copied. Syntax: As described in Feature input, this parameter can be one of the following: A URL to a feature service layer with an optional filter to select specific features A URL to a big data catalog service layer with an optional filter to select specific features A feature collection REST examples Use dark colors for code blocksCopy `1 2 3 4 //REST web example {"url":"https://myportal.domain.com/server/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter": "Month = 'September'"} //REST scripting example "inputLayer": {"url":"https://myportal.domain.com/server/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter": "Month = 'September'"}`
`outputName` (Required)	The task will create a feature service of the results. You define the name of the service. REST examples Use dark colors for code blocksCopy `1 2 3 4 //REST web example myOutput //REST scripting example "outputName": "myOutput"`
`context` (Optional)	The `context` parameter contains additional settings that affect task execution. For this task, there are five settings: Extent (`extent` )—A bounding box that defines the analysis area. Only those features that intersect the bounding box will be analyzed. Processing spatial reference (`processSR` )—The features will be projected into this coordinate system for analysis. Output spatial reference (`outSR` )—The features will be projected into this coordinate system after the analysis to be saved. The output spatial reference for the spatiotemporal big data store is always WGS84. Data store (`dataStore` )—Results will be saved to the specified data store. The default is the spatiotemporal big data store. Default aggregation styles (`defaultAggregationStyles` )—If set to `true` , results will have square, hexagon, and triangle aggregation styles enabled on results map services. Syntax: Use dark colors for code blocksCopy `1 2 3 4 5 6 7 { "extent": {extent}, "processSR": {spatial reference}, "outSR": {spatial reference}, "dataStore": {data store}, "defaultAggregationStyles": {true\|false} }`
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

Example usage

Below is a sample request URL for CopyToDataStore:

Use dark colors for code blocksCopy
https://hostname.domain.com/webadaptor/rest/services/System/GeoAnalyticsTools/GPServer/CopyToDataStore/submitJob?inputLayer={"url":"https://hostname.domain.com/webadaptor/rest/services/Hurricane/hurricaneTrack/0"}&outputName=myOutput&context={"extent":{"xmin":-122.68,"ymin":45.53,"xmax":-122.45,"ymax":45.6,"spatialReference":{"wkid":4326}}}&f=json

Response

When you submit a request, the service assigns a unique job ID for the transaction.

Syntax:

Use dark colors for code blocksCopy
{
  "jobId": "<unique job identifier>",
  "jobStatus": "<job status>"
}

After the initial request is submitted, you can use jobId to periodically check the status of the job and messages as described in Check job status. Once the job has successfully completed, use jobId to retrieve the results. To track the status, you can make a request of the following form:

Use dark colors for code blocksCopy
https://<analysis url>/CopyToDataStore/jobs/<jobId>

Access results

When the status of the job request is esriJobSucceeded , you can access the results of the analysis by making a request of the following form:

Use dark colors for code blocksCopy
https://<analysis-url>/CopyToDataStore/jobs/<jobId>/results/output?token=<your token>&f=json

Response Description

Response	Description
`output`	The `output` parameter will contain the copied features. Use dark colors for code blocksCopy `1 {"url": "https://<analysis-url>/CopyToDataStore/jobs/<jobId>/results/output"}` The result has properties for parameter name, data type, and value. The contents of `value` depend on the `outputName` parameter provided in the initial request. The `value` contains the URL of the feature service layer. Use dark colors for code blocksCopy `1 2 3 4 5 { "paramName": "output", "dataType": "GPRecordSet", "value":{"url": "<hosted featureservice layer url>"} }` See Feature output for more information about how the result layer is accessed.

output

The output parameter will contain the copied features.

Use dark colors for code blocksCopy
{"url": "https://<analysis-url>/CopyToDataStore/jobs/<jobId>/results/output"}

The result has properties for parameter name, data type, and value. The contents of value depend on the outputName parameter provided in the initial request. The value contains the URL of the feature service layer.

Use dark colors for code blocksCopy
{
  "paramName": "output",
  "dataType": "GPRecordSet",
  "value":{"url": "<hosted featureservice layer url>"}
}

See Feature output for more information about how the result layer is accessed.