Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "required":[
        "BatchName",
        "SpokeSystemId"
    ],
    "type":"object",
    "properties":{
        "ChangeOrderEffectiveDateType":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SpokeSystemId":{
            "title":"Spoke System ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ImportScheduleCode":{
            "title":"Schedule",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChangeOrderSplitAutomaticallyFlag":{
            "title":"Split automatically",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false
        },
        "NewItemRequestAddAllItemsFlag":{
            "title":"Add all items",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "PackUpdateCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConfirmUnmatchedNewFlag":{
            "title":"Confirm unmatched as new item",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "NewItemRequestOptionCode":{
            "title":"New Item Request",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StructureEffectivityControl":{
            "maxLength":20,
            "type":"string",
            "description":"Effectivity control of the item structure. Valid value is Date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ImportCrossReferencesOnlyFlag":{
            "title":"Cross-references only",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "NewItemRequestAssociateCode":{
            "title":"Associate",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastMatchRequestId":{
            "title":"Last Data Process Request Phase",
            "type":"integer",
            "description":"Value that uniquely identifies last run item matching scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ConfirmSingleMatchFlag":{
            "title":"Confirm single matches",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "NewItemRequestName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the new item request. The default value is the value from the spoke system of the item batch.",
            "nullable":true
        },
        "DeleteProcessedRows":{
            "maxLength":20,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnableDataQualityMatchingFlag":{
            "title":"Enable data quality matching",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "ImportSchedule":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BatchStatusCode":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"A",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChangeOrderName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the change order. The default value is the value from the spoke system of the item batch.",
            "nullable":true
        },
        "StructureNameCode":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChangeOrderType":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeleteProcessedRowsCode":{
            "maxLength":6,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StructureName":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChangeOrderOptionCode":{
            "title":"Change Order",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BatchStatus":{
            "maxLength":20,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StructureEffectivityDateTime":{
            "type":"string",
            "description":"Date and time when the structure component becomes effective.",
            "format":"date-time",
            "nullable":true
        },
        "NewItemRequestAssociate":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChangeOrderTypeCode":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastImportRequestId":{
            "title":"Last Import Request Phase",
            "type":"integer",
            "description":"Value that uniquely identifies last run import scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NewItemRequestSplitAutomaticallyFlag":{
            "title":"Split automatically",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false
        },
        "NewItemRequestEffectiveDateTypeCode":{
            "title":"Effective Date",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"D",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "itemBatchTranslations":{
            "title":"Item Batch Translations",
            "type":"array",
            "description":"The Item Batch Translations resource manages records in item batch translations.",
            "items":{
                "$ref":"#/components/schemas/itemBatches-itemBatchTranslations-item-post-request"
            }
        },
        "ChangeOrderEffectiveDateTypeCode":{
            "title":"Effective Date",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"D",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BatchName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the item batch.",
            "nullable":false
        },
        "ProcessItems":{
            "maxLength":20,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChangeOrderNumber":{
            "title":"Number",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the change order. The default value is the value from the spoke system of the item batch.",
            "nullable":true
        },
        "StructureUpdateCode":{
            "title":"Update",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StructureUpdate":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChangeOrderAssociate":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SpokeSystemCode":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NewItemRequestOption":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChangeOrderAddAllItemsFlag":{
            "title":"Add all items",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "DefaultOrganizationId":{
            "title":"Default Organization",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NewItemRequestNumber":{
            "title":"Number",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the new item request. The default value is the value from the spoke system of the item batch.",
            "nullable":true
        },
        "SpokeSystemName":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssignedTo":{
            "maxLength":100,
            "type":"string",
            "description":"User who's assigned to the item batch.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Type":{
            "title":"Type",
            "maxLength":1,
            "type":"string",
            "description":"Type of the Item batch. Valid values are E and I. The default value is E.",
            "nullable":true,
            "default":"E"
        },
        "ChangeOrderAssociateCode":{
            "title":"Associate",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StructureEffectivityControlCode":{
            "title":"Effectivity Control",
            "type":"integer",
            "description":"Abbreviation that identifies the effectivity control of the item structure. Valid value is 1.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "controlType":"choice",
                "precision":9
            }
        },
        "PackUpdate":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChangeOrderOption":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ScheduleDateTime":{
            "type":"string",
            "description":"Date and time when the item batch is scheduled to run to import the item data.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessItemsCode":{
            "title":"Process Items",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NewItemRequestEffectiveDateType":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Item Batch Translations

Type: array

Title: Item Batch Translations

The Item Batch Translations resource manages records in item batch translations.

Show Source

• Array of: object itemBatches-itemBatchTranslations-item-post-request

{
    "title":"Item Batch Translations",
    "type":"array",
    "description":"The Item Batch Translations resource manages records in item batch translations.",
    "items":{
        "$ref":"#/components/schemas/itemBatches-itemBatchTranslations-item-post-request"
    }
}

Nested Schema : itemBatches-itemBatchTranslations-item-post-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Source language associated with the item batch.",
            "nullable":false
        },
        "BatchName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the item batch.",
            "nullable":false
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language associated with the item batch.",
            "nullable":false
        },
        "BatchId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item batch.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : itemBatches-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ChangeOrderEffectiveDateType":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SpokeSystemId":{
            "title":"Spoke System ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ImportScheduleCode":{
            "title":"Schedule",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChangeOrderSplitAutomaticallyFlag":{
            "title":"Split automatically",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "NewItemRequestAddAllItemsFlag":{
            "title":"Add all items",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PackUpdateCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConfirmUnmatchedNewFlag":{
            "title":"Confirm unmatched as new item",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "NewItemRequestOptionCode":{
            "title":"New Item Request",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StructureEffectivityControl":{
            "maxLength":20,
            "type":"string",
            "description":"Effectivity control of the item structure. Valid value is Date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ImportCrossReferencesOnlyFlag":{
            "title":"Cross-references only",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "NewItemRequestAssociateCode":{
            "title":"Associate",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastMatchRequestId":{
            "title":"Last Data Process Request Phase",
            "type":"integer",
            "description":"Value that uniquely identifies last run item matching scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConfirmSingleMatchFlag":{
            "title":"Confirm single matches",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "NewItemRequestName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the new item request. The default value is the value from the spoke system of the item batch.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DeleteProcessedRows":{
            "maxLength":20,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnableDataQualityMatchingFlag":{
            "title":"Enable data quality matching",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ImportSchedule":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BatchStatusCode":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"A",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChangeOrderName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the change order. The default value is the value from the spoke system of the item batch.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the item batch.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StructureNameCode":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChangeOrderType":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the item batch.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchNumber":{
            "title":"Number",
            "maxLength":40,
            "type":"string",
            "description":"Number that identifies the item batch.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"Value that uniquely identifies the item batch.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteProcessedRowsCode":{
            "maxLength":6,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StructureName":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChangeOrderOptionCode":{
            "title":"Change Order",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BatchStatus":{
            "maxLength":20,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StructureEffectivityDateTime":{
            "type":"string",
            "description":"Date and time when the structure component becomes effective.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "NewItemRequestAssociate":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChangeOrderTypeCode":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the item batch.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastImportRequestId":{
            "title":"Last Import Request Phase",
            "type":"integer",
            "description":"Value that uniquely identifies last run import scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NewItemRequestSplitAutomaticallyFlag":{
            "title":"Split automatically",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "NewItemRequestEffectiveDateTypeCode":{
            "title":"Effective Date",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"D",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "itemBatchTranslations":{
            "title":"Item Batch Translations",
            "type":"array",
            "description":"The Item Batch Translations resource manages records in item batch translations.",
            "items":{
                "$ref":"#/components/schemas/itemBatches-itemBatchTranslations-item-response"
            }
        },
        "ChangeOrderEffectiveDateTypeCode":{
            "title":"Effective Date",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"D",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BatchName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the item batch.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessItems":{
            "maxLength":20,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChangeOrderNumber":{
            "title":"Number",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the change order. The default value is the value from the spoke system of the item batch.",
            "nullable":true,
            "x-queryable":true
        },
        "StructureUpdateCode":{
            "title":"Update",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StructureUpdate":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChangeOrderAssociate":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SpokeSystemCode":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NewItemRequestOption":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChangeOrderAddAllItemsFlag":{
            "title":"Add all items",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultOrganizationId":{
            "title":"Default Organization",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NewItemRequestNumber":{
            "title":"Number",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the new item request. The default value is the value from the spoke system of the item batch.",
            "nullable":true,
            "x-queryable":true
        },
        "SpokeSystemName":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignedTo":{
            "maxLength":100,
            "type":"string",
            "description":"User who's assigned to the item batch.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":1,
            "type":"string",
            "description":"Type of the Item batch. Valid values are E and I. The default value is E.",
            "nullable":true,
            "default":"E",
            "x-queryable":true
        },
        "CreationDateTime":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the item batch.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeOrderAssociateCode":{
            "title":"Associate",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StructureEffectivityControlCode":{
            "title":"Effectivity Control",
            "type":"integer",
            "description":"Abbreviation that identifies the effectivity control of the item structure. Valid value is 1.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "controlType":"choice",
                "precision":9
            },
            "x-queryable":true
        },
        "PackUpdate":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChangeOrderOption":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleDateTime":{
            "type":"string",
            "description":"Date and time when the item batch is scheduled to run to import the item data.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessItemsCode":{
            "title":"Process Items",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NewItemRequestEffectiveDateType":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Item Batch Translations

Type: array

Title: Item Batch Translations

The Item Batch Translations resource manages records in item batch translations.

Show Source

• Array of: object itemBatches-itemBatchTranslations-item-response

{
    "title":"Item Batch Translations",
    "type":"array",
    "description":"The Item Batch Translations resource manages records in item batch translations.",
    "items":{
        "$ref":"#/components/schemas/itemBatches-itemBatchTranslations-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : itemBatches-itemBatchTranslations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the item batch.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Source language associated with the item batch.",
            "nullable":false,
            "x-queryable":true
        },
        "BatchName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the item batch.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the item batch.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the item batch.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the item batch.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language associated with the item batch.",
            "nullable":false,
            "x-queryable":true
        },
        "BatchId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item batch.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

BatchStatusesLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

ChangeOrderAssociatesLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

ChangeOrderEffectiveDateTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

ChangeOrderOptionsLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

DeleteProcessedRowsLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

ImportScheduleLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

NewItemRequestAssociatesLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

NewItemRequestEffectiveDateTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

NewItemRequestOptionsLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

PackUpdateLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

ProcessItemsLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

StructureEffectivityControlLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

StructureUpdateLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

itemBatchTranslations

Operation: /fscmRestApi/resources/11.13.18.05/itemBatches/{itemBatchesUniqID}/child/itemBatchTranslations

Parameters:

• itemBatchesUniqID: $request.path.itemBatchesUniqID

The Item Batch Translations resource manages records in item batch translations.

Back to Top

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"
	}
	]
}

Back to Top