Create a scheduler filter
post
/crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerFilters
Request
Path Parameters
-
SchedulerCd(required): string
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
Root Schema : schema
Type:
Show Source
object
-
AllowReleaseFlag: boolean
Title:
Allow Agent to Release Filter
Maximum Length:1
Indicates whether the agent can release the filter when viewing the scheduler results. -
FilterOrder: integer
(int64)
Title:
Filter Order
Identifies the order of this scheduler filter that needs to be applied. -
FsResourceField: string
Title:
Field Service Resource
Maximum Length:64
The field service resource from Oracle Field Service. -
SchedulerCd: string
Title:
Scheduler Code
Maximum Length:30
Value that uniquely identifies the scheduler. -
SchedulerFilterCd: string
Title:
Scheduler Filter Code
Maximum Length:30
Value that uniquely identifies the filter associated to the scheduler. -
WoField: string
Title:
Filter Field Name
Maximum Length:30
The filter type for this filter. -
WoFieldType: string
Title:
Field Type
Maximum Length:64
The work order field type on which the filter is to be applied. -
WoFieldValue: string
Title:
Field Value
Maximum Length:64
The work order field value on which the filter is to be applied.
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.
Root Schema : fieldServiceSchedulers-schedulerFilters-item-response
Type:
Show Source
object
-
AllowReleaseFlag: boolean
Title:
Allow Agent to Release Filter
Maximum Length:1
Indicates whether the agent can release the filter when viewing the scheduler results. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the scheduler filter. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of creating the scheduler filter. -
FilterOrder: integer
(int64)
Title:
Filter Order
Identifies the order of this scheduler filter that needs to be applied. -
FsResourceField: string
Title:
Field Service Resource
Maximum Length:64
The field service resource from Oracle Field Service. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the scheduler was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the scheduler filter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SchedulerCd: string
Title:
Scheduler Code
Maximum Length:30
Value that uniquely identifies the scheduler. -
SchedulerFilterCd: string
Title:
Scheduler Filter Code
Maximum Length:30
Value that uniquely identifies the filter associated to the scheduler. -
SchedulerFilterId: integer
(int64)
Title:
Scheduler Filter ID
Read Only:true
The unique identifier of the scheduler filter. -
WoField: string
Title:
Filter Field Name
Maximum Length:30
The filter type for this filter. -
WoFieldLabel: string
Title:
Field Label
Read Only:true
The work order field label on which the filter is to be applied. -
WoFieldType: string
Title:
Field Type
Maximum Length:64
The work order field type on which the filter is to be applied. -
WoFieldValue: string
Title:
Field Value
Maximum Length:64
The work order field value on which the filter is to be applied.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.