- 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 generate operation:
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 generate 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 |
|---|---|
(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 Values: |
(Optional; Required for | The ID of the federated server. This value is retrieved from the Generate Organization URL Map operation. |
| If Values: |
| The response format. The default format is Values: |
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:
{
"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"
}
}
]
}
}