Update Layer | ArcGIS REST APIs

URL:: https://<root>/services/serviceName/VideoServer/layerId/updateLayer
Methods:: POST
Version Introduced:: 12.0

Description

The updateLayer operation updates an existing video service layer.

Request parameters

Parameter Details

Parameter	Details
`name` (Required)	Adjusts the layer's name. Input must be a string.
`copyrightText` (Optional)	Modifies the copyright text for the layer. Input must be a string.
`description` (Optional)	Updates the layer's description, which provides additional information regarding a layer's purpose, location, etc. Input must be a string.
`supportsExportClip` (Required)	Specifies whether users are able to export clips from a given layer. Values: `true` \| `false`
`supportsFrameset` (Required)	Specifies whether a user can create frame sets based on this layer. Values: `true` \| `false`
`livestreamInfo` (Required only for Livestream Layers)	A JSON object that includes two properties: `supportsConversion` and `bufferSize`. The `supportsConversion` property is `false` by default. If modified to `true` it will allow a livestream layer to be converted to an on-demand layer after a stream ends using the (Convert to On-Demand tool)[/process]. The `bufferSize` property defaults to `30`, and is the number of seconds of buffer time allowed between the livestream process starting on ArcGIS Video Server. With a value of `30`, the livestream will begin to play with a 30 second delay. Example Use dark colors for code blocksCopy `1 2 3 4 { "supportsConversion": true, "bufferSize": 30 }`
`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.

name

(Required)

Adjusts the layer's name. Input must be a string.

copyrightText

(Optional)

Modifies the copyright text for the layer. Input must be a string.

description

(Optional)

Updates the layer's description, which provides additional information regarding a layer's purpose, location, etc. Input must be a string.

supportsExportClip

(Required)

Specifies whether users are able to export clips from a given layer.

Values: true | false

supportsFrameset

(Required)

Specifies whether a user can create frame sets based on this layer.

Values: true | false

livestreamInfo

(Required only for Livestream Layers)

A JSON object that includes two properties: supportsConversion and bufferSize. The supportsConversion property is false by default. If modified to true it will allow a livestream layer to be converted to an on-demand layer after a stream ends using the (Convert to On-Demand tool)[/process]. The bufferSize property defaults to 30, and is the number of seconds of buffer time allowed between the livestream process starting on ArcGIS Video Server. With a value of 30, the livestream will begin to play with a 30 second delay.

Example
Use dark colors for code blocksCopy
{
 "supportsConversion": true,
 "bufferSize": 30
}

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 updateLayer operation:

Use dark colors for code blocksCopy
POST /arcgis/rest/services/sampleService/VideoServer/01/updateLayer HTTP/1.1
Host: organization.example.com:21443
Content-Type: application/x-wwww-form-urlencoded
Content-Length: []

name=changedName&copyrightText=Updated+Copyright+Text&description=Updated+description+text&supportsExportClip=true&supportsFrameset=true&f=pjson&token=<token>

JSON Response syntax

Use dark colors for code blocksCopy
{
    "success": <true | false>
}

JSON Response example

Use dark colors for code blocksCopy
{
    "success": true
}