seventhings API (1.2.0)

Download OpenAPI specification:Download

E-mail: developer@seventhings.com URL: https://www.seventhings.com/ License: proprietary

API for seventhings, the fixed asset manager for successful companies.

With the seventhings asset tracking manager you digitize your internal process in no time and boost creativity and structure.

default

Basic ping route of the API.

Ping the API

Default Message that API exists here, no login required.

Responses

Response samples

200

Content type

application/json

{"status": "OK",
"description": "Itexia Scanner API"
}

auth

Login and authentification of the API.

/auth

Request Body schema: application/x-www-form-urlencoded

Any of

username required	string Your login username for the web app.
password required	string Your secret password.
client_id required	string You can get the client_id on request.
grant_type	string The `password` grant type

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

username=your%20username&password=S3cR3tP4%C3%9FW0rD&client_id=hash456789012345678901234567890123456789&grant_type=password

Response samples

200

Content type

application/json

{"access_token": "e68f38c2dca2add6c5528e16d7a2b453371e5870",
"expires_in": 3600,
"token_type": "Bearer",
"scope": null,
"refresh_token": "2b57a8d37baf1ef3a436968da51149b2eddf7f0f",
"itexia_clients": {"1": "ITEXIA GmbH"
},
"user_id": 1
}

asset-field-definition

Get all asset field definitions.

Get asset field definitions

Get all asset field definition objects.

Authorizations:

bearerAuth

query Parameters

page	integer <int32> >= 1 Default: 1 Example: page=1 Page number
pagesize	integer <int32> [ 0 .. 1000 ] Default: 0 Example: pagesize=100 Number of items per page (0 == all items)
	object or null Example: filter[id]=1&filter[updated_at]=2022-11-15+00:00:00 other examples: `filter[id][in]=1&filter[id][in]=2&filter[id][in]=3` `filter[updated_at][gt]=2022-11-15+00:00:00` `filter[updated_at][lt]=2022-11-15+00:00:00&filter[updated_at][gt]=2022-11-14+00:00:00`

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"field_key": "id",
"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"system_field": 0,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"part_of_name": 0,
"is_actual": 1,
"actual_target_field_id": 5,
"is_target": 0,
"editable": 1,
"value": "example",
"updated_at": "2018-08-17 12:15:57",
"included_in_search_bar": 1
}
]

Add a new asset field definition to the instance.

Authorizations:

bearerAuth

Request Body schema: application/json

Asset field definition object that needs to be added.

label	string The label of this dataset.
type	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 22 23 25 The type of this dataset. 0: status 1: varchar 2: text 3: selection 4: costunit 5: location 6: expression_text 7: autoincrement 8: integer 9: boolean 10: date 11: datetime 12: room 13: file 14: connection 15: float 16: currency 17: expression_integer 18: barcode 19: password 20: link 22: boolean_toggle 23: scancode_alternate 25: user
sort_index	integer The position of the dataset in a list.
readonly_on_scanner	boolean The flag to decide if the property is editable on the scanner.
visible_by_scanner	boolean The flag to decide if the property is visible on the scanner.
default_value	string or null The default value of the property.
mandatory	boolean The flag to decide if the property is mandatory to save the dataset.
in_form	boolean The flag to decide if the property is visible in the detail view of the dataset.
form_group	string or null The form group of the property.
editable	boolean The flag to decide if the property is editable.
value	string or null Additional property of the field according to the type, e.g. currency symbol for type "currency", select options for type "selection".
included_in_search_bar	boolean Should the field be included in asset free text search

Responses

Request samples

Payload

Content type

application/json

{"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"editable": 1,
"value": "example",
"included_in_search_bar": 1
}

Response samples

201
422

Content type

application/json

{"id": 0,
"field_key": "id",
"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"system_field": 0,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"part_of_name": 0,
"is_actual": 1,
"actual_target_field_id": 5,
"is_target": 0,
"editable": 1,
"value": "example",
"updated_at": "2018-08-17 12:15:57",
"included_in_search_bar": 1
}

Updates an existing asset field definition

Updates an existing asset field definition by given identifier.

Authorizations:

bearerAuth

query Parameters

id

required

integer

Asset field definition id to update

Request Body schema: application/json

Asset field definition object that should be updated.

