Get all persons
get
/fscmRestApi/resources/11.13.18.05/publicSectorPersonDetails
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 the persons that match the specified primary key criteria.
Finder Variables:- PersonId; integer.
- findPersonByCEDistrictTypeAndDistrictID: Finds the person that matches the specified district type and district ID.
Finder Variables:- pEnabled; string; Finds the person based on the record with enabled flag.
- pJobFuncSectnValue; string; Processes the district type job function as a parameter.
- pJobFuncSectnValue2; string; Processes the district ID job section as a parameter.
- findPersonByJobFuncId: Finds the person ID using the job function.
Finder Variables:- pJobFuncId; string; Finds the person ID using the job function as the parameter.
- findPersonByJobFuncIdAndSecId: Finds the person that matches the specified job function and section.
Finder Variables:- pJobFuncId; string; Processes the job function as a parameter.
- pJobFuncSecId; string; Processes the job section as a parameter.
- findPersonByJobFuncIdAndSecIdAndSecValue: Finds the person that matches the specified job function, section, and section value.
Finder Variables:- pJobFuncId; string; Processes the job function as a parameter.
- pJobFuncSecId; string; Processes the job section as a parameter.
- pJobFuncSectnValue; string; Processes the job section value as a parameter.
- findPersonByJobFunctionAttributeValue: Finds the person that matches the specified job function attributes.
Finder Variables:- pJobFuncId; string; Processes the job function as a parameter.
- pJobFuncSecId; string; Processes the job section as a parameter.
- pJobFuncSectnValue; string; Processes the job section value as a parameter.
- simpleSearchFinder: Finds the person that matches the specified key word.
Finder Variables:- value; string; The key word used to match and find a person.
- PrimaryKey: Finds the persons that match the specified primary key criteria.
-
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:- AgencyAddressId; integer; The identifier of the location of the public sector agency.
- AgencyId; integer; The identifier of the public sector agency.
- AssignmentType; string; The identifier of the type of record. A record can be an assignment such as an employee, an applicant, CWK, or a non worker. A set of terms can also form a record.
- BillRate; number; The bill rate for time recording.
- BillRateFrequency; string; The bill rate frequency for time recording.
- BusinessUnitId; integer; Identifies the business unit to which employee belongs.
- BusinessUnitName; string; Name of the business unit to which the person belongs.
- CurrencyCode; string; The bill rate currency code for time recording.
- DepartmentId; string; The identifier of the department of the public sector agency.
- DisplayName; string; The name of the person as present in the application.
- EmailAddress; string; The work email of the person.
- EnabledFlag; string; Indicates if the public sector profile of the person is available to be used.
- FirstName; string; The first name of the person.
- HireDate; string; Indicates the hiring date of the employee.
- IsSupervisor; string; Indicates if the employee is a supervisor.
- JobFuncGrpId; string; Indicates if the public sector profile of the person is available to be used.
- JobTitleId; string; The identifier of the job title assigned to the employee.
- LastName; string; The last name of the person.
- LegalEmployer; string; The employee's legal employer.
- ListName; string; The name as shown on the search criteria.
- Manager; string; Indicates if the person is a manager.
- PersonId; integer; The identifier of the person for which the row was created.
- PersonNumber; string; The unique identifier of the person. The value is not determined based on the type of person, which can be an employee or a contingent worker.
- PhoneNumber; string; The work phone number.
- SystemPersonType; string; The identifier of the person type that is included by the Fusion development teams.
- UserId; integer; The unique identifier of the person.
- Username; string; The identifier of the user name to be assigned to the employee.
- WorkerPersonType; string; Indicates the type of employment. The default value is 'Employee'.
-
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 : publicSectorPersonDetails
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:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPersonDetails-item-response
Type:
Show Source
object
-
AgencyAddressId: integer
(int64)
Title:
Agency Location
Read Only:true
The identifier of the location of the public sector agency. -
AgencyId: integer
(int32)
Title:
Agency ID
Read Only:true
The identifier of the public sector agency. -
AssignmentType: string
Title:
Assignment Type
Read Only:true
Maximum Length:30
The identifier of the type of record. A record can be an assignment such as an employee, an applicant, CWK, or a non worker. A set of terms can also form a record. -
BillRate: number
Read Only:
true
The bill rate for time recording. -
BillRateFrequency: string
Read Only:
true
Maximum Length:30
The bill rate frequency for time recording. -
BusinessUnitId: integer
(int64)
Read Only:
true
Identifies the business unit to which employee belongs. -
BusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the business unit to which the person belongs. -
CurrencyCode: string
Read Only:
true
Maximum Length:3
The bill rate currency code for time recording. -
DepartmentId: string
Title:
Agency Department
Read Only:true
Maximum Length:30
The identifier of the department of the public sector agency. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
The name of the person as present in the application. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:240
The work email of the person. -
EnabledFlag: string
Title:
Enabled
Read Only:true
Maximum Length:1
Indicates if the public sector profile of the person is available to be used. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the person. -
HireDate: string
(date)
Title:
Start Date
Read Only:true
Indicates the hiring date of the employee. -
IsSupervisor: string
Title:
Is Supervisor
Read Only:true
Maximum Length:1
Indicates if the employee is a supervisor. -
JobFuncGrpId: string
Title:
Job Group
Read Only:true
Maximum Length:50
Indicates if the public sector profile of the person is available to be used. -
JobTitleId: string
Title:
Job Title
Read Only:true
Maximum Length:50
The identifier of the job title assigned to the employee. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the person. -
LegalEmployer: string
Title:
Legal Employer
Read Only:true
Maximum Length:240
The employee's legal employer. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListName: string
Title:
Name
Read Only:true
Maximum Length:240
The name as shown on the search criteria. -
Manager: string
Title:
Manager
Read Only:true
Maximum Length:240
Indicates if the person is a manager. -
PersonId: integer
(int64)
Read Only:
true
The identifier of the person for which the row was created. -
PersonJobFuncAssignmentP: array
Person Job Attributes
Title:
Person Job Attributes
The person job attributes resource is used to list the job attributes and their values assigned to a person. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
The unique identifier of the person. The value is not determined based on the type of person, which can be an employee or a contingent worker. -
PhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:60
The work phone number. -
SystemPersonType: string
Title:
System Person Type
Read Only:true
Maximum Length:30
The identifier of the person type that is included by the Fusion development teams. -
UserGuid: string
Read Only:
true
Maximum Length:64
The global unique identifier of the person. -
UserId: integer
(int64)
Read Only:
true
The unique identifier of the person. -
Username: string
Title:
User Name
Read Only:true
Maximum Length:100
The identifier of the user name to be assigned to the employee. -
WorkerPersonType: string
Title:
Worker Person Type
Read Only:true
Maximum Length:80
Indicates the type of employment. The default value is 'Employee'.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Person Job Attributes
Type:
array
Title:
Person Job Attributes
The person job attributes resource is used to list the job attributes and their values assigned to a person.
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 : publicSectorPersonDetails-PersonJobFuncAssignmentP-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Read Only:
true
The identifier of the public sector agency. -
EnabledFlag: string
Read Only:
true
Maximum Length:1
Indicates if the job function and the attribute assignment are available to be used. -
JobFuncId: string
Read Only:
true
Maximum Length:50
The unique identifier of the job function. -
JobFuncSecId: string
Read Only:
true
Maximum Length:200
The unique identifier of the job attribute. -
JobFuncSectnValue: string
Read Only:
true
Maximum Length:4000
The unique value of the job attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersJobFuncAssignId: integer
(int64)
Read Only:
true
The auto generated identifier of the row. -
PersJobFuncId: integer
(int64)
Read Only:
true
The auto generated identifier of the unique row. -
PersonId: integer
(int64)
Read Only:
true
The identifier of the person for which the data is recorded.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source