Update an agency staff
patch
/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
PersonId: integer
The identifier of the person for whom the record is created.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorEmployees-item
Type:
Show Source
object
-
AgencyAddressId(optional):
integer(int64)
Title:
Agency Location
The identifier of the location of the public sector agency. -
AgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the public sector agency. -
BusinessUnit(optional):
string
Title:
Business Unit
The name of the business unit in which the employee is created. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
DepartmentId(optional):
string
Title:
Agency Department
Maximum Length:30
The identifier of the department of the public sector agency. -
EmailAddress(optional):
string
Title:
Email
The email ID of the person. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates that the public sector profile of the person is available to be used. -
FirstName(optional):
string
Title:
First Name
Maximum Length:255
The first name of the person. -
GeneratedUserAccountFlag(optional):
string
Title:
Generated User Account
Indicates that a user account is to be created at the time of creation of the profile. -
HireDate(optional):
string(date)
Title:
Hire Date
The hiring date of the employee. -
IsSupervisor(optional):
string
Title:
Is Supervisor
Maximum Length:1
Indicates that the employee is a supervisor. -
JobFuncGrpId(optional):
string
Title:
Job Group
Maximum Length:50
The identifier of the job group to which the employee is assigned. -
JobTitleId(optional):
string
Title:
Job Title
Maximum Length:50
The identifier of the job title of the employee. -
LastName(optional):
string
Title:
Last Name
The last name of the person. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
LegalEntity(optional):
string
Title:
Legal Entity
The name of the employee's legal employer. -
links(optional):
array Items
Title:
Items
Link Relations -
ManagerPersonNumber(optional):
string
Title:
Manager
The identifier of the person number of the manager to whom the employee reports. -
PersonId(optional):
integer(int64)
Title:
Worker ID
The identifier of the person for whom the record is created. -
PersonJobFunctions(optional):
array Person Job Functions
Title:
Person Job Functions
The employees resource is used to list the attributes of the agency staff. -
PersonNumber(optional):
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(optional):
string
Title:
Person Type
The type of employment. The default value for the field is Employee. -
PersonUserName(optional):
string
The user name of the person.
-
SendCredentialsEmailFlag(optional):
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(optional):
string
A global unique identifier of the person.
-
UserId(optional):
integer(int64)
A unique identifier of the person.
-
Username(optional):
string
Title:
User Name
The user name assigned to the employee. -
WorkPhoneNumber(optional):
string
Title:
Work Phone Number
The work phone number of the employee.
Nested Schema : Person Job Functions
Type:
array
Title:
Person Job Functions
The employees resource is used to list the attributes of the agency staff.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorEmployees-PersonJobFunctions-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
An identifier of the public sector agency. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates that the job functions and the associated job attributes are available for the employee to use. -
JobFuncId(optional):
string
Title:
Job Function ID
Maximum Length:50
A unique identifier of the job function. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
PersJobFuncId(optional):
integer(int64)
An identifier of the unique row using an auto generated number.
-
PersonId(optional):
integer(int64)
An identifier of the person for whom the row is created.
-
PersonJobFuncAssignments(optional):
array Person Job Attributes
Title:
Person Job Attributes
The person job functions resource is used to view the list of job functions that are assigned to a person.
Nested Schema : Person Job Attributes
Type:
array
Title:
Person Job Attributes
The person job functions resource is used to view the list of job functions that are assigned to a person.
Show Source
Nested Schema : publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
An identifier of the public sector agency. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates that the job attribute is available for the employee to use. -
JobFuncId(optional):
string
Title:
Job Function ID
Maximum Length:50
A unique identifier of the job function. -
JobFuncSecId(optional):
string
Title:
Job Attribute
Maximum Length:50
A unique identifier of the job attribute. -
JobFuncSectnValue(optional):
string
Title:
Attribute Value
Maximum Length:1000
A unique value of the job attribute. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
PersJobFuncAssignId(optional):
integer(int64)
An identifier for the row assigned using an auto generated number.
-
PersJobFuncId(optional):
integer(int64)
An identifier for the unique row assigned using an auto generated number.
-
PersonId(optional):
integer(int64)
The name of the person for whom the row was created.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorEmployees-item
Type:
Show Source
object
-
AgencyAddressId(optional):
integer(int64)
Title:
Agency Location
The identifier of the location of the public sector agency. -
AgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the public sector agency. -
BusinessUnit(optional):
string
Title:
Business Unit
The name of the business unit in which the employee is created. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
DepartmentId(optional):
string
Title:
Agency Department
Maximum Length:30
The identifier of the department of the public sector agency. -
EmailAddress(optional):
string
Title:
Email
The email ID of the person. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates that the public sector profile of the person is available to be used. -
FirstName(optional):
string
Title:
First Name
Maximum Length:255
The first name of the person. -
GeneratedUserAccountFlag(optional):
string
Title:
Generated User Account
Indicates that a user account is to be created at the time of creation of the profile. -
HireDate(optional):
string(date)
Title:
Hire Date
The hiring date of the employee. -
IsSupervisor(optional):
string
Title:
Is Supervisor
Maximum Length:1
Indicates that the employee is a supervisor. -
JobFuncGrpId(optional):
string
Title:
Job Group
Maximum Length:50
The identifier of the job group to which the employee is assigned. -
JobTitleId(optional):
string
Title:
Job Title
Maximum Length:50
The identifier of the job title of the employee. -
LastName(optional):
string
Title:
Last Name
The last name of the person. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
LegalEntity(optional):
string
Title:
Legal Entity
The name of the employee's legal employer. -
links(optional):
array Items
Title:
Items
Link Relations -
ManagerPersonNumber(optional):
string
Title:
Manager
The identifier of the person number of the manager to whom the employee reports. -
PersonId(optional):
integer(int64)
Title:
Worker ID
The identifier of the person for whom the record is created. -
PersonJobFunctions(optional):
array Person Job Functions
Title:
Person Job Functions
The employees resource is used to list the attributes of the agency staff. -
PersonNumber(optional):
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(optional):
string
Title:
Person Type
The type of employment. The default value for the field is Employee. -
PersonUserName(optional):
string
The user name of the person.
-
SendCredentialsEmailFlag(optional):
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(optional):
string
A global unique identifier of the person.
-
UserId(optional):
integer(int64)
A unique identifier of the person.
-
Username(optional):
string
Title:
User Name
The user name assigned to the employee. -
WorkPhoneNumber(optional):
string
Title:
Work Phone Number
The work phone number of the employee.
Nested Schema : Person Job Functions
Type:
array
Title:
Person Job Functions
The employees resource is used to list the attributes of the agency staff.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorEmployees-PersonJobFunctions-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
An identifier of the public sector agency. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates that the job functions and the associated job attributes are available for the employee to use. -
JobFuncId(optional):
string
Title:
Job Function ID
Maximum Length:50
A unique identifier of the job function. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
PersJobFuncId(optional):
integer(int64)
An identifier of the unique row using an auto generated number.
-
PersonId(optional):
integer(int64)
An identifier of the person for whom the row is created.
-
PersonJobFuncAssignments(optional):
array Person Job Attributes
Title:
Person Job Attributes
The person job functions resource is used to view the list of job functions that are assigned to a person.
Nested Schema : Person Job Attributes
Type:
array
Title:
Person Job Attributes
The person job functions resource is used to view the list of job functions that are assigned to a person.
Show Source
Nested Schema : publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
An identifier of the public sector agency. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates that the job attribute is available for the employee to use. -
JobFuncId(optional):
string
Title:
Job Function ID
Maximum Length:50
A unique identifier of the job function. -
JobFuncSecId(optional):
string
Title:
Job Attribute
Maximum Length:50
A unique identifier of the job attribute. -
JobFuncSectnValue(optional):
string
Title:
Attribute Value
Maximum Length:1000
A unique value of the job attribute. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
PersJobFuncAssignId(optional):
integer(int64)
An identifier for the row assigned using an auto generated number.
-
PersJobFuncId(optional):
integer(int64)
An identifier for the unique row assigned using an auto generated number.
-
PersonId(optional):
integer(int64)
The name of the person for whom the row was created.