Fleet setup

Attributes

Computed attributes management

Fetch a list of Attributes

GET

https://demo.traccar.org/api/attributes/computed

Without params, it returns a list of Attributes the user has access to

Fetch a list of Attributes

curl -X GET 'https://demo.traccar.org/api/attributes/computed' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/attributes/computed', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/attributes/computed',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

[
  {
    "id": 0,
    "description": "string",
    "attribute": "string",
    "expression": "string",
    "type": "string"
  }
]

Parameters

allbooleanquery

Can only be used by admins or managers to fetch all entities

userIdintegerquery

Standard users can use this only with their own userId

deviceIdintegerquery

Standard users can use this only with _deviceId_s, they have access to

groupIdintegerquery

Standard users can use this only with _groupId_s, they have access to

refreshbooleanquery

limitintegerquery

Limit the number of returned results

offsetintegerquery

Offset for pagination

keywordstringquery

Search keyword filter

Response

200OKArray<Attribute>

Response fields application/json

Array<Attribute>

Show child attributes

idinteger<int64>

Unique computed attribute identifier

descriptionstring

Human readable name of the attribute

attributestring

Attribute name used in expressions

expressionstring

Expression that defines how the attribute is calculated

typestring

String|Number|Boolean

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Create an Attribute

POST

https://demo.traccar.org/api/attributes/computed

Create an Attribute

curl -X POST 'https://demo.traccar.org/api/attributes/computed' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}'

const body = `{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}`;

const response = await fetch('https://demo.traccar.org/api/attributes/computed', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}'''

response = requests.post(
    'https://demo.traccar.org/api/attributes/computed',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}

200

{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}

Body

application/json

idinteger<int64>

Unique computed attribute identifier

descriptionstring

Human readable name of the attribute

attributestring

Attribute name used in expressions

expressionstring

Expression that defines how the attribute is calculated

typestring

String|Number|Boolean

Response

200OKAttribute

Response fields application/json

idinteger<int64>

Unique computed attribute identifier

descriptionstring

Human readable name of the attribute

attributestring

Attribute name used in expressions

expressionstring

Expression that defines how the attribute is calculated

typestring

String|Number|Boolean

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Evaluate a Computed Attribute against the latest Device Position

POST

https://demo.traccar.org/api/attributes/computed/test

Admin only. Returns the computed value without persisting the attribute.

Evaluate a Computed Attribute against the latest Device Position

curl -X POST 'https://demo.traccar.org/api/attributes/computed/test?deviceId=0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}'

const body = `{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}`;

const response = await fetch('https://demo.traccar.org/api/attributes/computed/test?deviceId=0', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}'''

response = requests.post(
    'https://demo.traccar.org/api/attributes/computed/test?deviceId=0',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}

200

Body

application/json

idinteger<int64>

Unique computed attribute identifier

descriptionstring

Human readable name of the attribute

attributestring

Attribute name used in expressions

expressionstring

Expression that defines how the attribute is calculated

typestring

String|Number|Boolean

Parameters

deviceIdintegerrequiredquery

Response

200OKnumber | boolean | string

Response fields application/json

One of

number

boolean

string

204No Content

Computation produced no value

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch an Attribute

GET

https://demo.traccar.org/api/attributes/computed/{id}

Fetch an Attribute

curl -X GET 'https://demo.traccar.org/api/attributes/computed/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/attributes/computed/0', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/attributes/computed/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}

Parameters

idintegerrequiredpath

Response

200OKAttribute

Response fields application/json

idinteger<int64>

Unique computed attribute identifier

descriptionstring

Human readable name of the attribute

attributestring

Attribute name used in expressions

expressionstring

Expression that defines how the attribute is calculated

typestring

String|Number|Boolean

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Update an Attribute

PUT

https://demo.traccar.org/api/attributes/computed/{id}

Update an Attribute

curl -X PUT 'https://demo.traccar.org/api/attributes/computed/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}'

const body = `{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}`;

const response = await fetch('https://demo.traccar.org/api/attributes/computed/0', {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}'''

response = requests.put(
    'https://demo.traccar.org/api/attributes/computed/0',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}

200

{
  "id": 0,
  "description": "string",
  "attribute": "string",
  "expression": "string",
  "type": "string"
}

Body

application/json

idinteger<int64>

Unique computed attribute identifier

descriptionstring

Human readable name of the attribute

attributestring

Attribute name used in expressions

expressionstring

Expression that defines how the attribute is calculated

typestring

String|Number|Boolean

Parameters

idintegerrequiredpath

Response

200OKAttribute

Response fields application/json

idinteger<int64>

Unique computed attribute identifier

descriptionstring

Human readable name of the attribute

attributestring

Attribute name used in expressions

expressionstring

Expression that defines how the attribute is calculated

typestring

String|Number|Boolean

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Delete an Attribute

DELETE

https://demo.traccar.org/api/attributes/computed/{id}

Delete an Attribute

curl -X DELETE 'https://demo.traccar.org/api/attributes/computed/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/attributes/computed/0', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://demo.traccar.org/api/attributes/computed/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Parameters

idintegerrequiredpath

Response

204No Content

No Content

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Docs by Sourcey