Jump to

• Request
• Response
• Examples

Change the legal employer or create a temporary assignment

post

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/changeLegalEmployer

Changes the legal employer of a worker or creates a global temporary assignment for a worker.

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

• 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

• actionCode: string
  Action being performed for this assignment, such as Global Transfer. Valid values are defined in the actionsLOV.
• businessTitle: string
  Business title of the worker assignment.
• businessUnitId: number
  Unique identifier for the business unit of the assignment.
• businessUnitName: string
  Name of the business unit for the worker assignment. Valid values are defined in the hcmBusinesUnitsLOV.
• contractNumber: string
  Number of the contract.
• contractType: string
  Type of the contract.
• copyAssignmentEFFFlag: boolean
  Indicates whether the assignment extensible flexfield attributes should be copied from the source assignment.
• copyAssignmentFlag: boolean
  Indicates whether the assignment attributes should be copied from the source assignment.
• createPrimaryWorkRelationshipFlag: boolean
  Indicate whether the new work relationship should be primary.
• duration: number
  Duration of the contract.
• durationUnits: string
  Unit for the duration of the contract.
• effectiveDate: string (date)
  Start date of the date-effective changes to the record.
• legalEmployerName: string
  Name of the legal employer for the work relationship.
• legalEntityId: number
  Unique identifier for the legal entity of the work relationship.
• reasonCode: string
  Reason for the action being performed on the record. Valid values are defined in the actionReasonsLOV.
• sourceAssignmentId: number
  Unique identifier for the source assignment.
• sourceAssignmentNumber: string
  Number of the source assignment.

{
    "type":"object",
    "properties":{
        "businessUnitName":{
            "type":"string",
            "description":"Name of the business unit for the worker assignment. Valid values are defined in the hcmBusinesUnitsLOV.",
            "nullable":true
        },
        "createPrimaryWorkRelationshipFlag":{
            "type":"boolean",
            "description":"Indicate whether the new work relationship should be primary.",
            "nullable":true
        },
        "contractType":{
            "type":"string",
            "description":"Type of the contract.",
            "nullable":true
        },
        "sourceAssignmentNumber":{
            "type":"string",
            "description":"Number of the source assignment.",
            "nullable":true
        },
        "contractNumber":{
            "type":"string",
            "description":"Number of the contract.",
            "nullable":true
        },
        "durationUnits":{
            "type":"string",
            "description":"Unit for the duration of the contract.",
            "nullable":true
        },
        "businessUnitId":{
            "type":"number",
            "description":"Unique identifier for the business unit of the assignment.",
            "nullable":true
        },
        "copyAssignmentFlag":{
            "type":"boolean",
            "description":"Indicates whether the assignment attributes should be copied from the source assignment.",
            "nullable":true
        },
        "duration":{
            "type":"number",
            "description":"Duration of the contract.",
            "nullable":true
        },
        "legalEntityId":{
            "type":"number",
            "description":"Unique identifier for the legal entity of the work relationship.",
            "nullable":true
        },
        "sourceAssignmentId":{
            "type":"number",
            "description":"Unique identifier for the source assignment.",
            "nullable":true
        },
        "legalEmployerName":{
            "type":"string",
            "description":"Name of the legal employer for the work relationship.",
            "nullable":true
        },
        "businessTitle":{
            "type":"string",
            "description":"Business title of the worker assignment.",
            "nullable":true
        },
        "actionCode":{
            "type":"string",
            "description":"Action being performed for this assignment, such as Global Transfer. Valid values are defined in the actionsLOV.",
            "nullable":true
        },
        "copyAssignmentEFFFlag":{
            "type":"boolean",
            "description":"Indicates whether the assignment extensible flexfield attributes should be copied from the source assignment.",
            "nullable":true
        },
        "reasonCode":{
            "type":"string",
            "description":"Reason for the action being performed on the record. Valid values are defined in the actionReasonsLOV.",
            "nullable":true
        },
        "effectiveDate":{
            "type":"string",
            "description":"Start date of the date-effective changes to the record.",
            "format":"date",
            "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): string
  Internal identifier that indicates the success status of the custom method.

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

Back to Top

Examples

Permanent Change

The following examples shows how to change the legal employer for a worker 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/workers/00020000000EACED00057708000110F086BB19F10000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001627E80E80078/child/workRelationships/300100215314932/action/changeLegalEmployer"

Example of Payload

The following is an example of the payload.

{
  "actionCode":"GLB_TRANSFER" ,
  "effectiveDate":"2018-10-25" ,
  "legalEmployerName":"Vision City LE" ,
  "businessUnitName":"Vision Central"
}

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.actionresult+json

Example of Response Body

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

{
	"assignmentNumber":"300100215314939"
}

Temporary Change

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/workers/00020000000EACED00057708000110F086BB19F10000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001627E80E80078/child/workRelationships/300100215314932/action/changeLegalEmployer"

Example of Payload

The following is an example of the payload.

{
  "actionCode":"GLB_TEMP_TRANSFER" ,
  "effectiveDate":"2018-10-25" ,
  "legalEmployerName":"Vision City LE" ,
  "businessUnitName":"Vision Central"
}

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.action+json

Example of Payload

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

{
	"assignmentNumber":"300100215314939"
}

Back to Top