Jump to

• Request
• Response

Get all persons

get

/fscmRestApi/resources/11.13.18.05/publicSectorPersonDetails

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>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • findPersonByJobFuncIdAndSecId: Finds the person that matches the specified Job Function and Section. Finder Variables:
    • pJobFuncId; string; Processes the job function as a parameter.
    • pJobFuncSecId; string; Processes the job section as a parameter.
  • findPersonByJobFuncIdAndSecIdAndSecValue: Finds the person that matches the specified Job Function, Section and Section value. Finder Variables:
    • pJobFuncId; string; Processes the job function as a parameter.
    • pJobFuncSecId; string; Processes the job section as a parameter.
    • pJobFuncSectnValue; string; Processes the job section value as a parameter.
  • simpleSearchFinder: Finds the person that matches the specified key word. Finder Variables:
    • value; string; The key word used to match and find a person.
  • findPersonByJobFuncId: Finds the person ID by passing the job function. Finder Variables:
    • pJobFuncId; string; Finds the person ID by passing the job function as parameter.
  • PrimaryKey: Finds the persons that match the specified primary key criteria. Finder Variables:
    • UserId; integer; The unique identifier of the person.
• 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".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorPersonDetails

Type: object

Show Source

• 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.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorPersonDetails-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPersonDetails-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPersonDetails-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorPersonDetails-item

Type: object

Show Source

• 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. A record can be an assignment such as an employee, an applicant, CWK, or a non worker. A set of terms can also form a record.
• BusinessUnitId(optional): integer(int64)
  Identifies the business unit to which employee belongs.
• BusinessUnitName(optional): string
  Title: Business Unit

  Maximum Length: 240

  Name of the business unit to which the person belongs.
• 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 present in the application.
• EmailAddress(optional): string
  Title: Email

  Maximum Length: 240

  The work email 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 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 employee's legal employer.
• links(optional): array Items
  Title: Items

  Link Relations
• ListName(optional): string
  Title: Name

  Maximum Length: 240

  The name as shown on the search criteria.
• Manager(optional): string
  Title: Manager

  Maximum Length: 240

  Indicates if the person is a manager.
• PersonId(optional): integer(int64)
  The identifier of the person for which the row was created.
• PersonJobFuncAssignmentP(optional): array Person Job Attributes
  Title: Person Job Attributes

  The person details resource is used to find the agency staff and their job functions, along with the attribute assignments and other HR attributes.
• PersonNumber(optional): string
  Title: Person Number

  Maximum Length: 30

  The unique identifier of the person. The value is not determined based on the type of person, which can be an employee or a contingent worker.
• PhoneNumber(optional): string
  Title: Phone

  Maximum Length: 60

  The work phone number.
• SystemPersonType(optional): string
  Title: System Person Type

  Maximum Length: 30

  The identifier of the person type that is included by the Fusion development teams.
• UserGuid(optional): string
  Maximum Length: 64

  The global unique 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 to be assigned to the employee.
• WorkerPersonType(optional): string
  Title: Worker Person Type

  Maximum Length: 80

  Indicates the type of employment. The default value is 'Employee'.

{
    "properties":{
        "AgencyAddressId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the location of the public sector agency.",
            "title":"Agency Location"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "AssignmentType":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the type of record. A record can be an assignment such as an employee, an applicant, CWK, or a non worker. A set of terms can also form a record.",
            "title":"Assignment Type"
        },
        "BusinessUnitId":{
            "format":"int64",
            "type":"integer",
            "description":"Identifies the business unit to which employee belongs."
        },
        "BusinessUnitName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit to which the person belongs.",
            "title":"Business Unit"
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the department of the public sector agency.",
            "title":"Agency Department"
        },
        "DisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the person as present in the application.",
            "title":"Name"
        },
        "EmailAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The work email of the person.",
            "title":"Email"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the public sector profile of the person is available to be used.",
            "title":"Enabled"
        },
        "FirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person.",
            "title":"First Name"
        },
        "HireDate":{
            "format":"date",
            "type":"string",
            "description":"Indicates the hiring date of the employee.",
            "title":"Start Date"
        },
        "IsSupervisor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the employee is a supervisor.",
            "title":"Is Supervisor"
        },
        "JobFuncGrpId":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates if the public sector profile of the person is available to be used.",
            "title":"Job Group"
        },
        "JobTitleId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the job title assigned to the employee.",
            "title":"Job Title"
        },
        "LastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person.",
            "title":"Last Name"
        },
        "LegalEmployer":{
            "maxLength":240,
            "type":"string",
            "description":"The employee's legal employer.",
            "title":"Legal Employer"
        },
        "ListName":{
            "maxLength":240,
            "type":"string",
            "description":"The name as shown on the search criteria.",
            "title":"Name"
        },
        "Manager":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates if the person is a manager.",
            "title":"Manager"
        },
        "PersonId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the person for which the row was created."
        },
        "PersonJobFuncAssignmentP":{
            "items":{
                "$ref":"#/definitions/publicSectorPersonDetails-PersonJobFuncAssignmentP-item"
            },
            "type":"array",
            "description":"The person details resource is used to find the agency staff and their job functions, along with the attribute assignments and other HR attributes.",
            "title":"Person Job Attributes"
        },
        "PersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the person. The value is not determined based on the type of person, which can be an employee or a contingent worker.",
            "title":"Person Number"
        },
        "PhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"The work phone number.",
            "title":"Phone"
        },
        "SystemPersonType":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the person type that is included by the Fusion development teams.",
            "title":"System Person Type"
        },
        "UserGuid":{
            "maxLength":64,
            "type":"string",
            "description":"The global unique identifier of the person."
        },
        "UserId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the person."
        },
        "Username":{
            "maxLength":100,
            "type":"string",
            "description":"The identifier of the user name to be assigned to the employee.",
            "title":"User Name"
        },
        "WorkerPersonType":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates the type of employment. The default value is 'Employee'.",
            "title":"Worker Person Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Person Job Attributes

Type: array

Title: Person Job Attributes

The person details resource is used to find the agency staff and their job functions, along with the attribute assignments and other HR attributes.

Show Source

• Array of: object publicSectorPersonDetails-PersonJobFuncAssignmentP-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPersonDetails-PersonJobFuncAssignmentP-item"
    },
    "type":"array",
    "description":"The person details resource is used to find the agency staff and their job functions, along with the attribute assignments and other HR attributes.",
    "title":"Person Job Attributes"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorPersonDetails-PersonJobFuncAssignmentP-item

Type: object

Show Source

• 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 assignment 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 row.
• PersJobFuncId(optional): integer(int64)
  The auto generated identifier of the unique row.
• PersonId(optional): integer(int64)
  The identifier of the person for which the data is recorded.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the job function and the attribute assignment are available to be used."
        },
        "JobFuncId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the job function."
        },
        "JobFuncSecId":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the job attribute."
        },
        "JobFuncSectnValue":{
            "maxLength":4000,
            "type":"string",
            "description":"The unique value of the job attribute."
        },
        "PersJobFuncAssignId":{
            "format":"int64",
            "type":"integer",
            "description":"The auto generated identifier of the row."
        },
        "PersJobFuncId":{
            "format":"int64",
            "type":"integer",
            "description":"The auto generated identifier of the unique row."
        },
        "PersonId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the person for which the data is recorded."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top