Update one schedule exception
patch
/fscmRestApi/resources/11.13.18.05/scheduleExceptions/{ExceptionId}
Request
Path Parameters
-
ExceptionId(required): integer(int64)
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.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AllDayFlag: boolean
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. -
CategoryCode: string
Title:
Category
Maximum Length:30
The abbreviation that identifies the category, such as Holiday and Training. -
Description: string
Title:
Description
Maximum Length:2000
The description of the exception that you provide when creating an instance. -
ExceptionEndDate: string
The date when the schedule no longer uses the exception.
-
ExceptionStartDate: string
The date when the schedule starts to use the exception.
-
Name: string
Title:
Name
Maximum Length:240
The name of the schedule exception that you provide when creating an instance. This attribute is required. -
PeriodTypeCode: string
Title:
Period Type
Maximum Length:30
The abbreviation that identifies the type of period, such as Off period and Work period. -
ShortCode: string
Title:
Code
Maximum Length:3
The abbreviation that identifies the exception that is displayed.
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 : scheduleExceptions-item-response
Type:
Show Source
object
-
AllDayFlag: boolean
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. -
CategoryCode: string
Title:
Category
Maximum Length:30
The abbreviation that identifies the category, such as Holiday and Training. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user created the record. -
Description: string
Title:
Description
Maximum Length:2000
The description of the exception that you provide when creating an instance. -
ExceptionEndDate: string
The date when the schedule no longer uses the exception.
-
ExceptionId: integer
(int64)
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. -
ExceptionStartDate: string
The date when the schedule starts to use the exception.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:240
The name of the schedule exception that you provide when creating an instance. This attribute is required. -
PeriodTypeCode: string
Title:
Period Type
Maximum Length:30
The abbreviation that identifies the type of period, such as Off period and Work period. -
ShortCode: string
Title:
Code
Maximum Length:3
The abbreviation that identifies the exception that is displayed.
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.