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)
  The last date that an alert appears.
• AlertStart(optional): string(date-time)
  The first date that an alert appears.
• AttachmentKeyReference(optional): string
  Maximum Length: 256

  The attachment key references.
• AttachmentsEnabled(optional): string
  Maximum Length: 1

  Indicates whether attachments are enabled for the communication template.
• BccEmailAddress(optional): string
  The blind copied recipient addresses for email communications.
• Body(optional): string
  The communication message body text.
• CcEmailAddress(optional): string
  The copied recipient addresses for email communications.
• ChannelType(optional): string
  Maximum Length: 30

  The communication message channel type.
• ChannelTypeMeaning(optional): string
  Maximum Length: 80

  The channel type for the communication template.
• Comments(optional): string
  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
  Maximum Length: 4

  The default language for the communication template.
• EnabledFlag(optional): boolean
  Indicates whether the communication template is available to be used. The default value is false.
• EventId(optional): integer(int64)
  The unique identifier for the communication event.
• FromAddress(optional): string
  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
  Maximum Length: 30

  The MIME type of communication message. The possible values are HTML and Text.
• MimeTypeMeaning(optional): string
  Maximum Length: 80

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

  The priority of the notification.
• ShortMessage(optional): string
  Maximum Length: 500

  The short text message body.
• Subject(optional): string
  Maximum Length: 1000

  The subject of the communication message.
• TemplateCode(optional): string
  Maximum Length: 32

  The unique code of the communication template.
• TemplateId(optional): integer(int64)
  The unique identifier of the communication template. This ID is generated automatically by the application.
• TemplateName(optional): string
  Maximum Length: 100

  The name of the communication template.
• ToEmailAddress(optional): string
  The primary recipient addresses for email communications.
• ToPhoneNumber(optional): string
  The recipient phone number for text communications.
• ToUserid(optional): string
  The recipient user ID for notifications.
• Visibility(optional): string
  Maximum Length: 30

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

  Visibility option of the communication message generated by template.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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)
  The last date that an alert appears.
• AlertStart(optional): string(date-time)
  The first date that an alert appears.
• AttachmentKeyReference(optional): string
  Maximum Length: 256

  The attachment key references.
• AttachmentsEnabled(optional): string
  Maximum Length: 1

  Indicates whether attachments are enabled for the communication template.
• BccEmailAddress(optional): string
  The blind copied recipient addresses for email communications.
• Body(optional): string
  The communication message body text.
• CcEmailAddress(optional): string
  The copied recipient addresses for email communications.
• ChannelType(optional): string
  Maximum Length: 30

  The communication message channel type.
• ChannelTypeMeaning(optional): string
  Maximum Length: 80

  The channel type for the communication template.
• Comments(optional): string
  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
  Maximum Length: 4

  The default language for the communication template.
• EnabledFlag(optional): boolean
  Indicates whether the communication template is available to be used. The default value is false.
• EventId(optional): integer(int64)
  The unique identifier for the communication event.
• FromAddress(optional): string
  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
  Maximum Length: 30

  The MIME type of communication message. The possible values are HTML and Text.
• MimeTypeMeaning(optional): string
  Maximum Length: 80

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

  The priority of the notification.
• ShortMessage(optional): string
  Maximum Length: 500

  The short text message body.
• Subject(optional): string
  Maximum Length: 1000

  The subject of the communication message.
• TemplateCode(optional): string
  Maximum Length: 32

  The unique code of the communication template.
• TemplateId(optional): integer(int64)
  The unique identifier of the communication template. This ID is generated automatically by the application.
• TemplateName(optional): string
  Maximum Length: 100

  The name of the communication template.
• ToEmailAddress(optional): string
  The primary recipient addresses for email communications.
• ToPhoneNumber(optional): string
  The recipient phone number for text communications.
• ToUserid(optional): string
  The recipient user ID for notifications.
• Visibility(optional): string
  Maximum Length: 30

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

  Visibility option of the communication message generated by template.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top