Get all calendars
get
/fscmRestApi/resources/11.13.18.05/workCenters/{WorkCenterId}/child/productionCalendars
Request
Path Parameters
-
WorkCenterId(required): integer(int64)
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center.
Query Parameters
-
dependency: string
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> -
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 a date effective calendar for a work center according to the production calendar identifier as the primary key.
Finder Variables:- ProductionCalendarId; integer; Value that uniquely identifies the date effective production calendar for the work center. It's a primary key that the application generates when it creates the override calendar.
- PrimaryKey: Finds a date effective calendar for a work center according to the production calendar identifier as the primary key.
-
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:- AssociationEndDate; string; Indicates the end date for the work center calendar's association.
- AssociationStartDate; string; Indicates the work center calendar association's start date.
- CreatedBy; string; User who created the production calendar.
- CreationDate; string; Date when the user created the production calendar.
- Description; string; Description of the work center calendar.
- EffectiveFromDate; string; Effective From date of the work center calendar.
- EffectiveToDate; string; Effective To date of the work center calendar.
- LastUpdateDate; string; Date and time when the user most recently updated the production calendar.
- LastUpdateLogin; string; Who column: indicates the session login associated with the user who last updated the row.
- LastUpdatedBy; string; Login of the user who most recently updated the production calendar.
- MfgCalendarId; integer; Calendar schedule for manufacturing usage. Manufacturing calendars must be of the type Time. This is a foreign key to the ZMM_SR_SCHEDULES_B table that the calendar references.
- Name; string; Name of the work center calendar.
- OrganizationCode; string; Organization code.
- OrganizationId; integer; Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
- OrganizationName; string; Organization name.
- ProductionCalendarId; integer; Unique identifier of the work center production calendar's record. Its value is an application-generated unique ID.
- WorkCenterCode; string; Code that represents the user key of the work center.
- WorkCenterId; integer; Value that uniquely identifies the work center that the calendar references.
- WorkCenterName; string; Field value that represents the name of the work center.
-
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 TopResponse
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.
Root Schema : workCenters-productionCalendars
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workCenters-productionCalendars-item-response
Type:
Show Source
object
-
AssociationEndDate: string
(date)
Indicates the end date for the work center calendar's association.
-
AssociationStartDate: string
(date)
Indicates the work center calendar association's start date.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the production calendar. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the production calendar. -
Description: string
Read Only:
true
Maximum Length:2000
Description of the work center calendar. -
EffectiveFromDate: string
(date)
Read Only:
true
Effective From date of the work center calendar. -
EffectiveToDate: string
(date)
Read Only:
true
Effective To date of the work center calendar. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the production calendar. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Login of the user who most recently updated the production calendar. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Who column: indicates the session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MfgCalendarId: integer
(int64)
Calendar schedule for manufacturing usage. Manufacturing calendars must be of the type Time. This is a foreign key to the ZMM_SR_SCHEDULES_B table that the calendar references.
-
Name: string
Maximum Length:
240
Name of the work center calendar. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Organization code. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization. -
OrganizationName: string
Read Only:
true
Maximum Length:240
Organization name. -
ProductionCalendarId: integer
(int64)
Unique identifier of the work center production calendar's record. Its value is an application-generated unique ID.
-
resourceShifts: array
Resource Shifts
Title:
Resource Shifts
The Resource Shifts for work center resources are applicable when the override schedule indicator is set to Yes for a work center. The application automatically creates each shift when you assign a production resource to a work center. -
shifts: array
Shifts
Title:
Shifts
The Shifts for production calendars are the shift definitions for date effective override calendars. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Code that represents the user key of the work center. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center that the calendar references.
-
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Field value that represents the name of the work center.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Resource Shifts
Type:
array
Title:
Resource Shifts
The Resource Shifts for work center resources are applicable when the override schedule indicator is set to Yes for a work center. The application automatically creates each shift when you assign a production resource to a work center.
Show Source
Nested Schema : Shifts
Type:
array
Title:
Shifts
The Shifts for production calendars are the shift definitions for date effective override calendars.
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 : workCenters-productionCalendars-resourceShifts-item-response
Type:
Show Source
object
-
AssignedUnits: number
Indicates the number of resource instances assigned to the shift.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time of the creation of the row. -
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center resource. -
ResourceId: integer
(int64)
Indicates the resource to which the shift is assigned.
-
ResourceName: string
Title:
Name
Maximum Length:80
Name of the work center resource. -
ShiftId: integer
(int64)
Represents the shift identifier that's the foreign key to the ZMM_SR_SHIFTS_B table that the shift references.
-
ShiftName: string
Maximum Length:
240
Name of the shift.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workCenters-productionCalendars-shifts-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the shift. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the shift. -
Description: string
Read Only:
true
Maximum Length:2000
Description of the shift. -
Duration: string
Read Only:
true
Duration of the shift. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the shift. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Login of the user who most recently updated the shift. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Who column: indicates the session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:240
Name of the shift. -
ShiftId: integer
Read Only:
true
Value that uniquely identifies the shift that the calendar references. -
StartTime: string
Read Only:
true
Start time of the shift.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source