Jump to

• Request
• Response

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.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorEmployees-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.
• 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 person job functions resource is used to view the list of job functions that are assigned to a person.
• 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.

{
    "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"
        },
        "BusinessUnit":{
            "type":"string",
            "description":"The name of the business unit in which the employee is created.",
            "title":"Business Unit"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the department of the public sector agency.",
            "title":"Agency Department"
        },
        "EmailAddress":{
            "type":"string",
            "description":"The email ID of the person.",
            "title":"Email"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the public sector profile of the person is available to be used.",
            "title":"Enabled"
        },
        "FirstName":{
            "maxLength":255,
            "type":"string",
            "description":"The first name of the person.",
            "title":"First Name"
        },
        "GeneratedUserAccountFlag":{
            "type":"string",
            "description":"Indicates that a user account is to be created at the time of creation of the profile.",
            "title":"Generated User Account"
        },
        "HireDate":{
            "format":"date",
            "type":"string",
            "description":"The hiring date of the employee.",
            "title":"Hire Date"
        },
        "IsSupervisor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the employee is a supervisor.",
            "title":"Is Supervisor"
        },
        "JobFuncGrpId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the job group to which the employee is assigned.",
            "title":"Job Group"
        },
        "JobTitleId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the job title of the employee.",
            "title":"Job Title"
        },
        "LastName":{
            "type":"string",
            "description":"The last name of the person.",
            "title":"Last Name"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "LegalEntity":{
            "type":"string",
            "description":"The name of the employee's legal employer.",
            "title":"Legal Entity"
        },
        "ManagerPersonNumber":{
            "type":"string",
            "description":"The identifier of the person number of the manager to whom the employee reports.",
            "title":"Manager"
        },
        "PersonId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the person for whom the record is created.",
            "title":"Worker ID"
        },
        "PersonJobFunctions":{
            "items":{
                "$ref":"#/definitions/publicSectorEmployees-PersonJobFunctions-item"
            },
            "type":"array",
            "description":"The person job functions resource is used to view the list of job functions that are assigned to a person.",
            "title":"Person Job Functions"
        },
        "PersonNumber":{
            "type":"string",
            "description":"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.",
            "title":"Person Number"
        },
        "PersonType":{
            "type":"string",
            "description":"The type of employment. The default value for the field is Employee.",
            "title":"Person Type"
        },
        "PersonUserName":{
            "type":"string",
            "description":"The user name of the person."
        },
        "SendCredentialsEmailFlag":{
            "type":"string",
            "description":"Indicates that the user should be notified by an email with the details of the credentials after an user account is created.",
            "title":"Send Credentials Email"
        },
        "UserGUID":{
            "type":"string",
            "description":"A global unique identifier of the person."
        },
        "UserId":{
            "format":"int64",
            "type":"integer",
            "description":"A unique identifier of the person."
        },
        "Username":{
            "type":"string",
            "description":"The user name assigned to the employee.",
            "title":"User Name"
        },
        "WorkPhoneNumber":{
            "type":"string",
            "description":"The work phone number of the employee.",
            "title":"Work Phone Number"
        },
        "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 Functions

Type: array

Title: Person Job Functions

The person job functions resource is used to view the list of job functions that are assigned to a person.

Show Source

• Array of: object publicSectorEmployees-PersonJobFunctions-item

{
    "items":{
        "$ref":"#/definitions/publicSectorEmployees-PersonJobFunctions-item"
    },
    "type":"array",
    "description":"The person job functions resource is used to view the list of job functions that are assigned to a person.",
    "title":"Person Job Functions"
}

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 : publicSectorEmployees-PersonJobFunctions-item

Type: object

Show Source

