1. REST API for Oracle Fusion Cloud SCMREST API for Oracle Fusion Cloud SCM
  2. Use Cases
  3. Product Management
  4. Get and Import Item Batches

Get and Import Item Batches

You can use a REST resource to upload item data from data files to batches interface for import. To upload the item data, you can use a REST resource to create an item batch for processing the data files received from multiple external source systems and upload the data from the data files to batches interface for import.

Let's discuss these scenarios, where you create a solution that allows Richard, your customer, to use a client to connect to your partner application, and then use REST API to do these tasks:

  1. Get item batches
  2. Post a new item batch
  3. Upload an item data

Note:

  • If the schedule of the item batch is set to On Data Load, then the import process is called to import the data. If the schedule of the item batch is set to Manual, then the item batch needs to be manually submitted for import.
  • If the data file to be imported contains more than 10,000 rows, it's recommended to use the Schedule Item Import scheduled process instead of this REST resource.

Get Item Batches

Assume Richard must get all item batches of a particular spoke application so he can determine the frequency at which the spoke application is uploading the item data. To get item batches:

  1. Gets the top 10 item batches
  2. The response payload includes details that describe the results of the request.
  3. Your partner application extracts the values for these attributes from the response payload and displays them in the client.
Attribute Description
SpokeSystemCode Abbreviation that identifies the spoke system.
BatchName Name of the item batch.
CreationDateTime Date and time when the user created the item batch.

Example URL

Use this resource URL format.

GET

curl -u username:password "https://servername/fscmRestApi/resources/version/itemBatches?limit=10&q=SpokeSystemCode=JDE" -H 'authorization: Basic c2Ntb3BlcmF0aW9uczpXZWxjb21lMQ==' -H 'cache-control: no-cache']"

Example Response

Here's an example of the response body in JSON format.

