Download OpenAPI specification:Download
Support for more advanced integrations for manufacturing records data
Note: this API should not be used unless explicitly directed to do so by a member of the JEDI team. Unauthorized use of this API may result in missing and unrecoverable data.
| productId required | number [ 1 .. 65535 ] Product ID used to allocate the MPBIDs |
| size required | number [ 1 .. 10000 ] Number of MPBIDs to allocate for the given Product ID |
| customerPO | string (Optional) Purchase order number or NPD project ID associated with this batch of tools. |
| prefix | string (Optional) Prefix which defines each catalog number. The prefix letters are alpha-numeric characters - required for service purposes and the SPL, and aids in identifying the tool model. The prefix is to be assigned by Engineering (Technical Literature). |
| splBreak | string (Optional) Alpha character (A-Z) for Serial breaks and indicates major changes. The character is to begin with "A". For each major change that occurs after the initial release, the alpha character is to index upward to the next letter (A to B; B to C; etc.). The character is assigned by Engineering. |
required | object (ToolRecordClient) Tool Record Client Information |
{- "productId": 1,
- "size": 1,
- "customerPO": "string",
- "prefix": "string",
- "splBreak": "string",
- "client": {
- "timestamp": 1609459200,
- "supplierId": "string",
- "facility": "string",
- "lineId": "string",
- "stationId": "string",
- "name": "string",
- "version": "string",
- "user": "string"
}
}{- "manufacturer": "string",
- "productId": 65535,
- "createdDateTime": 1609459200,
- "devices": [
- {
- "sequenceNumber": 0,
- "mpbid": "0000000000",
- "bod": "17A9BD1670C",
- "metcoPassword": "FFFFFFFFFFFFFFFF",
- "userPassword": "FFFFFFFFFFFFFFFF",
- "servicePassword": "FFFFFFFFFFFFFFFF",
- "adminPassword": "FFFFFFFFFFFFFFFF"
}
], - "currentSerialID": 0
}Note: this API should not be used unless explicitly directed to do so by a member of the JEDI team.
| count required | number [ 1 .. 10000 ] Number of serial numbers to allocate |
| prefix required | string Prefix which defines each catalog number. The prefix letters are alpha-numeric characters - required for service purposes and the SPL, and aids in identifying the tool model. The prefix is to be assigned by Engineering (Technical Literature). |
| splBreak required | string Alpha character (A-Z) for Serial breaks and indicates major changes. The character is to begin with "A". For each major change that occurs after the initial release, the alpha character is to index upward to the next letter (A to B; B to C; etc.). The character is assigned by Engineering. |
| facility required | string Alphanumeric single character that represents the facility where the tool is being manufactured. |
{- "count": 1,
- "prefix": "string",
- "splBreak": "string",
- "facility": "string"
}Currently supports querying for a tool record using a single query parameter (which may contain multiple, comman separated values), one of [toolId, mpbid, serialNumber]
| toolId | string Example: toolId=https://mke.tl/0000001FF,https://mke.tl/0000004HE (Optional) single toolId or comma-separated list of toolIds. |
| mpbid | string Example: mpbid=FFFF000766 (Optional) single mpbid or comma-separated list of mpbids. |
| serialNumber | string Example: serialNumber=M64AM220300048 (Optional) single serialNumber or comma-separated list of serialNumbers. |
{- "records": [
- {
- "mfgProductionDate": 1642136328000,
- "uniqueDeviceId": "3C006A000250315338363020",
- "description": "Gen 4 M18 FUEL Drill",
- "source": "Unknown",
- "platform": "M18",
- "mpbid": "01150002D3",
- "bleModule": "UNKNOWN",
- "createdAt": 1616164700000,
- "mfgLastUpdateDate": 1641795977000,
- "model": "2903-20",
- "firmwareVersion": "10010605",
- "updatedAt": 1642136330000,
- "p_id_hex": "0115",
- "default_p_id": "0115",
- "partNumber": "35866D65",
- "p_id": 277,
- "serialNumber": "M64AM220300021",
- "bornOnDate": 1641795989000,
- "imei": "350457795727930",
- "iccId": "891004234814455936F"
}
]
}| Manufacturer required | string A unique name given to each manufacturer |
required | object |
{- "Manufacturer": "string",
- "Item": {
- "MPBID": "0000000000",
- "SN": "A0000000 000000 0000000",
- "BOD": "17A9BD1670C",
- "METCOPassword": "FFFFFFFFFFFFFFFF",
- "UserPassword": "FFFFFFFFFFFFFFFF",
- "ServicePassword": "FFFFFFFFFFFFFFFF",
- "AdminPassword": "FFFFFFFFFFFFFFFF",
- "EncryptionKeyLo": "FFFFFFFFFFFFFFFF",
- "EncryptionKeyHi": "FFFFFFFFFFFFFFFF",
- "MACAddress": "FFFFFFFFFFFF",
- "FirmwareVersion": "FFFFFFFF",
- "FirmwarePartNumber": "FFFFFFFF",
- "uniqueDeviceId": "A1B2C3D40110022003300440",
- "ProductionDate": "2021-07-12T18:01:25.132Z",
- "LastUpdateDate": "2021-07-12T18:01:25.132Z"
}
}required | Array of objects (ToolRecord) [ 1 .. 10000 ] items | ||||||||||||||||||||||||||
Array ([ 1 .. 10000 ] items)
| |||||||||||||||||||||||||||
{- "records": [
- {
- "id": {
- "mpbid": "FFFF000000",
- "serialNumber": "GA12340000000",
- "vendorId": "ABCD 1234"
}, - "firmware": {
- "partNumber": "35866D65",
- "version": "0E010602"
}, - "uniqueDeviceId": "1234567890ABCDEFGHIJ",
- "bornOnDate": "AC01DF",
- "link": {
- "pcbaTool": "123456ABCDEF",
- "mpbid": "0001000000"
}, - "ble": {
- "macAddress": "00:00:5e:00:53:af",
- "version": "0.1.2.3",
- "moduleType": "BGM220"
}, - "productionDate": "0001-01-01T00:00:00",
- "lastUpdateDate": "0001-01-01T00:00:00",
- "password": {
- "admin": "0000000000000000",
- "user": "11111111111111111",
- "metco": "22222222222222222",
- "service": "4444444444444444"
}, - "cellular": {
- "imei": "350457795727930",
- "iccId": "891004234814455936F"
}, - "region": "UL",
- "ttiPartNumber": "0123456789",
- "client": {
- "timestamp": 1638171069,
- "name": "Quicklink-Mfg",
- "version": "1.2.3",
- "facility": "",
- "lineId": "1",
- "stationId": "A",
- "user": "ABCD"
}
}
]
}