Jump to

• Request
• Response
• Examples

Get one material

get

/fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionMaterial/{WorkDefinitionOperationMaterialId}

Request

Path Parameters

• WorkDefinitionId(required): integer(int64)
  Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition.
• WorkDefinitionOperationMaterialId(required): integer(int64)
  Value that uniquely identifies the material for the work definition operation. It is a primary key that the application generates when it creates the material for the work definition operation material.

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

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 : workDefinitions-WorkDefinitionMaterial-item-response

Type: object

Show Source

• AdhocItemFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the material line is based on the item structure. If false, then the material line is not based on the item structure. This attribute does not have a default value.
• BasisType: string
  Title: Basis

  Read Only: true

  Maximum Length: 30

  Contains one of the following values: 1 or 2. If 1, then the application does not consider the quantity of the work order when it sets the component quantity that it requires for the parent assembly 2: the application varies the component quantity that it requires for the parent assembly according to the quantity of the work order.
• ComponentSequenceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item structure component (EGP_COMPONENTS_B) assigned to this operation.
• ComponentSequenceIdPath: string (byte)
  Read Only: true

  Value that uniquely identifies this component in the exploded ATO Model item structure.
• 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.
• FindNumber: number
  Title: Find Number

  Read Only: true

  Unique identifier of a component that appears more than once in an item structure.
• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the component. It is a primary key that the application generates when it creates the item.
• InverseQuantity: number
  Title: Inverse Quantity

  Read Only: true

  Inverse of the Quantity Per Product. The application uses the inverse when the Quantity Per Product for the material is a fraction, but the inverse of this quantity is an integer.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the component.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that identifies the item.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaterialSequenceNumber: number
  Title: Sequence

  Read Only: true

  Number that indicates the unique sequence of the component assigned to the work definition operation.
• MaterialType: string
  Read Only: true

  Maximum Length: 30

  Type of material of the items or components that the work definition operation references. Contains one of the following values: COMPONENT or PRIMARY_PRODUCT. COMPONENT: the material is a component that the application issues to the work order. PRIMARY_PRODUCT: the material is an assembly that is an output of a work order.
• OperationName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the operation.
• OperationSequenceNumber: number
  Title: Sequence

  Read Only: true

  Number that indicates the sequence to use when performing the work definition operation.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization.
• Quantity: number
  Title: Quantity

  Read Only: true

  Quantity required to make each unit of the item.
• SecondaryQuantity: number
  Title: Secondary Quantity

  Read Only: true

  Required component quantity in the secondary unit of measure. This attribute is associated with a feature that requires opt in.
• SecondaryUnitOfMeasure: string
  Title: Secondary UOM

  Read Only: true

  Secondary unit of measure of the component. This attribute is associated with a feature that requires opt in.
• SecondaryUOMCode: string
  Title: Secondary UOM Code

  Read Only: true

  Abbreviation that identifies the secondary unit of measure of the component. This attribute is associated with a feature that requires opt in.
• StandardOperationCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the standard operation.
• StandardOperationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the standard operation that the work definition operation references. It is a primary key that the application generates when it creates the standard operation.
• SupplyLocator: string
  Read Only: true

  Maximum Length: 255

  Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
• SupplyLocatorId: integer (int64)
  Title: Supply Locator

  Read Only: true

  Value that uniquely identifies the locator. It is a primary key that the application generates when it creates the locator.
• SupplySubinventory: string
  Title: Supply Subinventory

  Read Only: true

  Maximum Length: 10

  Subinventory to use, by default, when the plant uses material during assembly or an operation pull.
• SupplyType: string
  Title: Supply Type

  Read Only: true

  Maximum Length: 30

  Consumption of the material. Values include Assembly pull, Operation pull, Push, Bulk, or Supplier.
• SupplyTypeDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the supply type.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure that the component uses. It is the primary unit of measure of the item.
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the component uses.
• WorkAreaCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the work area.
• WorkAreaDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the work area.
• WorkAreaId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area.
• WorkAreaName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the work area.
• WorkCenterCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the work center.
• WorkCenterDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the work center.
• WorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center.
• WorkCenterName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the work center.
• WorkDefinitionId: integer (int64)
  Read Only: true

  Default Value: 1

  Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition.
• WorkDefinitionOperationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation.
• WorkDefinitionOperationMaterialAttachment: array Attachments for Materials
  Title: Attachments for Materials

  The Attachments for Materials resource gets the attachments that contain details about the material.
