Jump to

• Request
• Response
• Examples

Bulk update orders

post

/fscmRestApi/resources/11.13.18.05/buyerPlanningSupplies/buyerPlanningSupplies/

Bulk update orders

Request

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 doesn't specify this header in the request the server picks a default version for the API.

Supported Media Types

• application/batch+json

Request Body - application/batch+json ()

Root Schema : schema

Type: array

Show Source

• Array of: object buyerPlanningSupplies-bulkItems

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/buyerPlanningSupplies-bulkItems"
    }
}

Nested Schema : buyerPlanningSupplies-bulkItems

Type: object

Show Source

• $context: object $context
• $key: object $key
• ConsolidationTransactionId: integer (int64)
  Title: Consolidation Transaction Id

  Value that uniquely identifies associated consolidated orders.
• ImplementDockDate: string (date)
  Title: Implement Dock Date

  Date when the material should be on the receiving dock when the order is released.
• ImplementFirm: integer (int64)
  Title: Implement Firm

  Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO.
• ImplementQuantity: integer (int64)
  Title: Implement Quantity

  Quantity of the order that's released.
• MarkForReleaseOption: integer (int64)
  Title: Mark For Release Option

  Value that indicates the release status of the order. Valid values are 1: Marked For Release or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
• ReleaseGroupCode: string
  Title: Release Group Code

  Abbreviation??that??identifies??a??custom??grouping??created??in??buyer??planning??used??by??procurement??in??the??purchase??order??creation??process.

{
    "type":"object",
    "properties":{
        "$context":{
            "type":"object",
            "properties":{
                "operation":{
                    "type":"string",
                    "description":"Describe type of operation: update."
                },
                "if-match":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                },
                "id":{
                    "type":"string",
                    "description":"Context Identifier."
                }
            }
        },
        "$key":{
            "type":"object",
            "properties":{
                "TransactionId":{
                    "type":"integer",
                    "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
                    "format":"int64"
                },
                "PlanId":{
                    "type":"integer",
                    "description":"Value that uniquely identifies the plan.",
                    "format":"int64"
                },
                "PartKey1":{
                    "type":"integer",
                    "description":"Value that uniquely identifies the order based on planId, transactionID and a system generated part key.",
                    "format":"int64"
                }
            }
        },
        "ConsolidationTransactionId":{
            "title":"Consolidation Transaction Id",
            "type":"integer",
            "description":"Value that uniquely identifies associated consolidated orders.",
            "format":"int64"
        },
        "ReleaseGroupCode":{
            "title":"Release Group Code",
            "type":"string",
            "description":"Abbreviation??that??identifies??a??custom??grouping??created??in??buyer??planning??used??by??procurement??in??the??purchase??order??creation??process."
        },
        "MarkForReleaseOption":{
            "title":"Mark For Release Option",
            "type":"integer",
            "description":"Value that indicates the release status of the order. Valid values are 1: Marked For Release or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.",
            "format":"int64"
        },
        "ImplementQuantity":{
            "title":"Implement Quantity",
            "type":"integer",
            "description":"Quantity of the order that's released.",
            "format":"int64"
        },
        "ImplementFirm":{
            "title":"Implement Firm",
            "type":"integer",
            "description":"Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO.",
            "format":"int64"
        },
        "ImplementDockDate":{
            "title":"Implement Dock Date",
            "type":"string",
            "description":"Date when the material should be on the receiving dock when the order is released.",
            "format":"date"
        }
    }
}

Nested Schema : $context

Type: object

Show Source

• id: string
  Context Identifier.
• if-match: string
  Change indicator or the ETag value of the resource instance.
• operation: string
  Describe type of operation: update.

{
    "type":"object",
    "properties":{
        "operation":{
            "type":"string",
            "description":"Describe type of operation: update."
        },
        "if-match":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        },
        "id":{
            "type":"string",
            "description":"Context Identifier."
        }
    }
}

Nested Schema : $key

Type: object

Show Source

• PartKey1: integer (int64)
  Value that uniquely identifies the order based on planId, transactionID and a system generated part key.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• TransactionId: integer (int64)
  Value that uniquely identifies the supply transaction. This value is internally generated by the application.

