Jump to

• Request
• Response

Delete a message design metadata

patch

/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}

Request

Path Parameters

• MessageDesignId(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=

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DesignEditorTypeCode: string
  Maximum Length: 30

  Default Value: ORA_ADVANCED

  Editor type used for creating a message template.
• DesignName: string
  Maximum Length: 240

  Name of the Message Design.
• DesignStatusCode: string
  Maximum Length: 30

  Code for the design status for each message design.
• DesignTypeCode: string
  Maximum Length: 30

  Code assigned to the design type for message designs.
• MessageDesignCode: string
  Maximum Length: 32

  Message design code.
• messageDesignMetadata: array Message Design Metadata
  Title: Message Design Metadata

  The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.
• messageDesignTypes: array Message DesignTypes
  Title: Message DesignTypes

  The resource messageDesignTypes is to get different types of message designs.
• ModuleId: string
  Maximum Length: 32

  Module ID for the message designs.
• TemplateDescription: string
  Maximum Length: 240

  Description of the template.

{
    "type":"object",
    "properties":{
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Module ID for the message designs.",
            "nullable":true
        },
        "DesignStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the design status for each message design.",
            "nullable":true
        },
        "DesignName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the Message Design.",
            "nullable":false
        },
        "messageDesignTypes":{
            "title":"Message DesignTypes",
            "type":"array",
            "description":"The resource messageDesignTypes is to get different types of message designs.",
            "items":{
                "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignTypes-item-patch-request"
            }
        },
        "DesignEditorTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Editor type used for creating a message template.",
            "nullable":true,
            "default":"ORA_ADVANCED"
        },
        "messageDesignMetadata":{
            "title":"Message Design Metadata",
            "type":"array",
            "description":"The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.",
            "items":{
                "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignMetadata-item-patch-request"
            }
        },
        "DesignTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code assigned to the design type for message designs.",
            "nullable":false
        },
        "MessageDesignCode":{
            "maxLength":32,
            "type":"string",
            "description":"Message design code.",
            "nullable":false
        },
        "TemplateDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the template.",
            "nullable":true
        }
    }
}

Nested Schema : Message Design Metadata

Type: array

Title: Message Design Metadata

The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.

Show Source

• Array of: object schema

{
    "title":"Message Design Metadata",
    "type":"array",
    "description":"The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.",
    "items":{
        "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignMetadata-item-patch-request"
    }
}

Nested Schema : Message DesignTypes

Type: array

Title: Message DesignTypes

The resource messageDesignTypes is to get different types of message designs.

Show Source

• Array of: object schema

