Jump to

• Request
• Response

Create a set of agency staff

post

/fscmRestApi/resources/11.13.18.05/publicSectorEmployees

Request

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.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• AgencyAddressId(required): integer (int64)
  Title: Agency Location

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

  Default Value: 1

  The identifier of the public sector agency.
• BusinessUnit(required): string
  Title: Business Unit

  The name of the business unit in which the employee is created.
• DepartmentId(required): string
  Title: Agency Department

  Maximum Length: 30

  The identifier of the department of the public sector agency.
• EmailAddress(required): string
  Title: Email

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

  Maximum Length: 1

  Default Value: Y

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

  The first name of the person.
• GeneratedUserAccountFlag: string
  Title: Generated User Account

  Indicates that a user account is to be created at the time of creation of the profile.
• HireDate: string (date)
  Title: Hire Date

  The hiring date of the employee.
• IsSupervisor(required): string
  Title: Is Supervisor

  Maximum Length: 1

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

  Maximum Length: 50

  The identifier of the job group to which the employee is assigned.
• JobTitleId(required): string
  Title: Job Title

  Maximum Length: 50

  The identifier of the job title of the employee.
• LastName(required): string
  Title: Last Name

  The last name of the person.
• LegalEntity(required): string
  Title: Legal Entity

  The name of the employee's legal employer.
• ManagerPersonNumber: string
  Title: Manager

  The identifier of the person number of the manager to whom the employee reports.
• PersonId: integer (int64)
  Title: Worker ID

  Default Value: 0

  The identifier of the person for whom the record is created.
• PersonJobFunctions: 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: 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: string
  Title: Person Type

  The type of employment. The default value for the field is Employee.
• SendCredentialsEmailFlag: 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.
• Username: string
  Title: User Name

  The user name assigned to the employee.
• WorkPhoneNumber: string
  Title: Work Phone Number

  The work phone number of the employee.

{
    "required":[
        "AgencyAddressId",
        "BusinessUnit",
        "DepartmentId",
        "EmailAddress",
        "FirstName",
        "IsSupervisor",
        "JobTitleId",
        "LastName",
        "LegalEntity"
    ],
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "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.",
            "nullable":true,
            "x-queryable":false
        },
        "LegalEntity":{
            "title":"Legal Entity",
            "type":"string",
            "description":"The name of the employee's legal employer.",
            "nullable":false,
            "x-queryable":false
        },
        "SendCredentialsEmailFlag":{
            "title":"Send Credentials Email",
            "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.",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "JobFuncGrpId":{
            "title":"Job Group",
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the job group to which the employee is assigned.",
            "nullable":true
        },
        "WorkPhoneNumber":{
            "title":"Work Phone Number",
            "type":"string",
            "description":"The work phone number of the employee.",
            "nullable":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "type":"string",
            "description":"The first name of the person.",
            "nullable":false,
            "x-queryable":false
        },
        "GeneratedUserAccountFlag":{
            "title":"Generated User Account",
            "type":"string",
            "description":"Indicates that a user account is to be created at the time of creation of the profile.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonType":{
            "title":"Person Type",
            "type":"string",
            "description":"The type of employment. The default value for the field is Employee.",
            "nullable":true,
            "x-queryable":false
        },
        "ManagerPersonNumber":{
            "title":"Manager",
            "type":"string",
            "description":"The identifier of the person number of the manager to whom the employee reports.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The email ID of the person.",
            "nullable":false,
            "x-queryable":false
        },
        "JobTitleId":{
            "title":"Job Title",
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the job title of the employee.",
            "nullable":false
        },
        "PersonId":{
            "title":"Worker ID",
            "type":"integer",
            "description":"The identifier of the person for whom the record is created.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "Username":{
            "title":"User Name",
            "type":"string",
            "description":"The user name assigned to the employee.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"string",
            "description":"The name of the business unit in which the employee is created.",
            "nullable":false,
            "x-queryable":false
        },
        "AgencyAddressId":{
            "title":"Agency Location",
            "type":"integer",
            "description":"The identifier of the location of the public sector agency.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "HireDate":{
            "title":"Hire Date",
            "type":"string",
            "description":"The hiring date of the employee.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PersonJobFunctions":{
            "title":"Person Job Functions",
            "type":"array",
            "description":"The person job functions resource is used to view the list of job functions that are assigned to a person.",
            "items":{
                "$ref":"#/components/schemas/publicSectorEmployees-PersonJobFunctions-item-post-request"
            }
        },
        "LastName":{
            "title":"Last Name",
            "type":"string",
            "description":"The last name of the person.",
            "nullable":false,
            "x-queryable":false
        },
        "DepartmentId":{
            "title":"Agency Department",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the department of the public sector agency.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the public sector profile of the person is available to be used.",
            "nullable":false,
            "default":"Y"
        },
        "IsSupervisor":{
            "title":"Is Supervisor",
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the employee is a supervisor.",
            "nullable":false
        }
    }
}

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-post-request

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

Nested Schema : publicSectorEmployees-PersonJobFunctions-item-post-request

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  An identifier of the public sector agency.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates that the job functions and the associated job attributes are available for the employee to use.
• JobFuncId: string
  Title: Job Function ID

  Maximum Length: 50

  A unique identifier of the job function.
• PersJobFuncId: integer (int64)
  An identifier of the unique row using an auto generated number.
• PersonId: integer (int64)
  An identifier of the person for whom the row is created.
• PersonJobFuncAssignments: 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.

{
    "type":"object",
    "properties":{
        "JobFuncId":{
            "title":"Job Function ID",
            "maxLength":50,
            "type":"string",
            "description":"A unique identifier of the job function.",
            "nullable":true
        },
        "PersJobFuncId":{
            "type":"integer",
            "description":"An identifier of the unique row using an auto generated number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PersonId":{
            "type":"integer",
            "description":"An identifier of the person for whom the row is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"An identifier of the public sector agency.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the job functions and the associated job attributes are available for the employee to use.",
            "nullable":true
        },
        "PersonJobFuncAssignments":{
            "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/publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item-post-request"
            }
        }
    }
}

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-post-request

{
    "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/publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item-post-request"
    }
}

Nested Schema : publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item-post-request

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  An identifier of the public sector agency.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates that the job attribute is available for the employee to use.
• JobFuncId: string
  Title: Job Function ID

  Maximum Length: 50

  A unique identifier of the job function.
• JobFuncSecId: string
  Title: Job Attribute

  Maximum Length: 50

  A unique identifier of the job attribute.
• JobFuncSectnValue: string
  Title: Attribute Value

  Maximum Length: 1000

  A unique value of the job attribute.
• PersJobFuncAssignId: integer (int64)
  An identifier for the row assigned using an auto generated number.
• PersJobFuncId: integer (int64)
  An identifier for the unique row assigned using an auto generated number.
• PersonId: integer (int64)
  The name of the person for whom the row was created.

