Create a worker assignment
post
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments
Request
Path Parameters
-
PeriodOfServiceId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
workersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers 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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Maximum Length:30
Action being performed for this assignment, such as, Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV. -
AdjustedFTE: number
Title:
Adjusted FTE
Adjusted Full Time Equivalent for the worker assignment. -
allReports: array
All Reports
Title:
All Reports
The allReports resource is a child of the assignments resource. It provides all the reports of a worker as of the specified date. By default, the current date is retained. -
AnnualWorkingDuration: number
Title:
Annual Working Duration
Annual working duration for the worker assignment. -
AnnualWorkingDurationUnits: string
Title:
Annual Working Duration Units
Maximum Length:20
Description of the annual working duration units. -
AnnualWorkingRatio: number
Title:
Annual Working Ratio
Annual working ratio for the worker assignment. -
AssignmentCategory: string
Title:
Assignment Category
Maximum Length:30
User-defined category for the assignment such as full-time, permanent, and so on. Valid values are defined in the commonLookupsLOV. -
AssignmentName: string
Title:
Business Title
Maximum Length:80
Business title of the worker assignment. -
AssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Unique identifier for the assignment. -
assignmentsDDF: array
assignmentsDDF
-
assignmentsDFF: array
assignmentsDFF
-
assignmentsEFF: array
assignmentsEFF
-
AssignmentStandardFrequency: string
Title:
Assignment Standard Working Hours Units
Maximum Length:30
Standard frequency for the worker assignment. -
AssignmentStandardWorkingHours: number
Title:
Assignment Standard Working Hours
Standard working hours for the worker assignment. -
AssignmentStatusTypeCode: string
Maximum Length:
30
Code for the assignment status type. -
AssignmentStatusTypeId(required): integer
(int64)
Title:
Assignment Status Type ID
Unique identifier for the assignment status type. -
BargainingUnitCode: string
Title:
Bargaining Unit
Maximum Length:30
Code for the bargaining unit. -
BusinessUnitId(required): integer
(int64)
Title:
Business Unit ID
Unique identifier for the business unit of the assignment. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit for the worker assignment. Valid values are defined in the hcmBusinesUnitsLOV. -
CollectiveAgreementId: integer
(int64)
Title:
Collective Agreement ID
Surrogate identifier for the collective agreement. -
CollectiveAgreementName: string
Title:
Collective Agreement
Maximum Length:80
Name for the collective agreement. Valid values are defined in the collectiveAgreementsLov. -
ContractId: integer
(int64)
Title:
Contract ID
Surrogate identifier for the contract. -
ContractNumber: string
Title:
Contract Number
Maximum Length:30
Number of the contract. -
DefaultExpenseAccount: string
Default expense account of the assignment. If the expense account is configured with multiple segments, then provide the concatenated value. Separate the values using the separator configured for the expense account.
-
DepartmentId: integer
(int64)
Title:
Department ID
Unique identifier for the worker's department. -
DepartmentName: string
Title:
Department
Maximum Length:240
Name of the department for the worker assignment. Valid values are defined in the departmentsLov. -
EffectiveEndDate(required): string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveLatestChange(required): string
Title:
Effective Latest Change
Maximum Length:30
Set to Y if this is the last change on the effective start date. Otherwise, set to N. -
EffectiveSequence(required): integer
(int32)
Title:
Effective Sequence
Sequence number of the change on the effective start date. For the first change on the effective start date, set this value to 1. For incremental changes, leave this value blank to generate the next number in the sequence. -
EffectiveStartDate(required): string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
EndTime: string
Title:
End Time
Maximum Length:5
Normal end time for the working day. -
ExpenseCheckSendToAddress: string
Title:
Expense Check Send-to Address
Maximum Length:30
Determines whether expense checks are sent to the home or office address. -
Frequency: string
Title:
Frequency
Maximum Length:30
Frequency of normal working hours such as week or month. Specify with the NormalHours attribute. Valid values are defined in the commonLookupsLOV. -
FullPartTime: string
Title:
Full Time or Part Time
Maximum Length:30
Indicates whether the worker works full-time or part-time. Valid values are defined in the commonLookupsLOV. -
GradeCode: string
Title:
Grade Code
Maximum Length:30
Code of the assignment grade. Valid values are defined in the gradesLov. -
GradeId: integer
(int64)
Title:
Grade ID
Unique identifier for the worker's grade. -
GradeLadderId: integer
(int64)
Title:
Grade Ladder ID
Unique identifier for the grade ladder used for benefits. -
GradeLadderName: string
Title:
Grade Ladder
Maximum Length:240
Name of the grade ladder used for benefits. Valid values are defined in the gradeLaddersLov. -
GradeStepEligibilityFlag: boolean
Title:
Include in Grade Step Progression
Maximum Length:30
Default Value:true
Indicates whether the assignment is eligible for grade-step progression. Valid values are true or false. -
gradeSteps: array
Grade Steps
Title:
Grade Steps
The gradeSteps resource is a child of the assignments resource. It provides all the assignment grade steps of a worker as of the specified date. By default, the current date is retained. -
HourlySalariedCode: 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 commonLookupsLOV. -
InternalBuilding: string
Title:
Building
Maximum Length:45
Building information associated with the work location. -
InternalFloor: string
Title:
Floor
Maximum Length:45
Floor information associated with the work location. -
InternalMailstop: string
Title:
Mail Stop
Maximum Length:45
Internal mail location. -
InternalOfficeNumber: string
Title:
Office Number
Maximum Length:45
Office number associated with the work location. -
JobCode: string
Title:
Job Code
Maximum Length:30
Code for the worker's job. Valid values are defined in the jobsLov. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier for the worker's job. -
LabourUnionMemberFlag: boolean
Title:
Union Member
Maximum Length:30
Indicates whether the worker is a labor union member. -
LocationCode: string
Title:
Location Code
Maximum Length:150
Code for the worker's location. -
LocationId: integer
(int64)
Title:
Location ID
Unique identifier for the worker's location. -
ManagerFlag: boolean
Title:
Working as a Manager
Maximum Length:30
Indicates whether the worker is a manager. -
managers: array
Managers
Title:
Managers
The managers resource is a child of the assignments resource. It provides all the assignment managers of a worker as of the specified date. By default, the current date is retained. -
NormalHours: number
Title:
Working Hours
Normal working hours, such as 37.5. Specify with the Frequency attribute. -
NoticePeriod: integer
(int64)
Title:
Notice Period
Notice period for the assignment. Specify with the NoticePeriodUOM attribute. -
NoticePeriodUOM: string
Title:
Notice Period Units
Maximum Length:30
Unit of measure for the notice period. Specify with the NoticePeriod attribute. Valid values are defined in the commonLookupsLOV. -
PeopleGroup: string
People Group Key flexfield for the assignment. If people group is configured with multiple segments, provide the concatenated value, separating the values with the separator configured for the People Group Key flexfield.
-
PermanentTemporary: string
Title:
Regular or Temporary
Maximum Length:30
Indicates whether the worker is regular or temporary. Valid values are defined in the commonLookupsLOV. -
PositionCode: string
Title:
Position Code
Maximum Length:30
Code for the worker's position. -
PositionId: integer
(int64)
Title:
Position ID
Unique identifier for the worker's position. -
PrimaryAssignmentFlag: boolean
Title:
Primary Assignment
Maximum Length:30
Default Value:false
Indicates whether the current assignment is primary for the work relationship. Valid values are true or false. -
ProbationEndDate: string
(date)
Title:
Probation End Date
End date of the probation period. -
ProbationPeriod: number
Title:
Probation Period
Duration of the probation period. Specify with the ProbationPeriodUnit attribute. -
ProbationPeriodUnit: string
Title:
Probation Unit
Maximum Length:30
Unit of measure for the probation period. Specify with the ProbationPeriod attribute. Valid values are defined in the commonLookupsLOV. -
ProjectedEndDate: string
(date)
Title:
Projected End Date
Date when the assignment is expected to end. -
ProjectedStartDate: string
(date)
Title:
Projected Start Date
Expected start date for applicants. This value is required for pending workers. -
ProposedUserPersonType: string
Title:
Proposed Person Type
Maximum Length:80
Code of the proposed user person type. Valid values are defined in the personTypesLOV. -
ProposedUserPersonTypeId: string
Title:
Proposed User Person Type ID
Maximum Length:30
Unique identifier for the proposed user person type. -
ReasonCode: string
Title:
Reason Code
Maximum Length:30
Reason for the action being performed on the record. Valid values are defined in the actionReasonsLOV. -
ReportingEstablishmentId: integer
(int64)
Title:
Reporting Establishment ID
Unique identifier for the reporting establishment. -
ReportingEstablishmentName: string
Title:
Reporting Establishment
Maximum Length:240
Name of the reporting establishment. Valid values are defined in the reportingEstablishmentsLOV. -
representatives: array
Representatives
Title:
Representatives
The representatives resource is a child of the assignments resource. It provides all the representatives of a worker as of the specified date. By default, the current date is retained. -
RetirementAge: integer
(int64)
Title:
Retirement Age
Age at which the worker is retiring. -
RetirementDate: string
(date)
Title:
Retirement Date
Planned retirement date of the worker. -
SeniorityBasis: string
Title:
Basis for Seniority Calculation
Maximum Length:30
Default Value:ORA_PER_SNDT_DAYS
Basis for calculating seniority for the person. Valid values are defined in the commonLookupsLOV. -
StandardAnnualWorkingDuration: number
Title:
Standard Annual Working Duration
Standard annual working duration for the worker assignment. -
StandardFrequency: string
Frequency of standard working hours such as week or month.
-
StandardWorkingHours: number
Standard working hours such as 40.
-
StartTime: string
Title:
Start Time
Maximum Length:5
Normal start time for the working day. -
SynchronizeFromPositionFlag: boolean
Title:
Synchronize from Position
Maximum Length:30
Default Value:false
Indicates whether attributes from the position can be overridden on the assignment when using position synchronization. Valid values are true or false. -
UnionId: integer
(int64)
Title:
Union ID
Unique identifier of the worker union for the assignment. -
UnionName: string
Title:
Union
Maximum Length:240
Name of the worker union for the assignment. Valid values are defined in the unionsLov. -
UserPersonType: string
Title:
User Person Type
Maximum Length:80
User-defined value that identifies the person type such as employee or contingent worker. Valid values are defined in the personTypesLOV. -
UserPersonTypeId: integer
(int64)
Title:
User Person Type ID
Unique identifier for the user person type. -
WorkAtHomeFlag: boolean
Title:
Working at Home
Maximum Length:30
Indicates whether the worker works at home for the assignment. -
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 commonLookupsLOV. -
workMeasures: array
Work Measures
Title:
Work Measures
The workMeasures resource is a child of the assignments resource. It provides all the assignment work measures of a worker as of the specified date. By default, the current date is retained. -
WorkTaxAddressId: integer
(int64)
Title:
Work Tax Address ID
Unique identifier for the address used for taxation purposes. This can be different from the mailing address.
Nested Schema : All Reports
Type:
array
Title:
All Reports
The allReports resource is a child of the assignments resource. It provides all the reports of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : assignmentsDDF
Type:
Show Source
array
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "DE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-post-request", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-post-request", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-post-request", "IE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFIEVO-item-post-request", "MX":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-post-request", "ORA_HRX_ZA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-post-request", "US":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-post-request" } }
Nested Schema : assignmentsEFF
Type:
Show Source
array
-
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-post-request" } }
Nested Schema : Grade Steps
Type:
array
Title:
Grade Steps
The gradeSteps resource is a child of the assignments resource. It provides all the assignment grade steps of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Managers
Type:
array
Title:
Managers
The managers resource is a child of the assignments resource. It provides all the assignment managers of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Representatives
Type:
array
Title:
Representatives
The representatives resource is a child of the assignments resource. It provides all the representatives of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Work Measures
Type:
array
Title:
Work Measures
The workMeasures resource is a child of the assignments resource. It provides all the assignment work measures of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : workers-workRelationships-assignments-allReports-item-post-request
Type:
Show Source
object
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
DE -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-post-request
-
FR -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-post-request
-
GB -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-post-request
-
IE -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFIEVO-item-post-request
-
MX -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-post-request
-
ORA_HRX_ZA -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-post-request
-
US -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-post-request
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:DE
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_HRX_DE_DIS_EXEMPT_1: string
Title:
Workplace regarding Par. 156 SGB IX
Maximum Length:150
-
_HRX_DE_DIS_EXEMPT_1_Display: string
Title:
Workplace regarding Par. 156 SGB IX
-
_HRX_DE_DIS_EXEMPT_2: string
Title:
Apprentice Details
Maximum Length:150
-
_HRX_DE_DIS_EXEMPT_2_Display: string
Title:
Apprentice Details
-
_HRX_DE_DIS_EXEMPT_3: string
Title:
Exemption Par. 156 passage 2 and 3 SGB IX
Maximum Length:150
-
_HRX_DE_DIS_EXEMPT_3_Display: string
Title:
Exemption Par. 156 passage 2 and 3 SGB IX
-
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
-
oraHrxDeAnnVacDaysEe: number
Title:
Annual Leave Days
-
oraHrxDeContractTypeEe: string
Title:
Contract Type
Maximum Length:150
-
oraHrxDeContractTypeEe_DisplayValue: string
Title:
Contract Type
-
oraHrxDeIrrWorkDaysEe: string
Title:
Irregular Work Day Distribution
Maximum Length:150
-
oraHrxDeProjEndDateEe: string
(date)
Title:
Projected Contract End Date
-
oraHrxDeProRataTempEe: string
Title:
Pro rata temporis
Maximum Length:150
-
oraHrxDeWaitPerLengEe: number
Title:
Individual Waiting Period Length
-
oraHrxDeWaitPerStartEe: string
(date)
Title:
Alternative Waiting Period Start Date
-
oraHrxDeWaitPerUomEe: string
Title:
UOM
Maximum Length:150
-
oraHrxDeWaitPerUomEe_DisplayValue: string
Title:
UOM
-
oraHrxDeWorkDaysEe: number
Title:
Work Days Per Week
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:FR
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_FR_ACTIVITY_MODE: string
Title:
Activity Mode
Maximum Length:150
-
_FR_ACTIVITY_MODE_Display: string
Title:
Activity Mode
-
_JOB_POPULATION_TYPE: string
Title:
Job Population Type
Maximum Length:150
-
_JOB_POPULATION_TYPE_Display: string
Title:
Job Population Type
-
_NUMBER_OF_DAYS_WORK_HOME: number
Title:
Number of Days Working from Home
-
_ORA_HRX_FR_CAGR_GRADE: string
Title:
Collective Agreement Grade
Maximum Length:150
-
_ORA_HRX_FR_CAGR_GRADE_Display: string
Title:
Collective Agreement Grade
-
_TELEWORKING_TIME_UNIT: string
Title:
Teleworking Time Unit
Maximum Length:150
-
_TELEWORKING_TIME_UNIT_Display: string
Title:
Teleworking Time Unit
-
_TRAINING_DURATION_HOURS: number
Title:
Training Duration in Hours
-
_WORKING_DAYS_ANNUAL: number
Title:
Fixed Number of Working Days per Year
-
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
-
primaryAssignment: string
Title:
Main Assignment
Maximum Length:150
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:GB
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_WORKER_ENGAGEMENT_DETAILS: string
Title:
Worker Engagement Details
Maximum Length:150
-
_WORKER_ENGAGEMENT_DETAILS_Display: string
Title:
Worker Engagement Details
-
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
-
oraHrxGbPsTpsRi: string
Title:
Role Identifier
Maximum Length:150
-
standardWorkingHoursOverride: number
Title:
Standard Working Hours Override
-
uniformedGrade: string
Title:
Uniformed grade
Maximum Length:150
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFIEVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:IE
-
__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
-
oraHrxIeWklyWrkHrs: string
Title:
Working Hours Band
Maximum Length:150
-
oraHrxIeWklyWrkHrs_Display: string
Title:
Working Hours Band
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:MX
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_CFDI_CONTRACT_TYPE: string
Title:
CFDI Contract Type
Maximum Length:150
-
_CFDI_CONTRACT_TYPE_Display: string
Title:
CFDI Contract Type
-
_CFDI_FISCAL_REGIME: string
Title:
CFDI Fiscal Regime
Maximum Length:150
-
_CFDI_FISCAL_REGIME_Display: string
Title:
CFDI Fiscal Regime
-
_CFDI_WORK_SHCEDULE_TYPE: string
Title:
CFDI Work Schedule Type
Maximum Length:150
-
_CFDI_WORK_SHCEDULE_TYPE_Display: string
Title:
CFDI Work Schedule Type
-
_MX_SS_SALARY_TYPE: string
Title:
Social Insurance Salary Type
Maximum Length:150
-
_MX_SS_SALARY_TYPE_Display: string
Title:
Social Insurance Salary Type
-
_SUA_REDUCED_WORK_WEEK: string
Title:
Social Insurance Reduced Working Week
Maximum Length:150
-
_SUA_REDUCED_WORK_WEEK_Display: string
Title:
Social Insurance Reduced Working Week
-
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
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:ORA_HRX_ZA
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_ORA_HRX_ZA_NATURE_OF_PERSON: string
Title:
Nature of Person
Maximum Length:150
-
_ORA_HRX_ZA_NATURE_OF_PERSON_Display: string
Title:
Nature of Person
-
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
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:US
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
acaEligibility: string
Title:
ACA Eligibility
Maximum Length:150
-
acaEligibility_Display: string
Title:
ACA Eligibility
-
ACAFullTime: string
Title:
ACA Full Time
Maximum Length:150
-
ACAFullTime_Display: string
Title:
ACA Full Time
-
administrationPeriodBeginDate: string
(date)
Title:
Administrative Period Start Date
-
administrationPeriodEndDate: string
(date)
Title:
Administrative Period End Date
-
affordableHraOffered: string
Title:
Affordable HRA Offered
Maximum Length:150
-
affordableHraZipCode: string
Title:
HRA Affordability ZIP Code
Maximum Length:150
-
affordableHraZipCode_Display: string
Title:
HRA Affordability ZIP Code
-
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
-
initialFlag: string
Title:
Initial Employee
Maximum Length:150
-
initialFlag_Display: string
Title:
Initial Employee
-
limitedNonassessmentPeriod: string
Title:
Limited Nonassessment Period
Maximum Length:150
-
limitedNonassessmentPeriod_Display: string
Title:
Limited Nonassessment Period
-
measurementPeriodBeginDate: string
(date)
Title:
Measurement Period Start Date
-
measurementPeriodEndDate: string
(date)
Title:
Measurement Period End Date
-
processingPriority: number
Title:
Processing Priority
-
safeHarborOverride: string
Title:
Safe Harbor Override
Maximum Length:150
-
safeHarborOverride_Display: string
Title:
Safe Harbor Override
-
stabilityPeriodBeginDate: string
(date)
Title:
Stability Period Start Date
-
stabilityPeriodEndDate: string
(date)
Title:
Stability Period End Date
Nested Schema : schema
Type:
Show Source
object
-
__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
Nested Schema : Discriminator: CategoryCode
Type:
object
Discriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-post-request
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Title:
Assignment ID
-
AssignmentType(required): string
Title:
Assignment Type
Maximum Length:30
-
CategoryCode: string
Title:
EFF Context
Maximum Length:80
Default Value:PER_ASG_EIT
-
EffectiveEndDate(required): string
(date)
Title:
Effective End Date
-
EffectiveLatestChange(required): string
Title:
Effective Latest Change
Maximum Length:30
-
EffectiveSequence(required): integer
(int32)
Title:
Effective Sequence
-
EffectiveStartDate(required): string
(date)
Title:
Effective Start Date
-
InformationORA_5FPER_5FRET_5FGRADEprivateVO: array
InformationORA_5FPER_5FRET_5FGRADEprivateVO
Nested Schema : emps-assignments-assignmentExtraInformation-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-post-request
Type:
Show Source
object
-
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
Nested Schema : schema
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Action being performed for the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV. -
AssignGradeStepId: integer
(int64)
Title:
Assignment Grade Step ID
Surrogate identifier for the assignment grade step record. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
GradeId: integer
Surrogate identifier for the grade.
-
GradeStepId: integer
(int64)
Title:
Grade Step ID
Surrogate identifier for the grade step. -
GradeStepName: string
Title:
Name
Maximum Length:240
Name of the grade step. Valid values are defined in the gradeStepNamesLOV. -
ReasonCode: string
Title:
Reason Code
Reason for the change.Valid values are defined in the actionReasonsLOV.
Nested Schema : schema
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Maximum Length:80
Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
ManagerAssignmentId: integer
(int64)
Title:
Assignment ID
Surrogate identifier for the assignment supervisor. -
ManagerAssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Assignment number of the supervisor. -
ManagerType: string
Title:
Type
Maximum Length:30
Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. Valid values are defined in the commonLookupsLOV. -
ReasonCode: string
Title:
Reason Code
Maximum Length:80
Reason for the change. Valid values are defined in the actionReasonsLOV.
Nested Schema : workers-workRelationships-assignments-representatives-item-post-request
Type:
Show Source
object
Nested Schema : schema
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV. -
CalculateWorkmeasureFlag: boolean
Title:
Calculate FTE and Headcount Automatically
Maximum Length:30
Indicates whether the full time equivalency (FTE) should be calculated automatically. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
ReasonCode: string
Title:
Reason Code
Reason for the change.Valid values are defined in the actionReasonsLOV. -
Unit: string
Title:
Unit
Maximum Length:30
Unit of measure. Valid values are defined in the commonLookupsLOV. -
Value: number
Title:
Value
Value of the work measure.
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.
Root Schema : workers-workRelationships-assignments-item-response
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Maximum Length:30
Action being performed for this assignment, such as, Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV. -
ActionName: string
Title:
Action Name
Read Only:true
Maximum Length:80
Name of the action performed on the assignment. -
AdjustedFTE: number
Title:
Adjusted FTE
Adjusted Full Time Equivalent for the worker assignment. -
allReports: array
All Reports
Title:
All Reports
The allReports resource is a child of the assignments resource. It provides all the reports of a worker as of the specified date. By default, the current date is retained. -
AnnualWorkingDuration: number
Title:
Annual Working Duration
Annual working duration for the worker assignment. -
AnnualWorkingDurationUnits: string
Title:
Annual Working Duration Units
Maximum Length:20
Description of the annual working duration units. -
AnnualWorkingRatio: number
Title:
Annual Working Ratio
Annual working ratio for the worker assignment. -
AssignmentCategory: string
Title:
Assignment Category
Maximum Length:30
User-defined category for the assignment such as full-time, permanent, and so on. Valid values are defined in the commonLookupsLOV. -
AssignmentCategoryMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the assignment category. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
Surrogate identifier for the worker assignment. -
AssignmentName: string
Title:
Business Title
Maximum Length:80
Business title of the worker assignment. -
AssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Unique identifier for the assignment. -
assignmentsDDF: array
assignmentsDDF
-
assignmentsDFF: array
assignmentsDFF
-
assignmentsEFF: array
assignmentsEFF
-
AssignmentStandardFrequency: string
Title:
Assignment Standard Working Hours Units
Maximum Length:30
Standard frequency for the worker assignment. -
AssignmentStandardWorkingHours: number
Title:
Assignment Standard Working Hours
Standard working hours for the worker assignment. -
AssignmentStatusType: string
Title:
Assignment Status
Read Only:true
Maximum Length:30
Assignment status type. Valid values are defined in the assignmentStatusTypesLov. -
AssignmentStatusTypeCode: string
Maximum Length:
30
Code for the assignment status type. -
AssignmentStatusTypeId: integer
(int64)
Title:
Assignment Status Type ID
Unique identifier for the assignment status type. -
AssignmentType: string
Title:
Assignment Type
Read Only:true
Maximum Length:30
Type of the assignment such as employee or contingent worker. -
AssignmentTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the assignment type. -
BargainingUnitCode: string
Title:
Bargaining Unit
Maximum Length:30
Code for the bargaining unit. -
BargainingUnitMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the bargaining unit. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Unique identifier for the business unit of the assignment. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit for the worker assignment. Valid values are defined in the hcmBusinesUnitsLOV. -
CollectiveAgreementId: integer
(int64)
Title:
Collective Agreement ID
Surrogate identifier for the collective agreement. -
CollectiveAgreementName: string
Title:
Collective Agreement
Maximum Length:80
Name for the collective agreement. Valid values are defined in the collectiveAgreementsLov. -
ContractId: integer
(int64)
Title:
Contract ID
Surrogate identifier for the contract. -
ContractNumber: string
Title:
Contract Number
Maximum Length:30
Number of the contract. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the assignment record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the assignment record was created. -
DefaultExpenseAccount: string
Default expense account of the assignment. If the expense account is configured with multiple segments, then provide the concatenated value. Separate the values using the separator configured for the expense account.
-
DepartmentId: integer
(int64)
Title:
Department ID
Unique identifier for the worker's department. -
DepartmentName: string
Title:
Department
Maximum Length:240
Name of the department for the worker assignment. Valid values are defined in the departmentsLov. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveLatestChange: string
Title:
Effective Latest Change
Maximum Length:30
Set to Y if this is the last change on the effective start date. Otherwise, set to N. -
EffectiveSequence: integer
(int32)
Title:
Effective Sequence
Sequence number of the change on the effective start date. For the first change on the effective start date, set this value to 1. For incremental changes, leave this value blank to generate the next number in the sequence. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
EndTime: string
Title:
End Time
Maximum Length:5
Normal end time for the working day. -
ExpenseCheckSendToAddress: string
Title:
Expense Check Send-to Address
Maximum Length:30
Determines whether expense checks are sent to the home or office address. -
ExpenseCheckSendToAddressMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the expense check address. -
Frequency: string
Title:
Frequency
Maximum Length:30
Frequency of normal working hours such as week or month. Specify with the NormalHours attribute. Valid values are defined in the commonLookupsLOV. -
FrequencyMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the assignment frequency. -
FullPartTime: string
Title:
Full Time or Part Time
Maximum Length:30
Indicates whether the worker works full-time or part-time. Valid values are defined in the commonLookupsLOV. -
FullPartTimeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning that indicates whether the worker is full time or part time. -
GradeCeilingStep: string
Title:
Special Ceiling Step
Read Only:true
Grade step for this assignment. -
GradeCeilingStepId: integer
(int64)
Title:
Grade Ceiling Step ID
Read Only:true
Unique identifier for the grade step of the assignment. -
GradeCode: string
Title:
Grade Code
Maximum Length:30
Code of the assignment grade. Valid values are defined in the gradesLov. -
GradeId: integer
(int64)
Title:
Grade ID
Unique identifier for the worker's grade. -
GradeLadderId: integer
(int64)
Title:
Grade Ladder ID
Unique identifier for the grade ladder used for benefits. -
GradeLadderName: string
Title:
Grade Ladder
Maximum Length:240
Name of the grade ladder used for benefits. Valid values are defined in the gradeLaddersLov. -
GradeName: string
Title:
Grade
Read Only:true
Maximum Length:240
Name of the grade. -
GradeStepEligibilityFlag: boolean
Title:
Include in Grade Step Progression
Maximum Length:30
Default Value:true
Indicates whether the assignment is eligible for grade-step progression. Valid values are true or false. -
gradeSteps: array
Grade Steps
Title:
Grade Steps
The gradeSteps resource is a child of the assignments resource. It provides all the assignment grade steps of a worker as of the specified date. By default, the current date is retained. -
HourlySalariedCode: 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 commonLookupsLOV. -
HourlySalariedMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning that indicates whether the worker is hourly or salaried. -
InternalBuilding: string
Title:
Building
Maximum Length:45
Building information associated with the work location. -
InternalFloor: string
Title:
Floor
Maximum Length:45
Floor information associated with the work location. -
InternalMailstop: string
Title:
Mail Stop
Maximum Length:45
Internal mail location. -
InternalOfficeNumber: string
Title:
Office Number
Maximum Length:45
Office number associated with the work location. -
JobCode: string
Title:
Job Code
Maximum Length:30
Code for the worker's job. Valid values are defined in the jobsLov. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier for the worker's job. -
JobName: string
Title:
Job
Read Only:true
Maximum Length:240
Name of the job. -
LabourUnionMemberFlag: boolean
Title:
Union Member
Maximum Length:30
Indicates whether the worker is a labor union member. -
LastUpdateDate: string
(date-time)
Title:
Last Changed Date
Read Only:true
Date and time when the assignment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the assignment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationCode: string
Title:
Location Code
Maximum Length:150
Code for the worker's location. -
LocationId: integer
(int64)
Title:
Location ID
Unique identifier for the worker's location. -
LocationName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Name of the assignment location. -
ManagerFlag: boolean
Title:
Working as a Manager
Maximum Length:30
Indicates whether the worker is a manager. -
managers: array
Managers
Title:
Managers
The managers resource is a child of the assignments resource. It provides all the assignment managers of a worker as of the specified date. By default, the current date is retained. -
NormalHours: number
Title:
Working Hours
Normal working hours, such as 37.5. Specify with the Frequency attribute. -
NoticePeriod: integer
(int64)
Title:
Notice Period
Notice period for the assignment. Specify with the NoticePeriodUOM attribute. -
NoticePeriodUOM: string
Title:
Notice Period Units
Maximum Length:30
Unit of measure for the notice period. Specify with the NoticePeriod attribute. Valid values are defined in the commonLookupsLOV. -
NoticePeriodUOMMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the notice period unit of measure. -
PeopleGroup: string
People Group Key flexfield for the assignment. If people group is configured with multiple segments, provide the concatenated value, separating the values with the separator configured for the People Group Key flexfield.
-
PermanentTemporary: string
Title:
Regular or Temporary
Maximum Length:30
Indicates whether the worker is regular or temporary. Valid values are defined in the commonLookupsLOV. -
PermanentTemporaryMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning that indicates whether the worker is permanent or temporary. -
PositionCode: string
Title:
Position Code
Maximum Length:30
Code for the worker's position. -
PositionId: integer
(int64)
Title:
Position ID
Unique identifier for the worker's position. -
PositionName: string
Title:
Position
Read Only:true
Maximum Length:240
Name of the position. -
PrimaryAssignmentFlag: boolean
Title:
Primary Assignment
Maximum Length:30
Default Value:false
Indicates whether the current assignment is primary for the work relationship. Valid values are true or false. -
PrimaryFlag: boolean
Title:
Primary
Read Only:true
Maximum Length:30
Default Value:false
Indicates whether the current assignment is the primary assignment for the worker. Valid values are true or false. -
ProbationEndDate: string
(date)
Title:
Probation End Date
End date of the probation period. -
ProbationPeriod: number
Title:
Probation Period
Duration of the probation period. Specify with the ProbationPeriodUnit attribute. -
ProbationPeriodUnit: string
Title:
Probation Unit
Maximum Length:30
Unit of measure for the probation period. Specify with the ProbationPeriod attribute. Valid values are defined in the commonLookupsLOV. -
ProbationPeriodUnitMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the probation period unit. -
ProjectedEndDate: string
(date)
Title:
Projected End Date
Date when the assignment is expected to end. -
ProjectedStartDate: string
(date)
Title:
Projected Start Date
Expected start date for applicants. This value is required for pending workers. -
ProposedUserPersonType: string
Title:
Proposed Person Type
Maximum Length:80
Code of the proposed user person type. Valid values are defined in the personTypesLOV. -
ProposedUserPersonTypeId: string
Title:
Proposed User Person Type ID
Maximum Length:30
Unique identifier for the proposed user person type. -
ReasonCode: string
Title:
Reason Code
Maximum Length:30
Reason for the action being performed on the record. Valid values are defined in the actionReasonsLOV. -
ReasonName: string
Title:
Action Reason
Read Only:true
Maximum Length:80
Name of the reason for the action being performed on the assignment. -
ReportingEstablishmentId: integer
(int64)
Title:
Reporting Establishment ID
Unique identifier for the reporting establishment. -
ReportingEstablishmentName: string
Title:
Reporting Establishment
Maximum Length:240
Name of the reporting establishment. Valid values are defined in the reportingEstablishmentsLOV. -
representatives: array
Representatives
Title:
Representatives
The representatives resource is a child of the assignments resource. It provides all the representatives of a worker as of the specified date. By default, the current date is retained. -
RetirementAge: integer
(int64)
Title:
Retirement Age
Age at which the worker is retiring. -
RetirementDate: string
(date)
Title:
Retirement Date
Planned retirement date of the worker. -
SeniorityBasis: string
Title:
Basis for Seniority Calculation
Maximum Length:30
Default Value:ORA_PER_SNDT_DAYS
Basis for calculating seniority for the person. Valid values are defined in the commonLookupsLOV. -
SeniorityBasisMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the seniority basis. -
StandardAnnualWorkingDuration: number
Title:
Standard Annual Working Duration
Standard annual working duration for the worker assignment. -
StandardFrequency: string
Frequency of standard working hours such as week or month.
-
StandardWorkingHours: number
Standard working hours such as 40.
-
StartTime: string
Title:
Start Time
Maximum Length:5
Normal start time for the working day. -
SynchronizeFromPositionFlag: boolean
Title:
Synchronize from Position
Maximum Length:30
Default Value:false
Indicates whether attributes from the position can be overridden on the assignment when using position synchronization. Valid values are true or false. -
SystemPersonType: string
Title:
System Person Type
Read Only:true
Maximum Length:30
Application-defined value that identifies a person type, such as employee or contingent worker. -
UnionId: integer
(int64)
Title:
Union ID
Unique identifier of the worker union for the assignment. -
UnionName: string
Title:
Union
Maximum Length:240
Name of the worker union for the assignment. Valid values are defined in the unionsLov. -
UserPersonType: string
Title:
User Person Type
Maximum Length:80
User-defined value that identifies the person type such as employee or contingent worker. Valid values are defined in the personTypesLOV. -
UserPersonTypeId: integer
(int64)
Title:
User Person Type ID
Unique identifier for the user person type. -
WorkAtHomeFlag: boolean
Title:
Working at Home
Maximum Length:30
Indicates whether the worker works at home for the assignment. -
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 commonLookupsLOV. -
WorkerCategoryMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the worker category. -
workMeasures: array
Work Measures
Title:
Work Measures
The workMeasures resource is a child of the assignments resource. It provides all the assignment work measures of a worker as of the specified date. By default, the current date is retained. -
WorkTaxAddressId: integer
(int64)
Title:
Work Tax Address ID
Unique identifier for the address used for taxation purposes. This can be different from the mailing address.
Nested Schema : All Reports
Type:
array
Title:
All Reports
The allReports resource is a child of the assignments resource. It provides all the reports of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : assignmentsDDF
Type:
Show Source
array
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "DE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-response", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-response", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-response", "IE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFIEVO-item-response", "MX":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-response", "ORA_HRX_ZA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-response" } }
Nested Schema : assignmentsEFF
Type:
Show Source
array
-
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" } }
Nested Schema : Grade Steps
Type:
array
Title:
Grade Steps
The gradeSteps resource is a child of the assignments resource. It provides all the assignment grade steps of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Managers
Type:
array
Title:
Managers
The managers resource is a child of the assignments resource. It provides all the assignment managers of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Representatives
Type:
array
Title:
Representatives
The representatives resource is a child of the assignments resource. It provides all the representatives of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Work Measures
Type:
array
Title:
Work Measures
The workMeasures resource is a child of the assignments resource. It provides all the assignment work measures of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : workers-workRelationships-assignments-allReports-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
Internal identifier for the reports assignment. -
AssignmentName: string
Title:
Business Title
Read Only:true
Maximum Length:80
Business title of the report. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the report. -
DisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Display name of the report. -
Level: integer
(int32)
Title:
Level
Read Only:true
Level of the report in the manager's hierarchy. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerAssignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
Internal identifier for the assignment of the immediate manager of each report. -
ManagerAssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Name of the assignment of the person's manager. -
ManagerAssignmentNumber: string
Title:
Manager Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the immediate manager of each report. -
ManagerDisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the person's manager. -
ManagerId: integer
(int64)
Read Only:
true
Internal identifier for the immediate manager of each report. -
ManagerPersonNumber: string
Title:
Manager Person Number
Read Only:true
Maximum Length:30
Person number of the immediate manager of each report. -
PersonId: integer
(int64)
Title:
Person ID
Read Only:true
Surrogate identifier for the report. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the report. -
RelationshipType: string
Title:
Relationship Type
Read Only:true
Maximum Length:30
Type of managerial relationship with the report such as line manager. -
RelationshipTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning for the person's manager relationship type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
DE -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-response
-
FR -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-response
-
GB -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-response
-
IE -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFIEVO-item-response
-
MX -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-response
-
ORA_HRX_ZA -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-response
-
US -
object
oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-response
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:DE
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_HRX_DE_DIS_EXEMPT_1: string
Title:
Workplace regarding Par. 156 SGB IX
Maximum Length:150
-
_HRX_DE_DIS_EXEMPT_1_Display: string
Title:
Workplace regarding Par. 156 SGB IX
-
_HRX_DE_DIS_EXEMPT_2: string
Title:
Apprentice Details
Maximum Length:150
-
_HRX_DE_DIS_EXEMPT_2_Display: string
Title:
Apprentice Details
-
_HRX_DE_DIS_EXEMPT_3: string
Title:
Exemption Par. 156 passage 2 and 3 SGB IX
Maximum Length:150
-
_HRX_DE_DIS_EXEMPT_3_Display: string
Title:
Exemption Par. 156 passage 2 and 3 SGB IX
-
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. -
oraHrxDeAnnVacDaysEe: number
Title:
Annual Leave Days
-
oraHrxDeContractTypeEe: string
Title:
Contract Type
Maximum Length:150
-
oraHrxDeContractTypeEe_DisplayValue: string
Title:
Contract Type
-
oraHrxDeIrrWorkDaysEe: string
Title:
Irregular Work Day Distribution
Maximum Length:150
-
oraHrxDeProjEndDateEe: string
(date)
Title:
Projected Contract End Date
-
oraHrxDeProRataTempEe: string
Title:
Pro rata temporis
Maximum Length:150
-
oraHrxDeWaitPerLengEe: number
Title:
Individual Waiting Period Length
-
oraHrxDeWaitPerStartEe: string
(date)
Title:
Alternative Waiting Period Start Date
-
oraHrxDeWaitPerUomEe: string
Title:
UOM
Maximum Length:150
-
oraHrxDeWaitPerUomEe_DisplayValue: string
Title:
UOM
-
oraHrxDeWorkDaysEe: number
Title:
Work Days Per Week
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:FR
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_FR_ACTIVITY_MODE: string
Title:
Activity Mode
Maximum Length:150
-
_FR_ACTIVITY_MODE_Display: string
Title:
Activity Mode
-
_JOB_POPULATION_TYPE: string
Title:
Job Population Type
Maximum Length:150
-
_JOB_POPULATION_TYPE_Display: string
Title:
Job Population Type
-
_NUMBER_OF_DAYS_WORK_HOME: number
Title:
Number of Days Working from Home
-
_ORA_HRX_FR_CAGR_GRADE: string
Title:
Collective Agreement Grade
Maximum Length:150
-
_ORA_HRX_FR_CAGR_GRADE_Display: string
Title:
Collective Agreement Grade
-
_TELEWORKING_TIME_UNIT: string
Title:
Teleworking Time Unit
Maximum Length:150
-
_TELEWORKING_TIME_UNIT_Display: string
Title:
Teleworking Time Unit
-
_TRAINING_DURATION_HOURS: number
Title:
Training Duration in Hours
-
_WORKING_DAYS_ANNUAL: number
Title:
Fixed Number of Working Days per Year
-
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. -
primaryAssignment: string
Title:
Main Assignment
Maximum Length:150
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:GB
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_WORKER_ENGAGEMENT_DETAILS: string
Title:
Worker Engagement Details
Maximum Length:150
-
_WORKER_ENGAGEMENT_DETAILS_Display: string
Title:
Worker Engagement Details
-
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. -
oraHrxGbPsTpsRi: string
Title:
Role Identifier
Maximum Length:150
-
standardWorkingHoursOverride: number
Title:
Standard Working Hours Override
-
uniformedGrade: string
Title:
Uniformed grade
Maximum Length:150
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFIEVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:IE
-
__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. -
oraHrxIeWklyWrkHrs: string
Title:
Working Hours Band
Maximum Length:150
-
oraHrxIeWklyWrkHrs_Display: string
Title:
Working Hours Band
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:MX
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_CFDI_CONTRACT_TYPE: string
Title:
CFDI Contract Type
Maximum Length:150
-
_CFDI_CONTRACT_TYPE_Display: string
Title:
CFDI Contract Type
-
_CFDI_FISCAL_REGIME: string
Title:
CFDI Fiscal Regime
Maximum Length:150
-
_CFDI_FISCAL_REGIME_Display: string
Title:
CFDI Fiscal Regime
-
_CFDI_WORK_SHCEDULE_TYPE: string
Title:
CFDI Work Schedule Type
Maximum Length:150
-
_CFDI_WORK_SHCEDULE_TYPE_Display: string
Title:
CFDI Work Schedule Type
-
_MX_SS_SALARY_TYPE: string
Title:
Social Insurance Salary Type
Maximum Length:150
-
_MX_SS_SALARY_TYPE_Display: string
Title:
Social Insurance Salary Type
-
_SUA_REDUCED_WORK_WEEK: string
Title:
Social Insurance Reduced Working Week
Maximum Length:150
-
_SUA_REDUCED_WORK_WEEK_Display: string
Title:
Social Insurance Reduced Working Week
-
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.
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:ORA_HRX_ZA
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_ORA_HRX_ZA_NATURE_OF_PERSON: string
Title:
Nature of Person
Maximum Length:150
-
_ORA_HRX_ZA_NATURE_OF_PERSON_Display: string
Title:
Nature of Person
-
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.
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:US
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
acaEligibility: string
Title:
ACA Eligibility
Maximum Length:150
-
acaEligibility_Display: string
Title:
ACA Eligibility
-
ACAFullTime: string
Title:
ACA Full Time
Maximum Length:150
-
ACAFullTime_Display: string
Title:
ACA Full Time
-
administrationPeriodBeginDate: string
(date)
Title:
Administrative Period Start Date
-
administrationPeriodEndDate: string
(date)
Title:
Administrative Period End Date
-
affordableHraOffered: string
Title:
Affordable HRA Offered
Maximum Length:150
-
affordableHraZipCode: string
Title:
HRA Affordability ZIP Code
Maximum Length:150
-
affordableHraZipCode_Display: string
Title:
HRA Affordability ZIP Code
-
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
-
initialFlag: string
Title:
Initial Employee
Maximum Length:150
-
initialFlag_Display: string
Title:
Initial Employee
-
limitedNonassessmentPeriod: string
Title:
Limited Nonassessment Period
Maximum Length:150
-
limitedNonassessmentPeriod_Display: string
Title:
Limited Nonassessment Period
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
measurementPeriodBeginDate: string
(date)
Title:
Measurement Period Start Date
-
measurementPeriodEndDate: string
(date)
Title:
Measurement Period End Date
-
processingPriority: number
Title:
Processing Priority
-
safeHarborOverride: string
Title:
Safe Harbor Override
Maximum Length:150
-
safeHarborOverride_Display: string
Title:
Safe Harbor Override
-
stabilityPeriodBeginDate: string
(date)
Title:
Stability Period Start Date
-
stabilityPeriodEndDate: string
(date)
Title:
Stability Period End Date
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workers-workRelationships-assignments-assignmentsDFF-item-response
Type:
Show Source
object
-
__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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: CategoryCode
Type:
object
Discriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-assignments-assignmentExtraInformation-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-response
Type:
Show Source
object
-
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workers-workRelationships-assignments-gradeSteps-item-response
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Action being performed for the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV. -
AssignGradeStepId: integer
(int64)
Title:
Assignment Grade Step ID
Surrogate identifier for the assignment grade step record. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the grade step. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the grade step was created. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
GradeId: integer
Surrogate identifier for the grade.
-
GradeName: string
Title:
Grade
Read Only:true
Maximum Length:240
Name of the person's grade. -
GradeStepId: integer
(int64)
Title:
Grade Step ID
Surrogate identifier for the grade step. -
GradeStepName: string
Title:
Name
Maximum Length:240
Name of the grade step. Valid values are defined in the gradeStepNamesLOV. -
LastUpdateDate: string
(date-time)
Title:
Last Changed Date
Read Only:true
User who last updated the grade step. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Date and time when the grade step was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReasonCode: string
Title:
Reason Code
Reason for the change.Valid values are defined in the actionReasonsLOV.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workers-workRelationships-assignments-managers-item-response
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Maximum Length:80
Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV. -
AssignmentSupervisorId: integer
(int64)
Title:
Assignment Supervisor ID
Read Only:true
Surrogate identifier for the supervisor of the worker assignment. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the supervisor record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the supervisor record was created. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
LastUpdateDate: string
(date-time)
Title:
Last Changed Date
Read Only:true
User who last updated the supervisor record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Date and time when the supervisor record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerAssignmentId: integer
(int64)
Title:
Assignment ID
Surrogate identifier for the assignment supervisor. -
ManagerAssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Assignment number of the supervisor. -
ManagerType: string
Title:
Type
Maximum Length:30
Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. Valid values are defined in the commonLookupsLOV. -
ManagerTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning for person's manager type. -
ReasonCode: string
Title:
Reason Code
Maximum Length:80
Reason for the change. Valid values are defined in the actionReasonsLOV.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workers-workRelationships-assignments-representatives-item-response
Type:
Show Source
object
-
AsgResponsibilityId: integer
(int64)
Read Only:
true
Surrogate identifier for the responsibility. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
Internal identifier for the representative's assignment. -
AssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Name of the person's assignment. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the representative. -
DisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Display name of the representative. -
FromDate: string
(date)
Title:
From Date
Read Only:true
Date when the responsibility starts. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Read Only:
true
Internal identifier for the representative. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the representative. -
ResponsibilityName: string
Title:
Responsibility Name
Read Only:true
Maximum Length:240
Name of the area of responsibility of the representative such as Benefits Representative. -
ResponsibilityType: string
Title:
Responsibility Type
Read Only:true
Maximum Length:80
Responsibility type of the representative such as Human Resource Representative. -
ToDate: string
(date)
Title:
To Date
Read Only:true
Date when the responsibility ends. -
Usage: string
Read Only:
true
Maximum Length:4000
Description of the purpose for the responsibility. -
WorkContactsFlag: boolean
Title:
Work Contacts
Read Only:true
Maximum Length:30
Indicates whether the representatives should be displayed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workers-workRelationships-assignments-workMeasures-item-response
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV. -
AssignWorkMeasureId: integer
(int64)
Title:
Assignment Work Measure ID
Read Only:true
Surrogate identifier for the assignment work measure. -
CalculateWorkmeasureFlag: boolean
Title:
Calculate FTE and Headcount Automatically
Maximum Length:30
Indicates whether the full time equivalency (FTE) should be calculated automatically. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the work measure. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the work measure was created. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
LastUpdateDate: string
(date-time)
Title:
Last Changed Date
Read Only:true
Date and time when the work measure was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the work measure. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReasonCode: string
Title:
Reason Code
Reason for the change.Valid values are defined in the actionReasonsLOV. -
Unit: string
Title:
Unit
Maximum Length:30
Unit of measure. Valid values are defined in the commonLookupsLOV. -
UnitMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the person's unit code. -
Value: number
Title:
Value
Value of the work measure.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- actionReasonsLOV
-
Parameters:
- finder:
findByActionId%3BActionId%3D{ActionId}
The list of values for action reasons. - finder:
- actionsLOV
-
Operation: /hcmRestApi/resources/11.13.18.05/actionsLOVThe list of values for actions.
- allReports
-
Parameters:
- PeriodOfServiceId:
$request.path.PeriodOfServiceId
- assignmentsUniqID:
$request.path.assignmentsUniqID
- workersUniqID:
$request.path.workersUniqID
The allReports resource is a child of the assignments resource. It provides all the reports of a worker as of the specified date. By default, the current date is retained. - PeriodOfServiceId:
- assignmentCategoriesLOV
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupType%3DEMP_CAT%2CLegislationCode%3D{LegislationCode}%2CLookupCode%3D{AssignmentCategory}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- assignmentStatusTypeCodesLOV
-
The list of values for assignment status types.
- assignmentsDDF
-
Parameters:
- PeriodOfServiceId:
$request.path.PeriodOfServiceId
- assignmentsUniqID:
$request.path.assignmentsUniqID
- workersUniqID:
$request.path.workersUniqID
- PeriodOfServiceId:
- assignmentsDFF
-
Parameters:
- PeriodOfServiceId:
$request.path.PeriodOfServiceId
- assignmentsUniqID:
$request.path.assignmentsUniqID
- workersUniqID:
$request.path.workersUniqID
- PeriodOfServiceId:
- assignmentsEFF
-
Parameters:
- PeriodOfServiceId:
$request.path.PeriodOfServiceId
- assignmentsUniqID:
$request.path.assignmentsUniqID
- workersUniqID:
$request.path.workersUniqID
- PeriodOfServiceId:
- bargainingUnitCodesLOV
-
The list of values for bargaining units.
- businessUnitNamesLOV
-
The list of values for business units.
- collectiveAgreementNamesLOV
-
The list of values for collective agreements.
- contractsLOV
-
Parameters:
- finder:
findByPeriodOfServiceId%3BPeriodOfServiceId%3D{PeriodOfServiceId}
The list of values for contracts. - finder:
- departmentNamesLOV
-
The list of values for departments.
- endAssignment
-
Parameters:
- PeriodOfServiceId:
$request.path.PeriodOfServiceId
- assignmentsUniqID:
$request.path.assignmentsUniqID
- workersUniqID:
$request.path.workersUniqID
Ends an assignment of a worker. - PeriodOfServiceId:
- expenseCheckSendToAddressLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DPER_WORKER_ADDRESS_TYPE%2CLookupCode%3D{ExpenseCheckSendToAddress}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- frequencyLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DFREQUENCY%2CLookupCode%3D{Frequency}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- fullPartTimeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DPART_FULL_TIME%2CLookupCode%3D{FullPartTime}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- gradeCodesLOV
-
Operation: /hcmRestApi/resources/11.13.18.05/gradesLovThe list of values for grades.
- gradeLadderNamesLOV
-
The list of values for grade ladders.
- gradeSteps
-
Parameters:
- PeriodOfServiceId:
$request.path.PeriodOfServiceId
- assignmentsUniqID:
$request.path.assignmentsUniqID
- workersUniqID:
$request.path.workersUniqID
The gradeSteps resource is a child of the assignments resource. It provides all the assignment grade steps of a worker as of the specified date. By default, the current date is retained. - PeriodOfServiceId:
- hourlySalariedCodesLOV
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupType%3DHOURLY_SALARIED_CODE%2CLegislationCode%3D{LegislationCode}%2CLookupCode%3D{HourlySalariedCode}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- jobCodesLOV
-
Operation: /hcmRestApi/resources/11.13.18.05/jobsLovThe list of values for jobs.
- locationCodesLOV
-
The list of values for locations.
- managers
-
Parameters:
- PeriodOfServiceId:
$request.path.PeriodOfServiceId
- assignmentsUniqID:
$request.path.assignmentsUniqID
- workersUniqID:
$request.path.workersUniqID
The managers resource is a child of the assignments resource. It provides all the assignment managers of a worker as of the specified date. By default, the current date is retained. - PeriodOfServiceId:
- permanentTemporaryLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DREGULAR_TEMPORARY%2CLookupCode%3D{PermanentTemporary}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- positionCodesLOV
-
The list of values for positions.
- probationPeriodUnitsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DQUALIFYING_UNITS%2CLookupCode%3D{ProbationPeriodUnit}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- proposedUserPersonTypesLOV
-
The list of values for person types.
- reportingEstablishmentNamesLOV
-
The list of values for reporting establishments.
- representatives
-
Parameters:
- PeriodOfServiceId:
$request.path.PeriodOfServiceId
- assignmentsUniqID:
$request.path.assignmentsUniqID
- workersUniqID:
$request.path.workersUniqID
The representatives resource is a child of the assignments resource. It provides all the representatives of a worker as of the specified date. By default, the current date is retained. - PeriodOfServiceId:
- seniorityBasisLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_PER_SENIORITY_CALC_BASIS%2CLookupCode%3D{SeniorityBasis}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- unionNamesLOV
-
Operation: /hcmRestApi/resources/11.13.18.05/unionsLovThe list of values for worker unions.
- userPersonTypesLOV
-
The list of values for person types.
- workMeasures
-
Parameters:
- PeriodOfServiceId:
$request.path.PeriodOfServiceId
- assignmentsUniqID:
$request.path.assignmentsUniqID
- workersUniqID:
$request.path.workersUniqID
The workMeasures resource is a child of the assignments resource. It provides all the assignment work measures of a worker as of the specified date. By default, the current date is retained. - PeriodOfServiceId:
- workerCategoriesLOV
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupType%3DEMPLOYEE_CATG%2CLegislationCode%3D{LegislationCode}%2CLookupCode%3D{WorkerCategory}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
Examples
The following example shows how to create a worker assignment by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -H "Effective-Of:RangeStartDate=2017-01-01" -X POST -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED00057708000110F086BB19F10000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001627E80E80078/child/workRelationships/300100215314932/child/assignments"
Example of Payload
The following is an example of the payload.
{ "ActionCode": "HIRE", "BusinessUnitId": 300100037658074 }
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 201 Created Content-Type : application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "AssignmentId": 300100215315683, "AssignmentNumber": "E960000000000897-2", "AssignmentName": "E960000000000897-2", "ActionCode": "HIRE", "ReasonCode": null, "EffectiveStartDate": "2017-01-01", "EffectiveEndDate": "4712-12-31", "EffectiveSequence": 1, "EffectiveLatestChange": "Y", "BusinessUnitId": 300100037658074, "BusinessUnitName": "AUTO_GHR_BUSINESS UNIT01", "AssignmentType": "E", "AssignmentStatusTypeId": 100010026278977, "AssignmentStatusTypeCode": "ACTIVE_PROCESS", "AssignmentStatusType": "ACTIVE", "SystemPersonType": "EMP", "UserPersonTypeId": 100010025072012, "UserPersonType": "Employee", "ProposedUserPersonTypeId": null, "ProposedUserPersonType": null, "ProjectedStartDate": null, "ProjectedEndDate": null, "PrimaryFlag": false, "PrimaryAssignmentFlag": false, "PositionId": null, "PositionCode": null, "SynchronizeFromPositionFlag": false, "JobId": null, "JobCode": null, "GradeId": null, "GradeCode": null, "GradeLadderId": null, "GradeLadderName": null, "GradeStepEligibilityFlag": true, "GradeCeilingStepId": null, "GradeCeilingStep": null, "DepartmentId": null, "DepartmentName": null, "ReportingEstablishmentId": null, "ReportingEstablishmentName": null, "LocationId": null, "LocationCode": null, "WorkAtHomeFlag": false, "AssignmentCategory": null, "WorkerCategory": null, "PermanentTemporary": null, "FullPartTime": null, "ManagerFlag": false, "HourlySalariedCode": null, "NormalHours": null, "Frequency": null, "StartTime": null, "EndTime": null, "SeniorityBasis": "ORA_PER_SNDT_DAYS", "ProbationPeriod": null, "ProbationPeriodUnit": null, "ProbationEndDate": null, "NoticePeriod": null, "NoticePeriodUOM": null, "WorkTaxAddressId": null, "ExpenseCheckSendToAddress": null, "RetirementAge": null, "RetirementDate": null, "LabourUnionMemberFlag": null, "UnionId": null, "UnionName": null, "BargainingUnitCode": null, "CollectiveAgreementId": null, "CollectiveAgreementName": null, "InternalBuilding": null, "InternalFloor": null, "InternalOfficeNumber": null, "InternalMailstop": null, "DefaultExpenseAccount": null, "PeopleGroup": null, "CreatedBy": "VMOSS", "CreationDate": "2019-04-23T11:14:39.001+00:00", "LastUpdatedBy": "VMOSS", "LastUpdateDate": "2019-04-23T11:14:43.415+00:00", "links": [ {... } ] }