Jump to

• Request
• Response

Create a scheduler

post

/crmRestApi/resources/11.13.18.05/fieldServiceSchedulers

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: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  Indicates whether the scheduler is active.
• ConnectionCd(required): string
  Title: Connection Code

  Maximum Length: 30

  Value that uniquely identifies the field service connection associated to this scheduler.
• CurrentDayBuffer: integer (int64)
  Title: Current Day Buffer

  The buffer in minutes for the scheduler current day.
• Description: string
  Title: Description

  Maximum Length: 240

  The description for the scheduler.
• EnforcePreferredTechFlag: boolean
  Title: Enable Preferred Technician

  Maximum Length: 1

  Default Value: false

  Indicates whether the preferred technician tags should be enforced on the scheduler.
• HighQuotaCutoff: integer (int64)
  Title: High Quota Cutoff

  The cutoff for high quota.
• LowQuotaCutoff: integer (int64)
  Title: Low Quota Cutoff

  The cutoff for low quota.
• SchedulerCd(required): string
  Title: Scheduler Code

  Maximum Length: 30

  Value that uniquely identifies the alternate unique identifier for the scheduler.
• schedulerFilters: array Scheduler Filters
  Title: Scheduler Filters

  Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time.
• SchedulerName(required): string
  Title: Scheduler Name

  Maximum Length: 80

  The user defined name for the scheduler.
• SchedulerOrder: integer (int64)
  Title: Order

  The order of the scheduler.
• schedulerRoles: array Scheduler Roles
  Title: Scheduler Roles

  Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order.
• SchedulerTypeCd(required): string
  Title: Scheduler Type

  Maximum Length: 30

  The code that identifies the type of scheduler.
• translations: array Scheduler Translations
  Title: Scheduler Translations

  Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler.
• WeekStartDayCd(required): string
  Title: Scheduler Start of Week

  Maximum Length: 30

  The code that identifies the week start day used for the scheduler.

