Skip to content
URL:
https://<root>/services/serviceName/VideoServer/layerId/update/poster
Methods:
POST
Version Introduced:
12.0

Description

The update/poster operation sets the thumbnail poster associated with a given layer to a new image. The new image can either be an uploaded image or an image available at a given URL.

Request parameters

ParameterDetails

file

(Optional)

The poster image to be uploaded. This parameter is optional, but must be provided if the url parameter is not submitted. Supported file types are .jpg and .png.

url

(Optional)

The URL to the poster image. This parameter is optional, but must be provided if the file parameter is not submitted. Supported file types to link to are .jpg and .png.

data

(Optional)

Any image metadata associated with the poster can be included here as a JSON object.

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

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

url=http://organization.example/image.jpeg&f=pjson

JSON Response syntax

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

JSON Response example

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

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