Jump to

• Request
• Response

Update template status

post

/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/action/updateTemplateStatus

Updates the status of a message template in the recruiting message designs. This action changes the template status based on the provided input parameters.

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

• messageDesignId: number
  Unique identifier for the message design.
• status: string
  Status of the message template. Indicates whether the template is active or inactive. Valid values are Active and Inactive.

{
    "type":"object",
    "properties":{
        "messageDesignId":{
            "type":"number",
            "description":"Unique identifier for the message design.",
            "nullable":true
        },
        "status":{
            "type":"string",
            "description":"Status of the message template. Indicates whether the template is active or inactive. Valid values are Active and Inactive.",
            "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

  Return value indicating the status of the template update operation.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Return value indicating the status of the template update operation."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Return value indicating the status of the template update operation."
}

Return value indicating the status of the template update operation.

Back to Top