{
    "type":"object",
    "properties":{
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
            "format":"int64"
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64"
        },
        "PartKey1":{
            "type":"integer",
            "description":"Value that uniquely identifies the order based on planId, transactionID and a system generated part key.",
            "format":"int64"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : buyerPlanningSupplies-bulkItemsStatus-response

Match All

Show Source

• object ItemsBulkProperties
• integer
  The number of resource instances returned in the current range.
• object buyerPlanningSupplies-bulkItemsStatus-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemsBulkProperties"
        },
        {
            "$ref":"#/components/schemas/CollectionProperties/properties/count"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : ItemsBulkProperties

Type: object

Show Source

• items: array Items
  Title: Items

  The item relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The item relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/bulk-patch-item"
            }
        }
    }
}

Nested Schema : buyerPlanningSupplies-bulkItemsStatus-response-allOf[2]

Type: object

Nested Schema : Items

Type: array

Title: Items

The item relations associated with the resource instance.

Show Source

• Array of: object bulk-patch-item

{
    "title":"Items",
    "type":"array",
    "description":"The item relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/bulk-patch-item"
    }
}

Nested Schema : bulk-patch-item

Type: object

Show Source

• Date: string
• DocumentMeasureQuantitiesId: integer (int64)
• MeasureTypeCode: string
  Read Only: true

  Maximum Length: 30
• Quantity: integer (int64)

{
    "type":"object",
    "properties":{
        "DocumentMeasureQuantitiesId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        },
        "MeasureTypeCode":{
            "maxLength":"30",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "Date":{
            "type":"string",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "Quantity":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-precision":"18"
            }
        }
    }
}

Back to Top

Examples

This example describes how to bulk update orders.

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/buyerPlanningSupplies"

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.

{
		"$context": {
			"if-match": "C4CA4238A0B923820DCC509A6F75849B",
			"operation": "update"
		},
		"$key": {
			"PartKey1": "999999999999999999",
			"PlanId": "300100577750737",
			"TransactionId": "99549201"
		},
		"ConsolidationTransactionId": "99549201",
		"ImplementFirm": 1,
		"ImplementQuantity": 0
	},
	{
		"$context": {
			"if-match": "C4CA4238A0B923820DCC509A6F75849B",
			"operation": "update"
		},
		"$key": {
			"PartKey1": "999999999999999999",
			"PlanId": "300100577750737",
			"TransactionId": "99549241"
		},
		"ConsolidationTransactionId": "99549201",
		"ImplementFirm": 2,
		"ImplementQuantity": 0
	},
	{
		"$context": {
			"if-match": "C4CA4238A0B923820DCC509A6F75849B",
			"operation": "update"
		},
		"$key": {
			"PartKey1": "999999999999999999",
			"PlanId": "300100577750737",
			"TransactionId": "99549280"
		},
		"ConsolidationTransactionId": "99549201",
		"ImplementFirm": 2,
		"ImplementQuantity": 0
	}

Example Response Body

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

