Add collaboration groups

post

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

This operation creates collaboration groups for the specified user.

Request

Path Parameters
  • The unique identifier of the user account in Oracle Field Service Cloud.
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
Back to Top

Response

Supported Media Types

201 Response

This section describes the 201 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 add collaboration groups by submitting a POST request on the REST resource.

Example of Request Header

The following shows an example of the request header.

POST /rest/ofscCore/v1/users/soap/collaborationGroups HTTP/1.0
Authorization: Basic c29hcEBwZXRyb2xpYXNoZXZ5Y2gucmVzdDox
Host: etadev1f
Accept: */*
Content-Type: application/json; charset=utf-8
Content-Length: 134

Example of Request Body

The following shows an example of the request body.

{
  "items": 
    [
     "Test Group Name1 for POST",
     "Test Group Name2 for POST",
     "Test Group Name3 for POST"
    ]
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 201 Created
Server: nginx/1.2.1
Date: Thu, 03 Dec 2015 10:39:57 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 Group Name2 for POST",
                "type": "user-group",
                "description": "test description",
                "status": "inactive"
            },
            {
                "name": "Test Group Name1 for POST",
                "type": "helpdesk",
                "description": "test description",
                "status": "inactive"
            },
            {
                "name": "Test Group Name3 for POST",
                "type": "helpdesk",
                "description": "test description",
                "status": "inactive"
            }
        ],
        "links": [
            {
                "rel": "canonical",
                "href": "https://etadev1f/rest/ofscCore/v1/users/soap/collaborationGroups?groupType=both"
            },
            {
                "rel": "describedby",
                "href": "https://etadev1f/rest/ofscCore/v1/metadata-catalog/users"
            }
        ]
    }
Back to Top