Jump to

• Request
• Response
• Examples

Get a user request

get

/hcmRestApi/atomservlet/user/userRequests/{id}

Get a user request

Request

Path Parameters

• id(required): string
  The unique identifier of the user.

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 : UserRequest-item

Type: object

Show Source

• addresses: object Addresses
  Title: Addresses

  The address information of the user.
• employeeNumber: string
  Title: EmployeeNumber

  A unique employee number for the user's account in Oracle Fusion Cloud Applications.
• manager: object Manager
  Title: Manager

  The details of the user's manager.
• phoneNumbers: object PhoneNumbers
  Title: PhoneNumbers

  The user's phone number information.
• user: object User
  Title: User

  The user information in Oracle Fusion Cloud Applications.
• userRequestType: string
  Title: UserRequestType

  The action code of the user request. For example, to create, update, activate, disable, or delete a user.
• userType: string
  Title: UserType

  Worker type of the user that identifies the organization-user relationship.

{
    "type":"object",
    "properties":{
        "userRequestType":{
            "title":"UserRequestType",
            "type":"string",
            "description":"The action code of the user request. For example, to create, update, activate, disable, or delete a user."
        },
        "addresses":{
            "title":"Addresses",
            "type":"object",
            "properties":{
            },
            "description":"The address information of the user."
        },
        "employeeNumber":{
            "title":"EmployeeNumber",
            "type":"string",
            "description":"A unique employee number for the user's account in Oracle Fusion Cloud Applications."
        },
        "manager":{
            "title":"Manager",
            "type":"object",
            "properties":{
            },
            "description":"The details of the user's manager."
        },
        "phoneNumbers":{
            "title":"PhoneNumbers",
            "type":"object",
            "properties":{
            },
            "description":"The user's phone number information."
        },
        "userType":{
            "title":"UserType",
            "type":"string",
            "description":"Worker type of the user that identifies the organization-user relationship."
        },
        "user":{
            "title":"User",
            "type":"object",
            "properties":{
            },
            "description":"The user information in Oracle Fusion Cloud Applications."
        }
    }
}

Nested Schema : Addresses

Type: object

Title: Addresses

The address information of the user.

Show Source

{
    "title":"Addresses",
    "type":"object",
    "properties":{
    },
    "description":"The address information of the user."
}

Nested Schema : Manager

Type: object

Title: Manager

The details of the user's manager.

Show Source

{
    "title":"Manager",
    "type":"object",
    "properties":{
    },
    "description":"The details of the user's manager."
}

Nested Schema : PhoneNumbers

Type: object

Title: PhoneNumbers

The user's phone number information.

Show Source

{
    "title":"PhoneNumbers",
    "type":"object",
    "properties":{
    },
    "description":"The user's phone number information."
}

Nested Schema : User

Type: object

Title: User

The user information in Oracle Fusion Cloud Applications.

Show Source

{
    "title":"User",
    "type":"object",
    "properties":{
    },
    "description":"The user information in Oracle Fusion Cloud Applications."
}

Back to Top

Examples

The following example shows how to retrieve a user request 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/atomservlet/user/userRequests/userRequests300100089891619

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:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns="http://www.w3.org/2005/Atom">
    <link href="http://<host>:<port>/hcmRestApi/atomservlet/user/userRequests/userRequests300100089891619" rel="edit"></link>
    <id>atomservlet:userRequests:userRequests300100089891619</id>
    <title type="text">SOD.User 64102016Nov28_0848 User CREATE</title>
    <updated>2016-11-28T07:52:27.000Z</updated>
    <author>
        <name>FAAdmin</name>
    </author>
    <summary type="text"></summary>
    <published>2016-11-28T07:52:27.000Z</published>
    <content type="text">{"id":"300100089888912","schemas":["urn:oracle:apps:scim:schemas:fa:1.0:UserRequest"],"employeeNumber":"955160008185297","user":{"id":"41C78D2719753027E050F50A5A0B07CE","name":{"familyName":"User 64102016Nov28_0848","givenName":"SOD"},"active":true,"userName":"SODUser64102016Nov28_0848","emails":[{"primary":true,"value":"[e-mail]","type":"work"}],"displayName":"SOD User 64102016Nov28_0848","preferredLanguage":"en"},"meta":{"lastModified":"2016-11-28T07:49:46Z","created":"2016-11-28T07:49:46Z"},"userType":"EMP","userRequestType":"CREATE"}</content>
    <source>
        <id>atomserver:userRequests:feed</id>
        <title type="text">User Requests</title>
        <link href="http://<host>:<port>/hcmRestApi/atomservlet/user/userRequests/userRequests300100089891619" rel="self"></link>
        <updated>2014-08-11T17:15:57.000Z</updated>
    </source>
</entry>

Back to Top