Get all user accounts

get

/hcmRestApi/resources/11.13.18.05/userAccounts

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all the user accounts that match the specified primary key criteria.
      Finder Variables
      • UserId; integer; Surrogate identifier for the user account.
    • findByFinder Finds all the user accounts that match the specified finder.
      Finder Variables
      • GUID; string; Globally unique identifier for the user account.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; User who created the user account.
    • CreationDate; string; Date and time when the user account was created.
    • CredentialsEmailSentFlag; boolean; Indicates whether the user name and password credentials were sent to the user after the account was created. The default value is Yes. Valid values are Yes and No.
    • GUID; string; Globally unique identifier for the user account.
    • LastUpdateDate; string; Date and time when the user account was last updated.
    • LastUpdatedBy; string; User who last updated the user account.
    • PersonId; integer; Unique identifier of the person record linked to the user account.
    • PersonNumber; string; Person number of the person record linked to the user account.
    • SuspendedFlag; boolean; Indicates whether the user, as part of termination, is suspended. If suspended, the user can be reactivated. Valid values are Yes and No.
    • UserId; integer; Unique identifier for the user.
    • Username; string; User name, a unique identifier for a user's account.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : userAccounts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : userAccounts-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the user account.
  • Title: Creation Date
    Read Only: true
    Date and time when the user account was created.
  • Title: Credentials Email Sent
    Maximum Length: 30
    Default Value: false
    Indicates whether the user name and password credentials were sent to the user after the account was created. The default value is Yes. Valid values are Yes and No.
  • Title: GUID
    Maximum Length: 64
    Globally unique identifier for the user account.
  • Title: Last Update Date
    Read Only: true
    Date and time when the user account was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the user account.
  • Links
  • Title: Person ID
    Unique identifier of the person record linked to the user account.
  • Title: Person Number
    Maximum Length: 30
    Person number of the person record linked to the user account.
  • Title: Suspended
    Maximum Length: 30
    Indicates whether the user, as part of termination, is suspended. If suspended, the user can be reactivated. Valid values are Yes and No.
  • User Account Roles
    Title: User Account Roles
    The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.
  • Title: User ID
    Unique identifier for the user.
  • Title: User Name
    Maximum Length: 100
    User name, a unique identifier for a user's account.
Nested Schema : User Account Roles
Type: array
Title: User Account Roles
The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : userAccounts-userAccountRoles-item-response
Type: object
Show Source
Back to Top

Examples

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

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/userAccounts"

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

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

{
  "items" : [ {
    "UserId" : 60,
    "Username" : "CUST_CONTRACT_MGR_OPERATIONS",
    "SuspendedFlag" : false,
    "PersonId" : 100010024201426,
    "PersonNumber" : "10024201426",
    "CredentialsEmailSentFlag" : true,
    "GUID" : "5A25572D96277A00C0547E3A715EF682",
    "CreatedBy" : "0",
    "CreationDate" : "2009-05-25T00:00:00+00:00",
    "LastUpdatedBy" : "FUSION",
    "LastUpdateDate" : "2019-01-10T14:21:50.341+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 300100003417358,
    "Username" : "DATA_STEWARD_MANAGER_VISION_CORPORATION",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "C79DBCC8F107FDE2CD3B938BEF5A94CE",
    "CreatedBy" : "HCM_USER10",
    "CreationDate" : "2011-12-02T04:30:33.660+00:00",
    "LastUpdatedBy" : "FUSION",
    "LastUpdateDate" : "2013-08-14T00:48:18+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100010032550939,
    "Username" : "Edward.Harper",
    "SuspendedFlag" : false,
    "PersonId" : 100010032550935,
    "PersonNumber" : "10032550935",
    "CredentialsEmailSentFlag" : true,
    "GUID" : "084F3C386BB2FBFEB1910F624D4765F5",
    "CreatedBy" : "0",
    "CreationDate" : "2009-11-02T15:17:27+00:00",
    "LastUpdatedBy" : "FUSION",
    "LastUpdateDate" : "2019-01-10T14:25:58.204+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018104239,
    "Username" : "FUNCTIONAL_SETUPS_USER",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "115FAD4B36A3D39B47C286608A1C9FDB",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:45:49.562+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:30:46.248+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100010034210251,
    "Username" : "JLamot_ACC",
    "SuspendedFlag" : false,
    "PersonId" : 100010034210252,
    "PersonNumber" : "10032752289ACC",
    "CredentialsEmailSentFlag" : true,
    "GUID" : "A4B4AA65D049D850A7EAF6FB5A26039F",
    "CreatedBy" : "0",
    "CreationDate" : "2010-01-14T12:44:04+00:00",
    "LastUpdatedBy" : "FUSION",
    "LastUpdateDate" : "2019-01-10T14:27:29.081+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018100401,
    "Username" : "PROJECT_ACCOUNTANT_ANBU4",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "3D9599178DE4A11D58C93098EC783343",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:44:57.266+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:35.465+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100010033906104,
    "Username" : "PROJECT_ACCOUNTANT_VISION_OPERATIONS",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "AC42C941067E93EA2F33D553292E5489",
    "CreatedBy" : "PROJECT_ACCOUNTANT_VISION_OPERATIONS",
    "CreationDate" : "2010-04-06T17:52:03+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:35.512+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018100409,
    "Username" : "PROJECT_ACCOUNTANT_VISION_SERVICES_R_AND_D",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "9587EB5A6E9875BA0347FAA54219CD0E",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:44:57.396+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:35.595+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100010032639684,
    "Username" : "PROJECT_ACCT_PROJECT",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "F855930A08B5603E051D3F1848639EF3",
    "CreatedBy" : "FUSION",
    "CreationDate" : "2009-12-09T00:00:00+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:35.730+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018100419,
    "Username" : "PROJECT_ADMINISTRATOR_FUSION_CORP_USA",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "87A6BA4DAAE299E539AF5C5C89453B9A",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:44:57.698+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:35.867+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018100431,
    "Username" : "PROJECT_ADMINISTRATOR_VISION_PROJECT_MFG",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "3F2AA882C6A64319ECEFE9A081137D97",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:44:57.875+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:36.023+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100010034074292,
    "Username" : "PROJECT_ADMINISTRATOR_VISION_SERVICES",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "BCFE82CE5A23792AC0ED3436F8E78D34",
    "CreatedBy" : "anonymous",
    "CreationDate" : "2010-05-17T13:43:12+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:36.057+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018100437,
    "Username" : "PROJECT_ADMINISTRATOR_VISION_STORES_US",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "ADFD97341A056F7E64788D4EDFF238F2",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:44:57.962+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:36.140+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018100443,
    "Username" : "PROJECT_BILLING_SPECIALIST_VISION_PROJECT_MFG",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "FB1A7742CCB281EDCBC9EECC2D032E52",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:44:58.419+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:36.647+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018100451,
    "Username" : "PROJECT_BILLING_SPEC_FUSION_CORP_USA",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "768E1476635CBFC2181DEC4B810D0D80",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:44:58.539+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:36.733+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018100453,
    "Username" : "PROJECT_BILLING_SPEC_OPERATIONS",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "9FA73AFCF3809B6ABB2D477633B7C7A9",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:44:58.570+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:36.755+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018100461,
    "Username" : "PROJECT_BILLING_SPEC_SERVICES_R_AND_D",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "F7CD8E01870A56113A4A3E82A02BFA81",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:44:58.690+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:36.891+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 157,
    "Username" : "PROJECT_CREATOR_FACILITY_OPERATIONS",
    "SuspendedFlag" : false,
    "PersonId" : 100010024203170,
    "PersonNumber" : "10024203170",
    "CredentialsEmailSentFlag" : true,
    "GUID" : "2C1E45C8C397A6D04B69A0B1511E61F8",
    "CreatedBy" : "0",
    "CreationDate" : "2009-05-25T00:00:00+00:00",
    "LastUpdatedBy" : "FUSION",
    "LastUpdateDate" : "2019-01-10T14:22:10.690+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018100463,
    "Username" : "PROJECT_CREATOR_FUSION_CORP_USA",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "8F0A9B8251E439020647DE6A13201153",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:44:58.787+00:00",
    "LastUpdatedBy" : "IT_SECURITY_MANAGER",
    "LastUpdateDate" : "2015-12-01T09:06:37.364+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100010032639696,
    "Username" : "PROJECT_CREATOR_PROJECT",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "07CBA34A89D888F4F059856EB5AE9B54",
    "CreatedBy" : "FUSION",
    "CreationDate" : "2009-12-09T00:00:00+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:37.095+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100000018100471,
    "Username" : "PROJECT_CREATOR_SERVICES_SOUTH",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "E33B376F16CBB608AE6B43312C1CE04D",
    "CreatedBy" : "HR_SPEC_ALL",
    "CreationDate" : "2010-05-28T15:44:59.098+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:37.366+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100010032639743,
    "Username" : "PSRUSER044",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "1BB3E8688E1195B26829C02216FEBADD",
    "CreatedBy" : "FUSION",
    "CreationDate" : "2009-12-09T00:00:00+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:39.806+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100010032639751,
    "Username" : "PSRUSER052",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "9F9FF3A6C3BC92B169AFC6145A37FF0F",
    "CreatedBy" : "FUSION",
    "CreationDate" : "2009-12-09T00:00:00+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:40.137+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100010032639759,
    "Username" : "PSRUSER060",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "27DCD1D8CEE5739B61CE72001ECF4E74",
    "CreatedBy" : "FUSION",
    "CreationDate" : "2009-12-09T00:00:00+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:40.394+00:00",
    "links" : [ 
         {
           ...}
  }, {
    "UserId" : 100010032639767,
    "Username" : "PSRUSER068",
    "SuspendedFlag" : false,
    "PersonId" : null,
    "PersonNumber" : null,
    "CredentialsEmailSentFlag" : true,
    "GUID" : "01486698BA6C510C86E772409C4CDDA4",
    "CreatedBy" : "FUSION",
    "CreationDate" : "2009-12-09T00:00:00+00:00",
    "LastUpdatedBy" : "HCM_USER10",
    "LastUpdateDate" : "2011-12-02T04:31:40.668+00:00",
    "links" : [ 
         {
           ...}
     ]
}
Back to Top