Jump to

• Request
• Response

Create a scheduler setup

post

/fscmRestApi/resources/11.13.18.05/schedulerSetups

Request

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

• ActiveFlag(required): boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the scheduler is active or inactive.
• Description(required): string
  Title: Description

  Maximum Length: 240

  The description of the scheduler.
• Name(required): string
  Title: Scheduler Name

  Maximum Length: 50

  The name of the scheduler, such as payment due schedule.
• SchedulerCode(required): string
  Title: Scheduler Code

  Maximum Length: 30

  The unique code for the scheduler, such as PAYMENTDUESCHEDULE.
• schedulerDetails: array Scheduler Details
  Title: Scheduler Details

  Scheduler details provide metadata information for the scheduler. For example, information for the scheduler scheduled for task due event.
• SchedulerEndDatetime: string (date-time)
  Title: Scheduler End Date Time

  The date and time when the scheduler will end.
• SchedulerOccurrenceTypeCode: string
  Title: Scheduler Occurrence Type Code

  Maximum Length: 30

  The code that indicates the type of the scheduler occurrence, such as ORA_HEY_SINGLE_SCHEDULER and ORA_HEY_RECURRING_SCHEDULER. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULER_TYPE.
• SchedulerStartDatetime(required): string (date-time)
  Title: Scheduler Start Date Time

  The date and time when the scheduler will start.
• SchedulerTimeZoneCode(required): string
  Title: Scheduler Time Zone Code

  Maximum Length: 50

  The code that indicates the time zone for date time, such as US Pacific Time.
• ScheduleTypeCode: string
  Title: Schedule Type Code

  Maximum Length: 30

  The code that indicates the type of the schedule, such as ORA_HEY_SCHEDULE_EVENT. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULE_TYPE.

{
    "required":[
        "ActiveFlag",
        "Description",
        "Name",
        "SchedulerCode",
        "SchedulerStartDatetime",
        "SchedulerTimeZoneCode"
    ],
    "type":"object",
    "properties":{
        "SchedulerTimeZoneCode":{
            "title":"Scheduler Time Zone Code",
            "maxLength":50,
            "type":"string",
            "description":"The code that indicates the time zone for date time, such as US Pacific Time.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SchedulerStartDatetime":{
            "title":"Scheduler Start Date Time",
            "type":"string",
            "description":"The date and time when the scheduler will start.",
            "format":"date-time",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the scheduler.",
            "nullable":false
        },
        "SchedulerOccurrenceTypeCode":{
            "title":"Scheduler Occurrence Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the type of the scheduler occurrence, such as ORA_HEY_SINGLE_SCHEDULER and ORA_HEY_RECURRING_SCHEDULER. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULER_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ScheduleTypeCode":{
            "title":"Schedule Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the type of the schedule, such as ORA_HEY_SCHEDULE_EVENT. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SchedulerEndDatetime":{
            "title":"Scheduler End Date Time",
            "type":"string",
            "description":"The date and time when the scheduler will end.",
            "format":"date-time",
            "nullable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the scheduler is active or inactive.",
            "nullable":false
        },
        "SchedulerCode":{
            "title":"Scheduler Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the scheduler, such as PAYMENTDUESCHEDULE.",
            "nullable":false
        },
        "schedulerDetails":{
            "title":"Scheduler Details",
            "type":"array",
            "description":"Scheduler details provide metadata information for the scheduler. For example, information for the scheduler scheduled for task due event.",
            "items":{
                "$ref":"#/components/schemas/schedulerSetups-schedulerDetails-item-post-request"
            }
        },
        "Name":{
            "title":"Scheduler Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the scheduler, such as payment due schedule.",
            "nullable":false
        }
    }
}

Nested Schema : Scheduler Details

Type: array

Title: Scheduler Details

Scheduler details provide metadata information for the scheduler. For example, information for the scheduler scheduled for task due event.

Show Source

• Array of: object schema

{
    "title":"Scheduler Details",
    "type":"array",
    "description":"Scheduler details provide metadata information for the scheduler. For example, information for the scheduler scheduled for task due event.",
    "items":{
        "$ref":"#/components/schemas/schedulerSetups-schedulerDetails-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• SchedulerParameterName: string
  Title: Scheduler Parameter Name

  Maximum Length: 64

  The name of the scheduler parameter used for scheduling.
• SchedulerParameterType: string
  Title: Scheduler Parameter Type

  Maximum Length: 30

  The type of the scheduler parameter used for scheduling.
• SchedulerParameterValue: string
  Title: Scheduler Parameter Value

  Maximum Length: 1000

  The value of the scheduler parameter used for scheduling.
• SeededDataFlag: boolean
  Title: Predefined Data Indicator

  Maximum Length: 80

  Predefined Data Indicator

{
    "type":"object",
    "properties":{
        "SchedulerParameterValue":{
            "title":"Scheduler Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the scheduler parameter used for scheduling.",
            "nullable":false
        },
        "SchedulerParameterType":{
            "title":"Scheduler Parameter Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the scheduler parameter used for scheduling.",
            "nullable":false
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "maxLength":80,
            "type":"boolean",
            "description":"Predefined Data Indicator",
            "nullable":true,
            "x-queryable":false
        },
        "SchedulerParameterName":{
            "title":"Scheduler Parameter Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the scheduler parameter used for scheduling.",
            "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 : schedulerSetups-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the scheduler is active or inactive.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the scheduler.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Scheduler Name

  Maximum Length: 50

  The name of the scheduler, such as payment due schedule.
• SchedulerCode: string
  Title: Scheduler Code

  Maximum Length: 30

  The unique code for the scheduler, such as PAYMENTDUESCHEDULE.
• schedulerDetails: array Scheduler Details
  Title: Scheduler Details

  Scheduler details provide metadata information for the scheduler. For example, information for the scheduler scheduled for task due event.
• SchedulerEndDatetime: string (date-time)
  Title: Scheduler End Date Time

  The date and time when the scheduler will end.
• SchedulerId: integer (int64)
  Title: Scheduler ID

  Read Only: true

  The unique identifier for the scheduler, for example, an identifier for an event scheduler.
• SchedulerOccurrenceTypeCode: string
  Title: Scheduler Occurrence Type Code

  Maximum Length: 30

  The code that indicates the type of the scheduler occurrence, such as ORA_HEY_SINGLE_SCHEDULER and ORA_HEY_RECURRING_SCHEDULER. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULER_TYPE.
• SchedulerOccurrenceTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the scheduler occurrence type. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULER_TYPE.
• SchedulerStartDatetime: string (date-time)
  Title: Scheduler Start Date Time

  The date and time when the scheduler will start.
• SchedulerTimeZoneCode: string
  Title: Scheduler Time Zone Code

  Maximum Length: 50

  The code that indicates the time zone for date time, such as US Pacific Time.
• ScheduleTypeCode: string
  Title: Schedule Type Code

  Maximum Length: 30

  The code that indicates the type of the schedule, such as ORA_HEY_SCHEDULE_EVENT. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULE_TYPE.
• ScheduleTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the schedule type. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULE_TYPE.
• SeededDataFlag: boolean
  Title: Predefined Data Indicator

  Read Only: true

  Maximum Length: 80

  Predefined Data Indicator

{
    "type":"object",
    "properties":{
        "SchedulerTimeZoneCode":{
            "title":"Scheduler Time Zone Code",
            "maxLength":50,
            "type":"string",
            "description":"The code that indicates the time zone for date time, such as US Pacific Time.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the scheduler.",
            "nullable":false,
            "x-queryable":true
        },
        "SchedulerOccurrenceTypeCode":{
            "title":"Scheduler Occurrence Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the type of the scheduler occurrence, such as ORA_HEY_SINGLE_SCHEDULER and ORA_HEY_RECURRING_SCHEDULER. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULER_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleTypeCode":{
            "title":"Schedule Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the type of the schedule, such as ORA_HEY_SCHEDULE_EVENT. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SchedulerEndDatetime":{
            "title":"Scheduler End Date Time",
            "type":"string",
            "description":"The date and time when the scheduler will end.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the scheduler is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "schedulerDetails":{
            "title":"Scheduler Details",
            "type":"array",
            "description":"Scheduler details provide metadata information for the scheduler. For example, information for the scheduler scheduled for task due event.",
            "items":{
                "$ref":"#/components/schemas/schedulerSetups-schedulerDetails-item-response"
            }
        },
        "Name":{
            "title":"Scheduler Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the scheduler, such as payment due schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "SchedulerStartDatetime":{
            "title":"Scheduler Start Date Time",
            "type":"string",
            "description":"The date and time when the scheduler will start.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "SchedulerOccurrenceTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the scheduler occurrence type. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULER_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "maxLength":80,
            "type":"boolean",
            "description":"Predefined Data Indicator",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SchedulerId":{
            "title":"Scheduler ID",
            "type":"integer",
            "description":"The unique identifier for the scheduler, for example, an identifier for an event scheduler.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ScheduleTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the schedule type. A list of accepted values is defined in the lookup type ORA_HEY_SCHEDULE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SchedulerCode":{
            "title":"Scheduler Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the scheduler, such as PAYMENTDUESCHEDULE.",
            "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 : Scheduler Details

Type: array

Title: Scheduler Details

Scheduler details provide metadata information for the scheduler. For example, information for the scheduler scheduled for task due event.

Show Source

• Array of: object schedulerSetups-schedulerDetails-item-response

{
    "title":"Scheduler Details",
    "type":"array",
    "description":"Scheduler details provide metadata information for the scheduler. For example, information for the scheduler scheduled for task due event.",
    "items":{
        "$ref":"#/components/schemas/schedulerSetups-schedulerDetails-item-response"
    }
}

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 : schedulerSetups-schedulerDetails-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SchedulerDetailId: integer (int64)
  Title: Scheduler Detail ID

  Read Only: true

  The unique identifier for the scheduler detail.
• SchedulerParameterName: string
  Title: Scheduler Parameter Name

  Maximum Length: 64

  The name of the scheduler parameter used for scheduling.
• SchedulerParameterType: string
  Title: Scheduler Parameter Type

  Maximum Length: 30

  The type of the scheduler parameter used for scheduling.
• SchedulerParameterValue: string
  Title: Scheduler Parameter Value

  Maximum Length: 1000

  The value of the scheduler parameter used for scheduling.
• SeededDataFlag: boolean
  Title: Predefined Data Indicator

  Maximum Length: 80

  Predefined Data Indicator

{
    "type":"object",
    "properties":{
        "SchedulerParameterValue":{
            "title":"Scheduler Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the scheduler parameter used for scheduling.",
            "nullable":false,
            "x-queryable":true
        },
        "SchedulerParameterType":{
            "title":"Scheduler Parameter Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the scheduler parameter used for scheduling.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SchedulerDetailId":{
            "title":"Scheduler Detail ID",
            "type":"integer",
            "description":"The unique identifier for the scheduler detail.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "maxLength":80,
            "type":"boolean",
            "description":"Predefined Data Indicator",
            "nullable":true,
            "x-queryable":false
        },
        "SchedulerParameterName":{
            "title":"Scheduler Parameter Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the scheduler parameter used for scheduling.",
            "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"
    }
}

Links

ScheduleTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_SCHEDULE_SETUP_TYPE

The following properties are defined on the LOV link relation:

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

SchedulerOccurrenceTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_SCHEDULE_TYPE

The following properties are defined on the LOV link relation:

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

SchedulerTimeZoneCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedTimezones

The following properties are defined on the LOV link relation:

• Source Attribute: SchedulerTimeZoneCode; Target Attribute: TimezoneCode
• Display Attribute: TimezoneCode

schedulerDetails

Operation: /fscmRestApi/resources/11.13.18.05/schedulerSetups/{SchedulerId}/child/schedulerDetails

Parameters:

• SchedulerId: $request.path.SchedulerId

Scheduler details provide metadata information for the scheduler. For example, information for the scheduler scheduled for task due event.

Back to Top