Jump to

• Request
• Response

GET action not supported

get

/fscmRestApi/resources/11.13.18.05/workDefinitionRequests/{workDefinitionRequestsUniqID}/child/workDefinitionHeaders/{workDefinitionHeadersUniqID}/child/operations/{operationsUniqID}

Request

Path Parameters

• operationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Operations resource and used to uniquely identify an instance of Operations. The client should not generate the hash key value. Instead, the client should query on the Operations collection resource in order to navigate to a specific instance of Operations to get the hash key.
• workDefinitionHeadersUniqID(required): string
  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.
• workDefinitionRequestsUniqID(required): string
  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

• 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(required):
  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(required):
  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-operations-item-response

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Value that specifies the desired action to perform on the work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
• AddlMtlAtManualIssue: string
  Maximum Length: 30

  Name that identifies a list of values that control whether a production operator can issue more than the required quantity while manually reporting material issues. You can allow issuing more than the required quantity without any hindrance, or prevent the material issue in case of additional material issue.
• AutoTransactFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then both resources and materials are automatically charged based on the supply type or the charge type setups for the operation. If the supply type is Operation Pull, the component-level issue transactions will occur when the operation is completed. If the supply type is Assembly Pull, the component level issue transactions will happen at the assembly completion event. The resource transactions are automatically done when the quantity is moved outside the operation. If false, then both resources and materials are not automatically charged. The default value is false.
• CountPointOperationFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the operation is a count-point operation. If an operation is a count-point operation, then you have to manually complete it. Any operations in between the count points are automatically completed; for example, backflushed, and so on. If false, then the operation is not a count-point operation. The default value is true. The last operation should always be a count-point operation.
• ErrorMessageNames: string
  Maximum Length: 255

  Names of the error messages that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
• ErrorMessages: string
  Maximum Length: 2000

  Text of the error message, if any, that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• FixedLeadTime: number
  Fixed lead time used to calculate the operation's start and end date for the supplier operation.
• LeadTimePercent: number
  Percent lead time computed by the manufacturing lead time calculation program and used in the cumulative lead time calculation.
• LeadTimeUnitOfMeasure: string
  Maximum Length: 25

  Unit of measure for the fixed or variable lead time values on the supplier operation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationComplWithOpenExceptions: string
  Maximum Length: 30

  Name that identifies a list of values that control whether operation completion should be allowed when open exceptions exist for an operation. You can allow operation completion without any hindrance, allow with a warning, or prevent the operation completion.
• OperationComplWithUnderIssue: string
  Maximum Length: 30

  Name that identifies a list of values that control whether operation completion should be allowed when less than the required quantity of material is issued. You can allow operation completion without any hindrance, allow with a warning, or prevent the operation completion.
• OperationDescription: string
  Maximum Length: 240

  Value that indicates the description of the work definition operation.
• OperationName: string
  Maximum Length: 120

  Value that indicates the name of the work definition operation.
• OperationSequenceNumber: number
  Number that defines the sequence of operation execution. A valid value must be a positive whole number.
• OperationType: string
  Maximum Length: 30

  Value that specifies the type of the operation. A list of accepted values is defined in the lookup type ORA_WIS_OPERATION_TYPE.
• OptionDependentFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the operation is dependent on one or more optional components. If false, then the operation is not dependent on optional components. The default value is false. This attribute applies only to an assemble-to-order (ATO) model work definition.
• OSPItemNumber: string
  Maximum Length: 300

  Item number that represents the value added service in a supplier operation. This is also commonly known as a partially finished assembly.
• PlanningPercent: number
  Percent that is used by planning for resources forecast explosion. This applies to an assemble-to-order (ATO) model work definition only.
• ReferencedFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the operation references a standard operation. If false, then the operation doesn't reference a standard operation. The default value is false. If the value is true, then a valid value must be specified for the attribute StandardOperationCode.
• ResequenceFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the work order has resequence operations. If false, then the work order doesn't have resequence operations. This attribute is associated with a feature that requires opt in.
• SerialTrackingFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the product is tracked by serial number while running the operation. If false, then the product is not tracked by serial number. The default value is false.
• ShippingDocumentsFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then create shipping documents for the outside processing (OSP) operation. If false, then do not create shipping documents. If the request payload doesn't specify this attribute, then the default value is from the Shippable attribute in the item master. The default value is false.
• StandardOperationCode: string
  Maximum Length: 30

  Value that represents the user key to the standard operation.
• SupplierName: string
  Maximum Length: 360

  Name of the suggested supplier for a supplier operation.
