1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. SCM Common
  4. Inventory Organizations
  5. Plant Parameters

Get all plant parameters

get

/fscmRestApi/resources/11.13.18.05/inventoryOrganizations/{OrganizationId}/child/plantParameters

Request

Path Parameters
  • Value that uniquely identifies the item or inventory organization. It is a primary key that the application generates when it creates an item or inventory organization.
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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds plant parameters for an organization according to the unique organization identification.
      Finder Variables:
      • OrganizationId; integer; Value that uniquely identifies the organization. It is a primary key that the application generates when it creates an item. This attribute is required.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AllowDirectPurchasesForWorkOrdersFlag; boolean; Contains one of the following values: true or false. If true, then allow a work definition to access self-service procurement. If false, then do not allow this access. The default value is false.
    • AllowNegativeIssueWithoutSerialNumberEntryFlag; boolean; Contains one of the following values: true or false. If true, then removing a part from a procured finished good will not require the user to specify the serial number of the part. If false, then removing a part from a procured finished good will require the user to specify the serial number of the part. The default value is false.
    • AllowReservationsOnWorkOrdersFlag; boolean; Contains one of the following values: true or false. If true, then the work order allows reservations on specified materials. If false, then reservations are not permitted. The default value is false.
    • AutoAssociateSerialNumberWorkOrderImportFlag; boolean; Contains one of the following values: true or false. If true, then create serial numbers and associate them with a job. If false, then do not create serial numbers. The default value is true.
    • BackflushLotSelection; string; Determines the lots to use when performing a backflush. Valid values include Manual, First In First Out, or First Expiration First Out.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • DefaultCompletionLocator; integer; Locator to use to store the product upon completion if the default isn't defined. The default completion subinventory controls whether or not the locator is required.
    • DefaultCompletionSubinventory; string; Subinventory to use to store the product upon completion if the default isn't defined.
    • DefaultIncludeInPlanningForBulkSupplyTypeFlag; boolean; Contains one of the following values: true or false. If true, then the default behavior is to include an operation item in planning when the operation item supply type is bulk. If false, then it's not. The default value is true.
    • DefaultIncludeInPlanningForSupplierSupplyTypeFlag; boolean; Contains one of the following values: true or false. If true, then the default behavior is to include an operation item in planning when the operation item supply type is supplier. If false, then it's not. The default value is true.
    • DefaultLabelTemplate; string; Layout template to use when printing labels.
    • DefaultLotNumberBehavior; string; Value that indicates the defaulting method to use to populate the lot number for the finished product. Valid values include No default and Work order number. The default value is No default.
    • DefaultMaterialReviewBoardLocator; integer; Default value of the locator to use when returning defective or unserviceable components while performing maintenance.
    • DefaultMaterialReviewBoardSubinventory; string; Default value of the subinventory to use when returning defective or unserviceable components while performing maintenance.
    • DefaultOvercompletionTolerance; number; Percent of assemblies that you can overcomplete for each job or schedule.
    • DefaultPickSlipGroupingRule; integer; Determines the grouping rule to use as the default for the pick slip in each manufacturing work order. The application shares the set of values with the Picking Rule inventory organization parameter in the Item Sourcing Details tab of the Manage Inventory Organization Parameters page.
    • DefaultSupplyLocator; integer; Locator to use when performing a backflushing operation that pulls and assembles components, and that doesn'thave default values defined. The default supply subinventory controls whether or not the locator is required.
    • DefaultSupplySubinventory; string; Subinventory to use when performing a backflushing operation that pulls and assembles components, and that doesn'thave default values defined.
    • DefaultTransactionMode; string; Specifies whether to allow inventory management to default the transaction quantity to the required quantity during a material transaction or resource transaction in the work order.
    • DefaultTransactionQuantity; string; Enables the default transaction mode. If the user chooses All Mode All Components, then inventory management defaults the resources that it uses for the operation, and the user can create a transaction that uses these resources.
    • DefaultUndercompletionTolerance; number; Percent of assemblies that you can undercomplete for each job or schedule.
    • DefaultWorkMethod; string; Value that determines which manufacturing method will be the default when defining the work definition. Valid values include Discrete or Process.
    • DefaultWorkOrderTravelerTemplate; string; Layout template to use when printing the work order traveler.
    • EnableIotFlag; boolean; Contains one of the following values: true or false. If true, then the plant is synchronized to Oracle Internet of Things Cloud Service. If false, then the plant isn't synchronized. The default value is false.
    • EnableProcessManufacturingFlag; boolean; Contains one of the following values: true or false. If true, then the plant supports process manufacturing. If false, then the plant only supports discrete manufacturing. The default value is false.
    • EnableRoboticsFlag; boolean; Contains one of the following values: true or false. If true, then the plant uses robotic resources. If false, then the plant doesn't use robotic resources. The default value is false.
    • ForecastHorizon; integer; Maximum number of days that the Maintenance Forecast scheduled process calculates. The value for this attribute must be a positive integer. The default value is 30.
    • GenerateWorkOrdersHorizon; integer; Maximum number of days that the Generate Work Order scheduled process calculates. The value for this attribute must be a positive integer. The default value is 7.
    • IncludeComponentYieldFlag; boolean; Contains one of the following values: true or false. If true, then do not round each decimal quantity. If false, then round each decimal quantity. The default value is false.
    • IncludeOperationYieldFlag; boolean; Contains one of the following values: true or false. If true, then the material and resource requirements in a work order are calculated based on the operation yield values, if these are specified in the work definition. If false, then the operation yield values aren't used in these calculations for this plant. The default value is false.
    • IncludePullComponentsFlag; boolean; Contains one of the following values: true or false. If true, then pick components that use the supply type operation pull or assembly pull in the work order. If false, then do not pick these components. The default value is false.
    • InspectionPlanType; string; Value of the default inspection plan for the maintenance facility.
    • IssuePushComponentsFlag; boolean; Contains one of the following values: true or false. If true, then push components that the application issues directly to the work order. If false, then don't push these components. The default value is false.
    • LastUpdateDate; string; Date and time when the user most recently updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • ManuallyIssueAssemblyToReworkWorkOrderFlag; boolean; Contains one of the following values: true or false. If true, then the assembly must be manually issued for rework. If false, then retain the automatic issuing behavior in the plant. The default value is false.
    • ManufacturingCalendarId; integer; Value that uniquely identifies the schedule that the organization references as the manufacturing calendar. This attribute is required.
    • ManufacturingCalendarName; string; The name of the schedule that the organization references as the manufacturing calendar.
    • MaterialReportingLevel; string; Determines the level when the dispatch list displays material reporting icons.
    • MaximumSchedulingDurationInMonths; integer; Maximum allowed duration in months to use when scheduling a work order. The minimum value is 3 months and the maximum value is 48 months. The default value is 12 months.
    • OperationSequenceIncrement; integer; Value that increments the sequence number for each new operation added in the work definition.
    • OrganizationId; integer; Value that uniquely identifies the item or inventory organization. It is a primary key that the application generates when it creates an item or inventory organization.
    • PhantomOperationInherit; string; Determines whether to charge the components, resources, and overhead from the phantom work definition, or to get them from the operation sequence that's defined for the parent work item.
    • PrintLabelExternallyFlag; boolean; Contains one of the following values: true or false. If true, then call a business event that uses an application outside of Oracle Fusion applications to print the label. If false, then use an Oracle Fusion Application to print the label. The default value is false.
    • PrintPickSlipsFlag; boolean; Contains one of the following values: true or false. If true, then print the pick slips. If false, then do not print the pick slips. The default value is false.
    • PurchaseRequisitionCreationTime; string; Threshold to use when creating purchase requisitions for a work order that involves a supplier operation, and that requires outside processing.
    • QuantityChangeBackflush; string; Determines whether or not Oracle Inventory Management Cloud allows a change to the transaction quantity in the work order.
    • RestrictLotsDuringReturnsFlag; boolean; Contains one of the following values: true or false. If true, then during returns, the choices for the lot are restricted to only those that have been transacted for the manufactured item. If false, then any lot can be selected. The default value is false.
    • StartStopCaptureLevel; string; Determines how to capture time for each serial operation that occurs when performing the work order. Valid values include Operation Serial or Item Serial.
    • StartingOperationSequence; integer; Default sequence number for the first operation in a new work definition.
    • WorkOrderPrefix; string; Alphanumeric text to add as a prefix to the work order name when creating the work order name.
    • WorkOrderStartingNumber; integer; The starting numeric value to use in the document sequence when creating each work order number at the plant.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : inventoryOrganizations-plantParameters
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : inventoryOrganizations-plantParameters-item-response
Type: object
Show Source
  • Title: Allow direct purchases for work orders
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then allow a work definition to access self-service procurement. If false, then do not allow this access. The default value is false.
  • Title: Allow negative issue without serial number entry
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then removing a part from a procured finished good will not require the user to specify the serial number of the part. If false, then removing a part from a procured finished good will require the user to specify the serial number of the part. The default value is false.
  • Title: Allow reservations for work order materials
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work order allows reservations on specified materials. If false, then reservations are not permitted. The default value is false.
  • Title: Automatically associate serial numbers during work order import
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then create serial numbers and associate them with a job. If false, then do not create serial numbers. The default value is true.
  • Title: Lot Selection During Backflush
    Maximum Length: 30
    Default Value: ORA_RCS_BFL_MANUAL
    Determines the lots to use when performing a backflush. Valid values include Manual, First In First Out, or First Expiration First Out.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Title: Default Completion Locator
    Locator to use to store the product upon completion if the default isn't defined. The default completion subinventory controls whether or not the locator is required.
  • Title: Default Completion Subinventory
    Maximum Length: 10
    Subinventory to use to store the product upon completion if the default isn't defined.
  • Title: Bulk
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the default behavior is to include an operation item in planning when the operation item supply type is bulk. If false, then it's not. The default value is true.
  • Title: Supplier
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the default behavior is to include an operation item in planning when the operation item supply type is supplier. If false, then it's not. The default value is true.
  • Maximum Length: 400
    Layout template to use when printing labels.
  • Title: Default Lot Number Used for Product Completion
    Maximum Length: 30
    Default Value: ORA_RCS_DLN_NO_DEF
    Value that indicates the defaulting method to use to populate the lot number for the finished product. Valid values include No default and Work order number. The default value is No default.
  • Title: Default Locator for Material Review Board
    Default value of the locator to use when returning defective or unserviceable components while performing maintenance.
  • Title: Default Subinventory for Material Review Board
    Maximum Length: 10
    Default value of the subinventory to use when returning defective or unserviceable components while performing maintenance.
  • Title: Default Overcompletion Tolerance Percentage
    Percent of assemblies that you can overcomplete for each job or schedule.
  • Title: Default Pick Slip Grouping Rule
    Determines the grouping rule to use as the default for the pick slip in each manufacturing work order. The application shares the set of values with the Picking Rule inventory organization parameter in the Item Sourcing Details tab of the Manage Inventory Organization Parameters page.
  • Title: Default Supply Locator
    Locator to use when performing a backflushing operation that pulls and assembles components, and that doesn'thave default values defined. The default supply subinventory controls whether or not the locator is required.
  • Title: Default Supply Subinventory
    Maximum Length: 10
    Subinventory to use when performing a backflushing operation that pulls and assembles components, and that doesn'thave default values defined.
  • Title: Default Transaction Mode
    Maximum Length: 1
    Default Value: 1
    Specifies whether to allow inventory management to default the transaction quantity to the required quantity during a material transaction or resource transaction in the work order.
  • Title: Default Transaction Quantity
    Maximum Length: 1
    Default Value: 4
    Enables the default transaction mode. If the user chooses All Mode All Components, then inventory management defaults the resources that it uses for the operation, and the user can create a transaction that uses these resources.
  • Title: Default Undercompletion Tolerance Percentage
    Percent of assemblies that you can undercomplete for each job or schedule.
  • Title: Default Work Method
    Maximum Length: 30
    Value that determines which manufacturing method will be the default when defining the work definition. Valid values include Discrete or Process.
  • Maximum Length: 400
    Layout template to use when printing the work order traveler.
  • Title: Enable synchronization to IoT Production Monitoring
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the plant is synchronized to Oracle Internet of Things Cloud Service. If false, then the plant isn't synchronized. The default value is false.
  • Title: Enable process manufacturing
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the plant supports process manufacturing. If false, then the plant only supports discrete manufacturing. The default value is false.
  • Title: Automate manufacturing execution with robotic and industrial equipment
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the plant uses robotic resources. If false, then the plant doesn't use robotic resources. The default value is false.
  • Title: Forecast Horizon in Days
    Maximum number of days that the Maintenance Forecast scheduled process calculates. The value for this attribute must be a positive integer. The default value is 30.
  • Title: Generate Work Orders Horizon in Days
    Maximum number of days that the Generate Work Order scheduled process calculates. The value for this attribute must be a positive integer. The default value is 7.
  • Title: Include component yield in material requirements
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then do not round each decimal quantity. If false, then round each decimal quantity. The default value is false.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the material and resource requirements in a work order are calculated based on the operation yield values, if these are specified in the work definition. If false, then the operation yield values aren't used in these calculations for this plant. The default value is false.
  • Title: Include pull components for pick release
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then pick components that use the supply type operation pull or assembly pull in the work order. If false, then do not pick these components. The default value is false.
  • Title: Inspection Plan Type
    Maximum Length: 30
    Value of the default inspection plan for the maintenance facility.
  • Title: Issue push components on pick release
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then push components that the application issues directly to the work order. If false, then don't push these components. The default value is false.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Title: Manually issue assembly to rework work order
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the assembly must be manually issued for rework. If false, then retain the automatic issuing behavior in the plant. The default value is false.
  • Title: Manufacturing Calendar
    Value that uniquely identifies the schedule that the organization references as the manufacturing calendar. This attribute is required.
  • The name of the schedule that the organization references as the manufacturing calendar.
  • Title: Material Reporting Level for Serialization Operations
    Maximum Length: 30
    Determines the level when the dispatch list displays material reporting icons.
  • Title: Maximum Scheduling Duration in Months
    Default Value: 12
    Maximum allowed duration in months to use when scheduling a work order. The minimum value is 3 months and the maximum value is 48 months. The default value is 12 months.
  • Title: Operation Sequence Increment
    Default Value: 10
    Value that increments the sequence number for each new operation added in the work definition.
  • Value that uniquely identifies the item or inventory organization. It is a primary key that the application generates when it creates an item or inventory organization.
  • Title: Phantom Operation Inheritance
    Maximum Length: 18
    Default Value: 1
    Determines whether to charge the components, resources, and overhead from the phantom work definition, or to get them from the operation sequence that's defined for the parent work item.
  • Title: Print product labels using external applications
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then call a business event that uses an application outside of Oracle Fusion applications to print the label. If false, then use an Oracle Fusion Application to print the label. The default value is false.
  • Title: Print pick slips
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then print the pick slips. If false, then do not print the pick slips. The default value is false.
  • Title: Purchase Requisition Trigger
    Maximum Length: 30
    Threshold to use when creating purchase requisitions for a work order that involves a supplier operation, and that requires outside processing.
  • Title: Allow Quantity Changes During Backflush
    Maximum Length: 1
    Default Value: 1
    Determines whether or not Oracle Inventory Management Cloud allows a change to the transaction quantity in the work order.
  • Title: Restrict lot numbers during returns
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then during returns, the choices for the lot are restricted to only those that have been transacted for the manufactured item. If false, then any lot can be selected. The default value is false.
  • Title: Starting Operation Sequence
    Default Value: 10
    Default sequence number for the first operation in a new work definition.
  • Maximum Length: 30
    Determines how to capture time for each serial operation that occurs when performing the work order. Valid values include Operation Serial or Item Serial.
  • Title: Work Order Prefix
    Maximum Length: 30
    Alphanumeric text to add as a prefix to the work order name when creating the work order name.
  • Default Value: 1000
    The starting numeric value to use in the document sequence when creating each work order number at the plant.
Back to Top

Examples

This example describes how to get plant parameters.

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/inventoryOrganizations/OrganizationId/child/plantParameters/"

For example, the following command gets plant parameters for organization 204:

curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryOrganizations/204/child/plantParameters/"

Example Response Body

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

{
  "items" : [ {
    "OrganizationId" : 204,
    "ManufacturingCalendarId" : 300100071648734,
    "DefaultSupplySubinventory" : "Stores",
    "DefaultSupplyLocator" : null,
    "DefaultCompletionSubinventory" : "Stores",
    "DefaultCompletionLocator" : null,
    "StartingOperationSequence" : 10,
    "OperationSequenceIncrement" : 10,
    "PhantomOperationInherit" : "2",
    "WorkOrderPrefix" : null,
    "WorkOrderStartingNumber" : 1000,
    "DefaultOvercompletionTolerance" : null,
    "DefaultTransactionMode" : "1",
    "DefaultTransactionQuantity" : "4",
    "QuantityChangeBackflush" : "4",
    "DefaultWorkOrderTravelerTemplate" : null,
    "DefaultLabelTemplate" : null,
    "IncludeComponentYieldFlag" : false,
    "AutoAssociateSerialNumberWorkOrderImportFlag" : "false",
    "StartStopCaptureLevel" : null,
    "PurchaseRequisitionCreationTime" : null,
...
  } ],
...
}
Back to Top