arcrest.hostedservice package

Submodules

arcrest.hostedservice.service module

class arcrest.hostedservice.service.AdminFeatureService(url, securityHandler, initialize=False, proxy_url=None, proxy_port=None)

Bases: arcrest._abstract.abstract.BaseAGOLClass

A feature service can contain datasets (e.g. tables, views) with and without a spatial column. Datasets with a spatial column are considered layers and without a spatial column are considered tables. A feature service allows clients to query and edit feature geometry and attributes.

This resource provides basic information about the feature service including the feature layers and tables that it contains, the service description, etc. The administrative feature service resource maintains a set of operations that manage the state and contents of the service. Note, query and edit operations are not available via the adminstrative resource.

addToDefinition(json_dict)

The addToDefinition operation supports adding a definition property to a hosted feature service. The result of this operation is a response indicating success or failure with error code and description.

This function will allow users to change add additional values to an already published service.

Input:

json_dict - part to add to host service. The part format can

be derived from the asDictionary property. For layer level modifications, run updates on each individual feature service layer object.

Output:

JSON message as dictionary

adminServiceInfo

returns the admin service information

allowGeometryUpdates

informs the user if the data allows geometry updates

asDictionary

returns the feature service as a dictionary object

capabilities

returns a list of capabilities

copyrightText

returns the copyright text

currentVersion

returns the map service current version

deleteFromDefinition(json_dict)

The deleteFromDefinition operation supports deleting a definition property from a hosted feature service. The result of this operation is a response indicating success or failure with error code and description. See: http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Delete_From_Definition_Feature_Service/02r30000021w000000/ for additional information on this function. Input:

json_dict - part to add to host service. The part format can

be derived from the asDictionary property. For layer level modifications, run updates on each individual feature service layer object. Only include the items you want to remove from the FeatureService or layer.

Output:

JSON Message as dictionary

description

returns the service description

editorTrackingInfo

enableZDefaults

returns the layers for a service

error

gets the error message

fullExtent

returns the full extent of the feature service

hasStaticData

hasVersionedData

returns boolean for versioned data

initialExtent

returns the initial extent of the feature service

json

returns boolean is disconnecting editted supported

layers

returns the layers for a service

maxRecordCount

returns the max record count

refresh()

refreshes a service

securityHandler

returns the security handler

serviceDescription

returns the serviceDescription of the map service

serviceItemId

gets the property value for serviceItemId

size

returns the size parameter

spatialReference

returns the spatial reference

status

returns the service status

supportedQueryFormats

supportsApplyEditsWithGlobalIds

gets the property value for supportsApplyEditsWithGlobalIds

supportsDisconnectedEditing

returns boolean is disconnecting editted supported

syncCapabilities

type of sync that can be performed

syncEnabled

informs the user if sync of data can be performed

tables

returns the layers for a service

units

returns the measurement unit

updateDefinition(json_dict)

The updateDefinition operation supports updating a definition property in a hosted feature service. The result of this operation is a response indicating success or failure with error code and description.

Input:

json_dict - part to add to host service. The part format can

be derived from the asDictionary property. For layer level modifications, run updates on each individual feature service layer object.

Output:

JSON Message as dictionary

url

returns boolean is disconnecting editted supported

xssPreventionInfo

returns the xssPreventionInfo information

class arcrest.hostedservice.service.AdminFeatureServiceLayer(url, securityHandler, initialize=False, proxy_url=None, proxy_port=None)

Bases: arcrest._abstract.abstract.BaseAGOLClass

The layer resource represents a single feature layer or a non spatial table in a feature service. A feature layer is a table or view with at least one spatial column. For tables, it provides basic information about the table such as its id, name, fields, types and templates. For feature layers, in addition to the table information above, it provides information such as its geometry type, min and max scales, and spatial reference. Each type includes information about the type such as the type id, name, and definition expression. Sub-types also include a default symbol and a list of feature templates. Each feature template includes a template name, description and a prototypical feature. The property supportsRollbackOnFailures will be true to indicate the support for transactional edits. The property maxRecordCount returns the maximum number of records that will be returned at once for a query. The property capabilities returns Query, Create, Delete, Update, and Editing capabilities. The Editing capability will be included if Create, Delete or Update is enabled for a Feature Service. Note, query and edit operations are not available on a layer in the adminstrative view.

addToDefinition(json_dict)

The addToDefinition operation supports adding a definition property to a hosted feature service. The result of this operation is a response indicating success or failure with error code and description.

This function will allow users to change add additional values to an already published service.

Input:

json_dict - part to add to host service. The part format can

be derived from the asDictionary property. For layer level modifications, run updates on each individual feature service layer object.

Output:

JSON message as dictionary

adminLayerInfo

advancedQueryCapabilities

returns the advanced query capabilities

allowGeometryUpdates

returns boolean if geometry updates are allowed

canModifyLayer

canScaleSymbols

capabilities

copyrightText

returns the copyright text

currentVersion

returns the current version

dateFieldsTimeReference

defaultVisibility

definitionExpression

returns the definitionExpression

definitionQuery

deleteFromDefinition(json_dict)

The deleteFromDefinition operation supports deleting a definition property from a hosted feature service. The result of this operation is a response indicating success or failure with error code and description. See: http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Delete_From_Definition_Feature_Service/02r30000021w000000/ for additional information on this function. Input:

json_dict - part to add to host service. The part format can

be derived from the asDictionary property. For layer level modifications, run updates on each individual feature service layer object. Only include the items you want to remove from the FeatureService or layer.

