Jump to

• Request
• Response

Create a communication channel

post

/fscmRestApi/resources/11.13.18.05/hedCommunicationSetups/{CommunicationSetupId}/child/commVersions

Request

Path Parameters

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

Header Parameters

• Metadata-Context: string
  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: string
  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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• commChannels: array Communication Channel Setups
  Title: Communication Channel Setups

  The list of channels that are supported by the communication template.
• VersionDescription: string
  Title: Communication Version Description

  Maximum Length: 240

  The description of a communication version record.
• VersionId: integer (int64)
  Title: Communication Setup Version ID

  The unique identifier for the communication version record.
• VersionName(required): string
  Title: Communication Version Name

  Maximum Length: 50

  The name of a communication version record.
• VersionNumber(required): integer (int32)
  Title: Communication Version Number

  Denotes version number of the communication.
• VersionStatusCode(required): string
  Title: Communication Version Status Code

  Maximum Length: 30

  The status code of the communication.

{
    "required":[
        "VersionName",
        "VersionNumber",
        "VersionStatusCode"
    ],
    "type":"object",
    "properties":{
        "VersionDescription":{
            "title":"Communication Version Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a communication version record.",
            "nullable":true
        },
        "VersionId":{
            "title":"Communication Setup Version ID",
            "type":"integer",
            "description":"The unique identifier for the communication version record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "VersionName":{
            "title":"Communication Version Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a communication version record.",
            "nullable":false
        },
        "VersionNumber":{
            "title":"Communication Version Number",
            "type":"integer",
            "description":"Denotes version number of the communication.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "VersionStatusCode":{
            "title":"Communication Version Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the communication.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "commChannels":{
            "title":"Communication Channel Setups",
            "type":"array",
            "description":"The list of channels that are supported by the communication template.",
            "items":{
                "$ref":"#/components/schemas/hedCommunicationSetups-commVersions-commChannels-item-post-request"
            }
        }
    }
}

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 hedCommunicationSetups-commVersions-commChannels-item-post-request

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

Nested Schema : hedCommunicationSetups-commVersions-commChannels-item-post-request

Type: object

Show Source

• CommChannelTypeCode(required): string
  Title: Communication Channel Type Code

  Maximum Length: 30

  Code for the communication channel type.
• 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.

{
    "required":[
        "CommChannelTypeCode"
    ],
    "type":"object",
    "properties":{
        "CommChannelTypeCode":{
            "title":"Communication Channel Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the communication channel type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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/hedCommunicationSetups-commVersions-commChannels-commContentProperties-item-post-request"
            }
        }
    }
}

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 hedCommunicationSetups-commVersions-commChannels-commContentProperties-item-post-request

{
    "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/hedCommunicationSetups-commVersions-commChannels-commContentProperties-item-post-request"
    }
}

Nested Schema : hedCommunicationSetups-commVersions-commChannels-commContentProperties-item-post-request

Type: object

Show Source

• 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.
• PropertyValue: string
  Title: Property Value

  Maximum Length: 1000

  Communication content property value.

{
    "type":"object",
    "properties":{
        "PropertyLongValue":{
            "title":"Property Long Value",
            "type":"string",
            "description":"Communication content property long value.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PropertyName":{
            "title":"Property Name",
            "maxLength":64,
            "type":"string",
            "description":"Name of the property.",
            "nullable":false
        },
        "PropertyTypeCode":{
            "title":"Property Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Type of the communication content property.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":1000,
            "type":"string",
            "description":"Communication content property value.",
            "nullable":true
        }
    }
}

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 : hedCommunicationSetups-commVersions-item-response

Type: object

Show Source

• commChannels: array Communication Channel Setups
  Title: Communication Channel Setups

  The list of channels that are supported by the communication template.
• ContractConfiguration: string (byte)
  Title: Contract Configuration

  Read Only: true

  The contract configuration of the communication. This includes all the expected parameters.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the communication version was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the communication version was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• VersionDescription: string
  Title: Communication Version Description

  Maximum Length: 240

  The description of a communication version record.
• VersionId: integer (int64)
  Title: Communication Setup Version ID

  The unique identifier for the communication version record.
• VersionName: string
  Title: Communication Version Name

  Maximum Length: 50

  The name of a communication version record.
• VersionNumber: integer (int32)
  Title: Communication Version Number

  Denotes version number of the communication.
• VersionStatusCode: string
  Title: Communication Version Status Code

  Maximum Length: 30

  The status code of the communication.
• VersionStatusMeaning: string
  Title: Communication Version Status Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the status of the communication.

{
    "type":"object",
    "properties":{
        "ContractConfiguration":{
            "title":"Contract Configuration",
            "type":"string",
            "description":"The contract configuration of the communication. This includes all the expected parameters.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the communication version was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the communication version was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication version.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionDescription":{
            "title":"Communication Version Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a communication version record.",
            "nullable":true,
            "x-queryable":true
        },
        "VersionId":{
            "title":"Communication Setup Version ID",
            "type":"integer",
            "description":"The unique identifier for the communication version record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "VersionName":{
            "title":"Communication Version Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a communication version record.",
            "nullable":false,
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Communication Version Number",
            "type":"integer",
            "description":"Denotes version number of the communication.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "VersionStatusCode":{
            "title":"Communication Version Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the communication.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VersionStatusMeaning":{
            "title":"Communication Version Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the status of the communication.",
            "nullable":false,
            "readOnly":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/hedCommunicationSetups-commVersions-commChannels-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 hedCommunicationSetups-commVersions-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/hedCommunicationSetups-commVersions-commChannels-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 : hedCommunicationSetups-commVersions-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

  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.
• 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.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the communication channel was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "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
        },
        "CommChannelTypeCode":{
            "title":"Communication Channel Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the communication channel type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the communication channel was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication channel.",
            "nullable":false,
            "readOnly":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/hedCommunicationSetups-commVersions-commChannels-commContentProperties-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 hedCommunicationSetups-commVersions-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/hedCommunicationSetups-commVersions-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 : hedCommunicationSetups-commVersions-commChannels-commContentProperties-item-response

Type: object

Show Source

• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the communication content property was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the communication content property.
• 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.

{
    "type":"object",
    "properties":{
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the communication content property was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication content property.",
            "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
        },
        "PropertyLongValue":{
            "title":"Property Long Value",
            "type":"string",
            "description":"Communication content property long value.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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"
            }
        }
    }
}

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."
        }
    }
}

Links

VersionStatusCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{VersionStatusCode}%2CLookupType%3DORA_HEY_VERSION_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: VersionStatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

commChannels

Operation: /fscmRestApi/resources/11.13.18.05/hedCommunicationSetups/{CommunicationSetupId}/child/commVersions/{VersionId}/child/commChannels

Parameters:

• CommunicationSetupId: $request.path.CommunicationSetupId
• VersionId: $request.path.VersionId

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

Back to Top