Get a worker
get
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}
Request
Path Parameters
-
PersonId(required): integer(int64)
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
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : publicWorkers-item-response
Type:
Show Source
object
-
assignments: array
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. -
DisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Person's display name. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
Person's first name. -
FullName: string
Title:
Full Name
Read Only:true
Maximum Length:2000
Person's full name. -
Honors: string
Title:
Honors
Read Only:true
Maximum Length:80
Higher qualification appended to a person's name such as PhD. -
KnownAs: string
Title:
Known As
Read Only:true
Maximum Length:80
Person's preferred name. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Person's last name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListName: string
Title:
List Name
Read Only:true
Maximum Length:240
Person's listed name. -
messages: array
Messages
Title:
Messages
The messages resource is a child of the publicWorkers resource. It includes all the available messages of a worker. -
MiddleNames: string
Title:
Middle Names
Read Only:true
Maximum Length:80
Person's middle name. -
MilitaryRank: string
Title:
Military Rank
Read Only:true
Maximum Length:80
Person's military rank. -
NameInformation1: string
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. -
NameInformation10: string
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. -
NameInformation11: string
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. -
NameInformation12: string
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. -
NameInformation13: string
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. -
NameInformation14: string
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. -
NameInformation15: string
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. -
NameInformation16: string
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. -
NameInformation17: string
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. -
NameInformation18: string
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. -
NameInformation19: string
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. -
NameInformation2: string
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. -
NameInformation20: string
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. -
NameInformation21: string
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. -
NameInformation22: string
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. -
NameInformation23: string
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. -
NameInformation24: string
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. -
NameInformation25: string
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. -
NameInformation26: string
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. -
NameInformation27: string
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. -
NameInformation28: string
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. -
NameInformation29: string
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. -
NameInformation3: string
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. -
NameInformation30: string
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. -
NameInformation4: string
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. -
NameInformation5: string
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. -
NameInformation6: string
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. -
NameInformation7: string
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. -
NameInformation8: string
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. -
NameInformation9: string
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. -
OrderName: string
Title:
Order Name
Read Only:true
Maximum Length:240
Person's order name. -
otherCommunicationAccounts: array
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. -
PersonId: integer
(int64)
Read Only:
true
Internal identifier for the person. -
PersonNumber: string
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: array
Phones
Title:
Phones
The phones resource is a child of the publicWorkers resource. It includes all the available phone numbers of a worker. -
photos: array
Photos
Title:
Photos
The photos resource is a child of the publicWorkers resource. It includes all the available photos of a worker. -
PreNameAdjunct: string
Title:
Prefix
Read Only:true
Maximum Length:150
Part of the name added before a person's first name. -
PreviousLastName: string
Title:
Previous Last Name
Read Only:true
Maximum Length:150
Person's previous last name. -
Suffix: string
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: string
Title:
Title
Read Only:true
Maximum Length:30
Person's salutation such as Mr., Ms., and so on. -
Username: string
Title:
User Name
Read Only:true
Maximum Length:100
User name for the person record. -
WorkEmail: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
allReports: array
All Reports
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. -
allReportsDepartments: array
All Reports Departments
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. -
allReportsLocations: array
All Reports Locations
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. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
Internal identifier for the assignment. -
AssignmentName: string
Title:
Business Title
Read Only:true
Maximum Length:80
Name of the worker assignment. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Unique identifier for the worker assignment. -
BusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the business unit for the worker assignment. -
DepartmentName: string
Title:
Department
Read Only:true
Maximum Length:240
Name of the department for the worker assignment. -
directReports: array
Direct Reports
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. -
employmentHistory: array
Employment History
Title:
Employment History
The employmentHistory resource is a child of the assignments resource. It includes the employment history of a worker. -
FullPartTime: string
Title:
Full Time or Part Time
Read Only:true
Maximum Length:30
Indicates whether the worker is working full time or part time. -
GradeCode: string
Title:
Grade Code
Read Only:true
Maximum Length:30
Code of the grade for the worker assignment. -
GradeName: string
Title:
Grade
Read Only:true
Maximum Length:240
Name of the grade for the worker assignment. -
InternalBuilding: string
Title:
Building
Read Only:true
Maximum Length:45
Building information associated with the work location. -
InternalFloor: string
Title:
Floor
Read Only:true
Maximum Length:45
Floor information associated with the work location. -
InternalMailstop: string
Title:
Mail Stop
Read Only:true
Maximum Length:45
Internal mail location. -
InternalOfficeNumber: string
Title:
Office Number
Read Only:true
Maximum Length:45
Office number associated with the work location. -
JobCode: string
Title:
Job Code
Read Only:true
Maximum Length:30
Code of the job for the worker assignment. -
JobName: string
Title:
Job
Read Only:true
Maximum Length:240
Name of the job for the worker assignment. -
LegalEmployerName: string
Title:
Legal Employer
Read Only:true
Maximum Length:240
Name of the legal employer for the assignment. -
LengthOfServiceDays: integer
Length of service of a worker in additional days that are less than a full month.
-
LengthOfServiceMonths: integer
Length of service of a worker in additional months that are less than a full year.
-
LengthOfServiceYears: integer
Length of service of a worker in years.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationAddressLine1: string
Title:
Address Line 1
Read Only:true
Maximum Length:240
First line of the work location address. -
LocationAddressLine2: string
Title:
Address Line 2
Read Only:true
Maximum Length:240
Second line of the work location address. -
LocationAddressLine3: string
Title:
Address Line 3
Read Only:true
Maximum Length:240
Third line of the work location address. -
LocationAddressLine4: string
Title:
Address Line 4
Read Only:true
Maximum Length:240
Fourth line of the work location address. -
LocationCode: string
Title:
Location Code
Read Only:true
Maximum Length:60
Code of the location for the worker assignment. -
LocationCountry: string
Title:
Country
Read Only:true
Maximum Length:60
Country in which the work address is located. -
LocationLongPostalCode: string
Title:
Long Postal Code
Read Only:true
Maximum Length:30
Long postal code of the work location. -
LocationMultiLineAddress: string
Title:
Address
Read Only:true
Multiline address of the location. -
LocationName: string
Title:
Location
Read Only:true
Maximum Length:240
Name of the location for the worker assignment. -
LocationPostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:30
Postal code of the work location. -
LocationRegion1: string
Title:
Region 1
Read Only:true
Maximum Length:120
Primary region in which the work address is located. -
LocationRegion2: string
Title:
Region 2
Read Only:true
Maximum Length:120
Secondary region within the primary region. -
LocationRegion3: string
Title:
Region 3
Read Only:true
Maximum Length:120
Subregion within the secondary region. -
LocationSingleLineAddress: string
Title:
Address
Read Only:true
Single line address. -
LocationTimezoneCode: string
Title:
Time Zone Code
Read Only:true
Maximum Length:50
Time zone of the work location. -
LocationTownOrCity: string
Title:
Town or City
Read Only:true
Maximum Length:30
Town or city in which the work address is located. -
ManagerName: string
Title:
Manager
Read Only:true
Maximum Length:240
Name of the manager. -
managers: array
Managers
Title:
Managers
The managers resource is a child of the assignments resource. It includes all the managers of a worker. -
MarkedAsFavoriteFlag: boolean
Read Only:
true
Maximum Length:30
Indicates whether the current person is marked as favorite for a particular user. Valid values are Yes and No. -
PositionCode: string
Title:
Position Code
Read Only:true
Maximum Length:30
Code of the position for the worker assignment. -
PositionName: string
Title:
Position
Read Only:true
Maximum Length:240
Name of the position for the worker assignment. -
PrimaryAssignmentFlag: boolean
Title:
Primary Assignment
Read Only:true
Maximum Length:30
Indicates whether the current assignment is primary for the work relationship. Valid values are Yes and No. -
PrimaryFlag: boolean
Title:
Primary
Read Only:true
Maximum Length:30
Indicates whether the current assignment is the primary assignment for the worker. Valid values are Yes and No. -
representatives: array
Representatives
Title:
Representatives
The representatives resource is a child of the assignments resource. It includes all the worker representatives as of the current date. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
Start date of the period of employment. -
WorkAtHomeFlag: boolean
Title:
Working at Home
Read Only:true
Maximum Length:30
Indicates whether the person is working at home. Valid values are Yes and No. -
WorkerNumber: string
Title:
Worker Number
Read Only:true
Maximum Length:30
Unique identifier for a worker. -
WorkerType: string
Title:
Worker Type
Read Only:true
Maximum Length:30
Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N).
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AssignmentId: integer
(int64)
Read Only:
true
Internal identifier for the report's assignment. -
AssignmentName: string
Title:
Business Title
Read Only:true
Maximum Length:80
Business title of the report. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the report. -
DepartmentId: integer
(int64)
Title:
Department ID
Read Only:true
Unique identifier of the department that the report belongs to. -
DisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Display name of the report. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
Person's first name. -
KnownAs: string
Title:
Known As
Read Only:true
Maximum Length:80
Person's preferred name. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Person's last name. -
Level: integer
(int32)
Title:
Level
Read Only:true
Level of the report in the manager's hierarchy. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Title:
Location ID
Read Only:true
Unique identifier for the location of the report. -
ManagerAssignmentNumber: string
Title:
Manager Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the immediate manager of each report. -
ManagerPersonNumber: string
Title:
Manager Person Number
Read Only:true
Maximum Length:30
Person number of the immediate manager of each report. -
PersonId: integer
(int64)
Read Only:
true
Internal identifier for the report. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the report. -
Photo: string
(byte)
Title:
Photo
Unique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo ID
Surrogate identifier for the representative photo. -
PhotoName: string
Title:
Photo Name
Maximum Length:240
Name of the image file of the representative. -
RelationshipType: string
Title:
Relationship Type
Read Only:true
Maximum Length:30
Type of managerial relationship with the report such as line manager. -
RelationshipTypeMeaning: string
Title:
Relationship Type
Read Only:true
Maximum Length:80
Name of the managerial relationship with the report, such as line manager. -
WorkerType: string
Title:
Worker Type
Read Only:true
Maximum Length:30
Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N).
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicWorkers-assignments-allReportsDepartments-item-response
Type:
Show Source
object
-
DepartmentId: integer
(int64)
Title:
Department ID
Read Only:true
Unique identifier for the department. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerDisplayName: string
Title:
Manager
Read Only:true
Maximum Length:240
Display name of the department manager. -
ManagerFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
First name of the department manager. -
ManagerKnownAs: string
Title:
Known As
Read Only:true
Maximum Length:80
Person's preferred name. -
ManagerLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Last name of the department manager. -
ManagerPersonId: string
Title:
Manager ID
Read Only:true
Maximum Length:150
Internal identifier for the department manager. -
ManagerPersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the department manager. -
Name: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the department. -
PhotoId: integer
(int64)
Title:
Photo ID
Surrogate identifier for the photo. -
PhotoName: string
Title:
Photo Name
Maximum Length:240
Name of the image file. -
WorkerCount: number
Title:
Total Workers
Read Only:true
Count of workers in the department.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-assignments-allReportsLocations-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationCode: string
Title:
Location Code
Read Only:true
Maximum Length:60
Code of the location. -
LocationId: integer
(int64)
Title:
Location ID
Read Only:true
Surrogate identifier for the location. -
LocationName: string
Title:
Location
Read Only:true
Maximum Length:240
Name of the location. -
WorkerCount: number
Title:
Total Workers
Read Only:true
Count of the workers in the location.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-assignments-directReports-item-response
Type:
Show Source
object
-
AllReportsCount: number
Title:
Total Workers
Read Only:true
Count of all reports of the worker. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
Internal identifier for the report's assignment. -
AssignmentName: string
Title:
Business Title
Read Only:true
Maximum Length:80
Business title of the report. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:50
Assignment number of the report. -
DirectReportsCount: number
Title:
Total Directs
Read Only:true
Count of direct reports of the worker. -
DisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Display name of the report. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
Person's first name. -
KnownAs: string
Title:
Known As
Read Only:true
Maximum Length:80
Person's preferred name. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Person's last name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Title:
Person ID
Read Only:true
Internal identifier for the report. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the report. -
Photo: string
(byte)
Title:
Photo
Unique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo ID
Surrogate identifier for the photo. -
PhotoName: string
Title:
Photo Name
Maximum Length:240
Name of the image file. -
RelationshipType: string
Title:
Relationship Type
Read Only:true
Maximum Length:30
Type of managerial relationship with the report, such as line manager. -
RelationshipTypeMeaning: string
Title:
Relationship Type
Read Only:true
Maximum Length:80
Name of managerial relationship with the report such as line manager. -
WorkerType: string
Title:
Worker Type
Read Only:true
Maximum Length:30
Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N).
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-assignments-employmentHistory-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Read Only:
true
Internal identifier for the worker's assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Read Only:true
Maximum Length:80
Business title of the assignment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-assignments-managers-item-response
Type:
Show Source
object
-
AssignmentSupervisorId: integer
(int64)
Title:
Assignment Supervisor ID
Surrogate identifier for the supervisor on workers assignment. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
Person's display name. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
Person's first name. -
JobCode: string
Title:
Code
Read Only:true
Maximum Length:30
Code of the job for the manager assignment. -
JobName: string
Title:
Job
Read Only:true
Maximum Length:240
Name of the job for the manager assignment. -
KnownAs: string
Title:
Known As
Read Only:true
Maximum Length:80
Person's preferred name. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Person's last name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerAssignmentId: integer
(int64)
Title:
Manager Assignment ID
Surrogate identifier for the assignment supervisor. -
ManagerAssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Assignment name of the supervisor. -
ManagerAssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the supervisor. -
ManagerPersonId: integer
(int64)
Title:
Manager ID
Surrogate identifier for the supervisor. -
ManagerPersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person Number of the supervisor. -
ManagerType: string
Title:
Manager Type
Maximum Length:30
Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. -
ManagerTypeMeaning: string
Title:
Manager Type
Read Only:true
Maximum Length:80
Name of the role the supervisor has with regards to the overall organization structure, such as functional, project leader, and so on. -
Photo: string
(byte)
Title:
Image
Unique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo ID
Surrogate identifier for the supervisor photo. -
PhotoName: string
Title:
Photo Name
Maximum Length:240
Name of the image file of the supervisor. -
PositionCode: string
Title:
Code
Read Only:true
Maximum Length:30
Code of the position for the manager assignment. -
PositionName: string
Title:
Position
Read Only:true
Maximum Length:240
Name of the position for the manager assignment. -
WorkEmail: string
Title:
Work Email
Read Only:true
Maximum Length:240
Manager's work e-mail address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-assignments-representatives-item-response
Type:
Show Source
object
-
AsgResponsibilityId: integer
(int64)
Read Only:
true
Internal identifier for the responsibility. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the representative. -
DisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Display name of the representative. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
Person's first name. -
FromDate: string
(date)
Title:
From Date
Read Only:true
Date when the responsibility starts. -
KnownAs: string
Title:
Known As
Read Only:true
Maximum Length:80
Person's preferred name. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Person's last name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Read Only:
true
Internal identifier for the representative. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the representative. -
Photo: string
(byte)
Title:
Image
Unique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo ID
Surrogate identifier for the representative photo. -
PhotoName: string
Title:
Photo Name
Maximum Length:240
Name of the image file of the representative. -
ResponsibilityName: string
Title:
Responsibility Name
Read Only:true
Maximum Length:240
Name of the responsibility type of the representative such as Benefits Representative. -
ResponsibilityType: string
Title:
Responsibility Type
Read Only:true
Maximum Length:80
Responsibility type of the representative such as Human Resource Representative. -
ToDate: string
(date)
Title:
To Date
Read Only:true
Date when the responsibility ends. -
Usage: string
Read Only:
true
Maximum Length:4000
Description of the purpose for the responsibility. -
WorkContactsFlag: boolean
Title:
Work Contacts
Read Only:true
Maximum Length:30
Indicates whether the representatives should be displayed. -
WorkEmail: string
Title:
Work Email
Read Only:true
Maximum Length:240
Representative's work e-mail address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-messages-item-response
Type:
Show Source
object
-
FromDate: string
(date-time)
Title:
From Date
Read Only:true
Date from when the message is valid. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageContent: string
Title:
Message
Read Only:true
Maximum Length:4000
Content of the message. -
MessageId: integer
(int64)
Read Only:
true
Surrogate identifier for the worker message. -
ToDate: string
(date-time)
Title:
To Date
Read Only:true
Date until when the message is valid.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-otherCommunicationAccounts-item-response
Type:
Show Source
object
-
AccountName: string
Title:
Account Name
Read Only:true
Maximum Length:1000
Name of the account. -
DateEnd: string
(date)
Title:
To Date
Read Only:true
End date of the account. -
DateStart: string
(date)
Title:
From Date
Read Only:true
Start date of the account. -
DeliveryMethodId: integer
(int64)
Read Only:
true
Surrogate identifier for the delivery method. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Provider: string
Title:
Provider
Read Only:true
Maximum Length:30
Provider of the account such as Facebook and Twitter. Valid values are defined in the commonLookupsLOV.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-phones-item-response
Type:
Show Source
object
-
AreaCode: string
Title:
Area Code
Read Only:true
Maximum Length:30
Area code of the phone number. -
CountryCodeNumber: string
Title:
Country Code
Read Only:true
Maximum Length:30
Country code of the phone number. -
Extension: string
Title:
Extension
Read Only:true
Maximum Length:60
Extension number for the phone. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneId: integer
(int64)
Read Only:
true
Internal identifier for the phone. -
PhoneNumber: string
Title:
Number
Read Only:true
Maximum Length:60
Phone number of various phone types such as Work, Home, and so on. -
PhoneType: string
Title:
Type
Read Only:true
Maximum Length:30
Type of phone such as Work, Home, and so on. -
PhoneTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the phone type lookup code. -
PrimaryFlag: boolean
Title:
Primary
Read Only:true
Indicates whether the phone number is the primary phone of the worker.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-photos-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Photo: string
(byte)
Title:
Image
Unique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo ID
Internal identifier for the photo. -
PhotoName: string
Title:
Photo Name
Maximum Length:240
Name of the image file. -
PhotoType: string
Title:
Type
Maximum Length:30
Default Value:PROFILE
Type of photo, such as Profile or Cover. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:30
Default Value:false
Indicates whether the image is primary.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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. - PersonId:
- 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. - PersonId:
- otherCommunicationAccounts
-
Operation: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/otherCommunicationAccountsParameters:
- PersonId:
$request.path.PersonId
The otherCommunicationAccounts resource is a child of the publicWorkers resource. It includes all the other communication accounts of a worker. - PersonId:
- 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. - PersonId:
- 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. - PersonId:
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] { ...} ] }