Get one production calendar shift exception

get

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

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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