How to work with the portal service

The general steps to run operations with the portal service.

1. Get the portal url

Before accessing and running operations in a portal, you need to determine the purpose of the work and evaluate whether ArcGIS Online or ArcGIS Enterprise is more suitable based on connectivity, security, scalability, and integration needs. To access a portal, you need an ArcGIS account which is associated with an organization that allows you to store and manage your content.

The base URL for a portal:

1
https://www.arcgis.com/sharing/rest

1
https://www.arcgis.com/sharing/rest

1
https://{machine.domain.com}/{webadaptor}/rest

To get the portal url:

1. In a web browser, log into your portal with your ArcGIS account.
2. Identify the portal URL from in the navigation bar.

2. Create an access token

As a developer, an access token is often used to manage and control access to services in a portal. This type of token is commonly used when working with command line apps, developing with the ArcGIS API for Python, or accessing the ArcGIS REST endpoint.

To get an access token, use the generateToken operation and set a username, password, and referer.

1
2
3
4
5
6
curl https://www.arcgis.com/sharing/rest/generateToken \
-d 'f=json' \
-d 'username=USERNAME' \
-d 'password=PASSWORD' \
-d 'referer=https://www.arcgis.com' \
-d 'client=referer'

1
2
3
4
5
{
  "token": "iX_oSlAphdxzi...",
  "expires": 1609488000000,
  "ssl": true
}

3. Make a request

Once an access token is created, follow these general steps to run an operation:

1. Make a request to the ArcGIS REST operation endpoint that includes the access token in the request headers for authentication.
2. Specify the operation parameters within the request payload, defining tasks like spatial analysis or querying specific data services.
3. Submit the request to the ArcGIS REST API endpoint using the token's authentication to access and run the operation.
4. Receive the response containing the results or confirmation of the executed operation.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
const portal = new Portal({
  url: "https://www.arcgis.com/"
});
portal.load().then(()=>{
  const query = {
    query: "title: Seven Natural Wonders, type: web map, owner: esri_devlabs"
  };
  portal.queryItems(query).then((response)=>{
    console.log(response);
  });
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
const portal = new Portal({
  url: "https://www.arcgis.com/",
  authMode = "immediate"
});
portal.load().then(()=>{
  const query = {
    query: `type: web map, owner: ${portal.user.username}`
  };
  portal.queryItems(query).then((response)=>{
    console.log(response);
  });
});

1
2
3
4
5
6
7
8
9
10
11
12
## Public

curl https://www.arcgis.com/sharing/rest/search \
-d 'q=title:"Seven Natural Wonders of the World" AND type:"web map" AND owner:"esri_devlabs"' \
-d 'f=pjson'

## Private

curl https://www.arcgis.com/sharing/rest/search \
-d 'q=title:"Seven Natural Wonders of the World" AND type:"web map" AND owner:"<YOUR_USER_ID>"' \
-d 'f=pjson'
-d 'token=<ACCESS_TOKEN>'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
{
  "query": "title:\"Seven Natural Wonders of the World\" AND type:\"web map\" AND owner:\"esri_devlabs\"",
  "total": 1,
  "start": 1,
  "num": 10,
  "nextStart": -1,
  "results": [{
    "id": "5a5147abe878444cbac68dea9f2f64e7",
    "owner": "esri_devlabs",
    "created": 1569537110000,

API support

Tools

Use tools to access the portal and create and manage content for applications.

Services