Services - Service catalog | ArcGIS REST APIs

URL:: https://<root>/rest/services
Methods:: GET
Operations:: Is Service Name Available, Is Livestream Address Available
Child Resources:
Version Introduced:: 12.0

Description

The services resource outputs a full list of services on ArcGIS Video Server that are accessible from this resource.

Request parameters

Parameter Details

Parameter	Details
`f` (Required)	The response format. The default value 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 value 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.

Pagination response properties

Property	Details
`total`	Lists, as an integer, the number of services associated with ArcGIS Video Server.
`num`	Lists, as an integer, the number of services.
`start`	Outputs the `num` associated with the starting point in the output list for a given service.
`nextStart`	Outputs the `num` associated with the following starting point in the output list for the following service.

Service response properties

Property	Details
`services`	Outputs a list of properties describing a specific service on the Video Server. Properties include `serviceType`, which should always be `video service`. The `description` property will include any provided description, while `serviceName` outputs the relevant service's name. The `frameworkProperties` property is a detaied breakdown of where the service was created, how it is stored, the contents of its layers, and their properties. The following are sub-properties of `frameworkProperties` which can be returned from a GET request to the Services REST endpoint.
`dataStoreId`	The ID of the data store in which a given service exists.
`supportsAppend`	Determines whether a service's data can be appended after creation. Values: `true` \| `false`
`supportedQueryFormats`	This should be JSON or GeoJSON. Values: `JSON` \| `GeoJSON`
`portalItemId`	The portal item ID associated with a given video service.
`created`	The date and time at which the service was created.
`supportsMultiUserAddLayer`	Determines whether a user other than the service's initial creator can add additional layers within a given service. Values: `true` \| `false`
`lastReservedId`	The last ID used by a layer created in a service.
`supportsUpdate`	Shows whether a service can be updated after creation. Values: `true` \| `false`
`layers`	Returns details about each layer contained within a given service. This will return the following properties: `serviceType`: On-demand or livestream `created` Date and time of creation `description`: Any string given as a description for the layer `sourceFile`: The name of the source file used to create the layer `sourceFilesInfo`: The size, name, id, and `content type/format` of the source file `supportsExportFrameset`: Boolean value `supportsExportClip`: Boolean value `supportedQueryFormats`: JSON `supportsPreviews`: Boolean value `name`: The layer name `id`: The layer id `copyrightText`: Any string of copyright text `supportsMensuration`: Boolean value

Example usage

The following is a sample request URL used to access the services resource:

Use dark colors for code blocksCopy
https://organization.example.com:21443/arcgis/rest/services?f=pjson&token=<token>

JSON Response syntax

Use dark colors for code blocksCopy
{
    "total": 1,
    "num": 1,
    "start": 1,
    "nextStart": -1,
    "services": [{
        "serviceType": "Video Service",
        "description": "",
        "serviceName": "SampleService",
        "frameworkProperties": {
            "dataStoreId": "4e9de5f0-0844-4945-ae55-cbd04f9e4cce",
            "supportsAppend": false,
            "supportedQueryFormats": "json",
            "portalItemId": "8fd72978390b4ec1ab83cf4447021e31",
            "created": 1761053079392,
            "supportsMultiUserAddLayer": < true | false >,
            "lastReservedId": 0,
            "supportsUpdate": < true | false >,
            "layers": [{
                "serviceType": "< ONDEMAND | LIVESTREAM >",
                "created": 1761053111832,
                "description": "sample description",
                "sourceFile": "sampleVideo.ts",
                "sourceFilesInfo": [{
                    "size": 6422832,
                    "name": "sampleVideo.ts",
                    "id": "0",
                    "contentType": "<video/ts | video/mp4 | video/mpeg, etc>"
                }],
                "supportsExportFrameset": < true | false >,
                "supportsExportClip": < true | false >,
                "supportedQueryFormats": "json",
                "supportsPreviews": < true | false >,
                "name": "sampleLayer",
                "id": 0,
                "copyrightText": "sample layer copyright text",
                "supportsMensuration": < true | false >
            }],
            "copyrightText": "sample service copyright text"
        }
    }]
}

JSON response example

Use dark colors for code blocksCopy
{
    "total": 1,
    "num": 1,
    "start": 1,
    "nextStart": -1,
    "services": [{
        "serviceType": "Video Service",
        "description": "",
        "serviceName": "SampleService",
        "frameworkProperties": {
            "dataStoreId": "4e9de5f0-0844-4945-ae55-cbd04f9e4cce",
            "supportsAppend": false,
            "supportedQueryFormats": "json",
            "portalItemId": "8fd72978390b4ec1ab83cf4447021e31",
            "created": 1761053079392,
            "supportsMultiUserAddLayer": false,
            "lastReservedId": 0,
            "supportsUpdate": true,
            "layers": [{
                "serviceType": "ONDEMAND",
                "created": 1761053111832,
                "description": "test description",
                "sourceFile": "sampleVideo.ts",
                "sourceFilesInfo": [{
                    "size": 6422832,
                    "name": "sampleVideo.ts",
                    "id": "0",
                    "contentType": "video/ts"
                }],
                "supportsExportFrameset": true,
                "supportsExportClip": true,
                "supportedQueryFormats": "json",
                "supportsPreviews": true,
                "name": "sampleLayer",
                "id": 0,
                "copyrightText": "test layer copyright text",
                "supportsMensuration": false
            }],
            "copyrightText": "test service copyright text"
        }
    }]
}