Update (Overview Configuration)

URL:
https://<root>/overview/update/config
Methods:
POST
Required Capability:
Access allowed with the "Security and infrastructure" privilege
Version Introduced:
10.9

Description

The config operation can be used to modify the updateIntervalMin property for an overview resource type. The updateIntervalMin property determines the interval (in minutes) when information, such as health and status information, for each overview resource type is pulled and cached. If the update frequency is specified as 0, no information is collected and cached for that resource type. Instead, when the Overview resource is manually called from the ArcGIS Enterprise Administrator API, or automatically by the ArcGIS Enterprise Manager, the real-time information for the resource type is returned.

Request parameters

ParameterDetails

resourceConfigJson

(Required)

A JSON array containing the overview resource type JSON objects. The JSON objects must contain the id, type, and updateIntervalMin for the overview resource type. The resource type JSON objects can be obtained from the JSON view of the Config resource. The accepted values for updateIntervalMin (0–60) can be modified to update the interval (in minutes) of when the resource type will have its information pulled and cached. If set to 0, information for the resource type will not be cached and instead have its real-time information returned when the Overview resource is called. The default values for each resource type are listed below:

  • criticalLogs : 0
  • systemServices : 1
  • utilityServices : 1
  • dataStores : 2
Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
resourceConfigJson={
  "configs": [
    {
      "updateIntervalMin": 2,
      "id": "1af0fa98-2ac2-44fe-be1c-0f9f75a8ef77",
      "type": "criticalLogs"
    },
    {
      "updateIntervalMin": 1,
      "id": "9595eece-5d9b-408b-911f-93d080896ac5",
      "type": "systemServices"
    },
    {
      "updateIntervalMin": 1,
      "id": "04c99764-0698-4586-badd-40ec9dc87a92",
      "type": "utilityServices"
    },
    {
      "updateIntervalMin": 1,
      "id": "0c12a861-f29b-48ef-b515-36497b041830",
      "type": "dataStores"
    }
  ]
}

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the update operation:

Use dark colors for code blocksCopy
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
POST /context/admin/overview/update/config HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

resourceConfigJson={
  "configs": [
    {
      "updateIntervalMin": 2,
      "id": "1af0fa98-2ac2-44fe-be1c-0f9f75a8ef77",
      "type": "criticalLogs"
    },
    {
      "updateIntervalMin": 1,
      "id": "9595eece-5d9b-408b-911f-93d080896ac5",
      "type": "systemServices"
    },
    {
      "updateIntervalMin": 1,
      "id": "04c99764-0698-4586-badd-40ec9dc87a92",
      "type": "utilityServices"
    },
    {
      "updateIntervalMin": 1,
      "id": "0c12a861-f29b-48ef-b515-36497b041830",
      "type":"dataStores"
    }
  ]
}&f=pjson&token=vGSqTwWwUv558RgvF1JzOM6dMJ4IXYR4sD9wwOBjHOppvvQp9Czd6S57c170S_T696AQOmfhK0NEn0wGhIUtHpaYFStDijj4yXmGgBbe6mj1zAm3oi0Up9pVLmH2V1rfAytc764RxOsx_BHwEEWQOBEn4kT0O3xkcpMDeOQaFlcphQ2XnBAot9r1riiWMFRenH-Rf1Mu0RSJuC9D5-LgnOSnkvC04K0Jy49ui-YSlqTL0i97Dw2SLtGtNoXUvVXQ

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

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