Get all agency staff
get
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees
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 employee row that matches the specified search criteria.
Finder Variables:- PersonId; integer; The key identifier of the person for whom the row is created.
- getPersonWithUsername: Finds the employee that matches the specified user name.
Finder Variables: - simpleSearchFinder: Finds the employee that matches the specified search criteria.
Finder Variables:- value; string; Finds the employee that matches the specified search criteria.
- PrimaryKey: Finds the employee row that matches the specified search 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.
- CreatedBy; string; The name of the user who created the row.
- CreationDate; string; The date and time when the row was created.
- DepartmentId; string; The identifier of the department of the public sector agency.
- EnabledFlag; string; Indicates that the public sector profile of the person is available to be used.
- IsSupervisor; string; Indicates that the employee is a supervisor.
- JobFuncGrpId; string; The identifier of the job group to which the employee is assigned.
- JobTitleId; string; The identifier of the job title of the employee.
- LastUpdateDate; string; The date and time when the row was last updated.
- LastUpdatedBy; string; The name of the user who last updated the row.
- PersonId; integer; The identifier of the person for whom the record is created.
- PersonUserName; string; The user name of the person.
-
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 : publicSectorEmployees
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 : publicSectorEmployees-item-response
Type:
Show Source
object-
AgencyAddressId: integer
(int64)
Title:
Agency LocationThe identifier of the location of the public sector agency. -
AgencyId: integer
(int32)
Title:
Agency IDDefault Value:1The identifier of the public sector agency. -
BusinessUnit: string
Title:
Business UnitThe name of the business unit in which the employee is created. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the row was created. -
DepartmentId: string
Title:
Agency DepartmentMaximum Length:30The identifier of the department of the public sector agency. -
EmailAddress: string
Title:
EmailThe email ID of the person. -
EnabledFlag: string
Title:
EnabledMaximum Length:1Default Value:YIndicates that the public sector profile of the person is available to be used. -
FirstName: string
Title:
First NameThe first name of the person. -
GeneratedUserAccountFlag: string
Title:
Generated User AccountIndicates that a user account is to be created at the time of creation of the profile. -
HireDate: string
(date)
Title:
Hire DateThe hiring date of the employee. -
IsSupervisor: string
Title:
Is SupervisorMaximum Length:1Indicates that the employee is a supervisor. -
JobFuncGrpId: string
Title:
Job GroupMaximum Length:50The identifier of the job group to which the employee is assigned. -
JobTitleId: string
Title:
Job TitleMaximum Length:50The identifier of the job title of the employee. -
LastName: string
Title:
Last NameThe last name of the person. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The name of the user who last updated the row. -
LegalEntity: string
Title:
Legal EntityThe name of the employee's legal employer. -
LinkExistingUserFlag: string
Indicates that the person should be linked to an existing user account.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManagerPersonNumber: string
Title:
ManagerThe identifier of the person number of the manager to whom the employee reports. -
PersonId: integer
(int64)
Title:
Worker IDDefault Value:0The identifier of the person for whom the record is created. -
PersonJobFunctions: array
Person Job Functions
Title:
Person Job FunctionsThe person job functions resource is used to view the list of job functions that are assigned to a person. -
PersonNumber: string
Title:
Person NumberA unique identifier of the person. Note that the assignment of the value is not determined by the type of person, such as an employee or a contingent worker. -
PersonType: string
Title:
Person TypeThe type of employment. The default value for the field is Employee. -
PersonUserName: string
Read Only:
trueThe user name of the person. -
SendCredentialsEmailFlag: string
Title:
Send Credentials EmailIndicates that the user should be notified by an email with the details of the credentials after an user account is created. -
UserGUID: string
Read Only:
trueA global unique identifier of the person. -
UserId: integer
Read Only:
trueA unique identifier of the person. -
Username: string
Title:
User NameThe user name assigned to the employee. -
WorkPhoneNumber: string
Title:
Work Phone NumberThe work phone number of the employee.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Person Job Functions
Type:
arrayTitle:
Person Job FunctionsThe person job functions resource is used to view the list of job functions that are assigned to a person.
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 : publicSectorEmployees-PersonJobFunctions-item-response
Type:
Show Source
object-
AgencyId: integer
(int32)
Title:
Agency IDDefault Value:1An identifier of the public sector agency. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the row was created. -
EnabledFlag: string
Title:
EnabledMaximum Length:1Indicates that the job functions and the associated job attributes are available for the employee to use. -
JobFuncId: string
Title:
Job Function IDMaximum Length:50A unique identifier of the job function. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The name of the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PersJobFuncId: integer
(int64)
An identifier of the unique row using an auto generated number.
-
PersonId: integer
(int64)
An identifier of the person for whom the row is created.
-
PersonJobFuncAssignments: array
Person Job Attributes
Title:
Person Job AttributesThe person job attributes resource is used to list the job attributes and their values assigned to a person.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Person Job Attributes
Type:
arrayTitle:
Person Job AttributesThe person job attributes resource is used to list the job attributes and their values assigned to a person.
Show Source
Nested Schema : publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item-response
Type:
Show Source
object-
AgencyId: integer
(int32)
Title:
Agency IDDefault Value:1An identifier of the public sector agency. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the row was created. -
EnabledFlag: string
Title:
EnabledMaximum Length:1Indicates that the job attribute is available for the employee to use. -
JobFuncId: string
Title:
Job Function IDMaximum Length:50A unique identifier of the job function. -
JobFuncSecId: string
Title:
Job AttributeMaximum Length:50A unique identifier of the job attribute. -
JobFuncSectnValue: string
Title:
Attribute ValueMaximum Length:1000A unique value of the job attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The name of the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PersJobFuncAssignId: integer
(int64)
An identifier for the row assigned using an auto generated number.
-
PersJobFuncId: integer
(int64)
An identifier for the unique row assigned using an auto generated number.
-
PersonId: integer
(int64)
The name of the person for whom the row was created.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source