Jump to

• Request
• Response

Get one flow schedule

get

/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.

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

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.

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 : flowSchedules-item-response

Type: object

Show Source

• ActualCompletionDate: string (date-time)
  Title: Actual Completion Date

  Read Only: true

  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.
• CanceledDate: string (date-time)
  Title: Canceled Date

  Read Only: true

  Date when the flow schedule is cancelled.
• CancelFlag: boolean
  Maximum Length: 255

  Identifies whether the flow schedule is cancelled.
• ClosedDate: string (date-time)
  Title: Closed Date

  Read Only: true

  Date when the flow schedule is closed.
• CompletedQuantity: number
  Title: Completed Quantity

  Read Only: true

  Flow schedule quantity that's completed into inventory at the last operation.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created this record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the record was created.
• CustomerName: string
  Read Only: true

  Maximum Length: 255

  Name of the customer on the demand source document.
• FlowScheduleDFF: array Flexfields for Flow Schedules
  Title: Flexfields for Flow Schedules

  A view object for the descriptive flexfield extensions for a work order.
• FlowScheduleSource: string
  Identifies the source of the flow schedule.
• InventoryItemId: integer (int64)
  Title: Item

  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
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item, which is the output of the flow schedule.
• ItemRevision: string
  Title: Revision

  Read Only: true

  Maximum Length: 18

  Name of the item revision.
• ItemStructureName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the item structure.
• KanbanCardId: integer (int64)
  Read Only: true

  Unique identifier of the Kanban card. Its value is an application-generated unique ID.
• KanbanCardNumber: string
  Title: Kanban Card Number

  Read Only: true

  Maximum Length: 200

  Number that uniquely identifies the Kanban card. Its value is generated from a document sequence.
• KanbanReplenishmentCycleId: integer (int64)
  Title: Cycle Number

  Read Only: true

  Unique identifier of the current replenishment cycle.
• LastExecutedSequenceNumber: number
  Read Only: true

  Indicates the most recent operation completed in the flow schedule.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the record was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of the user who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation 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: true

  Maximum Length: 255

  Number that identifies the parent flow schedule of a flow schedule created for a feeder line.
• PlannedCompletionDate: string (date-time)
  Title: Completion Date

  Date when the flow schedule completes.
• PlannedStartQuantity: number
  Title: Quantity

  Planned production quantity for the flow schedule.
• ProductionLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the production line.
• ProductionLineName: string
  Read Only: true

  Maximum Length: 120

  Name of a production line.
• RedwoodFlag: boolean
  Maximum Length: 255

  Identifies the source of the modifications, whether UI or REST API.
• SalesOrderNumber: string
  Read Only: true

  Maximum Length: 255

  Sales order number against which the flow schedule is reserved.
• UOMCode: string
  Title: UOM

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the item.
• VersionNumber: string
  Title: Version

  Read Only: true

  Maximum Length: 10

  Work definition version based on which the flow schedule is created.
• WorkDefinitionAsOfDate: string (date-time)
  Title: Date

  Read Only: true

  Identifies the as of date of the work definition.
• WorkDefinitionId: integer (int64)
  Title: Work Definition

  Value that uniquely identifies the work definition.
• WorkDefinitionVersionId: integer (int64)
  Title: Version

  Value that uniquely identifies the work definition version on which the flow schedule is created.
• WorkDefName: string
  Maximum Length: 255

  Name that uniquely identifies the work definition.
• WorkOrderId: integer (int64)
  Read Only: true

  Value 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 Order

  Maximum Length: 120

  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.
• WoStatusName: string
  Title: Work Order Status

  Read Only: true

  Maximum Length: 120

  Name of the flow schedule status.
