Jump to

• Request
• Response
• Examples

Update a role

patch

/hcmRestApi/scim/Roles/{id}

Update a role

Request

Path Parameters

• id(required): string
  The unique identifier of the role in Oracle Applications Cloud.

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Show Source

• members: array Members
  Title: Members

  A list of users assigned to the role.

{
    "type":"object",
    "properties":{
        "members":{
            "title":"Members",
            "type":"array",
            "description":"A list of users assigned to the role.",
            "items":{
                "$ref":"#/components/schemas/members-item"
            }
        }
    }
}

Nested Schema : Members

Type: array

Title: Members

A list of users assigned to the role.

Show Source

• Array of: object members-item

{
    "title":"Members",
    "type":"array",
    "description":"A list of users assigned to the role.",
    "items":{
        "$ref":"#/components/schemas/members-item"
    }
}

Nested Schema : members-item

Type: object

Show Source

• operation: string
  Title: Operation

  The operation to be performed in the PATCH request.
• value: string
  Title: Value

  The unique identifier of the user assigned to the role.

{
    "type":"object",
    "properties":{
        "operation":{
            "title":"Operation",
            "type":"string",
            "description":"The operation to be performed in the PATCH request."
        },
        "value":{
            "title":"Value",
            "type":"string",
            "description":"The unique identifier of the user assigned to the role."
        }
    }
}

Back to Top

Response

204 Response

The server has fulfilled the request. This task does not return elements in the response body.

Back to Top

Examples

The following example shows how to update a role by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload>  https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Role/6FC956208A6A4E87A1F57E76F08D1616

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
"members": [
{
 "value": "FE4222FEF1A63883F49F0B1D93224B8E",
 "operation": "ADD"
},
{
 "value": "C2A28F8ED9FA377A20C8E3D614936E88",
 "operation": "REMOVE"
}]
}

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 204 No Content

Content-Type : application/json

Example of Response Body

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

204 - No content

Back to Top