- URL:
- https://<root>/uploads/register
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise 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.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise 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 Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The register operation directs the server to reserve space for a new item to be uploaded that is made up of one or more parts. Once the operation is completed, you must use the Upload Part operation to upload individual parts. After all the parts are uploaded, you must use the Commit operation to consolidate the parts.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The item's file name and extension. Example |
(Optional) | The item's description. Example |
Example usage
The following is a sample POST request for the register operation:
POST /<context>/admin/uploads/register HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
itemName=TestUpload_WaterDistributionNetwork.kmz&description=Test upload of Water Distribution Network template&token=ELIMsyURgefHIZ-x6PzynYsaxLNR30GbWE6PCpgD0Hu7dWQ3vmBLz3bljwvJC8a74K_XARVfs5lpmCkjLkMZANHIDgMHiwgwnNiQBbTWHEbNqJeodE9ipXYeUmlGkveMQ44JjNQlNGYim-LqV4DcrPynxBlvO0CsIT4RIB-OsYp6oU_jqS9xVHxcHwCtvu3rnikAqeb3S96aS0ntC-414Y23t1CWAVhDSmRrl7NyWgw-jN4VBZ3FvPnDDDoFooYJSON Response syntax
{
"status": "success",
"item": <item>
}JSON Response example
{
"status": "success",
"item": {
"itemID": "ie3b7610b-b229-4ca0-a8bc-d2c02069149a",
"itemName": "TestUpload_WaterDistributionNetwork.kmz",
"description": "Test upload of Water Distribution Network template",
"pathOnServer": "C:\\arcgis\\arcgisserver\\directories\\arcgissystem\\kml",
"date": 1566936940842,
"committed": false,
"serviceName": "",
"contentType": "application/octet-stream"
}
}