- URL:https://[root]/portals/[portalID]/collaborations/[collaborationID]/invitations
- Child Resources:Invitation
- Required Capability:Administrator (host)
- Version Introduced:10.5
Example usage
Below is a sample ArcGIS Online request URL used to access the invitations resource:
https://org.arcgis.com/sharing/rest/portals/0123456789ABCDEF/collaborations/9a8d5afa72444769b7bbee30184cec78/invitations?f=pjsonBelow is a sample ArcGIS Enterprise request URL used to access the invitations resource:
https://machine.domain.com/sharing/rest/portals/0123456789ABCDEF/collaborations/9a8d5afa72444769b7bbee30184cec78/invitations?f=pjsonDescription
The invitations operation returns the invitation information for all the invitations generated by a distributed collaboration host.
Request parameter
| Property | Details |
|---|---|
| f | The response format. The default format is html. Values: html | json | pjson |
JSON Response example
{
"collaborationInvitations": [
{
"id": "c3d543379ca94151964435b9418464a3",
"collaborationId": "9a8d5afa72444769b7bbee30184cec78",
"hostPortalId": "962998f1-f70a-4a4b-9231-a3faba2f28c6",
"guestPortalId": "unknown",
"guestPortalUrl": "https://guest.domain.com:7443/arcgis",
"status": "host_created",
"config": {
"invitationRequestFilename": "collaboration-guest.domain.com.invite"
},
"invitationString": "{\"invitationRequest\":{\"id\":\"c3d543379ca94151964435b9418464a3\",\"collaborationId\":\"9a8d5afa72444769b7bbee30184cec78\",\"collaborationName\":\"test-collab8\",\"collaborationDescription\":\"test\",\"collaborationWorkspaceConfigs\":{\"accessMode\":[{\"collaborationWorkspaceId\":\"dba640b1e16b460380b579a427c08cc5\",\"collaborationWorkspaceName\":\"testworkspace8\",\"collaborationWorkspaceDescription\":\"testworkspace8\",\"accessMode\":\"send\",\"config\":{}}]},\"guestPortalUrl\":\"https://guest.domain.com:7443/arcgis\",\"guestPortalId\":\"unknown\",\"hostPortalUrl\":\"https://host.domain.com:7443/arcgis\",\"hostPortalId\":\"962998f1-f70a-4a4b-9231-a3faba2f28c6\",\"hostPortalName\":\"Portal for ArcGIS\",\"hostPortalType\":\"onpremises\",\"publicKey\":\"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmlP493J/oQrpFU/A8XeEwXgRijDgVkXerUoVve8IZvZO8c9lw4HDN7W2cqY7X3DoBSzYB4bSll3L3WjmxiXTDjUKBU8h4oRiUsbF2d1XdgddLmJmyQID2UsH9PFFC/sd3q2qXK+Y97w9XIh5dKb6qERjxLuf/yzTmkWacu8wYTJGRkRRcuEZ4kSG3OmpH3hst0iy9/T8fMrCLddGZgTKb/EPxcBSVT+oU3ifFC+9gZGfFJuUVi6joYmeU7FaEkk2SBvEZjEdcrpdi4jo0ModZNJmFMAyeCKH+NGklXpQUrm9s1Mj8TmhpdQDBxDH/H8xlrkMhEL2R82TrioKR5w5VwIDAQAB\",\"contactFirstname\":\"admin\",\"contactLastname\":\"admin\",\"contactEmailAddress\":\"[email protected]\",\"canReach\":true,\"canRunCollaborationAgent\":true,\"created\":1470069598259,\"expiration\":1470155998259,\"hostPortalDescription\":\"<br/>\",\"hostPortalVersion\":\"10.5.0\"},\"signature\":\"JexJuEgJuBnBzi2DyHla3DcSiDSklm4xwbmCXl+2u/rseiRyZNL6x4GWmg6VwP/7sfsz4RM0sjACh+DF+CzPHlPrYnivZ/aX64uNGmSeIeYXZHz+2w9ii5MrCgarImFmCRxtkg0nqYiRbrTs/53pXr/iOMecviog6CgOd4W05lOz30ejh/kV/FwwURyFI7TzNOFBdnl+zwVNY5/UMeiuuNyTC1zQgaLMqCxxw9fnjIa8sVXr2TFSV/FOSi7e85t7uD8A+kkv/OrR/v2t+w47diN7Gym/QF6hYf2E8kV6DQ7sYP7hDV7TZXoyFHl8O7GdavNlECRSa6LcTNO3PIeGLA==\"}",
"created": 1470069598288,
"modified": 1470069598288,
"expiration": 1470155998259
}
]
}