1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Public Workers

Get a worker

get

/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicWorkers-item-response
Type: object
Show Source
  • Assignments
    Title: Assignments
    The assignments resource is a child of the publicWorkers resource. It includes all the active assignments of a worker as of the current date.
  • Title: Display Name
    Read Only: true
    Maximum Length: 240
    Person's display name.
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    Person's first name.
  • Title: Full Name
    Read Only: true
    Maximum Length: 2000
    Person's full name.
  • Title: Honors
    Read Only: true
    Maximum Length: 80
    Higher qualification appended to a person's name such as PhD.
  • Title: Known As
    Read Only: true
    Maximum Length: 80
    Person's preferred name.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    Person's last name.
  • Links
  • Title: List Name
    Read Only: true
    Maximum Length: 240
    Person's listed name.
  • Messages
    Title: Messages
    The messages resource is a child of the publicWorkers resource. It includes all the available messages of a worker.
  • Title: Middle Names
    Read Only: true
    Maximum Length: 80
    Person's middle name.
  • Title: Military Rank
    Read Only: true
    Maximum Length: 80
    Person's military rank.
  • Title: Name Information 1
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 10
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 11
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 12
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 13
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 14
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 15
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 16
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 17
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 18
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 19
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 2
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 20
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 21
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 22
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 23
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 24
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 25
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 26
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 27
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 28
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 29
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 3
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 30
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 4
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 5
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 6
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 7
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 8
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Name Information 9
    Read Only: true
    Maximum Length: 150
    Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • Title: Order Name
    Read Only: true
    Maximum Length: 240
    Person's order name.
  • Other Communication Accounts
    Title: Other Communication Accounts
    The otherCommunicationAccounts resource is a child of the publicWorkers resource. It includes all the other communication accounts of a worker.
  • Read Only: true
    Internal identifier for the person.
  • Title: Person Number
    Read Only: true
    Maximum Length: 30
    Number assigned to a person to identify the person uniquely. Doesn't depend on the person type such as employee, contingent worker, and so on.
  • Phones
    Title: Phones
    The phones resource is a child of the publicWorkers resource. It includes all the available phone numbers of a worker.
  • Photos
    Title: Photos
    The photos resource is a child of the publicWorkers resource. It includes all the available photos of a worker.
  • Title: Prefix
    Read Only: true
    Maximum Length: 150
    Part of the name added before a person's first name.
  • Title: Previous Last Name
    Read Only: true
    Maximum Length: 150
    Person's previous last name.
  • Title: Suffix
    Read Only: true
    Maximum Length: 80
    Part of the name appended to a person's last name such as Jr., III, and so on.
  • Title: Title
    Read Only: true
    Maximum Length: 30
    Person's salutation such as Mr., Ms., and so on.
  • Title: User Name
    Read Only: true
    Maximum Length: 100
    User name for the person record.
  • Title: Work Email
    Read Only: true
    Maximum Length: 240
    Person's work e-mail address.
