Jump to

• Request
• Response

Update one interorganization parameter

patch

/fscmRestApi/resources/11.13.18.05/interOrganizationParameters/{InterorganizationParametersId}

Request

Path Parameters

• InterorganizationParametersId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DFF: array DFF
• DistanceUOMCode: string
  Maximum Length: 3

  Value that identifies the distance unit of measure code.
• DistanceUOMName: string
  Maximum Length: 80

  Value that identifies the distance unit of measure.
• ExpenseDestinationRoutingMeaning: string
  Maximum Length: 80

  Value that identifies the routing for expense destination transfers.
• ExpenseDestReceiptRouting: string
  Maximum Length: 30

  Value that identifies the receipt routing code for expense destination transfers.
• FillKillExpToLookup: string
  Maximum Length: 30

  Default Value: ORG_LEVEL

  Value that identifies the expense destination transfer backorder setup code.
• FillKillExpToLookupMeaning: string
  Maximum Length: 80

  Value that identifies the expense destination transfer backorder setup name.
• FillKillInvToLookup: string
  Maximum Length: 30

  Default Value: ORG_LEVEL

  Value that identifies the inventory destination transfer backorder setup code.
• FillKillInvToLookupMeaning: string
  Maximum Length: 80

  Value that identifies the inventory destination transfer backorder setup name.
• IntransitType: string
  Maximum Length: 30

  Default Value: 1

  Value that identifies the transfer type setup code for inventory destination transfers.
• IntransitTypeMeaning: string
  Maximum Length: 80

  Value that identifies the transfer type setup for inventory destination transfers.
• ManualReceiptExpenseFlag: boolean
  Default Value: false

  Value that identifies the manual receipt setup for expense destination transfers.
• RoutingHeader: string
  Maximum Length: 80

  Value that identifies the routing setup for expense destination transfers.
• RoutingHeaderId: string
  Maximum Length: 30

  Value that uniquely identifies the routing setup for expense destination transfers.
• ToOrganizationDistance: number
  Number that identifies the distance between organizations.
• TransferOrderRequiredFlag: boolean
  Default Value: false

  Value identifying whether a transfer order is required.

{
    "type":"object",
    "properties":{
        "FillKillExpToLookup":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the expense destination transfer backorder setup code.",
            "nullable":true,
            "default":"ORG_LEVEL"
        },
        "TransferOrderRequiredFlag":{
            "type":"boolean",
            "description":"Value identifying whether a transfer order is required.",
            "nullable":true,
            "default":false
        },
        "ExpenseDestinationRoutingMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the routing for expense destination transfers.",
            "nullable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/interOrganizationParameters-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "IntransitTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the transfer type setup for inventory destination transfers.",
            "nullable":true
        },
        "DistanceUOMName":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the distance unit of measure.",
            "nullable":true
        },
        "RoutingHeader":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the routing setup for expense destination transfers.",
            "nullable":true
        },
        "FillKillExpToLookupMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the expense destination transfer backorder setup name.",
            "nullable":true
        },
        "ExpenseDestReceiptRouting":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the receipt routing code for expense destination transfers.",
            "nullable":true
        },
        "ToOrganizationDistance":{
            "type":"number",
            "description":"Number that identifies the distance between organizations.",
            "nullable":true
        },
        "FillKillInvToLookupMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the inventory destination transfer backorder setup name.",
            "nullable":true
        },
        "IntransitType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the transfer type setup code for inventory destination transfers.",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RoutingHeaderId":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the routing setup for expense destination transfers.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "IntransitType"
                ]
            }
        },
        "DistanceUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Value that identifies the distance unit of measure code.",
            "nullable":true
        },
        "ManualReceiptExpenseFlag":{
            "type":"boolean",
            "description":"Value that identifies the manual receipt setup for expense destination transfers.",
            "nullable":true,
            "default":false
        },
        "FillKillInvToLookup":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the inventory destination transfer backorder setup code.",
            "nullable":true,
            "default":"ORG_LEVEL"
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/interOrganizationParameters-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value

