Get all persons

get

/fscmRestApi/resources/11.13.18.05/publicSectorPersons

Request

Query Parameters
  • 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).
  • 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
  • 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
      Finder Variables:
      • PersonId
    • findPersonByCEDistrictTypeAndDistrictID
      Finder Variables:
      • pEnabled
      • pJobFuncSectnValue
      • pJobFuncSectnValue2
    • findPersonByJobFuncId
      Finder Variables:
      • pJobFuncId
    • findPersonByJobFuncIdAndSecId
      Finder Variables:
      • pJobFuncId
      • pJobFuncSecId
    • findPersonByJobFuncIdAndSecIdAndSecValue
      Finder Variables:
      • pJobFuncId
      • pJobFuncSecId
      • pJobFuncSectnValue
    • findPersonByJobFunctionAttributeValue
      Finder Variables:
      • pJobFuncId
      • pJobFuncSecId
      • pJobFuncSectnValue
    • getPscPersons
      Finder Variables:
      • simpleSearchFinder
        Finder Variables:
        • value
    • 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.
    • 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
    • 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.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • 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
    • 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. 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.
      • BillRate; number; The bill rate for time recording.
      • BillRateFrequency; string; The bill rate frequency for time recording.
      • BusinessUnitId; integer; The identifier the business unit that the employee belongs to.
      • BusinessUnitName; string; The name of the business unit that the person belongs to.
      • 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 shown in the application.
      • EmailAddress; string; The work email address 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 that id assigned to the employee.
      • LastName; string; The last name of the person.
      • LegalEmployer; string; The identifier of the legal employer of the employee.
      • ListName; string; The name of the person as shown in the search criteria.
      • Manager; string; Indicates that the person is a manager.
      • MangaerPersonNumber; string; The identifier of the manager to whom the employee reports.
      • PersonId; integer; The identifier of the person for whom the row records data.
      • PersonNumber; string; The identifier of the person. The value is not determined by the type of person, such as an employee or a contingent worker.
      • PhoneNumber; string; The work phone number of the person.
      • SystemPersonType; string; The identifier of the type of the person. This field allows a valid person type that was included by the Fusion development teams.
      • UserId; integer; The unique identifier of the person.
      • Username; string; The identifier of the user name that is to be assigned to the employee.
      • WorkerPersonType; string; Indicates the type of the employment. The default value is 'Employee'.
    • 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
    • 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".
    • 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 Top

    Response

    Supported Media Types

    Default Response

    The following table describes the default response for this task.
    Headers
    • 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".
    • 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.
    Body ()
    Root Schema : publicSectorPersons
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : publicSectorPersons-item-response
    Type: object
    Show Source
    • Title: Agency Location
      Read Only: true
      The identifier of the location of the public sector agency.
    • Title: Agency ID
      Read Only: true
      The identifier of the public sector agency.
    • Title: Assignment Type
      Read Only: true
      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.
    • Read Only: true
      The bill rate for time recording.
    • Read Only: true
      Maximum Length: 30
      The bill rate frequency for time recording.
    • Read Only: true
      The identifier the business unit that the employee belongs to.
    • Title: Business Unit
      Read Only: true
      Maximum Length: 240
      The name of the business unit that the person belongs to.
    • Read Only: true
      Maximum Length: 3
      The bill rate currency code for time recording.
    • Title: Agency Department
      Read Only: true
      Maximum Length: 30
      The identifier of the department of the public sector agency.
    • Title: Name
      Read Only: true
      Maximum Length: 240
      The name of the person as shown in the application.
    • Title: Email
      Read Only: true
      Maximum Length: 240
      The work email address of the person.
    • Title: Enabled
      Read Only: true
      Maximum Length: 1
      Indicates if the public sector profile of the person is available to be used.
    • Title: First Name
      Read Only: true
      Maximum Length: 150
      The first name of the person.
    • Title: Start Date
      Read Only: true
      Indicates the hiring date of the employee.
    • Title: Is Supervisor
      Read Only: true
      Maximum Length: 1
      Indicates if the employee is a supervisor.
    • Title: Job Group
      Read Only: true
      Maximum Length: 50
      Indicates if the public sector profile of the person is available to be used.
    • Title: Job Title
      Read Only: true
      Maximum Length: 50
      The identifier of the job title that id assigned to the employee.
    • Title: Last Name
      Read Only: true
      Maximum Length: 150
      The last name of the person.
    • Title: Legal Employer
      Read Only: true
      Maximum Length: 240
      The identifier of the legal employer of the employee.
    • Links
    • Title: Name
      Read Only: true
      Maximum Length: 240
      The name of the person as shown in the search criteria.
    • Title: Manager
      Read Only: true
      Maximum Length: 240
      Indicates that the person is a manager.
    • Title: Person Number
      Read Only: true
      Maximum Length: 30
      The identifier of the manager to whom the employee reports.
    • Read Only: true
      The identifier of the person for whom the row records data.
    • 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.
    • Title: Person Number
      Read Only: true
      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.
    • Title: Phone
      Read Only: true
      Maximum Length: 60
      The work phone number of the person.
    • Title: System Person Type
      Read Only: true
      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.
    • Read Only: true
      Maximum Length: 64
      The unique global identifier of the person.
    • Read Only: true
      The unique identifier of the person.
    • Title: User Name
      Read Only: true
      Maximum Length: 100
      The identifier of the user name that is to be assigned to the employee.
    • Title: Worker Person Type
      Read Only: true
      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 person job attributes resource is used to list the job attributes and their values assigned to a person.
    Show Source
    Nested Schema : publicSectorPersons-PersonJobFuncAssignmentP-item-response
    Type: object
    Show Source
    Back to Top