Update a worker assignment

patch

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}

Request

Path Parameters
  • 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=
  • This is the hash key of the attributes which make up the composite key--- AssignmentId, EffectiveStartDate, EffectiveEndDate, EffectiveSequence and EffectiveLatestChange ---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 with a filter on the primary key values in order to navigate to a specific instance of Assignments.

    For example: assignments?q=AssignmentId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>;EffectiveSequence=<value4>;EffectiveLatestChange=<value5>
  • 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
  • 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.
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "DE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-patch-request", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-patch-request", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-patch-request", "MX":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-patch-request", "ORA_HRX_ZA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-patch-request", "US":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-patch-request" } }
Nested Schema : assignmentsDFF
Type: array
Show Source
Nested Schema : assignmentsEFF
Type: array
Show Source
  • Discriminator: CategoryCode
    Discriminator: { "propertyName":"CategoryCode", "mapping":{ "PER_ASG_EIT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-patch-request" } }
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-patch-request
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
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-patch-request
Type: object
Show Source
Nested Schema : InformationORA_5FPER_5FRET_5FGRADEprivateVO
Type: array
Show Source
Nested Schema : workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • 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.
  • Title: Effective End Date
    End date of the date-effective changes to the record.
  • Title: Effective Start Date
    Start date of the date-effective changes to the record.
  • Title: Assignment ID
    Surrogate identifier for the assignment supervisor.
  • Title: Assignment Number
    Maximum Length: 30
    Assignment number of the supervisor.
  • 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.
  • Title: Reason Code
    Maximum Length: 80
    Reason for the change. Valid values are defined in the actionReasonsLOV.
Nested Schema : workers-workRelationships-assignments-representatives-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : workers-workRelationships-assignments-item-response
Type: object
Show Source
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: array
Show Source
  • 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", "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 : assignmentsDFF
Type: array
Show Source
Nested Schema : assignmentsEFF
Type: array
Show Source
  • 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 : 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: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-assignmentsDFF-item-response
Type: object
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: object
Show Source
Nested Schema : InformationORA_5FPER_5FRET_5FGRADEprivateVO
Type: array
Show Source
Nested Schema : workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-gradeSteps-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-managers-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-representatives-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-workMeasures-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to update a worker assignment by submitting a PATCH request on the REST resource using cURL.

Correction

For a correction operation:
  • RangeMode , RangeStartDate, and RangeEndDate are required parameters.
  • RangeStartDate the same as the EffectiveStartDate of the record.
  • RangeEndDate must be the same as the EffectiveEndDate of the record.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -H "Effective-Of:RangeMode=CORRECTION;RangeStartDate=2019-05-01;RangeEndDate=2019-05-15" -X PATCH -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED00057708000110F086BB19F10000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001627E80E80078/child/workRelationships/300100215314932/child/assignments/00020000000EACED00057708000110F086BB19FB0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001627E80E80078"
 

Example of Payload

The following is an example of the payload.

{
  "InternalFloor": "4B",
 }

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
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": 300100215314939,
    "AssignmentNumber": "E960000000000897",
    "AssignmentName": "E960000000000897",
    "ActionCode": "HIRE",
    "ReasonCode": null,
    "EffectiveStartDate": "2019-05-01",
    "EffectiveEndDate": "2019-05-15",
    "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": true,
    "PrimaryAssignmentFlag": true,
    "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": "3B",
    "InternalOfficeNumber": null,
    "InternalMailstop": null,
    "DefaultExpenseAccount": null,
    "PeopleGroup": null,
    "CreatedBy": "VMOSS",
    "CreationDate": "2019-04-23T10:02:06.771+00:00",
    "LastUpdatedBy": "VMOSS",
    "LastUpdateDate": "2019-04-23T11:20:22.526+00:00",
    "links": [
        {...
          }
   ]
}

Update

For an update operation:
  • RangeMode, RangeStartDate, and RangeEndDate are required parameters.
  • RangeStartDate must be between EffectiveStartDate and EffectiveEndDate of the record.
  • RangeEndDate must be the same as the EffectiveEndDate of the record.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -H "Effective-Of:RangeMode=UPDATE;RangeStartDate=2018-04-01;RangeEndDate=4712-12-31" -X PATCH -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED00057708000110F086BB19F10000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001627E80E80078/child/workRelationships/300100215314932/child/assignments/00020000000EACED00057708000110F086BB19FB0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001627E80E80078"

Example of Payload

The following is an example of the payload.

{
  "InternalFloor": "3B",
  "ActionCode":"JOB_CHANGE"
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
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": 300100215314939,
    "AssignmentNumber": "E960000000000897",
    "AssignmentName": "E960000000000897",
    "ActionCode": "HIRE",
    "ReasonCode": null,
    "EffectiveStartDate": "2018-04-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": true,
    "PrimaryAssignmentFlag": true,
    "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": "3B",
    "InternalOfficeNumber": null,
    "InternalMailstop": null,
    "DefaultExpenseAccount": null,
    "PeopleGroup": null,
    "CreatedBy": "VMOSS",
    "CreationDate": "2019-04-23T10:02:06.771+00:00",
    "LastUpdatedBy": "VMOSS",
    "LastUpdateDate": "2019-04-23T11:20:22.526+00:00",
    "links": [
        {...
           }
   ]
}
Back to Top