Get all workers
get
/hcmRestApi/resources/11.13.18.05/publicWorkers
Request
Query Parameters
-
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 -
finder: string
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 workers based on the specified primary key attributes.
Finder Variables- PersonId; integer; Unique Identifier for the worker.
- findAssistant Finds the assistant of the worker based on the specified attributes. The finder retrieves the worker assistant if the personEFF custom context Assistant is defined for the worker. You must create a custom context Assistant for person extensible flexfield where the PEI_INFORMATION_NUMBER1 attribute must be configured to capture the person identifier of the assistant.
Finder Variables- PersonId; integer; Internal identifier for the person whose assistant is to be retrieved.
- PersonNumber; string; Number assigned to a person to identify the person uniquely. This is the number of the person whose assistant is to be retrieved.
- findByWorkerAttr Finds all the worker assignments based on the specified attributes.
Finder Variables- AssignmentName; string; Assignment name for the worker assignment.
- DepartmentName; string; Department name for the worker assignment.
- DisplayName; string; Display name of the worker.
- JobName; string; Job name for the worker assignment.
- LocationCountry; string; Country for the worker assignment.
- LocationName; string; Location name for the worker assignment.
- LocationTownOrCity; string; Town or city for the worker assignment.
- OnlyPrimaryAssignmentFlag; boolean; Indicates whether the finder attributes apply only on the primary assignment of the worker. The default value is false.
- PersonNumber; string; Person number of the worker.
- PositionName; string; Position name for the worker assignment.
- WorkEmail; string; Work email of the worker.
- findManagers Finds all the worker managers based on the specified attributes.
Finder Variables- AssignmentId; integer; Internal identifier for the assignment of worker whose managers are to be retrieved.
- AssignmentNumber; string; Unique identifier for the assignment of worker whose managers are to be retrieved.
- LineManagerFlag; boolean; Indicates whether the manager are retrieved only for line manager relationship. Valid values are true or false. The default value is false.
- PersonId; integer; Internal identifier for the person whose managers are to be retrieved.
- PersonNumber; string; Number assigned to a person to identify the person uniquely. This is the number of the person whose managers are to be retrieved.
- PrimaryAssignmentFlag; boolean; Indicates whether the current assignment is the primary assignment for the worker whose managers are to be retrieved. Valid values are true or false. The default value is false.
- RelationshipType; string; Type of managerial relationship with the report such as line manager.
- findPeers Finds all the worker peers based on the specified attributes.
Finder Variables- AssignmentId; integer; Internal identifier for the assignment of the worker whose peers are to be retrieved.
- AssignmentNumber; string; Unique identifier for the assignment of the worker whose peers are to be retrieved.
- LineManagerFlag; boolean; Indicates whether the peers are retrieved only for line manager relationship. Valid values are true or false. The default value is false.
- PersonId; integer; Internal identifier for the person whose peers are to be retrieved.
- PersonNumber; string; Number assigned to a person to identify the person uniquely. This is the number of the person whose peers are to be retrieved.
- PrimaryAssignmentFlag; boolean; Indicates whether the current assignment is the primary assignment for the worker whose peers are to be retrieved. Valid values are true or false. The default value is false.
- RelationshipType; string; Type of managerial relationship with the report such as line manager.
- findReports Finds all the worker reports based on the specified attributes.
Finder Variables- AssignmentId; integer; Internal identifier for the assignment.
- AssignmentNumber; string; Unique identifier for the worker assignment.
- DirectReportsFlag; boolean; Indicates whether only direct reports should be retrieved for the worker. Valid values are true or false. The default value is true.
- LineManagerFlag; boolean; Indicates whether the reports are retrieved only for line manager relationship. Valid values are true or false. The default value is false.
- PersonId; integer; Internal identifier for the person whose reports are to be retrieved.
- PersonNumber; string; Number assigned to a person to identify the person uniquely. This is the number of the person whose reports are to be retrieved.
- PrimaryAssignmentFlag; boolean; Indicates whether the reports are retrieved for the primary assignment of the worker. Valid values are true or false. The default value is false.
- RelationshipType; string; Type of managerial relationship with the report such as line manager.
- PrimaryKey Finds all the workers based on the specified primary key attributes.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- DisplayName; string; Person's display name.
- FirstName; string; Person's first name.
- FullName; string; Person's full name.
- KnownAs; string; Person's preferred name.
- LastName; string; Person's last name.
- ListName; string; Person's listed name.
- MilitaryRank; string; Person's military rank.
- NameInformation1; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation10; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation11; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation12; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation13; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation14; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation15; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation16; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation17; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation18; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation19; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation2; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation20; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation21; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation22; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation23; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation24; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation25; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation26; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation27; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation28; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation29; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation3; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation30; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
- NameInformation4; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation5; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation6; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation7; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation8; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- NameInformation9; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
- OrderName; string; Person's order name.
- PersonId; integer; Internal identifier for the person.
- PersonNumber; string; 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.
- PreviousLastName; string; Person's previous last name.
- Username; string; User name for the person record.
- WorkEmail; string; Person's work e-mail address.
-
totalResults: boolean
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
-
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
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-item-response
Type:
Show Source
object-
assignments: array
Assignments
Title:
AssignmentsThe 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 NameRead Only:trueMaximum Length:240Person's display name. -
FirstName: string
Title:
First NameRead Only:trueMaximum Length:150Person's first name. -
FullName: string
Title:
Full NameRead Only:trueMaximum Length:2000Person's full name. -
Honors: string
Title:
HonorsRead Only:trueMaximum Length:80Higher qualification appended to a person's name such as PhD. -
KnownAs: string
Title:
Known AsRead Only:trueMaximum Length:80Person's preferred name. -
LastName: string
Title:
Last NameRead Only:trueMaximum Length:150Person's last name. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ListName: string
Title:
List NameRead Only:trueMaximum Length:240Person's listed name. -
messages: array
Messages
Title:
MessagesThe messages resource is a child of the publicWorkers resource. It includes all the available messages of a worker. -
MiddleNames: string
Title:
Middle NamesRead Only:trueMaximum Length:80Person's middle name. -
MilitaryRank: string
Title:
Military RankRead Only:trueMaximum Length:80Person's military rank. -
NameInformation1: string
Title:
Name Information 1Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation10: string
Title:
Name Information 10Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation11: string
Title:
Name Information 11Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation12: string
Title:
Name Information 12Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation13: string
Title:
Name Information 13Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation14: string
Title:
Name Information 14Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation15: string
Title:
Name Information 15Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation16: string
Title:
Name Information 16Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation17: string
Title:
Name Information 17Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation18: string
Title:
Name Information 18Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation19: string
Title:
Name Information 19Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation2: string
Title:
Name Information 2Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation20: string
Title:
Name Information 20Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation21: string
Title:
Name Information 21Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation22: string
Title:
Name Information 22Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation23: string
Title:
Name Information 23Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation24: string
Title:
Name Information 24Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation25: string
Title:
Name Information 25Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation26: string
Title:
Name Information 26Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation27: string
Title:
Name Information 27Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation28: string
Title:
Name Information 28Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation29: string
Title:
Name Information 29Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation3: string
Title:
Name Information 3Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation30: string
Title:
Name Information 30Read Only:trueMaximum Length:150Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation4: string
Title:
Name Information 4Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation5: string
Title:
Name Information 5Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation6: string
Title:
Name Information 6Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation7: string
Title:
Name Information 7Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation8: string
Title:
Name Information 8Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation9: string
Title:
Name Information 9Read Only:trueMaximum Length:150Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
OrderName: string
Title:
Order NameRead Only:trueMaximum Length:240Person's order name. -
otherCommunicationAccounts: array
Other Communication Accounts
Title:
Other Communication AccountsThe otherCommunicationAccounts resource is a child of the publicWorkers resource. It includes all the other communication accounts of a worker. -
PersonId: integer
(int64)
Read Only:
trueInternal identifier for the person. -
PersonNumber: string
Title:
Person NumberRead Only:trueMaximum Length:30Number 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:
PhonesThe phones resource is a child of the publicWorkers resource. It includes all the available phone numbers of a worker. -
photos: array
Photos
Title:
PhotosThe photos resource is a child of the publicWorkers resource. It includes all the available photos of a worker. -
PreNameAdjunct: string
Title:
PrefixRead Only:trueMaximum Length:150Part of the name added before a person's first name. -
PreviousLastName: string
Title:
Previous Last NameRead Only:trueMaximum Length:150Person's previous last name. -
Suffix: string
Title:
SuffixRead Only:trueMaximum Length:80Part of the name appended to a person's last name such as Jr., III, and so on. -
Title: string
Title:
TitleRead Only:trueMaximum Length:30Person's salutation such as Mr., Ms., and so on. -
Username: string
Title:
User NameRead Only:trueMaximum Length:100User name for the person record. -
WorkEmail: string
Title:
Work EmailRead Only:trueMaximum Length:240Person's work e-mail address.
Nested Schema : Assignments
Type:
arrayTitle:
AssignmentsThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Messages
Type:
arrayTitle:
MessagesThe 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:
arrayTitle:
Other Communication AccountsThe 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:
arrayTitle:
PhonesThe 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:
arrayTitle:
PhotosThe 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 ReportsThe 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 DepartmentsThe 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 LocationsThe 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 IDRead Only:trueInternal identifier for the assignment. -
AssignmentName: string
Title:
Business TitleRead Only:trueMaximum Length:80Name of the worker assignment. -
AssignmentNumber: string
Title:
Assignment NumberRead Only:trueMaximum Length:30Unique identifier for the worker assignment. -
BusinessUnitName: string
Title:
Business UnitRead Only:trueMaximum Length:240Name of the business unit for the worker assignment. -
DepartmentName: string
Title:
DepartmentRead Only:trueMaximum Length:240Name of the department for the worker assignment. -
directReports: array
Direct Reports
Title:
Direct ReportsThe 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 HistoryThe employmentHistory resource is a child of the assignments resource. It includes the employment history of a worker. -
FullPartTime: string
Title:
Full Time or Part TimeRead Only:trueMaximum Length:30Indicates whether the worker is working full time or part time. -
GradeCode: string
Title:
Grade CodeRead Only:trueMaximum Length:30Code of the grade for the worker assignment. -
GradeName: string
Title:
GradeRead Only:trueMaximum Length:240Name of the grade for the worker assignment. -
InternalBuilding: string
Title:
BuildingRead Only:trueMaximum Length:45Building information associated with the work location. -
InternalFloor: string
Title:
FloorRead Only:trueMaximum Length:45Floor information associated with the work location. -
InternalMailstop: string
Title:
Mail StopRead Only:trueMaximum Length:45Internal mail location. -
InternalOfficeNumber: string
Title:
Office NumberRead Only:trueMaximum Length:45Office number associated with the work location. -
JobCode: string
Title:
Job CodeRead Only:trueMaximum Length:30Code of the job for the worker assignment. -
JobName: string
Title:
JobRead Only:trueMaximum Length:240Name of the job for the worker assignment. -
LegalEmployerName: string
Title:
Legal EmployerRead Only:trueMaximum Length:240Name 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:
LinksThe link relations associated with the resource instance. -
LocationAddressLine1: string
Title:
Address Line 1Read Only:trueMaximum Length:240First line of the work location address. -
LocationAddressLine2: string
Title:
Address Line 2Read Only:trueMaximum Length:240Second line of the work location address. -
LocationAddressLine3: string
Title:
Address Line 3Read Only:trueMaximum Length:240Third line of the work location address. -
LocationAddressLine4: string
Title:
Address Line 4Read Only:trueMaximum Length:240Fourth line of the work location address. -
LocationCode: string
Title:
Location CodeRead Only:trueMaximum Length:60Code of the location for the worker assignment. -
LocationCountry: string
Title:
CountryRead Only:trueMaximum Length:60Country in which the work address is located. -
LocationLongPostalCode: string
Title:
Long Postal CodeRead Only:trueMaximum Length:30Long postal code of the work location. -
LocationMultiLineAddress: string
Title:
AddressRead Only:trueMultiline address of the location. -
LocationName: string
Title:
LocationRead Only:trueMaximum Length:240Name of the location for the worker assignment. -
LocationPostalCode: string
Title:
Postal CodeRead Only:trueMaximum Length:30Postal code of the work location. -
LocationRegion1: string
Title:
Region 1Read Only:trueMaximum Length:120Primary region in which the work address is located. -
LocationRegion2: string
Title:
Region 2Read Only:trueMaximum Length:120Secondary region within the primary region. -
LocationRegion3: string
Title:
Region 3Read Only:trueMaximum Length:120Subregion within the secondary region. -
LocationSingleLineAddress: string
Title:
AddressRead Only:trueSingle line address. -
LocationTimezoneCode: string
Title:
Time Zone CodeRead Only:trueMaximum Length:50Time zone of the work location. -
LocationTownOrCity: string
Title:
Town or CityRead Only:trueMaximum Length:30Town or city in which the work address is located. -
ManagerName: string
Title:
ManagerRead Only:trueMaximum Length:240Name of the manager. -
managers: array
Managers
Title:
ManagersThe managers resource is a child of the assignments resource. It includes all the managers of a worker. -
MarkedAsFavoriteFlag: boolean
Read Only:
trueMaximum Length:30Indicates whether the current person is marked as favorite for a particular user. Valid values are Yes and No. -
PositionCode: string
Title:
Position CodeRead Only:trueMaximum Length:30Code of the position for the worker assignment. -
PositionName: string
Title:
PositionRead Only:trueMaximum Length:240Name of the position for the worker assignment. -
PrimaryAssignmentFlag: boolean
Title:
Primary AssignmentRead Only:trueMaximum Length:30Indicates whether the current assignment is primary for the work relationship. Valid values are Yes and No. -
PrimaryFlag: boolean
Title:
PrimaryRead Only:trueMaximum Length:30Indicates whether the current assignment is the primary assignment for the worker. Valid values are Yes and No. -
representatives: array
Representatives
Title:
RepresentativesThe 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 DateRead Only:trueStart date of the period of employment. -
WorkAtHomeFlag: boolean
Title:
Working at HomeRead Only:trueMaximum Length:30Indicates whether the person is working at home. Valid values are Yes and No. -
WorkerNumber: string
Title:
Worker NumberRead Only:trueMaximum Length:30Unique identifier for a worker. -
WorkerType: string
Title:
Worker TypeRead Only:trueMaximum Length:30Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N).
Nested Schema : All Reports
Type:
arrayTitle:
All ReportsThe 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:
arrayTitle:
All Reports DepartmentsThe 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:
arrayTitle:
All Reports LocationsThe 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:
arrayTitle:
Direct ReportsThe 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:
arrayTitle:
Employment HistoryThe employmentHistory resource is a child of the assignments resource. It includes the employment history of a worker.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Managers
Type:
arrayTitle:
ManagersThe managers resource is a child of the assignments resource. It includes all the managers of a worker.
Show Source
Nested Schema : Representatives
Type:
arrayTitle:
RepresentativesThe 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:
trueInternal identifier for the report's assignment. -
AssignmentName: string
Title:
Business TitleRead Only:trueMaximum Length:80Business title of the report. -
AssignmentNumber: string
Title:
Assignment NumberRead Only:trueMaximum Length:30Assignment number of the report. -
DepartmentId: integer
(int64)
Title:
Department IDRead Only:trueUnique identifier of the department that the report belongs to. -
DisplayName: string
Title:
Display NameRead Only:trueMaximum Length:240Display name of the report. -
FirstName: string
Title:
First NameRead Only:trueMaximum Length:150Person's first name. -
KnownAs: string
Title:
Known AsRead Only:trueMaximum Length:80Person's preferred name. -
LastName: string
Title:
Last NameRead Only:trueMaximum Length:150Person's last name. -
Level: integer
(int32)
Title:
LevelRead Only:trueLevel of the report in the manager's hierarchy. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationId: integer
(int64)
Title:
Location IDRead Only:trueUnique identifier for the location of the report. -
ManagerAssignmentNumber: string
Title:
Manager Assignment NumberRead Only:trueMaximum Length:30Assignment number of the immediate manager of each report. -
ManagerPersonNumber: string
Title:
Manager Person NumberRead Only:trueMaximum Length:30Person number of the immediate manager of each report. -
PersonId: integer
(int64)
Read Only:
trueInternal identifier for the report. -
PersonNumber: string
Title:
Person NumberRead Only:trueMaximum Length:30Person number of the report. -
Photo: string
(byte)
Title:
PhotoUnique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo IDSurrogate identifier for the representative photo. -
PhotoName: string
Title:
Photo NameMaximum Length:240Name of the image file of the representative. -
RelationshipType: string
Title:
Relationship TypeRead Only:trueMaximum Length:30Type of managerial relationship with the report such as line manager. -
RelationshipTypeMeaning: string
Title:
Relationship TypeRead Only:trueMaximum Length:80Name of the managerial relationship with the report, such as line manager. -
WorkerType: string
Title:
Worker TypeRead Only:trueMaximum Length:30Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N).
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 IDRead Only:trueUnique identifier for the department. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManagerDisplayName: string
Title:
ManagerRead Only:trueMaximum Length:240Display name of the department manager. -
ManagerFirstName: string
Title:
First NameRead Only:trueMaximum Length:150First name of the department manager. -
ManagerKnownAs: string
Title:
Known AsRead Only:trueMaximum Length:80Person's preferred name. -
ManagerLastName: string
Title:
Last NameRead Only:trueMaximum Length:150Last name of the department manager. -
ManagerPersonId: string
Title:
Manager IDRead Only:trueMaximum Length:150Internal identifier for the department manager. -
ManagerPersonNumber: string
Title:
Person NumberRead Only:trueMaximum Length:30Person number of the department manager. -
Name: string
Title:
NameRead Only:trueMaximum Length:240Name of the department. -
PhotoId: integer
(int64)
Title:
Photo IDSurrogate identifier for the photo. -
PhotoName: string
Title:
Photo NameMaximum Length:240Name of the image file. -
WorkerCount: number
Title:
Total WorkersRead Only:trueCount of workers in the department.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-assignments-allReportsLocations-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationCode: string
Title:
Location CodeRead Only:trueMaximum Length:60Code of the location. -
LocationId: integer
(int64)
Title:
Location IDRead Only:trueSurrogate identifier for the location. -
LocationName: string
Title:
LocationRead Only:trueMaximum Length:240Name of the location. -
WorkerCount: number
Title:
Total WorkersRead Only:trueCount of the workers in the location.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-assignments-directReports-item-response
Type:
Show Source
object-
AllReportsCount: number
Title:
Total WorkersRead Only:trueCount of all reports of the worker. -
AssignmentId: integer
(int64)
Title:
Assignment IDRead Only:trueInternal identifier for the report's assignment. -
AssignmentName: string
Title:
Business TitleRead Only:trueMaximum Length:80Business title of the report. -
AssignmentNumber: string
Title:
Assignment NumberRead Only:trueMaximum Length:50Assignment number of the report. -
DirectReportsCount: number
Title:
Total DirectsRead Only:trueCount of direct reports of the worker. -
DisplayName: string
Title:
Display NameRead Only:trueMaximum Length:240Display name of the report. -
FirstName: string
Title:
First NameRead Only:trueMaximum Length:150Person's first name. -
KnownAs: string
Title:
Known AsRead Only:trueMaximum Length:80Person's preferred name. -
LastName: string
Title:
Last NameRead Only:trueMaximum Length:150Person's last name. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PersonId: integer
(int64)
Title:
Person IDRead Only:trueInternal identifier for the report. -
PersonNumber: string
Title:
Person NumberRead Only:trueMaximum Length:30Person number of the report. -
Photo: string
(byte)
Title:
PhotoUnique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo IDSurrogate identifier for the photo. -
PhotoName: string
Title:
Photo NameMaximum Length:240Name of the image file. -
RelationshipType: string
Title:
Relationship TypeRead Only:trueMaximum Length:30Type of managerial relationship with the report, such as line manager. -
RelationshipTypeMeaning: string
Title:
Relationship TypeRead Only:trueMaximum Length:80Name of managerial relationship with the report such as line manager. -
WorkerType: string
Title:
Worker TypeRead Only:trueMaximum Length:30Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N).
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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:
trueInternal identifier for the worker's assignment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
NameRead Only:trueMaximum Length:80Business title of the assignment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 IDSurrogate identifier for the supervisor on workers assignment. -
DisplayName: string
Title:
NameRead Only:trueMaximum Length:240Person's display name. -
FirstName: string
Title:
First NameRead Only:trueMaximum Length:150Person's first name. -
JobCode: string
Title:
CodeRead Only:trueMaximum Length:30Code of the job for the manager assignment. -
JobName: string
Title:
JobRead Only:trueMaximum Length:240Name of the job for the manager assignment. -
KnownAs: string
Title:
Known AsRead Only:trueMaximum Length:80Person's preferred name. -
LastName: string
Title:
Last NameRead Only:trueMaximum Length:150Person's last name. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManagerAssignmentId: integer
(int64)
Title:
Manager Assignment IDSurrogate identifier for the assignment supervisor. -
ManagerAssignmentName: string
Title:
Assignment NameRead Only:trueMaximum Length:80Assignment name of the supervisor. -
ManagerAssignmentNumber: string
Title:
Assignment NumberRead Only:trueMaximum Length:30Assignment number of the supervisor. -
ManagerPersonId: integer
(int64)
Title:
Manager IDSurrogate identifier for the supervisor. -
ManagerPersonNumber: string
Title:
Person NumberRead Only:trueMaximum Length:30Person Number of the supervisor. -
ManagerType: string
Title:
Manager TypeMaximum Length:30Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. -
ManagerTypeMeaning: string
Title:
Manager TypeRead Only:trueMaximum Length:80Name 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:
ImageUnique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo IDSurrogate identifier for the supervisor photo. -
PhotoName: string
Title:
Photo NameMaximum Length:240Name of the image file of the supervisor. -
PositionCode: string
Title:
CodeRead Only:trueMaximum Length:30Code of the position for the manager assignment. -
PositionName: string
Title:
PositionRead Only:trueMaximum Length:240Name of the position for the manager assignment. -
WorkEmail: string
Title:
Work EmailRead Only:trueMaximum Length:240Manager's work e-mail address.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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:
trueInternal identifier for the responsibility. -
AssignmentNumber: string
Title:
Assignment NumberRead Only:trueMaximum Length:30Assignment number of the representative. -
DisplayName: string
Title:
Display NameRead Only:trueMaximum Length:240Display name of the representative. -
FirstName: string
Title:
First NameRead Only:trueMaximum Length:150Person's first name. -
FromDate: string
(date)
Title:
From DateRead Only:trueDate when the responsibility starts. -
KnownAs: string
Title:
Known AsRead Only:trueMaximum Length:80Person's preferred name. -
LastName: string
Title:
Last NameRead Only:trueMaximum Length:150Person's last name. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PersonId: integer
(int64)
Read Only:
trueInternal identifier for the representative. -
PersonNumber: string
Title:
Person NumberRead Only:trueMaximum Length:30Person number of the representative. -
Photo: string
(byte)
Title:
ImageUnique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo IDSurrogate identifier for the representative photo. -
PhotoName: string
Title:
Photo NameMaximum Length:240Name of the image file of the representative. -
ResponsibilityName: string
Title:
Responsibility NameRead Only:trueMaximum Length:240Name of the responsibility type of the representative such as Benefits Representative. -
ResponsibilityType: string
Title:
Responsibility TypeRead Only:trueMaximum Length:80Responsibility type of the representative such as Human Resource Representative. -
ToDate: string
(date)
Title:
To DateRead Only:trueDate when the responsibility ends. -
Usage: string
Read Only:
trueMaximum Length:4000Description of the purpose for the responsibility. -
WorkContactsFlag: boolean
Title:
Work ContactsRead Only:trueMaximum Length:30Indicates whether the representatives should be displayed. -
WorkEmail: string
Title:
Work EmailRead Only:trueMaximum Length:240Representative's work e-mail address.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 DateRead Only:trueDate from when the message is valid. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageContent: string
Title:
MessageRead Only:trueMaximum Length:4000Content of the message. -
MessageId: integer
(int64)
Read Only:
trueSurrogate identifier for the worker message. -
ToDate: string
(date-time)
Title:
To DateRead Only:trueDate until when the message is valid.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-otherCommunicationAccounts-item-response
Type:
Show Source
object-
AccountName: string
Title:
Account NameRead Only:trueMaximum Length:1000Name of the account. -
DateEnd: string
(date)
Title:
To DateRead Only:trueEnd date of the account. -
DateStart: string
(date)
Title:
From DateRead Only:trueStart date of the account. -
DeliveryMethodId: integer
(int64)
Read Only:
trueSurrogate identifier for the delivery method. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Provider: string
Title:
ProviderRead Only:trueMaximum Length:30Provider of the account such as Facebook and Twitter. Valid values are defined in the commonLookupsLOV.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-phones-item-response
Type:
Show Source
object-
AreaCode: string
Title:
Area CodeRead Only:trueMaximum Length:30Area code of the phone number. -
CountryCodeNumber: string
Title:
Country CodeRead Only:trueMaximum Length:30Country code of the phone number. -
Extension: string
Title:
ExtensionRead Only:trueMaximum Length:60Extension number for the phone. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PhoneId: integer
(int64)
Read Only:
trueInternal identifier for the phone. -
PhoneNumber: string
Title:
NumberRead Only:trueMaximum Length:60Phone number of various phone types such as Work, Home, and so on. -
PhoneType: string
Title:
TypeRead Only:trueMaximum Length:30Type of phone such as Work, Home, and so on. -
PhoneTypeMeaning: string
Title:
MeaningRead Only:trueMaximum Length:80Meaning of the phone type lookup code. -
PrimaryFlag: boolean
Title:
PrimaryRead Only:trueIndicates whether the phone number is the primary phone of the worker.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicWorkers-photos-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Photo: string
(byte)
Title:
ImageUnique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo IDInternal identifier for the photo. -
PhotoName: string
Title:
Photo NameMaximum Length:240Name of the image file. -
PhotoType: string
Title:
TypeMaximum Length:30Default Value:PROFILEType of photo, such as Profile or Cover. -
PrimaryFlag: boolean
Title:
PrimaryMaximum Length:30Default Value:falseIndicates whether the image is primary.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Examples
The following example shows how to retrieve all the workers 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"
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.
{
"items": [
{
"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]
},
{
"PersonId": 300100026061694,
"PersonNumber": "955160008176029",
"LastName": "Ball",
"FirstName": "Matt",
"Title": null,
"PreNameAdjunct": null,
"Suffix": null,
"MiddleNames": null,
"Honors": null,
"KnownAs": null,
"DisplayName": "Matt Ball",
"ListName": "Ball, Matt",
"WorkEmail": "Matt.Ball@ymail.com",
"Username": "Matt.Ball"
"links" : [5]
},
{
"PersonId": 300100026062598,
"PersonNumber": "955160008176030",
"LastName": "Aaron",
"FirstName": "Susan",
"Title": null,
"PreNameAdjunct": null,
"Suffix": null,
"MiddleNames": null,
"Honors": null,
"KnownAs": null,
"DisplayName": "Susan Aaron",
"ListName": "Aaron, Susan",
"WorkEmail": "Susan.Aaron@ymail.com",
"Username": "Susan.Aaron"
"links" : [5]
},
{
"PersonId": 300100026191328,
"PersonNumber": "955160008176063",
"LastName": "White",
"FirstName": "Laura",
"Title": null,
"PreNameAdjunct": null,
"Suffix": null,
"MiddleNames": null,
"Honors": null,
"KnownAs": null,
"DisplayName": "Laura White",
"ListName": "White, Laura",
"WorkEmail": "Laura.White@ymail.com",
"Username": "Laura.White"
"links" : [5]
},
{
"PersonId": 300100026197786,
"PersonNumber": "955160008176070",
"LastName": "Mahajan",
"FirstName": "Kapil",
"Title": null,
"PreNameAdjunct": null,
"Suffix": null,
"MiddleNames": null,
"Honors": null,
"KnownAs": null,
"DisplayName": "Kapil Mahajan",
"ListName": "Mahajan, Kapil",
"WorkEmail": "kapil.mahajan@ymail.com",
"Username": "kapil.mahajan"
"links": [5]
{
...}
]
}