label	string The label of this dataset.
type	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 22 23 25 The type of this dataset. 0: status 1: varchar 2: text 3: selection 4: costunit 5: location 6: expression_text 7: autoincrement 8: integer 9: boolean 10: date 11: datetime 12: room 13: file 14: connection 15: float 16: currency 17: expression_integer 18: barcode 19: password 20: link 22: boolean_toggle 23: scancode_alternate 25: user
sort_index	integer The position of the dataset in a list.
readonly_on_scanner	boolean The flag to decide if the property is editable on the scanner.
visible_by_scanner	boolean The flag to decide if the property is visible on the scanner.
default_value	string or null The default value of the property.
mandatory	boolean The flag to decide if the property is mandatory to save the dataset.
in_form	boolean The flag to decide if the property is visible in the detail view of the dataset.
form_group	string or null The form group of the property.
editable	boolean The flag to decide if the property is editable.
value	string or null Additional property of the field according to the type, e.g. currency symbol for type "currency", select options for type "selection".
included_in_search_bar	boolean Should the field be included in asset free text search

Responses

Request samples

Payload

Content type

application/json

{"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"editable": 1,
"value": "example",
"included_in_search_bar": 1
}

Response samples

200
422

Content type

application/json

{"id": 0,
"field_key": "id",
"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"system_field": 0,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"part_of_name": 0,
"is_actual": 1,
"actual_target_field_id": 5,
"is_target": 0,
"editable": 1,
"value": "example",
"updated_at": "2018-08-17 12:15:57",
"included_in_search_bar": 1
}

Count the asset field definitions

Get the total count of all asset field definitions.

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"total": 537
}

Get single asset field definition

Get a single asset field definition object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

The asset field definition identifier.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"field_key": "id",
"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"system_field": 0,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"part_of_name": 0,
"is_actual": 1,
"actual_target_field_id": 5,
"is_target": 0,
"editable": 1,
"value": "example",
"updated_at": "2018-08-17 12:15:57",
"included_in_search_bar": 1
}

room-field-definition

Get all room field definitions.

Get room field definitions

Get all room field definition objects.

Authorizations:

bearerAuth

query Parameters

page	integer <int32> >= 1 Default: 1 Example: page=1 Page number
pagesize	integer <int32> [ 0 .. 1000 ] Default: 0 Example: pagesize=100 Number of items per page (0 == all items)
	object or null Example: filter[id]=1&filter[updated_at]=2022-11-15+00:00:00 other examples: `filter[id][in]=1&filter[id][in]=2&filter[id][in]=3` `filter[room_uuid]=1f55367e-59d9-42e4-a975-c3eb137ae457` `filter[updated_at][gt]=2022-11-15+00:00:00` `filter[updated_at][lt]=2022-11-15+00:00:00&filter[updated_at][gt]=2022-11-14+00:00:00`

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"field_key": "id",
"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"system_field": 0,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"part_of_name": 0,
"is_actual": 1,
"actual_target_field_id": 5,
"is_target": 0,
"editable": 1,
"value": "example",
"updated_at": "2018-08-17 12:15:57",
"included_in_search_bar": 1
}
]

Add a new room field definition to the instance.

Authorizations:

bearerAuth

Request Body schema: application/json

Room field definition object that needs to be added.

label	string The label of this dataset.
type	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 22 23 25 The type of this dataset. 0: status 1: varchar 2: text 3: selection 4: costunit 5: location 6: expression_text 7: autoincrement 8: integer 9: boolean 10: date 11: datetime 12: room 13: file 14: connection 15: float 16: currency 17: expression_integer 18: barcode 19: password 20: link 22: boolean_toggle 23: scancode_alternate 25: user
sort_index	integer The position of the dataset in a list.
readonly_on_scanner	boolean The flag to decide if the property is editable on the scanner.
visible_by_scanner	boolean The flag to decide if the property is visible on the scanner.
default_value	string or null The default value of the property.
mandatory	boolean The flag to decide if the property is mandatory to save the dataset.
in_form	boolean The flag to decide if the property is visible in the detail view of the dataset.
form_group	string or null The form group of the property.
editable	boolean The flag to decide if the property is editable.
value	string or null Additional property of the field according to the type, e.g. currency symbol for type "currency", select options for type "selection".
included_in_search_bar	boolean Should the field be included in asset free text search

