Data item | ArcGIS REST APIs

URL:: https://<root>/data/items/<dataItem>
Methods:: GET
Version Introduced:: 12.0

Description

A resource for an individual data item returns information for specific data registered with the server. The set of data items registered with the server comprises the server's data store.

A data item contains all the information required by the server to connect to a folder or database while serving out one or more video services. Data items are extensively used while publishing video services to the server, as they inform the publishing client (ArcGIS Pro and ArcGIS Excalibur) whether the data needs to be explicitly copied to the server or whether it can be referred from the server. The server supports the following types of data items:

Spatiotemporal Big data stores
Cloud stores
File shares
Object stores (listed as the nosql type)

Request parameters

Parameter Details

Parameter	Details
`f` (Required)	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`
`token` (Required)	Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

f

(Required)

The response format. The default format is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

Response properties

Property	Details
`path`	A unique identifier for each data item when it's registered with the server.
`type`	Specifies the type of the data item. Values: `folder` \| `objectStore` \| `nosql` \| `cloudStore`
`clientPath`	The client path for replicated folders.
`provider`	The `provider` property only appears for cloud stores. This will show the cloud provider associated with a given data item.
`info`	A JSON object containing the connection string or file system path to the data item: `path`—The file system path to the data item. `clientConnectionString`—The connection string for the client to connect to a shared enterprise database. `connectionString`—The connection string for ArcGIS Video Server to connect to an enterprise database. `dataStoreConnectionType`—Indicates to the server whether the data item is `shared`, `replicated`, or `server` only. `isManaged`—Set to `true` if `dataStoreConnectionType` is set to `server`, indicating that the data store is managed by ArcGIS Video Server. Otherwise, `isManaged` is set to `false` by default.

Example usage

The following is a sample request URL used to access an individual data item resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/data/8f1fb939-b32b-40e6-9860-2bf5d6538a93?f=pjson

JSON Response syntax

The following is a sample JSON response for a data item. The exact JSON response returned from a data item resource depends on the type of data item being inspected.

Use dark colors for code blocksCopy
{
  "path": "<unique path on the server>",
  "type": "<folder|objectStore|nosql|cloudStore>",
  "clientPath": "<client paths for replicated folders>",
  "info": {
    "path": "<path to the folder>",
    "clientConnectionString": "<connection string for client to connect to shared enterprise database>",
    "connectionString": "<connection string for server to connect to enterprise database>",
    "dataStoreConnectionType": "<shared|replicated|serverOnly>",
    "isManaged": <true|false>
  }
}

JSON Response example

The sections below demonstrate the format of various data items supported by ArcGIS Video Server.

Cloud store

The example response below demonstrates an Amazon AWS S3 Bucket cloud store data item:

Use dark colors for code blocksCopy
{
    "path": "/cloudStores/cloudstore_sample",
    "provider": "amazon",
    "name": "cloudstore_sample",
    "id": "f52716eb6f564414b591f28daf9b111d",
    "type": "cloudStore",
    "info": {
        "connectionString": "<encrypted_connection_string>",
        "objectStore": "sampleName",
        "portalProperties": {"itemID": "f52716eb6f564414b591f28daf9b111d"},
        "isManaged": false
    }
}

Spatiotemporal Big Data Store

The example response below demonstrates a spatiotemporal big data store item:

Use dark colors for code blocksCopy
{
    "path": "/nosqlDatabases/AGSDataStore_bigdata_bds_sample",
    "provider": "ArcGIS Data Store",
    "name": "bds_sample",
    "childItems": [],
    "id": "6a6acb81-492c-416c-bfbf-feb3b8fa845f",
    "type": "nosql",
    "info": {
        "isManagedData": true,
        "connectionString": "<connection string with encrypted passwords>",
        "clusterUUID": "WnHClaBTSWOYfTsbj5HKLw",
        "factory": "nosql",
        "clusterFinalized": true,
        "implementation": "Opensearch",
        "systemManaged": true,
        "datastoreName": "bds_sample",
        "adminKey": "<encrypted key>",
        "httpScheme": "HTTPS_ONLY",
        "datastoreAlias": "agsbigdatastore-1",
        "users": [
            {
                "password": "<encrypted_password>",
                "role": "admin",
                "username": "username"
            },
            {
                "password": "<encrypted_password>",
                "role": "arcgis",
                "username": "username"
            }
        ],
        "isManaged": true,
        "nodePem": "<encrypted key>",
        "provider": "ArcGIS Data Store",
        "nodeDnName": "<encrypted node name>",
        "adminPem": "<encrypted key>",
        "purposes": ["feature-spatiotemporal"],
        "clusterName": "bds_sample",
        "dsFeature": "spatioTemporal",
        "rootCACert": "<encrypted key>",
        "nodeKey": "<encrypted key>",
        "machines": [{
            "dbPort": 9320,
            "isDataNode": true,
            "role": "BIGDATA_ONLY",
            "isCoordinatorNode": true,
            "httpPort": 9220,
            "name": "ORGANIZATION.EXAMPLE.COM",
            "adminURL": "https://ORGANIZATION.EXAMPLE.COM:2443/arcgis/datastoreadmin/",
            "transportPort": 9320,
            "platform": "Windows"
        }],
        "category": "database"
    }
}

File shares

The example response below demonstrates a data item in which the folder for the publisher and ArcGIS Video Server use the same shared path:

Use dark colors for code blocksCopy
{
    "path": "/fileShares/fileShare_ds_sample",
    "name": "sample",
    "id": "cbf6f88546b14b0388242a3a8fb57a3f",
    "type": "folder",
    "info": {
        "dataStoreConnectionType": "shared",
        "hostName": null,
        "path": "\\\\HOSTNAME\\FILESHARE",
        "portalProperties": {"itemID": "cbf6f88546b14b0388242a3a8fb57a3f"},
        "isManaged": false
    }
}

Object store

The example response below demonstrates an arcgis object store:

Use dark colors for code blocksCopy
{
    "path": "/cloudStores/VideoDataStore_objectstore_sample",
    "objectStore": "arcgisvideoservices",
    "provider": "ArcGIS Data Store",
    "name": "0123456789abcdef",
    "childItems": [],
    "id": "ac8aee42-0c2c-4744-8223-c5561669569c",
    "type": "objectStore",
    "info": {
        "isManagedData": true,
        "connectionString": "<connection string>",
        "factory": "objectStore",
        "secretKey": "<encrypted_secret_key>",
        "deployMode": "singleInstance",
        "implementation": "Ozone",
        "systemManaged": true,
        "datastoreName": "objectstore_sample",
        "isManaged": true,
        "finalized": true,
        "objectStore": "0123456789abcdef",
        "provider": "ArcGIS Data Store",
        "accessKey": "<encrypted_access_key>",
        "purposes": [
            "feature-tile",
            "scene"
        ],
        "sslEnabled": true,
        "dsFeature": "objectStore",
        "supportedStorageClasses": ["REDUCED_REDUNDANCY"],
        "machines": [{
            "isS3GEnabled": true,
            "managerNumber": 1,
            "role": "PRIMARY",
            "dbVersion": "2.0.0",
            "omID": "wdvzv",
            "isSCMPrimordialNode": true,
            "platform": "Windows",
            "dbPort": 29879,
            "endpoint": "https://ORGANIZATION.EXAMPLE.COM:29879",
            "isOMEnabled": true,
            "name": "ORGANIZATION.EXAMPLE.COM",
            "isDataNodeEnabled": true,
            "isSCMEnabled": true,
            "scmID": "lebg0",
            "adminURL": "https://ORGANIZATION.EXAMPLE.COM:2443/arcgis/datastoreadmin/"
        }],
        "category": "storage"
    }
}