REST API for Oracle Fusion Cloud HCM

Update Assignment Flexfields

Note:

A PATCH operation on descriptive and developer flexfields must be performed from the singular parent resource. For example, to correct or update the assignment DFF, perform the operation from the parent assignment ID self link, and not the child DFF self link.

Correct an Assignment DFF

Let's say that when Daniel Rodgers was hired, his DFFs were entered incorrectly. You need to patch the DFFs to correct them.

To correct the assignment DFFs:

Retrieve (GET) the work relationship details and obtain the parent assignment ID self link.
Perform a PATCH operation on this URL by providing the assignment DFFs in the request body.

Example URL

Use this resource URL format.

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

Example Request

Here's an example of the request body in JSON format.

Provide the headers.

Content-Type : application/vnd.oracle.adf.resourceitem+json
REST-Framework-Version : 4
effective-Of : RangeMode=CORRECTION;RangeStartDate=2019-06-15;RangeEndDate=4712-12-31

{
"assignmentsDFF":[{
"asgNum": 13,
"asgChar": "N"
}]
}

Example Response

Here's an example of the response body in JSON format.

{
    "AssignmentId": 300100180235425,
    "AssignmentNumber": "E955160008191566",
    "AssignmentName": "E955160008191566",
    "ActionCode": "HIRE_ADD_WORK_RELATION",
    "ReasonCode": null,
    "EffectiveStartDate": "2019-06-15",
    "EffectiveEndDate": "4712-12-31",
    "EffectiveSequence": 1,
    "EffectiveLatestChange": "Y",
    "BusinessUnitId": 300100024264603,
    "BusinessUnitName": "Vision Central",
    "AssignmentType": "E",
    "AssignmentStatusTypeId": 100010026278190,
    "AssignmentStatusTypeCode": "ACTIVE_PROCESS",
    "AssignmentStatusType": "ACTIVE",
    "SystemPersonType": "EMP",
    "UserPersonTypeId": 13,
    "UserPersonType": "Employee",
    "ProposedUserPersonTypeId": null,
    "ProposedUserPersonType": null,
    "ProjectedStartDate": null,
    "ProjectedEndDate": null,
    "PrimaryFlag": true,
    "PrimaryAssignmentFlag": true,
    "PositionId": null,
    "PositionCode": null,
    "SynchronizeFromPositionFlag": true,
    "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": 300100006480525,
    "LocationCode": "PMBUTTECA",
    "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,
    "ContractId": null,
    "ContractNumber": null,
    "InternalBuilding": null,
    "InternalFloor": null,
    "InternalOfficeNumber": null,
    "InternalMailstop": null,
    "DefaultExpenseAccount": null,
    "PeopleGroup": null,
    "CreatedBy": "HCM_INTEGRATION_SPEC",
    "CreationDate": "2019-06-20T20:41:44.629+00:00",
    "LastUpdatedBy": "HCM_INTEGRATION_SPEC",
    "LastUpdateDate": "2019-06-20T20:52:06.048+00:00",
    "assignmentsDFF": {
        "items": [
            {
                "AssignmentId": 300100180235425,
                "EffectiveStartDate": "2019-06-15",
                "EffectiveEndDate": "4712-12-31",
                "EffectiveSequence": 1,
                "EffectiveLatestChange": "Y",
                "AssignmentType": "E",
                "_asg_global": null,
                "FBLAG": null,
                "hdlG": null,
                "fblg1": null,
                "fblg2": null,
                "fblg3": null,
                "fblg4": null,
                "fblg5": null,
                "synchGlbNum": null,
                "synchGlbChar": null,
                "asgNum": 13,
                "asgChar": "N",
                "autoAsgNum": null,
                "autoAsgChar": null,
                "flexaut1": null,
                "__FLEX_Context": null,
                "__FLEX_Context_DisplayValue": null,
                "links": [...]
            }
        ],
        "count": 1,
        "hasMore": false,
        "limit": 24,
        "offset": 0,
        "links": [...]
    },
    "links": [...]
}

Update an Assignment DFF

Daniel's asgNum and asgChar have changed with his promotion. His DFFs have to be modified to reflect this change.

To update the assignment DFFs:

Retrieve (GET) the work relationship details and obtain the parent assignment ID self link.
Perform a PATCH operation on this URL by providing the assignment DFFs in the request body.