Responses

Request samples

Payload

Content type

application/json

{"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"editable": 1,
"value": "example",
"included_in_search_bar": 1
}

Response samples

201
422

Content type

application/json

{"id": 0,
"field_key": "id",
"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"system_field": 0,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"part_of_name": 0,
"is_actual": 1,
"actual_target_field_id": 5,
"is_target": 0,
"editable": 1,
"value": "example",
"updated_at": "2018-08-17 12:15:57",
"included_in_search_bar": 1
}

Updates an existing room field definition

Updates an existing room field definition by given identifier.

Authorizations:

bearerAuth

query Parameters

id

required

integer

Room field definition id to update

Request Body schema: application/json

Room field definition object that should be updated.

label	string The label of this dataset.
type	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 22 23 25 The type of this dataset. 0: status 1: varchar 2: text 3: selection 4: costunit 5: location 6: expression_text 7: autoincrement 8: integer 9: boolean 10: date 11: datetime 12: room 13: file 14: connection 15: float 16: currency 17: expression_integer 18: barcode 19: password 20: link 22: boolean_toggle 23: scancode_alternate 25: user
sort_index	integer The position of the dataset in a list.
readonly_on_scanner	boolean The flag to decide if the property is editable on the scanner.
visible_by_scanner	boolean The flag to decide if the property is visible on the scanner.
default_value	string or null The default value of the property.
mandatory	boolean The flag to decide if the property is mandatory to save the dataset.
in_form	boolean The flag to decide if the property is visible in the detail view of the dataset.
form_group	string or null The form group of the property.
editable	boolean The flag to decide if the property is editable.
value	string or null Additional property of the field according to the type, e.g. currency symbol for type "currency", select options for type "selection".
included_in_search_bar	boolean Should the field be included in asset free text search

Responses

Request samples

Payload

Content type

application/json

{"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"editable": 1,
"value": "example",
"included_in_search_bar": 1
}

Response samples

200
422

Content type

application/json

{"id": 0,
"field_key": "id",
"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"system_field": 0,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"part_of_name": 0,
"is_actual": 1,
"actual_target_field_id": 5,
"is_target": 0,
"editable": 1,
"value": "example",
"updated_at": "2018-08-17 12:15:57",
"included_in_search_bar": 1
}

Count the room field definitions

Get the total count of all room field definitions.

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"total": 537
}

Get single room field definition

Get a single room field definition object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

The room field definition identifier.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"field_key": "id",
"label": "Identifier",
"type": 1,
"sort_index": 0,
"readonly_on_scanner": 1,
"visible_by_scanner": 1,
"system_field": 0,
"default_value": "example data",
"mandatory": 0,
"in_form": 0,
"form_group": "ITEXIA",
"part_of_name": 0,
"is_actual": 1,
"actual_target_field_id": 5,
"is_target": 0,
"editable": 1,
"value": "example",
"updated_at": "2018-08-17 12:15:57",
"included_in_search_bar": 1
}

assets

The collection of assets present in the instance.

Get all assets

Get all undeleted and soft deleted asset objects.

Authorizations:

bearerAuth

query Parameters

page	integer <int32> >= 1 Default: 1 Example: page=1 Page number
pagesize	integer <int32> [ 0 .. 1000 ] Default: 0 Example: pagesize=100 Number of items per page (0 == all items)
	object or null Example: filter[id]=1&filter[updated_at]=2022-11-15+00:00:00 other examples: `filter[id][in]=1&filter[id][in]=2&filter[id][in]=3` `filter[inventory_name]=Standing+desk` `filter[inventory_name][like]=desk` `filter[deleted]=1` `filter[actual_room]=5` `filter[target_room]=7` `filter[alternate_barcode]=test` `filter[asset_uuid]=1f55367e-59d9-42e4-a975-c3eb137ae457` `filter[updated_at][gt]=2022-11-15+00:00:00` `filter[updated_at][gt]=2022-11-15+00:00:00&filter[status]=33&filter[barcode]=000001` `filter[updated_at][gt]=2022-11-15+00:00:00&filter[status]=33&filter[barcode]=000001&filter[inventory_name]=desk` `filter[updated_at][lt]=2022-11-15+00:00:00&filter[updated_at][gt]=2022-11-14+00:00:00`

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"asset_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"status": 33,
"barcode": "102020",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"inventory_group": "inventory",
"purchasing_date": "2018-08-17 11:15:57",
"inventory_name": "Meeting chair",
"purchasing_price": 287.5,
"description": "All fields can be adjusted individually.",
"manufacturer": "Vitra",
"link": "https://info.seventhings.com/de/itexia-der-digitale-inventarmanager-für-ihr-unternehmen-0-1",
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"documents": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"target_building": 1,
"target_room": 3,
"actual_building": 1,
"actual_room": 3,
"scan_time": "2018-08-17 12:15:57",
"inventory_time": "2018-08-17 12:15:57",
"locked_by": 1,
"scanned_by_user_id": 1,
"deleted": 0,
"external": 123,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1,
"original_barcode": "0000000102020"
}
]

