get
https://app.fracttal.com/api/items/
Through this API you can query asset information. You can query a specific asset or filter by dates, asset types, among others.
Through this API you can query asset information. You can query a specific asset or filter by dates, asset types, among others.
The "code" parameter in the URL is used to get the details of an asset. It can be obtained from this same endpoint (code field).
Input Parameters
You can filter information using the following query_params:
| Parameter | Type | Required | Description |
|---|---|---|---|
code | Text | Optional | Code of the asset to be obtained. Can be obtained from this same endpoint (code field). |
id | Integer | Optional | Asset ID in Fracttal. Can be obtained from this same endpoint (id field). |
item_type | Text | Optional | Filter by asset type. Available options are: 1: Locations, 2: Equipment, 3: Tools, 4: Spare Parts and Supplies, 5: Digital |
location_code | Text | Optional | Code of the parent location-type asset from which you want to query its children. Can be obtained from this same endpoint (location_code field). |
active | Boolean | Optional | Indicates whether the asset is active or not |
available | Boolean | Optional | Indicates whether the asset is in service or not |
field_1 | Text | Optional | Depends on asset type (see output parameters by asset type) |
field_2 | Text | Optional | Depends on asset type (see output parameters by asset type) |
field_3 | Text | Optional | Depends on asset type (see output parameters by asset type) |
field_4 | Text | Optional | Depends on asset type (see output parameters by asset type) |
field_5 | Text | Optional | Depends on asset type (see output parameters by asset type) |
field_6 | Text | Optional | Depends on asset type (see output parameters by asset type) |
start | Integer | Optional | Record number from which the query will start. Default is 0. All queries are limited to 100 records, when there are more than that amount, this parameter should be used for pagination. |
limit | Integer | Optional | Number of records that the request will show. Default value is 100. |
is_tree | Boolean | Optional | When set to true, it returns all descendants in the full hierarchy. When set to false or omitted, it returns only direct children (default). |
Output Parameters
Output parameters by asset type:
| Parameter | Type | Locations (id_type_item = 1) | Equipment (id_type_item = 2) | Tools (id_type_item = 3) | Spare Parts and Supplies (id_type_item = 4) | Digital (id_type_item = 5) |
|---|---|---|---|---|---|---|
field_1 | Text | Name | Name | Name | Name | Name |
field_2 | Text | Address | Manufacturer | Part number | Part number | Manufacturer |
field_3 | Text | City | Model | Manufacturer | Manufacturer | Serial number |
field_4 | Text | Area code | Serial number | Model | Model | Version |
field_5 | Text | Department / State / Region | Other 1 | Other 1 | Other 1 | |
field_6 | Text | Country | Other 2 | Other 2 | Other 2 |
| Parameter | Type | Description |
|---|---|---|
id | Integer | Asset ID in Fracttal |
active | Boolean | Indicates whether the asset is active or not |
code | Text | Asset code |
description | Text | Asset description |
id_type_item | Integer | Asset type. Can be: 1 - Location, 2 - Equipment, 3 - Tools, 4 - Spare Parts and Supplies, 5 - Digital |
notes | Text | Notes |
weight | Text | Weight |
is_serial_control | Boolean | Indicates if it's a serial-controlled asset |
items_types_description | Text | Asset type name |
groups_description | Text | Type |
groups_1_description | Text | Classification 1 |
groups_2_description | Text | Classification 2 |
custom_fields_groups_description | Text | Name of the custom fields group associated with the asset |
units_description | Text | Unit description |
priorities_description | Text | Priority |
parent_description | Text | Located in or part of |
purchase_date | Text | Purchase date |
total_cost | Text | Total cost |
anual_depreciation | Text | Annual depreciation percentage |
startup_date | Text | Start date for depreciation |
total_replacement_cost | Text | Total linear depreciation cost |
salvage_value | Text | Replacement value (depreciation) |
costs_center_description | Text | Cost center description |
budgets_description | Text | Budget |
cost_average | Text | Average cost |
latitude | Text | Latitude |
longitud | Text | Longitude |
groups_tasks_description | Text | Task plan it belongs to |
units_code | Text | Unit code |
visible_to_all | Boolean | True if the asset can be viewed by all people in the company |
id_parent | Integer | Location ID |
hours_average_daily_use | Integer | Average daily use hours (Time in seconds, default is 86400 = 24 hours) |
available | Boolean | True when the asset is available, false otherwise |
initial_date_out_of_service | UTC-0 Date | Initial out-of-service date (Applies when the asset is not available) |
last_final_date_available | UTC-0 Date | Final date of the last out of service |
item_url | Text | Asset URL within Fracttal. Used to generate the QR code |
id_company | Text | Company ID |
barcode | Text | QR code |
min_stock_warning | Integer | Minimum expected quantity of the asset |
location_code | Text | Code of the parent location-type asset |
Example
Request: (GET) https://app.fracttal.com/api/items/654545445354
{
"success": true,
"message": "200",
"data": [
{
"id": 28859188,
"active": true,
"code": "PPC.T.CA8.006",
"description": " Cadena de sujeción de 3/8\\ G8 de 8m { PPC.T.CA8.006 }",
"id_type_item": 4,
"barcode": null,
"field_1": "Cadena de sujeción de 3/8\\ G8 de 8m",
"field_2": null,
"field_3": null,
"field_4": null,
"field_5": null,
"field_6": null,
"notes": null,
"min_stock_warning": false,
"weight": null,
"is_serial_control": false,
"lead_time": null,
"items_types_description": "SPARE_PARTS_AND_SUPPLIES",
"groups_description": null,
"groups_1_description": null,
"groups_2_description": null,
"custom_fields_groups_description": null,
"units_description": "UND",
"priorities_description": null,
"parent_description": "// ",
"purchase_date": null,
"total_cost": null,
"anual_depreciation": null,
"startup_date": null,
"total_replacement_cost": null,
"salvage_value": null,
"costs_center_description": "",
"budgets_description": "",
"cost_average": null,
"latitude": null,
"longitud": null,
"id_group_task": null,
"groups_tasks_description": null,
"units_code": "UND",
"custom_fields_values": null,
"third_parties_name": null,
"id_parent": null,
"visible_to_all": false,
"hours_average_daily_use": null,
"available": true,
"initial_date_out_of_service": null,
"last_final_date_available": null,
"item_url": "https://apps.fracttal.com/#inventories/28859188",
"id_company": 1190,
"location_code": "LOC01"
}
],
"total": 1
}Test It
Test It