REST API for Oracle Supply Chain Management Cloud

Update an exception

patch

/fscmRestApi/resources/11.13.18.05/shippingExceptions/{ShippingExceptionId}

Request

Path Parameters

ShippingExceptionId(required): integer(int64)

Value that uniquely identifies the shipping exception.

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

Root Schema : schema

Type: object

Show Source

DFF: array Flexfields for Shipping Exceptions

Title: Flexfields for Shipping Exceptions

The Flexfields for Shipping Exceptions manages details about shipping exceptions.
Status: string

Maximum Length: 80

Status of the shipping exception.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"Status of the shipping exception.",
            "nullable":true
        },
        "DFF":{
            "title":"Flexfields for Shipping Exceptions",
            "type":"array",
            "description":"The Flexfields for Shipping Exceptions manages details about shipping exceptions.",
            "items":{
                "$ref":"#/components/schemas/shippingExceptions-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Flexfields for Shipping Exceptions

Type: array

Title: Flexfields for Shipping Exceptions

The Flexfields for Shipping Exceptions manages details about shipping exceptions.

Show Source

Array of: object shippingExceptions-DFF-item-patch-request

{
    "title":"Flexfields for Shipping Exceptions",
    "type":"array",
    "description":"The Flexfields for Shipping Exceptions manages details about shipping exceptions.",
    "items":{
        "$ref":"#/components/schemas/shippingExceptions-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : shippingExceptions-DFF-item-patch-request

Type: object

Show Source

__FLEX_Context: string

Title: Context Value

Maximum Length: 30

Descriptive flexfield context name for shipping exceptions.
__FLEX_Context_DisplayValue: string

Title: Context Value

Descriptive flexfield context display value for shipping exceptions.
ExceptionId: integer (int64)

Value that uniquely identifies the shipping exception.

{
    "type":"object",
    "properties":{
        "ExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipping exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield context display value for shipping exceptions.",
            "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"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for shipping exceptions.",
            "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"
                }
            }
        }
    }
}

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.

Root Schema : shippingExceptions-item-response

Type: object

Show Source

CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the shipping exception.
CreationDate: string (date-time)

Read Only: true

Date when the shipping exception was created.
DFF: array Flexfields for Shipping Exceptions

Title: Flexfields for Shipping Exceptions

The Flexfields for Shipping Exceptions manages details about shipping exceptions.
ExceptionComments: string

Maximum Length: 2000

Comments for the shipping exception.
ExceptionDescription: string

Read Only: true

Maximum Length: 100

Description of the shipping exception.
Item: string

Read Only: true

Maximum Length: 300

Value that uniquely identifies the inventory item.
ItemDescription: string

Read Only: true

Maximum Length: 300

Description of the inventory item.
ItemId: integer (int64)

Read Only: true

Value that uniquely identifies the item.
LastUpdateDate: string (date-time)

Read Only: true

Date when the shipping exception was most recently updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who most recently updated the shipping exception.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrganizationCode: string

Read Only: true

Maximum Length: 18

Abbreviation that identifies the inventory organization.
OrganizationId: integer

Read Only: true

Value that uniquely identifies the inventory organization.
OrganizationName: string

Read Only: true

Maximum Length: 240

Name of the inventory organization.
PackingUnit: string

Maximum Length: 30

Value that uniquely identifies the packing unit.
PackingUnitId: integer (int64)

Value that uniquely identifies the container used when packing the detail line.
Severity: string

Read Only: true

Maximum Length: 80

Severity of the shipping exception.
Shipment: string

Maximum Length: 30

Name of the material shipment.
ShipmentId: integer (int64)

Value that uniquely identifies the shipment.
ShipmentLine: integer (int64)

Value that uniquely identifies the shipment line.
ShippingException: string

Maximum Length: 80

Display name of the shipping exception.
ShippingExceptionCode: string

Maximum Length: 50

Abbreviation that identifies the shipping exception.
ShippingExceptionId: integer (int64)

Read Only: true

Value that uniquely identifies the shipping exception.
SourceOrder: string

Read Only: true

Maximum Length: 150

Number that identifies the source order header.
SourceOrderFulfillmentLine: string

Read Only: true

Maximum Length: 150

Number that identifies the source order fulfillment line within the source order line.
SourceOrderFulfillmentLineId: integer

Read Only: true

Value that uniquely identifies the source order fulfillment line.
SourceOrderLine: string

Read Only: true

Maximum Length: 150

Number that identifies the source order line within the source order header.
SourceSystem: string

Read Only: true

Maximum Length: 80

Name of the source application.
SourceSystemId: integer

Read Only: true

Value that uniquely identifies the source application.
Status: string

Maximum Length: 80

Status of the shipping exception.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the shipping exception was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DFF":{
            "title":"Flexfields for Shipping Exceptions",
            "type":"array",
            "description":"The Flexfields for Shipping Exceptions manages details about shipping exceptions.",
            "items":{
                "$ref":"#/components/schemas/shippingExceptions-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipmentLine":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"300",
            "type":"string",
            "description":"Description of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PackingUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the container used when packing the detail line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":"300",
            "type":"string",
            "description":"Value that uniquely identifies the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrderFulfillmentLine":{
            "maxLength":"150",
            "type":"string",
            "description":"Number that identifies the source order fulfillment line within the source order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExceptionComments":{
            "maxLength":"2000",
            "type":"string",
            "description":"Comments for the shipping exception.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "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"
            }
        },
        "ShippingExceptionCode":{
            "maxLength":"50",
            "type":"string",
            "description":"Abbreviation that identifies the shipping exception.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipping exception.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the shipping exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"Status of the shipping exception.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the shipping exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceOrder":{
            "maxLength":"150",
            "type":"string",
            "description":"Number that identifies the source order header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExceptionDescription":{
            "maxLength":"100",
            "type":"string",
            "description":"Description of the shipping exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Shipment":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the material shipment.",
            "nullable":true,
            "x-queryable":true
        },
        "Severity":{
            "maxLength":"80",
            "type":"string",
            "description":"Severity of the shipping exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrderLine":{
            "maxLength":"150",
            "type":"string",
            "description":"Number that identifies the source order line within the source order header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceOrderFulfillmentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source order fulfillment line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PackingUnit":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the source application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the shipping exception was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShippingException":{
            "maxLength":"80",
            "type":"string",
            "description":"Display name of the shipping exception.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Flexfields for Shipping Exceptions

Type: array

Title: Flexfields for Shipping Exceptions

The Flexfields for Shipping Exceptions manages details about shipping exceptions.

Show Source

Array of: object shippingExceptions-DFF-item-response

{
    "title":"Flexfields for Shipping Exceptions",
    "type":"array",
    "description":"The Flexfields for Shipping Exceptions manages details about shipping exceptions.",
    "items":{
        "$ref":"#/components/schemas/shippingExceptions-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 : shippingExceptions-DFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Value

Maximum Length: 30

Descriptive flexfield context name for shipping exceptions.
__FLEX_Context_DisplayValue: string

Title: Context Value

Descriptive flexfield context display value for shipping exceptions.
ExceptionId: integer (int64)

Value that uniquely identifies the shipping exception.
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"
            }
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipping exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield context display value for shipping exceptions.",
            "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 shipping exceptions.",
            "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."
        }
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/shippingExceptions/{ShippingExceptionId}/child/DFF

Parameters:

ShippingExceptionId: $request.path.ShippingExceptionId

The Flexfields for Shipping Exceptions manages details about shipping exceptions.

Examples

This example describes how to update an exception.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/shippingExceptions/ShippingExceptionId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
	"ShippingExceptionCode" : "WSH_SR_ERROR",
	"ShipmentId" : 2331592,
	"Status": "Closed",
	"DFF": [
	{
		"_Global1": "a2",
		"_Global2": "b3"
	}
	]
}

Example Response Body

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

{
	"ShippingExceptionId": 300100168920390,
	"ShippingExceptionCode": "WSH_SR_ERROR",
	"ShippingException": "Shipment Request Error",
	"Severity": "Error",
	"Status": "Closed",
	"ExceptionDescription": "Line has shipment request errors in shipment message interface.",
	"ExceptionComments": "Testing DFF post",
	"CreationDate": "2018-10-24T22:50:23+00:00",
	"CreatedBy": "WHSE_MGR_M1",
	"LastUpdateDate": "2018-12-03T16:08:37+00:00",
	"LastUpdatedBy": "WHSE_MGR_M1",
	"ShipmentId": 2331592,
	"Shipment": "2331592",
	"ShipmentLine": null,
	"PackingUnitId": null,
	"PackingUnit": null,
	"ItemId": null,
	"Item": nulll,
	"OrganizationId": 207,
	"OrganizationCode": "M1",
	"OrganizationName": "Tall Manufacturing",
	"SourceSystemId": null,
	"SourceSystem": null,
	"SourceOrder": null,
	"SourceOrderLine": null,
	"SourceOrderFulfillmentLine": null,
	"SourceOrderFulfillmentLineId": null,
	"ItemDescription":null
	"DFF": [
	{
		"ExceptionId": 300100168920390,
		"_Global1": "a2",
		"_Global2": "b3",
		"__FLEX_Context": null,
		"__FLEX_Context_DisplayValue": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/shippingExceptions/300100168920390/child/DFF/300100168920390",
			"name": "DFF",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/shippingExceptions/300100168920390/child/DFF/300100168920390",
			"name": "DFF",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/shippingExceptions/300100168920390",
			"name": "shippingExceptions",
			"kind": "item"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/shippingExceptions/300100168920390/child/DFF/300100168920390/lov/LVVO___FLEX_Context",
			"name": "LVVO___FLEX_Context",
			"kind": "collection"
		}
		]
	}
	],
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/shippingExceptions/300100168920390",
		"name": "shippingExceptions",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/shippingExceptions/300100168920390",
		"name": "shippingExceptions",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/shippingExceptions/300100168920390/child/DFF",
		"name": "DFF",
		"kind": "collection"
	}
	]
}