Output:

JSON Message as dictionary

description

returns the layer’s description

displayField

drawingInfo

editFieldsInfo

returns the edit fields information

editingInfo

gets the editingInfo value

effectiveMaxScale

effectiveMinScale

enableZDefaults

error

returns error message if error occurs

exceedsLimitFactor

extent

fields

geometryType

returns the geometry type

globalIdField

returns the global id field

hasAttachments

hasLabels

hasM

returns if it has a m value or not

hasStaticData

boolean T/F if static data is present

hasZ

returns if it has a Z value or not

htmlPopupType

id

returns the id

indexes

gets the indexes

isDataVersioned

loadAttributes(json_dict)

maxRecordCount

maxRecordCountFactor

gets the property value for maxRecordCountFactor

maxScale

sets the max scale

minScale

minimum scale layer will show

name

returns the name

objectIdField

ogcGeometryType

ownershipBasedAccessControlForFeatures

parentLayer

returns information about the parent

refresh()

refreshes a service

relationships

securityHandler

returns the current security handler

serviceItemId

returns the current security handler

standardMaxRecordCount

gets the property value for standardMaxRecordCount

subLayers

returns sublayers for layer

supportedQueryFormats

supportsAdvancedQueries

supportsApplyEditsWithGlobalIds

gets the property value for supportsApplyEditsWithGlobalIds

supportsAttachmentsByUploadId

gets the supportsAttachmentsByUploadId value

supportsCalculate

gets the supportsCalculate value

supportsCoordinatesQuantization

gets the supportsCoordinatesQuantization value

supportsRollbackOnFailureParameter

returns if rollback on failure supported

supportsStatistics

supportsValidateSQL

returns the current security handler

supportsValidateSql

gets the support validate sql value

syncCanReturnChanges

templates

gets the template

tileMaxRecordCount

gets the property value for tileMaxRecordCount

timeInfo

type

returns the type

typeIdField

types

updateDefinition(json_dict)

The updateDefinition operation supports updating a definition property in a hosted feature service. The result of this operation is a response indicating success or failure with error code and description.

Input:

json_dict - part to add to host service. The part format can

be derived from the asDictionary property. For layer level modifications, run updates on each individual feature service layer object.

Output:

JSON Message as dictionary

useStandardizedQueries

zDefault

class arcrest.hostedservice.service.AdminMapService(url, securityHandler, initialize=False, proxy_url=None, proxy_port=None)

Bases: arcrest._abstract.abstract.BaseAGOLClass

A map service offer access to map and layer content.

The REST API administrative map service resource represents a map service. This resource provides basic information about the map, including the layers that it contains, whether the map is cached or not, its spatial reference, initial and full extents, etc... The administrative map service resource maintains a set of operations that manage the state and contents of the service.

access

gets the access

cacheExecutionStatus

gets the cacheExecutionStatus

cancelJob(jobId)

The cancel job operation supports cancelling a job while update tiles is running from a hosted feature service. The result of this operation is a response indicating success or failure with error code and description.

Inputs:

jobId - jobId to cancel

count

gets the count

created

gets the created

currentJob

gets the currentJob

editTileService(serviceDefinition=None, minScale=None, maxScale=None, sourceItemId=None, exportTilesAllowed=False, maxExportTileCount=100000)

This post operation updates a Tile Service’s properties

Inputs:

serviceDefinition - updates a service definition minScale - sets the services minimum scale for caching maxScale - sets the service’s maximum scale for caching sourceItemId - The Source Item ID is the GeoWarehouse Item ID of the map service exportTilesAllowed - sets the value to let users export tiles maxExportTileCount - sets the maximum amount of tiles to be exported

from a single call.

exportTilesAllowed

gets the exportTilesAllowed

fullExtent

gets the fullExtent

id

gets the id

initialExtent

gets the initialExtent

jobStatistics(jobId)

The delete job operation supports deleting a job from a hosted map service. The result of this operation is a response indicating success or failure with error code and description.

jobStatus

gets the jobStatus

jobs

gets the jobs

lodInfos

gets the lodInfos

maxExportTilesCount

gets the maxExportTilesCount

maxScale

gets the maxScale

minScale

gets the minScale

modified

gets the modified

name

gets the name

readonly

returns the readonly property

refresh(serviceDefinition=True)

The refresh operation refreshes a service, which clears the web server cache for the service.

resampling

returns the resampling property

securityHandler

returns the current security handler

serverId

gets the serverId

size

gets the size

sourceType

gets the sourceType

status

returns the service status

tileInfo

gets the tileInfo

type

gets the type

urlService

gets the url

class arcrest.hostedservice.service.Services(url, securityHandler, initialize=False, proxy_url=None, proxy_port=None)

Bases: arcrest._abstract.abstract.BaseAGOLClass

The administration resource is the root node and initial entry point into a Spatial Data Server adminstrative interface. This resource represents a catalog of data sources and services published on the host. The current version and type of the server is also returned in the response. The value of the version is a number such that its value at a future release is guaranteed to be greater than its value at a previous release. Inputs:

url - url to service admin site: http://<web server hostname>/arcgis/rest/admin securityHandler - AGOL/Portal

currentVersion

returns the software’s current version

description

returns the description property

folderName

returns the folder name

folders

returns the service folders

resources

list of all resources on the AGOL site

securityHandler

gets the security handler

serverType

returns the server type

services

returns all the service objects in the admin service’s page

Module contents