Get a scheduler setup
get
/fscmRestApi/resources/11.13.18.05/schedulerSetups/{SchedulerId}
Request
Path Parameters
-
SchedulerId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : schedulerSetups-item-response
Type:
Show Source
object
-
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : schedulerSetups-schedulerDetails-item-response
Type:
Show Source
object
-
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ScheduleTypeCodeLOV
-
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
- finder:
- SchedulerOccurrenceTypeCodeLOV
-
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
- finder:
- SchedulerTimeZoneCodeLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: SchedulerTimeZoneCode; Target Attribute: TimezoneCode
- Display Attribute: TimezoneCode
- 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. - SchedulerId: