Jump to

• Request
• Response

Update one flow schedule

patch

/fscmRestApi/resources/11.13.18.05/flowSchedules/{WorkOrderId}

Request

Path Parameters

• WorkOrderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

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 canceled.
• FlowScheduleDFF: array FlowScheduleDFF
• FlowScheduleSource: string
  Identifies the source of the flow schedule.
• FlowScheduleTransactionalAttributeValues: array Work Order TIA Values
  Title: Work Order TIA Values

  Details of the transactional item attribute values within the work order.
• PlannedCompletionDate: string (date-time)
  Title: Completion Date

  Date when the flow schedule completes.
• RedwoodFlag: boolean
  Maximum Length: 255

  Identifies the source of the modifications, whether UI or REST API.
• WorkDefName: string
  Maximum Length: 255

  Name that uniquely identifies the work definition.

{
    "type":"object",
    "properties":{
        "BuildSequence":{
            "type":"number",
            "description":"Sequence or order of flow schedules based on which manufacturing activity is carried out on the shop floor.",
            "nullable":true
        },
        "CancelFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Identifies whether the flow schedule is canceled.",
            "nullable":true
        },
        "FlowScheduleDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/flowSchedules-FlowScheduleDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "FlowScheduleSource":{
            "type":"string",
            "description":"Identifies the source of the flow schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "FlowScheduleTransactionalAttributeValues":{
            "title":"Work Order TIA Values",
            "type":"array",
            "description":"Details of the transactional item attribute values within the work order.",
            "items":{
                "$ref":"#/components/schemas/flowSchedules-FlowScheduleTransactionalAttributeValues-item-patch-request"
            }
        },
        "PlannedCompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"Date when the flow schedule completes.",
            "format":"date-time",
            "nullable":true
        },
        "RedwoodFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Identifies the source of the modifications, whether UI or REST API.",
            "nullable":true
        },
        "WorkDefName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the work definition.",
            "nullable":true
        }
    }
}

Nested Schema : FlowScheduleDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/flowSchedules-FlowScheduleDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Work Order TIA Values

Type: array

Title: Work Order TIA Values

Details of the transactional item attribute values within the work order.

Show Source

• Array of: object flowSchedules-FlowScheduleTransactionalAttributeValues-item-patch-request

{
    "title":"Work Order TIA Values",
    "type":"array",
    "description":"Details of the transactional item attribute values within the work order.",
    "items":{
        "$ref":"#/components/schemas/flowSchedules-FlowScheduleTransactionalAttributeValues-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• WorkOrderId: integer (int64)

{
    "type":"object",
    "properties":{
        "WorkOrderId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        },
        "__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"
                }
            }
        }
    }
}

Nested Schema : flowSchedules-FlowScheduleTransactionalAttributeValues-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 canceled.
• CancelFlag: boolean
  Maximum Length: 255

  Identifies whether the flow schedule is canceled.
• 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 FlowScheduleDFF
• FlowScheduleSource: string
  Identifies the source of the flow schedule.
• FlowScheduleTransactionalAttributeValues: array Work Order TIA Values
  Title: Work Order TIA Values

  Details of the transactional item attribute values within the 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.
• 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's enabled for manufacturing. It's 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.
• TransactionalItemAttributesExistFlag: boolean
  Read Only: true

  Maximum Length: 255

  Identifies whether transactional item attributes exist.
• 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's 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":{
        "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
        },
        "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
        },
        "CancelFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Identifies whether the flow schedule is canceled.",
            "nullable":true,
            "x-queryable":true
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"Date when the flow schedule is canceled.",
            "format":"date-time",
            "nullable":true,
            "readOnly":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
        },
        "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "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
        },
        "FlowScheduleDFF":{
            "type":"array",
            "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
        },
        "FlowScheduleTransactionalAttributeValues":{
            "title":"Work Order TIA Values",
            "type":"array",
            "description":"Details of the transactional item attribute values within the work order.",
            "items":{
                "$ref":"#/components/schemas/flowSchedules-FlowScheduleTransactionalAttributeValues-item-response"
            }
        },
        "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
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":false,
            "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
        },
        "ItemRevision":{
            "title":"Revision",
            "maxLength":18,
            "type":"string",
            "description":"Name of the item revision.",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "LastExecutedSequenceNumber":{
            "type":"number",
            "description":"Indicates the most recent operation completed in the flow schedule.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "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
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "PlannedCompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"Date when the flow schedule completes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PlannedStartQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Planned production quantity for the flow schedule.",
            "nullable":false,
            "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
        },
        "ProductionLineName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of a production line.",
            "nullable":false,
            "readOnly":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
        },
        "SalesOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Sales order number against which the flow schedule is reserved.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionalItemAttributesExistFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Identifies whether transactional item attributes exist.",
            "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
        },
        "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
        },
        "WoStatusName":{
            "title":"Work Order Status",
            "maxLength":120,
            "type":"string",
            "description":"Name of the flow schedule status.",
            "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
        },
        "WorkDefName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the work definition.",
            "nullable":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
        },
        "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
        },
        "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
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the flow schedule. It's 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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : FlowScheduleDFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/flowSchedules-FlowScheduleDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Work Order TIA Values

Type: array

Title: Work Order TIA Values

Details of the transactional item attribute values within the work order.

Show Source

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

