Jump to

• Request
• Response

Update a production calendar shift exception

patch

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

Request

Path Parameters

• PlantShiftExceptionId(required): integer(int64)
  Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssociatedShiftId: integer (int64)
  Title: Associated Shift

  Value that uniquely identifies the shift that the exception will be applied to.
• AssociatedShiftName: string
  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.
• EndDate: string (date)
  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".
• ExceptionDuration: number
  Duration in Hours for the shift exception. This value is required.
• ExceptionDurationInMs: integer (int64)
  Duration in microseconds for the shift exception.
• ExceptionEndTime: string
  Maximum Length: 255

  Time when the shift exception ends. It's derived from the start time and duration and isn't input.
• ExceptionEndTimeInMs: integer (int64)
  Time when the shift exception ends as measured in microseconds after midnight.
• ExceptionStartTime: string
  Maximum Length: 255

  Time when the shift exception starts. This value is required. It must be formatted as "HH:MM AM|PM".
• ExceptionStartTimeInMs: integer (int64)
  Time when the shift exception starts as measured in microseconds after midnight.
• ExceptionType: string
  Maximum Length: 255

  Specifies the type of shift exception being created. Valid values are Change Shift, Remove Shift, Split Shift, and Add Shift.
• ExceptionTypeCode: string
  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.
• Name: string
  Title: Name

  Maximum Length: 120

  User-supplied name for the shift exception. This value is required.
• OrganizationCode: string
  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.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's the plant.
• OrganizationName: string
  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.
• PlantShiftExceptionId: integer (int64)
  Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.
• Reason: string
  Title: Reason

  Maximum Length: 1000

  User-supplied reason for the shift exception.
• resourceAvailabilityOverrides: array 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.
• ScheduleId: integer (int64)
  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.
• ScheduleName: string
  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.
• StartDate: string (date)
  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".
• WorkCenterCode: string
  Maximum Length: 255

  User-supplied value that uniquely identifies the work center with override calendars being chosen for an exception.
• WorkCenterId: integer (int64)
  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.