{
    "type":"object",
    "properties":{
        "PersJobFuncAssignId":{
            "type":"integer",
            "description":"An identifier for the row assigned using an auto generated number.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PersonId":{
            "type":"integer",
            "description":"The name of the person for whom the row was created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"An identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "PersJobFuncId":{
            "type":"integer",
            "description":"An identifier for the unique row assigned using an auto generated number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "JobFuncSecId":{
            "title":"Job Attribute",
            "maxLength":50,
            "type":"string",
            "description":"A unique identifier of the job attribute.",
            "nullable":true
        },
        "JobFuncId":{
            "title":"Job Function ID",
            "maxLength":50,
            "type":"string",
            "description":"A unique identifier of the job function.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the job attribute is available for the employee to use.",
            "nullable":true
        },
        "JobFuncSectnValue":{
            "title":"Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"A unique value of the job attribute.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorEmployees-item-response

Type: object

Show Source

• AgencyAddressId: integer (int64)
  Title: Agency Location

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

  Default Value: 1

  The identifier of the public sector agency.
• BusinessUnit: string
  Title: Business Unit

  The name of the business unit in which the employee is created.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• DepartmentId: string
  Title: Agency Department

  Maximum Length: 30

  The identifier of the department of the public sector agency.
• EmailAddress: string
  Title: Email

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

  Maximum Length: 1

  Default Value: Y

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

  The first name of the person.
• GeneratedUserAccountFlag: string
  Title: Generated User Account

  Indicates that a user account is to be created at the time of creation of the profile.
• HireDate: string (date)
  Title: Hire Date

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

  Maximum Length: 1

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

  Maximum Length: 50

  The identifier of the job group to which the employee is assigned.
• JobTitleId: string
  Title: Job Title

  Maximum Length: 50

  The identifier of the job title of the employee.
• LastName: string
  Title: Last Name

  The last name of the person.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• LegalEntity: string
  Title: Legal Entity

  The name of the employee's legal employer.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerPersonNumber: string
  Title: Manager

  The identifier of the person number of the manager to whom the employee reports.
• PersonId: integer (int64)
  Title: Worker ID

  Default Value: 0

  The identifier of the person for whom the record is created.
• PersonJobFunctions: 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: 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: string
  Title: Person Type

  The type of employment. The default value for the field is Employee.
• PersonUserName: string
  Read Only: true

  The user name of the person.
• SendCredentialsEmailFlag: 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: string
  Read Only: true

  A global unique identifier of the person.
• UserId: integer
  Read Only: true

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

  The user name assigned to the employee.
• WorkPhoneNumber: string
  Title: Work Phone Number

  The work phone number of the employee.

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

{
    "title":"Person Job Functions",
    "type":"array",
    "description":"The person job functions resource is used to view the list of job functions that are assigned to a person.",
    "items":{
        "$ref":"#/components/schemas/publicSectorEmployees-PersonJobFunctions-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 : publicSectorEmployees-PersonJobFunctions-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  An identifier of the public sector agency.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates that the job functions and the associated job attributes are available for the employee to use.
• JobFuncId: string
  Title: Job Function ID

  Maximum Length: 50

  A unique identifier of the job function.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersJobFuncId: integer (int64)
  An identifier of the unique row using an auto generated number.
• PersonId: integer (int64)
  An identifier of the person for whom the row is created.
• PersonJobFuncAssignments: 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersJobFuncId":{
            "type":"integer",
            "description":"An identifier of the unique row using an auto generated number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"An identifier of the person for whom the row is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"An identifier of the public sector agency.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "JobFuncId":{
            "title":"Job Function ID",
            "maxLength":50,
            "type":"string",
            "description":"A unique identifier of the job function.",
            "nullable":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 that the job functions and the associated job attributes are available for the employee to use.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonJobFuncAssignments":{
            "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/publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "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 publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-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/publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item-response"
    }
}

Nested Schema : publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  An identifier of the public sector agency.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates that the job attribute is available for the employee to use.
• JobFuncId: string
  Title: Job Function ID

  Maximum Length: 50

  A unique identifier of the job function.
• JobFuncSecId: string
  Title: Job Attribute

  Maximum Length: 50

  A unique identifier of the job attribute.
• JobFuncSectnValue: string
  Title: Attribute Value

  Maximum Length: 1000

  A unique value of the job attribute.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersJobFuncAssignId: integer (int64)
  An identifier for the row assigned using an auto generated number.
• PersJobFuncId: integer (int64)
  An identifier for the unique row assigned using an auto generated number.
• PersonId: integer (int64)
  The name of the person for whom the row was created.

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

Links

PersonJobFunctions

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions

Parameters:

• PersonId: $request.path.PersonId

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

Back to Top