Jump to

• Request
• Response
• Examples

Update an assignment

patch

/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}

Request

Path Parameters

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

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionCode: string
  Title: Action Code

  Maximum Length: 30

  Action performed on a particular record, such as Hire, Add Pending Worker, Manager Change, and so on. Valid values are defined in the list ActionCodeLOV.
• ActionReasonCode: string
  Title: Reason Code

  Maximum Length: 30

  User-defined code for the action reason. Specifies the reason for the action performed on the record. Valid values are defined in the list ActionReasonCodeLOV.
• AssignmentCategory: string
  Title: Assignment Category

  Maximum Length: 30

  User-defined category such as Full-Time Permanent or Part-Time Permanent. Valid values are defined in the list AssignmentCategoryLOV.
• assignmentDFF: array assignmentDFF
• assignmentExtraInformation: array assignmentExtraInformation
• AssignmentName: string
  Title: Assignment Name

  Maximum Length: 80

  Name of the assignment.
• AssignmentNumber: string
  Title: Assignment Number

  Maximum Length: 30

  Unique identifier for the assignment or terms. Valid for workers and nonworkers.
• AssignmentProjectedEndDate: string (date)
  Title: Projected End Date

  Date on which the assignment is expected to end.
• AssignmentStatus: string
  Title: Assignment Status

  Maximum Length: 30

  HR status of the assignment, such as Active or Inactive. Valid values are defined in the list AssignmentStatusLOV.
• AssignmentStatusTypeId: integer (int64)
  Title: Assignment Status Type ID

  Unique identifier for the user-defined assignment status. Valid values are defined in the list AssignmentStatusTypeIdLOV.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Unique identifier for the business unit. Valid values are defined in the list BusinessUnitIdLOV.
• DefaultExpenseAccount: string
  Default expense account represented as a concatenated value of all the related segments.
• DepartmentId: integer (int64)
  Title: Organization ID

  Unique identifier for the department. Valid values are defined in the list DepartmentIdLOV.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Date at the end of the period within which the employee assignment is effective.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Date at the beginning of the period within which the employee assignment is effective.
• empreps: array Employee Representatives
  Title: Employee Representatives

  The empreps resource is a child of the assignments resource. It includes all employee representatives as of the specified date. By default, the current date is retained.
  This resource is currently under controlled availability.
• EndTime: string
  Title: End Time

  Maximum Length: 5

  Work day normal end time.
• Frequency: string
  Title: Frequency

  Maximum Length: 30

  Frequency of normal working hours such as week, month, year. Valid values are defined in the list FrequencyLOV.
• FullPartTime: string
  Title: Full Time or Part Time

  Maximum Length: 30

  Indicates whether the position the employee is hired for is full-time or part-time. Valid values are defined in the list FullPartTimeLOV.
• GradeId: integer (int64)
  Title: Grade ID

  Unique identifier for the grade. Valid values are defined in the list GradeIdLOV.
• GradeLadderId: integer (int64)
  Title: Grade Ladder ID

  Unique identifier for the grade ladder.
• JobId: integer (int64)
  Title: Job ID

  Unique identifier for the job. Valid values are defined in the list JobIdLOV.
• LegalEntityId: integer (int64)
  Title: Legal Entity ID

  Unique identifier for the legal entity.
• LocationId: integer (int64)
  Title: Location ID

  Unique identifier for the location. Valid values are defined in the list LocationIdLOV.
• ManagerAssignmentId: integer (int64)
  Title: Manager Assignment ID

  Identifier for the manager's assignment.
• ManagerId: integer (int64)
  Title: Manager ID

  Unique identifier for a manager. Valid values are defined in the list ManagerIdLOV.
• ManagerType: string
  Title: Type

  Maximum Length: 30

  Role of the manager with regards to the overall organization structure. For example, functional, project leader, and so on.
• PeopleGroup: string
  People group represented as a concatenated value of all the related key flexfield segments.
• peopleGroupKeyFlexfield: array peopleGroupKeyFlexfield
• PeriodOfServiceId: integer (int64)
  Title: Period of Service ID

  Primary key autogenerated by the application.
• PersonTypeId: integer (int64)
  Title: Person Type ID

  Unique identifier for the person type. Valid values are defined in the list PersonTypeIdLOV.
• PositionId: integer (int64)
  Title: Position ID

  Unique identifier for a position. Valid values are defined in the list PositionIdLOV.
• PrimaryAssignmentFlag: boolean
  Title: Primary Assignment

  Maximum Length: 30

  Default Value: false

  Indicates whether the current assignment is the primary assignment. Valid values are Yes and No.
• PrimaryWorkRelationFlag: boolean
  Title: Primary Work Relationship

  Maximum Length: 30

  Indicates whether the current work relationship is primary. Valid values are Yes and No.
• PrimaryWorkTermsFlag: boolean
  Title: Primary Employment Terms

  Maximum Length: 30

  Default Value: false

  Indicates whether the current employment terms are primary. Valid values are Yes and No.
• ProbationPeriodEndDate: string (date)
  Title: Probation End Date

  End date of the probation period.
• ProbationPeriodLength: number
  Title: Probation Period

  Duration of the probation period.
• ProbationPeriodUnitOfMeasure: string
  Title: Probation Unit

  Maximum Length: 30

  Units for the probation period duration. Valid values are defined in the list QUALIFYING_UNITS.
• ProjectedStartDate: string (date)
  Title: Projected Start Date

  Proposed start date for the pending worker.
• ProposedPersonTypeId: string
  Title: Proposed Person Type

  Maximum Length: 30

  Unique identifier for the worker class. This value is valid only if the PersonTypeId is Pending Worker. It can be any of the employee or contingent worker types. Valid values are defined in the list ProposedPersonTypeIdLOV.
• RegularTemporary: string
  Title: Regular or Temporary

  Maximum Length: 30

  Indicates whether the position the employee is hired for is regular or temporary. Valid values are defined in the list RegularTemporaryLOV.
• SalaryAmount: number
  Title: Salary Amount

  Salary amount entered based on the salary frequency.
• SalaryBasisId: integer (int64)
  Identifier for the set of details linked to a worker's base pay. It identifies the payroll characteristics used to pay base earnings, the duration for which base pay is quoted, the factor used to annualize base pay, any components used to attribute base pay adjustments to different reasons, and any associated grade rate for salary validation. Valid values are defined in the list SalaryBasisIdLOV.
• SalaryCode: string
  Title: Hourly Paid or Salaried

  Maximum Length: 30

  Identifies whether the assignment is paid by the hour or by a salary. Either maintained at the assignment level or employment or placement terms but not both. Valid values are defined in the list SalaryCodeLOV.
• StartTime: string
  Title: Start Time

  Maximum Length: 5

  Work day normal start time.
• TermsEffectiveStartDate: string (date)
  Title: Effective Start Date

  Date at the beginning of the period within which the employee term is effective.
• WorkerCategory: string
  Title: Worker Category

  Maximum Length: 30

  Category of the worker such as Blue Collar, Civil Servant, and so on. Valid values are defined in the list WorkerCategoryLOV.
• WorkingAsManager: string
  Title: Working as a Manager

  Maximum Length: 30

  Indicates whether the person is a manager. Valid values are Yes and No.
• WorkingAtHome: string
  Title: Working at Home

  Maximum Length: 30

  Indicates whether the person is working at home. Valid values are Yes and No.
• WorkingHours: number
  Title: Working Hours

  Normal working hours.
• WorkTaxAddressId: integer (int64)
  Title: Tax Address ID

  Unique identifier for the address that's used for taxation purposes. This can be different from a mailing address. Valid values are defined in the list WorkTaxAddressIdLOV.

{
    "type":"object",
    "properties":{
        "GradeLadderId":{
            "title":"Grade Ladder ID",
            "type":"integer",
            "description":"Unique identifier for the grade ladder.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SalaryAmount":{
            "title":"Salary Amount",
            "type":"number",
            "description":"Salary amount entered based on the salary frequency.",
            "nullable":false
        },
        "AssignmentProjectedEndDate":{
            "title":"Projected End Date",
            "type":"string",
            "description":"Date on which the assignment is expected to end.",
            "format":"date",
            "nullable":true
        },
        "PrimaryWorkTermsFlag":{
            "title":"Primary Employment Terms",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the current employment terms are primary. Valid values are Yes and No.",
            "nullable":false,
            "default":false
        },
        "empreps":{
            "title":"Employee Representatives",
            "type":"array",
            "description":"The empreps resource is a child of the assignments resource. It includes all employee representatives as of the specified date. By default, the current date is retained.<br>This resource is currently under controlled availability.",
            "items":{
                "$ref":"#/components/schemas/emps-assignments-empreps-item-patch-request"
            }
        },
        "WorkerCategory":{
            "title":"Worker Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the worker such as Blue Collar, Civil Servant, and so on. Valid values are defined in the list WorkerCategoryLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActionReasonCode":{
            "title":"Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"User-defined code for the action reason. Specifies the reason for the action performed on the record. Valid values are defined in the list ActionReasonCodeLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FullPartTime":{
            "title":"Full Time or Part Time",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the position the employee is hired for is full-time or part-time. Valid values are defined in the list FullPartTimeLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "assignmentExtraInformation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emps-assignments-assignmentExtraInformation-item-patch-request"
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Date at the end of the period within which the employee assignment is effective.",
            "format":"date",
            "nullable":false
        },
        "ManagerType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Role of the manager with regards to the overall organization structure. For example, functional, project leader, and so on.",
            "nullable":false
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Unique identifier for the business unit. Valid values are defined in the list BusinessUnitIdLOV.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "DefaultExpenseAccount":{
            "type":"string",
            "description":"Default expense account represented as a concatenated value of all the related segments.",
            "nullable":true,
            "x-queryable":false
        },
        "ProposedPersonTypeId":{
            "title":"Proposed Person Type",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the worker class. This value is valid only if the PersonTypeId is Pending Worker. It can be any of the employee or contingent worker types. Valid values are defined in the list ProposedPersonTypeIdLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartTime":{
            "title":"Start Time",
            "maxLength":5,
            "type":"string",
            "description":"Work day normal start time.",
            "nullable":true
        },
        "PeopleGroup":{
            "type":"string",
            "description":"People group represented as a concatenated value of all the related key flexfield segments.",
            "nullable":true
        },
        "assignmentDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emps-assignments-assignmentDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the assignment.",
            "nullable":true
        },
        "AssignmentCategory":{
            "title":"Assignment Category",
            "maxLength":30,
            "type":"string",
            "description":"User-defined category such as Full-Time Permanent or Part-Time Permanent. Valid values are defined in the list AssignmentCategoryLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkTaxAddressId":{
            "title":"Tax Address ID",
            "type":"integer",
            "description":"Unique identifier for the address that's used for taxation purposes. This can be different from a mailing address. Valid values are defined in the list WorkTaxAddressIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "SalaryCode":{
            "title":"Hourly Paid or Salaried",
            "maxLength":30,
            "type":"string",
            "description":"Identifies whether the assignment is paid by the hour or by a salary. Either maintained at the assignment level or employment or placement terms but not both. Valid values are defined in the list SalaryCodeLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TermsEffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date at the beginning of the period within which the employee term is effective.",
            "format":"date",
            "nullable":false
        },
        "ProbationPeriodEndDate":{
            "title":"Probation End Date",
            "type":"string",
            "description":"End date of the probation period.",
            "format":"date",
            "nullable":true
        },
        "PersonTypeId":{
            "title":"Person Type ID",
            "type":"integer",
            "description":"Unique identifier for the person type. Valid values are defined in the list PersonTypeIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ManagerId":{
            "title":"Manager ID",
            "type":"integer",
            "description":"Unique identifier for a manager. Valid values are defined in the list ManagerIdLOV.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "ManagerAssignmentId"
                ]
            }
        },
        "ProbationPeriodUnitOfMeasure":{
            "title":"Probation Unit",
            "maxLength":30,
            "type":"string",
            "description":"Units for the probation period duration. Valid values are defined in the list QUALIFYING_UNITS.",
            "nullable":true
        },
        "PeriodOfServiceId":{
            "title":"Period of Service ID",
            "type":"integer",
            "description":"Primary key autogenerated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndTime":{
            "title":"End Time",
            "maxLength":5,
            "type":"string",
            "description":"Work day normal end time.",
            "nullable":true
        },
        "SalaryBasisId":{
            "type":"integer",
            "description":"Identifier for the set of details linked to a worker's base pay. It identifies the payroll characteristics used to pay base earnings, the duration for which base pay is quoted, the factor used to annualize base pay, any components used to attribute base pay adjustments to different reasons, and any associated grade rate for salary validation. Valid values are defined in the list SalaryBasisIdLOV.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ActionCode":{
            "title":"Action Code",
            "maxLength":30,
            "type":"string",
            "description":"Action performed on a particular record, such as Hire, Add Pending Worker, Manager Change, and so on. Valid values are defined in the list ActionCodeLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProbationPeriodLength":{
            "title":"Probation Period",
            "type":"number",
            "description":"Duration of the probation period.",
            "nullable":true,
            "x-hints":{
                "precision":25,
                "scale":5
            }
        },
        "RegularTemporary":{
            "title":"Regular or Temporary",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the position the employee is hired for is regular or temporary. Valid values are defined in the list RegularTemporaryLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProjectedStartDate":{
            "title":"Projected Start Date",
            "type":"string",
            "description":"Proposed start date for the pending worker.",
            "format":"date",
            "nullable":true
        },
        "PrimaryAssignmentFlag":{
            "title":"Primary Assignment",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the current assignment is the primary assignment. Valid values are Yes and No.",
            "nullable":true,
            "default":false
        },
        "LegalEntityId":{
            "title":"Legal Entity ID",
            "type":"integer",
            "description":"Unique identifier for the legal entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "peopleGroupKeyFlexfield":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emps-assignments-peopleGroupKeyFlexfield-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the assignment or terms. Valid for workers and nonworkers.",
            "nullable":true
        },
        "GradeId":{
            "title":"Grade ID",
            "type":"integer",
            "description":"Unique identifier for the grade. Valid values are defined in the list GradeIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Unique identifier for the job. Valid values are defined in the list JobIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "WorkingAtHome":{
            "title":"Working at Home",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the person is working at home. Valid values are Yes and No.",
            "nullable":true
        },
        "PrimaryWorkRelationFlag":{
            "title":"Primary Work Relationship",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the current work relationship is primary. Valid values are Yes and No.",
            "nullable":false
        },
        "PositionId":{
            "title":"Position ID",
            "type":"integer",
            "description":"Unique identifier for a position. Valid values are defined in the list PositionIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"Unique identifier for the location. Valid values are defined in the list LocationIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ManagerAssignmentId":{
            "title":"Manager Assignment ID",
            "type":"integer",
            "description":"Identifier for the manager's assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkingHours":{
            "title":"Working Hours",
            "type":"number",
            "description":"Normal working hours.",
            "nullable":true,
            "x-hints":{
                "precision":22,
                "scale":3
            }
        },
        "AssignmentStatusTypeId":{
            "title":"Assignment Status Type ID",
            "type":"integer",
            "description":"Unique identifier for the user-defined assignment status. Valid values are defined in the list AssignmentStatusTypeIdLOV.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "Frequency":{
            "title":"Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Frequency of normal working hours such as week, month, year. Valid values are defined in the list FrequencyLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DepartmentId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Unique identifier for the department. Valid values are defined in the list DepartmentIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "AssignmentStatus":{
            "title":"Assignment Status",
            "maxLength":30,
            "type":"string",
            "description":"HR status of the assignment, such as Active or Inactive. Valid values are defined in the list AssignmentStatusLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date at the beginning of the period within which the employee assignment is effective.",
            "format":"date",
            "nullable":false
        },
        "WorkingAsManager":{
            "title":"Working as a Manager",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the person is a manager. Valid values are Yes and No.",
            "nullable":true
        }
    }
}

Nested Schema : assignmentDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emps-assignments-assignmentDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : assignmentExtraInformation

Type: array

Show Source

• Array of: object Discriminator: CategoryCode
  Discriminator: { "propertyName":"CategoryCode", "mapping":{ "PER_ASG_EIT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-patch-request" } }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emps-assignments-assignmentExtraInformation-item-patch-request"
    }
}

Nested Schema : Employee Representatives

Type: array

Title: Employee Representatives

The empreps resource is a child of the assignments resource. It includes all employee representatives as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.

Show Source

• Array of: object emps-assignments-empreps-item-patch-request

{
    "title":"Employee Representatives",
    "type":"array",
    "description":"The empreps resource is a child of the assignments resource. It includes all employee representatives as of the specified date. By default, the current date is retained.<br>This resource is currently under controlled availability.",
    "items":{
        "$ref":"#/components/schemas/emps-assignments-empreps-item-patch-request"
    }
}

Nested Schema : peopleGroupKeyFlexfield

Type: array

Show Source

• Array of: object emps-assignments-peopleGroupKeyFlexfield-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emps-assignments-peopleGroupKeyFlexfield-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveLatestChange: string
  Title: Effective Latest Change

  Maximum Length: 30
• EffectiveSequence: integer (int32)
  Title: Effective Sequence
• EffectiveStartDate: string (date)
  Title: Effective Start Date

{
    "type":"object",
    "properties":{
        "EffectiveLatestChange":{
            "title":"Effective Latest Change",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "EffectiveSequence":{
            "title":"Effective Sequence",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":4
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : Discriminator: CategoryCode

Type: object

Discriminator: CategoryCode

Discriminator Values

• PER_ASG_EIT

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "PER_ASG_EIT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-patch-request"
        }
    ]
}

Match One Schema

Show Source

• PER_ASG_EIT - object oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-patch-request

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "PER_ASG_EIT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-patch-request"
        }
    ]
}

Nested Schema : oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-patch-request

Type: object

Show Source

• CategoryCode: string
  Title: EFF Context

  Maximum Length: 80

  Default Value: PER_ASG_EIT
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveLatestChange: string
  Title: Effective Latest Change

  Maximum Length: 30
• EffectiveSequence: integer (int32)
  Title: Effective Sequence
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• InformationORA_5FPER_5FRET_5FGRADEprivateVO: array InformationORA_5FPER_5FRET_5FGRADEprivateVO

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"EFF Context",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "default":"PER_ASG_EIT"
        },
        "EffectiveSequence":{
            "title":"Effective Sequence",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            }
        },
        "InformationORA_5FPER_5FRET_5FGRADEprivateVO":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-patch-request"
            }
        },
        "EffectiveLatestChange":{
            "title":"Effective Latest Change",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false
        }
    }
}