• WorkCenterName: string
  Maximum Length: 255

  Name that uniquely identifes the work center with override calendars being chosen for an exception.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"User-supplied name that identifies the organization. It's used if neither the OrganizationId nor OrganizationCode attributes are provided in the request.",
            "nullable":true
        },
        "ExceptionType":{
            "maxLength":255,
            "type":"string",
            "description":"Specifies the type of shift exception being created. Valid values are Change Shift, Remove Shift, Split Shift, and Add Shift.",
            "nullable":true
        },
        "WorkCenterName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifes the work center with override calendars being chosen for an exception.",
            "nullable":true
        },
        "ExceptionDuration":{
            "type":"number",
            "description":"Duration in Hours for the shift exception. This value is required.",
            "nullable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "resourceAvailabilityOverrides":{
            "title":"Resource Availability Overrides",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/productionCalendarShiftExceptions-resourceAvailabilityOverrides-item-patch-request"
            }
        },
        "ExceptionEndTime":{
            "maxLength":255,
            "type":"string",
            "description":"Time when the shift exception ends. It's derived from the start time and duration and isn't input.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's the plant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ScheduleId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "title":"Repeats Until",
            "type":"string",
            "description":"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\".",
            "format":"date",
            "nullable":false
        },
        "Reason":{
            "title":"Reason",
            "maxLength":1000,
            "type":"string",
            "description":"User-supplied reason for the shift exception.",
            "nullable":true
        },
        "ScheduleName":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ScheduleId"
                ]
            }
        },
        "AssociatedShiftName":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ExceptionStartTime":{
            "maxLength":255,
            "type":"string",
            "description":"Time when the shift exception starts. This value is required. It must be formatted as \"HH:MM AM|PM\".",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"User-supplied name for the shift exception. This value is required.",
            "nullable":false
        },
        "StartDate":{
            "title":"Exception Date",
            "type":"string",
            "description":"Date when the shift exception starts. This value is required. The value must be in the ISO8601 format such as \"YYYY-MM-DD\".",
            "format":"date",
            "nullable":false
        },
        "ExceptionEndTimeInMs":{
            "type":"integer",
            "description":"Time when the shift exception ends as measured in microseconds after midnight.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ExceptionDurationInMs",
                    "ExceptionStartTimeInMs"
                ]
            }
        },
        "AssociatedShiftId":{
            "title":"Associated Shift",
            "type":"integer",
            "description":"Value that uniquely identifies the shift that the exception will be applied to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExceptionTypeCode":{
            "title":"Exception Type",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the code for the type of shift exception being created. This value is required. Valid values are ChangeShift, RemoveShift, SplitShift, and AddShift.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"User-supplied short code that uniquely identifies the organization. It's used if the OrganizationId attribute is not provided in the request.",
            "nullable":true
        },
        "PlantShiftExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExceptionStartTimeInMs":{
            "type":"integer",
            "description":"Time when the shift exception starts as measured in microseconds after midnight.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkCenterCode":{
            "maxLength":255,
            "type":"string",
            "description":"User-supplied value that uniquely identifies the work center with override calendars being chosen for an exception.",
            "nullable":true
        },
        "ExceptionDurationInMs":{
            "type":"integer",
            "description":"Duration in microseconds for the shift exception.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

• Array of: object productionCalendarShiftExceptions-resourceAvailabilityOverrides-item-patch-request

{
    "title":"Resource Availability Overrides",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/productionCalendarShiftExceptions-resourceAvailabilityOverrides-item-patch-request"
    }
}

Nested Schema : productionCalendarShiftExceptions-resourceAvailabilityOverrides-item-patch-request

Type: object

Show Source

• AvailabilityOverride: number
  Value of the override quantity. This replaces the default units available for a given resource for the time interval defined by the exception. This value is required.
• DefaultAvailability: integer (int64)
  Value of the resource availability.
• ExceptionDuration: integer (int64)
  Duration in Hours for the work center resource exception. This value is required.
• ExceptionEndTimeInMs: integer (int64)
  Title: End Time

  Time in microseconds from midnight when the work center resource exception ends.
• ExceptionStartTime: string
  Maximum Length: 255

  Time when the work center resource exception starts. This value is required. It must be formatted as "HH:MM AM|PM".
• ExceptionStartTimeInMs: integer (int64)
  Title: Start Time

  Time in microseconds from midnight when the work center resource exception starts.
• PlantShiftExceptionId: integer (int64)
  Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource being updated. This value is required.
• ResourceName: string
  Maximum Length: 255

  Name that uniquely identifies the resource. It's used if the ResourceId isn't provided in the request.
• WorkCenterCode: string
  Maximum Length: 255

  User-supplied value that uniquely identifies the work center associated with the resource. It's used if the WorkCenterId isn't provided in the request.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center associated with the resource. This value is required.
• WorkCenterName: string
  Maximum Length: 255

  Name that uniquely identifies the work center. It's used if the WorkCenterCode isn't provided in the request.
• WorkCenterResourceExceptionDetailId: integer (int64)
  Value that uniquely identifies the resource availability override. The application generates this value when it creates the exception for the resource.
• WorkCenterResourceExceptionId: integer (int64)
  Value that uniquely identifies the work center resource exception in the production calendar of a plant. The application generates this value when it creates the exception.

{
    "type":"object",
    "properties":{
        "WorkCenterName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the work center. It's used if the WorkCenterCode isn't provided in the request.",
            "nullable":true
        },
        "ExceptionDuration":{
            "type":"integer",
            "description":"Duration in Hours for the work center resource exception. This value is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            }
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center associated with the resource. This value is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the resource. It's used if the ResourceId isn't provided in the request.",
            "nullable":true
        },
        "WorkCenterResourceExceptionDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource availability override. The application generates this value when it creates the exception for the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DefaultAvailability":{
            "type":"integer",
            "description":"Value of the resource availability.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            }
        },
        "ExceptionStartTime":{
            "maxLength":255,
            "type":"string",
            "description":"Time when the work center resource exception starts. This value is required. It must be formatted as \"HH:MM AM|PM\".",
            "nullable":true
        },
        "AvailabilityOverride":{
            "type":"number",
            "description":"Value of the override quantity. This replaces the default units available for a given resource for the time interval defined by the exception. This value is required. ",
            "nullable":false
        },
        "ExceptionEndTimeInMs":{
            "title":"End Time",
            "type":"integer",
            "description":"Time in microseconds from midnight when the work center resource exception ends.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource being updated. This value is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkCenterResourceExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center resource exception in the production calendar of a plant. The application generates this value when it creates the exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PlantShiftExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExceptionStartTimeInMs":{
            "title":"Start Time",
            "type":"integer",
            "description":"Time in microseconds from midnight when the work center resource exception starts.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkCenterCode":{
            "maxLength":255,
            "type":"string",
            "description":"User-supplied value that uniquely identifies the work center associated with the resource. It's used if the WorkCenterId isn't provided in the request.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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

• AssociatedShiftId: integer (int64)
  Title: Associated Shift

  Value that uniquely identifies the shift that the exception will be applied to.
• AssociatedShiftName: string
  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.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• EndDate: string (date)
  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".
• ExceptionDuration: number
  Duration in Hours for the shift exception. This value is required.
• ExceptionDurationInMs: integer (int64)
  Duration in microseconds for the shift exception.
• ExceptionEndTime: string
  Maximum Length: 255

  Time when the shift exception ends. It's derived from the start time and duration and isn't input.
• ExceptionEndTimeInMs: integer (int64)
  Time when the shift exception ends as measured in microseconds after midnight.
• ExceptionStartTime: string
  Maximum Length: 255

  Time when the shift exception starts. This value is required. It must be formatted as "HH:MM AM|PM".
• ExceptionStartTimeInMs: integer (int64)
  Time when the shift exception starts as measured in microseconds after midnight.
• ExceptionType: string
  Maximum Length: 255

  Specifies the type of shift exception being created. Valid values are Change Shift, Remove Shift, Split Shift, and Add Shift.
• ExceptionTypeCode: string
  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.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  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: 120

  User-supplied name for the shift exception. This value is required.
• OrganizationCode: string
  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.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's the plant.
• OrganizationName: string
  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.
• PlantShiftExceptionId: integer (int64)
  Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.
• Reason: string
  Title: Reason

  Maximum Length: 1000

  User-supplied reason for the shift exception.
• resourceAvailabilityOverrides: array 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.
• ScheduleId: integer (int64)
  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.
• ScheduleName: string
  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.
• StartDate: string (date)
  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".
• WorkCenterCode: string
  Maximum Length: 255

  User-supplied value that uniquely identifies the work center with override calendars being chosen for an exception.
• WorkCenterId: integer (int64)
  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.
• WorkCenterName: string
  Maximum Length: 255

  Name that uniquely identifes the work center with override calendars being chosen for an exception.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"User-supplied name that identifies the organization. It's used if neither the OrganizationId nor OrganizationCode attributes are provided in the request.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionType":{
            "maxLength":255,
            "type":"string",
            "description":"Specifies the type of shift exception being created. Valid values are Change Shift, Remove Shift, Split Shift, and Add Shift.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "resourceAvailabilityOverrides":{
            "title":"Resource Availability Overrides",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/productionCalendarShiftExceptions-resourceAvailabilityOverrides-item-response"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's the plant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason",
            "maxLength":1000,
            "type":"string",
            "description":"User-supplied reason for the shift exception.",
            "nullable":true,
            "x-queryable":true
        },
        "AssociatedShiftName":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionStartTime":{
            "maxLength":255,
            "type":"string",
            "description":"Time when the shift exception starts. This value is required. It must be formatted as \"HH:MM AM|PM\".",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"User-supplied name for the shift exception. This value is required.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Exception Date",
            "type":"string",
            "description":"Date when the shift exception starts. This value is required. The value must be in the ISO8601 format such as \"YYYY-MM-DD\".",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ExceptionEndTimeInMs":{
            "type":"integer",
            "description":"Time when the shift exception ends as measured in microseconds after midnight.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ExceptionDurationInMs",
                    "ExceptionStartTimeInMs"
                ]
            },
            "x-queryable":true
        },
        "AssociatedShiftId":{
            "title":"Associated Shift",
            "type":"integer",
            "description":"Value that uniquely identifies the shift that the exception will be applied to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"User-supplied short code that uniquely identifies the organization. It's used if the OrganizationId attribute is not provided in the request.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExceptionStartTimeInMs":{
            "type":"integer",
            "description":"Time when the shift exception starts as measured in microseconds after midnight.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":255,
            "type":"string",
            "description":"User-supplied value that uniquely identifies the work center with override calendars being chosen for an exception.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifes the work center with override calendars being chosen for an exception.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionDuration":{
            "type":"number",
            "description":"Duration in Hours for the shift exception. This value is required.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionEndTime":{
            "maxLength":255,
            "type":"string",
            "description":"Time when the shift exception ends. It's derived from the start time and duration and isn't input.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"Repeats Until",
            "type":"string",
            "description":"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\".",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ScheduleName":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ScheduleId"
                ]
            },
            "x-queryable":true
        },
        "ExceptionTypeCode":{
            "title":"Exception Type",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the code for the type of shift exception being created. This value is required. Valid values are ChangeShift, RemoveShift, SplitShift, and AddShift.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlantShiftExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionDurationInMs":{
            "type":"integer",
            "description":"Duration in microseconds for the shift exception.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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 : 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

• Array of: object productionCalendarShiftExceptions-resourceAvailabilityOverrides-item-response

{
    "title":"Resource Availability Overrides",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/productionCalendarShiftExceptions-resourceAvailabilityOverrides-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 : productionCalendarShiftExceptions-resourceAvailabilityOverrides-item-response

Type: object

Show Source

• AvailabilityOverride: number
  Value of the override quantity. This replaces the default units available for a given resource for the time interval defined by the exception. This value is required.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• DefaultAvailability: integer (int64)
  Value of the resource availability.
• ExceptionDuration: integer (int64)
  Duration in Hours for the work center resource exception. This value is required.
• ExceptionEndTime: string
  Read Only: true

  Maximum Length: 255

  Time when the work center resource exception ends. It's derived from the start time and duration and isn't input.
• ExceptionEndTimeInMs: integer (int64)
  Title: End Time

  Time in microseconds from midnight when the work center resource exception ends.
• ExceptionStartTime: string
  Maximum Length: 255

  Time when the work center resource exception starts. This value is required. It must be formatted as "HH:MM AM|PM".
• ExceptionStartTimeInMs: integer (int64)
  Title: Start Time

  Time in microseconds from midnight when the work center resource exception starts.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  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.
• PlantShiftExceptionId: integer (int64)
  Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource being updated. This value is required.
• ResourceName: string
  Maximum Length: 255

  Name that uniquely identifies the resource. It's used if the ResourceId isn't provided in the request.
• WorkCenterCode: string
  Maximum Length: 255

  User-supplied value that uniquely identifies the work center associated with the resource. It's used if the WorkCenterId isn't provided in the request.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center associated with the resource. This value is required.
• WorkCenterName: string
  Maximum Length: 255

  Name that uniquely identifies the work center. It's used if the WorkCenterCode isn't provided in the request.
• WorkCenterResourceExceptionDetailId: integer (int64)
  Value that uniquely identifies the resource availability override. The application generates this value when it creates the exception for the resource.
• WorkCenterResourceExceptionId: integer (int64)
  Value that uniquely identifies the work center resource exception in the production calendar of a plant. The application generates this value when it creates the exception.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the work center. It's used if the WorkCenterCode isn't provided in the request.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionDuration":{
            "type":"integer",
            "description":"Duration in Hours for the work center resource exception. This value is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center associated with the resource. This value is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the resource. It's used if the ResourceId isn't provided in the request.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionEndTime":{
            "maxLength":255,
            "type":"string",
            "description":"Time when the work center resource exception ends. It's derived from the start time and duration and isn't input.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterResourceExceptionDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource availability override. The application generates this value when it creates the exception for the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DefaultAvailability":{
            "type":"integer",
            "description":"Value of the resource availability.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "ExceptionStartTime":{
            "maxLength":255,
            "type":"string",
            "description":"Time when the work center resource exception starts. This value is required. It must be formatted as \"HH:MM AM|PM\".",
            "nullable":true,
            "x-queryable":true
        },
        "AvailabilityOverride":{
            "type":"number",
            "description":"Value of the override quantity. This replaces the default units available for a given resource for the time interval defined by the exception. This value is required. ",
            "nullable":false,
            "x-queryable":true
        },
        "ExceptionEndTimeInMs":{
            "title":"End Time",
            "type":"integer",
            "description":"Time in microseconds from midnight when the work center resource exception ends.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource being updated. This value is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkCenterResourceExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center resource exception in the production calendar of a plant. The application generates this value when it creates the exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlantShiftExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionStartTimeInMs":{
            "title":"Start Time",
            "type":"integer",
            "description":"Time in microseconds from midnight when the work center resource exception starts.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":255,
            "type":"string",
            "description":"User-supplied value that uniquely identifies the work center associated with the resource. It's used if the WorkCenterId isn't provided in the request.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "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"
    }
}

Links

resourceAvailabilityOverrides

Operation: /fscmRestApi/resources/11.13.18.05/productionCalendarShiftExceptions/{PlantShiftExceptionId}/child/resourceAvailabilityOverrides

Parameters:

• PlantShiftExceptionId: $request.path.PlantShiftExceptionId

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.

Back to Top