{
    "title":"Message DesignTypes",
    "type":"array",
    "description":"The resource messageDesignTypes is to get different types of message designs.",
    "items":{
        "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignTypes-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• DefaultLanguageFlag: boolean
  Maximum Length: 1

  DefaultLanguageFlag for the message design metadata.
• Description: string (byte)
  Description of the message design metadata.
• DesignMetadata: string (byte)
  DesignMetadata for the message design metadata.
• HTMLTemplate: string (byte)
  Html Template for the message design metadata.
• ImageURL: string
  Maximum Length: 1000

  Message design image link.
• MessageDesignId: integer (int64)
  MessageDesignId for each message design metadata.
• MessageLanguage: string
  Maximum Length: 4

  MessageLanguage for each message design metadata.
• Subject: string
  Maximum Length: 1000

  Subject for each message design metadata.

{
    "type":"object",
    "properties":{
        "Description":{
            "type":"string",
            "description":"Description of the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DefaultLanguageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"DefaultLanguageFlag for the message design metadata.",
            "nullable":true
        },
        "MessageLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"MessageLanguage for each message design metadata.",
            "nullable":false
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"MessageDesignId for each message design metadata.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ImageURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Message design image link.",
            "nullable":true
        },
        "HTMLTemplate":{
            "type":"string",
            "description":"Html Template for the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DesignMetadata":{
            "type":"string",
            "description":"DesignMetadata for the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Subject":{
            "maxLength":1000,
            "type":"string",
            "description":"Subject for each message design metadata.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• TypeCode: string
  Maximum Length: 30

  TypeCode for the message design types.

{
    "type":"object",
    "properties":{
        "TypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"TypeCode for the message design types.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : recruitingMessageDesigns-item-response

Type: object

Show Source

• DesignEditorTypeCode: string
  Maximum Length: 30

  Default Value: ORA_ADVANCED

  Editor type used for creating a message template.
• DesignName: string
  Maximum Length: 240

  Name of the Message Design.
• DesignStatusCode: string
  Maximum Length: 30

  Code for the design status for each message design.
• DesignTypeCode: string
  Maximum Length: 30

  Code assigned to the design type for message designs.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date of last update for the message designs.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageDesignCode: string
  Maximum Length: 32

  Message design code.
• MessageDesignId: integer (int64)
  Unique code for message designs.
• messageDesignMetadata: array Message Design Metadata
  Title: Message Design Metadata

  The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.
• messageDesignTypes: array Message DesignTypes
  Title: Message DesignTypes

  The resource messageDesignTypes is to get different types of message designs.
• ModuleId: string
  Maximum Length: 32

  Module ID for the message designs.
• TemplateDescription: string
  Maximum Length: 240

  Description of the template.

{
    "type":"object",
    "properties":{
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Module ID for the message designs.",
            "nullable":true,
            "x-queryable":true
        },
        "DesignStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the design status for each message design.",
            "nullable":true,
            "x-queryable":true
        },
        "DesignName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the Message Design.",
            "nullable":false,
            "x-queryable":true
        },
        "messageDesignTypes":{
            "title":"Message DesignTypes",
            "type":"array",
            "description":"The resource messageDesignTypes is to get different types of message designs.",
            "items":{
                "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignTypes-item-response"
            }
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"Unique code for message designs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DesignEditorTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Editor type used for creating a message template.",
            "nullable":true,
            "default":"ORA_ADVANCED",
            "x-queryable":true
        },
        "messageDesignMetadata":{
            "title":"Message Design Metadata",
            "type":"array",
            "description":"The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.",
            "items":{
                "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignMetadata-item-response"
            }
        },
        "DesignTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code assigned to the design type for message designs.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MessageDesignCode":{
            "maxLength":32,
            "type":"string",
            "description":"Message design code.",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the template.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date of last update for the message designs.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Message Design Metadata

Type: array

Title: Message Design Metadata

The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.

Show Source

• Array of: object recruitingMessageDesigns-messageDesignMetadata-item-response

{
    "title":"Message Design Metadata",
    "type":"array",
    "description":"The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.",
    "items":{
        "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignMetadata-item-response"
    }
}

Nested Schema : Message DesignTypes

Type: array

Title: Message DesignTypes

The resource messageDesignTypes is to get different types of message designs.

Show Source

• Array of: object recruitingMessageDesigns-messageDesignTypes-item-response

{
    "title":"Message DesignTypes",
    "type":"array",
    "description":"The resource messageDesignTypes is to get different types of message designs.",
    "items":{
        "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignTypes-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : recruitingMessageDesigns-messageDesignMetadata-item-response

Type: object

Show Source

• DefaultLanguageFlag: boolean
  Maximum Length: 1

  DefaultLanguageFlag for the message design metadata.
• Description: string (byte)
  Description of the message design metadata.
• DescriptionString: string
  Read Only: true

  Message design description string.
• DesignMetadata: string (byte)
  DesignMetadata for the message design metadata.
• DesignMetaDataString: string
  Read Only: true

  DesignMetaDataString for each message design metadata.
• HTMLTemplate: string (byte)
  Html Template for the message design metadata.
• HTMLTemplateString: string
  Read Only: true

  HTMLTemplateString for each message design metadata.
• ImageURL: string
  Maximum Length: 1000

  Message design image link.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageDesignId: integer (int64)
  MessageDesignId for each message design metadata.
• MessageLanguage: string
  Maximum Length: 4

  MessageLanguage for each message design metadata.
• Subject: string
  Maximum Length: 1000

  Subject for each message design metadata.

{
    "type":"object",
    "properties":{
        "DesignMetaDataString":{
            "type":"string",
            "description":"DesignMetaDataString for each message design metadata.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DesignMetadata"
                ]
            },
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "HTMLTemplateString":{
            "type":"string",
            "description":"HTMLTemplateString for each message design metadata.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "HTMLTemplate"
                ]
            },
            "x-queryable":true
        },
        "DefaultLanguageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"DefaultLanguageFlag for the message design metadata.",
            "nullable":true,
            "x-queryable":true
        },
        "DescriptionString":{
            "type":"string",
            "description":"Message design description string.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Description"
                ]
            },
            "x-queryable":true
        },
        "MessageLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"MessageLanguage for each message design metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"MessageDesignId for each message design metadata.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ImageURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Message design image link.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HTMLTemplate":{
            "type":"string",
            "description":"Html Template for the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DesignMetadata":{
            "type":"string",
            "description":"DesignMetadata for the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Subject":{
            "maxLength":1000,
            "type":"string",
            "description":"Subject for each message design metadata.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingMessageDesigns-messageDesignTypes-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Meaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of each message design types.
• TypeCode: string
  Maximum Length: 30

  TypeCode for the message design types.

{
    "type":"object",
    "properties":{
        "TypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"TypeCode for the message design types.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of each message design types.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

messageDesignMetadata

Operation: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata

Parameters:

• MessageDesignId: $request.path.MessageDesignId

The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.

messageDesignTypes

Operation: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes

Parameters:

• MessageDesignId: $request.path.MessageDesignId

The resource messageDesignTypes is to get different types of message designs.

Back to Top