Skip to main content
POST
/
v1
/
equipments
Create an Equipment
curl --request POST \
  --url https://api.siit.io/v1/equipments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "<string>",
  "holder": "<string>",
  "office_location": "<string>",
  "collection_date": "2023-12-25",
  "depreciation_rate": 123,
  "equipment_issue_date": "2023-12-25",
  "firmware_version": "<string>",
  "guarantee_date": "2023-12-25",
  "ip_address": "<string>",
  "keyboard_layout": "<string>",
  "last_contact_date": "2023-12-25",
  "last_enrollment_date": "2023-12-25",
  "last_maintenance_date": "2023-12-25",
  "last_report_date": "2023-12-25",
  "leasing_buyout_option": true,
  "leasing_company": "<string>",
  "leasing_company_contact": "<string>",
  "leasing_contract_id": "<string>",
  "leasing_end_date": "2023-12-25",
  "leasing_monthly_cost": 123,
  "leasing_start_date": "2023-12-25",
  "lifecycle": "in_service",
  "mac_address": "<string>",
  "model": "<string>",
  "name": "<string>",
  "notes": "<string>",
  "os_name": "<string>",
  "processor_type": "<string>",
  "purchase_cost": 123,
  "purchase_date": "2023-12-25",
  "purchase_number": "<string>",
  "serial_number": "<string>",
  "storage_capacity_mb": 123,
  "total_ram_mb": 123,
  "vendor_name": "<string>"
}
'
{
  "result": {
    "uid": "<string>",
    "added_by": "<string>",
    "category": "<string>",
    "category_uid": "<string>",
    "collection_date": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "depreciation_rate": 123,
    "equipment_issue_date": "2023-12-25",
    "external_id": "<string>",
    "external_url": "<string>",
    "firmware_version": "<string>",
    "guarantee_date": "2023-12-25",
    "holder": "<string>",
    "holder_uid": "<string>",
    "ip_address": "<string>",
    "keyboard_layout": "<string>",
    "last_contact_date": "2023-12-25",
    "last_enrollment_date": "2023-12-25",
    "last_maintenance_date": "2023-12-25",
    "last_report_date": "2023-12-25",
    "leasing_buyout_option": true,
    "leasing_company": "<string>",
    "leasing_company_contact": "<string>",
    "leasing_contract_id": "<string>",
    "leasing_end_date": "2023-12-25",
    "leasing_monthly_cost": 123,
    "leasing_start_date": "2023-12-25",
    "lifecycle": "in_service",
    "mac_address": "<string>",
    "model": "<string>",
    "name": "<string>",
    "notes": "<string>",
    "office_location": "<string>",
    "office_location_uid": "<string>",
    "os_name": "<string>",
    "processor_type": "<string>",
    "purchase_cost": 123,
    "purchase_date": "2023-12-25",
    "purchase_number": "<string>",
    "serial_number": "<string>",
    "source": "siit",
    "storage_capacity_mb": 123,
    "total_ram_mb": 123,
    "updated_at": "2023-11-07T05:31:56Z",
    "vendor_name": "<string>"
  }
}

​
Usage

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating or updating an Equipment. Pass UIDs (not objects) for relationship fields.

​
category
string

Category of this equipment. Defaults to "Other device". Pass the UID of the related object.

​
holder
string | null

The user who holds this equipment. Pass the UID of the related object.

​
office_location
string | null

Office Location of this equipment. Pass the UID of the related object.

​
collection_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

​
depreciation_rate
integer | null
​
equipment_issue_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

​
firmware_version
string | null
​
guarantee_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

​
ip_address
string | null
​
keyboard_layout
string | null
​
last_contact_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

​
last_enrollment_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

​
last_maintenance_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

​
last_report_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

​
leasing_buyout_option
boolean | null
​
leasing_company
string | null
​
leasing_company_contact
string | null
​
leasing_contract_id
string | null
​
leasing_end_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

​
leasing_monthly_cost
integer | null
​
leasing_start_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

​
leasing_status
enum<string> | null
Available options:
active,
expired
​
lifecycle
enum<string> | null
default:in_service
Available options:
in_order,
maintenance,
broken,
outdated,
lost,
sold,
reserved,
stolen,
in_service,
spare
​
mac_address
string | null
​
model
string | null
​
name
string
​
notes
string | null
​
os_name
string | null
​
processor_type
string | null
​
purchase_cost
integer | null
​
purchase_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

​
purchase_number
string | null
​
serial_number
string | null
​
storage_capacity_mb
integer | null
​
storage_type
enum<string> | null
Available options:
hdd,
ssd,
nvme,
other
​
total_ram_mb
integer | null
​
vendor_name
string | null

Response

201 - application/json

Equipment created

​
result
object