• 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 attributes resource is used to list the job attributes and their values assigned to a person.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"An identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the job functions and the associated job attributes are available for the employee to use.",
            "title":"Enabled"
        },
        "JobFuncId":{
            "maxLength":50,
            "type":"string",
            "description":"A unique identifier of the job function.",
            "title":"Job Function ID"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "PersJobFuncId":{
            "format":"int64",
            "type":"integer",
            "description":"An identifier of the unique row using an auto generated number."
        },
        "PersonId":{
            "format":"int64",
            "type":"integer",
            "description":"An identifier of the person for whom the row is created."
        },
        "PersonJobFuncAssignments":{
            "items":{
                "$ref":"#/definitions/publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item"
            },
            "type":"array",
            "description":"The person job attributes resource is used to list the job attributes and their values assigned to a person.",
            "title":"Person Job Attributes"
        },
        "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 job attributes resource is used to list the job attributes and their values assigned to a person.

Show Source

• Array of: object publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item

{
    "items":{
        "$ref":"#/definitions/publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item"
    },
    "type":"array",
    "description":"The person job attributes resource is used to list the job attributes and their values assigned to a person.",
    "title":"Person Job Attributes"
}

Nested Schema : publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item

Type: object

Show Source

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"An identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the job attribute is available for the employee to use.",
            "title":"Enabled"
        },
        "JobFuncId":{
            "maxLength":50,
            "type":"string",
            "description":"A unique identifier of the job function.",
            "title":"Job Function ID"
        },
        "JobFuncSecId":{
            "maxLength":50,
            "type":"string",
            "description":"A unique identifier of the job attribute.",
            "title":"Job Attribute"
        },
        "JobFuncSectnValue":{
            "maxLength":1000,
            "type":"string",
            "description":"A unique value of the job attribute.",
            "title":"Attribute Value"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "PersJobFuncAssignId":{
            "format":"int64",
            "type":"integer",
            "description":"An identifier for the row assigned using an auto generated number."
        },
        "PersJobFuncId":{
            "format":"int64",
            "type":"integer",
            "description":"An identifier for the unique row assigned using an auto generated number."
        },
        "PersonId":{
            "format":"int64",
            "type":"integer",
            "description":"The name of the person for whom the row was created."
        },
        "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

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorEmployees-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.
• 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 person job functions resource is used to view the list of job functions that are assigned to a person.
• 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.

{
    "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"
        },
        "BusinessUnit":{
            "type":"string",
            "description":"The name of the business unit in which the employee is created.",
            "title":"Business Unit"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the department of the public sector agency.",
            "title":"Agency Department"
        },
        "EmailAddress":{
            "type":"string",
            "description":"The email ID of the person.",
            "title":"Email"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the public sector profile of the person is available to be used.",
            "title":"Enabled"
        },
        "FirstName":{
            "maxLength":255,
            "type":"string",
            "description":"The first name of the person.",
            "title":"First Name"
        },
        "GeneratedUserAccountFlag":{
            "type":"string",
            "description":"Indicates that a user account is to be created at the time of creation of the profile.",
            "title":"Generated User Account"
        },
        "HireDate":{
            "format":"date",
            "type":"string",
            "description":"The hiring date of the employee.",
            "title":"Hire Date"
        },
        "IsSupervisor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the employee is a supervisor.",
            "title":"Is Supervisor"
        },
        "JobFuncGrpId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the job group to which the employee is assigned.",
            "title":"Job Group"
        },
        "JobTitleId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the job title of the employee.",
            "title":"Job Title"
        },
        "LastName":{
            "type":"string",
            "description":"The last name of the person.",
            "title":"Last Name"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "LegalEntity":{
            "type":"string",
            "description":"The name of the employee's legal employer.",
            "title":"Legal Entity"
        },
        "ManagerPersonNumber":{
            "type":"string",
            "description":"The identifier of the person number of the manager to whom the employee reports.",
            "title":"Manager"
        },
        "PersonId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the person for whom the record is created.",
            "title":"Worker ID"
        },
        "PersonJobFunctions":{
            "items":{
                "$ref":"#/definitions/publicSectorEmployees-PersonJobFunctions-item"
            },
            "type":"array",
            "description":"The person job functions resource is used to view the list of job functions that are assigned to a person.",
            "title":"Person Job Functions"
        },
        "PersonNumber":{
            "type":"string",
            "description":"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.",
            "title":"Person Number"
        },
        "PersonType":{
            "type":"string",
            "description":"The type of employment. The default value for the field is Employee.",
            "title":"Person Type"
        },
        "PersonUserName":{
            "type":"string",
            "description":"The user name of the person."
        },
        "SendCredentialsEmailFlag":{
            "type":"string",
            "description":"Indicates that the user should be notified by an email with the details of the credentials after an user account is created.",
            "title":"Send Credentials Email"
        },
        "UserGUID":{
            "type":"string",
            "description":"A global unique identifier of the person."
        },
        "UserId":{
            "format":"int64",
            "type":"integer",
            "description":"A unique identifier of the person."
        },
        "Username":{
            "type":"string",
            "description":"The user name assigned to the employee.",
            "title":"User Name"
        },
        "WorkPhoneNumber":{
            "type":"string",
            "description":"The work phone number of the employee.",
            "title":"Work Phone Number"
        },
        "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 Functions

