Jump to

• Request
• Response

Update a scheduler filter

patch

/crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerFilters/{SchedulerFilterId}

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=
• SchedulerFilterId(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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "AllowReleaseFlag":{
            "title":"Allow Agent to Release Filter",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the agent can release the filter when viewing the scheduler results.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FilterOrder":{
            "title":"Filter Order",
            "type":"integer",
            "description":"Identifies the order of this scheduler filter that needs to be applied.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FsResourceField":{
            "title":"Field Service Resource",
            "maxLength":64,
            "type":"string",
            "description":"The field service resource from Oracle Field Service.",
            "nullable":false
        },
        "WoField":{
            "title":"Filter Field Name",
            "maxLength":30,
            "type":"string",
            "description":"The filter type for this filter.",
            "nullable":true
        },
        "WoFieldType":{
            "title":"Field Type",
            "maxLength":64,
            "type":"string",
            "description":"The work order field type on which the filter is to be applied.",
            "nullable":false
        },
        "WoFieldValue":{
            "title":"Field Value",
            "maxLength":64,
            "type":"string",
            "description":"The work order field value on which the filter is to be applied.",
            "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:
  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 : fieldServiceSchedulers-schedulerFilters-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AllowReleaseFlag":{
            "title":"Allow Agent to Release Filter",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the agent can release the filter when viewing the scheduler results.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the scheduler filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of creating the scheduler filter.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FilterOrder":{
            "title":"Filter Order",
            "type":"integer",
            "description":"Identifies the order of this scheduler filter that needs to be applied.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FsResourceField":{
            "title":"Field Service Resource",
            "maxLength":64,
            "type":"string",
            "description":"The field service resource from Oracle Field Service.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the scheduler was last 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 scheduler filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SchedulerCd":{
            "title":"Scheduler Code",
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the scheduler.",
            "nullable":false,
            "x-queryable":true
        },
        "SchedulerFilterCd":{
            "title":"Scheduler Filter Code",
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the filter associated to the scheduler.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SchedulerFilterId":{
            "title":"Scheduler Filter ID",
            "type":"integer",
            "description":"The unique identifier of the scheduler filter.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WoField":{
            "title":"Filter Field Name",
            "maxLength":30,
            "type":"string",
            "description":"The filter type for this filter.",
            "nullable":true,
            "x-queryable":true
        },
        "WoFieldLabel":{
            "title":"Field Label",
            "type":"string",
            "description":"The work order field label on which the filter is to be applied.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WoFieldType":{
            "title":"Field Type",
            "maxLength":64,
            "type":"string",
            "description":"The work order field type on which the filter is to be applied.",
            "nullable":false,
            "x-queryable":true
        },
        "WoFieldValue":{
            "title":"Field Value",
            "maxLength":64,
            "type":"string",
            "description":"The work order field value on which the filter is to be applied.",
            "nullable":false,
            "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."
        }
    }
}

Back to Top