/generateUrlReport: Generate URL Report

URL:: https://<root>/portals/[portalID]/urls/generateUrlReport
Methods:: POST
Version Introduced:: 11.4

Example usage

The following is a sample ArcGIS Enterprise POST request for the generateUrlReport operation:

Use dark colors for code blocksCopy
POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/urls/generateUrlReport HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

urlType=federatedServerUrl&serverId=iXfbqc1PteuVvFTT&f=pjson&token=<token>

Description

The generateUrlReport operation returns a report of the items in ArcGIS Enterprise portal or a federated server that uses the Enterprise portal or server's public-facing URL. The items listed in the report will be affected if the public-facing URL is updated.

Request parameters

Parameter	Details
`urlType` (Required)	Specifies whether the URL report should be generated for ArcGIS Enterprise portal items or the items on a federated server. The default value is `portalUrl`. Values: `portalUrl` \| `federatedServerUrl`
`serverId` (Optional; Required for `federatedServerUrl`)	The ID of the federated server. This value is retrieved from the Generate Organization URL Map operation. Use dark colors for code blocksCopy `1 serverId=iXfbqc1PteuVvFTT`
`async`	If `true`, the request is run as an asynchronous job. If set as `true`, the response will return job details. Note It is recommended that this operation is performed asynchronously. Only organizations with a small number of items, and few federated servers, should performed this operation synchronously. Values: `true` \| `false`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

JSON Response examples

The tabs below show the JSON responses returned for synchronous and asynchronous requests:

The following response is returned when async is set to false:

Use dark colors for code blocksCopy

{
  "siteUrlReport": {
    "id": "5ece2435-2eaf-4380-b929-2dd21840b8ce",
    "reportVersion": "1.0",
    "reportCreated": "Sun Sep 22 19:59:31 PDT 2024",
    "itemCount": 21,
    "portal": {
      "httpsUrl": "https://publicUrlPortal.domain.com/portal",
      "version": "11.3.0",
      "portalId": "73f24f34-a6fd-4ccc-ba8b-79fc54d4c343",
      "webContextUrl": "https://publicUrlPortal.domain.com/portal"
    },
    "items": [
      {
        "itemId": "7e0fecc482874175a15a1e7167c00328",
        "owner": "admin",
        "itemType": "text",
        "itemInfo": {
          "url": "https://publicUrlPortal.domain.com/portal/apps/instant/countdown/index.html?appid=7e0fecc482874175a15a1e7167c00328"
        }
      },
      {
        "itemId": "87bba32e974c4dcc86ab7697ac719fc3",
        "owner": "admin",
        "itemType": "text",
        "itemInfo": {
          "url": "https://publicUrlPortal.domain.com/portal/apps/sites/#/citizen-problem-reporter"
        },
        "data": {
          "urls": [
            {
              "markdown": "..."
            }
          ]
        }
      },
      {
        "itemId": "110ee1a06c754dc0bddf79ad6e1dc59c",
        "owner": "admin",
        "itemType": "text",
        "itemInfo": {
          "url": "https://publicUrlPortal.domain.com/portal/home/webmap/viewer.html?webmap=110ee1a06c754dc0bddf79ad6e1dc59c"
        }
      },
      {
        "itemId": "58b4e1584da949b7b4aedf47f83765ff",
        "owner": "admin",
        "itemType": "text",
        "itemInfo": {
          "url": "https://publicUrlPortal.domain.com/portal/home/webmap/viewer.html?webmap=58b4e1584da949b7b4aedf47f83765ff"
        }
      },
      {
        "itemId": "b977fc6e4d524b4e948357fea67a0e83",
        "owner": "admin",
        "itemType": "text",
        "itemInfo": {
          "url": "https://publicUrlPortal.domain.com/portal/home/webmap/viewer.html?webmap=b977fc6e4d524b4e948357fea67a0e83"
        }
      },
      {
        "itemId": "30f48e4581bc4dbcaa222d7648e7775e",
        "owner": "admin",
        "itemType": "text",
        "itemInfo": {
          "url": "https://publicUrlPortal.domain.com/portal/apps/CrowdsourceManager/index.html?appid=30f48e4581bc4dbcaa222d7648e7775e"
        }
      },
      {
        "itemId": "9c7dfee107bd4cdba5a81c0ff7a1b748",
        "owner": "admin",
        "itemType": "text",
        "itemInfo": {
          "url": "https://publicUrlPortal.domain.com/portal/apps/webappviewer/index.html?id=9c7dfee107bd4cdba5a81c0ff7a1b748"
        },
        "data": {
          "urls": [
            {
              "portalUrl": "https://publicUrlPortal.domain.com/portal"
            },
            {
              "portalUrl": "https://publicUrlPortal.domain.com/portal/"
            },
            {
              "url": "https://publicUrlPortal.domain.com/portal/sharing/proxy"
            }
          ]
        }
      },
      {
        "itemId": "3b2d27301e6841afb9b2293f55789e18",
        "owner": "admin",
        "itemType": "text",
        "data": {
          "urls": [
            {
              "script": "..."
            }
          ]
        }
      },
      {
        "itemId": "554aac5d995d4af19937ea055c9a08e8",
        "owner": "admin",
        "itemType": "text",
        "itemInfo": {
          "url": "https://publicUrlPortal.domain.com/portal/apps/instant/basic/index.html?appid=554aac5d995d4af19937ea055c9a08e8"
        }
      }
    ]
  }
}

If the async parameter is set as true, the request will return a job ID and job URL. The returned URL can be used to access the job resource and periodically poll the jobs status.

Use dark colors for code blocksCopy
{
  "jobId": "e8c9560278a94c6f88d8d4dbd82c863f",
  "key": "5qVOT43M4lcK_tcNKfIcdho2FOCN0NbvUwRxH7FuxI4",
  "jobUrl": "https://machine.domain.com/webadaptor/sharing/rest/portals/self/jobs/57ba3f2bdf7441a9989c746f0a751a0e"
}

Once the job is completed, the following response is returned:

Use dark colors for code blocksCopy
{
  "id": "57ba3f2bdf7441a9989c746f0a751a0e",
  "definition": {"type": "generateUrlReport"},
  "status": "completed",
  "created": 1727060371576,
  "modified": 1727060372207,
  "messages": [],
  "result": {
    "details": "Completed - URL Report",
    "urlReport": {
      "id": "5ece2435-2eaf-4380-b929-2dd21840b8ce",
      "reportVersion": "1.0",
      "reportCreated": "Sun Sep 22 19:59:31 PDT 2024",
      "itemCount": 21,
      "portal": {
        "httpsUrl": "https://publicUrlPortal.domain.com/portal",
        "version": "11.3.0",
        "portalId": "73f24f34-a6fd-4ccc-ba8b-79fc54d4c343",
        "webContextUrl": "https://publicUrlPortal.domain.com/portal"
      },
      "items": [
        {
          "itemId": "401586ea527144d18413d885c6f115df",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/401586ea527144d18413d885c6f115df/rest/services/World/VehicleRoutingProblem/GPServer/SolveVehicleRoutingProblem"}
        },
        {
          "itemId": "17761f08773d48fb97e7b407751e782d",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/17761f08773d48fb97e7b407751e782d/rest/services/Tools/Elevation/GPServer"}
        },
        {
          "itemId": "3339399089bf4b0d829fe04de4adad8c",
          "owner": "creator1",
          "itemType": "text",
          "resources": {"urls": [{"portalUrl": "https://publicUrlPortal.domain.com/portal"}]}
        },
        {
          "itemId": "47211a010e1642c1a61d6333be904db1",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/47211a010e1642c1a61d6333be904db1/rest/services/World/ClosestFacility/NAServer/ClosestFacility_World"}
        },
        {
          "itemId": "8f606270c0094aac9cd0370d1f69ac0f",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/8f606270c0094aac9cd0370d1f69ac0f/rest/services/World/GeoenrichmentServer"}
        },
        {
          "itemId": "1ff4953f6dc945ddad84d8736ba748c1",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/1ff4953f6dc945ddad84d8736ba748c1/rest/services/World/Traffic/MapServer"}
        },
        {
          "itemId": "a6f76aab71264e8ea6729193f52ffea1",
          "owner": "webpublisher",
          "itemType": "text",
          "resources": {"urls": [{"portalUrl": "https://publicUrlPortal.domain.com/portal"}]}
        },
        {
          "itemId": "a847702542e74e958d493d66e403d54f",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/a847702542e74e958d493d66e403d54f/rest/services/World/Route/NAServer/Route_World"}
        },
        {
          "itemId": "4888fbf86a4f419084270fc5ef82fdd5",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/4888fbf86a4f419084270fc5ef82fdd5/rest/services/Tools/Hydrology/GPServer"}
        },
        {
          "itemId": "c22467929c134d66ac62b265f0ada9e8",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/c22467929c134d66ac62b265f0ada9e8/rest/services/World/OriginDestinationCostMatrix/GPServer"}
        },
        {
          "itemId": "3c412443c2fc4dc1aff874102a131005",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/3c412443c2fc4dc1aff874102a131005/rest/services/World/LocationAllocation/GPServer"}
        },
        {
          "itemId": "27f577ab1845462a81f85d6107ab912c",
          "owner": "gisproadv2",
          "itemType": "text",
          "resources": {"urls": [{"portalUrl": "https://publicUrlPortal.domain.com/portal"}]}
        },
        {
          "itemId": "336c7c11032a4a88b2f158e5722bf246",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/336c7c11032a4a88b2f158e5722bf246/rest/services/World/Route/GPServer"}
        },
        {
          "itemId": "842fce17d8a0478381fa41c4fc0dd2a4",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/842fce17d8a0478381fa41c4fc0dd2a4/rest/services/World/ServiceAreas/NAServer/ServiceArea_World"}
        },
        {
          "itemId": "b3abf1a0d9b4479cafa3e044250cc121",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/b3abf1a0d9b4479cafa3e044250cc121/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities"}
        },
        {
          "itemId": "76c7be24cefe4aaf8e5cba7ef8b0d61b",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/76c7be24cefe4aaf8e5cba7ef8b0d61b/rest/services/World/ServiceAreas/GPServer/GenerateServiceAreas"}
        },
        {
          "itemId": "f4f23fcdbd4144e6a9a13a9da5f1fa65",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/f4f23fcdbd4144e6a9a13a9da5f1fa65/rest/services/World/VehicleRoutingProblem/GPServer"}
        },
        {
          "itemId": "9b4b4861263e40939b5b27adf3b9cf09",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/9b4b4861263e40939b5b27adf3b9cf09/rest/services/World/VehicleRoutingProblemSync/GPServer/EditVehicleRoutingProblem"}
        },
        {
          "itemId": "1849e2ddf736492db80ffef0a6b00e60",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/1849e2ddf736492db80ffef0a6b00e60/rest/services/World/Utilities/GPServer"}
        },
        {
          "itemId": "d688a6b59b83453f874dfe2be7f65ca2",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/d688a6b59b83453f874dfe2be7f65ca2/rest/services/World/GeocodeServer"}
        },
        {
          "itemId": "d5fdafcc9e1443048b300ea4b2ea173f",
          "owner": "portaladmin",
          "itemType": "url",
          "itemInfo": {"url": "https://publicUrlPortal.domain.com/portal/sharing/servers/d5fdafcc9e1443048b300ea4b2ea173f/rest/services/World/OriginDestinationCostMatrix/NAServer/OriginDestinationCostMatrix_World"}
        }
      ]
    }
  }
}