Create one work center resource exception
post
/fscmRestApi/resources/11.13.18.05/workCenterResourceExceptions
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
Root Schema : schema
Type:
Show Source
object
-
AssociatedShiftId: integer
(int64)
Value that uniquely identifies the shift that the exception will be applied to. This value is optional.
-
AssociatedShiftName: string
Maximum Length:
255
User-supplied name that identifies the shift that the exception will be applied to. It is used if the AssociatedShiftId is not provided in the request. -
EndDate(required): string
(date)
Title:
Repeats Until
Date when the work center resource 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
Title:
Duration
Duration in Hours for the work center resource exception. This value is required. -
ExceptionEndTime: string
Title:
End Time
Maximum Length:255
Time when the work center resource exception ends. It is derived from the start time and duration, and is not input. -
ExceptionEndTimeInMs(required): integer
(int64)
Title:
End Time
Time in microseconds from midnight when the work center resource exception ends. -
ExceptionStartTime: string
Title:
Start Time
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(required): integer
(int64)
Title:
Start Time
Time in microseconds from midnight when the work center resource exception starts. -
OrganizationCode: string
Maximum Length:
255
User-supplied short code that uniquely identifies the organization. It is used if the OrganizationId attribute is not provided in the request. -
OrganizationId(required): 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 is used if neither the OrganizationId nor the OrganizationCode attributes are provided in the request. -
resourceAvailabilityOverrides: array
Resource Availability Overrides
Title:
Resource Availability Overrides
The Resource Availability Overrides resource defines changes to the available units of a work center resource assigned to a manufacturing or maintenance plant. -
ScheduleId(required): 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 is used if the ScheduleId is not provided in the request. -
StartDate(required): string
(date)
Title:
Exception Date
Date when the work center resource exception starts. This value is required. The value must be in the ISO8601 format such as "YYYY-MM-DD". -
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.
Nested Schema : Resource Availability Overrides
Type:
array
Title:
Resource Availability Overrides
The Resource Availability Overrides resource defines changes to the available units of a work center resource assigned to a manufacturing or maintenance plant.
Show Source
Nested Schema : workCenterResourceExceptions-resourceAvailabilityOverrides-item-post-request
Type:
Show Source
object
-
AvailabilityOverride: number
Override quantity value. It replaces the default units available for a given resource for the time interval defined by the exception. This value is required.
-
DefaultAvailability: integer
Value of the resource availability.
-
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 is used if the ResourceId is not provided in the request. -
WorkCenterCode: string
Maximum Length:
255
User-supplied value that uniquely identifies the work center associated to the resource. It is used if the WorkCenterId is not provided in the request. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center associated to the resource. This value is required.
-
WorkCenterName: string
Maximum Length:
255
Name that uniquely identifies the work center. It is used if the WorkCenterCode is not 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.
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 : workCenterResourceExceptions-item-response
Type:
Show Source
object
-
AssociatedShiftId: integer
(int64)
Value that uniquely identifies the shift that the exception will be applied to. This value is optional.
-
AssociatedShiftName: string
Maximum Length:
255
User-supplied name that identifies the shift that the exception will be applied to. It is used if the AssociatedShiftId is not 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 work center resource 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
Title:
Duration
Duration in Hours for the work center resource exception. This value is required. -
ExceptionEndTime: string
Title:
End Time
Maximum Length:255
Time when the work center resource exception ends. It is derived from the start time and duration, and is not input. -
ExceptionEndTimeInMs: integer
(int64)
Title:
End Time
Time in microseconds from midnight when the work center resource exception ends. -
ExceptionStartTime: string
Title:
Start Time
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. -
OrganizationCode: string
Maximum Length:
255
User-supplied short code that uniquely identifies the organization. It is 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 is used if neither the OrganizationId nor the OrganizationCode attributes are provided in the request. -
resourceAvailabilityOverrides: array
Resource Availability Overrides
Title:
Resource Availability Overrides
The Resource Availability Overrides resource defines changes to the available units of a work center resource assigned to a manufacturing or maintenance plant. -
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 is used if the ScheduleId is not provided in the request. -
StartDate: string
(date)
Title:
Exception Date
Date when the work center resource exception starts. This value is required. The value must be in the ISO8601 format such as "YYYY-MM-DD". -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Resource Availability Overrides
Type:
array
Title:
Resource Availability Overrides
The Resource Availability Overrides resource defines changes to the available units of a work center resource assigned to a manufacturing or maintenance plant.
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.
Nested Schema : workCenterResourceExceptions-resourceAvailabilityOverrides-item-response
Type:
Show Source
object
-
AvailabilityOverride: number
Override quantity value. It 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
Value of the resource availability.
-
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. -
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 is used if the ResourceId is not provided in the request. -
WorkCenterCode: string
Maximum Length:
255
User-supplied value that uniquely identifies the work center associated to the resource. It is used if the WorkCenterId is not provided in the request. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center associated to the resource. This value is required.
-
WorkCenterName: string
Maximum Length:
255
Name that uniquely identifies the work center. It is used if the WorkCenterCode is not 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- resourceAvailabilityOverrides
-
Parameters:
- WorkCenterResourceExceptionId:
$request.path.WorkCenterResourceExceptionId
The Resource Availability Overrides resource defines changes to the available units of a work center resource assigned to a manufacturing or maintenance plant. - WorkCenterResourceExceptionId: