Get
/v2/identity/users/me/historicalWorkSessions
This method returns 100 items at a time, to retrieve more items, multiple requests with incremental page number must be performed.
Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired
The name of the target tenant (e.g. acme).
Query parameters
searchText
string
The search text used to filter objects (requires searchField parameter).
Use '*' for variants: starts with (foo*), contains (*foo*) or ends with (*foo).
Maximum1.0
Example*foo*
searchField
string
The name of the field in which to verify the search text.
Maximum-1.0
Examplename
customerId
string
Condition on customer id.
Exampleabcd1234
locationId
string
Condition on location id.
Exampleabcd1234
thingId
string
Condition on thing id.
Exampleabcd1234
minStartTimestamp
integer (int64)
Condition to get events started after a specific timestamp.
Example1578438000000
maxStartTimestamp
integer (int64)
Condition to get events started before a specific timestamp.
Example1578438000000
size
integer
The number of elements to retrieve for the current page.
Minimum1.0
Example200
page
integer
The page number to retrieve (zero-based).
Minimum0.0
Example0
workSessionDefinitionId
string
The work-session-definition identifier.
Minimum1.0
Exampleabcd1234
Responses
200
Successful operation.
object
content
Array of object (WorkSession)
object
id
string
workSessionDefinitionId
string
name
string
title
string
description
string
startTimestamp
integer (int64)
Example1578438000000
endTimestamp
integer (int64)
Example1578438000000
timestamp
integer (int64)
Example1578438000000
metrics
object
importStatus
string
Valid values[
"IMPORTING",
"SUCCESS",
"ERROR"
]
Minimum1.0
thing
object
id
string
name
string
serialNumber
string
thingDefinitionId
string
productModelId
string
productModelPartId
string
gpsPosition
string
creationTimestamp
integer (int64)
activationDate
integer (int64)
lastModifiedTimestamp
integer (int64)
cloudStatus
integer
cloudStatusLastUpdateTimestamp
integer (int64)
connectionStatus
integer
connectionStatusLastUpdateTimestamp
integer (int64)
latestMetricValueTimestamp
integer (int64)
customerId
string
locationId
string
properties
object (Properties)
Example{
"foo": "abc",
"bar": "123"
}
property*
string additionalProperties
simIccid
string
simDetails
object (SimDetails)
simStatus
string
Valid values[
"INACTIVE",
"TEST",
"ACTIVE"
]
sessionStatus
string
Valid values[
"G",
"A",
"R"
]
sessionStartTimestamp
integer (int64)
sessionDataLastTimestamp
integer (int64)
sessionNetworkTraffic
integer
dailyTraffic
integer
monthlyTraffic
integer
lastCellId
string
lastUpdate
integer (int64)
tagIds
Array of string
string
thingDefinition
object
id
string
name
string
description
string
defaultThingName
string
nameMetricId
string
serialNumberMetricId
string
gpsPositionMetricId
string
thingDefinitionMetricId
string
superThingDefinitionId
string
parentThingDefinitionId
string
properties
object (Properties)
Example{
"foo": "abc",
"bar": "123"
}
property*
string additionalProperties
customer
object
id
string
name
string
country
string
timezone
string
properties
object (Properties)
Example{
"foo": "abc",
"bar": "123"
}
property*
string additionalProperties
creationTimestamp
integer (int64)
firstAccessTimestamp
integer (int64)
lastAccessTimestamp
integer (int64)
location
object
id
string
name
string
country
string
timezone
string
gpsPosition
string
properties
object (Properties)
Example{
"foo": "abc",
"bar": "123"
}
property*
string additionalProperties
customerId
string
serviceLevel
object
id
string
name
string
level
integer
alertingFeature
boolean
notificationsFeature
boolean
thingPricing
object
authorizationPricing
object
features
object
partner
object
id
string
name
string
code
string
country
string
timezone
string
customerCount
number
properties
object (Properties)
Example{
"foo": "abc",
"bar": "123"
}
property*
string additionalProperties
organization
object
id
string
Example1234abcd
creationTimestamp
integer (int64)
customer
object
id
string
name
string
country
string
timezone
string
gpsPosition
string
properties
object (Properties)
Example{
"foo": "abc",
"bar": "123"
}
property*
string additionalProperties
customerId
string
location
object
id
string
name
string
country
string
timezone
string
properties
object (Properties)
Example{
"foo": "abc",
"bar": "123"
}
property*
string additionalProperties
creationTimestamp
integer (int64)
firstAccessTimestamp
integer (int64)
lastAccessTimestamp
integer (int64)
first
boolean
last
boolean
totalPages
integer
totalElements
integer
sort
string
numberOfElements
integer
size
integer
number
integer
Minimum0.0
401
User not authenticated.
object
message
string
The error response.
ExampleUser not authenticated
403
User not authorized.
object
message
string
The error response.
ExampleUser not authorized
404
Resource was not found.
object
message
string
The error response.
ExampleResource not found
429
API call rate limit exeeded.
object
message
string
The error response.
ExampleAPI call rate limit exeeded
500
Internal server error.
object
message
string
The error response.
ExampleInternal Server Error