Jump to

• Request
• Response

Get all inter subinventory parameteres.

get

/fscmRestApi/resources/11.13.18.05/interSubinventoryParameters

Request

Query Parameters

• 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
• finder: string
  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 inter subinventory parameteres according to IntersubParametersId
    Finder Variables:
    • IntersubParametersId; integer; Value that uniquely identifies inter subinventory parameteres
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • DestinationType; string; Value that provides meaning for the destination type based on it's code.
  • DestinationTypeCode; string; Code that uniquely identifies destination type of current inter subinventory parameteres.
  • EndDate; string; Value that identifies end date for current inter subinventory parameteres.
  • FromSubinventory; string; Value that identifies source subinventory for current inter subinventory parameteres.
  • IntersubParametersId; integer; Value that uniquely identifies the current inter subinventory parameteres.
  • ManualReceiptExpenseFlag; boolean; Value that indicates if manual receipt is required for current inter subinventory parameteres. Valid values are true and false. The default value is false.
  • OrganizationCode; string; Code that uniquely identifies organization.
  • OrganizationId; integer; Value that uniquely identifies organization.
  • ReceiptRouting; string; Value that provides meaning for the receipt routing based on it's code.
  • ReceiptRoutingCode; string; Code that uniquely identifies receipt routing of current inter subinventory parameteres.
  • StartDate; string; Value that identifies start date for current inter subinventory parameteres.
  • ToSubinventory; string; Value that identifies destination subinventory for current inter subinventory parameteres.
  • TransferOrderRequired; string; Value that identifies if transfer order is required for current inter subinventory parameteres.
  • TransferType; string; Value that provides meaning for the transfer type based on it's code.
  • TransferTypeCode; string; Code that uniquely identifies transfer type of current inter subinventory parameteres.
• totalResults: boolean
  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

• Metadata-Context: string
  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: string
  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 : interSubinventoryParameters

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/interSubinventoryParameters-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object interSubinventoryParameters-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/interSubinventoryParameters-item-response"
    }
}

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 : interSubinventoryParameters-item-response

Type: object

Show Source

• DestinationType: string
  Maximum Length: 255

  Value that provides meaning for the destination type based on it's code.
• DestinationTypeCode: string
  Title: Destination Type

  Maximum Length: 30

  Code that uniquely identifies destination type of current inter subinventory parameteres.
• DFF: array Inter Subinventory Parameters Descriptive Flexfields
  Title: Inter Subinventory Parameters Descriptive Flexfields

  Descriptive flexfield corresponding to a inter subinventory parameters.
• EndDate: string (date)
  Title: End Date

  Value that identifies end date for current inter subinventory parameteres.
• FromSubinventory: string
  Title: Source Subinventory

  Maximum Length: 10

  Value that identifies source subinventory for current inter subinventory parameteres.
• IntersubParametersId: integer (int64)
  Value that uniquely identifies the current inter subinventory parameteres.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualReceiptExpenseFlag: boolean
  Value that indicates if manual receipt is required for current inter subinventory parameteres. Valid values are true and false. The default value is false.
• OrganizationCode: string
  Maximum Length: 255

  Code that uniquely identifies organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies organization.
• ReceiptRouting: string
  Maximum Length: 255

  Value that provides meaning for the receipt routing based on it's code.
• ReceiptRoutingCode: string
  Title: Receipt Routing

  Maximum Length: 30

  Code that uniquely identifies receipt routing of current inter subinventory parameteres.
• StartDate: string (date)
  Title: Start Date

  Value that identifies start date for current inter subinventory parameteres.
• ToSubinventory: string
  Title: Destination Subinventory

  Maximum Length: 10

  Value that identifies destination subinventory for current inter subinventory parameteres.
• TransferOrderRequired: string
  Maximum Length: 1

  Value that identifies if transfer order is required for current inter subinventory parameteres.
• TransferType: string
  Maximum Length: 255

  Value that provides meaning for the transfer type based on it's code.
• TransferTypeCode: string
  Title: Inventory Destination Transfer Type

  Maximum Length: 30

  Code that uniquely identifies transfer type of current inter subinventory parameteres.

{
    "type":"object",
    "properties":{
        "DestinationTypeCode":{
            "title":"Destination Type",
            "maxLength":30,
            "type":"string",
            "description":"Code that uniquely identifies destination type of current inter subinventory parameteres.",
            "nullable":false,
            "x-queryable":true
        },
        "ReceiptRoutingCode":{
            "title":"Receipt Routing",
            "maxLength":30,
            "type":"string",
            "description":"Code that uniquely identifies receipt routing of current inter subinventory parameteres.",
            "nullable":true,
            "x-queryable":true
        },
        "TransferOrderRequired":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies if transfer order is required for current inter subinventory parameteres.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "title":"Inter Subinventory Parameters Descriptive Flexfields",
            "type":"array",
            "description":"Descriptive flexfield corresponding to a inter subinventory parameters.",
            "items":{
                "$ref":"#/components/schemas/interSubinventoryParameters-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "IntersubParametersId":{
            "type":"integer",
            "description":"Value that uniquely identifies the current inter subinventory parameteres.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DestinationType":{
            "maxLength":255,
            "type":"string",
            "description":"Value that provides meaning for the destination type based on it's code.",
            "nullable":true,
            "x-queryable":true
        },
        "TransferType":{
            "maxLength":255,
            "type":"string",
            "description":"Value that provides meaning for the transfer type based on it's code.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Value that identifies end date for current inter subinventory parameteres.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Value that identifies start date for current inter subinventory parameteres.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FromSubinventory":{
            "title":"Source Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Value that identifies source subinventory for current inter subinventory parameteres.",
            "nullable":true,
            "x-queryable":true
        },
        "ToSubinventory":{
            "title":"Destination Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Value that identifies destination subinventory for current inter subinventory parameteres.",
            "nullable":true,
            "x-queryable":true
        },
        "TransferTypeCode":{
            "title":"Inventory Destination Transfer Type",
            "maxLength":30,
            "type":"string",
            "description":"Code that uniquely identifies transfer type of current inter subinventory parameteres.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code that uniquely identifies organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ManualReceiptExpenseFlag":{
            "type":"boolean",
            "description":"Value that indicates if manual receipt is required for current inter subinventory parameteres. Valid values are true and false. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReceiptRouting":{
            "maxLength":255,
            "type":"string",
            "description":"Value that provides meaning for the receipt routing based on it's code.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Inter Subinventory Parameters Descriptive Flexfields

Type: array

Title: Inter Subinventory Parameters Descriptive Flexfields

Descriptive flexfield corresponding to a inter subinventory parameters.

Show Source

• Array of: object interSubinventoryParameters-DFF-item-response

{
    "title":"Inter Subinventory Parameters Descriptive Flexfields",
    "type":"array",
    "description":"Descriptive flexfield corresponding to a inter subinventory parameters.",
    "items":{
        "$ref":"#/components/schemas/interSubinventoryParameters-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 : interSubinventoryParameters-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for a inter subinventory parameteres.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• IntersubParametersId: integer (int64)
  Value that uniquely identifies the current inter subinventory parameteres.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "IntersubParametersId":{
            "type":"integer",
            "description":"Value that uniquely identifies the current inter subinventory parameteres.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "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":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for a inter subinventory parameteres.",
            "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":"TEXT_BOX"
            },
            "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 : 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