Get a communication setup
get
/fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}
Request
Path Parameters
-
CommSetupId(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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : communicationSetups-item-response
Type:
Show Source
object
-
AcademicOrgId: integer
(int64)
Title:
Academic Organization ID
The unique identifier for an academic organization that owns the communication. -
AcademicOrgName: string
Title:
Academic Organization Name
Read Only:true
Maximum Length:50
The name of an academic organization that owns the communication. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether a communication is active or inactive. -
CategoryId: integer
(int64)
Title:
Category ID
The category for a communication, such as enrollment or billing. -
CategoryName: string
Title:
CategoryName
Read Only:true
Maximum Length:50
The name of a category, such as Enrollment or Billing. -
commEmailSetup: array
Communication Email Setups
Title:
Communication Email Setups
The communication email setups resource provides a list of setups for creating and sending communication email messages. -
commEventMappings: array
Communication Event Mapping
Title:
Communication Event Mapping
The communication event mapping resource provides the list of events mapped with communications. For example, an admissions application submission event could be mapped to a communication sent to notify the applicants that their applications were submitted. -
CommSetupId: integer
(int64)
Title:
Communication Setup ID
Read Only:true
The unique identifier for a communication setup. -
CommTime: string
(date-time)
Title:
Communication Time
The time when a communication is sent to the recipient. -
CommunicationDescription: string
Title:
Description
Maximum Length:240
The description of a communication. -
CommunicationName: string
Title:
Communication Name
Maximum Length:50
The name of a communication. -
CommunicationSetupCode: string
Title:
Communication Code
Maximum Length:30
The unique code for a communication. -
CommunicationTime: string
(date)
Title:
Communication Time
The date value when a communication is sent to the recipient. -
CommunicationTimingCode: string
Title:
Communication Timing
Maximum Length:30
Default Value:ORA_HEY_IMMEDIATE
Indicates the timing of a communication, such as immediate or scheduled. -
CommunicationType: string
Title:
Communication Type
Read Only:true
Maximum Length:80
The lookup meaning of the communication type code. A list of accepted values is defined in the lookup type ORA_HEY_COMMUNICATION_TYPE. -
CommunicationTypeCode: string
Title:
Communication Type
Maximum Length:30
Default Value:ORA_HEY_EVENT_BASED
The code for the type of communication, such as an event-based communication. A list of accepted values is defined in the lookup type ORA_HEY_COMMUNICATION_TYPE. -
EmailChannelFlag: boolean
Title:
Email Channel Enabled
Maximum Length:1
Indicates whether the email channel is enabled for a specific communication. -
InactivateDate: string
(date)
Title:
Inactivation Date
The date on which a communication should become inactive. -
InstitutionId: integer
(int64)
Title:
Institution ID
The unique identifier for an institution. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
The name of an institution with which a communication is associated. -
LastModifiedBy: string
Title:
Last Updated By
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. -
RecipientCriteriaCode: string
Title:
Recipients
Maximum Length:30
Default Value:ORA_HEY_ALL_PARTIES
The recipient population of a communication, such as all persons impacted by an event. -
SeededDataFlag: boolean
Title:
Predefined Data Indicator
Read Only:true
Indicates whether the associated row is predefined.
Nested Schema : Communication Email Setups
Type:
array
Title:
Communication Email Setups
The communication email setups resource provides a list of setups for creating and sending communication email messages.
Show Source
Nested Schema : Communication Event Mapping
Type:
array
Title:
Communication Event Mapping
The communication event mapping resource provides the list of events mapped with communications. For example, an admissions application submission event could be mapped to a communication sent to notify the applicants that their applications were submitted.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : communicationSetups-commEmailSetup-item-response
Type:
Show Source
object
-
CommSetupId: integer
(int64)
Read Only:
true
The unique identifier for a communication setup. -
EmailBcc: string
The email addresses in the Bcc line of an email.
-
EmailCc: string
The email addresses in the Cc line of an email.
-
EmailFrom: string
Maximum Length:
64
The email address of the sender of the communication. -
EmailMessageText: string
The message text of an email.
-
EmailSetupId: integer
(int64)
Read Only:
true
The unique identifier for a communication's email content. -
EmailSubject: string
Maximum Length:
240
The subject line of an email. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : communicationSetups-commEventMappings-item-response
Type:
Show Source
object
-
CommEventId: integer
(int64)
Title:
Communication Event ID
The unique identifier for communication event mapping. -
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 Name
Read Only:true
Maximum Length:50
The name of an event, such as Admissions Application Submission. -
EventTypeCode: string
Title:
Event Type Code
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AcademicInstitutionLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: InstitutionId; Target Attribute: InstitutionId
- Display Attribute: InstitutionName
- CategoryLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: CategoryId; Target Attribute: CategoryId
- Display Attribute: CategoryName
- commEmailSetup
-
Operation: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEmailSetupParameters:
- CommSetupId:
$request.path.CommSetupId
The communication email setups resource provides a list of setups for creating and sending communication email messages. - CommSetupId:
- commEventMappings
-
Operation: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEventMappingsParameters:
- CommSetupId:
$request.path.CommSetupId
The communication event mapping resource provides the list of events mapped with communications. For example, an admissions application submission event could be mapped to a communication sent to notify the applicants that their applications were submitted. - CommSetupId: