Jump to

• Request
• Response

Get a person

get

/fscmRestApi/resources/11.13.18.05/publicSectorPersons/{publicSectorPersonsUniqID}

Request

Path Parameters

• publicSectorPersonsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Persons resource and used to uniquely identify an instance of Persons. The client should not generate the hash key value. Instead, the client should query on the Persons collection resource in order to navigate to a specific instance of Persons to get the hash key.

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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorPersons-item-response

Type: object

Show Source

• AgencyAddressId: integer (int64)
  Title: Agency Location

  Read Only: true

  The identifier of the location of the public sector agency.
• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  The identifier of the public sector agency.
• AssignmentType: string
  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.
• BillRate: number
  Read Only: true

  The bill rate for time recording.
• BillRateFrequency: string
  Read Only: true

  Maximum Length: 30

  The bill rate frequency for time recording.
• BusinessUnitId: integer (int64)
  Read Only: true

  The identifier the business unit that the employee belongs to.
• BusinessUnitName: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  The name of the business unit that the person belongs to.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 3

  The bill rate currency code for time recording.
• DepartmentId: string
  Title: Agency Department

  Read Only: true

  Maximum Length: 30

  The identifier of the department of the public sector agency.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  The name of the person as shown in the application.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 240

  The work email address of the person.
• EnabledFlag: string
  Title: Enabled

  Read Only: true

  Maximum Length: 1

  Indicates if the public sector profile of the person is available to be used.
• FirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the person.
• HireDate: string (date)
  Title: Start Date

  Read Only: true

  Indicates the hiring date of the employee.
• IsSupervisor: string
  Title: Is Supervisor

  Read Only: true

  Maximum Length: 1

  Indicates if the employee is a supervisor.
• JobFuncGrpId: string
  Title: Job Group

  Read Only: true

  Maximum Length: 50

  Indicates if the public sector profile of the person is available to be used.
• JobTitleId: string
  Title: Job Title

  Read Only: true

  Maximum Length: 50

  The identifier of the job title that id assigned to the employee.
• LastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the person.
• LegalEmployer: string
  Title: Legal Employer

  Read Only: true

  Maximum Length: 240

  The identifier of the legal employer of the employee.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  The name of the person as shown in the search criteria.
• Manager: string
  Title: Manager

  Read Only: true

  Maximum Length: 240

  Indicates that the person is a manager.
• MangaerPersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  The identifier of the manager to whom the employee reports.
• PersonId: integer (int64)
  Read Only: true

  The identifier of the person for whom the row records data.
• PersonJobFuncAssignmentP: 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.
• PersonNumber: string
  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.
• PhoneNumber: string
  Title: Phone

  Read Only: true

  Maximum Length: 60

  The work phone number of the person.
• SystemPersonType: string
  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.
• UserGuid: string
  Read Only: true

  Maximum Length: 64

  The unique global identifier of the person.
• UserId: integer (int64)
  Read Only: true

  The unique identifier of the person.
• Username: string
  Title: User Name

  Read Only: true

  Maximum Length: 100

  The identifier of the user name that is to be assigned to the employee.
• WorkerPersonType: string
  Title: Worker Person Type

  Read Only: true

  Maximum Length: 80

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

{
    "type":"object",
    "properties":{
        "LegalEmployer":{
            "title":"Legal Employer",
            "maxLength":"240",
            "type":"string",
            "description":"The identifier of the legal employer of the employee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "Manager":{
            "title":"Manager",
            "maxLength":"240",
            "type":"string",
            "description":"Indicates that the person is a manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The bill rate currency code for time recording.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitleId":{
            "title":"Job Title",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier of the job title that id assigned to the employee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the person as shown in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HireDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Indicates the hiring date of the employee.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the public sector profile of the person is available to be used.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the business unit that the person belongs to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillRateFrequency":{
            "maxLength":"30",
            "type":"string",
            "description":"The bill rate frequency for time recording.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkerPersonType":{
            "title":"Worker Person Type",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the type of the employment. The default value is 'Employee'.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsSupervisor":{
            "title":"Is Supervisor",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the employee is a supervisor.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the person. The value is not determined by the type of person, such as an employee or a contingent worker.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemPersonType":{
            "title":"System Person Type",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the type of the person. This field allows a valid person type that was included by the Fusion development teams.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFuncGrpId":{
            "title":"Job Group",
            "maxLength":"50",
            "type":"string",
            "description":"Indicates if the public sector profile of the person is available to be used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ListName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the person as shown in the search criteria.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserGuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The unique global identifier of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The identifier the business unit that the employee belongs to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"The work email address of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonJobFuncAssignmentP":{
            "title":"Person Job Attributes",
            "type":"array",
            "description":"The person job attributes resource is used to list the job attributes and their values assigned to a person.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPersons-PersonJobFuncAssignmentP-item-response"
            }
        },
        "MangaerPersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the manager to whom the employee reports.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"The identifier of the person for whom the row records data.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Username":{
            "title":"User Name",
            "maxLength":"100",
            "type":"string",
            "description":"The identifier of the user name that is to be assigned to the employee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserId":{
            "type":"integer",
            "description":"The unique identifier of the person.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyAddressId":{
            "title":"Agency Location",
            "type":"integer",
            "description":"The identifier of the location of the public sector agency.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillRate":{
            "type":"number",
            "description":"The bill rate for time recording.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"60",
            "type":"string",
            "description":"The work phone number of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Agency Department",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the department of the public sector agency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

• Array of: object publicSectorPersons-PersonJobFuncAssignmentP-item-response

{
    "title":"Person Job Attributes",
    "type":"array",
    "description":"The person job attributes resource is used to list the job attributes and their values assigned to a person.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPersons-PersonJobFuncAssignmentP-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : publicSectorPersons-PersonJobFuncAssignmentP-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  The identifier of the public sector agency.
• EnabledFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates if the job function and the attribute assignments are available to be used.
• JobFuncId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the job function.
• JobFuncSecId: string
  Read Only: true

  Maximum Length: 200

  The unique identifier of the job attribute.
• JobFuncSectnValue: string
  Read Only: true

  Maximum Length: 4000

  The unique value of the job attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersJobFuncAssignId: integer (int64)
  Read Only: true

  The auto generated identifier of the unique row.
• PersJobFuncId: integer (int64)
  Read Only: true

  The auto generated number to identify the unique row.
• PersonId: integer (int64)
  Read Only: true

  The identifier of the person for whom the row records data.

{
    "type":"object",
    "properties":{
        "PersJobFuncAssignId":{
            "type":"integer",
            "description":"The auto generated identifier of the unique row.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"The identifier of the person for whom the row records data.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersJobFuncId":{
            "type":"integer",
            "description":"The auto generated number to identify the unique row.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobFuncSecId":{
            "maxLength":"200",
            "type":"string",
            "description":"The unique identifier of the job attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFuncId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the job function.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the job function and the attribute assignments are available to be used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFuncSectnValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"The unique value of the job attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

PersonJobFuncAssignmentP

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorPersons/{publicSectorPersonsUniqID}/child/PersonJobFuncAssignmentP

Parameters:

• publicSectorPersonsUniqID: $request.path.publicSectorPersonsUniqID

The person job attributes resource is used to list the job attributes and their values assigned to a person.

Back to Top