Create item batches
post
/fscmRestApi/resources/11.13.18.05/itemBatches
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 does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
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
Root Schema : schema
Type:
Show Source
object
-
AssignedTo: string
Maximum Length:
100
User who's assigned to the item batch. -
BatchName(required): string
Title:
Name
Maximum Length:80
Name of the item batch. -
BatchStatus: string
Maximum Length:
20
Status of the item batch. A list of accepted values is defined in the lookup type EGI_IMPORT_BATCH_STATUS. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
BatchStatusCode: string
Title:
Status
Maximum Length:1
Default Value:A
Abbreviation that identifies the status of the item batch. A list of accepted values is defined in the lookup type EGI_IMPORT_BATCH_STATUS. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ChangeOrderAddAllItemsFlag: boolean
Title:
Add all items
Maximum Length:1
Contains one of the following values: true or false. If true, then all imported item changes are added to a change order. If false, then the imported item changes aren't added to a change order. The default value is the value from the spoke system of the item batch. -
ChangeOrderAssociate: string
Maximum Length:
30
Value that indicates the creation a new change order for the imported item changes or adding the imported item changes to an existing change order. A list of accepted values is defined in the lookup type EGI_CHG_ORDER_CREATION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ChangeOrderAssociateCode: string
Title:
Associate
Maximum Length:30
Abbreviation that identifies creation of a new change order for the imported item changes or adding the imported item changes to an existing change order. A list of accepted values is defined in the lookup type EGI_CHG_ORDER_CREATION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
ChangeOrderEffectiveDateType: string
Maximum Length:
30
Value that indicates when the item changes imported to the change order become effective. A list of accepted values is defined in the lookup type ORA_EGI_CO_EFFECTIVE_DATE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ChangeOrderEffectiveDateTypeCode: string
Title:
Effective Date
Maximum Length:30
Default Value:D
Abbreviation that identifies when the item changes imported to the change order become effective. A list of accepted values is defined in the lookup type ORA_EGI_CO_EFFECTIVE_DATE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
ChangeOrderName: string
Title:
Name
Maximum Length:240
Name of the change order. The default value is the value from the spoke system of the item batch. -
ChangeOrderNumber: string
Title:
Number
Maximum Length:50
Number that identifies the change order. The default value is the value from the spoke system of the item batch. -
ChangeOrderOption: string
Maximum Length:
30
Value that indicates how change orders get created or updated by the item batch. A list of accepted values is defined in the lookup type EGI_CHANGE_ORDER_OPTION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ChangeOrderOptionCode: string
Title:
Change Order
Maximum Length:1
Abbreviation that identifies how change orders get created or updated by the item batch. A list of accepted values is defined in the lookup type EGI_CHANGE_ORDER_OPTION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
ChangeOrderSplitAutomaticallyFlag: boolean
Title:
Split automatically
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the imported items are split into multiple change orders. If false, then the imported items aren't split into multiple change orders. The default value is the value from the spoke system of the item batch. -
ChangeOrderType: string
Maximum Length:
80
Type of change order. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Order Types task. -
ChangeOrderTypeCode: string
Maximum Length:
80
Abbreviation that identifies the type of change order. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Order Types task. The default value is the value from the spoke system of the item batch. -
ConfirmSingleMatchFlag: boolean
Title:
Confirm single matches
Maximum Length:1
Contains one of the following values: true or false. If true, then single item matches get automatically confirmed during import. If false, then single item matches don't get automatically confirmed during import. The default value is the value from the spoke system of the item batch. -
ConfirmUnmatchedNewFlag: boolean
Title:
Confirm unmatched as new item
Maximum Length:1
Contains one of the following values: true or false. If true, then unmatched items get confirmed as new items during import. If false, then unmatched items don't get confirmed as new items during import. The default value is the value from the spoke system of the item batch. -
DefaultOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the default organization of the item batch. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
DefaultOrganizationId: integer
(int64)
Title:
Default Organization
Value that uniquely identifies the default organization of the item batch. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. The default value is the value from the spoke system of the item batch. -
DeleteProcessedRows: string
Maximum Length:
20
Value that indicates the interface rows that are to be deleted after import. A list of accepted values is defined in the lookup type ORA_EGP_PURGE_BATCH_ROWS_TYPE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
DeleteProcessedRowsCode: string
Maximum Length:
6
Abbreviation that identifies the interface rows that are to be deleted after import. A list of accepted values is defined in the lookup type ORA_EGP_PURGE_BATCH_ROWS_TYPE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
EnableDataQualityMatchingFlag: boolean
Title:
Enable data quality matching
Maximum Length:1
Contains one of the following values: true or false. If true, then data quality matching is enabled. If false, then data quality matching isn't enabled. The default value is the value from the spoke system of the item batch. -
ImportCrossReferencesOnlyFlag: boolean
Title:
Cross-references only
Maximum Length:1
Contains one of the following values: true or false. If true, then only cross-references are imported. If false, then cross-references aren't imported. The default value is the value from the spoke system of the item batch. -
ImportSchedule: string
Maximum Length:
80
Value that indicates how item data gets imported after uploading it to the item batch. A list of accepted values is defined in the lookup type EGI_IMPORT_ON_DATA_LOAD. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ImportScheduleCode: string
Title:
Schedule
Maximum Length:1
Abbreviation that identifies how item data gets imported after uploading it to the item batch. A list of accepted values is defined in the lookup type EGI_IMPORT_ON_DATA_LOAD. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
itemBatchTranslations: array
Item Batch Translations
Title:
Item Batch Translations
The Item Batch Translations resource manages records in item batch translations. -
LastImportRequestId: integer
(int64)
Title:
Last Import Request Phase
Value that uniquely identifies last run import scheduled process. -
LastMatchRequestId: integer
(int64)
Title:
Last Data Process Request Phase
Value that uniquely identifies last run item matching scheduled process. -
NewItemRequestAddAllItemsFlag: boolean
Title:
Add all items
Maximum Length:1
Contains one of the following values: true or false. If true, then all imported items are added to a new item request. If false, then imported items are added to a new item request. The default value is the value from the spoke system of the item batch. -
NewItemRequestAssociate: string
Maximum Length:
30
Value that indicates the creation of a new item request for the imported items or adding the imported items to an existing item request. A list of accepted values is defined in the lookup type EGI_CHG_ORDER_CREATION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
NewItemRequestAssociateCode: string
Title:
Associate
Maximum Length:1
Abbreviation that identifies the creation of a new item request for the imported items or adding the imported items to an existing item request. A list of accepted values is defined in the lookup type EGI_CHG_ORDER_CREATION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
NewItemRequestEffectiveDateType: string
Maximum Length:
30
Value that indicates when the items imported to the new item request become effective. A list of accepted values is defined in the lookup type EGI_NIR_CO_EFFECTIVE_DATE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
NewItemRequestEffectiveDateTypeCode: string
Title:
Effective Date
Maximum Length:30
Default Value:D
Abbreviation that identifies when the items imported to the new item request become effective. A list of accepted values is defined in the lookup type EGI_NIR_CO_EFFECTIVE_DATE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
NewItemRequestName: string
Title:
Name
Maximum Length:240
Name of the new item request. The default value is the value from the spoke system of the item batch. -
NewItemRequestNumber: string
Title:
Number
Maximum Length:50
Number that identifies the new item request. The default value is the value from the spoke system of the item batch. -
NewItemRequestOption: string
Maximum Length:
30
Value that indicates how new item requests are created or updated by the item batch. A list of accepted values is defined in the lookup type EGI_CHANGE_ORDER_OPTION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
NewItemRequestOptionCode: string
Title:
New Item Request
Maximum Length:1
Abbreviation that identifies how new item requests are created or updated by the item batch. A list of accepted values is defined in the lookup type EGI_CHANGE_ORDER_OPTION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
NewItemRequestSplitAutomaticallyFlag: boolean
Title:
Split automatically
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the imported items are split into multiple new item requests. If false, then the imported items aren't split into multiple new item requests. The default value is the value from the spoke system of the item batch. -
PackUpdate: string
Maximum Length:
30
Value that identifies the pack components that are to be updated. A list of accepted values is defined in the lookup type EGI_IMPORT_STRUCTURE_CONTENT. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
PackUpdateCode: string
Maximum Length:
30
Abbreviation that identifies the pack components that are to be updated. A list of accepted values is defined in the lookup type EGI_IMPORT_STRUCTURE_CONTENT. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
ProcessItems: string
Maximum Length:
20
Value that indicates how items are grouped during import. A list of accepted values is defined in the lookup type ORA_EGI_PROCESS_ITEMS_OPTIONS. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ProcessItemsCode: string
Title:
Process Items
Maximum Length:1
Abbreviation that identifies how items are grouped during import. A list of accepted values is defined in the lookup type ORA_EGI_PROCESS_ITEMS_OPTIONS. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
ScheduleDateTime: string
(date-time)
Date and time when the item batch is scheduled to run to import the item data.
-
SpokeSystemCode: string
Maximum Length:
80
Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task. -
SpokeSystemId(required): integer
(int64)
Title:
Spoke System ID
Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task. -
SpokeSystemName: string
Maximum Length:
80
Name of the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task. -
StructureEffectivityControl: string
Maximum Length:
20
Effectivity control of the item structure. Valid value is Date. -
StructureEffectivityControlCode: integer
(int32)
Title:
Effectivity Control
Default Value:1
Abbreviation that identifies the effectivity control of the item structure. Valid value is 1. -
StructureEffectivityDateTime: string
(date-time)
Date and time when the structure component becomes effective.
-
StructureName: string
Maximum Length:
80
Name of the item structure. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Structure Type Details task. -
StructureNameCode: string
Title:
Name
Maximum Length:80
Abbreviation that identifies the item structure. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Structure Type Details task. This attribute defaults the value from the spoke system of the item batch. -
StructureUpdate: string
Maximum Length:
30
Value that indicates the structure components that are to be updated. A list of accepted values is defined in the lookup type EGI_IMPORT_STRUCTURE_CONTENT. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
StructureUpdateCode: string
Title:
Update
Maximum Length:30
Abbreviation that identifies the structure components that are to be updated. A list of accepted values is defined in the lookup type EGI_IMPORT_STRUCTURE_CONTENT. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
Type: string
Title:
Type
Maximum Length:1
Default Value:E
Type of the Item batch. Valid values are E and I. The default value is E.
Nested Schema : Item Batch Translations
Type:
array
Title:
Item Batch Translations
The Item Batch Translations resource manages records in item batch translations.
Show Source
Nested Schema : itemBatches-itemBatchTranslations-item-post-request
Type:
Show Source
object
-
BatchId: integer
(int64)
Value that uniquely identifies the item batch.
-
BatchName: string
Maximum Length:
80
Name of the item batch. -
Language: string
Maximum Length:
4
Language associated with the item batch. -
SourceLanguage: string
Maximum Length:
4
Source language associated with the item batch.
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 : itemBatches-item-response
Type:
Show Source
object
-
AssignedTo: string
Maximum Length:
100
User who's assigned to the item batch. -
BatchId: integer
(int64)
Title:
Batch ID
Read Only:true
Value that uniquely identifies the item batch. -
BatchName: string
Title:
Name
Maximum Length:80
Name of the item batch. -
BatchNumber: string
Title:
Number
Read Only:true
Maximum Length:40
Number that identifies the item batch. -
BatchStatus: string
Maximum Length:
20
Status of the item batch. A list of accepted values is defined in the lookup type EGI_IMPORT_BATCH_STATUS. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
BatchStatusCode: string
Title:
Status
Maximum Length:1
Default Value:A
Abbreviation that identifies the status of the item batch. A list of accepted values is defined in the lookup type EGI_IMPORT_BATCH_STATUS. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ChangeOrderAddAllItemsFlag: boolean
Title:
Add all items
Maximum Length:1
Contains one of the following values: true or false. If true, then all imported item changes are added to a change order. If false, then the imported item changes aren't added to a change order. The default value is the value from the spoke system of the item batch. -
ChangeOrderAssociate: string
Maximum Length:
30
Value that indicates the creation a new change order for the imported item changes or adding the imported item changes to an existing change order. A list of accepted values is defined in the lookup type EGI_CHG_ORDER_CREATION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ChangeOrderAssociateCode: string
Title:
Associate
Maximum Length:30
Abbreviation that identifies creation of a new change order for the imported item changes or adding the imported item changes to an existing change order. A list of accepted values is defined in the lookup type EGI_CHG_ORDER_CREATION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
ChangeOrderEffectiveDateType: string
Maximum Length:
30
Value that indicates when the item changes imported to the change order become effective. A list of accepted values is defined in the lookup type ORA_EGI_CO_EFFECTIVE_DATE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ChangeOrderEffectiveDateTypeCode: string
Title:
Effective Date
Maximum Length:30
Default Value:D
Abbreviation that identifies when the item changes imported to the change order become effective. A list of accepted values is defined in the lookup type ORA_EGI_CO_EFFECTIVE_DATE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
ChangeOrderName: string
Title:
Name
Maximum Length:240
Name of the change order. The default value is the value from the spoke system of the item batch. -
ChangeOrderNumber: string
Title:
Number
Maximum Length:50
Number that identifies the change order. The default value is the value from the spoke system of the item batch. -
ChangeOrderOption: string
Maximum Length:
30
Value that indicates how change orders get created or updated by the item batch. A list of accepted values is defined in the lookup type EGI_CHANGE_ORDER_OPTION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ChangeOrderOptionCode: string
Title:
Change Order
Maximum Length:1
Abbreviation that identifies how change orders get created or updated by the item batch. A list of accepted values is defined in the lookup type EGI_CHANGE_ORDER_OPTION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
ChangeOrderSplitAutomaticallyFlag: boolean
Title:
Split automatically
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the imported items are split into multiple change orders. If false, then the imported items aren't split into multiple change orders. The default value is the value from the spoke system of the item batch. -
ChangeOrderType: string
Maximum Length:
80
Type of change order. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Order Types task. -
ChangeOrderTypeCode: string
Maximum Length:
80
Abbreviation that identifies the type of change order. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Order Types task. The default value is the value from the spoke system of the item batch. -
ConfirmSingleMatchFlag: boolean
Title:
Confirm single matches
Maximum Length:1
Contains one of the following values: true or false. If true, then single item matches get automatically confirmed during import. If false, then single item matches don't get automatically confirmed during import. The default value is the value from the spoke system of the item batch. -
ConfirmUnmatchedNewFlag: boolean
Title:
Confirm unmatched as new item
Maximum Length:1
Contains one of the following values: true or false. If true, then unmatched items get confirmed as new items during import. If false, then unmatched items don't get confirmed as new items during import. The default value is the value from the spoke system of the item batch. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the item batch. -
CreationDateTime: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user created the item batch. -
DefaultOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the default organization of the item batch. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
DefaultOrganizationId: integer
(int64)
Title:
Default Organization
Value that uniquely identifies the default organization of the item batch. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. The default value is the value from the spoke system of the item batch. -
DeleteProcessedRows: string
Maximum Length:
20
Value that indicates the interface rows that are to be deleted after import. A list of accepted values is defined in the lookup type ORA_EGP_PURGE_BATCH_ROWS_TYPE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
DeleteProcessedRowsCode: string
Maximum Length:
6
Abbreviation that identifies the interface rows that are to be deleted after import. A list of accepted values is defined in the lookup type ORA_EGP_PURGE_BATCH_ROWS_TYPE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
EnableDataQualityMatchingFlag: boolean
Title:
Enable data quality matching
Maximum Length:1
Contains one of the following values: true or false. If true, then data quality matching is enabled. If false, then data quality matching isn't enabled. The default value is the value from the spoke system of the item batch. -
ImportCrossReferencesOnlyFlag: boolean
Title:
Cross-references only
Maximum Length:1
Contains one of the following values: true or false. If true, then only cross-references are imported. If false, then cross-references aren't imported. The default value is the value from the spoke system of the item batch. -
ImportSchedule: string
Maximum Length:
80
Value that indicates how item data gets imported after uploading it to the item batch. A list of accepted values is defined in the lookup type EGI_IMPORT_ON_DATA_LOAD. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ImportScheduleCode: string
Title:
Schedule
Maximum Length:1
Abbreviation that identifies how item data gets imported after uploading it to the item batch. A list of accepted values is defined in the lookup type EGI_IMPORT_ON_DATA_LOAD. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
itemBatchTranslations: array
Item Batch Translations
Title:
Item Batch Translations
The Item Batch Translations resource manages records in item batch translations. -
LastImportRequestId: integer
(int64)
Title:
Last Import Request Phase
Value that uniquely identifies last run import scheduled process. -
LastMatchRequestId: integer
(int64)
Title:
Last Data Process Request Phase
Value that uniquely identifies last run item matching scheduled process. -
LastUpdateDateTime: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the item batch. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the item batch. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewItemRequestAddAllItemsFlag: boolean
Title:
Add all items
Maximum Length:1
Contains one of the following values: true or false. If true, then all imported items are added to a new item request. If false, then imported items are added to a new item request. The default value is the value from the spoke system of the item batch. -
NewItemRequestAssociate: string
Maximum Length:
30
Value that indicates the creation of a new item request for the imported items or adding the imported items to an existing item request. A list of accepted values is defined in the lookup type EGI_CHG_ORDER_CREATION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
NewItemRequestAssociateCode: string
Title:
Associate
Maximum Length:1
Abbreviation that identifies the creation of a new item request for the imported items or adding the imported items to an existing item request. A list of accepted values is defined in the lookup type EGI_CHG_ORDER_CREATION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
NewItemRequestEffectiveDateType: string
Maximum Length:
30
Value that indicates when the items imported to the new item request become effective. A list of accepted values is defined in the lookup type EGI_NIR_CO_EFFECTIVE_DATE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
NewItemRequestEffectiveDateTypeCode: string
Title:
Effective Date
Maximum Length:30
Default Value:D
Abbreviation that identifies when the items imported to the new item request become effective. A list of accepted values is defined in the lookup type EGI_NIR_CO_EFFECTIVE_DATE. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
NewItemRequestName: string
Title:
Name
Maximum Length:240
Name of the new item request. The default value is the value from the spoke system of the item batch. -
NewItemRequestNumber: string
Title:
Number
Maximum Length:50
Number that identifies the new item request. The default value is the value from the spoke system of the item batch. -
NewItemRequestOption: string
Maximum Length:
30
Value that indicates how new item requests are created or updated by the item batch. A list of accepted values is defined in the lookup type EGI_CHANGE_ORDER_OPTION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
NewItemRequestOptionCode: string
Title:
New Item Request
Maximum Length:1
Abbreviation that identifies how new item requests are created or updated by the item batch. A list of accepted values is defined in the lookup type EGI_CHANGE_ORDER_OPTION. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
NewItemRequestSplitAutomaticallyFlag: boolean
Title:
Split automatically
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the imported items are split into multiple new item requests. If false, then the imported items aren't split into multiple new item requests. The default value is the value from the spoke system of the item batch. -
PackUpdate: string
Maximum Length:
30
Value that identifies the pack components that are to be updated. A list of accepted values is defined in the lookup type EGI_IMPORT_STRUCTURE_CONTENT. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
PackUpdateCode: string
Maximum Length:
30
Abbreviation that identifies the pack components that are to be updated. A list of accepted values is defined in the lookup type EGI_IMPORT_STRUCTURE_CONTENT. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
ProcessItems: string
Maximum Length:
20
Value that indicates how items are grouped during import. A list of accepted values is defined in the lookup type ORA_EGI_PROCESS_ITEMS_OPTIONS. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ProcessItemsCode: string
Title:
Process Items
Maximum Length:1
Abbreviation that identifies how items are grouped during import. A list of accepted values is defined in the lookup type ORA_EGI_PROCESS_ITEMS_OPTIONS. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
ScheduleDateTime: string
(date-time)
Date and time when the item batch is scheduled to run to import the item data.
-
SpokeSystemCode: string
Maximum Length:
80
Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task. -
SpokeSystemId: integer
(int64)
Title:
Spoke System ID
Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task. -
SpokeSystemName: string
Maximum Length:
80
Name of the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task. -
StructureEffectivityControl: string
Maximum Length:
20
Effectivity control of the item structure. Valid value is Date. -
StructureEffectivityControlCode: integer
(int32)
Title:
Effectivity Control
Default Value:1
Abbreviation that identifies the effectivity control of the item structure. Valid value is 1. -
StructureEffectivityDateTime: string
(date-time)
Date and time when the structure component becomes effective.
-
StructureName: string
Maximum Length:
80
Name of the item structure. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Structure Type Details task. -
StructureNameCode: string
Title:
Name
Maximum Length:80
Abbreviation that identifies the item structure. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Structure Type Details task. This attribute defaults the value from the spoke system of the item batch. -
StructureUpdate: string
Maximum Length:
30
Value that indicates the structure components that are to be updated. A list of accepted values is defined in the lookup type EGI_IMPORT_STRUCTURE_CONTENT. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
StructureUpdateCode: string
Title:
Update
Maximum Length:30
Abbreviation that identifies the structure components that are to be updated. A list of accepted values is defined in the lookup type EGI_IMPORT_STRUCTURE_CONTENT. Review the list of values using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is the value from the spoke system of the item batch. -
Type: string
Title:
Type
Maximum Length:1
Default Value:E
Type of the Item batch. Valid values are E and I. The default value is E.
Nested Schema : Item Batch Translations
Type:
array
Title:
Item Batch Translations
The Item Batch Translations resource manages records in item batch translations.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : itemBatches-itemBatchTranslations-item-response
Type:
Show Source
object
-
BatchId: integer
(int64)
Value that uniquely identifies the item batch.
-
BatchName: string
Maximum Length:
80
Name of the item batch. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the item batch. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the user created the item batch. -
Language: string
Maximum Length:
4
Language associated with the item batch. -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the item batch. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the item batch. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceLanguage: string
Maximum Length:
4
Source language associated with the item batch.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- BatchStatusesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGI_IMPORT_BATCH_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: BatchStatusCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- ChangeOrderAssociatesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGI_CHG_ORDER_CREATION
The following properties are defined on the LOV link relation:- Source Attribute: ChangeOrderAssociateCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- ChangeOrderEffectiveDateTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_EGI_CO_EFFECTIVE_DATE
The following properties are defined on the LOV link relation:- Source Attribute: ChangeOrderEffectiveDateTypeCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- ChangeOrderOptionsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGI_CHANGE_ORDER_OPTION
The following properties are defined on the LOV link relation:- Source Attribute: ChangeOrderOptionCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- DeleteProcessedRowsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_EGP_PURGE_BATCH_ROWS_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: DeleteProcessedRowsCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- ImportScheduleLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGI_IMPORT_ON_DATA_LOAD
The following properties are defined on the LOV link relation:- Source Attribute: ImportScheduleCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- NewItemRequestAssociatesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGI_CHG_ORDER_CREATION
The following properties are defined on the LOV link relation:- Source Attribute: NewItemRequestAssociateCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- NewItemRequestEffectiveDateTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3DA%2CD%2CLookupType%3DEGI_NIR_CO_EFFECTIVE_DATE
The following properties are defined on the LOV link relation:- Source Attribute: NewItemRequestEffectiveDateTypeCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- NewItemRequestOptionsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGI_CHANGE_ORDER_OPTION
The following properties are defined on the LOV link relation:- Source Attribute: NewItemRequestOptionCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- PackUpdateLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGI_IMPORT_STRUCTURE_CONTENT
The following properties are defined on the LOV link relation:- Source Attribute: PackUpdateCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- ProcessItemsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_EGI_PROCESS_ITEMS_OPTIONS
The following properties are defined on the LOV link relation:- Source Attribute: ProcessItemsCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- StructureEffectivityControlLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGI_BOM_EFFEC_CTRL%2CLookupCode%3D1
The following properties are defined on the LOV link relation:- Source Attribute: StructureEffectivityControlCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- StructureUpdateLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGI_IMPORT_STRUCTURE_CONTENT
The following properties are defined on the LOV link relation:- Source Attribute: StructureUpdateCode; Target Attribute: LookupCode
- Display Attribute: LookupCode, Meaning
- finder:
- itemBatchTranslations
-
Operation: /fscmRestApi/resources/11.13.18.05/itemBatches/{itemBatchesUniqID}/child/itemBatchTranslationsParameters:
- itemBatchesUniqID:
$request.path.itemBatchesUniqID
The Item Batch Translations resource manages records in item batch translations. - itemBatchesUniqID:
Examples
This example describes how to create item batches.
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/itemBatches"
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 creates.
{ "BatchName":"batch_022421_01", "SpokeSystemName":"JDE", "DefaultOrganizationCode":"V1", "ImportSchedule": "Manual" }
Example Response Body
The following example includes the contents 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" } ] }