Get all persons
get
/fscmRestApi/resources/11.13.18.05/publicSectorPersons
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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> -
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPersons
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPersons-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. -
AssignmentType(optional):
string
Title:
Assignment Type
Maximum Length:30
The identifier of the type of record. The type of record can be a set of terms or it can be an assignment such as an employee, a CWK, an applicant, or a non-worker. -
BusinessUnitId(optional):
integer(int64)
The identifier the business unit that the employee belongs to.
-
BusinessUnitName(optional):
string
Title:
Business Unit
Maximum Length:240
The name of the business unit that the person belongs to. -
DepartmentId(optional):
string
Title:
Agency Department
Maximum Length:30
The identifier of the department of the public sector agency. -
DisplayName(optional):
string
Title:
Name
Maximum Length:240
The name of the person as shown in the application. -
EmailAddress(optional):
string
Title:
Email
Maximum Length:240
The work email address of the person. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates if the public sector profile of the person is available to be used. -
FirstName(optional):
string
Title:
First Name
Maximum Length:150
The first name of the person. -
HireDate(optional):
string(date)
Title:
Start Date
Indicates the hiring date of the employee. -
IsSupervisor(optional):
string
Title:
Is Supervisor
Maximum Length:1
Indicates if the employee is a supervisor. -
JobFuncGrpId(optional):
string
Title:
Job Group
Maximum Length:50
Indicates if the public sector profile of the person is available to be used. -
JobTitleId(optional):
string
Title:
Job Title
Maximum Length:50
The identifier of the job title that id assigned to the employee. -
LastName(optional):
string
Title:
Last Name
Maximum Length:150
The last name of the person. -
LegalEmployer(optional):
string
Title:
Legal Employer
Maximum Length:240
The identifier of the legal employer of the employee. -
links(optional):
array Items
Title:
Items
Link Relations -
ListName(optional):
string
Title:
Name
Maximum Length:240
The name of the person as shown in the search criteria. -
Manager(optional):
string
Title:
Manager
Maximum Length:240
Indicates that the person is a manager. -
MangaerPersonNumber(optional):
string
Title:
Person Number
Maximum Length:30
The identifier of the manager to whom the employee reports. -
PersonId(optional):
integer(int64)
The identifier of the person for whom the row records data.
-
PersonJobFuncAssignmentP(optional):
array Person Job Attributes
Title:
Person Job Attributes
The persons resource is used to list all the persons in the agency. -
PersonNumber(optional):
string
Title:
Person Number
Maximum Length:30
The identifier of the person. The value is not determined by the type of person, such as an employee or a contingent worker. -
PhoneNumber(optional):
string
Title:
Phone
Maximum Length:60
The work phone number of the person. -
SystemPersonType(optional):
string
Title:
System Person Type
Maximum Length:30
The identifier of the type of the person. This field allows a valid person type that was included by the Fusion development teams. -
UserGuid(optional):
string
Maximum Length:
64
The unique global identifier of the person. -
UserId(optional):
integer(int64)
The unique identifier of the person.
-
Username(optional):
string
Title:
User Name
Maximum Length:100
The identifier of the user name that is to be assigned to the employee. -
WorkerPersonType(optional):
string
Title:
Worker Person Type
Maximum Length:80
Indicates the type of the employment. The default value is 'Employee'.
Nested Schema : Person Job Attributes
Type:
array
Title:
Person Job Attributes
The persons resource is used to list all the persons in the agency.
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 : publicSectorPersons-PersonJobFuncAssignmentP-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The identifier of the public sector agency.
-
EnabledFlag(optional):
string
Maximum Length:
1
Indicates if the job function and the attribute assignments are available to be used. -
JobFuncId(optional):
string
Maximum Length:
50
The unique identifier of the job function. -
JobFuncSecId(optional):
string
Maximum Length:
200
The unique identifier of the job attribute. -
JobFuncSectnValue(optional):
string
Maximum Length:
4000
The unique value of the job attribute. -
links(optional):
array Items
Title:
Items
Link Relations -
PersJobFuncAssignId(optional):
integer(int64)
The auto generated identifier of the unique row.
-
PersJobFuncId(optional):
integer(int64)
The auto generated number to identify the unique row.
-
PersonId(optional):
integer(int64)
The identifier of the person for whom the row records data.