Create schedule exceptions

post

/fscmRestApi/resources/11.13.18.05/scheduleExceptions

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: All Day
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then the exception is for the entire day and the Exception Start and the Exception End values are dates. If false, then the exception is for a subset of hours within each day in the exception range and the Exception Start and the Exception End values include date and time values. The default value is false.
  • Title: Category
    Maximum Length: 30
    The abbreviation that identifies the category, such as Holiday and Training.
  • Title: Description
    Maximum Length: 2000
    The description of the exception that you provide when creating an instance.
  • The date when the schedule no longer uses the exception.
  • The date when the schedule starts to use the exception.
  • Title: Name
    Maximum Length: 240
    The name of the schedule exception that you provide when creating an instance. This attribute is required.
  • Title: Period Type
    Maximum Length: 30
    The abbreviation that identifies the type of period, such as Off period and Work period.
  • Title: Code
    Maximum Length: 3
    The abbreviation that identifies the exception that is displayed.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : scheduleExceptions-item-response
Type: object
Show Source
  • Title: All Day
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then the exception is for the entire day and the Exception Start and the Exception End values are dates. If false, then the exception is for a subset of hours within each day in the exception range and the Exception Start and the Exception End values include date and time values. The default value is false.
  • Title: Category
    Maximum Length: 30
    The abbreviation that identifies the category, such as Holiday and Training.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the record.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the record.
  • Title: Description
    Maximum Length: 2000
    The description of the exception that you provide when creating an instance.
  • The date when the schedule no longer uses the exception.
  • Read Only: true
    The value that uniquely identifies the schedule exception. It is a primary key that the application generates when it creates an exception. This attribute is required.
  • The date when the schedule starts to use the exception.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Title: Name
    Maximum Length: 240
    The name of the schedule exception that you provide when creating an instance. This attribute is required.
  • Title: Period Type
    Maximum Length: 30
    The abbreviation that identifies the type of period, such as Off period and Work period.
  • Title: Code
    Maximum Length: 3
    The abbreviation that identifies the exception that is displayed.
Back to Top