Jump to

• Request
• Response

Update a status code

post

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEventDetails/action/updateStatusCode

Updates the status code of the employee event. This is used when the event transitions from one status to another.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

• eventNumber: string
  Event number to be passed when updating event's status code.
• statusCode: string
  Status code to be used when updating an event's status code.

{
    "type":"object",
    "properties":{
        "eventNumber":{
            "type":"string",
            "description":"Event number to be passed when updating event's status code.",
            "nullable":true
        },
        "statusCode":{
            "type":"string",
            "description":"Status code to be used when updating an event's status code.",
            "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): object result
  Additional Properties Allowed: additionalProperties

  Response returned when update event's status code is invoked.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Response returned when update event's status code is invoked."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Response returned when update event's status code is invoked."
}

Response returned when update event's status code is invoked.

Back to Top