Jump to

• Request
• Response

Create flexfields

post

/fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/locators/{InventoryLocationId}/child/locatorsKeyFlex

Request

Path Parameters

• InventoryLocationId(required): integer(int64)
  Value that uniquely identifies the locator.
• subinventoriesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrganizationId and SecondaryInventoryName ---for the Subinventories resource and used to uniquely identify an instance of Subinventories. The client should not generate the hash key value. Instead, the client should query on the Subinventories collection resource with a filter on the primary key values in order to navigate to a specific instance of Subinventories.
  
  For example: subinventories?q=OrganizationId=<value1>;SecondaryInventoryName=<value2>

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Discriminator: _STRUCTURE_INSTANCE_NUMBER

Type: object

Discriminator: _STRUCTURE_INSTANCE_NUMBER

Discriminator Values

• 1025

{
    "discriminator":{
        "propertyName":"_STRUCTURE_INSTANCE_NUMBER",
        "mapping":{
            "1025":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-post-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-post-request"
        }
    ]
}

Match One Schema

Show Source

• 1025 - object oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-post-request

{
    "discriminator":{
        "propertyName":"_STRUCTURE_INSTANCE_NUMBER",
        "mapping":{
            "1025":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-post-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-post-request"
        }
    ]
}

Nested Schema : oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-post-request

Type: object

Show Source

• _INVENTORY_LOCATION_ID: integer (int64)
  Title: Locator

  Number that uniquely identifies the locator.
• _STRUCTURE_INSTANCE_NUMBER: integer (int64)
  Title: Locator Structure

  Default Value: 1025

  Value that uniquely identifies the locator structure for the subinventory when a locator control is enabled for the subinventory.
• _SUBINVENTORY_ID: integer (int64)
  Value that uniquely identifies subinventory.
• aisle: string
  Title: Aisle

  Maximum Length: 40
• bin: string
  Title: Bin

  Maximum Length: 40
• EnabledFlag: string
  Maximum Length: 1

  Default Value: Y

  Contains one of the following values. Y: enable the locator. N: do not enable the locator. There is no default value for this attribute.
• EndDateActive: string (date)
  Date when the locator becomes inactive.
• rack: string
  Title: Rack

  Maximum Length: 40
• row: string
  Title: Row

  Maximum Length: 40
• StartDateActive: string (date)
  Date when the locator becomes active.

{
    "type":"object",
    "properties":{
        "StartDateActive":{
            "type":"string",
            "description":"Date when the locator becomes active.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EndDateActive":{
            "type":"string",
            "description":"Date when the locator becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "rack":{
            "title":"Rack",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"rack",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Rack",
                "FND_ACFF_SegSeqNo":"3"
            }
        },
        "bin":{
            "title":"Bin",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"bin",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Bin",
                "FND_ACFF_SegSeqNo":"4"
            }
        },
        "_INVENTORY_LOCATION_ID":{
            "title":"Locator",
            "type":"integer",
            "description":"Number that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_IsCCID":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "_SUBINVENTORY_ID":{
            "type":"integer",
            "description":"Value that uniquely identifies subinventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "FND_ACFF_IsDataSetNumber":"true",
                "FND_ACFF_JavaType":"java.lang.Long"
            }
        },
        "row":{
            "title":"Row",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"row",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Row",
                "FND_ACFF_SegSeqNo":"2"
            }
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values. Y: enable the locator. N: do not enable the locator. There is no default value for this attribute.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "aisle":{
            "title":"Aisle",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"aisle",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Aisle",
                "FND_ACFF_SegSeqNo":"1"
            }
        },
        "_STRUCTURE_INSTANCE_NUMBER":{
            "title":"Locator Structure",
            "type":"integer",
            "description":"Value that uniquely identifies the locator structure for the subinventory when a locator control is enabled for the subinventory.",
            "format":"int64",
            "nullable":true,
            "default":1025,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "FND_ACFF_IsStructureID":"true",
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_StructureLookupRequired":"false"
            }
        }
    }
}

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 : Discriminator: _STRUCTURE_INSTANCE_NUMBER

Type: object

Discriminator: _STRUCTURE_INSTANCE_NUMBER

Discriminator Values

• 1025

{
    "discriminator":{
        "propertyName":"_STRUCTURE_INSTANCE_NUMBER",
        "mapping":{
            "1025":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    ]
}

Match One Schema

Show Source

• 1025 - object oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response

{
    "discriminator":{
        "propertyName":"_STRUCTURE_INSTANCE_NUMBER",
        "mapping":{
            "1025":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response

Type: object

Show Source

• _INVENTORY_LOCATION_ID: integer (int64)
  Title: Locator

  Number that uniquely identifies the locator.
• _STRUCTURE_INSTANCE_NUMBER: integer (int64)
  Title: Locator Structure

  Default Value: 1025

  Value that uniquely identifies the locator structure for the subinventory when a locator control is enabled for the subinventory.
• _SUBINVENTORY_ID: integer (int64)
  Value that uniquely identifies subinventory.
• aisle: string
  Title: Aisle

  Maximum Length: 40
• bin: string
  Title: Bin

  Maximum Length: 40
• EnabledFlag: string
  Maximum Length: 1

  Default Value: Y

  Contains one of the following values. Y: enable the locator. N: do not enable the locator. There is no default value for this attribute.
• EndDateActive: string (date)
  Date when the locator becomes inactive.
• links: array Links
  Title: Links

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

  Maximum Length: 40
• row: string
  Title: Row

  Maximum Length: 40
• StartDateActive: string (date)
  Date when the locator becomes active.

{
    "type":"object",
    "properties":{
        "StartDateActive":{
            "type":"string",
            "description":"Date when the locator becomes active.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EndDateActive":{
            "type":"string",
            "description":"Date when the locator becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "rack":{
            "title":"Rack",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"rack",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Rack",
                "FND_ACFF_SegSeqNo":"3"
            }
        },
        "bin":{
            "title":"Bin",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"bin",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Bin",
                "FND_ACFF_SegSeqNo":"4"
            }
        },
        "_INVENTORY_LOCATION_ID":{
            "title":"Locator",
            "type":"integer",
            "description":"Number that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_IsCCID":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "_SUBINVENTORY_ID":{
            "type":"integer",
            "description":"Value that uniquely identifies subinventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "FND_ACFF_IsDataSetNumber":"true",
                "FND_ACFF_JavaType":"java.lang.Long"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "row":{
            "title":"Row",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"row",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Row",
                "FND_ACFF_SegSeqNo":"2"
            }
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values. Y: enable the locator. N: do not enable the locator. There is no default value for this attribute.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "aisle":{
            "title":"Aisle",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"aisle",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Aisle",
                "FND_ACFF_SegSeqNo":"1"
            }
        },
        "_STRUCTURE_INSTANCE_NUMBER":{
            "title":"Locator Structure",
            "type":"integer",
            "description":"Value that uniquely identifies the locator structure for the subinventory when a locator control is enabled for the subinventory.",
            "format":"int64",
            "nullable":true,
            "default":1025,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "FND_ACFF_IsStructureID":"true",
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_StructureLookupRequired":"false"
            }
        }
    }
}

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