• WorkDefinitionOperationMaterialDFF: array Flexfields for Materials
  Title: Flexfields for Materials

  The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material.
• WorkDefinitionOperationMaterialId: integer (int64)
  Read Only: true

  Value that uniquely identifies the material for the work definition operation. It is a primary key that the application generates when it creates the material.
• WorkDefinitionOperationSubstituteMaterial: array Substitute Materials
  Title: Substitute Materials

  The Substitute Materials resource gets the substitute materials that the work definition operation uses.
• YieldFactor: number
  Read Only: true

  Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It is recommended that you set the yield to between 0 and 1. You can set the yield to a value that is greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.

{
    "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
        },
        "SupplySubinventory":{
            "title":"Supply Subinventory",
            "maxLength":"10",
            "type":"string",
            "description":"Subinventory to use, by default, when the plant uses material during assembly or an operation pull.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkCenterDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SecondaryUnitOfMeasure":{
            "title":"Secondary UOM",
            "type":"string",
            "description":"Secondary unit of measure of the component. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"1",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StandardOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the standard operation that the work definition operation references. It is a primary key that the application generates when it creates the standard operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InverseQuantity":{
            "title":"Inverse Quantity",
            "type":"number",
            "description":"Inverse of the Quantity Per Product. The application uses the inverse when the Quantity Per Product for the material is a fraction, but the inverse of this quantity is an integer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplyLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionOperationSubstituteMaterial":{
            "title":"Substitute Materials",
            "type":"array",
            "description":"The Substitute Materials resource gets the substitute materials that the work definition operation uses.",
            "items":{
                "$ref":"#/components/schemas/workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationSubstituteMaterial-item-response"
            }
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkDefinitionOperationMaterialAttachment":{
            "title":"Attachments for Materials",
            "type":"array",
            "description":"The Attachments for Materials resource gets the attachments that contain details about the material.",
            "items":{
                "$ref":"#/components/schemas/workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationMaterialAttachment-item-response"
            }
        },
        "MaterialType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of material of the items or components that the work definition operation references. Contains one of the following values: COMPONENT or PRIMARY_PRODUCT. COMPONENT: the material is a component that the application issues to the work order. PRIMARY_PRODUCT: the material is an assembly that is an output of a work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "YieldFactor":{
            "type":"number",
            "description":"Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It is recommended that you set the yield to between 0 and 1. You can set the yield to a value that is greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyLocatorId":{
            "title":"Supply Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator. It is a primary key that the application generates when it creates the locator.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkAreaName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FindNumber":{
            "title":"Find Number",
            "type":"number",
            "description":"Unique identifier of a component that appears more than once in an item structure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the material for the work definition operation. It is a primary key that the application generates when it creates the material.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MaterialSequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"Number that indicates the unique sequence of the component assigned to the work definition operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM Code",
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure of the component. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyType":{
            "title":"Supply Type",
            "maxLength":"30",
            "type":"string",
            "description":"Consumption of the material. Values include Assembly pull, Operation pull, Push, Bulk, or Supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkDefinitionOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkCenterCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the component uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ComponentSequenceIdPath":{
            "type":"string",
            "description":"Value that uniquely identifies this component in the exploded ATO Model item structure.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAreaDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StandardOperationCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the standard operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure that the component uses. It is the primary unit of measure of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "OperationName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component. It is a primary key that the application generates when it creates the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity required to make each unit of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item structure component (EGP_COMPONENTS_B) assigned to this operation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SupplyTypeDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the supply type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkAreaCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "description":"Required component quantity in the secondary unit of measure. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisType":{
            "title":"Basis",
            "maxLength":"30",
            "type":"string",
            "description":"Contains one of the following values: 1 or 2. If 1, then the application does not consider the quantity of the work order when it sets the component quantity that it requires for the parent assembly 2: the application varies the component quantity that it requires for the parent assembly according to the quantity of the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionOperationMaterialDFF":{
            "title":"Flexfields for Materials",
            "type":"array",
            "description":"The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material.",
            "items":{
                "$ref":"#/components/schemas/workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationMaterialDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "OperationSequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"Number that indicates the sequence to use when performing the work definition operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdhocItemFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the material line is based on the item structure. If false, then the material line is not based on the item structure. This attribute does not have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : Attachments for Materials

Type: array

Title: Attachments for Materials

The Attachments for Materials resource gets the attachments that contain details about the material.

Show Source

• Array of: object workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationMaterialAttachment-item-response

{
    "title":"Attachments for Materials",
    "type":"array",
    "description":"The Attachments for Materials resource gets the attachments that contain details about the material.",
    "items":{
        "$ref":"#/components/schemas/workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationMaterialAttachment-item-response"
    }
}

Nested Schema : Flexfields for Materials

Type: array

Title: Flexfields for Materials

The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material.

Show Source

• Array of: object workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationMaterialDFF-item-response

{
    "title":"Flexfields for Materials",
    "type":"array",
    "description":"The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material.",
    "items":{
        "$ref":"#/components/schemas/workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationMaterialDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Substitute Materials

Type: array

Title: Substitute Materials

The Substitute Materials resource gets the substitute materials that the work definition operation uses.

Show Source

• Array of: object workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationSubstituteMaterial-item-response

{
    "title":"Substitute Materials",
    "type":"array",
    "description":"The Substitute Materials resource gets the substitute materials that the work definition operation uses.",
    "items":{
        "$ref":"#/components/schemas/workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationSubstituteMaterial-item-response"
    }
}

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 : workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationMaterialAttachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attachment of a work definition operation output. It is a primary key that the application generates when a document is attached to the work definition operation output.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. This attribute does not have a default value.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the attachment record.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the current version of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents in the attachment are no longer available.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) that locates the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user most recently updated the document that is attached to the work definition operation output.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Login of the user who updated the document that is attached to the work definition operation output.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the document that is attached to the work definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) that locates the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when adding or modifying the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment of a work definition operation output. It is a primary key that the application generates when a document is attached to the work definition operation output.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the current version of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"Login of the user who updated the document that is attached to the work definition operation output.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Login that the user used when adding or modifying the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the document that is attached to the work definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents in the attachment are no longer available.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the document that is attached to the work definition operation output.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationMaterialDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context name for work definition operation materials.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• Discriminator: string
  This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• WdOperationMaterialId: integer (int64)
  Value that uniquely identifies the material that the work definition operation consumes. It is a primary key that the application generates when it consumes the material.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WdOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the material that the work definition operation consumes. It is a primary key that the application generates when it consumes the material.",
            "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",
            "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
        },
        "Discriminator":{
            "type":"string",
            "description":"This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"80",
            "type":"string",
            "description":"Descriptive flexfield context name for work definition operation materials.",
            "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 : workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationSubstituteMaterial-item-response

Type: object

Show Source

• ComponentSequenceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the sequence of the substitute component that the application assigns to the material that the work definition operation consumes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PriorityRanking: number
  Read Only: true

  Ranking of the substitute component to use instead of the primary component.
• SubstituteComponentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the substitute component. It is a primary key that the application generates when it creates the item.
• SubstituteInverseQuantity: number
  Read Only: true

  Inverse of the Quantity Per Product attribute. The application uses the inverse when the Quantity Per Product for the material is a fraction, but the inverse of this quantity is an integer.
• SubstituteItemQuantity: number
  Read Only: true

  Quantity required to make each unit of the item.
• WdOperationMaterialId: integer (int64)
  Read Only: true

  Value that uniquely identifies the material for a work definition operation. It is a primary key that the application generates when it consumes the material.
• WdOperationSubstituteMaterialId: integer (int64)
  Read Only: true

  Value that uniquely identifies the substitute material for a work definition operation. It is a primary key that the application generates when it consumes the substitute material.

{
    "type":"object",
    "properties":{
        "SubstituteInverseQuantity":{
            "type":"number",
            "description":"Inverse of the Quantity Per Product attribute. The application uses the inverse when the Quantity Per Product for the material is a fraction, but the inverse of this quantity is an integer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PriorityRanking":{
            "type":"number",
            "description":"Ranking of the substitute component to use instead of the primary component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WdOperationSubstituteMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the substitute material for a work definition operation. It is a primary key that the application generates when it consumes the substitute material.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SubstituteItemQuantity":{
            "type":"number",
            "description":"Quantity required to make each unit of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WdOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the material for a work definition operation. It is a primary key that the application generates when it consumes the material.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sequence of the substitute component that the application assigns to the material that the work definition operation consumes.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubstituteComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the substitute component. It is a primary key that the application generates when it creates the item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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"
    }
}

Links

WorkDefinitionOperationMaterialAttachment

Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionMaterial/{WorkDefinitionOperationMaterialId}/child/WorkDefinitionOperationMaterialAttachment

Parameters:

• WorkDefinitionId: $request.path.WorkDefinitionId
• WorkDefinitionOperationMaterialId: $request.path.WorkDefinitionOperationMaterialId

The Attachments for Materials resource gets the attachments that contain details about the material.

WorkDefinitionOperationMaterialDFF

Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionMaterial/{WorkDefinitionOperationMaterialId}/child/WorkDefinitionOperationMaterialDFF

Parameters:

• WorkDefinitionId: $request.path.WorkDefinitionId
• WorkDefinitionOperationMaterialId: $request.path.WorkDefinitionOperationMaterialId

The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material.

WorkDefinitionOperationSubstituteMaterial

Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionMaterial/{WorkDefinitionOperationMaterialId}/child/WorkDefinitionOperationSubstituteMaterial

Parameters:

• WorkDefinitionId: $request.path.WorkDefinitionId
• WorkDefinitionOperationMaterialId: $request.path.WorkDefinitionOperationMaterialId

The Substitute Materials resource gets the substitute materials that the work definition operation uses.

Back to Top

Examples

This example describes how to get one material.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/workDefinitions/WorkDefinitionId/child/WorkDefinitionMaterial/WorkDefinitionOperationMaterialId"

For example, the following command gets one material:

curl -u username:password "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionMaterial/300100546045451"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"OrganizationId": 207,
	"WorkDefinitionId": 300100546045347,
	"WorkDefinitionOperationId": 300100546045410,
	"OperationSequenceNumber": 10,
	"OperationName": "Cleaning and Sorting",
	"StandardOperationId": 300100110956176,
	"StandardOperationCode": "MCCLEANSYS",
	"WorkAreaId": 300100110956116,
	"WorkAreaCode": "MFG_WA",
	"WorkAreaName": "MFG Workarea",
	"WorkAreaDescription": "MFG Cleaning Workarea",
	"WorkCenterId": 300100110956122,
	"WorkCenterCode": "MCNOCAL",
	"WorkCenterName": "MFG Cleaning",
	"WorkCenterDescription": "Citrus Sorting and Cleaning",
	"WorkDefinitionOperationMaterialId": 300100546045451,
	"MaterialSequenceNumber": 10,
	"MaterialType": "COMPONENT",
	"InventoryItemId": 300100200567298,
	"ItemNumber": "MFG-100",
	"ItemDescription": "MFG Plain item",
	"BasisType": "1",
	"Quantity": 1000,
	"InverseQuantity": 0.001,
	"UOMCode": "Ea",
	"UnitOfMeasure": "Each",
	"SecondaryQuantity": null,
	"SecondaryUOMCode": null,
	"SecondaryUnitOfMeasure": null,
	"YieldFactor": 1,
	"SupplyType": "2",
	"SupplyTypeDescription": "Assembly pull",
	"SupplySubinventory": "Stores",
	"SupplyLocatorId": null,
	"SupplyLocator": null,
	"ComponentSequenceId": null,
	"AdhocItemFlag": true,
	"LastUpdatedBy": "MFG_QA",
	"LastUpdateDate": "2021-02-25T22:47:39.859+00:00",
	"CreatedBy": "MFG_QA",
	"CreationDate": "2021-02-25T22:45:18.610+00:00",
	"links": [
	{
		"rel": "self",
		"href": ""https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionMaterial/300100546045451",
		"name": "WorkDefinitionMaterial",
		"kind": "item"
	},
	{
		"rel": "canonical",
		"href": ""https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionMaterial/300100546045451",
		"name": "WorkDefinitionMaterial",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": ""https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347",
		"name": "workDefinitions",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": ""https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionMaterial/300100546045451/child/WorkDefinitionOperationMaterialAttachment",
		"name": "WorkDefinitionOperationMaterialAttachment",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": ""https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionMaterial/300100546045451/child/WorkDefinitionOperationMaterialDFF",
		"name": "WorkDefinitionOperationMaterialDFF",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": ""https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionMaterial/300100546045451/child/WorkDefinitionOperationSubstituteMaterial",
		"name": "WorkDefinitionOperationSubstituteMaterial",
		"kind": "collection"
	},
	{
		"rel": "enclosure",
		"href": ""https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionMaterial/300100546045451/enclosure/ComponentSequenceIdPath",
		"name": "ComponentSequenceIdPath",
		"kind": "other"
	}
	]
}

Back to Top