Import Matrix Items

Import Matrix Items

Imports or updates records to the selected index

REST API

matrixItemApi/importMatrixItem

Parameters	Description	Parameter Options/value	Default
insertNew	Allow inserting new records. If false - only update is allowed	true / false	false
updExist	Allow updating exist records. If false	true / false	false
rows Required	Matrix items object array	See table below
lines	lines object array for each rows array	See table below
columns	columns object array for each rows array	See table below
moves	moves array for each lines/columns object	See table below

JSON Body Example

{
   ...
   
    "rows": [
     { 
      ...  
        "lines": 
            { ... 
              "moves": [
                {
                ...
              	  
                }
              ]
            },
        "columns": 
            { ... 
              "moves": [
                {
                ...
              	  
                }
              ]
            }
       }
     ] 
  }

Matrix items Data

The following parameters should be included in a rows array (see examples below)

FieldName-matrix item	Type	Description	תיאור	Default
itemKey Required	String (max 20)	מפתח פריט	Item key
matrixType	1-חד מימדית 2-דו מימדית	סוג מטריצה	Matrix type
barcode	1-רגיל 2-בר קוד	ברקוד	barcode
fItemKey	String (max 20)	קוד פריט	item key
lines	object	שורות	lines
columns	object	עמודות	columns

Lines object for each rows array

The following parameters should be included in a lines array (see examples below)

FieldName-matrix item	Type	Description	תיאור
lineHead	String (max 20)	כותרת שורות	Lines head
moves	array	שורות	lines

Columns object for each rows array

The following parameters should be included in a columns array (see examples below)

FieldName-matrix item	Type	Description	תיאור
colHead	String (max 20)	כותרת עמודות	columns head
moves	array	עמודות	columns

Moves array for each line/column object

The following parameters should be included in a moves array (see examples below)

tip

When updating an existing matrix item's row or column the ID is required, otherwise it is an addition.

FieldName-matrix item	Type	Description	תיאור
id Required when updating line/column	String	קוד שורה/ עמודה
code	String (max 20)	מפתח	code
itemName	String (max 50)	שם	Item name
forignName	String (max 50)	שם לועזי	Foreign name
name	String (max 15)	כותרת	head
disabled	bool	פעיל	disabled

JSON Examples

Example for itm index

{
    "insertNew":true,
    "updExist":true,
    "rows": [
        {
            "itemKey": "shirt",
            "matrixType": 2, 
            "barcode": 1, 
            "lines": {
                "lineHead": "color",
                "moves": [
                    {
                        "code": "black",
                        "itemName": "black",
                        "forignName": "black",
                        "name": "black",
                        "disabled": 0
                    },
                    {
                        "code": "blue",
                        "itemName": "blue",
                        "forignName": "blue",
                        "name": "blue",
                        "disabled": 0
                    }
                ]
            },
            "columns": {
                "colHead": "size",
                "moves": [
                    {
                        "code": "small",
                        "itemName": "small",
                        "forignName": "small",
                        "name": "S",
                        "disabled": 0
                    },
                    {
                        "code": "large",
                        "itemName": " large ",
                        "forignName": "large",
                        "name": "L",
                        "disabled": 0
                    }
                ]
            }
        }
    ]
}

Deleting Matrix Items

Deletes matrix item from tables

REST API

matrixItemApi/deleteMatrixItem

Parameters	Type	Description
itemKey Required	string	Item key in the items table

JSON Example

{
  "itemKey": "פריט-מטריצה1"
}

Showing matrix item

Show matrix item data

REST API

matrixItemApi/getMatrixItem

Parameters	Type	Description
itemKey Required	string	Item key in the items table

JSON Example

{
  "itemKey": "פריט-מטריצה1"
}

Matrix Item OutputData

Name	Options
statusCode	200 – OK / 500 - Errors
status
errors	OK / Errors: "error description" / No Permission

JSON Example

 {
    "statusCode": 200,
    "status": {
        "errors": "OK"
    }
}