Nested Schema : InformationORA_5FPER_5FRET_5FGRADEprivateVO

Type: array

Show Source

• Array of: object workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-patch-request"
    }
}

Nested Schema : workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-patch-request

Type: object

Show Source

• AeiInformationCategory: string
  Maximum Length: 30

  Default Value: ORA_PER_RET_GRADE
• AssignmentExtraInfoId: integer (int64)
• AssignmentId: integer (int64)
• BusinessGroupId: integer (int64)
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveLatestChange: string
  Maximum Length: 30

  Default Value: Y
• EffectiveSequence: integer (int32)
  Default Value: 1
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• endDate: string (date)
  Title: End Date
• frequency: string
  Title: Pay Basis

  Maximum Length: 150
• grade: string
  Title: Grade

  Maximum Length: 150
• grade_Display: string
  Title: Grade
• gradeLadder: string
  Title: Pay Table ID

  Maximum Length: 150
• gradeLadder_Display: string
  Title: Pay Table ID
• payPlan: string
  Title: Pay Plan

  Maximum Length: 150
• primaryIndicator: string
  Title: Primary Indicator

  Maximum Length: 150
• primaryIndicator_Display: string
  Title: Primary Indicator
• startDate: string (date)
  Title: Start Date
• step: string
  Title: Step

  Maximum Length: 150
• step_Display: string
  Title: Step

{
    "type":"object",
    "properties":{
        "AssignmentExtraInfoId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "grade_Display":{
            "title":"Grade",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"grade",
                "FND_ACFF_IsReferenced":"true",
                "FND_ACFF_PartialTarget":"startDate endDate gradeLadder gradeLadder",
                "FlexClientVar_flex_vst_bind3_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind4_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "controlType":"combo_lov",
                "FlexClientVar_flex_vst_bind4_RQ":"true",
                "FlexClientDisplayHint":"Hide",
                "FlexClientVar_flex_vst_bind3_VT":"SEGMENT.gradeLadder",
                "FlexClientVar_flex_vst_bind4_VT":"SEGMENT.gradeLadder",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.startDate",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind4,flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "EffectiveLatestChange":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"Y"
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "endDate":{
            "title":"End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "FND_ACFF_IsReferenced":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_ValueSetInfo":"HRC_STANDARD_DATE#FORMAT_ONLY",
                "controlType":"date",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"endDate",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.sql.Date",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_END_DATE_S",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_END_DATE_S",
                "FND_ACFF_PreferredDisplayType":"DATE_TIME"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "primaryIndicator":{
            "title":"Primary Indicator",
            "maxLength":150,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"primaryIndicator_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"primaryIndicator",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_PRI_IND_S",
                "FND_ACFF_ValueSetInfo":"HRC_YES_NO#TABLE",
                "FND_ACFF_EFF_TVVS_ID_BASE_VALUE":"Y",
                "controlType":"combo_lov",
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_PRI_IND_S",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "step_Display":{
            "title":"Step",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"step",
                "FND_ACFF_PartialTarget":"grade startDate endDate",
                "FlexClientVar_flex_vst_bind3_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "controlType":"combo_lov",
                "FlexClientDisplayHint":"Hide",
                "FlexClientVar_flex_vst_bind3_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.startDate",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.grade",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "frequency":{
            "title":"Pay Basis",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_ValueSetInfo":"ORA_PER_RETGRD_PAY_BASIS_VS#TABLE",
                "controlType":"combo_lov",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"frequency",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_FREQUENCY_S",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_FREQUENCY_S",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "AeiInformationCategory":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "default":"ORA_PER_RET_GRADE"
        },
        "grade":{
            "title":"Grade",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"grade_Display",
                "FND_ACFF_IsReferenced":"true",
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_PartialTarget":"startDate endDate gradeLadder gradeLadder",
                "FND_ACFF_OpenIdentifier":"grade",
                "FlexClientVar_flex_vst_bind3_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind1_JT":"java.sql.Date",
                "FND_ACFF_ValueSetInfo":"ORA_PER_RETGRD_GRADE_VS#TABLE",
                "FlexClientVar_flex_vst_bind4_RQ":"true",
                "FlexClientDisplayHint":"Show",
                "FlexClientVar_flex_vst_bind4_VT":"SEGMENT.gradeLadder",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_GRADE_S",
                "FND_ACFF_PreferredDisplayType":"LOV",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FlexClientVar_flex_vst_bind4_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_GRADE_S",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "FND_ACFF_EFF_TVVS_ID_BASE_VALUE":"Y",
                "controlType":"combo_lov",
                "FlexClientVar_flex_vst_bind3_VT":"SEGMENT.gradeLadder",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.startDate",
                "FND_ACFF_JavaType":"java.lang.String",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind4,flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_DependsOnAttributes":"startDate,endDate,gradeLadder"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "AssignmentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EffectiveSequence":{
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":4
            }
        },
        "gradeLadder_Display":{
            "title":"Pay Table ID",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"gradeLadder",
                "FND_ACFF_IsReferenced":"true",
                "FND_ACFF_PartialTarget":"startDate endDate",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "controlType":"combo_lov",
                "FlexClientDisplayHint":"Hide",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.startDate",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FlexClientVsBindVars":"flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "BusinessGroupId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "primaryIndicator_Display":{
            "title":"Primary Indicator",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"primaryIndicator",
                "controlType":"combo_lov",
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "step":{
            "title":"Step",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"step_Display",
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_PartialTarget":"grade startDate endDate",
                "FND_ACFF_OpenIdentifier":"step",
                "FlexClientVar_flex_vst_bind3_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_JT":"java.lang.String",
                "FND_ACFF_ValueSetInfo":"ORA_PER_RETGRD_GRADE_STEP_VS#TABLE",
                "FlexClientDisplayHint":"Show",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.startDate",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_GRADE_STEP_S",
                "FND_ACFF_PreferredDisplayType":"LOV",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_GRADE_STEP_S",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "FND_ACFF_EFF_TVVS_ID_BASE_VALUE":"Y",
                "controlType":"combo_lov",
                "FlexClientVar_flex_vst_bind3_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.grade",
                "FND_ACFF_JavaType":"java.lang.String",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_DependsOnAttributes":"grade,startDate,endDate"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "startDate":{
            "title":"Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "FND_ACFF_IsReferenced":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_ValueSetInfo":"HRC_STANDARD_DATE#FORMAT_ONLY",
                "controlType":"date",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"startDate",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.sql.Date",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_START_DATE_S",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_START_DATE_S",
                "FND_ACFF_PreferredDisplayType":"DATE_TIME"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "gradeLadder":{
            "title":"Pay Table ID",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"gradeLadder_Display",
                "FND_ACFF_IsReferenced":"true",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_PartialTarget":"startDate endDate",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"gradeLadder",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_JT":"java.sql.Date",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_GRADE_LADDER_S",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "FND_ACFF_ValueSetInfo":"ORA_PER_RETGRD_GRADE_LADDER_VS#TABLE",
                "FND_ACFF_EFF_TVVS_ID_BASE_VALUE":"Y",
                "controlType":"combo_lov",
                "FlexClientDisplayHint":"Show",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.startDate",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_GRADE_LADDER_S",
                "FlexClientVsBindVars":"flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_DependsOnAttributes":"startDate,endDate",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "payPlan":{
            "title":"Pay Plan",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_ValueSetInfo":"ORA_PER_RETGRD_PAY_PLAN_VS#TABLE",
                "controlType":"combo_lov",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"payPlan",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_PAY_PLAN_S",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_PAY_PLAN_S",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : emps-assignments-empreps-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : emps-assignments-peopleGroupKeyFlexfield-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : emps-assignments-item-response

Type: object

Show Source

• ActionCode: string
  Title: Action Code

  Maximum Length: 30

  Action performed on a particular record, such as Hire, Add Pending Worker, Manager Change, and so on. Valid values are defined in the list ActionCodeLOV.
• ActionReasonCode: string
  Title: Reason Code

  Maximum Length: 30

  User-defined code for the action reason. Specifies the reason for the action performed on the record. Valid values are defined in the list ActionReasonCodeLOV.
• ActualTerminationDate: string (date)
  Read Only: true

  Actual date of termination of employment. This is required during termination, when the TerminateWorkRelationshipFlag is set to Y.
• AssignmentCategory: string
  Title: Assignment Category

  Maximum Length: 30

  User-defined category such as Full-Time Permanent or Part-Time Permanent. Valid values are defined in the list AssignmentCategoryLOV.
• assignmentDFF: array assignmentDFF
• assignmentExtraInformation: array assignmentExtraInformation
• AssignmentId: integer (int64)
  Title: Assignment ID

  Unique identifier for the assignment. This is a primary key generated by the application.
• AssignmentName: string
  Title: Assignment Name

  Maximum Length: 80

  Name of the assignment.
• AssignmentNumber: string
  Title: Assignment Number

  Maximum Length: 30

  Unique identifier for the assignment or terms. Valid for workers and nonworkers.
• AssignmentProjectedEndDate: string (date)
  Title: Projected End Date

  Date on which the assignment is expected to end.
• AssignmentStatus: string
  Title: Assignment Status

  Maximum Length: 30

  HR status of the assignment, such as Active or Inactive. Valid values are defined in the list AssignmentStatusLOV.
• AssignmentStatusTypeId: integer (int64)
  Title: Assignment Status Type ID

  Unique identifier for the user-defined assignment status. Valid values are defined in the list AssignmentStatusTypeIdLOV.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Unique identifier for the business unit. Valid values are defined in the list BusinessUnitIdLOV.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time of creation of the employee assignment record.
• DefaultExpenseAccount: string
  Default expense account represented as a concatenated value of all the related segments.
• DepartmentId: integer (int64)
  Title: Organization ID

  Unique identifier for the department. Valid values are defined in the list DepartmentIdLOV.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Date at the end of the period within which the employee assignment is effective.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Date at the beginning of the period within which the employee assignment is effective.
• empreps: array Employee Representatives
  Title: Employee Representatives

  The empreps resource is a child of the assignments resource. It includes all employee representatives as of the specified date. By default, the current date is retained.
  This resource is currently under controlled availability.
• EndTime: string
  Title: End Time

  Maximum Length: 5

  Work day normal end time.
• Frequency: string
  Title: Frequency

  Maximum Length: 30

  Frequency of normal working hours such as week, month, year. Valid values are defined in the list FrequencyLOV.
• FullPartTime: string
  Title: Full Time or Part Time

  Maximum Length: 30

  Indicates whether the position the employee is hired for is full-time or part-time. Valid values are defined in the list FullPartTimeLOV.
• GradeId: integer (int64)
  Title: Grade ID

  Unique identifier for the grade. Valid values are defined in the list GradeIdLOV.
• GradeLadderId: integer (int64)
  Title: Grade Ladder ID

  Unique identifier for the grade ladder.
• JobId: integer (int64)
  Title: Job ID

  Unique identifier for the job. Valid values are defined in the list JobIdLOV.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time of update of the employee assignment record.
• LegalEntityId: integer (int64)
  Title: Legal Entity ID

  Unique identifier for the legal entity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  Title: Location ID

  Unique identifier for the location. Valid values are defined in the list LocationIdLOV.
• ManagerAssignmentId: integer (int64)
  Title: Manager Assignment ID

  Identifier for the manager's assignment.
• ManagerId: integer (int64)
  Title: Manager ID

  Unique identifier for a manager. Valid values are defined in the list ManagerIdLOV.
• ManagerType: string
  Title: Type

  Maximum Length: 30

  Role of the manager with regards to the overall organization structure. For example, functional, project leader, and so on.
• OriginalHireDate: string (date)
  Read Only: true

  Original date of hire for employment.
• PeopleGroup: string
  People group represented as a concatenated value of all the related key flexfield segments.
• peopleGroupKeyFlexfield: array peopleGroupKeyFlexfield
• PeriodOfServiceId: integer (int64)
  Title: Period of Service ID

  Primary key autogenerated by the application.
• PersonTypeId: integer (int64)
  Title: Person Type ID

  Unique identifier for the person type. Valid values are defined in the list PersonTypeIdLOV.
• PositionId: integer (int64)
  Title: Position ID

  Unique identifier for a position. Valid values are defined in the list PositionIdLOV.
• PrimaryAssignmentFlag: boolean
  Title: Primary Assignment

  Maximum Length: 30

  Default Value: false

  Indicates whether the current assignment is the primary assignment. Valid values are Yes and No.
• PrimaryWorkRelationFlag: boolean
  Title: Primary Work Relationship

  Maximum Length: 30

  Indicates whether the current work relationship is primary. Valid values are Yes and No.
• PrimaryWorkTermsFlag: boolean
  Title: Primary Employment Terms

  Maximum Length: 30

  Default Value: false

  Indicates whether the current employment terms are primary. Valid values are Yes and No.
• ProbationPeriodEndDate: string (date)
  Title: Probation End Date

  End date of the probation period.
• ProbationPeriodLength: number
  Title: Probation Period

  Duration of the probation period.
• ProbationPeriodUnitOfMeasure: string
  Title: Probation Unit

  Maximum Length: 30

  Units for the probation period duration. Valid values are defined in the list QUALIFYING_UNITS.
• ProjectedStartDate: string (date)
  Title: Projected Start Date

  Proposed start date for the pending worker.
• ProposedPersonTypeId: string
  Title: Proposed Person Type

  Maximum Length: 30

  Unique identifier for the worker class. This value is valid only if the PersonTypeId is Pending Worker. It can be any of the employee or contingent worker types. Valid values are defined in the list ProposedPersonTypeIdLOV.
• RegularTemporary: string
  Title: Regular or Temporary

  Maximum Length: 30

  Indicates whether the position the employee is hired for is regular or temporary. Valid values are defined in the list RegularTemporaryLOV.
• SalaryAmount: number
  Title: Salary Amount

  Salary amount entered based on the salary frequency.
• SalaryBasisId: integer (int64)
  Identifier for the set of details linked to a worker's base pay. It identifies the payroll characteristics used to pay base earnings, the duration for which base pay is quoted, the factor used to annualize base pay, any components used to attribute base pay adjustments to different reasons, and any associated grade rate for salary validation. Valid values are defined in the list SalaryBasisIdLOV.
• SalaryCode: string
  Title: Hourly Paid or Salaried

  Maximum Length: 30

  Identifies whether the assignment is paid by the hour or by a salary. Either maintained at the assignment level or employment or placement terms but not both. Valid values are defined in the list SalaryCodeLOV.
• StartTime: string
  Title: Start Time

  Maximum Length: 5

  Work day normal start time.
• TermsEffectiveStartDate: string (date)
  Title: Effective Start Date

  Date at the beginning of the period within which the employee term is effective.
• WorkerCategory: string
  Title: Worker Category

  Maximum Length: 30

  Category of the worker such as Blue Collar, Civil Servant, and so on. Valid values are defined in the list WorkerCategoryLOV.
• WorkingAsManager: string
  Title: Working as a Manager

  Maximum Length: 30

  Indicates whether the person is a manager. Valid values are Yes and No.
• WorkingAtHome: string
  Title: Working at Home

  Maximum Length: 30

  Indicates whether the person is working at home. Valid values are Yes and No.
• WorkingHours: number
  Title: Working Hours

  Normal working hours.
• WorkTaxAddressId: integer (int64)
  Title: Tax Address ID

  Unique identifier for the address that's used for taxation purposes. This can be different from a mailing address. Valid values are defined in the list WorkTaxAddressIdLOV.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time of creation of the employee assignment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GradeLadderId":{
            "title":"Grade Ladder ID",
            "type":"integer",
            "description":"Unique identifier for the grade ladder.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalaryAmount":{
            "title":"Salary Amount",
            "type":"number",
            "description":"Salary amount entered based on the salary frequency.",
            "nullable":false,
            "x-queryable":true
        },
        "AssignmentProjectedEndDate":{
            "title":"Projected End Date",
            "type":"string",
            "description":"Date on which the assignment is expected to end.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryWorkTermsFlag":{
            "title":"Primary Employment Terms",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the current employment terms are primary. Valid values are Yes and No.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "empreps":{
            "title":"Employee Representatives",
            "type":"array",
            "description":"The empreps resource is a child of the assignments resource. It includes all employee representatives as of the specified date. By default, the current date is retained.<br>This resource is currently under controlled availability.",
            "items":{
                "$ref":"#/components/schemas/emps-assignments-empreps-item-response"
            }
        },
        "WorkerCategory":{
            "title":"Worker Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the worker such as Blue Collar, Civil Servant, and so on. Valid values are defined in the list WorkerCategoryLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActionReasonCode":{
            "title":"Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"User-defined code for the action reason. Specifies the reason for the action performed on the record. Valid values are defined in the list ActionReasonCodeLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FullPartTime":{
            "title":"Full Time or Part Time",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the position the employee is hired for is full-time or part-time. Valid values are defined in the list FullPartTimeLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignmentExtraInformation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emps-assignments-assignmentExtraInformation-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Date at the end of the period within which the employee assignment is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ManagerType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Role of the manager with regards to the overall organization structure. For example, functional, project leader, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Unique identifier for the business unit. Valid values are defined in the list BusinessUnitIdLOV.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "DefaultExpenseAccount":{
            "type":"string",
            "description":"Default expense account represented as a concatenated value of all the related segments.",
            "nullable":true,
            "x-queryable":false
        },
        "ProposedPersonTypeId":{
            "title":"Proposed Person Type",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the worker class. This value is valid only if the PersonTypeId is Pending Worker. It can be any of the employee or contingent worker types. Valid values are defined in the list ProposedPersonTypeIdLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "maxLength":5,
            "type":"string",
            "description":"Work day normal start time.",
            "nullable":true,
            "x-queryable":true
        },
        "PeopleGroup":{
            "type":"string",
            "description":"People group represented as a concatenated value of all the related key flexfield segments.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emps-assignments-assignmentDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentCategory":{
            "title":"Assignment Category",
            "maxLength":30,
            "type":"string",
            "description":"User-defined category such as Full-Time Permanent or Part-Time Permanent. Valid values are defined in the list AssignmentCategoryLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkTaxAddressId":{
            "title":"Tax Address ID",
            "type":"integer",
            "description":"Unique identifier for the address that's used for taxation purposes. This can be different from a mailing address. Valid values are defined in the list WorkTaxAddressIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "SalaryCode":{
            "title":"Hourly Paid or Salaried",
            "maxLength":30,
            "type":"string",
            "description":"Identifies whether the assignment is paid by the hour or by a salary. Either maintained at the assignment level or employment or placement terms but not both. Valid values are defined in the list SalaryCodeLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TermsEffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date at the beginning of the period within which the employee term is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ProbationPeriodEndDate":{
            "title":"Probation End Date",
            "type":"string",
            "description":"End date of the probation period.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTypeId":{
            "title":"Person Type ID",
            "type":"integer",
            "description":"Unique identifier for the person type. Valid values are defined in the list PersonTypeIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ManagerId":{
            "title":"Manager ID",
            "type":"integer",
            "description":"Unique identifier for a manager. Valid values are defined in the list ManagerIdLOV.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "ManagerAssignmentId"
                ]
            },
            "x-queryable":true
        },
        "ProbationPeriodUnitOfMeasure":{
            "title":"Probation Unit",
            "maxLength":30,
            "type":"string",
            "description":"Units for the probation period duration. Valid values are defined in the list QUALIFYING_UNITS.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodOfServiceId":{
            "title":"Period of Service ID",
            "type":"integer",
            "description":"Primary key autogenerated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "maxLength":5,
            "type":"string",
            "description":"Work day normal end time.",
            "nullable":true,
            "x-queryable":true
        },
        "SalaryBasisId":{
            "type":"integer",
            "description":"Identifier for the set of details linked to a worker's base pay. It identifies the payroll characteristics used to pay base earnings, the duration for which base pay is quoted, the factor used to annualize base pay, any components used to attribute base pay adjustments to different reasons, and any associated grade rate for salary validation. Valid values are defined in the list SalaryBasisIdLOV.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ActionCode":{
            "title":"Action Code",
            "maxLength":30,
            "type":"string",
            "description":"Action performed on a particular record, such as Hire, Add Pending Worker, Manager Change, and so on. Valid values are defined in the list ActionCodeLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActualTerminationDate":{
            "type":"string",
            "description":"Actual date of termination of employment. This is required during termination, when the TerminateWorkRelationshipFlag is set to Y.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProbationPeriodLength":{
            "title":"Probation Period",
            "type":"number",
            "description":"Duration of the probation period.",
            "nullable":true,
            "x-hints":{
                "precision":25,
                "scale":5
            },
            "x-queryable":true
        },
        "RegularTemporary":{
            "title":"Regular or Temporary",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the position the employee is hired for is regular or temporary. Valid values are defined in the list RegularTemporaryLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectedStartDate":{
            "title":"Projected Start Date",
            "type":"string",
            "description":"Proposed start date for the pending worker.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryAssignmentFlag":{
            "title":"Primary Assignment",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the current assignment is the primary assignment. Valid values are Yes and No.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LegalEntityId":{
            "title":"Legal Entity ID",
            "type":"integer",
            "description":"Unique identifier for the legal entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "peopleGroupKeyFlexfield":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emps-assignments-peopleGroupKeyFlexfield-item-response"
            },
            "x-cardinality":"1"
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier for the assignment. This is a primary key generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the assignment or terms. Valid for workers and nonworkers.",
            "nullable":true,
            "x-queryable":true
        },
        "GradeId":{
            "title":"Grade ID",
            "type":"integer",
            "description":"Unique identifier for the grade. Valid values are defined in the list GradeIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Unique identifier for the job. Valid values are defined in the list JobIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "WorkingAtHome":{
            "title":"Working at Home",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the person is working at home. Valid values are Yes and No.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryWorkRelationFlag":{
            "title":"Primary Work Relationship",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the current work relationship is primary. Valid values are Yes and No.",
            "nullable":false,
            "x-queryable":true
        },
        "OriginalHireDate":{
            "type":"string",
            "description":"Original date of hire for employment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PositionId":{
            "title":"Position ID",
            "type":"integer",
            "description":"Unique identifier for a position. Valid values are defined in the list PositionIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"Unique identifier for the location. Valid values are defined in the list LocationIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ManagerAssignmentId":{
            "title":"Manager Assignment ID",
            "type":"integer",
            "description":"Identifier for the manager's assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkingHours":{
            "title":"Working Hours",
            "type":"number",
            "description":"Normal working hours.",
            "nullable":true,
            "x-hints":{
                "precision":22,
                "scale":3
            },
            "x-queryable":true
        },
        "AssignmentStatusTypeId":{
            "title":"Assignment Status Type ID",
            "type":"integer",
            "description":"Unique identifier for the user-defined assignment status. Valid values are defined in the list AssignmentStatusTypeIdLOV.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Frequency":{
            "title":"Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Frequency of normal working hours such as week, month, year. Valid values are defined in the list FrequencyLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Unique identifier for the department. Valid values are defined in the list DepartmentIdLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentStatus":{
            "title":"Assignment Status",
            "maxLength":30,
            "type":"string",
            "description":"HR status of the assignment, such as Active or Inactive. Valid values are defined in the list AssignmentStatusLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date at the beginning of the period within which the employee assignment is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "WorkingAsManager":{
            "title":"Working as a Manager",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the person is a manager. Valid values are Yes and No.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time of update of the employee assignment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : assignmentDFF

Type: array

Show Source

• Array of: object emps-assignments-assignmentDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emps-assignments-assignmentDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : assignmentExtraInformation

Type: array

Show Source

• Array of: object Discriminator: CategoryCode
  Discriminator: { "propertyName":"CategoryCode", "mapping":{ "PER_ASG_EIT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response" } }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emps-assignments-assignmentExtraInformation-item-response"
    }
}

Nested Schema : Employee Representatives

Type: array

Title: Employee Representatives

The empreps resource is a child of the assignments resource. It includes all employee representatives as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.

Show Source

• Array of: object emps-assignments-empreps-item-response

{
    "title":"Employee Representatives",
    "type":"array",
    "description":"The empreps resource is a child of the assignments resource. It includes all employee representatives as of the specified date. By default, the current date is retained.<br>This resource is currently under controlled availability.",
    "items":{
        "$ref":"#/components/schemas/emps-assignments-empreps-item-response"
    }
}

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 : peopleGroupKeyFlexfield

Type: array

Show Source

• Array of: object emps-assignments-peopleGroupKeyFlexfield-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emps-assignments-peopleGroupKeyFlexfield-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : emps-assignments-assignmentDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• AssignmentId: integer (int64)
  Title: Assignment ID
• AssignmentType: string
  Title: Assignment Type

  Maximum Length: 30
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveLatestChange: string
  Title: Effective Latest Change

  Maximum Length: 30
• EffectiveSequence: integer (int32)
  Title: Effective Sequence
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "EffectiveLatestChange":{
            "title":"Effective Latest Change",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EffectiveSequence":{
            "title":"Effective Sequence",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":4
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : 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 : Discriminator: CategoryCode

Type: object

Discriminator: CategoryCode

Discriminator Values

• PER_ASG_EIT

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "PER_ASG_EIT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response"
        }
    ]
}

Match One Schema

Show Source

• PER_ASG_EIT - object oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "PER_ASG_EIT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Title: Assignment ID
• AssignmentType: string
  Title: Assignment Type

  Maximum Length: 30
• CategoryCode: string
  Title: EFF Context

  Maximum Length: 80

  Default Value: PER_ASG_EIT
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveLatestChange: string
  Title: Effective Latest Change

  Maximum Length: 30
• EffectiveSequence: integer (int32)
  Title: Effective Sequence
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• InformationORA_5FPER_5FRET_5FGRADEprivateVO: array InformationORA_5FPER_5FRET_5FGRADEprivateVO
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"EFF Context",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "default":"PER_ASG_EIT"
        },
        "EffectiveLatestChange":{
            "title":"Effective Latest Change",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:FND_AUDIT_USER_KEY":"true",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "KeyHelper":"keyContextHelper.setDataSecurityVCName(null);keyContextHelper.resolve(\"oracle.apps.hcm.employment.core.publicModel.view.AssignmentVVO\",\"AssignmentNumber;\");",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "EffectiveSequence":{
            "title":"Effective Sequence",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InformationORA_5FPER_5FRET_5FGRADEprivateVO":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-response"
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false
        }
    }
}

Nested Schema : InformationORA_5FPER_5FRET_5FGRADEprivateVO

Type: array

Show Source

• Array of: object workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-response"
    }
}

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 : workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-response

Type: object

Show Source

• AeiInformationCategory: string
  Maximum Length: 30

  Default Value: ORA_PER_RET_GRADE
• AssignmentExtraInfoId: integer (int64)
• AssignmentId: integer (int64)
• BusinessGroupId: integer (int64)
• CreationDate: string (date-time)
  Read Only: true
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveLatestChange: string
  Maximum Length: 30

  Default Value: Y
• EffectiveSequence: integer (int32)
  Default Value: 1
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• endDate: string (date)
  Title: End Date
• frequency: string
  Title: Pay Basis

  Maximum Length: 150
• grade: string
  Title: Grade

  Maximum Length: 150
• grade_Display: string
  Title: Grade
• gradeLadder: string
  Title: Pay Table ID

  Maximum Length: 150
• gradeLadder_Display: string
  Title: Pay Table ID
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• payPlan: string
  Title: Pay Plan

  Maximum Length: 150
• primaryIndicator: string
  Title: Primary Indicator

  Maximum Length: 150
• primaryIndicator_Display: string
  Title: Primary Indicator
• startDate: string (date)
  Title: Start Date
• step: string
  Title: Step

  Maximum Length: 150
• step_Display: string
  Title: Step

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true
        },
        "AssignmentExtraInfoId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "grade_Display":{
            "title":"Grade",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"grade",
                "FND_ACFF_IsReferenced":"true",
                "FND_ACFF_PartialTarget":"startDate endDate gradeLadder gradeLadder",
                "FlexClientVar_flex_vst_bind3_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind4_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "controlType":"combo_lov",
                "FlexClientVar_flex_vst_bind4_RQ":"true",
                "FlexClientDisplayHint":"Hide",
                "FlexClientVar_flex_vst_bind3_VT":"SEGMENT.gradeLadder",
                "FlexClientVar_flex_vst_bind4_VT":"SEGMENT.gradeLadder",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.startDate",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind4,flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "EffectiveLatestChange":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"Y"
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "endDate":{
            "title":"End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "FND_ACFF_IsReferenced":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_ValueSetInfo":"HRC_STANDARD_DATE#FORMAT_ONLY",
                "controlType":"date",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"endDate",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.sql.Date",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_END_DATE_S",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_END_DATE_S",
                "FND_ACFF_PreferredDisplayType":"DATE_TIME"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "primaryIndicator":{
            "title":"Primary Indicator",
            "maxLength":150,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"primaryIndicator_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"primaryIndicator",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_PRI_IND_S",
                "FND_ACFF_ValueSetInfo":"HRC_YES_NO#TABLE",
                "FND_ACFF_EFF_TVVS_ID_BASE_VALUE":"Y",
                "controlType":"combo_lov",
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_PRI_IND_S",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "step_Display":{
            "title":"Step",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"step",
                "FND_ACFF_PartialTarget":"grade startDate endDate",
                "FlexClientVar_flex_vst_bind3_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "controlType":"combo_lov",
                "FlexClientDisplayHint":"Hide",
                "FlexClientVar_flex_vst_bind3_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.startDate",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.grade",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "frequency":{
            "title":"Pay Basis",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_ValueSetInfo":"ORA_PER_RETGRD_PAY_BASIS_VS#TABLE",
                "controlType":"combo_lov",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"frequency",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_FREQUENCY_S",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_FREQUENCY_S",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "AeiInformationCategory":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "default":"ORA_PER_RET_GRADE"
        },
        "grade":{
            "title":"Grade",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"grade_Display",
                "FND_ACFF_IsReferenced":"true",
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_PartialTarget":"startDate endDate gradeLadder gradeLadder",
                "FND_ACFF_OpenIdentifier":"grade",
                "FlexClientVar_flex_vst_bind3_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind1_JT":"java.sql.Date",
                "FND_ACFF_ValueSetInfo":"ORA_PER_RETGRD_GRADE_VS#TABLE",
                "FlexClientVar_flex_vst_bind4_RQ":"true",
                "FlexClientDisplayHint":"Show",
                "FlexClientVar_flex_vst_bind4_VT":"SEGMENT.gradeLadder",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_GRADE_S",
                "FND_ACFF_PreferredDisplayType":"LOV",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FlexClientVar_flex_vst_bind4_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_GRADE_S",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "FND_ACFF_EFF_TVVS_ID_BASE_VALUE":"Y",
                "controlType":"combo_lov",
                "FlexClientVar_flex_vst_bind3_VT":"SEGMENT.gradeLadder",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.startDate",
                "FND_ACFF_JavaType":"java.lang.String",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind4,flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_DependsOnAttributes":"startDate,endDate,gradeLadder"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "AssignmentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EffectiveSequence":{
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":4
            }
        },
        "gradeLadder_Display":{
            "title":"Pay Table ID",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"gradeLadder",
                "FND_ACFF_IsReferenced":"true",
                "FND_ACFF_PartialTarget":"startDate endDate",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "controlType":"combo_lov",
                "FlexClientDisplayHint":"Hide",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.startDate",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FlexClientVsBindVars":"flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessGroupId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "primaryIndicator_Display":{
            "title":"Primary Indicator",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"primaryIndicator",
                "controlType":"combo_lov",
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "step":{
            "title":"Step",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"step_Display",
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_PartialTarget":"grade startDate endDate",
                "FND_ACFF_OpenIdentifier":"step",
                "FlexClientVar_flex_vst_bind3_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_JT":"java.lang.String",
                "FND_ACFF_ValueSetInfo":"ORA_PER_RETGRD_GRADE_STEP_VS#TABLE",
                "FlexClientDisplayHint":"Show",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.startDate",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_GRADE_STEP_S",
                "FND_ACFF_PreferredDisplayType":"LOV",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_GRADE_STEP_S",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "FND_ACFF_EFF_TVVS_ID_BASE_VALUE":"Y",
                "controlType":"combo_lov",
                "FlexClientVar_flex_vst_bind3_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.grade",
                "FND_ACFF_JavaType":"java.lang.String",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_DependsOnAttributes":"grade,startDate,endDate"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "startDate":{
            "title":"Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "FND_ACFF_IsReferenced":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_ValueSetInfo":"HRC_STANDARD_DATE#FORMAT_ONLY",
                "controlType":"date",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"startDate",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.sql.Date",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_START_DATE_S",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_START_DATE_S",
                "FND_ACFF_PreferredDisplayType":"DATE_TIME"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "gradeLadder":{
            "title":"Pay Table ID",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"gradeLadder_Display",
                "FND_ACFF_IsReferenced":"true",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_PartialTarget":"startDate endDate",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"gradeLadder",
                "FlexClientVar_flex_vst_bind2_JT":"java.sql.Date",
                "FlexClientVar_flex_vst_bind1_JT":"java.sql.Date",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_GRADE_LADDER_S",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "FND_ACFF_ValueSetInfo":"ORA_PER_RETGRD_GRADE_LADDER_VS#TABLE",
                "FND_ACFF_EFF_TVVS_ID_BASE_VALUE":"Y",
                "controlType":"combo_lov",
                "FlexClientDisplayHint":"Show",
                "FlexClientVar_flex_vst_bind2_VT":"SEGMENT.endDate",
                "FlexClientVar_flex_vst_bind1_VT":"SEGMENT.startDate",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_GRADE_LADDER_S",
                "FlexClientVsBindVars":"flex_vst_bind1,flex_vst_bind2",
                "FND_ACFF_DependsOnAttributes":"startDate,endDate",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "payPlan":{
            "title":"Pay Plan",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_EFF_HAS_LOV":"true",
                "FND_ACFF_EFF_SEGMENT_ATTRIBUTE":"true",
                "FND_ACFF_ValueSetInfo":"ORA_PER_RETGRD_PAY_PLAN_VS#TABLE",
                "controlType":"combo_lov",
                "FND_ACFF_EFF_INDEXED_FLAG":"Y",
                "FND_ACFF_OpenIdentifier":"payPlan",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_EFF_CONTEXT_SEGMENT_CODE":"ORA_PER_RETGRD_PAY_PLAN_S",
                "FND_ACFF_SegmentName":"ORA_PER_RETGRD_PAY_PLAN_S",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 : emps-assignments-empreps-item-response

Type: object

Show Source

• AsgResponsibilityId: integer (int64)
  Read Only: true

  Primary key autogenerated by the application.
• AssignmentId: integer (int64)
  Title: Assignment ID

  Read Only: true

  Internal identifier for the assignment.
• links: array Links
  Title: Links

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

  Internal unique identifier for the person.
• ResponsibilityName: string
  Read Only: true

  Maximum Length: 240

  Name of an area of responsibility.
• ResponsibilityTypeCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  Identifier of the responsibility type for which this record holds the criteria. The value is validated against HCM_LOOKUPS with the lookup type PER_RESPONSIBILITY_TYPES.
• ResponsibilityTypeName: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name of the responsibility type for which this record holds the criteria. For example, Benefits Representative.

{
    "type":"object",
    "properties":{
        "ResponsibilityTypeCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifier of the responsibility type for which this record holds the criteria. The value is validated against HCM_LOOKUPS with the lookup type PER_RESPONSIBILITY_TYPES.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Internal unique identifier for the person.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AsgResponsibilityId":{
            "type":"integer",
            "description":"Primary key autogenerated by the application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Internal identifier for the assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponsibilityTypeName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name of the responsibility type for which this record holds the criteria. For example, Benefits Representative.",
            "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"
            }
        },
        "ResponsibilityName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of an area of responsibility.",
            "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"
    }
}

Nested Schema : emps-assignments-peopleGroupKeyFlexfield-item-response

Type: object

Show Source

• _ID_FLEX_NUM: integer (int64)
  Read Only: true
• _PEOPLE_GROUP_ID: integer (int64)
  Read Only: true
• EnabledFlag: string
  Read Only: true

  Maximum Length: 1
• EndDateActive: string (date)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StartDateActive: string (date)
  Read Only: true

{
    "type":"object",
    "properties":{
        "StartDateActive":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EndDateActive":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "_PEOPLE_GROUP_ID":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_IsCCID":"true"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "_ID_FLEX_NUM":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "FND_ACFF_IsStructureID":"true",
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_StructureLookupRequired":"false"
            },
            "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

AssignmentStatusTypeIdLOV

Operation: /hcmRestApi/resources/11.13.18.05/assignmentStatusTypesLov

The list of values for the user-defined status of the assignment.

SalaryBasisIdLOV

Operation: /hcmRestApi/resources/11.13.18.05/salaryBasisLov

The list of values for salary basis.

assignmentDFF

Operation: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentDFF

Parameters:

• assignmentsUniqID: $request.path.assignmentsUniqID
• empsUniqID: $request.path.empsUniqID

assignmentExtraInformation

Operation: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentExtraInformation

Parameters:

• assignmentsUniqID: $request.path.assignmentsUniqID
• empsUniqID: $request.path.empsUniqID

empreps

Operation: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/empreps

Parameters:

• assignmentsUniqID: $request.path.assignmentsUniqID
• empsUniqID: $request.path.empsUniqID

The empreps resource is a child of the assignments resource. It includes all employee representatives as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.

peopleGroupKeyFlexfield

Operation: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/peopleGroupKeyFlexfield

Parameters:

• assignmentsUniqID: $request.path.assignmentsUniqID
• empsUniqID: $request.path.empsUniqID

Back to Top

Examples

The following example shows how to update an employee assignment for manager change, by submitting a PATCH request on the REST resource using cURL.

Note:

Always execute PATCH operations against the self link returned in the GET response.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "Effective-Of:RangeMode=UPDATE;RangeStartDate=2019-01-01" -X PATCH -d <payload> https://<host>:<port>/hcmRestApi/resources/11.13.18.05/emps/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000012D147EA440780000000EACED00057708000110F07EBB375D/child/assignments/00040000000EACED00057708000110F07EBB37790000000EACED0005770800000000000001850000000EACED00057708000000000000017F0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016805879C4078

Example of Payload

The following shows an example of the payload

{
  "ActionCode":"MANAGER_CHANGE",
  "ManagerAssignmentId":"389",  
  "ManagerId":"383",
  "ManagerType":"LINE_MANAGER"
}

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "AssignmentName":"Asg1DEFLG1457528209432",
  "PersonTypeId":13,"BusinessUnitId":202,
  "LocationId":null,"JobId":11,
  "GradeId":null,
  "DepartmentId":null,
  "WorkerCategory":"WC",
  "AssignmentCategory":"FT",
  "WorkingAtHome":"N",
  "WorkingAsManager":"N",
  "SalaryCode":"H",
  "WorkingHours":12,"Frequency":"D",
  "StartTime":"08:00",
  "EndTime":"17:00",
  "SalaryAmount":100000,
  "SalaryBasisId":100010024999994,
  "ActionCode":"MANAGER_CHANGE",
  "ActionReasonCode":"NEWHIRE",
  "AssignmentStatus":"ACTIVE",
  "WorkTaxAddressId":300100011952957,
  "AssignmentId":300100081104761,
  "EffectiveStartDate":"2019-01-01",
  "EffectiveEndDate":"4712-12-31",
  "PositionId":null,
  "TermsEffectiveStartDate":"2019-01-01, "ManagerAssignmentId":389,
  "ManagerId":383,
  "ManagerType":"LINE_MANAGER",
  "AssignmentNumber":"E955160008236641",
  "PeriodOfServiceId":300100081104753,
  "OriginalHireDate":null,
  "PrimaryAssignmentFlag":"Y",
  "ProbationPeriodEndDate":null,
  "ProbationPeriodLength":null,
  "ProbationPeriodUnitOfMeasure":null,
  "AssignmentProjectedEndDate":null,
  "ActualTerminationDate":null,
  "LegalEntityId":40010,
  "PrimaryWorkRelationFlag":"Y",
  "PrimaryWorkTermsFlag":"N",
  "CreationDate":"2016-03-09 18:27:24.133",
  "LastUpdateDate":"2016-03-09 18:28:36.53",
     "links":[24]
       0:  {...
          ...}
}

Back to Top