Type: array

Title: Person Job Functions

The person job functions resource is used to view the list of job functions that are assigned to a person.

Show Source

• Array of: object publicSectorEmployees-PersonJobFunctions-item

{
    "items":{
        "$ref":"#/definitions/publicSectorEmployees-PersonJobFunctions-item"
    },
    "type":"array",
    "description":"The person job functions resource is used to view the list of job functions that are assigned to a person.",
    "title":"Person Job Functions"
}

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 : publicSectorEmployees-PersonJobFunctions-item

Type: object

Show Source

• 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 attributes resource is used to list the job attributes and their values assigned to a person.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"An identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the job functions and the associated job attributes are available for the employee to use.",
            "title":"Enabled"
        },
        "JobFuncId":{
            "maxLength":50,
            "type":"string",
            "description":"A unique identifier of the job function.",
            "title":"Job Function ID"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "PersJobFuncId":{
            "format":"int64",
            "type":"integer",
            "description":"An identifier of the unique row using an auto generated number."
        },
        "PersonId":{
            "format":"int64",
            "type":"integer",
            "description":"An identifier of the person for whom the row is created."
        },
        "PersonJobFuncAssignments":{
            "items":{
                "$ref":"#/definitions/publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item"
            },
            "type":"array",
            "description":"The person job attributes resource is used to list the job attributes and their values assigned to a person.",
            "title":"Person Job Attributes"
        },
        "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 job attributes resource is used to list the job attributes and their values assigned to a person.

Show Source

• Array of: object publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item

{
    "items":{
        "$ref":"#/definitions/publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item"
    },
    "type":"array",
    "description":"The person job attributes resource is used to list the job attributes and their values assigned to a person.",
    "title":"Person Job Attributes"
}

Nested Schema : publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item

Type: object

Show Source

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"An identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the job attribute is available for the employee to use.",
            "title":"Enabled"
        },
        "JobFuncId":{
            "maxLength":50,
            "type":"string",
            "description":"A unique identifier of the job function.",
            "title":"Job Function ID"
        },
        "JobFuncSecId":{
            "maxLength":50,
            "type":"string",
            "description":"A unique identifier of the job attribute.",
            "title":"Job Attribute"
        },
        "JobFuncSectnValue":{
            "maxLength":1000,
            "type":"string",
            "description":"A unique value of the job attribute.",
            "title":"Attribute Value"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "PersJobFuncAssignId":{
            "format":"int64",
            "type":"integer",
            "description":"An identifier for the row assigned using an auto generated number."
        },
        "PersJobFuncId":{
            "format":"int64",
            "type":"integer",
            "description":"An identifier for the unique row assigned using an auto generated number."
        },
        "PersonId":{
            "format":"int64",
            "type":"integer",
            "description":"The name of the person for whom the row was created."
        },
        "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