Jump to

• Request
• Response

Get a communication template

get

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

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : publicSectorCommunicationTemplates-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

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

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

  Maximum Length: 256

  The attachment key references.
• AttachmentsEnabled: string
  Title: Enabled

  Maximum Length: 1

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

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

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

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

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 1000

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 4

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

  Maximum Length: 1

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

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

  Maximum Length: 256

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the communication template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageDeleteAllowed: boolean
  Maximum Length: 1

  Indicates whether the notifications generated by the template can be deleted from a user's notification list.
• MimeType: string
  Title: MIME Type

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 1

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

  Maximum Length: 500

  The short text message body.
• Subject: string
  Title: Subject

  Maximum Length: 1000

  The subject of the communication message.
• TemplateAttachmentAttributes: string
  Title: Attachment Key Reference

  Maximum Length: 900

  Attachment attributes required to generate reports.
• TemplateAttData: string
  Maximum Length: 255

  The attachment details of the template.
• TemplateCode: string
  Title: Template Code

  Maximum Length: 32

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

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

  Maximum Length: 100

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

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

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

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

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 80

  Visibility option of the communication message generated by template.

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

Back to Top