Jump to

• Request
• Response
• Examples

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

• login(required): string
  The unique identifier of the user account in Oracle Field Service.

Back to Top

Response

Supported Media Types

• application/schema+json
• application/json

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

• items: array Items
  Title: Items

  The collection of collaboration groups assigned to the specified user.

{
    "title":"Collaboration Groups",
    "description":"The collaboration groups assigned to the user.",
    "type":"object",
    "properties":{
        "items":{
            "items":{
                "$ref":"#/definitions/collaborationGroup"
            },
            "type":"array",
            "description":"The collection of collaboration groups assigned to the specified user.",
            "title":"Items"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The collection of collaboration groups assigned to the specified user.

Show Source

• Array of: object 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.

{
    "items":{
        "$ref":"#/definitions/collaborationGroup"
    },
    "type":"array",
    "description":"The collection of collaboration groups assigned to the specified user.",
    "title":"Items"
}

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

• name: string
  Title: Name

  The name of the collaboration group.

{
    "title":"Collaboration Group",
    "description":"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.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the collaboration group.",
            "title":"Name"
        }
    }
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

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