Update a production calendar shift exception

patch

/fscmRestApi/resources/11.13.18.05/productionCalendarShiftExceptions/{PlantShiftExceptionId}

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Associated Shift
    Value that uniquely identifies the shift that the exception will be applied to.
  • Maximum Length: 255
    User-supplied name that identifies the shift that the exception will be applied to. It's used if the AssociatedShiftId isn't provided in the request.
  • Title: Repeats Until
    Date when the shift exception ends. This value is optional and defaults to the start date if it's not supplied. The value must be in the ISO8601 format such as "YYYY-MM-DD".
  • Duration in Hours for the shift exception. This value is required.
  • Duration in microseconds for the shift exception.
  • Maximum Length: 255
    Time when the shift exception ends. It's derived from the start time and duration and isn't input.
  • Time when the shift exception ends as measured in microseconds after midnight.
  • Maximum Length: 255
    Time when the shift exception starts. This value is required. It must be formatted as "HH:MM AM|PM".
  • Time when the shift exception starts as measured in microseconds after midnight.
  • Maximum Length: 255
    Specifies the type of shift exception being created. Valid values are Change Shift, Remove Shift, Split Shift, and Add Shift.
  • Title: Exception Type
    Maximum Length: 30
    Specifies the code for the type of shift exception being created. This value is required. Valid values are ChangeShift, RemoveShift, SplitShift, and AddShift.
  • Title: Name
    Maximum Length: 120
    User-supplied name for the shift exception. This value is required.
  • Maximum Length: 255
    User-supplied short code that uniquely identifies the organization. It's used if the OrganizationId attribute is not provided in the request.
  • Value that uniquely identifies the inventory organization that's the plant.
  • Maximum Length: 255
    User-supplied name that identifies the organization. It's used if neither the OrganizationId nor OrganizationCode attributes are provided in the request.
  • Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.
  • Title: Reason
    Maximum Length: 1000
    User-supplied reason for the shift exception.
  • Resource Availability Overrides
    Title: Resource Availability Overrides
    The Resource Availability Overrides resource gets the individual overrides to the availability of a work center resource assigned to the shift. It provides an optional ability to assign changes to resource availability specific to the shift exception time period.
  • Value that uniquely identifies the schedule that the organization references as the manufacturing or production calendar. It corresponds to the Manufacturing Calendar specified in the Manage Plant Parameters task for the inventory organization in the request.
  • Maximum Length: 255
    User-supplied name that identifies the schedule that the organization references as the manufacturing calendar. It's used if the ScheduleId is not provided in the request.
  • Title: Exception Date
    Date when the shift exception starts. This value is required. The value must be in the ISO8601 format such as "YYYY-MM-DD".
  • Maximum Length: 255
    User-supplied value that uniquely identifies the work center with override calendars being chosen for an exception.
  • Value that idenfies the work center when the exception being modeled is associated to a work center with override calendars, instead of to the full plant.
  • Maximum Length: 255
    Name that uniquely identifes the work center with override calendars being chosen for an exception.
Nested Schema : Resource Availability Overrides
Type: array
Title: Resource Availability Overrides
The Resource Availability Overrides resource gets the individual overrides to the availability of a work center resource assigned to the shift. It provides an optional ability to assign changes to resource availability specific to the shift exception time period.
Show Source
Nested Schema : productionCalendarShiftExceptions-resourceAvailabilityOverrides-item-patch-request
Type: object
Show Source
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 : productionCalendarShiftExceptions-item-response
Type: object
Show Source
  • Title: Associated Shift
    Value that uniquely identifies the shift that the exception will be applied to.
  • Maximum Length: 255
    User-supplied name that identifies the shift that the exception will be applied to. It's used if the AssociatedShiftId isn't provided in the request.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Title: Repeats Until
    Date when the shift exception ends. This value is optional and defaults to the start date if it's not supplied. The value must be in the ISO8601 format such as "YYYY-MM-DD".
  • Duration in Hours for the shift exception. This value is required.
  • Duration in microseconds for the shift exception.
  • Maximum Length: 255
    Time when the shift exception ends. It's derived from the start time and duration and isn't input.
  • Time when the shift exception ends as measured in microseconds after midnight.
  • Maximum Length: 255
    Time when the shift exception starts. This value is required. It must be formatted as "HH:MM AM|PM".
  • Time when the shift exception starts as measured in microseconds after midnight.
  • Maximum Length: 255
    Specifies the type of shift exception being created. Valid values are Change Shift, Remove Shift, Split Shift, and Add Shift.
  • Title: Exception Type
    Maximum Length: 30
    Specifies the code for the type of shift exception being created. This value is required. Valid values are ChangeShift, RemoveShift, SplitShift, and AddShift.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Title: Name
    Maximum Length: 120
    User-supplied name for the shift exception. This value is required.
  • Maximum Length: 255
    User-supplied short code that uniquely identifies the organization. It's used if the OrganizationId attribute is not provided in the request.
  • Value that uniquely identifies the inventory organization that's the plant.
  • Maximum Length: 255
    User-supplied name that identifies the organization. It's used if neither the OrganizationId nor OrganizationCode attributes are provided in the request.
  • Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.
  • Title: Reason
    Maximum Length: 1000
    User-supplied reason for the shift exception.
  • Resource Availability Overrides
    Title: Resource Availability Overrides
    The Resource Availability Overrides resource gets the individual overrides to the availability of a work center resource assigned to the shift. It provides an optional ability to assign changes to resource availability specific to the shift exception time period.
  • Value that uniquely identifies the schedule that the organization references as the manufacturing or production calendar. It corresponds to the Manufacturing Calendar specified in the Manage Plant Parameters task for the inventory organization in the request.
  • Maximum Length: 255
    User-supplied name that identifies the schedule that the organization references as the manufacturing calendar. It's used if the ScheduleId is not provided in the request.
  • Title: Exception Date
    Date when the shift exception starts. This value is required. The value must be in the ISO8601 format such as "YYYY-MM-DD".
  • Maximum Length: 255
    User-supplied value that uniquely identifies the work center with override calendars being chosen for an exception.
  • Value that idenfies the work center when the exception being modeled is associated to a work center with override calendars, instead of to the full plant.
  • Maximum Length: 255
    Name that uniquely identifes the work center with override calendars being chosen for an exception.
Nested Schema : Resource Availability Overrides
Type: array
Title: Resource Availability Overrides
The Resource Availability Overrides resource gets the individual overrides to the availability of a work center resource assigned to the shift. It provides an optional ability to assign changes to resource availability specific to the shift exception time period.
Show Source
Nested Schema : productionCalendarShiftExceptions-resourceAvailabilityOverrides-item-response
Type: object
Show Source
Back to Top