Jump to

• Request
• Response
• Examples

Update a tax reporting unit

post

/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/action/updateTRU

Updates the tax reporting unit for a payroll assignment such that the card associations get generated.

Request

Path Parameters

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

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• truId: string
  Unique identifier for the tax reporting unit.

{
    "type":"object",
    "properties":{
        "truId":{
            "type":"string",
            "description":"Unique identifier for the tax reporting unit.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): boolean
  Internal identifier that indicates the success status of the custom method.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"boolean",
            "description":"Internal identifier that indicates the success status of the custom method."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example shows how to update a tax reporting unit for a payroll assignment by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -H "REST-Framework-Version: 4" -X POST -d payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/payrollRelationships/00020000000EACED00057708000110F085BDE8A30000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000169368CF00078/child/payrollAssignments/00040000000EACED00057708000110F085BDE8A80000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000151FA7BDC00780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F085BDE8A8/action/updateTRU"

Example of Request

The following is an example of the request payload.

{"truId": "300100126008594"}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK                     
Content-Type : application/vnd.oracle.adf.actionresult+json

Example of Response Body

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

{
  	"result": "true"
}

Back to Top