Jump to

• Request
• Response
• Examples

Get a role

get

/hcmRestApi/scim/Roles/{id}

Get a role

Request

Path Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : Roles-item

Type: object

Show Source

• category: string
  Title: Category

  The category of the role, for example Manager.
• description: string
  Title: Description

  The description of the role, which includes informations such as the functions that a user with this role can perform.
• displayName: string
  Title: DisplayName

  The display name for the role.
• id: string
  Title: Id

  A unique identifier for the role in Oracle Applications Cloud.
• members: array Members
  Title: Members

  A list of users assigned to the role.
• meta: object meta
  Title: meta

  The metadata of the roles resource.
• name: string
  Title: Name

  The name of the role.
• schemas: array Schemas
  Title: Schemas

  The schema of the roles resource.

{
    "type":"object",
    "properties":{
        "schemas":{
            "title":"Schemas",
            "type":"array",
            "description":"The schema of the roles resource.",
            "items":{
                "type":"string"
            }
        },
        "meta":{
            "title":"meta",
            "type":"object",
            "description":"The metadata of the roles resource."
        },
        "id":{
            "title":"Id",
            "type":"string",
            "description":"A unique identifier for the role in Oracle Applications Cloud."
        },
        "name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the role."
        },
        "displayName":{
            "title":"DisplayName",
            "type":"string",
            "description":"The display name for the role."
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"The description of the role, which includes informations such as the functions that a user with this role can perform."
        },
        "category":{
            "title":"Category",
            "type":"string",
            "description":"The category of the role, for example Manager."
        },
        "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 : meta

Type: object

Title: meta

The metadata of the roles resource.

Nested Schema : Schemas

Type: array

Title: Schemas

The schema of the roles resource.

Show Source

• Array of: string

{
    "title":"Schemas",
    "type":"array",
    "description":"The schema of the roles resource.",
    "items":{
        "type":"string"
    }
}

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

Examples

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

curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Role/6FC956208A6A4E87A1F57E76F08D1616

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/json

Example of Response Body

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

{
  "id": "6FC956208A6A4E87A1F57E76F08D1616",
  "meta": {
    "created": "2016-09-08 12:05:09.192",
    "lastModified": "2016-10-19 04:58:45.278",
    "location": "http://<host>:<port>/hcmRestApi/scim/Roles/6FC956208A6A4E87A1F57E76F08D1616"
  },
  "schemas": [
    "urn:oracle:apps:scim:schemas:fa:1.0:Role"
  ],
  "name": "DATA_ROLE_TEST_1.1160908_115907_DATA",
  "displayName": "data role test 1.1160908_115907",
  "description": "data role test 1.1160908_115907 Data",
  "category": "DATA",
  "members": [
    {
      "value": "3BBE77DF8A0FF8F2E050F00A081B2E54"
    }
  ]
}

Back to Top