- URL:
- https://<root>/services/<ServiceName>.<ServiceType>
- Methods:
GET- Operations:
- Start Service, Stop Service, Edit Service, Change Provider, Delete Service
- Child Resources:
- Status, Item Info, Scaling, Placement Policy, Webhooks, Jobs
- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The resource for an individual service, exposing GIS resources such as maps, rasters, locators, geodatabases through REST, and SOAP interfaces. The type of the service is often dictated by the type of resources being published. In addition to accessing the underlying resource, a GIS service can expose additional capabilities known as extensions (or server object extensions). Extensions are packages of custom functionality that can perform business logic or expose the service through additional formats or protocols.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the service resource:
https://organization.example.com/<context>/admin/services/CommercialDamageAssessment.FeatureServer?f=pjsonJSON Response example
{
"allowedUploadFileTypes": "",
"private": false,
"maxUsageTime": 600,
"description": "",
"maxInstancesPerNode": 0,
"minInstancesPerNode": 0,
"datasets": [],
"type": "FeatureServer",
"frameworkProperties": {},
"instancesPerContainer": 1,
"recycleStartTime": "00:00",
"maxUploadFileSize": 0,
"provider": "SDS",
"clusterName": "default",
"deploymentId": "kutph67xzwc7icetczsvy",
"id": "sssw86gd63v6mh5c140un",
"maxStartupTime": 300,
"capabilities": "Query",
"maxWaitTime": 60,
"recycleInterval": 24,
"jsonProperties": {
"allowGeometryUpdates": true,
"adminServiceInfo": {
"database": {
"datasource": {
"name": "/enterpriseDatabases/b5ca50d1-34bf-4da2-b6fb-5b9dc44be9cd"
}
},
"name": "CommercialDamageAssessment",
"type": "FeatureServer",
"status": "Started"
},
"supportsApplyEditsWithGlobalIds": false,
"maxRecordCount": 2000,
"description": "",
"units": "esriMeters",
"maxViewsCount": 20,
"syncEnabled": false,
"hasVersionedData": false,
"layers": {
"0": {
"isCoGoEnabled": false,
"extent": {
"ymin": -5296763.491700001,
"xmin": 1.28926565275E7,
"ymax": -2181479.3775999993,
"xmax": 1.70689846678E7,
"spatialReference": {
"falseM": -100000,
"xyTolerance": 0.001,
"mUnits": 10000,
"zUnits": 40000,
"latestWkid": 3857,
"zTolerance": 2.0E-4,
"wkid": 102100,
"xyUnits": 10000,
"mTolerance": 0.001,
"falseX": -20037700,
"falseY": -30241100,
"falseZ": -100000
}
},
"isDataBranchVersioned": false,
"supportsApplyEditsWithGlobalIds": false,
"maxRecordCount": 2000,
"datesInUnknownTimezone": false,
"type": "Feature Layer",
"onlyAllowTrueCurveUpdatesByTrueCurveClients": true,
"relationships": [],
"cimVersion": "2.7.0",
"isDataArchived": false,
"id": 0,
"supportsStatistics": true,
"standardMaxRecordCount": 32000,
"isDataVersioned": false,
"templates": [
{
"name": "aus_majorcities",
"description": "",
"drawingTool": "esriFeatureEditToolPoint",
"prototype": {"attributes": {
"aa_final_": null,
"aa_final_i": null,
"year": null,
"perimeter": null,
"name": null,
"name1": null,
"diak_cde": null,
"status": null,
"sde_gn_aa_city_area": null,
"diak_cde1": null,
"fips_cntry": null,
"populat": null
}
}
}
],
"hasGeometryProperties": true,
"supportsAdvancedQueries": true,
"parentLayer": null,
"currentVersion": 10.9,
"canScaleSymbols": false,
"hasZ": true,
"advancedEditingCapabilities": {"supportedSqlFormatsInCalculate": ["standard"]},
"objectIdField": "objectid",
"name": "aus_majorcities",
"allowTrueCurvesUpdates": false,
"displayField": "name",
"supportsCalculate": true,
"fields": [
{
"nullable": false,
"defaultValue": null,
"editable": false,
"typeName": "int4",
"length": 4,
"type": "esriFieldTypeOID",
"modelName": "OBJECTID",
"sqlType": "sqlTypeInteger",
"adminFieldInfo": {"uniqueValueGenerator": {"function": true}},
"domain": null,
"name": "objectid",
"alias": "OBJECTID",
"sqlTypeCode": 4
},
{
"modelName": "CITY_area",
"sqlType": "sqlTypeNumeric",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "city_area",
"typeName": "numeric",
"length": 38,
"alias": "CITY_area",
"type": "esriFieldTypeDouble",
"sqlTypeCode": 2
},
{
"modelName": "perimeter",
"sqlType": "sqlTypeNumeric",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "perimeter",
"typeName": "numeric",
"length": 38,
"alias": "perimeter",
"type": "esriFieldTypeDouble",
"sqlTypeCode": 2
},
{
"modelName": "aa_final_",
"sqlType": "sqlTypeNumeric",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "aa_final_",
"typeName": "numeric",
"length": 38,
"alias": "aa_final_",
"type": "esriFieldTypeDouble",
"sqlTypeCode": 2
},
{
"modelName": "aa_final_i",
"sqlType": "sqlTypeNumeric",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "aa_final_i",
"typeName": "numeric",
"length": 38,
"alias": "aa_final_i",
"type": "esriFieldTypeDouble",
"sqlTypeCode": 2
},
{
"modelName": "name",
"sqlType": "sqlTypeVarchar",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "name",
"length": 30,
"typeName": "varchar",
"alias": "name",
"type": "esriFieldTypeString",
"sqlTypeCode": 12
},
{
"modelName": "diak_cde",
"sqlType": "sqlTypeVarchar",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "diak_cde",
"length": 20,
"typeName": "varchar",
"alias": "diak_cde",
"type": "esriFieldTypeString",
"sqlTypeCode": 12
},
{
"modelName": "name1",
"sqlType": "sqlTypeVarchar",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "name1",
"length": 30,
"typeName": "varchar",
"alias": "name1",
"type": "esriFieldTypeString",
"sqlTypeCode": 12
},
{
"modelName": "diak_cde1",
"sqlType": "sqlTypeVarchar",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "diak_cde1",
"length": 20,
"typeName": "varchar",
"alias": "diak_cde1",
"type": "esriFieldTypeString",
"sqlTypeCode": 12
},
{
"modelName": "fips_cntry",
"sqlType": "sqlTypeVarchar",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "fips_cntry",
"length": 2,
"typeName": "varchar",
"alias": "fips_cntry",
"type": "esriFieldTypeString",
"sqlTypeCode": 12
},
{
"modelName": "populat",
"sqlType": "sqlTypeNumeric",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "populat",
"typeName": "numeric",
"length": 38,
"alias": "populat",
"type": "esriFieldTypeDouble",
"sqlTypeCode": 2
},
{
"modelName": "year",
"sqlType": "sqlTypeNumeric",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "year",
"typeName": "numeric",
"length": 38,
"alias": "year",
"type": "esriFieldTypeDouble",
"sqlTypeCode": 2
},
{
"modelName": "status",
"sqlType": "sqlTypeVarchar",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "status",
"length": 25,
"typeName": "varchar",
"alias": "status",
"type": "esriFieldTypeString",
"sqlTypeCode": 12
}
],
"maxRecordCountFactor": 1,
"dateFieldsTimeReference": {
"respectsDaylightSaving": false,
"timeZone": "UTC"
},
"hasM": false,
"allowGeometryUpdates": true,
"useStandardizedQueries": true,
"globalIdField": null,
"description": "",
"syncCanReturnChanges": false,
"supportsRollbackOnFailureParameter": true,
"isDataReplicaTracked": false,
"standardMaxRecordCountNoGeometry": 32000,
"indexes": [
{
"name": "r23_sde_rowid_uk",
"isUnique": true,
"description": "",
"fields": "objectid",
"isAscending": true
},
{
"name": "a12_ix1",
"isUnique": true,
"description": "",
"fields": "shape",
"isAscending": true
}
],
"editFieldsInfo": null,
"htmlPopupType": "esriServerHTMLPopupTypeAsHTMLText",
"minScale": 0,
"hasAttachments": false,
"advancedQueryCapabilities": {
"supportsStatistics": true,
"supportsSqlExpression": true,
"supportsQueryWithResultType": true,
"supportsTrueCurve": true,
"supportsOrderBy": true,
"supportsQueryWithDistance": true,
"supportsLod": false,
"supportsQueryWithDatumTransformation": true,
"supportsCountDistinct": true,
"supportsReturningQueryExtent": true,
"supportsQueryWithLodSR": false,
"supportsPagination": true,
"supportsDistinct": true,
"supportsReturningGeometryCentroid": false,
"supportsPercentileStatistics": true,
"supportsHavingClause": true
},
"supportsValidateSQL": true,
"enableZDefaults": true,
"serviceItemId": "94eebec4bc1c4405ad3b2c252a39f29c",
"allowUpdateWithoutMValues": true,
"supportsCoordinatesQuantization": true,
"types": [],
"capabilities": "Query",
"maxScale": 0,
"defaultVisibility": true,
"hasMetadata": true,
"tileMaxRecordCount": 8000,
"typeIdField": "",
"supportsASyncCalculate": true,
"supportsVCSProjection": true,
"supportedQueryFormats": "JSON",
"drawingInfo": {
"renderer": {
"symbol": {
"outline": {
"color": [
0,
0,
0,
255
],
"width": 0.7
},
"color": [
146,
147,
60,
255
],
"size": 4,
"yoffset": 0,
"xoffset": 0,
"angle": 0,
"style": "esriSMSCircle",
"type": "esriSMS"
},
"type": "simple"
},
"scaleSymbols": true,
"transparency": 0,
"labelingInfo": null
},
"geometryField": {
"modelName": "SHAPE",
"nullable": true,
"editable": true,
"defaultValue": null,
"domain": null,
"name": "shape",
"alias": "SHAPE",
"type": "esriFieldTypeGeometry"
},
"copyrightText": "",
"zDefault": 0,
"geometryType": "esriGeometryPoint",
"adminLayerInfo": {
"syncEnabled": false,
"typesBasedOnSubtypes": false,
"tableExtent": {
"ymin": -5296763.491700001,
"xmin": 1.28926565275E7,
"ymax": -2181479.3775999993,
"xmax": 1.70689846678E7,
"spatialReference": {
"wkt": "...",
"falseM": -100000,
"mUnits": 10000,
"zUnits": 10000,
"zTolerance": 0.001,
"wkid": 3857,
"sdesrid": 3857,
"xyUnits": 10000,
"mTolerance": 0.001,
"falseX": -20037700,
"falseY": -30241100,
"falseZ": -100000
}
},
"geometryField": {
"sqlType": "sqlTypeDistinct",
"nullable": true,
"editable": true,
"name": "shape",
"typeName": "st_point",
"length": 2147483647,
"type": "",
"sqlTypeCode": 2001
},
"xssTrustedFields": [],
"tableName": "aus_majorcities"
},
"ogcGeometryType": ["POINT"]
}},
"spatialReference": {
"latestWkid": 3857,
"wkid": 102100
},
"layerIds": ["0"],
"fullExtent": {
"ymin": -5296763.491700001,
"xmin": 1.28926565275E7,
"ymax": -2181479.3775999993,
"xmax": 1.70689846678E7,
"spatialReference": {
"latestWkid": 3857,
"wkid": 102100
}
},
"enableZDefaults": true,
"serviceItemId": "94eebec4bc1c4405ad3b2c252a39f29c",
"allowUpdateWithoutMValues": true,
"capabilities": "Query",
"xssPreventionInfo": {
"xssInputRule": "rejectInvalid",
"xssPreventionRule": "input",
"xssPreventionEnabled": true
},
"supportsDisconnectedEditing": false,
"currentVersion": 10.3,
"supportedQueryFormats": "JSON",
"datumTransformations": [
{
"fromSR": {
"latestWkid": 4326,
"wkid": 4326
},
"transformJson": "",
"transformDirection": "forward",
"wkid": 108190,
"toSR": {
"latestWkid": 4269,
"wkid": 4269
}
},
{
"fromSR": {
"latestWkid": 4326,
"wkid": 4326
},
"transformJson": "",
"transformDirection": "reverse",
"wkid": 108190,
"toSR": {
"latestWkid": 4269,
"wkid": 4269
}
}
],
"initialExtent": {
"ymin": -5849363.420427503,
"xmin": 1.1788729584173871E7,
"ymax": -1628879.448849326,
"xmax": 1.817291161114496E7,
"spatialReference": {
"latestWkid": 3857,
"wkid": 102100
}
},
"serviceDescription": "",
"editorTrackingInfo": {
"allowOthersToUpdate": true,
"enableEditorTracking": false,
"allowOthersToDelete": false,
"allowOthersToQuery": true,
"enableOwnershipAccessControl": false
},
"isMultiServicesView": false,
"copyrightText": "",
"zDefault": 0
},
"maxIdleTime": 1800,
"serviceName": "CommercialDamageAssessment",
"loadBalancing": "ROUND_ROBIN",
"keepAliveInterval": 1800,
"configuredState": "STARTED",
"isDefault": false,
"extensions": [],
"isolationLevel": "HIGH",
"folderName": "Hosted",
"properties": {
"enableZDefaults": "true",
"allowUpdateWithoutMValues": "true",
"outputDir": "/arcgisusr/directories/arcgisoutput",
"maxScale": "4513.9887049999998",
"allowGeometryUpdates": "true",
"maxRecordCount": "2000",
"supportedImageReturnTypes": "MIME",
"clientCachingAllowed": "true",
"antialiasingMode": "Best",
"onlyAllowTrueCurveUpdatesByTrueCurveClients": "false",
"userName": "administrator",
"textAntialiasingMode": "Force",
"isCached": "false",
"maxExportTilesCount": "100000",
"virtualOutputDir": "/rest/directories/0123456789abcdef/arcgisoutput",
"exportTilesAllowed": "false",
"ignoreCache": "false",
"cacheOnDemand": "false",
"portalURL": "https://reverseproxy.example.com/gis/",
"allowTrueCurvesUpdates": "false",
"zDefaultValue": "0",
"minScale": "22996637.919871442"
},
"portalProperties": {
"isHosted": true,
"portalItems": [
{
"itemID": "94eebec4bc1c4405ad3b2c252a39f29c",
"type": "FeatureServer"
}
]
}
}