{
    "title":"Work Order TIA Values",
    "type":"array",
    "description":"Details of the transactional item attribute values within the work order.",
    "items":{
        "$ref":"#/components/schemas/flowSchedules-FlowScheduleTransactionalAttributeValues-item-response"
    }
}

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

  Context Segment
• __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)

{
    "type":"object",
    "properties":{
        "WorkOrderId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Context Segment",
            "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
        },
        "__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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Nested Schema : flowSchedules-FlowScheduleTransactionalAttributeValues-item-response

Type: object

Show Source

• AttributeDataType: string
  Read Only: true

  Maximum Length: 1

  Data type of the transactional attribute, which can be Character, Date, Number, or Time.
• AttributeDescription: string
  Read Only: true

  Maximum Length: 240

  Statement, word picture, or account that provides a descriptive representation.
• AttributeDisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 100

  Name given to a specific variation of a structure type.
• AttributeId: integer (int64)
  Read Only: true

  Metadata defined during item creation, where the attribute's value is captured when the item is used in a transaction. For example, the attribute Monogram used for the item Shirt.
• AttributeName: string
  Read Only: true

  Maximum Length: 32

  Name of the matching attribute being used.
• AttributeUnitOfMeasure: string
  Title: UOM

  Read Only: true

  Maximum Length: 25

  Translatable unit of measure (UOM) name.
• AttributeUOM: string
  Read Only: true

  Maximum Length: 255

  Indicates the unit of measure code associated with a transactional item attribute.
• AttributeValue: string
  Title: Value

  Read Only: true

  Indicates the value of transactional attribute name.
• BomItemType: number
  Read Only: true

  Indicates the type of bill of materials the item can have, such as standard, model, planning, or other.
• BomItemTypeMean: string
  Title: Type

  Read Only: true

  Indicates the type of item, such as ATO model, option class, or standard item.
• CharacterAttributeValue: string
  Read Only: true

  Maximum Length: 50

  Value of the attribute if it's a character.
• ComponentHierarchy: string
  Read Only: true

  Maximum Length: 4000

  Indicates the component structure hierarchy.
• DateAttributeValue: string (date)
  Read Only: true

  Value of the attribute if it's a date.
• InventoryItemId: integer (int64)
  Read Only: true

  Item identifier assigned to the model or option class item.
• ItemNumber: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Number that identifies the item, which is the output of the work order.
• ItemUOM: string
  Read Only: true

  Maximum Length: 255

  Unit of measure for the quantity ordered.
• Lineage: string
  Title: Component Hierarchy

  Read Only: true

  Indicates the lineage of the transactional attribute, traced through the option class and ATO model.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberAttributeValue: integer (int64)
  Read Only: true

  Value of the attribute if it's a number.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.
• TiaReferenceEntity: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the transaction attribute entity.
• TiaReferenceLineId: integer
  Read Only: true

  Unique identifier assigned to match the entry of the detailed record.
• TimestampAttributeValue: string (date-time)
  Read Only: true

  Value of the attribute if it's a timestamp.
• WorkOrderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order. It's a primary key generated by the application when the work order is created.

{
    "type":"object",
    "properties":{
        "AttributeDataType":{
            "maxLength":1,
            "type":"string",
            "description":"Data type of the transactional attribute, which can be Character, Date, Number, or Time.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Statement, word picture, or account that provides a descriptive representation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeDisplayName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"Name given to a specific variation of a structure type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Metadata defined during item creation, where the attribute's value is captured when the item is used in a transaction. For example, the attribute Monogram used for the item Shirt.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeName":{
            "maxLength":32,
            "type":"string",
            "description":"Name of the matching attribute being used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the unit of measure code associated with a transactional item attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AttributeUnitOfMeasure":{
            "title":"UOM",
            "maxLength":25,
            "type":"string",
            "description":"Translatable unit of measure (UOM) name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "title":"Value",
            "type":"string",
            "description":"Indicates the value of transactional attribute name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BomItemType":{
            "type":"number",
            "description":"Indicates the type of bill of materials the item can have, such as standard, model, planning, or other.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BomItemTypeMean":{
            "title":"Type",
            "type":"string",
            "description":"Indicates the type of item, such as ATO model, option class, or standard item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CharacterAttributeValue":{
            "maxLength":50,
            "type":"string",
            "description":"Value of the attribute if it's a character.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentHierarchy":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates the component structure hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DateAttributeValue":{
            "type":"string",
            "description":"Value of the attribute if it's a date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Item identifier assigned to the model or option class item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item, which is the output of the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for the quantity ordered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Lineage":{
            "title":"Component Hierarchy",
            "type":"string",
            "description":"Indicates the lineage of the transactional attribute, traced through the option class and ATO model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberAttributeValue":{
            "type":"integer",
            "description":"Value of the attribute if it's a number.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TiaReferenceEntity":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the transaction attribute entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TiaReferenceLineId":{
            "type":"integer",
            "description":"Unique identifier assigned to match the entry of the detailed record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TimestampAttributeValue":{
            "type":"string",
            "description":"Value of the attribute if it's a timestamp.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order. It's a primary key generated by the application when the work order is created.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

FlowScheduleDFF

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

Parameters:

• WorkOrderId: $request.path.WorkOrderId

FlowScheduleTransactionalAttributeValues

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

Parameters:

• WorkOrderId: $request.path.WorkOrderId

Details of the transactional item attribute values within the work order.

Back to Top