Jump to

• Request
• Response

Get all production calendar shift exceptions

get

/fscmRestApi/resources/11.13.18.05/productionCalendarShiftExceptions

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds production calendar shift exceptions according to the exception ID as the primary key.
    Finder Variables:
    • PlantShiftExceptionId; integer; Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssociatedShiftId; integer; Value that uniquely identifies the shift that the exception will be applied to.
  • AssociatedShiftName; string; 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; User who created the record.
  • CreationDate; string; Date and time when the user created the record.
  • EndDate; string; 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; Duration in microseconds for the shift exception.
  • ExceptionEndTime; string; Time when the shift exception ends. It's derived from the start time and duration and isn't input.
  • ExceptionEndTimeInMs; integer; Time when the shift exception ends as measured in microseconds after midnight.
  • ExceptionStartTime; string; Time when the shift exception starts. This value is required. It must be formatted as "HH:MM AM|PM".
  • ExceptionStartTimeInMs; integer; Time when the shift exception starts as measured in microseconds after midnight.
  • ExceptionType; string; Specifies the type of shift exception being created. Valid values are Change Shift, Remove Shift, Split Shift, and Add Shift.
  • ExceptionTypeCode; string; 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 and time when the user most recently updated the record.
  • LastUpdatedBy; string; User who most recently updated the record.
  • Name; string; User-supplied name for the shift exception. This value is required.
  • OrganizationCode; string; User-supplied short code that uniquely identifies the organization. It's used if the OrganizationId attribute is not provided in the request.
  • OrganizationId; integer; Value that uniquely identifies the inventory organization that's the plant.
  • OrganizationName; string; User-supplied name that identifies the organization. It's used if neither the OrganizationId nor OrganizationCode attributes are provided in the request.
  • PlantShiftExceptionId; integer; 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; User-supplied reason for the shift exception.
  • ScheduleId; integer; 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; 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 when the shift exception starts. This value is required. The value must be in the ISO8601 format such as "YYYY-MM-DD".
  • WorkCenterCode; string; User-supplied value that uniquely identifies the work center with override calendars being chosen for an exception.
  • WorkCenterId; integer; 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; Name that uniquely identifes the work center with override calendars being chosen for an exception.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : productionCalendarShiftExceptions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/productionCalendarShiftExceptions-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SCMCommon",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object productionCalendarShiftExceptions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/productionCalendarShiftExceptions-item-response"
    }
}

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 : 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
  Title: Duration

  Duration in Hours for the shift exception. This value is required.
• ExceptionDurationInMs: integer (int64)
  Duration in microseconds for the shift exception.
• ExceptionEndTime: string
  Title: End Time

  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
  Title: Start Time

  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
  Title: Exception Type

  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":{
            "title":"Exception Type",
            "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":{
            "title":"Start Time",
            "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":{
            "title":"Duration",
            "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":{
            "title":"End Time",
            "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

generateProductionCalendarData

Operation: /fscmRestApi/resources/11.13.18.05/productionCalendarShiftExceptions/action/generateProductionCalendarData

Generate the calendar data for a specified date range for the specified plant or work center. The calendar information shows the active shifts, as well as known shift exceptions which alter standard working time. This action is intended for use in Fusion Cloud Manufacturing or Maintenance when viewing the production calendar.

Back to Top