Add a new asset to the instance.

Authorizations:

bearerAuth

Request Body schema: application/json

Asset object that needs to be added. Unsetable fields will be ignored, like the id field.

id	integer The identifier of the asset.
status	any Enum: 1 11 20 31 33 The status of this dataset. 1: unknown asset 11: missing asset 20: difference between target and actual data 31: new asset 33: OK
barcode	string The unique identifier of the asset used by the scanners.
created_at	string The creation date of this asset in timezone UTC.
updated_at	string The update date of this asset in timezone UTC without the locking of the asset.
updated_by_user_id	integer or null The identifier of the associated user who updated the asset last.
inventory_group	string or null A user generated enum field with the possible inventory groups.
purchasing_date	string or null The title of the asset.
inventory_name	string The title of the asset.
purchasing_price	number or null The purchasing price of the asset.
description	string A description associated with the asset.
manufacturer	string The name of the manufacturer of the asset.
link	string or null A valid link associated with the asset.
	Array of objects or null (MediaItem)
	Array of objects or null (MediaItem)
target_building	integer The identifier of the associated building where the asset should be located at.
target_room	integer The identifier of the associated room where the asset should be located at.
actual_building	integer or null The identifier of the associated building where the asset actually is located.
actual_room	integer or null The identifier of the associated room where the asset actually is located.
scan_time	string or null Saved while the asset is scanned and will be cleared while inventory reset process.
inventory_time	string or null Saved by manual changes of the actual values and while scanning and within the inventory reset process.
locked_by	integer Default: 0 The identifier of the associated user who locked the asset last.
scanned_by_user_id	integer or null The identifier of the associated user who scanned the asset last.
deleted	integer or null (SoftDelete) Enum: 0 1 2 The soft delete flag of object. 0 or null is undeleted, 1 is soft deleted and 2 is deleted.
external	integer or null Actually not in use.
imported_by_user_id	integer or null Default: null The identifier of the associated user who imported the asset last.
imported_with_template_id	integer or null Default: null The identifier of the associated import template which affected this asset last.
imported_at	string or null Default: null The date of the last import change which affected this asset last.
created_on_import_with_template_id	integer or null Default: null The identifier of the associated import template which created this asset.
original_barcode	string The unique identifier originally read by the scanners.

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"status": 33,
"barcode": "102020",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"inventory_group": "inventory",
"purchasing_date": "2018-08-17 11:15:57",
"inventory_name": "Meeting chair",
"purchasing_price": 287.5,
"description": "All fields can be adjusted individually.",
"manufacturer": "Vitra",
"link": "https://info.seventhings.com/de/itexia-der-digitale-inventarmanager-für-ihr-unternehmen-0-1",
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"documents": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"target_building": 1,
"target_room": 3,
"actual_building": 1,
"actual_room": 3,
"scan_time": "2018-08-17 12:15:57",
"inventory_time": "2018-08-17 12:15:57",
"locked_by": 1,
"scanned_by_user_id": 1,
"deleted": 0,
"external": 123,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1,
"original_barcode": "0000000102020"
}

Response samples

201
422

Content type

application/json

