Skip to content
URL:
https://<root>/uploads
Methods:
GET
Operations:
Register, Upload Item
Child Resources:
Item
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 generateToken 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.


Learn how to generate a token

Description

The uploads resource is a collection of all the items that have been uploaded to the server. There are two ways to upload items. You can upload complete items using the Upload Item operation. If a particular item is made up of many chunks (parts), you need to first register the item and subsequently upload the individual parts using the Upload Part operation.

Item uploads are filtered by an allowed list of filename extensions. Below is the default list:

  • soe
  • sd
  • sde
  • odc
  • csv
  • txt
  • zshp
  • kmz

The default list can be overridden by setting the uploadFileExtensionAllowedList property with the server properties API.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the uploads resource:

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/admin/uploads?f=pjson

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
  "items": [
    {
      "itemID": "if4582d33-f10a-41fe-85bc-cf2e2880c46e",
      "itemName": "JavaDeleteFeatures.sd",
      "description": null,
      "pathOnServer": "c:\\arcgisserver\\directories\\arcgissystem\\arcgisuploads\\if4582d33-f10a-41fe-85bc-cf2e2880c46e",
      "date": "Mon Jun 13 12:59:59 PDT 2019",
      "committed": true
    }
  ]
}

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