Skip to content
URL:
https://<root>/rest/uploads/register
Methods:
POST
Version Introduced:
12.0

Description

The register operation registers a video file to the ArcGIS Video Server. Supported file formats include the following:

  • .ts
  • .mp4
  • .mpeg4
  • .mpeg

Once registered, a directory will be added to the \arcgisvideoserver\directories\<itemID>\admin\ path where a file with a matching name can be added. This will associate the file with the fileId output returned by this operation.

Request parameters

ParameterDetails

fileName

The file name to be registered. Must include the file name and extension as a string. This file name will need to match the name of the desired file, which will then need to be manually placed in the \arcgisvideoserver\directories\<itemID>\admin\ folder. Once this has been done, the item ID can be used with the Add Layer operation.

description

A description of the file can optionally be provided in the form of a string.

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.

Example usage

The following is a sample POST request for the register operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /arcgis/rest/uploads/register HTTP/1.1
Host: organization.example.com:21443
Content-Type: application/x-www-form-urlencoded
Content-Length: []

fileName=C:\test\sampleVideo.ts&description=testDescription&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
{
    "date": <date string>,
    "fileName": "videoTitle.ts",
    "committed": <true | false>,
    "fileId": "<file id string>"
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
{
    "date": 1759427939101,
    "fileName": "testItem.mp4",
    "committed": false,
    "fileId": "ib3c3b968-2abf-48b4-8051-637c0a05a7e0"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.