Update one flow schedule
patch
/fscmRestApi/resources/11.13.18.05/flowSchedules/{WorkOrderId}
Request
Path Parameters
-
WorkOrderId(required): integer(int64)
Value that uniquely identifies the flow schedule. It is a primary key that the application generates when it creates the flow schedule.
Header Parameters
-
Metadata-Context: string
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: string
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
BuildSequence: number
Sequence or order of flow schedules based on which manufacturing activity is carried out on the shop floor.
-
CancelFlag: boolean
Maximum Length:
255Identifies whether the flow schedule is cancelled. -
FlowScheduleDFF: array
Flexfields for Flow Schedules
Title:
Flexfields for Flow SchedulesA view object for the descriptive flexfield extensions for a work order. -
FlowScheduleSource: string
Identifies the source of the flow schedule.
-
PlannedCompletionDate: string
(date-time)
Title:
Completion DateDate when the flow schedule completes. -
RedwoodFlag: boolean
Maximum Length:
255Identifies the source of the modifications, whether UI or REST API. -
WorkDefName: string
Maximum Length:
255Name that uniquely identifies the work definition.
Nested Schema : Flexfields for Flow Schedules
Type:
arrayTitle:
Flexfields for Flow SchedulesA view object for the descriptive flexfield extensions for a work order.
Show Source
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:80Descriptive flexfield context name for the flow schedules. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
WorkOrderId: integer
(int64)
Value that uniquely identifies the flow schedule.
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 : flowSchedules-item-response
Type:
Show Source
object-
ActualCompletionDate: string
(date-time)
Title:
Actual Completion DateRead Only:trueDate 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.
-
CanceledDate: string
(date-time)
Title:
Canceled DateRead Only:trueDate when the flow schedule is cancelled. -
CancelFlag: boolean
Maximum Length:
255Identifies whether the flow schedule is cancelled. -
ClosedDate: string
(date-time)
Title:
Closed DateRead Only:trueDate when the flow schedule is closed. -
CompletedQuantity: number
Title:
Completed QuantityRead Only:trueFlow schedule quantity that's completed into inventory at the last operation. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created this record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
CustomerName: string
Read Only:
trueMaximum Length:255Name of the customer on the demand source document. -
FlowScheduleDFF: array
Flexfields for Flow Schedules
Title:
Flexfields for Flow SchedulesA view object for the descriptive flexfield extensions for a work order. -
FlowScheduleSource: string
Identifies the source of the flow schedule.
-
InventoryItemId: integer
(int64)
Title:
ItemValue 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
Title:
Item DescriptionRead Only:trueMaximum Length:240Description of the item. -
ItemNumber: string
Maximum Length:
300Number that identifies the item, which is the output of the flow schedule. -
ItemRevision: string
Title:
RevisionRead Only:trueMaximum Length:18Name of the item revision. -
ItemStructureName: string
Title:
NameRead Only:trueMaximum Length:80Name of the item structure. -
KanbanCardId: integer
(int64)
Read Only:
trueUnique identifier of the Kanban card. Its value is an application-generated unique ID. -
KanbanCardNumber: string
Title:
Kanban Card NumberRead Only:trueMaximum Length:200Number that uniquely identifies the Kanban card. Its value is generated from a document sequence. -
KanbanReplenishmentCycleId: integer
(int64)
Title:
Cycle NumberRead Only:trueUnique identifier of the current replenishment cycle. -
LastExecutedSequenceNumber: number
Read Only:
trueIndicates the most recent operation completed in the flow schedule. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login of the user who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
18Abbreviation that identifies the inventory organization that comes enabled for manufacturing. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization that is enabled for manufacturing. It is a primary key of the inventory organization.
-
ParentFlowScheduleNumber: string
Read Only:
trueMaximum Length:255Number that identifies the parent flow schedule of a flow schedule created for a feeder line. -
PlannedCompletionDate: string
(date-time)
Title:
Completion DateDate when the flow schedule completes. -
PlannedStartQuantity: number
Title:
QuantityPlanned production quantity for the flow schedule. -
ProductionLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the production line. -
ProductionLineName: string
Read Only:
trueMaximum Length:120Name of a production line. -
RedwoodFlag: boolean
Maximum Length:
255Identifies the source of the modifications, whether UI or REST API. -
SalesOrderNumber: string
Read Only:
trueMaximum Length:255Sales order number against which the flow schedule is reserved. -
UOMCode: string
Title:
UOMRead Only:trueMaximum Length:3Abbreviation that identifies the unit of measure of the item. -
VersionNumber: string
Title:
VersionRead Only:trueMaximum Length:10Work definition version based on which the flow schedule is created. -
WorkDefinitionAsOfDate: string
(date-time)
Title:
DateRead Only:trueIdentifies the as of date of the work definition. -
WorkDefinitionId: integer
(int64)
Title:
Work DefinitionValue that uniquely identifies the work definition. -
WorkDefinitionVersionId: integer
(int64)
Title:
VersionValue that uniquely identifies the work definition version on which the flow schedule is created. -
WorkDefName: string
Maximum Length:
255Name that uniquely identifies the work definition. -
WorkOrderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the flow schedule. It is a primary key that the application generates when it creates the flow schedule. -
WorkOrderNumber: string
Title:
Work OrderMaximum Length:120Number 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. -
WoStatusName: string
Title:
Work Order StatusRead Only:trueMaximum Length:120Name of the flow schedule status. -
WoSystemStatusCode: string
Title:
System Status CodeRead Only:trueMaximum Length:30Abbreviation that identifies the system status that the application maps to the flow schedule status.
Nested Schema : Flexfields for Flow Schedules
Type:
arrayTitle:
Flexfields for Flow SchedulesA view object for the descriptive flexfield extensions for a work order.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : flowSchedules-FlowScheduleDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:80Descriptive flexfield context name for the flow schedules. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
WorkOrderId: integer
(int64)
Value that uniquely identifies the flow schedule.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- FlowScheduleDFF
-
Parameters:
- WorkOrderId:
$request.path.WorkOrderId
A view object for the descriptive flexfield extensions for a work order. - WorkOrderId: