Get collaboration groups

get

/rest/ofscCore/v1/users/{login}/collaborationGroups

This operation retrieves a list of collaboration groups associated with the specified user.

Request

Path Parameters
  • The unique identifier of the user account in Oracle Field Service Cloud.
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : Collaboration Groups
Type: object
Title: Collaboration Groups
The collaboration groups assigned to the user.
Show Source
Nested Schema : Items
Type: array
Title: Items
The collection of collaboration groups assigned to the specified user.
Show Source
  • Collaboration Group
    Title: Collaboration Group
    The array of collaboration group objects assigned to the user. Each collaboration group object contains data, such as name, type, and description specific to a collaboration group.
Nested Schema : Collaboration Group
Type: object
Title: Collaboration Group
The array of collaboration group objects assigned to the user. Each collaboration group object contains data, such as name, type, and description specific to a collaboration group.
Show Source

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to get collaboration groups by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET /rest/ofscCore/v1/users/login/collaborationGroups HTTP/1.0
Authorization: Basic c29hcEB5YW1hdG86MQ==
Host: etadev1f
Accept: */*

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.6.2
Date: Fri, 24 Jul 2015 08:35:48 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
      "totalResults": 3,
      "items": [
            {
                "name": "Test Name1",
                "type": "user-group",
                "description": "test description1",
                "active": "active"
            },
            {
                "name": "Test Name2",
                "type": "helpdesk",
                "description": "test description2",
                "active": "inactive"
            },
            {
                "name": "Test Name3",
                "type": "helpdesk",
                "description": "test description3",
                "active": "active"
            }
      ],
      "links": [
            {
                "rel": "canonical",
                "href": "https://etadev1f/rest/ofscCore/v1/users/login/collaborationGroups?groupType=both"
            },
            {
                "rel": "describedby",
                "href": "https://etadev1f/rest/ofscCore/v1/metadata-catalog/users"
            }
      ]
    }
Back to Top