- URL:
- https://<root>/services/<serviceName>.<serviceType>/iteminfo/upload
- Methods:
POST- Version Introduced:
- 10.1
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The upload operation uploads a file associated with the item information to the server. The uploaded file is placed in a directory defined by the folder parameter. The file is accessible by appending the path and file name to the Item Information URL. Uploads are filtered by a list of approved filename extensions:
- xml
- img
- png
- gif
- jpg
- jpeg
- bmp
- json
The default list can be overridden by setting the upload property with the server properties API.
Request parameters
| Parameter | Description |
|---|---|
| The name of the folder on the server to which the file must be uploaded. |
| The file to upload to the server. |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the upload operation:
POST /<context>/admin/services/FireWeatherWatch.MapServer/iteminfo/upload HTTP/1.1
Host: organization.example.com
Content-Type: multipart/form-data; boundary=----boundary
Content-Length: []
------boundary
Content-Disposition: form-data; name="folder"
folderName
------boundary
Content-Disposition: form-data; name="file"; filename=""
Content-Type: application/octet-stream
thumbnail.jpg
------boundary
Content-Disposition: form-data; name="f"
pjson
------boundary
Content-Disposition: form-data; name="csrfPreventToken"
0aGn2YRklyOX7aHf91CHNH3dGj9CTSXru2llPr6C6Xcq-JJRKeq2GEXIRAY03GgMIp51WXmo8gquonKhIuuqQJziHfyY4s63NUhhfNfmPPgBb6m-0KcLN4cagbGzswKhQWPl85x4sMLByXSGKhaxjrcVQbUumSup8jClPeBa9xq9kaeCD_CQvNgjy42OtrN9,https://organization.example.com/server/admin
------boundary--JSON Response example
{"status": "success"}