Jump to

• Request
• Response

Update one shipping exception configuration

patch

/fscmRestApi/resources/11.13.18.05/shippingExceptionConfigurations/{ExceptionDefinitionId}

Request

Path Parameters

• ExceptionDefinitionId(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: 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the shipping exception is active. If false, then the shipping exception isn't active.
• DFF: array DFF
• ExceptionDescription: string
  Title: Description

  Maximum Length: 100

  Description of the shipping exception.
• ExceptionName: string
  Title: Name

  Maximum Length: 80

  Name of the shipping exception.
• ExceptionSeverity: string
  Maximum Length: 255

  Severity of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_BEHAVIOR.
• ExceptionSeverityCode: string
  Title: Severity

  Maximum Length: 10

  Abbreviation that identifies the severity of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_BEHAVIOR.
• ExceptionType: string
  Maximum Length: 255

  Type of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_LEVEL.
• ExceptionTypeCode: string
  Title: Type

  Maximum Length: 30

  Abbreviation that identifies the type of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_LEVEL.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipping exception is active. If false, then the shipping exception isn't active.",
            "nullable":false,
            "default":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shippingExceptionConfigurations-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "ExceptionDescription":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"Description of the shipping exception.",
            "nullable":false
        },
        "ExceptionName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the shipping exception.",
            "nullable":false
        },
        "ExceptionSeverity":{
            "maxLength":255,
            "type":"string",
            "description":"Severity of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_BEHAVIOR.",
            "nullable":true
        },
        "ExceptionSeverityCode":{
            "title":"Severity",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the severity of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_BEHAVIOR.",
            "nullable":false
        },
        "ExceptionType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_LEVEL.",
            "nullable":true
        },
        "ExceptionTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_LEVEL.",
            "nullable":false
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shippingExceptionConfigurations-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
• ExceptionDefinitionId: integer (int64)

{
    "type":"object",
    "properties":{
        "ExceptionDefinitionId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "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"
                }
            }
        }
    }
}

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

Type: object

Show Source

• ActiveFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the shipping exception is active. If false, then the shipping exception isn't active.
• DFF: array DFF
• ExceptionCode: string
  Read Only: true

  Maximum Length: 100

  Abbreviation that identifies the shipping exception.
• ExceptionDefinitionId: integer (int64)
  Value that uniquely identifies the shipping exception.
• ExceptionDescription: string
  Title: Description

  Maximum Length: 100

  Description of the shipping exception.
• ExceptionName: string
  Title: Name

  Maximum Length: 80

  Name of the shipping exception.
• ExceptionSeverity: string
  Maximum Length: 255

  Severity of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_BEHAVIOR.
• ExceptionSeverityCode: string
  Title: Severity

  Maximum Length: 10

  Abbreviation that identifies the severity of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_BEHAVIOR.
• ExceptionType: string
  Maximum Length: 255

  Type of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_LEVEL.
• ExceptionTypeCode: string
  Title: Type

  Maximum Length: 30

  Abbreviation that identifies the type of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_LEVEL.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PredefinedFlag: boolean
  Title: Predefined

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the shipping exception is predefined. If false, then the shipping exception is defined by the user.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipping exception is active. If false, then the shipping exception isn't active.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shippingExceptionConfigurations-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ExceptionCode":{
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the shipping exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipping exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ExceptionDescription":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"Description of the shipping exception.",
            "nullable":false,
            "x-queryable":true
        },
        "ExceptionName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the shipping exception.",
            "nullable":false,
            "x-queryable":true
        },
        "ExceptionSeverity":{
            "maxLength":255,
            "type":"string",
            "description":"Severity of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_BEHAVIOR.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionSeverityCode":{
            "title":"Severity",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the severity of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_BEHAVIOR.",
            "nullable":false,
            "x-queryable":true
        },
        "ExceptionType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_LEVEL.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of the shipping exception. A list of accepted values is defined in the lookup WSH_EXCEPTION_LEVEL.",
            "nullable":false,
            "x-queryable":true
        },
        "PredefinedFlag":{
            "title":"Predefined",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipping exception is predefined. If false, then the shipping exception is defined by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shippingExceptionConfigurations-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 : shippingExceptionConfigurations-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
• ExceptionDefinitionId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

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

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/shippingExceptionConfigurations/{ExceptionDefinitionId}/child/DFF

Parameters:

• ExceptionDefinitionId: $request.path.ExceptionDefinitionId

Back to Top