/resources: Resources

URL:: https://[root]/portals/[portalID]/resources
Methods:: GET

Example usage

The following is a sample ArcGIS Online request URL used to access the resources endpoint:

Use dark colors for code blocksCopy
https://org.arcgis.com/sharing/rest/portals/0123456789ABCDEF/resources?f=pjson

The following is a sample ArcGIS Enterprise request URL used to access the resources endpoint:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/sharing/rest/portals/0123456789ABCDEF/resources?f=pjson

Description

The resources endpoint lists all file resources for the organization. The start and num paging parameters are supported.

Request parameters

Parameter Details

Parameter	Details
`start`	The number of the first entry in the result set response. The index number is 1-based. The default value of start is 1 (that is, the first search result). The start parameter, along with the num parameter, can be used to paginate the search results. Example Use dark colors for code blocksCopy `1 start=11`
`num`	The maximum number of results to be included in the result set response. The default value is 10, and the maximum allowed value is 100. The start parameter, along with the num parameter, can be used to paginate the search results. Note The actual number of returned results may be less than num. This happens when the number of results remaining after start is less than num.
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

start

The number of the first entry in the result set response. The index number is 1-based. The default value of start is 1 (that is, the first search result). The start parameter, along with the num parameter, can be used to paginate the search results.

Example

Use dark colors for code blocksCopy
start=11

num

The maximum number of results to be included in the result set response. The default value is 10, and the maximum allowed value is 100. The start parameter, along with the num parameter, can be used to paginate the search results.

f

The response format. The default format is html.

Values: html | json | pjson

Response properties

Property	Details
`total`	The total number of results found.
`start`	The number of the first entry in the result set response. The index number is 1-based.
`num`	The number of results included in this result set response.
`nextStart`	The next entry index if the current result set doesn't contain all results.
`resources`	A JSON array of resource objects that contain the key, size, and created date of the resource.

JSON Response syntax

Use dark colors for code blocksCopy
{
  "total": <total number of results>,
  "start": <results in first set>,
  "num": <number of results per page>,
  "nextStart": <result number of next page>,
  "resources": [
    {
      "key":  "<key name>",
      "size": <size of resource>,
      "created": date created shown in UNIX time
    },
    {
      "key":  "<key name>",
      "size": <size of resource>,
      "created": date created shown in UNIX time
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "total":  2,
  "start":  1,
  "num": 10,
  "nextStart": -1,
  "resources": [
    {
      "key":  "banner.jpg",
      "size": 4688,
      "created": 1313796950000
    },
    {
      "key":  "logo.png",
      "size": 4479,
      "created": 1313702941000
    }
  ]
}