{
	"items": [
		{
			"PlanId": "300100577750737",
			"PlanName": null,
			"TransactionId": "99549201",
			"ConsolidatedFlag": null,
			"ConsolidationTransactionId": "99549201",
			"PartKey1": "999999999999999999",
			"SrInstanceId": null,
			"OrderTypeCode": null,
			"OrderType": "Planned order",
			"OrderNumber": null,
			"ReleaseStatusCode": 14,
			"ReleaseStatus": "Marked for release",
			"MarkForReleaseOption": 1,
			"SegmentId": null,
			"SegmentName": null,
			"ReleaseGroupCode": null,
			"MappedSupplierId": null,
			"SupplierId": "2736186",
			"Supplier": null,
			"SupplierSiteId": "7463792",
			"SupplierSite": null,
			"MappedOrganizationId": null,
			"OrganizationId": "147201",
			"SubInventoryId": null,
			"ActualLocation": "BP1",
			"Organization": null,
			"OrganizationCode": null,
			"OrganizationCalendarCode": null,
			"SubinventoryCode": null,
			"MappedItemId": null,
			"InventoryItemId": "26563118",
			"Item": null,
			"ItemDescription": null,
			"NewOrderQuantity": null,
			"OldOrderQuantity": null,
			"NewDockDate": null,
			"NewShipDate": null,
			"OldDockDate": null,
			"OldShipDate": null,
			"FirmStatusCode": null,
			"FirmStatus": null,
			"FirmQuantity": null,
			"FirmDate": null,
			"ImplementQuantity": 168,
			"ImplementDockDate": "2024-01-10",
			"ImplementShipDate": "2024-01-10",
			"ImplementDate": "2024-01-12",
			"MappedImplementLocationId": null,
			"ImplementFirm": 1,
			"ImplementLocationId": null,
			"PrimaryUomCode": null,
			"ImplementLocation": null,
			"PrimaryUom": null,
			"ImplementLocationCode": null,
			"SourceUomCode": null,
			"SourceUom": null,
			"UnitVolume": null,
			"VolumeUomCode": null,
			"UnitWeight": null,
			"VolumeUom": null,
			"WeightUomCode": null,
			"WeightUom": null,
			"CarryingCost": null,
			"HasPriceBreakFlag": true,
			"ListPrice": null,
			"OrderCost": null,
			"StandardCost": null,
			"PriceSavings": 588,
			"OrganizationCurrency": null,
			"FixedDaysOfSupply": null,
			"FixedLotMultiplier": null,
			"FixedOrderQuantity": null,
			"MaximumOrderQuantity": null,
			"MinimumOrderQuantity": null,
			"PlanningTimeFenceDays": null,
			"ProcessingLeadTime": null,
			"PostProcessingLeadTime": null,
			"ItemPlanner": null,
			"EmployeeId": null,
			"PoLineId": null,
			"PoLineLocationId": null,
			"RangeFilterDate": null,
			"PlannerCode": null,
			"ObjectVersionNumber": 2,
			"CreatedBy": null,
			"CreationDate": null,
			"LastUpdatedBy": null,
			"LastUpdateDate": null,
			"links": [
				{
					. . .
				}
			]
		},
		{
			"PlanId": "300100577750737",
			"PlanName": null,
			"TransactionId": "99549241",
			"ConsolidatedFlag": null,
			"ConsolidationTransactionId": "99549201",
			"PartKey1": "999999999999999999",
			"SrInstanceId": null,
			"OrderTypeCode": null,
			"OrderType": "Planned order",
			"OrderNumber": null,
			"ReleaseStatusCode": 14,
			"ReleaseStatus": "Marked for release",
			"MarkForReleaseOption": 1,
			"SegmentId": null,
			"SegmentName": null,
			"ReleaseGroupCode": null,
			"MappedSupplierId": null,
			"SupplierId": "2736186",
			"Supplier": null,
			"SupplierSiteId": "7463792",
			"SupplierSite": null,
			"MappedOrganizationId": null,
			"OrganizationId": "147201",
			"SubInventoryId": null,
			"ActualLocation": "BP1",
			"Organization": null,
			"OrganizationCode": null,
			"OrganizationCalendarCode": null,
			"SubinventoryCode": null,
			"MappedItemId": null,
			"InventoryItemId": "26563118",
			"Item": null,
			"ItemDescription": null,
			"NewOrderQuantity": null,
			"OldOrderQuantity": null,
			"NewDockDate": null,
			"NewShipDate": null,
			"OldDockDate": null,
			"OldShipDate": null,
			"FirmStatusCode": null,
			"FirmStatus": null,
			"FirmQuantity": null,
			"FirmDate": null,
			"ImplementQuantity": 0,
			"ImplementDockDate": "2024-01-12",
			"ImplementShipDate": "2024-01-12",
			"ImplementDate": "2024-01-16",
			"MappedImplementLocationId": null,
			"ImplementFirm": 2,
			"ImplementLocationId": null,
			"PrimaryUomCode": null,
			"ImplementLocation": null,
			"PrimaryUom": null,
			"ImplementLocationCode": null,
			"SourceUomCode": null,
			"SourceUom": null,
			"UnitVolume": null,
			"VolumeUomCode": null,
			"UnitWeight": null,
			"VolumeUom": null,
			"WeightUomCode": null,
			"WeightUom": null,
			"CarryingCost": null,
			"HasPriceBreakFlag": true,
			"ListPrice": null,
			"OrderCost": null,
			"StandardCost": null,
			"PriceSavings": null,
			"OrganizationCurrency": null,
			"FixedDaysOfSupply": null,
			"FixedLotMultiplier": null,
			"FixedOrderQuantity": null,
			"MaximumOrderQuantity": null,
			"MinimumOrderQuantity": null,
			"PlanningTimeFenceDays": null,
			"ProcessingLeadTime": null,
			"PostProcessingLeadTime": null,
			"ItemPlanner": null,
			"EmployeeId": null,
			"PoLineId": null,
			"PoLineLocationId": null,
			"RangeFilterDate": null,
			"PlannerCode": null,
			"ObjectVersionNumber": 2,
			"CreatedBy": null,
			"CreationDate": null,
			"LastUpdatedBy": null,
			"LastUpdateDate": null,
			"links": [
				{
					. . .
				}
			]
		},
		{
			"PlanId": "300100577750737",
			"PlanName": null,
			"TransactionId": "99549280",
			"ConsolidatedFlag": null,
			"ConsolidationTransactionId": "99549201",
			"PartKey1": "999999999999999999",
			"SrInstanceId": null,
			"OrderTypeCode": null,
			"OrderType": "Planned order",
			"OrderNumber": null,
			"ReleaseStatusCode": 14,
			"ReleaseStatus": "Marked for release",
			"MarkForReleaseOption": 1,
			"SegmentId": null,
			"SegmentName": null,
			"ReleaseGroupCode": null,
			"MappedSupplierId": null,
			"SupplierId": "2736186",
			"Supplier": null,
			"SupplierSiteId": "7463792",
			"SupplierSite": null,
			"MappedOrganizationId": null,
			"OrganizationId": "147201",
			"SubInventoryId": null,
			"ActualLocation": "BP1",
			"Organization": null,
			"OrganizationCode": null,
			"OrganizationCalendarCode": null,
			"SubinventoryCode": null,
			"MappedItemId": null,
			"InventoryItemId": "26563118",
			"Item": null,
			"ItemDescription": null,
			"NewOrderQuantity": null,
			"OldOrderQuantity": null,
			"NewDockDate": null,
			"NewShipDate": null,
			"OldDockDate": null,
			"OldShipDate": null,
			"FirmStatusCode": null,
			"FirmStatus": null,
			"FirmQuantity": null,
			"FirmDate": null,
			"ImplementQuantity": 0,
			"ImplementDockDate": "2024-01-15",
			"ImplementShipDate": "2024-01-14",
			"ImplementDate": "2024-01-17",
			"MappedImplementLocationId": null,
			"ImplementFirm": 2,
			"ImplementLocationId": null,
			"PrimaryUomCode": null,
			"ImplementLocation": null,
			"PrimaryUom": null,
			"ImplementLocationCode": null,
			"SourceUomCode": null,
			"SourceUom": null,
			"UnitVolume": null,
			"VolumeUomCode": null,
			"UnitWeight": null,
			"VolumeUom": null,
			"WeightUomCode": null,
			"WeightUom": null,
			"CarryingCost": null,
			"HasPriceBreakFlag": true,
			"ListPrice": null,
			"OrderCost": null,
			"StandardCost": null,
			"PriceSavings": null,
			"OrganizationCurrency": null,
			"FixedDaysOfSupply": null,
			"FixedLotMultiplier": null,
			"FixedOrderQuantity": null,
			"MaximumOrderQuantity": null,
			"MinimumOrderQuantity": null,
			"PlanningTimeFenceDays": null,
			"ProcessingLeadTime": null,
			"PostProcessingLeadTime": null,
			"ItemPlanner": null,
			"EmployeeId": null,
			"PoLineId": null,
			"PoLineLocationId": null,
			"RangeFilterDate": null,
			"PlannerCode": null,
			"ObjectVersionNumber": 2,
			"CreatedBy": null,
			"CreationDate": null,
			"LastUpdatedBy": null,
			"LastUpdateDate": null,
			"links": [
				{
					. . .
				}
			]
		}
	],
	"count": 3
}

Back to Top