Jump to

• Request
• Response
• Examples

Create one flow schedule

post

/fscmRestApi/resources/11.13.18.05/flowSchedules

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BuildSequence: number
  Sequence or order of flow schedules based on which manufacturing activity is carried out on the shop floor.
• CancelFlag: boolean
  Maximum Length: 255

  Identifies whether the flow schedule is cancelled.
• FlowScheduleDFF: array Flexfields for Flow Schedules
  Title: Flexfields for Flow Schedules

  A view object for the descriptive flexfield extensions for a work order.
• InventoryItemId(required): 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.
• ItemNumber(required): string
  Maximum Length: 300

  Number that identifies the item, which is the output of the flow schedule.
• 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.
• PlannedCompletionDate: string (date-time)
  Title: Completion Date

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

  Planned production quantity for the flow schedule.
• RedwoodFlag: boolean
  Maximum Length: 255

  Identifies the source of the modifications, whether UI or REST API.
• WorkDefinitionId: integer (int64)
  Title: Work Definition

  Value that uniquely identifies the work definition.
• WorkDefName: string
  Maximum Length: 255

  Name that uniquely identifies the work definition.
• 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.

{
    "required":[
        "InventoryItemId",
        "ItemNumber",
        "PlannedStartQuantity"
    ],
    "type":"object",
    "properties":{
        "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-post-request"
            },
            "x-cardinality":"1"
        },
        "WorkDefinitionId":{
            "title":"Work Definition",
            "type":"integer",
            "description":"Value that uniquely identifies the work definition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PlannedCompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"Date when the flow schedule completes.",
            "format":"date-time",
            "nullable":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"
            }
        },
        "BuildSequence":{
            "type":"number",
            "description":"Sequence or order of flow schedules based on which manufacturing activity is carried out on the shop floor.",
            "nullable":true
        },
        "RedwoodFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Identifies the source of the modifications, whether UI or REST API.",
            "nullable":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"
            }
        },
        "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"
            }
        },
        "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
        },
        "WorkDefName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name that uniquely identifies the work definition.",
            "nullable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization that comes enabled for manufacturing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CancelFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Identifies whether the flow schedule is cancelled.",
            "nullable":true
        },
        "PlannedStartQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Planned production quantity for the flow schedule.",
            "nullable":false
        }
    }
}

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-post-request

{
    "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-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : flowSchedules-FlowScheduleDFF-item-post-request

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
• WorkOrderId: integer (int64)
  Value that uniquely identifies the flow schedule.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "__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"
                }
            }
        },
        "__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"
                }
            }
        }
    }
}

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.
• 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.
• 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.
• 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.
• 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
        },
        "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"
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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

Examples

This example describes how to create a flow schedule.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/flowSchedules"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "WorkDefName": "FlowWDNameuRee9R",
    "ItemNumber": "MFGPLPROD1",
    "OrganizationCode": "SCMDISFM",
    "PlannedStartQuantity": 1,
    "PlannedCompletionDate": "2024-11-15T00:00:00+00:00"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "WorkOrderId" : 300100674029117,
  "OrganizationId" : 300100622732103,
  "WorkOrderNumber" : "SCMDISFM-100015",
  "InventoryItemId" : 100105863980344,
  "PlannedStartQuantity" : 1,
  "UOMCode" : "Ea",
  "CreatedBy" : "MFG_QA",
  "CreationDate" : "2024-11-14T09:38:46+00:00",
  "LastUpdateDate" : "2024-11-14T09:38:46.612+00:00",
  "LastUpdateLogin" : "23E3F0C860085DF7E063715A060A74BE",
  "LastUpdatedBy" : "MFG_QA",
  "OrganizationCode" : "SCMDISFM",
  "ItemNumber" : "MFGPLPROD1",
  "ItemRevision" : "A",
  "ItemStructureName" : null,
  "WorkDefinitionAsOfDate" : "2024-11-15T00:00:00+00:00",
  "WorkDefinitionId" : 246041,
  "WoStatusName" : "Released",
  "PlannedCompletionDate" : "2024-11-15T00:00:00+00:00",
  "ClosedDate" : null,
  "CompletedQuantity" : null,
  "BuildSequence" : 10,
  "ProductionLineId" : 300100674029050,
  "ItemDescription" : "Plain Prod Push",
  "ProductionLineName" : null,
  "RedwoodFlag" : null,
  "WorkDefName" : "FlowWDNameuRee9R",
  "ActualCompletionDate" : null,
  "CanceledDate" : null,
  "WoSystemStatusCode" : "RELEASED",
  "CancelFlag" : null,
  "CustomerName" : null,
  "SalesOrderNumber" : null,
  "VersionNumber" : null,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/flowSchedules/300100674029117",
    "name" : "flowSchedules",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/flowSchedules/300100674029117",
    "name" : "flowSchedules",
    "kind" : "item"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/flowSchedules/300100674029117/child/FlowScheduleDFF",
    "name" : "FlowScheduleDFF",
    "kind" : "collection"
  } ]
}

Back to Top