{
    "type":"object",
    "properties":{
        "__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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the interorganization parameter.
• CreationDate: string (date-time)
  Read Only: true

  Date when the interorganization parameter was created.
• DFF: array DFF
• DistanceUOMCode: string
  Maximum Length: 3

  Value that identifies the distance unit of measure code.
• DistanceUOMName: string
  Maximum Length: 80

  Value that identifies the distance unit of measure.
• ExpenseDestinationRoutingMeaning: string
  Maximum Length: 80

  Value that identifies the routing for expense destination transfers.
• ExpenseDestReceiptRouting: string
  Maximum Length: 30

  Value that identifies the receipt routing code for expense destination transfers.
• FillKillExpToLookup: string
  Maximum Length: 30

  Default Value: ORG_LEVEL

  Value that identifies the expense destination transfer backorder setup code.
• FillKillExpToLookupMeaning: string
  Maximum Length: 80

  Value that identifies the expense destination transfer backorder setup name.
• FillKillInvToLookup: string
  Maximum Length: 30

  Default Value: ORG_LEVEL

  Value that identifies the inventory destination transfer backorder setup code.
• FillKillInvToLookupMeaning: string
  Maximum Length: 80

  Value that identifies the inventory destination transfer backorder setup name.
• FromOrganizationCode: string
  Maximum Length: 18

  Value that identifies the from organization code.
• FromOrganizationId: integer (int64)
  Unique identifier for the from organization.
• FromOrganizationName: string
  Maximum Length: 80

  Name of the from organization.
• InterorganizationParametersId: integer (int64)
  Unique identifier for the interorganization parameter row.
• IntransitType: string
  Maximum Length: 30

  Default Value: 1

  Value that identifies the transfer type setup code for inventory destination transfers.
• IntransitTypeMeaning: string
  Maximum Length: 80

  Value that identifies the transfer type setup for inventory destination transfers.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualReceiptExpenseFlag: boolean
  Default Value: false

  Value that identifies the manual receipt setup for expense destination transfers.
• RoutingHeader: string
  Maximum Length: 80

  Value that identifies the routing setup for expense destination transfers.
• RoutingHeaderId: string
  Maximum Length: 30

  Value that uniquely identifies the routing setup for expense destination transfers.
• ToOrganizationCode: string
  Maximum Length: 18

  Value that identifies the to organization code.
• ToOrganizationDistance: number
  Number that identifies the distance between organizations.
• ToOrganizationId: integer (int64)
  Unique identifier for the to organization.
• ToOrganizationName: string
  Maximum Length: 80

  Name of the to organization.
• TransferOrderRequiredFlag: boolean
  Default Value: false

  Value identifying whether a transfer order is required.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the interorganization parameter was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TransferOrderRequiredFlag":{
            "type":"boolean",
            "description":"Value identifying whether a transfer order is required.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "FromOrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Value that identifies the from organization code.",
            "nullable":true,
            "x-queryable":true
        },
        "ToOrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Value that identifies the to organization code.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/interOrganizationParameters-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "InterorganizationParametersId":{
            "type":"integer",
            "description":"Unique identifier for the interorganization parameter row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RoutingHeader":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the routing setup for expense destination transfers.",
            "nullable":true,
            "x-queryable":true
        },
        "FillKillExpToLookupMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the expense destination transfer backorder setup name.",
            "nullable":true,
            "x-queryable":true
        },
        "IntransitType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the transfer type setup code for inventory destination transfers.",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RoutingHeaderId":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the routing setup for expense destination transfers.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "IntransitType"
                ]
            },
            "x-queryable":true
        },
        "ManualReceiptExpenseFlag":{
            "type":"boolean",
            "description":"Value that identifies the manual receipt setup for expense destination transfers.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ToOrganizationName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the to organization.",
            "nullable":true,
            "x-queryable":true
        },
        "FillKillInvToLookup":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the inventory destination transfer backorder setup code.",
            "nullable":true,
            "default":"ORG_LEVEL",
            "x-queryable":true
        },
        "FromOrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the from organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FillKillExpToLookup":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the expense destination transfer backorder setup code.",
            "nullable":true,
            "default":"ORG_LEVEL",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the interorganization parameter.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ExpenseDestinationRoutingMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the routing for expense destination transfers.",
            "nullable":true,
            "x-queryable":true
        },
        "IntransitTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the transfer type setup for inventory destination transfers.",
            "nullable":true,
            "x-queryable":true
        },
        "DistanceUOMName":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the distance unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "ToOrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the to organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpenseDestReceiptRouting":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the receipt routing code for expense destination transfers.",
            "nullable":true,
            "x-queryable":true
        },
        "ToOrganizationDistance":{
            "type":"number",
            "description":"Number that identifies the distance between organizations.",
            "nullable":true,
            "x-queryable":true
        },
        "FillKillInvToLookupMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the inventory destination transfer backorder setup name.",
            "nullable":true,
            "x-queryable":true
        },
        "DistanceUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Value that identifies the distance unit of measure code.",
            "nullable":true,
            "x-queryable":true
        },
        "FromOrganizationName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the from organization.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/interOrganizationParameters-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 : interOrganizationParameters-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• InterorgParametersId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InterorgParametersId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__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":"HIDDEN"
            },
            "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":"Context Value",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "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":"HIDDEN"
            },
            "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."
        }
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/interOrganizationParameters/{InterorganizationParametersId}/child/DFF

Parameters:

• InterorganizationParametersId: $request.path.InterorganizationParametersId

Back to Top