Jump to

• Request
• Response

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

Type: object

Show Source

• 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: 255

  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: Category Name

  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

  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.
• 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.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "description":"The category for a communication, such as enrollment or billing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastModifiedBy":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The user who last updated the communication setup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailChannelFlag":{
            "title":"Email Channel Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the email channel is enabled for a specific communication.",
            "nullable":true,
            "x-queryable":true
        },
        "commEventMappings":{
            "title":"Communication Event Mapping",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/communicationSetups-commEventMappings-item-response"
            }
        },
        "InactivateDate":{
            "title":"Inactivation Date",
            "type":"string",
            "description":"The date on which a communication should become inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CommunicationSetupCode":{
            "title":"Communication Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for a communication.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CommunicationName":{
            "title":"Communication Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a communication.",
            "nullable":false,
            "x-queryable":true
        },
        "CommunicationTime":{
            "title":"Communication Time",
            "type":"string",
            "description":"The date value when a communication is sent to the recipient.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CommSetupId":{
            "title":"Communication Setup ID",
            "type":"integer",
            "description":"The unique identifier for a communication setup.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"The name of an institution with which a communication is associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The unique identifier for an academic organization that owns the communication.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CommunicationTimingCode":{
            "title":"Communication Timing",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the timing of a communication, such as immediate or scheduled.",
            "nullable":true,
            "default":"ORA_HEY_IMMEDIATE",
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for an institution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicOrgName":{
            "title":"Academic Organization Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of an academic organization that owns the communication.",
            "nullable":true,
            "readOnly":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
        },
        "RecipientCriteriaCode":{
            "title":"Recipients",
            "maxLength":"30",
            "type":"string",
            "description":"The recipient population of a communication, such as all persons impacted by an event.",
            "nullable":true,
            "default":"ORA_HEY_ALL_PARTIES",
            "x-queryable":true
        },
        "CommunicationType":{
            "title":"Communication Type",
            "maxLength":"80",
            "type":"string",
            "description":"The lookup meaning of the communication type code. A list of accepted values is defined in the lookup type ORA_HEY_COMMUNICATION_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommTime":{
            "title":"Communication Time",
            "type":"string",
            "description":"The time when a communication is sent to the recipient.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SeedDataSource"
                ]
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a category, such as Enrollment or Billing.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationTypeCode":{
            "title":"Communication Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"ORA_HEY_EVENT_BASED",
            "x-queryable":true
        },
        "commEmailSetup":{
            "title":"Communication Email Setups",
            "type":"array",
            "description":"The communication email setups resource provides a list of setups for creating and sending communication email messages.",
            "items":{
                "$ref":"#/components/schemas/communicationSetups-commEmailSetup-item-response"
            }
        },
        "CommunicationDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a communication.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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
        }
    }
}

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

• Array of: object communicationSetups-commEmailSetup-item-response

{
    "title":"Communication Email Setups",
    "type":"array",
    "description":"The communication email setups resource provides a list of setups for creating and sending communication email messages.",
    "items":{
        "$ref":"#/components/schemas/communicationSetups-commEmailSetup-item-response"
    }
}

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

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

{
    "title":"Communication Event Mapping",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/communicationSetups-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 : communicationSetups-commEmailSetup-item-response

Type: object

Show Source

• EmailBcc: string
  Title: Bcc

  The email addresses in the Bcc line of an email.
• EmailCc: string
  Title: Cc

  The email addresses in the Cc line of an email.
• EmailFrom: string
  Title: From

  Maximum Length: 64

  The email address of the sender of the communication.
• EmailMessageText: string
  Title: Message Text

  The message text of an email.
• EmailSetupId: integer (int64)
  Title: Email Setup ID

  Read Only: true

  The unique identifier for a communication's email content.
• EmailSubject: string
  Title: Subject

  Maximum Length: 240

  The subject line of an email.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "EmailSetupId":{
            "title":"Email Setup ID",
            "type":"integer",
            "description":"The unique identifier for a communication's email content.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EmailFrom":{
            "title":"From",
            "maxLength":"64",
            "type":"string",
            "description":"The email address of the sender of the communication.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "EmailSubject":{
            "title":"Subject",
            "maxLength":"240",
            "type":"string",
            "description":"The subject line of an email.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EmailCc":{
            "title":"Cc",
            "type":"string",
            "description":"The email addresses in the Cc line of an email.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CommEmailCc"
                ]
            },
            "x-queryable":true
        },
        "EmailMessageText":{
            "title":"Message Text",
            "type":"string",
            "description":"The message text of an email.",
            "nullable":false,
            "x-queryable":true
        },
        "EmailBcc":{
            "title":"Bcc",
            "type":"string",
            "description":"The email addresses in the Bcc line of an email.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CommEmailBcc"
                ]
            },
            "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 : communicationSetups-commEventMappings-item-response

Type: object

Show Source

• CommEventId: integer (int64)
  Title: Communication Event ID

  Read Only: true

  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.

{
    "type":"object",
    "properties":{
        "EventTypeCode":{
            "title":"Event Type Code",
            "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
        },
        "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 Name",
            "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
        }
    }
}

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

AcademicInstitutionLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions

The following properties are defined on the LOV link relation:

• Source Attribute: InstitutionId; Target Attribute: InstitutionId
• Display Attribute: InstitutionName

CategoryLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentManagementCategories

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/commEmailSetup

Parameters:

• CommSetupId: $request.path.CommSetupId

The communication email setups resource provides a list of setups for creating and sending communication email messages.

commEventMappings

Operation: /fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEventMappings

Parameters:

• 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.

Back to Top