{
	"items": [
	{
		"BatchNumber": "186343",
		"BatchName": "OATS_SUPP_CSV_UPDATE_33486290",
		"BatchId": 300100179408737,
		"SpokeSystemName": "JDE",
		"SpokeSystemCode": "JDE",
		"SpokeSystemId": 100000012259013,
		"AssignedTo": "PIMQA",
		"DefaultOrganizationCode": "V1",
		"DefaultOrganizationId": 204,
		"ImportCrossReferencesOnlyFlag": false,
		"BatchStatus": "Active",
		"BatchStatusCode": "A",
		"CreatedBy": "PIMQA",
		"CreationDateTime": "2019-04-26T10:05:19+00:00",
		"LastUpdateDateTime": "2019-04-26T10:08:49+00:00",
		"LastUpdatedBy": "PIMQA",
		"ImportSchedule": "Manual",
		"ImportScheduleCode": "N",
		"ScheduleDateTime": null,
		"ProcessItems": "Per Item",
		"ProcessItemsCode": "N",
		"DeleteProcessedRows": null,
		"DeleteProcessedRowsCode": null,
		"EnableDataQualityMatchingFlag": true,
		"ConfirmSingleMatchFlag": true,
		"ConfirmUnmatchedNewFlag": true,
		"StructureName": "Primary",
		"StructureNameCode": "Primary",
		"StructureEffectivityControl": "Date",
		"StructureEffectivityControlCode": 1,
		"StructureEffectivityDateTime": "2019-04-26T10:05:19+00:00",
		"StructureUpdate": "Changed components only",
		"StructureUpdateCode": "C",
		"PackUpdate": "All components",
		"PackUpdateCode": "A",
		"NewItemRequestOption": "One per Item",
		"NewItemRequestOptionCode": "I",
		"NewItemRequestSplitAutomaticallyFlag": false,
		"NewItemRequestAssociate": null,
		"NewItemRequestAssociateCode": null,
		"NewItemRequestNumber": null,
		"NewItemRequestName": null,
		"NewItemRequestAddAllItemsFlag": false,
		"NewItemRequestEffectiveDateType": "Type default",
		"NewItemRequestEffectiveDateTypeCode": "D",
		"ChangeOrderOption": "One per Item",
		"ChangeOrderOptionCode": "I",
		"ChangeOrderSplitAutomaticallyFlag": false,
		"ChangeOrderAssociate": null,
		"ChangeOrderAssociateCode": null,
		"ChangeOrderType": null,
		"ChangeOrderTypeCode": null,
		"ChangeOrderNumber": null,
		"ChangeOrderName": null,
		"ChangeOrderAddAllItemsFlag": false,
		"ChangeOrderEffectiveDateType": "Type default",
		"ChangeOrderEffectiveDateTypeCode": "D",
		"LastMatchRequestId": 518200,
		"LastImportRequestId": 518222,
		"Type": "E",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F0849737610000000EACED00057708000110F084973762",
			"name": "itemBatches",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000037371007E00020000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F0849737610000000EACED00057708000110F084973762",
			"name": "itemBatches",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F0849737610000000EACED00057708000110F084973762/child/itemBatchTranslations",
			"name": "itemBatchTranslations",
			"kind": "collection"
		}
		]
	},
	{
		"BatchNumber": "198345",
		"BatchName": "Auto198345",
		"BatchId": 300100181472478,
		"SpokeSystemName": "JDE",
		"SpokeSystemCode": "JDE",
		"SpokeSystemId": 100000012259013,
		"AssignedTo": "SCMOPERATIONS",
		"DefaultOrganizationCode": "V1",
		"DefaultOrganizationId": 204,
		"ImportCrossReferencesOnlyFlag": false,
		"BatchStatus": "Active",
		"BatchStatusCode": "A",
		"CreatedBy": "SCMOPERATIONS",
		"CreationDateTime": "2019-08-02T11:43:33+00:00",
		"LastUpdateDateTime": "2019-08-02T11:44:01+00:00",
		"LastUpdatedBy": "SCMOPERATIONS",
		"ImportSchedule": "On data load",
		"ImportScheduleCode": "Y",
		"ScheduleDateTime": null,
		"ProcessItems": "Per Item",
		"ProcessItemsCode": "N",
		"DeleteProcessedRows": null,
		"DeleteProcessedRowsCode": null,
		"EnableDataQualityMatchingFlag": true,
		"ConfirmSingleMatchFlag": true,
		"ConfirmUnmatchedNewFlag": true,
		"StructureName": "Primary",
		"StructureNameCode": "Primary",
		"StructureEffectivityControl": "Date",
		"StructureEffectivityControlCode": 1,
		"StructureEffectivityDateTime": "2019-08-02T11:43:33+00:00",
		"StructureUpdate": "Changed components only",
		"StructureUpdateCode": "C",
		"PackUpdate": "All components",
		"PackUpdateCode": "A",
		"NewItemRequestOption": "One per Item",
		"NewItemRequestOptionCode": "I",
		"NewItemRequestSplitAutomaticallyFlag": false,
		"NewItemRequestAssociate": null,
		"NewItemRequestAssociateCode": null,
		"NewItemRequestNumber": null,
		"NewItemRequestName": null,
		"NewItemRequestAddAllItemsFlag": false,
		"NewItemRequestEffectiveDateType": "Type default",
		"NewItemRequestEffectiveDateTypeCode": "D",
		"ChangeOrderOption": "One per Item",
		"ChangeOrderOptionCode": "I",
		"ChangeOrderSplitAutomaticallyFlag": false,
		"ChangeOrderAssociate": null,
		"ChangeOrderAssociateCode": null,
		"ChangeOrderType": null,
		"ChangeOrderTypeCode": null,
		"ChangeOrderNumber": null,
		"ChangeOrderName": null,
		"ChangeOrderAddAllItemsFlag": false,
		"ChangeOrderEffectiveDateType": "Type default",
		"ChangeOrderEffectiveDateTypeCode": "D",
		"LastMatchRequestId": 580262,
		"LastImportRequestId": 580262,
		"Type": "E",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B4DE0000000EACED00057708000110F084B6B4DF",
			"name": "itemBatches",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B4DE0000000EACED00057708000110F084B6B4DF",
			"name": "itemBatches",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B4DE0000000EACED00057708000110F084B6B4DF/child/itemBatchTranslations",
			"name": "itemBatchTranslations",
			"kind": "collection"
		}
		]
	},
	{
		"BatchNumber": "199342",
		"BatchName": "Auto199342",
		"BatchId": 300100181472951,
		"SpokeSystemName": "JDE",
		"SpokeSystemCode": "JDE",
		"SpokeSystemId": 100000012259013,
		"AssignedTo": "SCMOPERATIONS",
		"DefaultOrganizationCode": "V1",
		"DefaultOrganizationId": 204,
		"ImportCrossReferencesOnlyFlag": false,
		"BatchStatus": "Active",
		"BatchStatusCode": "A",
		"CreatedBy": "SCMOPERATIONS",
		"CreationDateTime": "2019-08-06T19:36:10+00:00",
		"LastUpdateDateTime": "2019-08-06T19:36:12.807+00:00",
		"LastUpdatedBy": "SCMOPERATIONS",
		"ImportSchedule": "On data load",
		"ImportScheduleCode": "Y",
		"ScheduleDateTime": null,
		"ProcessItems": "Per Item",
		"ProcessItemsCode": "N",
		"DeleteProcessedRows": null,
		"DeleteProcessedRowsCode": null,
		"EnableDataQualityMatchingFlag": true,
		"ConfirmSingleMatchFlag": true,
		"ConfirmUnmatchedNewFlag": true,
		"StructureName": "Primary",
		"StructureNameCode": "Primary",
		"StructureEffectivityControl": "Date",
		"StructureEffectivityControlCode": 1,
		"StructureEffectivityDateTime": "2019-08-06T19:36:10+00:00",
		"StructureUpdate": "Changed components only",
		"StructureUpdateCode": "C",
		"PackUpdate": "All components",
		"PackUpdateCode": "A",
		"NewItemRequestOption": "One per Item",
		"NewItemRequestOptionCode": "I",
		"NewItemRequestSplitAutomaticallyFlag": false,
		"NewItemRequestAssociate": null,
		"NewItemRequestAssociateCode": null,
		"NewItemRequestNumber": null,
		"NewItemRequestName": null,
		"NewItemRequestAddAllItemsFlag": false,
		"NewItemRequestEffectiveDateType": "Type default",
		"NewItemRequestEffectiveDateTypeCode": "D",
		"ChangeOrderOption": "One per Item",
		"ChangeOrderOptionCode": "I",
		"ChangeOrderSplitAutomaticallyFlag": false,
		"ChangeOrderAssociate": null,
		"ChangeOrderAssociateCode": null,
		"ChangeOrderType": null,
		"ChangeOrderTypeCode": null,
		"ChangeOrderNumber": null,
		"ChangeOrderName": null,
		"ChangeOrderAddAllItemsFlag": false,
		"ChangeOrderEffectiveDateType": "Type default",
		"ChangeOrderEffectiveDateTypeCode": "D",
		"LastMatchRequestId": null,
		"LastImportRequestId": null,
		"Type": "E",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B6B70000000EACED00057708000110F084B6B6B8",
			"name": "itemBatches",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B6B70000000EACED00057708000110F084B6B6B8",
			"name": "itemBatches",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B6B70000000EACED00057708000110F084B6B6B8/child/itemBatchTranslations",
			"name": "itemBatchTranslations",
			"kind": "collection"
		}
		]
	},
	{
		"BatchNumber": "199344",
		"BatchName": "Auto199344",
		"BatchId": 300100181472955,
		"SpokeSystemName": "JDE",
		"SpokeSystemCode": "JDE",
		"SpokeSystemId": 100000012259013,
		"AssignedTo": "SCMOPERATIONS",
		"DefaultOrganizationCode": "V1",
		"DefaultOrganizationId": 204,
		"ImportCrossReferencesOnlyFlag": false,
		"BatchStatus": "Active",
		"BatchStatusCode": "A",
		"CreatedBy": "SCMOPERATIONS",
		"CreationDateTime": "2019-08-06T19:49:25+00:00",
		"LastUpdateDateTime": "2019-08-06T19:49:25.241+00:00",
		"LastUpdatedBy": "SCMOPERATIONS",
		"ImportSchedule": "On data load",
		"ImportScheduleCode": "Y",
		"ScheduleDateTime": null,
		"ProcessItems": "Per Item",
		"ProcessItemsCode": "N",
		"DeleteProcessedRows": null,
		"DeleteProcessedRowsCode": null,
		"EnableDataQualityMatchingFlag": true,
		"ConfirmSingleMatchFlag": true,
		"ConfirmUnmatchedNewFlag": true,
		"StructureName": "Primary",
		"StructureNameCode": "Primary",
		"StructureEffectivityControl": "Date",
		"StructureEffectivityControlCode": 1,
		"StructureEffectivityDateTime": "2019-08-06T19:49:25+00:00",
		"StructureUpdate": "Changed components only",
		"StructureUpdateCode": "C",
		"PackUpdate": "All components",
		"PackUpdateCode": "A",
		"NewItemRequestOption": "One per Item",
		"NewItemRequestOptionCode": "I",
		"NewItemRequestSplitAutomaticallyFlag": false,
		"NewItemRequestAssociate": null,
		"NewItemRequestAssociateCode": null,
		"NewItemRequestNumber": null,
		"NewItemRequestName": null,
		"NewItemRequestAddAllItemsFlag": false,
		"NewItemRequestEffectiveDateType": "Type default",
		"NewItemRequestEffectiveDateTypeCode": "D",
		"ChangeOrderOption": "One per Item",
		"ChangeOrderOptionCode": "I",
		"ChangeOrderSplitAutomaticallyFlag": false,
		"ChangeOrderAssociate": null,
		"ChangeOrderAssociateCode": null,
		"ChangeOrderType": null,
		"ChangeOrderTypeCode": null,
		"ChangeOrderNumber": null,
		"ChangeOrderName": null,
		"ChangeOrderAddAllItemsFlag": false,
		"ChangeOrderEffectiveDateType": "Type default",
		"ChangeOrderEffectiveDateTypeCode": "D",
		"LastMatchRequestId": null,
		"LastImportRequestId": null,
		"Type": "E",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B6BB0000000EACED00057708000110F084B6B6BC",
			"name": "itemBatches",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B6BB0000000EACED00057708000110F084B6B6BC",
			"name": "itemBatches",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B6BB0000000EACED00057708000110F084B6B6BC/child/itemBatchTranslations",
			"name": "itemBatchTranslations",
			"kind": "collection"
		}
		]
	},
	{
		"BatchNumber": "97344",
		"BatchName": "SP_R9QAEFFNTSRIL_070618",
		"BatchId": 300100168538156,
		"SpokeSystemName": "JDE",
		"SpokeSystemCode": "JDE",
		"SpokeSystemId": 100000012259013,
		"AssignedTo": "PIMQA",
		"DefaultOrganizationCode": "V1",
		"DefaultOrganizationId": 204,
		"ImportCrossReferencesOnlyFlag": false,
		"BatchStatus": "Active",
		"BatchStatusCode": "A",
		"CreatedBy": "PIMQA",
		"CreationDateTime": "2018-07-06T23:17:17.028+00:00",
		"LastUpdateDateTime": "2018-07-06T23:18:40.650+00:00",
		"LastUpdatedBy": "PIMQA",
		"ImportSchedule": "On data load",
		"ImportScheduleCode": "Y",
		"ScheduleDateTime": null,
		"ProcessItems": "Per Item",
		"ProcessItemsCode": "N",
		"DeleteProcessedRows": null,
		"DeleteProcessedRowsCode": null,
		"EnableDataQualityMatchingFlag": true,
		"ConfirmSingleMatchFlag": true,
		"ConfirmUnmatchedNewFlag": true,
		"StructureName": "Primary",
		"StructureNameCode": "Primary",
		"StructureEffectivityControl": "Date",
		"StructureEffectivityControlCode": 1,
		"StructureEffectivityDateTime": "2018-07-06T23:17:17+00:00",
		"StructureUpdate": "Changed components only",
		"StructureUpdateCode": "C",
		"PackUpdate": "All components",
		"PackUpdateCode": "A",
		"NewItemRequestOption": "One per Item",
		"NewItemRequestOptionCode": "I",
		"NewItemRequestSplitAutomaticallyFlag": false,
		"NewItemRequestAssociate": null,
		"NewItemRequestAssociateCode": null,
		"NewItemRequestNumber": null,
		"NewItemRequestName": null,
		"NewItemRequestAddAllItemsFlag": false,
		"NewItemRequestEffectiveDateType": "Type default",
		"NewItemRequestEffectiveDateTypeCode": "D",
		"ChangeOrderOption": "One per Item",
		"ChangeOrderOptionCode": "I",
		"ChangeOrderSplitAutomaticallyFlag": false,
		"ChangeOrderAssociate": null,
		"ChangeOrderAssociateCode": null,
		"ChangeOrderType": null,
		"ChangeOrderTypeCode": null,
		"ChangeOrderNumber": null,
		"ChangeOrderName": null,
		"ChangeOrderAddAllItemsFlag": false,
		"ChangeOrderEffectiveDateType": "Type default",
		"ChangeOrderEffectiveDateTypeCode": "D",
		"LastMatchRequestId": 245605,
		"LastImportRequestId": 245605,
		"Type": "E",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F083F1582C0000000EACED00057708000110F083F1582D",
			"name": "itemBatches",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E00020000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F083F1582C0000000EACED00057708000110F083F1582D",
			"name": "itemBatches",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F083F1582C0000000EACED00057708000110F083F1582D/child/itemBatchTranslations",
			"name": "itemBatchTranslations",
			"kind": "collection"
		}
		]
	},
	{
		"BatchNumber": "186342",
		"BatchName": "OATS_SUPP_UI_UPDATE_39581997",
		"BatchId": 300100179449352,
		"SpokeSystemName": "JDE",
		"SpokeSystemCode": "JDE",
		"SpokeSystemId": 100000012259013,
		"AssignedTo": "PIMQA",
		"DefaultOrganizationCode": "V1",
		"DefaultOrganizationId": 204,
		"ImportCrossReferencesOnlyFlag": false,
		"BatchStatus": "Active",
		"BatchStatusCode": "A",
		"CreatedBy": "PIMQA",
		"CreationDateTime": "2019-04-26T10:02:51+00:00",
		"LastUpdateDateTime": "2019-04-26T10:07:58+00:00",
		"LastUpdatedBy": "PIMQA",
		"ImportSchedule": "Manual",
		"ImportScheduleCode": "N",
		"ScheduleDateTime": null,
		"ProcessItems": "Per Item",
		"ProcessItemsCode": "N",
		"DeleteProcessedRows": null,
		"DeleteProcessedRowsCode": null,
		"EnableDataQualityMatchingFlag": true,
		"ConfirmSingleMatchFlag": true,
		"ConfirmUnmatchedNewFlag": true,
		"StructureName": "Primary",
		"StructureNameCode": "Primary",
		"StructureEffectivityControl": "Date",
		"StructureEffectivityControlCode": 1,
		"StructureEffectivityDateTime": "2019-04-26T10:02:51+00:00",
		"StructureUpdate": "Changed components only",
		"StructureUpdateCode": "C",
		"PackUpdate": "All components",
		"PackUpdateCode": "A",
		"NewItemRequestOption": "One per Item",
		"NewItemRequestOptionCode": "I",
		"NewItemRequestSplitAutomaticallyFlag": false,
		"NewItemRequestAssociate": null,
		"NewItemRequestAssociateCode": null,
		"NewItemRequestNumber": null,
		"NewItemRequestName": null,
		"NewItemRequestAddAllItemsFlag": false,
		"NewItemRequestEffectiveDateType": "Type default",
		"NewItemRequestEffectiveDateTypeCode": "D",
		"ChangeOrderOption": "One per Item",
		"ChangeOrderOptionCode": "I",
		"ChangeOrderSplitAutomaticallyFlag": false,
		"ChangeOrderAssociate": null,
		"ChangeOrderAssociateCode": null,
		"ChangeOrderType": null,
		"ChangeOrderTypeCode": null,
		"ChangeOrderNumber": null,
		"ChangeOrderName": null,
		"ChangeOrderAddAllItemsFlag": false,
		"ChangeOrderEffectiveDateType": "Type default",
		"ChangeOrderEffectiveDateTypeCode": "D",
		"LastMatchRequestId": 518186,
		"LastImportRequestId": 518216,
		"Type": "E",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F08497D6080000000EACED00057708000110F08497D609",
			"name": "itemBatches",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000037371007E00020000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F08497D6080000000EACED00057708000110F08497D609",
			"name": "itemBatches",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F08497D6080000000EACED00057708000110F08497D609/child/itemBatchTranslations",
			"name": "itemBatchTranslations",
			"kind": "collection"
		}
		]
	},
	{
		"BatchNumber": "199346",
		"BatchName": "Auto199346",
		"BatchId": 300100181472960,
		"SpokeSystemName": "JDE",
		"SpokeSystemCode": "JDE",
		"SpokeSystemId": 100000012259013,
		"AssignedTo": "SCMOPERATIONS",
		"DefaultOrganizationCode": "V1",
		"DefaultOrganizationId": 204,
		"ImportCrossReferencesOnlyFlag": false,
		"BatchStatus": "Active",
		"BatchStatusCode": "A",
		"CreatedBy": "SCMOPERATIONS",
		"CreationDateTime": "2019-08-06T20:00:20+00:00",
		"LastUpdateDateTime": "2019-08-06T20:00:20.239+00:00",
		"LastUpdatedBy": "SCMOPERATIONS",
		"ImportSchedule": "On data load",
		"ImportScheduleCode": "Y",
		"ScheduleDateTime": null,
		"ProcessItems": "Per Item",
		"ProcessItemsCode": "N",
		"DeleteProcessedRows": null,
		"DeleteProcessedRowsCode": null,
		"EnableDataQualityMatchingFlag": true,
		"ConfirmSingleMatchFlag": true,
		"ConfirmUnmatchedNewFlag": true,
		"StructureName": "Primary",
		"StructureNameCode": "Primary",
		"StructureEffectivityControl": "Date",
		"StructureEffectivityControlCode": 1,
		"StructureEffectivityDateTime": "2019-08-06T20:00:20+00:00",
		"StructureUpdate": "Changed components only",
		"StructureUpdateCode": "C",
		"PackUpdate": "All components",
		"PackUpdateCode": "A",
		"NewItemRequestOption": "One per Item",
		"NewItemRequestOptionCode": "I",
		"NewItemRequestSplitAutomaticallyFlag": false,
		"NewItemRequestAssociate": null,
		"NewItemRequestAssociateCode": null,
		"NewItemRequestNumber": null,
		"NewItemRequestName": null,
		"NewItemRequestAddAllItemsFlag": false,
		"NewItemRequestEffectiveDateType": "Type default",
		"NewItemRequestEffectiveDateTypeCode": "D",
		"ChangeOrderOption": "One per Item",
		"ChangeOrderOptionCode": "I",
		"ChangeOrderSplitAutomaticallyFlag": false,
		"ChangeOrderAssociate": null,
		"ChangeOrderAssociateCode": null,
		"ChangeOrderType": null,
		"ChangeOrderTypeCode": null,
		"ChangeOrderNumber": null,
		"ChangeOrderName": null,
		"ChangeOrderAddAllItemsFlag": false,
		"ChangeOrderEffectiveDateType": "Type default",
		"ChangeOrderEffectiveDateTypeCode": "D",
		"LastMatchRequestId": null,
		"LastImportRequestId": null,
		"Type": "E",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B6C00000000EACED00057708000110F084B6B6C1",
			"name": "itemBatches",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B6C00000000EACED00057708000110F084B6B6C1",
			"name": "itemBatches",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F084B6B6C00000000EACED00057708000110F084B6B6C1/child/itemBatchTranslations",
			"name": "itemBatchTranslations",
			"kind": "collection"
		}
		]
	},
	{
		"BatchNumber": "184341",
		"BatchName": "OATS_SUPP_CSV_CREATE_30160814",
		"BatchId": 300100179408703,
		"SpokeSystemName": "JDE",
		"SpokeSystemCode": "JDE",
		"SpokeSystemId": 100000012259013,
		"AssignedTo": "PIMQA",
		"DefaultOrganizationCode": "V1",
		"DefaultOrganizationId": 204,
		"ImportCrossReferencesOnlyFlag": false,
		"BatchStatus": "Active",
		"BatchStatusCode": "A",
		"CreatedBy": "PIMQA",
		"CreationDateTime": "2019-04-26T09:38:58+00:00",
		"LastUpdateDateTime": "2019-04-26T09:44:21+00:00",
		"LastUpdatedBy": "PIMQA",
		"ImportSchedule": "Manual",
		"ImportScheduleCode": "N",
		"ScheduleDateTime": null,
		"ProcessItems": "Per Item",
		"ProcessItemsCode": "N",
		"DeleteProcessedRows": null,
		"DeleteProcessedRowsCode": null,
		"EnableDataQualityMatchingFlag": true,
		"ConfirmSingleMatchFlag": true,
		"ConfirmUnmatchedNewFlag": true,
		"StructureName": "Primary",
		"StructureNameCode": "Primary",
		"StructureEffectivityControl": "Date",
		"StructureEffectivityControlCode": 1,
		"StructureEffectivityDateTime": "2019-04-26T09:38:58+00:00",
		"StructureUpdate": "Changed components only",
		"StructureUpdateCode": "C",
		"PackUpdate": "All components",
		"PackUpdateCode": "A",
		"NewItemRequestOption": "One per Item",
		"NewItemRequestOptionCode": "I",
		"NewItemRequestSplitAutomaticallyFlag": false,
		"NewItemRequestAssociate": null,
		"NewItemRequestAssociateCode": null,
		"NewItemRequestNumber": null,
		"NewItemRequestName": null,
		"NewItemRequestAddAllItemsFlag": false,
		"NewItemRequestEffectiveDateType": "Type default",
		"NewItemRequestEffectiveDateTypeCode": "D",
		"ChangeOrderOption": "One per Item",
		"ChangeOrderOptionCode": "I",
		"ChangeOrderSplitAutomaticallyFlag": false,
		"ChangeOrderAssociate": null,
		"ChangeOrderAssociateCode": null,
		"ChangeOrderType": null,
		"ChangeOrderTypeCode": null,
		"ChangeOrderNumber": null,
		"ChangeOrderName": null,
		"ChangeOrderAddAllItemsFlag": false,
		"ChangeOrderEffectiveDateType": "Type default",
		"ChangeOrderEffectiveDateTypeCode": "D",
		"LastMatchRequestId": 518008,
		"LastImportRequestId": 518043,
		"Type": "E",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F08497373F0000000EACED00057708000110F084973740",
			"name": "itemBatches",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000037371007E00020000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F08497373F0000000EACED00057708000110F084973740",
			"name": "itemBatches",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F08497373F0000000EACED00057708000110F084973740/child/itemBatchTranslations",
			"name": "itemBatchTranslations",
			"kind": "collection"
		}
		]
	},
	{
		"BatchNumber": "185341",
		"BatchName": "OATS_SUPP_CSV_UPDATE_33504575",
		"BatchId": 300100179450111,
		"SpokeSystemName": "JDE",
		"SpokeSystemCode": "JDE",
		"SpokeSystemId": 100000012259013,
		"AssignedTo": "PIMQA",
		"DefaultOrganizationCode": "V1",
		"DefaultOrganizationId": 204,
		"ImportCrossReferencesOnlyFlag": false,
		"BatchStatus": "Active",
		"BatchStatusCode": "A",
		"CreatedBy": "PIMQA",
		"CreationDateTime": "2019-04-26T09:52:16+00:00",
		"LastUpdateDateTime": "2019-04-26T09:57:27+00:00",
		"LastUpdatedBy": "PIMQA",
		"ImportSchedule": "Manual",
		"ImportScheduleCode": "N",
		"ScheduleDateTime": null,
		"ProcessItems": "Per Item",
		"ProcessItemsCode": "N",
		"DeleteProcessedRows": null,
		"DeleteProcessedRowsCode": null,
		"EnableDataQualityMatchingFlag": true,
		"ConfirmSingleMatchFlag": true,
		"ConfirmUnmatchedNewFlag": true,
		"StructureName": "Primary",
		"StructureNameCode": "Primary",
		"StructureEffectivityControl": "Date",
		"StructureEffectivityControlCode": 1,
		"StructureEffectivityDateTime": "2019-04-26T09:52:16+00:00",
		"StructureUpdate": "Changed components only",
		"StructureUpdateCode": "C",
		"PackUpdate": "All components",
		"PackUpdateCode": "A",
		"NewItemRequestOption": "One per Item",
		"NewItemRequestOptionCode": "I",
		"NewItemRequestSplitAutomaticallyFlag": false,
		"NewItemRequestAssociate": null,
		"NewItemRequestAssociateCode": null,
		"NewItemRequestNumber": null,
		"NewItemRequestName": null,
		"NewItemRequestAddAllItemsFlag": false,
		"NewItemRequestEffectiveDateType": "Type default",
		"NewItemRequestEffectiveDateTypeCode": "D",
		"ChangeOrderOption": "One per Item",
		"ChangeOrderOptionCode": "I",
		"ChangeOrderSplitAutomaticallyFlag": false,
		"ChangeOrderAssociate": null,
		"ChangeOrderAssociateCode": null,
		"ChangeOrderType": null,
		"ChangeOrderTypeCode": null,
		"ChangeOrderNumber": null,
		"ChangeOrderName": null,
		"ChangeOrderAddAllItemsFlag": false,
		"ChangeOrderEffectiveDateType": "Type default",
		"ChangeOrderEffectiveDateTypeCode": "D",
		"LastMatchRequestId": 518099,
		"LastImportRequestId": 518143,
		"Type": "E",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F08497D8FF0000000EACED00057708000110F08497D900",
			"name": "itemBatches",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000037371007E00020000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F08497D8FF0000000EACED00057708000110F08497D900",
			"name": "itemBatches",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F08497D8FF0000000EACED00057708000110F08497D900/child/itemBatchTranslations",
			"name": "itemBatchTranslations",
			"kind": "collection"
		}
		]
	},
	{
		"BatchNumber": "187342",
		"BatchName": "OATS_SUPP_UI_CREATE_29087978",
		"BatchId": 300100179690449,
		"SpokeSystemName": "JDE",
		"SpokeSystemCode": "JDE",
		"SpokeSystemId": 100000012259013,
		"AssignedTo": "PIMQA",
		"DefaultOrganizationCode": "V1",
		"DefaultOrganizationId": 204,
		"ImportCrossReferencesOnlyFlag": false,
		"BatchStatus": "Active",
		"BatchStatusCode": "A",
		"CreatedBy": "PIMQA",
		"CreationDateTime": "2019-04-30T07:24:01+00:00",
		"LastUpdateDateTime": "2019-04-30T07:29:23+00:00",
		"LastUpdatedBy": "PIMQA",
		"ImportSchedule": "Manual",
		"ImportScheduleCode": "N",
		"ScheduleDateTime": null,
		"ProcessItems": "Per Item",
		"ProcessItemsCode": "N",
		"DeleteProcessedRows": null,
		"DeleteProcessedRowsCode": null,
		"EnableDataQualityMatchingFlag": true,
		"ConfirmSingleMatchFlag": true,
		"ConfirmUnmatchedNewFlag": true,
		"StructureName": "Primary",
		"StructureNameCode": "Primary",
		"StructureEffectivityControl": "Date",
		"StructureEffectivityControlCode": 1,
		"StructureEffectivityDateTime": "2019-04-30T07:24:01+00:00",
		"StructureUpdate": "Changed components only",
		"StructureUpdateCode": "C",
		"PackUpdate": "All components",
		"PackUpdateCode": "A",
		"NewItemRequestOption": "One per Item",
		"NewItemRequestOptionCode": "I",
		"NewItemRequestSplitAutomaticallyFlag": false,
		"NewItemRequestAssociate": null,
		"NewItemRequestAssociateCode": null,
		"NewItemRequestNumber": null,
		"NewItemRequestName": null,
		"NewItemRequestAddAllItemsFlag": false,
		"NewItemRequestEffectiveDateType": "Type default",
		"NewItemRequestEffectiveDateTypeCode": "D",
		"ChangeOrderOption": "One per Item",
		"ChangeOrderOptionCode": "I",
		"ChangeOrderSplitAutomaticallyFlag": false,
		"ChangeOrderAssociate": null,
		"ChangeOrderAssociateCode": null,
		"ChangeOrderType": null,
		"ChangeOrderTypeCode": null,
		"ChangeOrderNumber": null,
		"ChangeOrderName": null,
		"ChangeOrderAddAllItemsFlag": false,
		"ChangeOrderEffectiveDateType": "Type default",
		"ChangeOrderEffectiveDateTypeCode": "D",
		"LastMatchRequestId": 521924,
		"LastImportRequestId": 521995,
		"Type": "E",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F0849B83D10000000EACED00057708000110F0849B83D2",
			"name": "itemBatches",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000037371007E00020000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F0849B83D10000000EACED00057708000110F0849B83D2",
			"name": "itemBatches",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F0849B83D10000000EACED00057708000110F0849B83D2/child/itemBatchTranslations",
			"name": "itemBatchTranslations",
			"kind": "collection"
		}
		]
	}
	],
	"count": 10,
	"hasMore": true,
	"limit": 10,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/itemBatches",
		"name": "itemBatches",
		"kind": "collection"
	},
	{
		"rel": "action",
		"href": "https://servername/fscmRestApi/resources/version/itemBatches/action/uploadFile",
		"name": "uploadFile",
		"kind": "other"
	}
	]
}

Post a New Item Batch

If Richard wants to create a new item batch for uploading the item data from a data file to batches interface:

  1. Post the data to create a new product upload
  2. The response payload includes details that describe the results of the request.
  3. Your partner application extracts the values for these attributes from the response payload and displays them in the client.
Attribute Description
BatchName Name of the item batch.
BatchId Value that uniquely identifies the item batch.
CreationDateTime Date and time when the user created the item batch.
CreatedBy User who created the item batch.

Example URL

Use this resource URL format.

POST

curl -X POST -u username:password "https://servername/fscmRestApi/resources/version/itemBatches" -H 'authorization: Basic c2Ntb3BlcmF0aW9uczpXZWxjb21lMQ==' -H 'cache-control: no-cache' -H 'Content-Type: application/json' -d 'request payload'

Example Request

Here's an example of the request body in JSON format.

{
	"BatchName":"batch_022421_01",
	"SpokeSystemName":"JDE",
	"DefaultOrganizationCode":"V1",
	"ImportSchedule": "Manual"
}

Example Response

Here's an example of the response body in JSON format.

{
	"BatchNumber": "325418",
	"BatchName": "batch_022421_01",
	"BatchId": 300100545817268,
	"SpokeSystemName": "JDE",
	"SpokeSystemCode": "JDE",
	"SpokeSystemId": 100000012259013,
	"AssignedTo": "PIMQA",
	"DefaultOrganizationCode": "V1",
	"DefaultOrganizationId": 204,
	"ImportCrossReferencesOnlyFlag": false,
	"BatchStatus": "Active",
	"BatchStatusCode": "A",
	"CreatedBy": "PIMQA",
	"CreationDateTime": "2021-02-24T09:39:14+00:00",
	"LastUpdateDateTime": "2021-02-24T09:39:14.669+00:00",
	"LastUpdatedBy": "PIMQA",
	"ImportSchedule": "Manual",
	"ImportScheduleCode": "N",
	"ScheduleDateTime": null,
	"ProcessItems": "Per Item",
	"ProcessItemsCode": "N",
	"DeleteProcessedRows": null,
	"DeleteProcessedRowsCode": null,
	"EnableDataQualityMatchingFlag": true,
	"ConfirmSingleMatchFlag": true,
	"ConfirmUnmatchedNewFlag": true,
	"StructureName": "Primary",
	"StructureNameCode": "Primary",
	"StructureEffectivityControl": "Date",
	"StructureEffectivityControlCode": 1,
	"StructureEffectivityDateTime": "2021-02-24T09:39:14+00:00",
	"StructureUpdate": "Changed components only",
	"StructureUpdateCode": "C",
	"PackUpdate": "All components",
	"PackUpdateCode": "A",
	"NewItemRequestOption": "One per Item",
	"NewItemRequestOptionCode": "I",
	"NewItemRequestSplitAutomaticallyFlag": false,
	"NewItemRequestAssociate": null,
	"NewItemRequestAssociateCode": null,
	"NewItemRequestNumber": null,
	"NewItemRequestName": null,
	"NewItemRequestAddAllItemsFlag": false,
	"NewItemRequestEffectiveDateType": "Type default",
	"NewItemRequestEffectiveDateTypeCode": "D",
	"ChangeOrderOption": "One per Item",
	"ChangeOrderOptionCode": "I",
	"ChangeOrderSplitAutomaticallyFlag": false,
	"ChangeOrderAssociate": "Create new",
	"ChangeOrderAssociateCode": "N",
	"ChangeOrderType": null,
	"ChangeOrderTypeCode": null,
	"ChangeOrderNumber": "Vish_PPCM",
	"ChangeOrderName": "Vish_PPCM",
	"ChangeOrderAddAllItemsFlag": false,
	"ChangeOrderEffectiveDateType": "Effective immediately",
	"ChangeOrderEffectiveDateTypeCode": "A",
	"LastMatchRequestId": null,
	"LastImportRequestId": null,
	"Type": "E",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F09A6E2AB40000000EACED00057708000110F09A6E2AB5",
		"name": "itemBatches",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F09A6E2AB40000000EACED00057708000110F09A6E2AB5",
		"name": "itemBatches",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/itemBatches/00020000000EACED00057708000110F09A6E2AB40000000EACED00057708000110F09A6E2AB5/child/itemBatchTranslations",
		"name": "itemBatchTranslations",
		"kind": "collection"
	}
	]
}

Upload Item Data

If Richard wants to upload a data file containing item data to batches interface for import:

  1. Post the data to upload the item data from the data file to batches interface for import
  2. The response payload includes details that describe the results of the request.
  3. Your partner application extracts the values for these attributes from the response payload and displays them in the client.
Attribute Description
BatchName Name of the item batch.
BatchId Value that uniquely identifies the item batch.
CreationDateTime Date and time when the user created the item batch.
CreatedBy User who created the item batch.

Example URL

Note:

  • Before running upload file, you must upload the data file and the attachments zip file to the scm$/item$/import$/ Oracle WebCenter Content account. Only the user who uploads the data file and attachments zip file to Oracle WebCenter Content can upload the item data and attachments from the data or attachment files to the batches interface.

Use this resource URL format.

POST

curl -X POST -u username:password "https://servername/fscmRestApi/resources/version/itemBatches" -H 'authorization: Basic c2Ntb3BlcmF0aW9uczpXZWxjb21lMQ==' -H 'cache-control: o-cache' -H 'Content-Type: application/vnd.oracle.adf.action+json' -d'{"name":"uploadFile", "parameters":[{"batchNumber":325418},{ "dataFilePath" : "/scm/item/import/Import.csv"},{"importMapName":"Import Map"} ]}']

Example Response

Here's an example of the response body in JSON format.

{
	"result": "File upload complete. 2 rows were uploaded to batch 325418.Your process 200,046 was submitted."
}