Get all flow schedules

get

/fscmRestApi/resources/11.13.18.05/flowSchedules

Request

Query Parameters
  • 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
  • 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 flow schedules according to the flow schedule identifier as the primary key.
      Finder Variables:
      • WorkOrderId; integer; Value that uniquely identifies the flow schedule. it's a primary key that the application generates when it creates the flow schedule. This attribute is required.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ActualCompletionDate; string; Date when the flow schedule is actually completed.
    • BuildSequence; number; Sequence or order of flow schedules based on which manufacturing activity is carried out on the shop floor.
    • CancelFlag; boolean; Identifies whether the flow schedule is cancelled.
    • CanceledDate; string; Date when the flow schedule is cancelled.
    • ClosedDate; string; Date when the flow schedule is closed.
    • CompletedQuantity; number; Flow schedule quantity that's completed into inventory at the last operation.
    • CreatedBy; string; User who created this record.
    • CreationDate; string; Date and time when the record was created.
    • CustomerName; string; Name of the customer on the demand source document.
    • InventoryItemId; integer; Value that uniquely identifies the item, product, or assembly in the inventory organization. It's a primary key that the application generates when it creates the item.
    • ItemDescription; string; Description of the item.
    • ItemNumber; string; Number that identifies the item, which is the output of the flow schedule.
    • ItemRevision; string; Name of the item revision.
    • ItemStructureName; string; Name of the item structure.
    • LastUpdateDate; string; Date when the record was most recently updated.
    • LastUpdateLogin; string; Login of the user who most recently updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • OrganizationCode; string; Abbreviation that identifies the inventory organization that comes enabled for manufacturing.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization that is enabled for manufacturing. It is a primary key of the inventory organization.
    • PlannedCompletionDate; string; Date when the flow schedule completes.
    • PlannedStartQuantity; number; Planned production quantity for the flow schedule.
    • ProductionLineId; integer; Value that uniquely identifies the production line.
    • ProductionLineName; string; Name of a production line.
    • RedwoodFlag; boolean; Identifies the source of the modifications, whether UI or REST API.
    • SalesOrderNumber; string; Sales order number against which the flow schedule is reserved.
    • UOMCode; string; Abbreviation that identifies the unit of measure of the item.
    • VersionNumber; string; Work definition version based on which the flow schedule is created.
    • WoStatusName; string; Name of the flow schedule status.
    • WoSystemStatusCode; string; Abbreviation that identifies the system status that the application maps to the flow schedule status.
    • WorkDefName; string; Name that uniquely identifies the work definition.
    • WorkDefinitionAsOfDate; string; Identifies the as of date of the work definition.
    • WorkDefinitionId; integer; Value that uniquely identifies the work definition.
    • WorkOrderId; integer; Value that uniquely identifies the flow schedule. It is a primary key that the application generates when it creates the flow schedule.
    • WorkOrderNumber; string; Number that identifies the flow schedule. This number is unique in the manufacturing organization. The user can manually assign the number when the user creates the flow schedule, or can allow the application to create a unique number.
  • 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
  • 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 : flowSchedules
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : flowSchedules-item-response
Type: object
Show Source
Nested Schema : Flexfields for Flow Schedules
Type: array
Title: Flexfields for Flow Schedules
A view object for the descriptive flexfield extensions for a work order.
Show Source
Nested Schema : flowSchedules-FlowScheduleDFF-item-response
Type: object
Show Source
Back to Top