Jump to

• Request
• Response

Create a communication schedule

post

/fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings/{CommEventId}/child/commSchedulers

Request

Path Parameters

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

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.
• Upsert-Mode:
  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

• CommChannelTypeCode: string
  Title: Communication Channel Type Code

  Maximum Length: 30

  Code of communication channel type
• IncrementValue: integer (int64)
  Title: Increment Value

  Numeric value of time used to calculate the schedule date for a communication.
• 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.
• 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.

{
    "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
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "CommChannelTypeCode":{
            "title":"Communication Channel Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of communication channel type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PivotDateAttribute":{
            "title":"Pivot Date Attribute",
            "maxLength":80,
            "type":"string",
            "description":"The date attribute from event payload for pivot date.",
            "nullable":false
        }
    }
}

Back to Top

Response

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.

Body ()

Root 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 : 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

CommChannelTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_COMM_CHANNEL

The following properties are defined on the LOV link relation:

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

PivotDirectionLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_EVENT_TIMING_RULE_TYPE

The following properties are defined on the LOV link relation:

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

TimeUnitLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_COMM_TIME_UNIT_TYPE

The following properties are defined on the LOV link relation:

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

Back to Top