{"id": 1,
"asset_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"status": 33,
"barcode": "102020",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"inventory_group": "inventory",
"purchasing_date": "2018-08-17 11:15:57",
"inventory_name": "Meeting chair",
"purchasing_price": 287.5,
"description": "All fields can be adjusted individually.",
"manufacturer": "Vitra",
"link": "https://info.seventhings.com/de/itexia-der-digitale-inventarmanager-für-ihr-unternehmen-0-1",
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"documents": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"target_building": 1,
"target_room": 3,
"actual_building": 1,
"actual_room": 3,
"scan_time": "2018-08-17 12:15:57",
"inventory_time": "2018-08-17 12:15:57",
"locked_by": 1,
"scanned_by_user_id": 1,
"deleted": 0,
"external": 123,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1,
"original_barcode": "0000000102020"
}

Updates an existing asset

Updates an existing asset by given identifier.

Authorizations:

bearerAuth

query Parameters

id

required

integer

Asset id to update

Request Body schema: application/json

Asset object that should be updated.

id	integer The identifier of the asset.
status	any Enum: 1 11 20 31 33 The status of this dataset. 1: unknown asset 11: missing asset 20: difference between target and actual data 31: new asset 33: OK
barcode	string The unique identifier of the asset used by the scanners.
created_at	string The creation date of this asset in timezone UTC.
updated_at	string The update date of this asset in timezone UTC without the locking of the asset.
updated_by_user_id	integer or null The identifier of the associated user who updated the asset last.
inventory_group	string or null A user generated enum field with the possible inventory groups.
purchasing_date	string or null The title of the asset.
inventory_name	string The title of the asset.
purchasing_price	number or null The purchasing price of the asset.
description	string A description associated with the asset.
manufacturer	string The name of the manufacturer of the asset.
link	string or null A valid link associated with the asset.
	Array of objects or null (MediaItem)
	Array of objects or null (MediaItem)
target_building	integer The identifier of the associated building where the asset should be located at.
target_room	integer The identifier of the associated room where the asset should be located at.
actual_building	integer or null The identifier of the associated building where the asset actually is located.
actual_room	integer or null The identifier of the associated room where the asset actually is located.
scan_time	string or null Saved while the asset is scanned and will be cleared while inventory reset process.
inventory_time	string or null Saved by manual changes of the actual values and while scanning and within the inventory reset process.
locked_by	integer Default: 0 The identifier of the associated user who locked the asset last.
scanned_by_user_id	integer or null The identifier of the associated user who scanned the asset last.
deleted	integer or null (SoftDelete) Enum: 0 1 2 The soft delete flag of object. 0 or null is undeleted, 1 is soft deleted and 2 is deleted.
external	integer or null Actually not in use.
imported_by_user_id	integer or null Default: null The identifier of the associated user who imported the asset last.
imported_with_template_id	integer or null Default: null The identifier of the associated import template which affected this asset last.
imported_at	string or null Default: null The date of the last import change which affected this asset last.
created_on_import_with_template_id	integer or null Default: null The identifier of the associated import template which created this asset.
original_barcode	string The unique identifier originally read by the scanners.

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"status": 33,
"barcode": "102020",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"inventory_group": "inventory",
"purchasing_date": "2018-08-17 11:15:57",
"inventory_name": "Meeting chair",
"purchasing_price": 287.5,
"description": "All fields can be adjusted individually.",
"manufacturer": "Vitra",
"link": "https://info.seventhings.com/de/itexia-der-digitale-inventarmanager-für-ihr-unternehmen-0-1",
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"documents": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"target_building": 1,
"target_room": 3,
"actual_building": 1,
"actual_room": 3,
"scan_time": "2018-08-17 12:15:57",
"inventory_time": "2018-08-17 12:15:57",
"locked_by": 1,
"scanned_by_user_id": 1,
"deleted": 0,
"external": 123,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1,
"original_barcode": "0000000102020"
}

Response samples

200
422

Content type

application/json

{"id": 1,
"asset_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"status": 33,
"barcode": "102020",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"inventory_group": "inventory",
"purchasing_date": "2018-08-17 11:15:57",
"inventory_name": "Meeting chair",
"purchasing_price": 287.5,
"description": "All fields can be adjusted individually.",
"manufacturer": "Vitra",
"link": "https://info.seventhings.com/de/itexia-der-digitale-inventarmanager-für-ihr-unternehmen-0-1",
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"documents": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"target_building": 1,
"target_room": 3,
"actual_building": 1,
"actual_room": 3,
"scan_time": "2018-08-17 12:15:57",
"inventory_time": "2018-08-17 12:15:57",
"locked_by": 1,
"scanned_by_user_id": 1,
"deleted": 0,
"external": 123,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1,
"original_barcode": "0000000102020"
}

Deletes a asset

Deletes a asset in steps. At first it will delete soft with a flag. Later it will delete hard.

Authorizations:

bearerAuth

query Parameters

id

required

integer

The asset identifier to identify the object which should be deleted.

Responses

Get file

Returns file content.

Authorizations:

bearerAuth

query Parameters

fileName required	string The file name.
fileType required	string The file mime type.

Responses

Add one new file to one asset

Authorizations:

bearerAuth

Request Body schema: multipart/form-data

File and where to upload.

model_id	integer The identifier of the associated object.
attribute	string The attribute where the file belongs to within the object.
File	string <binary> The file content.

Responses

Response samples

200
500

Content type

application/json

{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}

Remove one file from one asset

Authorizations:

bearerAuth

query Parameters

model_id required	integer Example: model_id=1 The identifier of the associated asset
attribute required	string Example: attribute=documents The field_key of the associated asset field definition which store the files.
file_name required	string Example: file_name=assets_5c3cbd9f91b4f6.99342518.jpg The unique filename of the image on the server.

Responses

Response samples

200
500

Content type

application/json

"File successfully deleted!"

Count all assets

Get count of all undeleted and soft deleted assets.

Authorizations:

bearerAuth

query Parameters

object or null

Example: filter[id]=1&filter[updated_at]=2022-11-15+00:00:00

other examples:

filter[id][in]=1&filter[id][in]=2&filter[id][in]=3
filter[inventory_name]=Standing+desk
filter[inventory_name][like]=desk
filter[deleted]=1
filter[actual_room]=5
filter[target_room]=7
filter[alternate_barcode]=test
filter[asset_uuid]=1f55367e-59d9-42e4-a975-c3eb137ae457
filter[updated_at][gt]=2022-11-15+00:00:00
filter[updated_at][gt]=2022-11-15+00:00:00&filter[status]=33&filter[barcode]=000001
filter[updated_at][gt]=2022-11-15+00:00:00&filter[status]=33&filter[barcode]=000001&filter[inventory_name]=desk
filter[updated_at][lt]=2022-11-15+00:00:00&filter[updated_at][gt]=2022-11-14+00:00:00

Responses

Response samples

200

Content type

application/json

{"total": 537
}

Get one asset by id

Also hard deleted objects can be found here.

Authorizations:

bearerAuth

path Parameters

id

required

integer

The asset identifier.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"asset_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"status": 33,
"barcode": "102020",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"inventory_group": "inventory",
"purchasing_date": "2018-08-17 11:15:57",
"inventory_name": "Meeting chair",
"purchasing_price": 287.5,
"description": "All fields can be adjusted individually.",
"manufacturer": "Vitra",
"link": "https://info.seventhings.com/de/itexia-der-digitale-inventarmanager-für-ihr-unternehmen-0-1",
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"documents": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"target_building": 1,
"target_room": 3,
"actual_building": 1,
"actual_room": 3,
"scan_time": "2018-08-17 12:15:57",
"inventory_time": "2018-08-17 12:15:57",
"locked_by": 1,
"scanned_by_user_id": 1,
"deleted": 0,
"external": 123,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1,
"original_barcode": "0000000102020"
}

buildings

The collection of buildings present in the instance.

Get all buildings

Get all undeleted building objects.

Authorizations:

bearerAuth

query Parameters

page	integer <int32> >= 1 Default: 1 Example: page=1 Page number
pagesize	integer <int32> [ 0 .. 1000 ] Default: 0 Example: pagesize=100 Number of items per page (0 == all items)
	object or null Example: filter[id]=1&filter[updated_at]=2022-11-15+00:00:00 other examples: `filter[id][in]=1&filter[id][in]=2&filter[id][in]=3` `filter[location_uuid]=1f55367e-59d9-42e4-a975-c3eb137ae457` `filter[updated_at][gt]=2022-11-15+00:00:00` `filter[updated_at][lt]=2022-11-15+00:00:00&filter[updated_at][gt]=2022-11-14+00:00:00`

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"location_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"name": "example building",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"deleted": 0
}
]

