Get an agency staff
get
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}
Request
Path Parameters
-
PersonId(required): integer(int64)
The identifier of the person for whom the record is created.
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(required):
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(required):
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-item-response
Type:
Show Source
object
-
AgencyAddressId: integer
(int64)
Title:
Agency Location
The identifier of the location of the public sector agency. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the public sector agency. -
BusinessUnit: string
Title:
Business Unit
The name of the business unit in which the employee is created. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DepartmentId: string
Title:
Agency Department
Maximum Length:30
The identifier of the department of the public sector agency. -
EmailAddress: string
Title:
Email
The email ID of the person. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates that the public sector profile of the person is available to be used. -
FirstName: string
Title:
First Name
The first name of the person. -
GeneratedUserAccountFlag: string
Title:
Generated User Account
Indicates that a user account is to be created at the time of creation of the profile. -
HireDate: string
(date)
Title:
Hire Date
The hiring date of the employee. -
IsSupervisor: string
Title:
Is Supervisor
Maximum Length:1
Indicates that the employee is a supervisor. -
JobFuncGrpId: string
Title:
Job Group
Maximum Length:50
The identifier of the job group to which the employee is assigned. -
JobTitleId: string
Title:
Job Title
Maximum Length:50
The identifier of the job title of the employee. -
LastName: string
Title:
Last Name
The last name of the person. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
LegalEntity: string
Title:
Legal Entity
The 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:
Links
The link relations associated with the resource instance. -
ManagerPersonNumber: string
Title:
Manager
The identifier of the person number of the manager to whom the employee reports. -
PersonId: integer
(int64)
Title:
Worker ID
Default Value:0
The identifier of the person for whom the record is created. -
PersonJobFunctions: array
Person Job Functions
Title:
Person Job Functions
The person job functions resource is used to view the list of job functions that are assigned to a person. -
PersonNumber: string
Title:
Person Number
A 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 Type
The type of employment. The default value for the field is Employee. -
PersonUserName: string
Read Only:
true
The user name of the person. -
SendCredentialsEmailFlag: string
Title:
Send Credentials Email
Indicates 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:
true
A global unique identifier of the person. -
UserId: integer
Read Only:
true
A unique identifier of the person. -
Username: string
Title:
User Name
The user name assigned to the employee. -
WorkPhoneNumber: string
Title:
Work Phone Number
The work phone number of the employee.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Person Job Functions
Type:
array
Title:
Person Job Functions
The 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 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 : publicSectorEmployees-PersonJobFunctions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
An identifier of the public sector agency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates that the job functions and the associated job attributes are available for the employee to use. -
JobFuncId: string
Title:
Job Function ID
Maximum Length:50
A unique identifier of the job function. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The 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 Attributes
The person job attributes resource is used to list the job attributes and their values assigned to a person.
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 : publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
An identifier of the public sector agency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates that the job attribute is available for the employee to use. -
JobFuncId: string
Title:
Job Function ID
Maximum Length:50
A unique identifier of the job function. -
JobFuncSecId: string
Title:
Job Attribute
Maximum Length:50
A unique identifier of the job attribute. -
JobFuncSectnValue: string
Title:
Attribute Value
Maximum Length:1000
A unique value of the job attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PersonJobFunctions
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctionsParameters:
- PersonId:
$request.path.PersonId
The person job functions resource is used to view the list of job functions that are assigned to a person. - PersonId: