Jump to

• Request
• Response

Get a communication setup

get

/fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}

Request

Path Parameters

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

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

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether a communication is active or inactive.
• commChannels: array Communication Channel Setups
  Title: Communication Channel Setups

  The list of channels that are supported by the communication template.
• commEventMappings: array Communication Event Mappings
  Title: Communication Event Mappings

  The list of events mapped to a communication. For example, Proxy Added event is mapped with a communication.
• CommTemplateCode: string
  Title: Communication Template Code

  Maximum Length: 30

  The unique code for a communication.
• CommTemplateDescription: string
  Title: Description

  Maximum Length: 240

  The description of the communication.
• CommTemplateName: string
  Title: Communication Name

  Maximum Length: 50

  The name of a communication.
• CommTemplateSetupId: integer (int64)
  Title: Communication Template Setup ID

  Read Only: true

  The unique identifier for a communication setup.
• LastModifiedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the communication setup.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the communication was updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• mappedCommCategories: array Communication Categories
  Title: Communication Categories

  The communication categories resource lists all the categories a communication is mapped to.
• SeededDataFlag: boolean
  Title: Predefined Data Indicator

  Read Only: true

  Indicates whether the associated row is predefined.

{
    "type":"object",
    "properties":{
        "LastModifiedBy":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The user who last updated the communication setup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CommTemplateCode":{
            "title":"Communication Template Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for a communication.",
            "nullable":false,
            "x-queryable":true
        },
        "CommTemplateName":{
            "title":"Communication Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a communication.",
            "nullable":false,
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "commEventMappings":{
            "title":"Communication Event Mappings",
            "type":"array",
            "description":"The list of events mapped to a communication. For example, Proxy Added event is mapped with a communication.",
            "items":{
                "$ref":"#/components/schemas/communicationTemplateSetups-commEventMappings-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CommTemplateSetupId":{
            "title":"Communication Template Setup ID",
            "type":"integer",
            "description":"The unique identifier for a communication setup.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a communication is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "mappedCommCategories":{
            "title":"Communication Categories",
            "type":"array",
            "description":"The communication categories resource lists all the categories a communication is mapped to.",
            "items":{
                "$ref":"#/components/schemas/communicationTemplateSetups-mappedCommCategories-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the communication was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommTemplateDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "commChannels":{
            "title":"Communication Channel Setups",
            "type":"array",
            "description":"The list of channels that are supported by the communication template.",
            "items":{
                "$ref":"#/components/schemas/communicationTemplateSetups-commChannels-item-response"
            }
        }
    }
}

Nested Schema : Communication Channel Setups

Type: array

Title: Communication Channel Setups

The list of channels that are supported by the communication template.

Show Source

• Array of: object communicationTemplateSetups-commChannels-item-response

{
    "title":"Communication Channel Setups",
    "type":"array",
    "description":"The list of channels that are supported by the communication template.",
    "items":{
        "$ref":"#/components/schemas/communicationTemplateSetups-commChannels-item-response"
    }
}

Nested Schema : Communication Event Mappings

Type: array

Title: Communication Event Mappings

The list of events mapped to a communication. For example, Proxy Added event is mapped with a communication.

Show Source

• Array of: object communicationTemplateSetups-commEventMappings-item-response

{
    "title":"Communication Event Mappings",
    "type":"array",
    "description":"The list of events mapped to a communication. For example, Proxy Added event is mapped with a communication.",
    "items":{
        "$ref":"#/components/schemas/communicationTemplateSetups-commEventMappings-item-response"
    }
}

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 : Communication Categories

Type: array

Title: Communication Categories

The communication categories resource lists all the categories a communication is mapped to.

Show Source

• Array of: object communicationTemplateSetups-mappedCommCategories-item-response

{
    "title":"Communication Categories",
    "type":"array",
    "description":"The communication categories resource lists all the categories a communication is mapped to.",
    "items":{
        "$ref":"#/components/schemas/communicationTemplateSetups-mappedCommCategories-item-response"
    }
}

Nested Schema : communicationTemplateSetups-commChannels-item-response

Type: object

Show Source

• CommChannelId: integer (int64)
  Title: Communication Channel ID

  Read Only: true

  The unique identifier for a communication's email content for a channel.
• CommChannelTypeCode: string
  Title: Communication Channel Type Code

  Maximum Length: 30

  The code of the communication channel type.
• CommChannelTypeMeaning: string
  Title: Communication Channel Type Code Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the communication channel type code. Examples of channels are email and SMS.
• commContentProperties: array Communication Content Properties
  Title: Communication Content Properties

  The properties for a communication that hold information about the communication template for specific channels. For example, information for From, Reply to, and Subject.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeededDataFlag: boolean
  Title: Predefined Data Indicator

  Read Only: true

  Predefined Data Indicator

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CommChannelTypeMeaning":{
            "title":"Communication Channel Type Code Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the communication channel type code. Examples of channels are email and SMS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommChannelId":{
            "title":"Communication Channel ID",
            "type":"integer",
            "description":"The unique identifier for a communication's email content for a channel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "commContentProperties":{
            "title":"Communication Content Properties",
            "type":"array",
            "description":"The properties for a communication that hold information about the communication template for specific channels. For example, information for From, Reply to, and Subject.",
            "items":{
                "$ref":"#/components/schemas/communicationTemplateSetups-commChannels-commContentProperties-item-response"
            }
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Predefined Data Indicator",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "CommChannelTypeCode":{
            "title":"Communication Channel Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the communication channel type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Communication Content Properties

Type: array

Title: Communication Content Properties

The properties for a communication that hold information about the communication template for specific channels. For example, information for From, Reply to, and Subject.

Show Source

• Array of: object communicationTemplateSetups-commChannels-commContentProperties-item-response

{
    "title":"Communication Content Properties",
    "type":"array",
    "description":"The properties for a communication that hold information about the communication template for specific channels. For example, information for From, Reply to, and Subject.",
    "items":{
        "$ref":"#/components/schemas/communicationTemplateSetups-commChannels-commContentProperties-item-response"
    }
}

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 : communicationTemplateSetups-commChannels-commContentProperties-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PropertyId: integer (int64)
  Title: Property ID

  Read Only: true

  Communication setup content identifier for a channel property.
• PropertyLongValue: string (byte)
  Title: Property Long Value

  Communication content property long value.
• PropertyName: string
  Title: Property Name

  Maximum Length: 64

  Name of the property.
• PropertyTypeCode: string
  Title: Property Type Code

  Maximum Length: 30

  Type of the communication content property.
• PropertyTypeMeaning: string
  Title: Property Type Code Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the communication content property type. Example of content types are short and long.
• PropertyValue: string
  Title: Property Value

  Maximum Length: 1000

  Communication content property value.
• SeededDataFlag: boolean
  Title: Predefined Data Indicator

  Read Only: true

  Predefined Data Indicator

{
    "type":"object",
    "properties":{
        "PropertyName":{
            "title":"Property Name",
            "maxLength":"64",
            "type":"string",
            "description":"Name of the property.",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyTypeCode":{
            "title":"Property Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Type of the communication content property.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Predefined Data Indicator",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            },
            "x-queryable":true
        },
        "PropertyLongValue":{
            "title":"Property Long Value",
            "type":"string",
            "description":"Communication content property long value.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":"1000",
            "type":"string",
            "description":"Communication content property value.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PropertyTypeMeaning":{
            "title":"Property Type Code Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the communication content property type. Example of content types are short and long.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyId":{
            "title":"Property ID",
            "type":"integer",
            "description":"Communication setup content identifier for a channel property.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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."
        }
    }
}

Nested Schema : communicationTemplateSetups-commEventMappings-item-response

Type: object

Show Source

• CommChannelTypeCode: string
  Title: Communication Channel Type Code

  Maximum Length: 30

  Code for the communication channel type.
• CommChannelTypeMeaning: string
  Title: Communication Channel Type Code Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the communication channel type code. Examples of channels are email and SMS.
• CommEventId: integer (int64)
  Title: Communication Event ID

  Read Only: true

  The unique identifier for communication event mapping.
• commSchedulers: array Communication Scheduler
  Title: Communication Scheduler

  The list of schedules for a specific communication template in relation to an event.
• EventCode: string
  Title: Event Code

  Maximum Length: 30

  The unique code for the event, such as ADMINADDENRLL.
• EventDescription: string
  Title: Event Description

  Read Only: true

  Maximum Length: 240

  The description of an event that triggers a communication.
• EventId: integer (int64)
  Title: Event ID

  The unique identifier for an event.
• EventName: string
  Title: Event

  Read Only: true

  Maximum Length: 50

  The name of an event, such as Admissions Application Submission.
• EventTypeCode: string
  Title: Event Type

  Read Only: true

  Maximum Length: 30

  The code that indicates the type of the event, such as ORA_HEY_TRANSACTIONAL and ORA_HEY_DATE_BASED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeededDataFlag: boolean
  Title: Predefined Data Indicator

  Read Only: true

  Predefined Data Indicator
• SendImmediateFlag: boolean
  Maximum Length: 1

  Indicates if the communication must be sent immediately.

{
    "type":"object",
    "properties":{
        "EventTypeCode":{
            "title":"Event Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the type of the event, such as ORA_HEY_TRANSACTIONAL and ORA_HEY_DATE_BASED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "commSchedulers":{
            "title":"Communication Scheduler",
            "type":"array",
            "description":"The list of schedules for a specific communication template in relation to an event.",
            "items":{
                "$ref":"#/components/schemas/communicationTemplateSetups-commEventMappings-commSchedulers-item-response"
            }
        },
        "CommChannelTypeMeaning":{
            "title":"Communication Channel Type Code Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the communication channel type code. Examples of channels are email and SMS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Predefined Data Indicator",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "CommChannelTypeCode":{
            "title":"Communication Channel Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the communication channel type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for an event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CommEventId":{
            "title":"Communication Event ID",
            "type":"integer",
            "description":"The unique identifier for communication event mapping.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EventName":{
            "title":"Event",
            "maxLength":"50",
            "type":"string",
            "description":"The name of an event, such as Admissions Application Submission.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventDescription":{
            "title":"Event Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of an event that triggers a communication.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for the event, such as ADMINADDENRLL.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SendImmediateFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the communication must be sent immediately.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Communication Scheduler

Type: array

Title: Communication Scheduler

The list of schedules for a specific communication template in relation to an event.

Show Source

• Array of: object communicationTemplateSetups-commEventMappings-commSchedulers-item-response

{
    "title":"Communication Scheduler",
    "type":"array",
    "description":"The list of schedules for a specific communication template in relation to an event.",
    "items":{
        "$ref":"#/components/schemas/communicationTemplateSetups-commEventMappings-commSchedulers-item-response"
    }
}

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 : communicationTemplateSetups-commEventMappings-commSchedulers-item-response

Type: object

Show Source

• CommChannelTypeCode: string
  Title: Communication Channel Type Code

  Maximum Length: 30

  Code of communication channel type
• CommChannelTypeMeaning: string
  Title: Communication Channel Type Code Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the communication channel type code. Examples of channels are email and SMS.
• CommSchedulerId: integer (int64)
  Title: Communication Scheduler ID

  Read Only: true

  The unique identifier of the communication schedule.
• IncrementValue: integer (int64)
  Title: Increment Value

  Numeric value of time used to calculate the schedule date for a communication.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PivotDateAttribute: string
  Title: Pivot Date Attribute

  Maximum Length: 80

  The date attribute from event payload for pivot date.
• PivotDirectionCode: string
  Title: Pivot Direction

  Maximum Length: 30

  The direction of the pivot. Example of pivot directions are after and before.
• PivotDirectionMeaning: string
  Title: Pivot Direction Code Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the pivot direction code type. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TIMING_RULE_TYPE.
• SeededDataFlag: boolean
  Title: Predefined Data Indicator

  Read Only: true

  Predefined Data Indicator
• TimeUnitCode: string
  Title: Time Unit

  Maximum Length: 30

  Unit of Time used to calculate the schedule date for the communication. For example, minutes, hours, or days.
• TimeUnitMeaning: string
  Title: Time Unit Code Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the time unit type. A list of accepted values is defined in the lookup type ORA_HEY_COMM_TIME_UNIT_TYPE.

{
    "type":"object",
    "properties":{
        "IncrementValue":{
            "title":"Increment Value",
            "type":"integer",
            "description":"Numeric value of time used to calculate the schedule date for a communication.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CommChannelTypeMeaning":{
            "title":"Communication Channel Type Code Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the communication channel type code. Examples of channels are email and SMS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeUnitCode":{
            "title":"Time Unit",
            "maxLength":"30",
            "type":"string",
            "description":"Unit of Time used to calculate the schedule date for the communication. For example, minutes, hours, or days.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CommSchedulerId":{
            "title":"Communication Scheduler ID",
            "type":"integer",
            "description":"The unique identifier of the communication schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PivotDirectionMeaning":{
            "title":"Pivot Direction Code Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the pivot direction code type. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TIMING_RULE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Predefined Data Indicator",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "CommChannelTypeCode":{
            "title":"Communication Channel Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of communication channel type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PivotDirectionCode":{
            "title":"Pivot Direction",
            "maxLength":"30",
            "type":"string",
            "description":"The direction of the pivot. Example of pivot directions are after and before.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TimeUnitMeaning":{
            "title":"Time Unit Code Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the time unit type. A list of accepted values is defined in the lookup type ORA_HEY_COMM_TIME_UNIT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PivotDateAttribute":{
            "title":"Pivot Date Attribute",
            "maxLength":"80",
            "type":"string",
            "description":"The date attribute from event payload for pivot date.",
            "nullable":false,
            "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 : communicationTemplateSetups-mappedCommCategories-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Read Only: true

  Maximum Length: 1

  Active
• CategoryCode: string
  Title: Category Code

  Maximum Length: 30

  The code of the category.
• CategoryDescription: string
  Title: Category Description

  Read Only: true

  Maximum Length: 240

  The description of the category.
• CategoryId: integer (int64)
  Title: Category ID

  The unique identifier for the category related to the communication.
• CategoryName: string
  Title: Category Name

  Read Only: true

  Maximum Length: 50

  The name of the category.
• CommCategoryId: integer (int64)
  Title: Communication Category ID

  Read Only: true

  The unique identifier of the communication setup category.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeededDataFlag: boolean
  Title: Predefined Data Indicator

  Read Only: true

  Predefined Data Indicator

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "description":"The unique identifier for the category related to the communication.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the category.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Predefined Data Indicator",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryDescription":{
            "title":"Category Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommCategoryId":{
            "title":"Communication Category ID",
            "type":"integer",
            "description":"The unique identifier of the communication setup category.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Active",
            "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

commChannels

Operation: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commChannels

Parameters:

• CommTemplateSetupId: $request.path.CommTemplateSetupId

The list of channels that are supported by the communication template.

commEventMappings

Operation: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings

Parameters:

• CommTemplateSetupId: $request.path.CommTemplateSetupId

The list of events mapped to a communication. For example, Proxy Added event is mapped with a communication.

mappedCommCategories

Operation: /fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/mappedCommCategories

Parameters:

• CommTemplateSetupId: $request.path.CommTemplateSetupId

The communication categories resource lists all the categories a communication is mapped to.

Back to Top