Jump to

• Request
• Response

Update a communication template

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationTemplates/{TemplateId}

Request

Supported Media Types

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

Path Parameters

• TemplateId: integer
  The unique identifier of the communication template. This ID is generated automatically by the application.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorCommunicationTemplates-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the communication template.
• AlertEnd(optional): string(date-time)
  Title: Alert End Date

  The last date that an alert appears.
• AlertStart(optional): string(date-time)
  Title: Alert Start Date

  The first date that an alert appears.
• AttachmentKeyReference(optional): string
  Title: Attachment Key Reference

  Maximum Length: 256

  The attachment key references.
• AttachmentsEnabled(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether attachments are enabled for the communication template.
• BccEmailAddress(optional): string
  Title: Bcc Email Address

  The blind copied recipient addresses for email communications.
• Body(optional): string
  Title: Message Body

  The communication message body text.
• CcEmailAddress(optional): string
  Title: Cc Email Address

  The copied recipient addresses for email communications.
• ChannelType(optional): string
  Title: Channel Type

  Maximum Length: 30

  The communication message channel type.
• ChannelTypeMeaning(optional): string
  Title: Channel Type

  Maximum Length: 80

  The channel type for the communication template.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments entered by the user.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the communication template.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time that the communication template was created.
• DefaultLanguage(optional): string
  Title: Default Language

  Maximum Length: 4

  The default language for the communication template.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the communication template is available to be used. The default value is false.
• EventId(optional): integer(int64)
  Title: Event ID

  The unique identifier for the communication event.
• FromAddress(optional): string
  Title: From Address

  Maximum Length: 256

  The sender of the communication message.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the communication template was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the communication template.
• links(optional): array Items
  Title: Items

  Link Relations
• MessageDeleteAllowed(optional): boolean
  Indicates whether the notifications generated by the template can be deleted from a user's notification list.
• MimeType(optional): string
  Title: MIME Type

  Maximum Length: 30

  The MIME type of communication message. The possible values are HTML and Text.
• MimeTypeMeaning(optional): string
  Title: Mime Type

  Maximum Length: 80

  The MIME type of the communication template. The possible values are HTML and Text.
• Priority(optional): string
  Title: Priority

  Maximum Length: 1

  The priority of the notification.
• ShortMessage(optional): string
  Title: Short Message

  Maximum Length: 500

  The short text message body.
• Subject(optional): string
  Title: Subject

  Maximum Length: 1000

  The subject of the communication message.
• TemplateCode(optional): string
  Title: Template Code

  Maximum Length: 32

  The unique code of the communication template.
• TemplateId(optional): integer(int64)
  Title: Template ID

  The unique identifier of the communication template. This ID is generated automatically by the application.
• TemplateName(optional): string
  Title: Template Name

  Maximum Length: 100

  The name of the communication template.
• ToEmailAddress(optional): string
  Title: To Email Address

  The primary recipient addresses for email communications.
• ToPhoneNumber(optional): string
  Title: To Phone Number

  The recipient phone number for text communications.
• ToUserid(optional): string
  Title: To User ID

  The recipient user ID for notifications.
• Visibility(optional): string
  Title: Visibility

  Maximum Length: 30

  Visibility option of the communication message generated by the template.
• VisibilityMeaning(optional): string
  Title: Visibility

  Maximum Length: 80

  Visibility option of the communication message generated by template.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication template.",
            "title":"Agency ID"
        },
        "AlertEnd":{
            "format":"date-time",
            "type":"string",
            "description":"The last date that an alert appears.",
            "title":"Alert End Date"
        },
        "AlertStart":{
            "format":"date-time",
            "type":"string",
            "description":"The first date that an alert appears.",
            "title":"Alert Start Date"
        },
        "AttachmentKeyReference":{
            "maxLength":256,
            "type":"string",
            "description":"The attachment key references.",
            "title":"Attachment Key Reference"
        },
        "AttachmentsEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether attachments are enabled for the communication template.",
            "title":"Enabled"
        },
        "BccEmailAddress":{
            "type":"string",
            "description":"The blind copied recipient addresses for email communications.",
            "title":"Bcc Email Address"
        },
        "Body":{
            "type":"string",
            "description":"The communication message body text.",
            "title":"Message Body"
        },
        "CcEmailAddress":{
            "type":"string",
            "description":"The copied recipient addresses for email communications.",
            "title":"Cc Email Address"
        },
        "ChannelType":{
            "maxLength":30,
            "type":"string",
            "description":"The communication message channel type.",
            "title":"Channel Type"
        },
        "ChannelTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The channel type for the communication template.",
            "title":"Channel Type"
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments entered by the user.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the communication template.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the communication template was created.",
            "title":"Creation Date"
        },
        "DefaultLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"The default language for the communication template.",
            "title":"Default Language"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the communication template is available to be used. The default value is false.",
            "title":"Enabled"
        },
        "EventId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication event.",
            "title":"Event ID"
        },
        "FromAddress":{
            "maxLength":256,
            "type":"string",
            "description":"The sender of the communication message.",
            "title":"From Address"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the communication template was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication template.",
            "title":"Last Updated By"
        },
        "MessageDeleteAllowed":{
            "type":"boolean",
            "description":"Indicates whether the notifications generated by the template can be deleted from a user's notification list."
        },
        "MimeType":{
            "maxLength":30,
            "type":"string",
            "description":"The MIME type of communication message. The possible values are HTML and Text.",
            "title":"MIME Type"
        },
        "MimeTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The MIME type of the communication template. The possible values are HTML and Text.",
            "title":"Mime Type"
        },
        "Priority":{
            "maxLength":1,
            "type":"string",
            "description":"The priority of the notification.",
            "title":"Priority"
        },
        "ShortMessage":{
            "maxLength":500,
            "type":"string",
            "description":"The short text message body.",
            "title":"Short Message"
        },
        "Subject":{
            "maxLength":1000,
            "type":"string",
            "description":"The subject of the communication message.",
            "title":"Subject"
        },
        "TemplateCode":{
            "maxLength":32,
            "type":"string",
            "description":"The unique code of the communication template.",
            "title":"Template Code"
        },
        "TemplateId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the communication template. This ID is generated automatically by the application.",
            "title":"Template ID"
        },
        "TemplateName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the communication template.",
            "title":"Template Name"
        },
        "ToEmailAddress":{
            "type":"string",
            "description":"The primary recipient addresses for email communications.",
            "title":"To Email Address"
        },
        "ToPhoneNumber":{
            "type":"string",
            "description":"The recipient phone number for text communications.",
            "title":"To Phone Number"
        },
        "ToUserid":{
            "type":"string",
            "description":"The recipient user ID for notifications.",
            "title":"To User ID"
        },
        "Visibility":{
            "maxLength":30,
            "type":"string",
            "description":"Visibility option of the communication message generated by the template.",
            "title":"Visibility"
        },
        "VisibilityMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Visibility option of the communication message generated by template.",
            "title":"Visibility"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCommunicationTemplates-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the communication template.
• AlertEnd(optional): string(date-time)
  Title: Alert End Date

  The last date that an alert appears.
• AlertStart(optional): string(date-time)
  Title: Alert Start Date

  The first date that an alert appears.
• AttachmentKeyReference(optional): string
  Title: Attachment Key Reference

  Maximum Length: 256

  The attachment key references.
• AttachmentsEnabled(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether attachments are enabled for the communication template.
• BccEmailAddress(optional): string
  Title: Bcc Email Address

  The blind copied recipient addresses for email communications.
• Body(optional): string
  Title: Message Body

  The communication message body text.
• CcEmailAddress(optional): string
  Title: Cc Email Address

  The copied recipient addresses for email communications.
• ChannelType(optional): string
  Title: Channel Type

  Maximum Length: 30

  The communication message channel type.
• ChannelTypeMeaning(optional): string
  Title: Channel Type

  Maximum Length: 80

  The channel type for the communication template.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments entered by the user.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the communication template.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time that the communication template was created.
• DefaultLanguage(optional): string
  Title: Default Language

  Maximum Length: 4

  The default language for the communication template.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the communication template is available to be used. The default value is false.
• EventId(optional): integer(int64)
  Title: Event ID

  The unique identifier for the communication event.
• FromAddress(optional): string
  Title: From Address

  Maximum Length: 256

  The sender of the communication message.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the communication template was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the communication template.
• links(optional): array Items
  Title: Items

  Link Relations
• MessageDeleteAllowed(optional): boolean
  Indicates whether the notifications generated by the template can be deleted from a user's notification list.
• MimeType(optional): string
  Title: MIME Type

  Maximum Length: 30

  The MIME type of communication message. The possible values are HTML and Text.
• MimeTypeMeaning(optional): string
  Title: Mime Type

  Maximum Length: 80

  The MIME type of the communication template. The possible values are HTML and Text.
• Priority(optional): string
  Title: Priority

  Maximum Length: 1

  The priority of the notification.
• ShortMessage(optional): string
  Title: Short Message

  Maximum Length: 500

  The short text message body.
• Subject(optional): string
  Title: Subject

  Maximum Length: 1000

  The subject of the communication message.
• TemplateCode(optional): string
  Title: Template Code

  Maximum Length: 32

  The unique code of the communication template.
• TemplateId(optional): integer(int64)
  Title: Template ID

  The unique identifier of the communication template. This ID is generated automatically by the application.
• TemplateName(optional): string
  Title: Template Name

  Maximum Length: 100

  The name of the communication template.
• ToEmailAddress(optional): string
  Title: To Email Address

  The primary recipient addresses for email communications.
• ToPhoneNumber(optional): string
  Title: To Phone Number

  The recipient phone number for text communications.
• ToUserid(optional): string
  Title: To User ID

  The recipient user ID for notifications.
• Visibility(optional): string
  Title: Visibility

  Maximum Length: 30

  Visibility option of the communication message generated by the template.
• VisibilityMeaning(optional): string
  Title: Visibility

  Maximum Length: 80

  Visibility option of the communication message generated by template.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication template.",
            "title":"Agency ID"
        },
        "AlertEnd":{
            "format":"date-time",
            "type":"string",
            "description":"The last date that an alert appears.",
            "title":"Alert End Date"
        },
        "AlertStart":{
            "format":"date-time",
            "type":"string",
            "description":"The first date that an alert appears.",
            "title":"Alert Start Date"
        },
        "AttachmentKeyReference":{
            "maxLength":256,
            "type":"string",
            "description":"The attachment key references.",
            "title":"Attachment Key Reference"
        },
        "AttachmentsEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether attachments are enabled for the communication template.",
            "title":"Enabled"
        },
        "BccEmailAddress":{
            "type":"string",
            "description":"The blind copied recipient addresses for email communications.",
            "title":"Bcc Email Address"
        },
        "Body":{
            "type":"string",
            "description":"The communication message body text.",
            "title":"Message Body"
        },
        "CcEmailAddress":{
            "type":"string",
            "description":"The copied recipient addresses for email communications.",
            "title":"Cc Email Address"
        },
        "ChannelType":{
            "maxLength":30,
            "type":"string",
            "description":"The communication message channel type.",
            "title":"Channel Type"
        },
        "ChannelTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The channel type for the communication template.",
            "title":"Channel Type"
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments entered by the user.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the communication template.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the communication template was created.",
            "title":"Creation Date"
        },
        "DefaultLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"The default language for the communication template.",
            "title":"Default Language"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the communication template is available to be used. The default value is false.",
            "title":"Enabled"
        },
        "EventId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication event.",
            "title":"Event ID"
        },
        "FromAddress":{
            "maxLength":256,
            "type":"string",
            "description":"The sender of the communication message.",
            "title":"From Address"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the communication template was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication template.",
            "title":"Last Updated By"
        },
        "MessageDeleteAllowed":{
            "type":"boolean",
            "description":"Indicates whether the notifications generated by the template can be deleted from a user's notification list."
        },
        "MimeType":{
            "maxLength":30,
            "type":"string",
            "description":"The MIME type of communication message. The possible values are HTML and Text.",
            "title":"MIME Type"
        },
        "MimeTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The MIME type of the communication template. The possible values are HTML and Text.",
            "title":"Mime Type"
        },
        "Priority":{
            "maxLength":1,
            "type":"string",
            "description":"The priority of the notification.",
            "title":"Priority"
        },
        "ShortMessage":{
            "maxLength":500,
            "type":"string",
            "description":"The short text message body.",
            "title":"Short Message"
        },
        "Subject":{
            "maxLength":1000,
            "type":"string",
            "description":"The subject of the communication message.",
            "title":"Subject"
        },
        "TemplateCode":{
            "maxLength":32,
            "type":"string",
            "description":"The unique code of the communication template.",
            "title":"Template Code"
        },
        "TemplateId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the communication template. This ID is generated automatically by the application.",
            "title":"Template ID"
        },
        "TemplateName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the communication template.",
            "title":"Template Name"
        },
        "ToEmailAddress":{
            "type":"string",
            "description":"The primary recipient addresses for email communications.",
            "title":"To Email Address"
        },
        "ToPhoneNumber":{
            "type":"string",
            "description":"The recipient phone number for text communications.",
            "title":"To Phone Number"
        },
        "ToUserid":{
            "type":"string",
            "description":"The recipient user ID for notifications.",
            "title":"To User ID"
        },
        "Visibility":{
            "maxLength":30,
            "type":"string",
            "description":"Visibility option of the communication message generated by the template.",
            "title":"Visibility"
        },
        "VisibilityMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Visibility option of the communication message generated by template.",
            "title":"Visibility"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top