Set users
put
/rest/ofscCore/v1/resources/{resourceId}/users
This operation updates the list of users assigned to the specified resource.
Request
Path Parameters
-
resourceId(required): string
The unique identifier of the resource in Oracle Field Service.
Root Schema : Resource Users
Type:
object
Title:
Resource Users
The list of users assigned to the resource.
Show Source
-
items:
array Items
Title:
Items
The array of objects containing information about the users assigned to the resource.
Nested Schema : Items
Type:
array
Title:
Items
The array of objects containing information about the users assigned to the resource.
Show Source
-
Array of:
object Resource User
Title:
Resource User
The user assigned to the resource.
Nested Schema : Resource User
Type:
object
Title:
Resource User
The user assigned to the resource.
Show Source
-
login(required):
string
Title:
Login
The login details of the assigned user.
Response
Supported Media Types
- application/json
200 Response
This section describes the 200 status response for this operation.
Root Schema : Resource Users
Type:
object
Title:
Resource Users
The list of users assigned to the resource.
Show Source
-
items:
array Items
Title:
Items
The array of objects containing information about the users assigned to the resource.
Nested Schema : Items
Type:
array
Title:
Items
The array of objects containing information about the users assigned to the resource.
Show Source
-
Array of:
object Resource User
Title:
Resource User
The user assigned to the resource.
Nested Schema : Resource User
Type:
object
Title:
Resource User
The user assigned to the resource.
Show Source
-
login(required):
string
Title:
Login
The login details of the assigned user.
Default Response
This section describes the default error response for this operation.
Root Schema : Error
Type:
Show Source
object
-
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.
Examples
The following example shows how to set users for a resource by submitting a PUT request on the REST resource.
Example of Request Header
The following shows an example of the request header.
PUT /rest/ofscCore/v1/resources/testResourceUsersCruOOXEKHKTDP/users HTTP/1.0
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "items": [ { "login": "de_engineer" }, { "login": "ru_engineer" } ] }
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "login": "de_engineer", "links": [ { "rel": "canonical", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/users/de_engineer" } ] }, { "login": "ru_engineer", "links": [ { "rel": "canonical", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/users/ru_engineer" } ] } ] }