• SupplierSiteCode: string
  Maximum Length: 15

  Value that identifies the suggested supplier site for a supplier operation.
• VariableLeadTime: number
  Variable lead time used to calculate the operation's start and end date based on the operation quantity for the supplier operation.
• WorkCenterCode: string
  Maximum Length: 30

  Value that indicates the user key of the work center where this operation is executed.

{
    "type":"object",
    "properties":{
        "OSPItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Item number that represents the value added service in a supplier operation. This is also commonly known as a partially finished assembly.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that specifies the desired action to perform on the work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "LeadTimeUnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the fixed or variable lead time values on the supplier operation.",
            "nullable":true,
            "x-queryable":true
        },
        "FixedLeadTime":{
            "type":"number",
            "description":"Fixed lead time used to calculate the operation's start and end date for the supplier operation.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningPercent":{
            "type":"number",
            "description":"Percent that is used by planning for resources forecast explosion. This applies to an assemble-to-order (ATO) model work definition only.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingDocumentsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then create shipping documents for the outside processing (OSP) operation. If false, then do not create shipping documents. If the request payload doesn't specify this attribute, then the default value is from the Shippable attribute in the item master. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionDependentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the operation is dependent on one or more optional components. If false, then the operation is not dependent on optional components. The default value is false. This attribute applies only to an assemble-to-order (ATO) model work definition.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadTimePercent":{
            "type":"number",
            "description":"Percent lead time computed by the manufacturing lead time calculation program and used in the cumulative lead time calculation.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteCode":{
            "maxLength":15,
            "type":"string",
            "description":"Value that identifies the suggested supplier site for a supplier operation.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationComplWithOpenExceptions":{
            "maxLength":30,
            "type":"string",
            "description":"Name that identifies a list of values that control whether operation completion should be allowed when open exceptions exist for an operation. You can allow operation completion without any hindrance, allow with a warning, or prevent the operation completion.",
            "nullable":true,
            "x-queryable":true
        },
        "CountPointOperationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the operation is a count-point operation. If an operation is a count-point operation, then you have to manually complete it. Any operations in between the count points are automatically completed; for example, backflushed, and so on. If false, then the operation is not a count-point operation. The default value is true. The last operation should always be a count-point operation.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddlMtlAtManualIssue":{
            "maxLength":30,
            "type":"string",
            "description":"Name that identifies a list of values that control whether a production operator can issue more than the required quantity while manually reporting material issues. You can allow issuing more than the required quantity without any hindrance, or prevent the material issue in case of additional material issue.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferencedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the operation references a standard operation. If false, then the operation doesn't reference a standard operation. The default value is false. If the value is true, then a valid value must be specified for the attribute StandardOperationCode.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the user key of the work center where this operation is executed.",
            "nullable":true,
            "x-queryable":true
        },
        "VariableLeadTime":{
            "type":"number",
            "description":"Variable lead time used to calculate the operation's start and end date based on the operation quantity for the supplier operation.",
            "nullable":true,
            "x-queryable":true
        },
        "StandardOperationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that represents the user key to the standard operation.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationName":{
            "maxLength":120,
            "type":"string",
            "description":"Value that indicates the name of the work definition operation.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":255,
            "type":"string",
            "description":"Names of the error messages that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Value that indicates the description of the work definition operation.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the error message, if any, that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true,
            "x-queryable":true
        },
        "AutoTransactFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then both resources and materials are automatically charged based on the supply type or the charge type setups for the operation. If the supply type is Operation Pull, the component-level issue transactions will occur when the operation is completed. If the supply type is Assembly Pull, the component level issue transactions will happen at the assembly completion event. The resource transactions are automatically done when the quantity is moved outside the operation. If false, then both resources and materials are not automatically charged. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the suggested supplier for a supplier operation.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationComplWithUnderIssue":{
            "maxLength":30,
            "type":"string",
            "description":"Name that identifies a list of values that control whether operation completion should be allowed when less than the required quantity of material is issued. You can allow operation completion without any hindrance, allow with a warning, or prevent the operation completion.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that defines the sequence of operation execution. A valid value must be a positive whole number.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialTrackingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the product is tracked by serial number while running the operation. If false, then the product is not tracked by serial number. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ResequenceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the work order has resequence operations. If false, then the work order doesn't have resequence operations. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that specifies the type of the operation. A list of accepted values is defined in the lookup type ORA_WIS_OPERATION_TYPE.",
            "nullable":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 : 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."
        }
    }
}

Back to Top