1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Manufacturing
  4. Work Definition Requests
  5. Work Definition Headers
  6. Materials

GET action not supported

get

/fscmRestApi/resources/11.13.18.05/workDefinitionRequests/{workDefinitionRequestsUniqID}/child/workDefinitionHeaders/{workDefinitionHeadersUniqID}/child/materials/{materialsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Materials resource and used to uniquely identify an instance of Materials. The client should not generate the hash key value. Instead, the client should query on the Materials collection resource in order to navigate to a specific instance of Materials to get the hash key.
  • This is the hash key of the attributes which make up the composite key for the Work Definition Headers resource and used to uniquely identify an instance of Work Definition Headers. The client should not generate the hash key value. Instead, the client should query on the Work Definition Headers collection resource in order to navigate to a specific instance of Work Definition Headers to get the hash key.
  • This is the hash key of the attributes which make up the composite key for the Work Definition Requests resource and used to uniquely identify an instance of Work Definition Requests. The client should not generate the hash key value. Instead, the client should query on the Work Definition Requests collection resource in order to navigate to a specific instance of Work Definition Requests to get the hash key.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : workDefinitionRequests-workDefinitionHeaders-materials-item-response
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the material of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Maximum Length: 1
    Contains one of the following values: true or false. If false, then the material line is based on the item structure. If true, then the material line isn't based on the item structure. This attribute doesn't have a default value. This is a mandatory attribute when ActionCode is CREATE.
  • 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. If 2, then the application varies the component quantity that it requires for the parent assembly according to the quantity of the work order. For item structure components, the default value is the value in the item structure. For ad hoc items, the default value is 1.
  • Maximum Length: 255
    Names of the error messages that occurred when processing the work definition operation material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error message, if any, that occurred when processing the work definition operation material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Unique identifier of a component that appears more than once in an item structure.
  • 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. Don't specify this attribute if a value is specified for the Quantity attribute in the request payload.
  • Maximum Length: 300
    Number that identifies the item.
  • Links
  • Number that defines the unique sequence of the component assigned to the work definition operation.
  • Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
  • Quantity required to make each unit of the item. The quantity is required when the unit of measure is provided.
  • Date when the structure component is effective. This must be specified only if the item appears multiple times in the item structure with different effective dates.
  • Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
  • Maximum Length: 10
    Value that indicates the subinventory from which this material is consumed.
  • Maximum Length: 30
    Value that indicates the supply type code. Valid values are 1 (Push), 2 (Assembly Pull), 3 (Operation Pull), 4 (Bulk), 5 (Supplier), and 6 (Phantom). If a value is not specified in the request payload, then for item structure components, the default value is the value in the item structure; for ad hoc items, the default value is the value in the item master.
  • Maximum Length: 3
    Abbreviation that identifies the unit of measure that the material uses and can be the item's primary UOM code or a UOM code that can be converted. If the item is enabled with primary and secondary tracking unit of measure, the value can be the item's secondary UOM code. This enhanced behavior is associated with a feature that requires opt in.
  • 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.
Back to Top