Jump to

• Request
• Response
• Examples

Create one special handling type

post

/fscmRestApi/resources/11.13.18.05/specialHandlingTypes

Request

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AutomaticallyCreateReceiptFlag: boolean
  Title: Automatically Create Receipt

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application creates a receipt after the purchase order is implemented. If false, then the application doesn't create a receipt after the purchase order is implemented.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the special handling type purchasing document.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the special handling type will be available for document creation. If false, then you won't be able to create documents with that type.
• HeaderContextCode: string
  Maximum Length: 30

  Descriptive flexfield context name for the special handling document header.
• LineContextCode: string
  Maximum Length: 30

  Descriptive flexfield context name for the special handling document line.
• NegotiatedFlag: boolean
  Title: Negotiated

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then when creating special handling purchasing documents, the Negotiated field on the line is enabled. If false, then the Negotiated field isn't enabled.
• RequiresBuyerReviewFlag: boolean
  Title: Requires Buyer Review

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then special handling orders created from requisitions require buyer review before submission. If false, then special handling orders created from requisitions are submitted automatically.
• RequiresSingleSupplierFlag: boolean
  Title: Requires Single Supplier

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then all lines on special handling requisitions must have the same supplier and supplier site. If false, then requisition lines can have a different supplier and supplier site.
• SpecialHandlingType: string
  Title: Special Handling Type

  Maximum Length: 30

  Type of purchasing document that indicates that the document needs to be handled in a special manner.
• SpecialHandlingTypeCode: string
  Title: Special Handling Type Code

  Maximum Length: 30

  Abbreviation that identifies the special handling type.