• WoSystemStatusCode: string
  Title: System Status Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the system status that the application maps to the flow schedule status.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentFlowScheduleNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the parent flow schedule of a flow schedule created for a feeder line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowScheduleDFF":{
            "title":"Flexfields for Flow Schedules",
            "type":"array",
            "description":"A view object for the descriptive flexfield extensions for a work order.",
            "items":{
                "$ref":"#/components/schemas/flowSchedules-FlowScheduleDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "FlowScheduleSource":{
            "type":"string",
            "description":"Identifies the source of the flow schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkDefinitionId":{
            "title":"Work Definition",
            "type":"integer",
            "description":"Value that uniquely identifies the work definition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlannedCompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"Date when the flow schedule completes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CompletedQuantity":{
            "title":"Completed Quantity",
            "type":"number",
            "description":"Flow schedule quantity that's completed into inventory at the last operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that is enabled for manufacturing. It is a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionAsOfDate":{
            "title":"Date",
            "type":"string",
            "description":"Identifies the as of date of the work definition.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item, which is the output of the flow schedule.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkDefName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the work definition.",
            "nullable":true,
            "x-queryable":true
        },
        "WoStatusName":{
            "title":"Work Order Status",
            "maxLength":120,
            "type":"string",
            "description":"Name of the flow schedule status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KanbanCardId":{
            "type":"integer",
            "description":"Unique identifier of the Kanban card. Its value is an application-generated unique ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"Date when the flow schedule is cancelled.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization that comes enabled for manufacturing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRevision":{
            "title":"Revision",
            "maxLength":18,
            "type":"string",
            "description":"Name of the item revision.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer on the demand source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastExecutedSequenceNumber":{
            "type":"number",
            "description":"Indicates the most recent operation completed in the flow schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Date when the flow schedule is actually completed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoSystemStatusCode":{
            "title":"System Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the system status that the application maps to the flow schedule status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BuildSequence":{
            "type":"number",
            "description":"Sequence or order of flow schedules based on which manufacturing activity is carried out on the shop floor.",
            "nullable":true,
            "x-queryable":true
        },
        "RedwoodFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Identifies the source of the modifications, whether UI or REST API.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductionLineName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of a production line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version",
            "maxLength":10,
            "type":"string",
            "description":"Work definition version based on which the flow schedule is created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Sales order number against which the flow schedule is reserved.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KanbanCardNumber":{
            "title":"Kanban Card Number",
            "maxLength":200,
            "type":"string",
            "description":"Number that uniquely identifies the Kanban card. Its value is generated from a document sequence.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemStructureName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the item structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":120,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the flow schedule. It is a primary key that the application generates when it creates the flow schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Closed Date",
            "type":"string",
            "description":"Date when the flow schedule is closed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KanbanReplenishmentCycleId":{
            "title":"Cycle Number",
            "type":"integer",
            "description":"Unique identifier of the current replenishment cycle.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CancelFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Identifies whether the flow schedule is cancelled.",
            "nullable":true,
            "x-queryable":true
        },
        "PlannedStartQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Planned production quantity for the flow schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkDefinitionVersionId":{
            "title":"Version",
            "type":"integer",
            "description":"Value that uniquely identifies the work definition version on which the flow schedule is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who most recently updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object flowSchedules-FlowScheduleDFF-item-response

{
    "title":"Flexfields for Flow Schedules",
    "type":"array",
    "description":"A view object for the descriptive flexfield extensions for a work order.",
    "items":{
        "$ref":"#/components/schemas/flowSchedules-FlowScheduleDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : flowSchedules-FlowScheduleDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context name for the flow schedules.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• WorkOrderId: integer (int64)
  Value that uniquely identifies the flow schedule.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the flow schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context name for the flow schedules.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : 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."
        }
    }
}

Links

FlowScheduleDFF

Operation: /fscmRestApi/resources/11.13.18.05/flowSchedules/{WorkOrderId}/child/FlowScheduleDFF

Parameters:

• WorkOrderId: $request.path.WorkOrderId

A view object for the descriptive flexfield extensions for a work order.

Back to Top