Get an assignment
get
/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 Employees resource and used to uniquely identify an instance of Employees. The client should not generate the hash key value. Instead, the client should query on the Employees collection resource in order to navigate to a specific instance of Employees to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : emps-assignments-item-response
Type:
Show Source
object
-
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
-
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
-
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
empreps
-
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
-
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
-
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 generated 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 is used for taxation purposes. This can be different from a mailing address. Valid values are defined in the list WorkTaxAddressIdLOV.
Nested Schema : assignmentExtraInformation
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-assignments-assignmentDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield for assignment. Valid values are defined in the list LVVO___FLEX_Context. -
__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
Descriptive flexfield for assignment. -
EffectiveLatestChange: string
Title:
Effective Latest Change
Maximum Length:30
Descriptive flexfield for assignment. -
EffectiveSequence: integer
(int32)
Title:
Effective Sequence
Descriptive flexfield for assignment. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Descriptive flexfield for assignment. -
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 : 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: 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 : workers-workRelationships-assignments-assignmentsEFF-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 : emps-assignments-empreps-item-response
Type:
Show Source
object
-
AsgResponsibilityId: integer
(int64)
Read Only:
true
-
AssignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Read Only:
true
-
ResponsibilityName: string
Read Only:
true
Maximum Length:240
-
ResponsibilityTypeCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
-
ResponsibilityTypeName: string
Title:
Meaning
Read Only:true
Maximum Length:80
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : emps-assignments-peopleGroupKeyFlexfield-item-response
Type:
Show Source
object
-
_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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AssignmentStatusTypeIdLOV
-
The assignmentStatusTypesLov resource provides the list of values for the assignment status types.
- SalaryBasisIdLOV
-
A list of salary bases available for workers. A salary basis identifies the currency and period of the quoted base pay and the factor used to annualize base pay. It optionally identifies components used to itemize salary adjustments as well as the grade rate and differential profile used to validate salary.
- assignmentDFF
-
Parameters:
- assignmentsUniqID:
$request.path.assignmentsUniqID
- empsUniqID:
$request.path.empsUniqID
The assignmentDFF resource is a child of the assignments resource. It includes all employee assignment key flexfields as of the specified date. By default, the current date is retained. This resource is currently under controlled availability. - assignmentsUniqID:
- assignmentExtraInformation
-
Parameters:
- assignmentsUniqID:
$request.path.assignmentsUniqID
- empsUniqID:
$request.path.empsUniqID
The assignmentExtraInformation resource is a child of the emps resource. It includes all the extensible flexfields for additional assignment information as of the specified date. By default, the current date is retained. This resource is currently under controlled availability. - assignmentsUniqID:
- 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. - assignmentsUniqID:
- peopleGroupKeyFlexfield
-
Parameters:
- assignmentsUniqID:
$request.path.assignmentsUniqID
- empsUniqID:
$request.path.empsUniqID
The peopleGroupKeyFlexfield resource is a child of the assignments resource. It includes all employee assignment key flexfields as of the specified date. By default, the current date is retained. This resource is currently under controlled availability. - assignmentsUniqID:
Examples
The following example shows how to retrieve an employee assignment by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password> -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/emps/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000014349EB6440780000000EACED00057708000110F07EBB2F8D/child/assignments/00040000000EACED00057708000110F07EBB2FA90000000EACED0005770800000000000001850000000EACED00057708000000000000017F0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000014349EB644078
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":"Asg1DEFLG1457526107137", "PersonTypeId":13, "BusinessUnitId":202, "LocationId":null, "JobId":null, "GradeId":null, "DepartmentId":null, "WorkerCategory":"WC", "AssignmentCategory":"FR", "WorkingAtHome":"N", "WorkingAsManager":"N", "SalaryCode":"H", "WorkingHours":12, "Frequency":"D", "StartTime":"08:00", "EndTime":"17:00", "SalaryAmount":100000, "SalaryBasisId":100010024999994, "ActionCode":"HIRE", "ActionReasonCode":"NEWHIRE", "AssignmentStatus":"ACTIVE", "WorkTaxAddressId":300100011952957, "AssignmentId":300100081102761, "EffectiveStartDate":"2014-01-01", "EffectiveEndDate":"4712-12-31", "PositionId":null, "TermsEffectiveStartDate":"2014-01-01","ManagerAssignmentId":389, "ManagerId":383, "ManagerType":"LINE_MANAGER", "AssignmentNumber":"E955160008236639", "PeriodOfServiceId":300100081102753, "OriginalHireDate":null, "PrimaryAssignmentFlag":"Y", "ProbationPeriodEndDate":null, "ProbationPeriodLength":null, "ProbationPeriodUnitOfMeasure":null, "AssignmentProjectedEndDate":null, "ActualTerminationDate":null, "LegalEntityId":300100003448002, "PrimaryWorkRelationFlag":"Y", "PrimaryWorkTermsFlag":"N", "CreationDate":"2016-03-09 17:52:22.453", "LastUpdateDate":"2016-03-09 17:52:41.726", "links":[24] 0: {... ...} }