Skip to main content

​
GET meta data

Don’ forget to change to you domain, username and password
HTTP Example
HTTP /{api_url}/api/tables/item
Authorization: ApiKey pricing@example.com:MYPASSWORD123
Content-Type: application/json
cURL Example
curl 'https://yourdomain.priceedge.eu/papi/api/tables/item' \
--header 'Authorization: ApiKey pricing@example.com:MYPASSWORD123' \
--header 'Content-Type: application/json'
ApiKey is case sensitive and note the : between username and password

​
Expected Response

The return body will contain a lot of information but for now we are happy that you can connect. Let’s move on to next step. The returned data. 
{
    "Data": [
        {
            "column_id": 12,
            "name": "_dtLastModifiedDate",
            "typeName": "datetime2",
            "max_length": 8,
            "precision": 27,
            "scale": 7,
            "is_nullable": true,
            "default_value": "(sysdatetime())",
            "is_unique": null,
            "is_primary_key": false,
            "enableInABC": null,
            "typeName_display": "datetime2",
            "precision_display": null,
            "table_name": "Item",
            "DATA_TYPE": "Text",
            "FORMATTING": "",
            "ALIGN": "Left",
            "ViewSecurityRightID": null,
            "EditSecurityRightID": null,
            "EditTableSecurityRightID": "dataadmin-item_edit",
            "canEdit": true,
            "IsKey": false,
            "Condition": "and Number = '@Data.Number~'",
            "isPriceColumn": null
        },
        {
            "column_id": 6,
            "name": "cd_PriceGroup",
            "typeName": "varchar",
            "max_length": 20,
            "precision": 0,
            "scale": 0,
            "is_nullable": true,
            "default_value": null,
            "is_unique": null,
            "is_primary_key": false,
            "enableInABC": null,
            "typeName_display": "fk(PriceGroup.Code)",
            "precision_display": "20",
            "table_name": "Item",
            "DATA_TYPE": "Text",
            "FORMATTING": "",
            "ALIGN": "Left",
            "ViewSecurityRightID": null,
            "EditSecurityRightID": null,
            "EditTableSecurityRightID": "dataadmin-item_edit",
            "canEdit": true,
            "IsKey": false,
            "Condition": "and Number = '@Data.Number~'",
            "isPriceColumn": null
        },
        {
            "column_id": 4,
            "name": "CostForPricing",
            "typeName": "decimal",
            "max_length": 9,
            "precision": 18,
            "scale": 4,
            "is_nullable": true,
            "default_value": null,
            "is_unique": null,
            "is_primary_key": false,
            "enableInABC": null,
            "typeName_display": "decimal(18,4)",
            "precision_display": "18,4",
            "table_name": "Item",
            "DATA_TYPE": "Number",
            "FORMATTING": "###,###,##0.00",
            "ALIGN": "Right",
            "ViewSecurityRightID": "dataadmin-item_CostForPricing_view",
            "EditSecurityRightID": "dataadmin-item_CostForPricing_edit",
            "EditTableSecurityRightID": "dataadmin-item_edit",
            "canEdit": true,
            "IsKey": false,
            "Condition": "and Number = '@Data.Number~'",
            "isPriceColumn": null
        },
        {
            "column_id": 5,
            "name": "Description",
            "typeName": "nvarchar",
            "max_length": 0,
            "precision": 0,
            "scale": 0,
            "is_nullable": true,
            "default_value": null,
            "is_unique": null,
            "is_primary_key": false,
            "enableInABC": null,
            "typeName_display": "nvarchar(0)",
            "precision_display": "0",
            "table_name": "Item",
            "DATA_TYPE": "Text",
            "FORMATTING": "",
            "ALIGN": "Left",
            "ViewSecurityRightID": null,
            "EditSecurityRightID": null,
            "EditTableSecurityRightID": "dataadmin-item_edit",
            "canEdit": true,
            "IsKey": false,
            "Condition": "and Number = '@Data.Number~'",
            "isPriceColumn": null
        },
        {
            "column_id": 10,
            "name": "ImageUrl",
            "typeName": "nvarchar",
            "max_length": 1000,
            "precision": 0,
            "scale": 0,
            "is_nullable": true,
            "default_value": null,
            "is_unique": null,
            "is_primary_key": false,
            "enableInABC": null,
            "typeName_display": "nvarchar(1000)",
            "precision_display": "1000",
            "table_name": "Item",
            "DATA_TYPE": "Text",
            "FORMATTING": "",
            "ALIGN": "Left",
            "ViewSecurityRightID": null,
            "EditSecurityRightID": null,
            "EditTableSecurityRightID": "dataadmin-item_edit",
            "canEdit": true,
            "IsKey": false,
            "Condition": "and Number = '@Data.Number~'",
            "isPriceColumn": null
        },
        {
            "column_id": 8,
            "name": "InsertDate",
            "typeName": "datetime",
            "max_length": 8,
            "precision": 23,
            "scale": 3,
            "is_nullable": false,
            "default_value": "(getdate())",
            "is_unique": null,
            "is_primary_key": false,
            "enableInABC": null,
            "typeName_display": "datetime",
            "precision_display": null,
            "table_name": "Item",
            "DATA_TYPE": "Date",
            "FORMATTING": "Short Date",
            "ALIGN": "Right",
            "ViewSecurityRightID": null,
            "EditSecurityRightID": null,
            "EditTableSecurityRightID": "dataadmin-item_edit",
            "canEdit": true,
            "IsKey": false,
            "Condition": "and Number = '@Data.Number~'",
            "isPriceColumn": null
        },
        {
            "column_id": 2,
            "name": "Name",
            "typeName": "nvarchar",
            "max_length": 1000,
            "precision": 0,
            "scale": 0,
            "is_nullable": true,
            "default_value": null,
            "is_unique": null,
            "is_primary_key": false,
            "enableInABC": null,
            "typeName_display": "nvarchar(1000)",
            "precision_display": "1000",
            "table_name": "Item",
            "DATA_TYPE": "Text",
            "FORMATTING": "",
            "ALIGN": "Left",
            "ViewSecurityRightID": null,
            "EditSecurityRightID": null,
            "EditTableSecurityRightID": "dataadmin-item_edit",
            "canEdit": true,
            "IsKey": false,
            "Condition": "and Number = '@Data.Number~'",
            "isPriceColumn": null
        },
        {
            "column_id": 9,
            "name": "NeedsPrice",
            "typeName": "bit",
            "max_length": 1,
            "precision": 1,
            "scale": 0,
            "is_nullable": false,
            "default_value": "(isnull([dbo].[usfGetSystemSetting]('DefaultNeedsPrice'),(0)))",
            "is_unique": null,
            "is_primary_key": false,
            "enableInABC": null,
            "typeName_display": "bit",
            "precision_display": null,
            "table_name": "Item",
            "DATA_TYPE": "Number",
            "FORMATTING": "True/False",
            "ALIGN": "Right",
            "ViewSecurityRightID": null,
            "EditSecurityRightID": null,
            "EditTableSecurityRightID": "dataadmin-item_edit",
            "canEdit": true,
            "IsKey": false,
            "Condition": "and Number = '@Data.Number~'",
            "isPriceColumn": null
        },
        {
            "column_id": 1,
            "name": "Number",
            "typeName": "nvarchar",
            "max_length": 128,
            "precision": 0,
            "scale": 0,
            "is_nullable": false,
            "default_value": null,
            "is_unique": true,
            "is_primary_key": true,
            "enableInABC": null,
            "typeName_display": "nvarchar(128)",
            "precision_display": "128",
            "table_name": "Item",
            "DATA_TYPE": "Text",
            "FORMATTING": "",
            "ALIGN": "Left",
            "ViewSecurityRightID": null,
            "EditSecurityRightID": null,
            "EditTableSecurityRightID": "dataadmin-item_edit",
            "canEdit": false,
            "IsKey": true,
            "Condition": "and Number = '@Data.Number~'",
            "isPriceColumn": null
        },
        {
            "column_id": 3,
            "name": "SearchName",
            "typeName": "nvarchar",
            "max_length": 1024,
            "precision": 0,
            "scale": 0,
            "is_nullable": true,
            "default_value": null,
            "is_unique": null,
            "is_primary_key": false,
            "enableInABC": null,
            "typeName_display": "nvarchar(1024)",
            "precision_display": "1024",
            "table_name": "Item",
            "DATA_TYPE": "Text",
            "FORMATTING": "",
            "ALIGN": "Left",
            "ViewSecurityRightID": null,
            "EditSecurityRightID": null,
            "EditTableSecurityRightID": "dataadmin-item_edit",
            "canEdit": true,
            "IsKey": false,
            "Condition": "and Number = '@Data.Number~'",
            "isPriceColumn": null
        },
        {
            "column_id": 11,
            "name": "Url",
            "typeName": "nvarchar",
            "max_length": 1000,
            "precision": 0,
            "scale": 0,
            "is_nullable": true,
            "default_value": null,
            "is_unique": null,
            "is_primary_key": false,
            "enableInABC": null,
            "typeName_display": "nvarchar(1000)",
            "precision_display": "1000",
            "table_name": "Item",
            "DATA_TYPE": "Text",
            "FORMATTING": "",
            "ALIGN": "Left",
            "ViewSecurityRightID": null,
            "EditSecurityRightID": null,
            "EditTableSecurityRightID": "dataadmin-item_edit",
            "canEdit": true,
            "IsKey": false,
            "Condition": "and Number = '@Data.Number~'",
            "isPriceColumn": null
        }
    ],
    "Errors": [],
    "Succeeded": true
}
⌘I