Skip To Content
ArcGIS Developers
Dashboard

Get Entitlements

  • URL:https://<licenses-url>/getEntitlements(POST only)
  • Required Capability:Administrator
  • Version Introduced:10.3

Description

Note:

This operation is only applicable to ArcGIS Enterprise 10.6.1 and earlier.

This operation returns the currently queued entitlements for a product, such as ArcGIS Pro or ArcGIS Navigator, and applies them when their start dates become effective. It's possible that all entitlements imported using the Import Entitlements operation are effective immediately and no entitlements are added to the queue. In this case, the operation returns an empty result.

Request parameters

ParameterDetails
appId

The identifier for the application for which the entitlements are queued.

Example

appId=arcgisprodesktop
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Below is a sample POST request for getEntitlements:

POST /webadaptor/portaladmin/system/licenses/getEntitlements HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

appId=arcgisprodesktop&f=json

JSON Response syntax

{
  "itemId": "<itemId>",
  "appId": "<appId>",
  "queue": [
    {
      "orgEntitlements": {
        "maxUsers": <maxUsers>,
        "startDate": <startDate>,
        "startDateStr": "<startDateStr>",
        "entitlements": {
          "<feature1>": {
            "num": <number>,
            "license": "<license_string>"
          },
          "<feature2>": {
            "num": <number>,
            "license": "<license_string>"
          }
        },
        "signature": "<signature>",
        "licenseManagerInfo": {
          "hostname": "<hostname>",
          "port": <port>
        }
      }
    }
  ]
}

JSON Response example

{
  "itemId": "12345",
  "appId": "arcgisprodesktop",
  "queue": [
    {
      "orgEntitlements": {
        "maxUsers": 0,
        "startDate": 21432374576,
        "startDateStr": "10-Sep-2015",
        "entitlements": {
          "desktopAdvN": {
            "num": 0,
            "license": "***"
          },
          "networkAnalystN": {
            "num": 0,
            "license": "***"
          }
        }
      },
      "signature": "***",
      "licenseManagerInfo": {
        "hostname": "licensemanager.domain.com",
        "port": 27000
      }
    }
  ]
}