{
    "required":[
        "ConnectionCd",
        "SchedulerCd",
        "SchedulerName",
        "SchedulerTypeCd",
        "WeekStartDayCd"
    ],
    "type":"object",
    "properties":{
        "schedulerFilters":{
            "title":"Scheduler Filters",
            "type":"array",
            "description":"Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time.",
            "items":{
                "$ref":"#/components/schemas/fieldServiceSchedulers-schedulerFilters-item-post-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description for the scheduler.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "LowQuotaCutoff":{
            "title":"Low Quota Cutoff",
            "type":"integer",
            "description":"The cutoff for low quota.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SchedulerTypeCd":{
            "title":"Scheduler Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the type of scheduler.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrentDayBuffer":{
            "title":"Current Day Buffer",
            "type":"integer",
            "description":"The buffer in minutes for the scheduler current day.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SchedulerOrder":{
            "title":"Order",
            "type":"integer",
            "description":"The order of the scheduler.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "HighQuotaCutoff":{
            "title":"High Quota Cutoff",
            "type":"integer",
            "description":"The cutoff for high quota.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "WeekStartDayCd":{
            "title":"Scheduler Start of Week",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the week start day used for the scheduler.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the scheduler is active.",
            "nullable":false,
            "default":false
        },
        "EnforcePreferredTechFlag":{
            "title":"Enable Preferred Technician",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the preferred technician tags should be enforced on the scheduler.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SchedulerCd":{
            "title":"Scheduler Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the alternate unique identifier for the scheduler.",
            "nullable":false
        },
        "ConnectionCd":{
            "title":"Connection Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the field service connection associated to this scheduler.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "translations":{
            "title":"Scheduler Translations",
            "type":"array",
            "description":"Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler.",
            "items":{
                "$ref":"#/components/schemas/fieldServiceSchedulers-translations-item-post-request"
            }
        },
        "schedulerRoles":{
            "title":"Scheduler Roles",
            "type":"array",
            "description":"Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order.",
            "items":{
                "$ref":"#/components/schemas/fieldServiceSchedulers-schedulerRoles-item-post-request"
            }
        },
        "SchedulerName":{
            "title":"Scheduler Name",
            "maxLength":"80",
            "type":"string",
            "description":"The user defined name for the scheduler.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        }
    }
}

Nested Schema : Scheduler Filters

Type: array

Title: Scheduler Filters

Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time.

Show Source

• Array of: object fieldServiceSchedulers-schedulerFilters-item-post-request

{
    "title":"Scheduler Filters",
    "type":"array",
    "description":"Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time.",
    "items":{
        "$ref":"#/components/schemas/fieldServiceSchedulers-schedulerFilters-item-post-request"
    }
}

Nested Schema : Scheduler Roles

Type: array

Title: Scheduler Roles

Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order.

Show Source

• Array of: object fieldServiceSchedulers-schedulerRoles-item-post-request

{
    "title":"Scheduler Roles",
    "type":"array",
    "description":"Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order.",
    "items":{
        "$ref":"#/components/schemas/fieldServiceSchedulers-schedulerRoles-item-post-request"
    }
}

Nested Schema : Scheduler Translations

Type: array

Title: Scheduler Translations

Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler.

Show Source

• Array of: object fieldServiceSchedulers-translations-item-post-request

{
    "title":"Scheduler Translations",
    "type":"array",
    "description":"Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler.",
    "items":{
        "$ref":"#/components/schemas/fieldServiceSchedulers-translations-item-post-request"
    }
}

Nested Schema : fieldServiceSchedulers-schedulerFilters-item-post-request

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

{
    "type":"object",
    "properties":{
        "WoFieldType":{
            "title":"Field Type",
            "maxLength":"64",
            "type":"string",
            "description":"The work order field type on which the filter is to be applied.",
            "nullable":false
        },
        "WoField":{
            "title":"Filter Field Name",
            "maxLength":"30",
            "type":"string",
            "description":"The filter type for this filter.",
            "nullable":true
        },
        "FsResourceField":{
            "title":"Field Service Resource",
            "maxLength":"64",
            "type":"string",
            "description":"The field service resource from Oracle Field Service.",
            "nullable":false
        },
        "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"
            }
        },
        "SchedulerCd":{
            "title":"Scheduler Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the scheduler.",
            "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
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

Nested Schema : fieldServiceSchedulers-schedulerRoles-item-post-request

Type: object

Show Source

• RoleCommonName: string
  Title: Role Common Name

  Maximum Length: 4000

  The role common name defined within LDAP.
• RoleGUID: string
  Title: Role GUID

  Maximum Length: 64

  The unique identifier of the role.
• SchedulerCd: string
  Title: Scheduler Code

  Maximum Length: 30

  Value that uniquely identifies the scheduler.

{
    "type":"object",
    "properties":{
        "RoleCommonName":{
            "title":"Role Common Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The role common name defined within LDAP.",
            "nullable":false
        },
        "SchedulerCd":{
            "title":"Scheduler Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the scheduler.",
            "nullable":false
        },
        "RoleGUID":{
            "title":"Role GUID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the role.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Display"
            }
        }
    }
}

Nested Schema : fieldServiceSchedulers-translations-item-post-request

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 240

  The description for the scheduler.
• Language: string
  Title: Language

  Maximum Length: 4

  The warning message to display when an agent selects a time slot on a holiday.
• SchedulerName: string
  Title: Scheduler Name

  Maximum Length: 80

  The name for the scheduler.
• SourceLang: string
  Title: Source Language

  Maximum Length: 4

  The source language code from which the scheduler is translated.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description for the scheduler.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "Language":{
            "title":"Language",
            "maxLength":"4",
            "type":"string",
            "description":"The warning message to display when an agent selects a time slot on a holiday.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "SchedulerName":{
            "title":"Scheduler Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name for the scheduler.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "SourceLang":{
            "title":"Source Language",
            "maxLength":"4",
            "type":"string",
            "description":"The source language code from which the scheduler is translated.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"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-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  Indicates whether the scheduler is active.
• AssignedRoleDisp: string
  Title: Roles

  Read Only: true

  A comma delimited list of roles assigned to the scheduler.
• ConnectionCd: string
  Title: Connection Code

  Maximum Length: 30

  Value that uniquely identifies the field service connection associated to this scheduler.
• ConnnectionName: string
  Title: Connection Name

  Read Only: true

  Maximum Length: 80

  The user defined name for the field service connection associated to this scheduler.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the scheduler.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time of creating the scheduler.
• CurrentDayBuffer: integer (int64)
  Title: Current Day Buffer

  The buffer in minutes for the scheduler current day.
• Description: string
  Title: Description

  Maximum Length: 240

  The description for the scheduler.
• EnforcePreferredTechFlag: boolean
  Title: Enable Preferred Technician

  Maximum Length: 1

  Default Value: false

  Indicates whether the preferred technician tags should be enforced on the scheduler.
• HighQuotaCutoff: integer (int64)
  Title: High Quota Cutoff

  The cutoff for high quota.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Indicates the date and time of last update for the scheduler.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the scheduler.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LowQuotaCutoff: integer (int64)
  Title: Low Quota Cutoff

  The cutoff for low quota.
• SchedulerCd: string
  Title: Scheduler Code

  Maximum Length: 30

  Value that uniquely identifies the alternate unique identifier for the scheduler.
• schedulerFilters: array Scheduler Filters
  Title: Scheduler Filters

  Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time.
• SchedulerId: integer (int64)
  Title: Scheduler ID

  Read Only: true

  The unique identifier of the scheduler.
• SchedulerName: string
  Title: Scheduler Name

  Maximum Length: 80

  The user defined name for the scheduler.
• SchedulerOrder: integer (int64)
  Title: Order

  The order of the scheduler.
• schedulerRoles: array Scheduler Roles
  Title: Scheduler Roles

  Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order.
• SchedulerTypeCd: string
  Title: Scheduler Type

  Maximum Length: 30

  The code that identifies the type of scheduler.
• SchedulerTypeDisp: string
  Title: Scheduler Type

  Read Only: true

  Maximum Length: 80

  The name of the scheduler type selected for this scheduler.
• translations: array Scheduler Translations
  Title: Scheduler Translations

  Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler.
• WeekStartDayCd: string
  Title: Scheduler Start of Week

  Maximum Length: 30

  The code that identifies the week start day used for the scheduler.
• WeekStartDayMeaning: string
  Title: Scheduler Start of Week

  Read Only: true

  Maximum Length: 255

  The start day of the week used for the scheduler.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of creating the scheduler.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description for the scheduler.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "SchedulerTypeDisp":{
            "title":"Scheduler Type",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the scheduler type selected for this scheduler.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HighQuotaCutoff":{
            "title":"High Quota Cutoff",
            "type":"integer",
            "description":"The cutoff for high quota.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WeekStartDayCd":{
            "title":"Scheduler Start of Week",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the week start day used for the scheduler.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnforcePreferredTechFlag":{
            "title":"Enable Preferred Technician",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the preferred technician tags should be enforced on the scheduler.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConnectionCd":{
            "title":"Connection Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the field service connection associated to this scheduler.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "translations":{
            "title":"Scheduler Translations",
            "type":"array",
            "description":"Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler.",
            "items":{
                "$ref":"#/components/schemas/fieldServiceSchedulers-translations-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssignedRoleDisp":{
            "title":"Roles",
            "type":"string",
            "description":"A comma delimited list of roles assigned to the scheduler.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SchedulerName":{
            "title":"Scheduler Name",
            "maxLength":"80",
            "type":"string",
            "description":"The user defined name for the scheduler.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the scheduler.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "schedulerFilters":{
            "title":"Scheduler Filters",
            "type":"array",
            "description":"Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time.",
            "items":{
                "$ref":"#/components/schemas/fieldServiceSchedulers-schedulerFilters-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the scheduler.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LowQuotaCutoff":{
            "title":"Low Quota Cutoff",
            "type":"integer",
            "description":"The cutoff for low quota.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SchedulerTypeCd":{
            "title":"Scheduler Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the type of scheduler.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrentDayBuffer":{
            "title":"Current Day Buffer",
            "type":"integer",
            "description":"The buffer in minutes for the scheduler current day.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SchedulerOrder":{
            "title":"Order",
            "type":"integer",
            "description":"The order of the scheduler.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the scheduler is active.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SchedulerCd":{
            "title":"Scheduler Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the alternate unique identifier for the scheduler.",
            "nullable":false,
            "x-queryable":true
        },
        "WeekStartDayMeaning":{
            "title":"Scheduler Start of Week",
            "maxLength":"255",
            "type":"string",
            "description":"The start day of the week used for the scheduler.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "WeekStartDayCd"
                ]
            }
        },
        "schedulerRoles":{
            "title":"Scheduler Roles",
            "type":"array",
            "description":"Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order.",
            "items":{
                "$ref":"#/components/schemas/fieldServiceSchedulers-schedulerRoles-item-response"
            }
        },
        "ConnnectionName":{
            "title":"Connection Name",
            "maxLength":"80",
            "type":"string",
            "description":"The user defined name for the field service connection associated to this scheduler.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ConnectionCd"
                ]
            },
            "x-queryable":true
        },
        "SchedulerId":{
            "title":"Scheduler ID",
            "type":"integer",
            "description":"The unique identifier of the scheduler.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time of last update for the scheduler.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 Filters

Type: array

Title: Scheduler Filters

Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time.

Show Source

• Array of: object fieldServiceSchedulers-schedulerFilters-item-response

{
    "title":"Scheduler Filters",
    "type":"array",
    "description":"Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time.",
    "items":{
        "$ref":"#/components/schemas/fieldServiceSchedulers-schedulerFilters-item-response"
    }
}

Nested Schema : Scheduler Roles

Type: array

Title: Scheduler Roles

Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order.

Show Source

• Array of: object fieldServiceSchedulers-schedulerRoles-item-response

{
    "title":"Scheduler Roles",
    "type":"array",
    "description":"Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order.",
    "items":{
        "$ref":"#/components/schemas/fieldServiceSchedulers-schedulerRoles-item-response"
    }
}

Nested Schema : Scheduler Translations

Type: array

Title: Scheduler Translations

Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler.

Show Source

• Array of: object fieldServiceSchedulers-translations-item-response

{
    "title":"Scheduler Translations",
    "type":"array",
    "description":"Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler.",
    "items":{
        "$ref":"#/components/schemas/fieldServiceSchedulers-translations-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 : 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":{
        "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
        },
        "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
        },
        "FsResourceField":{
            "title":"Field Service Resource",
            "maxLength":"64",
            "type":"string",
            "description":"The field service resource from Oracle Field Service.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "WoField":{
            "title":"Filter Field Name",
            "maxLength":"30",
            "type":"string",
            "description":"The filter type for this filter.",
            "nullable":true,
            "x-queryable":true
        },
        "SchedulerCd":{
            "title":"Scheduler Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the scheduler.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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 : fieldServiceSchedulers-schedulerRoles-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the scheduler role.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time of creating the scheduler role.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description for the role.
• JobRole: string
  Title: Job Role

  Read Only: true

  Maximum Length: 30

  The name of job role.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the scheduler role was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the scheduler role.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RoleCommonName: string
  Title: Role Common Name

  Maximum Length: 4000

  The role common name defined within LDAP.
• RoleGUID: string
  Title: Role GUID

  Maximum Length: 64

  The unique identifier of the role.
• RoleName: string
  Title: Role Name

  Read Only: true

  Maximum Length: 240

  The name of the role being used for this scheduler.
• SchedulerCd: string
  Title: Scheduler Code

  Maximum Length: 30

  Value that uniquely identifies the scheduler.
• SchedulerRoleId: integer (int64)
  Title: Scheduler Role ID

  Read Only: true

  The unique identifier of the scheduler role.

{
    "type":"object",
    "properties":{
        "JobRole":{
            "title":"Job Role",
            "maxLength":"30",
            "type":"string",
            "description":"The name of job role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the scheduler role.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of creating the scheduler role.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the role being used for this scheduler.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description for the role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the scheduler role.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RoleCommonName":{
            "title":"Role Common Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The role common name defined within LDAP.",
            "nullable":false,
            "x-queryable":true
        },
        "SchedulerCd":{
            "title":"Scheduler Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the scheduler.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SchedulerRoleId":{
            "title":"Scheduler Role ID",
            "type":"integer",
            "description":"The unique identifier of the scheduler role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the scheduler role was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RoleGUID":{
            "title":"Role GUID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the role.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Display"
            },
            "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 : fieldServiceSchedulers-translations-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 240

  The description for the scheduler.
• DisplayLanguage: string
  Title: Language Name

  Read Only: true

  Maximum Length: 255

  The language to which the scheduler is translated.
• DisplaySourceLanguage: string
  Title: Source Language

  Read Only: true

  Maximum Length: 255

  The source language from which the scheduler is translated.
• Language: string
  Title: Language

  Maximum Length: 4

  The warning message to display when an agent selects a time slot on a holiday.
• links: array Links
  Title: Links

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

  Maximum Length: 80

  The name for the scheduler.
• SourceLang: string
  Title: Source Language

  Maximum Length: 4

  The source language code from which the scheduler is translated.

{
    "type":"object",
    "properties":{
        "DisplayLanguage":{
            "title":"Language Name",
            "maxLength":"255",
            "type":"string",
            "description":"The language to which the scheduler is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySourceLanguage":{
            "title":"Source Language",
            "maxLength":"255",
            "type":"string",
            "description":"The source language from which the scheduler is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description for the scheduler.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "Language":{
            "title":"Language",
            "maxLength":"4",
            "type":"string",
            "description":"The warning message to display when an agent selects a time slot on a holiday.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "SourceLang":{
            "title":"Source Language",
            "maxLength":"4",
            "type":"string",
            "description":"The source language code from which the scheduler is translated.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SchedulerName":{
            "title":"Scheduler Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name for the scheduler.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "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

schedulerFilters

Operation: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerFilters

Parameters:

• SchedulerCd: $request.path.SchedulerCd

Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time.

schedulerRoles

Operation: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerRoles

Parameters:

• SchedulerCd: $request.path.SchedulerCd

Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order.

translations

Operation: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/translations

Parameters:

• SchedulerCd: $request.path.SchedulerCd

Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler.

Back to Top