Nested Schema : Assignments
Type: array
Title: Assignments
The assignments resource is a child of the publicWorkers resource. It includes all the active assignments of a worker as of the current date.
Show Source
Nested Schema : Messages
Type: array
Title: Messages
The messages resource is a child of the publicWorkers resource. It includes all the available messages of a worker.
Show Source
Nested Schema : Other Communication Accounts
Type: array
Title: Other Communication Accounts
The otherCommunicationAccounts resource is a child of the publicWorkers resource. It includes all the other communication accounts of a worker.
Show Source
Nested Schema : Phones
Type: array
Title: Phones
The phones resource is a child of the publicWorkers resource. It includes all the available phone numbers of a worker.
Show Source
Nested Schema : Photos
Type: array
Title: Photos
The photos resource is a child of the publicWorkers resource. It includes all the available photos of a worker.
Show Source
Nested Schema : publicWorkers-assignments-item-response
Type: object
Show Source
Nested Schema : All Reports
Type: array
Title: All Reports
The allReports resource is a child of the assignments resource. It includes all the reports of a worker as of the current date for a specific assignment.
Show Source
Nested Schema : All Reports Departments
Type: array
Title: All Reports Departments
The allReportsDepartments resource is a child of the assignments resource. It includes all the distinct departments that all the reports of a worker belong to, as of the system date for a specific assignment.
Show Source
Nested Schema : All Reports Locations
Type: array
Title: All Reports Locations
The allReportsLocations resource is a child of the assignments resource. It includes all the distinct locations that all the reports of a worker belong to, as of the system date for a specific assignment.
Show Source
Nested Schema : Direct Reports
Type: array
Title: Direct Reports
The directReports resource is a child of the assignments resource. It includes all the direct reports of a worker as of the system date for a specific assignment.
Show Source
Nested Schema : Employment History
Type: array
Title: Employment History
The employmentHistory resource is a child of the assignments resource. It includes the employment history of a worker.
Show Source
Nested Schema : Managers
Type: array
Title: Managers
The managers resource is a child of the assignments resource. It includes all the managers of a worker.
Show Source
Nested Schema : Representatives
Type: array
Title: Representatives
The representatives resource is a child of the assignments resource. It includes all the worker representatives as of the current date.
Show Source
Nested Schema : publicWorkers-assignments-allReports-item-response
Type: object
Show Source
Nested Schema : publicWorkers-assignments-allReportsDepartments-item-response
Type: object
Show Source
Nested Schema : publicWorkers-assignments-allReportsLocations-item-response
Type: object
Show Source
Nested Schema : publicWorkers-assignments-directReports-item-response
Type: object
Show Source
Nested Schema : publicWorkers-assignments-employmentHistory-item-response
Type: object
Show Source
Nested Schema : publicWorkers-assignments-managers-item-response
Type: object
Show Source
Nested Schema : publicWorkers-assignments-representatives-item-response
Type: object
Show Source
Nested Schema : publicWorkers-messages-item-response
Type: object
Show Source
Nested Schema : publicWorkers-otherCommunicationAccounts-item-response
Type: object
Show Source
Nested Schema : publicWorkers-phones-item-response
Type: object
Show Source
Nested Schema : publicWorkers-photos-item-response
Type: object
Show Source
Links
assignments
Parameters:
  • PersonId: $request.path.PersonId
The assignments resource is a child of the publicWorkers resource. It includes all the active assignments of a worker as of the current date.
messages
Parameters:
  • PersonId: $request.path.PersonId
The messages resource is a child of the publicWorkers resource. It includes all the available messages of a worker.
otherCommunicationAccounts
Parameters:
  • PersonId: $request.path.PersonId
The otherCommunicationAccounts resource is a child of the publicWorkers resource. It includes all the other communication accounts of a worker.
phones
Parameters:
  • PersonId: $request.path.PersonId
The phones resource is a child of the publicWorkers resource. It includes all the available phone numbers of a worker.
photos
Parameters:
  • PersonId: $request.path.PersonId
The photos resource is a child of the publicWorkers resource. It includes all the available photos of a worker.
Back to Top

Examples

The following example shows how to retrieve a worker 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" -H "REST-Framework-Version: 4" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/publicWorkers?q=PersonId=300100026051334"

Example of Response Header

The following is 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.

{
    "PersonId": 300100026051334,
    "PersonNumber": "955160008176019",
    "LastName": "White",
    "FirstName": "Ross",
    "Title": null,
    "PreNameAdjunct": null,
    "Suffix": null,
    "MiddleNames": null,
    "Honors": null,
    "KnownAs": null,
    "DisplayName": "Ross White",
    "ListName": "White, Ross",
    "WorkEmail": "Ross.White@ymail.com",
    "Username": "Ross.White",
    "links": [5]
        {
          ...}
     ]
}
Back to Top