Add a new building to the instance.

Authorizations:

bearerAuth

Request Body schema: application/json

Building object that needs to be added. Unsetable fields will be ignored, like the id field.

id	integer The identifier of the building.
name	string The name of the building.
created_at	string The creation date of this building in timezone UTC.
updated_at	string The update date of this building in timezone UTC.
updated_by_user_id	integer or null The identifier of the associated user who updated the building last.
deleted	integer or null (SoftDelete) Enum: 0 1 2 The soft delete flag of object. 0 or null is undeleted, 1 is soft deleted and 2 is deleted.

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "example building",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"deleted": 0
}

Response samples

201
422

Content type

application/json

{"id": 1,
"location_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"name": "example building",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"deleted": 0
}

Updates an existing building

Updates an existing building by given identifier. Currently only the name is updatable.

Authorizations:

bearerAuth

query Parameters

id

required

integer

Building id to update

Request Body schema: application/json

Building object that needs to be updated.

id	integer The identifier of the building.
name	string The name of the building.
created_at	string The creation date of this building in timezone UTC.
updated_at	string The update date of this building in timezone UTC.
updated_by_user_id	integer or null The identifier of the associated user who updated the building last.
deleted	integer or null (SoftDelete) Enum: 0 1 2 The soft delete flag of object. 0 or null is undeleted, 1 is soft deleted and 2 is deleted.

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "example building",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"deleted": 0
}

Response samples

200
422

Content type

application/json

{"id": 1,
"location_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"name": "example building",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"deleted": 0
}

Deletes a building

Deletes a building the hard way. No softdelete available for the object.

Authorizations:

bearerAuth

query Parameters

id

required

integer

The building identifier to identify the object which should be deleted.

Responses

Count all buildings

Get count of all undeleted buildings

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"total": 537
}

Get one building by id

Hard deleted objects can not be found here.

Authorizations:

bearerAuth

path Parameters

id

required

integer

the building identifier.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"location_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"name": "example building",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"deleted": 0
}

rooms

The collection of rooms present in the instance.

Get all rooms

Get all undeleted room objects.

Authorizations:

bearerAuth

query Parameters

page	integer <int32> >= 1 Default: 1 Example: page=1 Page number
pagesize	integer <int32> [ 0 .. 1000 ] Default: 0 Example: pagesize=100 Number of items per page (0 == all items)
	object or null Example: filter[id]=1&filter[updated_at]=2022-11-15+00:00:00 other examples: `filter[id][in]=1&filter[id][in]=2&filter[id][in]=3` `filter[room_uuid]=1f55367e-59d9-42e4-a975-c3eb137ae457` `filter[updated_at][gt]=2022-11-15+00:00:00` `filter[updated_at][lt]=2022-11-15+00:00:00&filter[updated_at][gt]=2022-11-14+00:00:00`

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"room_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"building_id": 1,
"name": "Meeting room",
"number": "R102",
"additional_information": "Some text in addition to the room.",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"scan_time": "2018-08-17 12:15:57",
"scanned_by_user_id": 1,
"deleted": 0,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1
}
]

Add a new room to the instance.

Authorizations:

bearerAuth

Request Body schema: application/json

Room object that needs to be added. Unsetable fields will be ignored, like the id field.

id	integer The identifier of the room.
building_id	integer The identifier of the associated building.
name	string The name of the room.
number	string The number of the room.
additional_information	string Some additional information to the room.
created_at	string The creation date of this room in timezone UTC.
updated_at	string The update date of this room in timezone UTC.
updated_by_user_id	integer or null The identifier of the associated user who updated the room last.
	Array of objects or null (MediaItem)
scan_time	string or null The last scan time of this room in timezone UTC.
scanned_by_user_id	integer or null The identifier of the associated user who scanned the room last.
deleted	integer or null (SoftDelete) Enum: 0 1 2 The soft delete flag of object. 0 or null is undeleted, 1 is soft deleted and 2 is deleted.
imported_by_user_id	integer or null Default: null The identifier of the associated user who imported the room last.
imported_with_template_id	integer or null Default: null The identifier of the associated import template which affected this room last.
imported_at	string or null Default: null The date of the last import change which affected this room last.
created_on_import_with_template_id	integer or null Default: null The identifier of the associated import template which created this room.

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"building_id": 1,
"name": "Meeting room",
"number": "R102",
"additional_information": "Some text in addition to the room.",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"scan_time": "2018-08-17 12:15:57",
"scanned_by_user_id": 1,
"deleted": 0,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1
}

Response samples

201
422

Content type

application/json

{"id": 1,
"room_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"building_id": 1,
"name": "Meeting room",
"number": "R102",
"additional_information": "Some text in addition to the room.",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"scan_time": "2018-08-17 12:15:57",
"scanned_by_user_id": 1,
"deleted": 0,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1
}

Updates an existing room

Authorizations:

bearerAuth

query Parameters

id

required

integer

Room id to update

Request Body schema: application/json

Room object that needs to be added.

id	integer The identifier of the room.
building_id	integer The identifier of the associated building.
name	string The name of the room.
number	string The number of the room.
additional_information	string Some additional information to the room.
created_at	string The creation date of this room in timezone UTC.
updated_at	string The update date of this room in timezone UTC.
updated_by_user_id	integer or null The identifier of the associated user who updated the room last.
	Array of objects or null (MediaItem)
scan_time	string or null The last scan time of this room in timezone UTC.
scanned_by_user_id	integer or null The identifier of the associated user who scanned the room last.
deleted	integer or null (SoftDelete) Enum: 0 1 2 The soft delete flag of object. 0 or null is undeleted, 1 is soft deleted and 2 is deleted.
imported_by_user_id	integer or null Default: null The identifier of the associated user who imported the room last.
imported_with_template_id	integer or null Default: null The identifier of the associated import template which affected this room last.
imported_at	string or null Default: null The date of the last import change which affected this room last.
created_on_import_with_template_id	integer or null Default: null The identifier of the associated import template which created this room.

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"building_id": 1,
"name": "Meeting room",
"number": "R102",
"additional_information": "Some text in addition to the room.",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"scan_time": "2018-08-17 12:15:57",
"scanned_by_user_id": 1,
"deleted": 0,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1
}

Response samples

200
422

Content type

application/json

{"id": 1,
"room_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"building_id": 1,
"name": "Meeting room",
"number": "R102",
"additional_information": "Some text in addition to the room.",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"scan_time": "2018-08-17 12:15:57",
"scanned_by_user_id": 1,
"deleted": 0,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1
}

Deletes a room

Deletes a room the hard way. No softdelete available for the object.

Authorizations:

bearerAuth

query Parameters

id

required

integer

Room id to delete.

Responses

Get file

Returns file content.

Authorizations:

bearerAuth

query Parameters

fileName required	string The file name.
fileType required	string The file mime type.

Responses

Add one new file to one room

Authorizations:

bearerAuth

Request Body schema: multipart/form-data

File and where to upload.

model_id	integer The identifier of the associated object.
attribute	string The attribute where the file belongs to within the object.
File	string <binary> The file content.

Responses

Response samples

200
500

Content type

application/json

{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}

Count all rooms

Get count of all undeleted rooms.

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"total": 537
}

Get one room by id

Hard deleted objects can not be found here.

Authorizations:

bearerAuth

path Parameters

id

required

integer

The room identifier.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"room_uuid": "eeb35ffa-0da4-4a44-b56c-b203b4778cc7",
"building_id": 1,
"name": "Meeting room",
"number": "R102",
"additional_information": "Some text in addition to the room.",
"created_at": "2018-08-17 11:15:57",
"updated_at": "2018-08-17 12:15:57",
"updated_by_user_id": 1,
"picture": [{"type": "image/jpeg",
"name": "Koala.jpg",
"name_on_server": "assets_5bf7d64eb1b432.69098394.jpg",
"url": "api/v1/asset/get-file?fileName=assets_5bf7d64eb1b432.69098394.jpg&fileType=image%2Fjpeg",
"size": 780831
}
],
"scan_time": "2018-08-17 12:15:57",
"scanned_by_user_id": 1,
"deleted": 0,
"imported_by_user_id": 1,
"imported_with_template_id": 1,
"imported_at": "2018-08-17 12:15:57",
"created_on_import_with_template_id": 1
}