collaborations: Collaborations | ArcGIS REST APIs

URL:: https://[root]/portals/[portalID]/collaborations
Methods:: GET
Operations:: Accept Invitation, Create Collaboration, Validate Invitation, Validate Invitation Response
Child Resources:: Collaboration
Required Capability:: Administrator
Version Introduced:: 10.5

Example usage

The following is a sample ArcGIS Online request URL used to access the collaborations resource:

Use dark colors for code blocksCopy
https://org.example.com/sharing/rest/portals/0123456789ABCDEF/collaborations?f=pjson

The following is a sample ArcGIS Enterprise request URL used to access the collaborations resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/sharing/rest/portals/0123456789ABCDEF/collaborations?f=pjson

Description

The collaborations resource lists all collaborations in which a portal participates. This includes collaborations for which the portal is a collaboration host or a collaboration guest. See About distributed collaboration for more information about collaboration patterns and use cases.

Request parameters

Parameter	Details
`f`	The response format. The default is `html`. Values: `html` \| `json` \| `pjson`
`start`	Introduced at ArcGIS Enterprise 12.1. The number of the first entry in the result set response. The index number is 1-based. The default value of `start` is `1`. Example Use dark colors for code blocksCopy `1 start=5`
`num`	Introduced at ArcGIS Enterprise 12.1. The maximum number of results to be included in the result set response. The default value is `10`. Note that the actual number of returned results may be less than the value specified for `num`. This happens when the number of results remaining after `start` is less than the `num` value. Example Use dark colors for code blocksCopy `1 2 //Returns a max of 50 results in the response num=10`
`sortField`	Introduced at ArcGIS Enterprise 12.1. The field to sort by. Sort field names are not case sensitive. Values: `name` \| `description` \| `created` \| `modified` \| `lastSyncFailureCount` \| `invitationsPendingCount`
`sortOrder`	Introduced at ArcGIS Enterprise 12.1. Describes whether the results are returned in ascending or descending order. The default is ascending. Note This applies when working with `sortField`. Values: `asc` \| `desc`
`filter`	Introduced at ArcGIS Enterprise 12.1. Structured filtering through specifying a field name followed by a colon and the term you are looking for with double quotation marks. It is designed to allow passing in application level filters based on its context. Specified field value should be an exact keyword match of the value interested, partially match the filter keyword will fail the matching and not return meaningful results. This parameter supports filtering collaborations by their `name` and `description` properties. Example: Use dark colors for code blocksCopy `1 filter=name:"Fire"`

JSON Response example

Use dark colors for code blocksCopy
{
  "total": 2,
  "start": 1,
  "num": 25,
  "nextStart": -1,
  "collaborations": [
    {
      "id": "4d95473e963942bf9ad6204095195e7b",
      "name": "Fire Weather Watch Collaboration",
      "description": "A collaboration between ArcGIS Enterprise and ArcGIS Online",
      "collaborationHostPortalId": "02c2cef9-bb19-472d-b867-46bcd987bf71",
      "config": {
        "ownerUsername": "admin"
      },
      "created": 1475859400628,
      "modified": 1475859400628
      "accountId": "0123456789ABCDEF", //Added at 12.1
      "lastSyncFailureCount": 0, //Added at 12.1
      "hostOrganizationName": "ArcGIS Enterprise", //Added at 12.1
      "hostOrganizationContact": "admin@me.com", //Added at 12.1
      "hostOrganizationType": "ArcGISEnterprise 12.1.0", //Added at 12.1
      "invitationsPendingCount": 0 //Added at 12.1
    }
  ]
}