{
    "type":"object",
    "properties":{
        "AutomaticallyCreateReceiptFlag":{
            "title":"Automatically Create Receipt",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application creates a receipt after the purchase order is implemented. If false, then the application doesn't create a receipt after the purchase order is implemented.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the special handling type purchasing document.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the special handling type will be available for document creation. If false, then you won't be able to create documents with that type.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "sortable":false
            }
        },
        "HeaderContextCode":{
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for the special handling document header.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineContextCode":{
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for the special handling document line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "NegotiatedFlag":{
            "title":"Negotiated",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then when creating special handling purchasing documents, the Negotiated field on the line is enabled. If false, then the Negotiated field isn't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequiresBuyerReviewFlag":{
            "title":"Requires Buyer Review",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then special handling orders created from requisitions require buyer review before submission. If false, then special handling orders created from requisitions are submitted automatically.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequiresSingleSupplierFlag":{
            "title":"Requires Single Supplier",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then all lines on special handling requisitions must have the same supplier and supplier site. If false, then requisition lines can have a different supplier and supplier site.",
            "nullable":true,
            "default":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SpecialHandlingType":{
            "title":"Special Handling Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of purchasing document that indicates that the document needs to be handled in a special manner.",
            "nullable":false
        },
        "SpecialHandlingTypeCode":{
            "title":"Special Handling Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the special handling type.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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 : specialHandlingTypes-item-response

Type: object

Show Source

• AutomaticallyCreateReceiptFlag: boolean
  Title: Automatically Create Receipt

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application creates a receipt after the purchase order is implemented. If false, then the application doesn't create a receipt after the purchase order is implemented.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the special handing type.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the special handling type was created.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the special handling type purchasing document.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the special handling type will be available for document creation. If false, then you won't be able to create documents with that type.
• HeaderContext: string
  Title: Header Context

  Read Only: true

  Maximum Length: 80

  Descriptive flexfield context display value for the special handling document header.
• HeaderContextCode: string
  Maximum Length: 30

  Descriptive flexfield context name for the special handling document header.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user last updated the special handling type.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the special handling type.
• LineContext: string
  Title: Line Context

  Read Only: true

  Maximum Length: 80

  Descriptive flexfield context display value for the special handling document line.
• LineContextCode: string
  Maximum Length: 30

  Descriptive flexfield context name for the special handling document line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NegotiatedFlag: boolean
  Title: Negotiated

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then when creating special handling purchasing documents, the Negotiated field on the line is enabled. If false, then the Negotiated field isn't enabled.
• RequiresBuyerReviewFlag: boolean
  Title: Requires Buyer Review

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then special handling orders created from requisitions require buyer review before submission. If false, then special handling orders created from requisitions are submitted automatically.
• RequiresSingleSupplierFlag: boolean
  Title: Requires Single Supplier

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then all lines on special handling requisitions must have the same supplier and supplier site. If false, then requisition lines can have a different supplier and supplier site.
• SpecialHandlingType: string
  Title: Special Handling Type

  Maximum Length: 30

  Type of purchasing document that indicates that the document needs to be handled in a special manner.
• SpecialHandlingTypeCode: string
  Title: Special Handling Type Code

  Maximum Length: 30

  Abbreviation that identifies the special handling type.
• SpecialHandlingTypeId: integer (int64)
  Read Only: true

  Value that uniquely identifies the special handling type.

{
    "type":"object",
    "properties":{
        "AutomaticallyCreateReceiptFlag":{
            "title":"Automatically Create Receipt",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application creates a receipt after the purchase order is implemented. If false, then the application doesn't create a receipt after the purchase order is implemented.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the special handing type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the special handling type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the special handling type purchasing document.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the special handling type will be available for document creation. If false, then you won't be able to create documents with that type.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "HeaderContext":{
            "title":"Header Context",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context display value for the special handling document header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "HeaderContextCode":{
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for the special handling document header.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user last updated the special handling type.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the special handling type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineContext":{
            "title":"Line Context",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context display value for the special handling document line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineContextCode":{
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for the special handling document line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "NegotiatedFlag":{
            "title":"Negotiated",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then when creating special handling purchasing documents, the Negotiated field on the line is enabled. If false, then the Negotiated field isn't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequiresBuyerReviewFlag":{
            "title":"Requires Buyer Review",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then special handling orders created from requisitions require buyer review before submission. If false, then special handling orders created from requisitions are submitted automatically.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequiresSingleSupplierFlag":{
            "title":"Requires Single Supplier",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then all lines on special handling requisitions must have the same supplier and supplier site. If false, then requisition lines can have a different supplier and supplier site.",
            "nullable":true,
            "default":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SpecialHandlingType":{
            "title":"Special Handling Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of purchasing document that indicates that the document needs to be handled in a special manner.",
            "nullable":false,
            "x-queryable":true
        },
        "SpecialHandlingTypeCode":{
            "title":"Special Handling Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the special handling type.",
            "nullable":false,
            "x-queryable":true
        },
        "SpecialHandlingTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the special handling type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

Back to Top

Examples

This example describes how to create one special handling type.

Example cURL Command

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

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

For example:

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

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.

{          
            "SpecialHandlingType": "Bill Only",
            "SpecialHandlingTypeCode": "ORA_PO_BILL_ONLY",
            "Description": "Bill Only",
            "HeaderContextCode": "ORA_PO_BILL_ONLY_HEADERS",
            "LineContextCode": "ORA_PO_BILL_ONLY_LINES",
            "NegotiatedFlag": null,
            "EnabledFlag": true,
            "AutomaticallyCreateReceiptFlag": null,
            "RequiresSingleSupplierFlag": true,
            "RequiresBuyerReviewFlag": null
}

Example Response Body

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

{
    "SpecialHandlingTypeId": 300100650999688,
    "SpecialHandlingTypeCode": "ORA_PO_BILL_ONLY",
    "SpecialHandlingType": "Bill Only",
    "Description": "Bill Only",
    "HeaderContextCode": "ORA_PO_BILL_ONLY_HEADERS",
    "HeaderContext": null,
    "LineContextCode": "ORA_PO_BILL_ONLY_LINES",
    "LineContext": "Bill Only Context for Lines",
    "NegotiatedFlag": null,
    "EnabledFlag": true,
    "AutomaticallyCreateReceiptFlag": null,
    "RequiresSingleSupplierFlag": true,
    "RequiresBuyerReviewFlag": null,
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2026-02-09T05:07:29.001+00:00",
    "LastUpdateDate": "2026-02-09T05:07:29.285+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/specialHandlingTypes/300100650999688",
            "name": "specialHandlingTypes",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/specialHandlingTypes/300100650999688",
            "name": "specialHandlingTypes",
            "kind": "item"
        }
    ]
}

Back to Top