Get me historical work-sessions

Prev Next
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.

Expand All
object
content
Array of object (WorkSession)
object
id
string

The work-session object identifier.

workSessionDefinitionId
string

The identifier of the work-session-definition associated with the work-session.

name
string

The work-session name.

title
string

The work-session title.

description
string

The work-session description.

startTimestamp
integer (int64)

The work-session start timestamp.

Example1578438000000
endTimestamp
integer (int64)

The work-session stop timestamp.

Example1578438000000
timestamp
integer (int64)

The work-session last status update timestamp.

Example1578438000000
metrics
object

The map of monitored metrics values.

importStatus
string

The status of the import process, if any.

Valid values[ "IMPORTING", "SUCCESS", "ERROR" ]
Minimum1.0
thing
object

The thing associated to the work-session.

id
string

The thing object identifier.

name
string

The thing name.

serialNumber
string

The thing serial number.

thingDefinitionId
string

The thing-defininition identifier associated with the thing.

productModelId
string

The product-model identifier associated with the thing. This must be provided in the alternative of the thingDefinitionId.

productModelPartId
string

The model-part identifier associated with the thing to be provided with the productModelId.

gpsPosition
string

The GPS coordinates associated with this thing.

creationTimestamp
integer (int64)

The timestamp at which the object was created.

activationDate
integer (int64)

The last activation date.

lastModifiedTimestamp
integer (int64)

The timestamp at witch the object has been modified the last time.

cloudStatus
integer

The cloud status of the thing.
0: INACTIVE
1: TEST
2: ACTIVE
2: SUSPENDED
4: PROVISIONING
5: ACTIVATING
6: ACTIVATING_TEST

cloudStatusLastUpdateTimestamp
integer (int64)

The timestamp of the last cloud status update.

connectionStatus
integer

The connection status of the thing.
-1: UNREACHABLE
0: OFFLINE
1: ONLINE

connectionStatusLastUpdateTimestamp
integer (int64)

The timestamp of the last connection status update.

latestMetricValueTimestamp
integer (int64)

The timestamp of the lastest received metric value.

customerId
string

The customer identifier.

locationId
string

The location identifier. If missing, the thing is registered as NOT ASSIGNED during creation (allowed only by organization users).

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
simIccid
string

The ICCID of the SIM card installed into the product.

simDetails
object (SimDetails)

The sub-node provising SIM card connectivity and status details.

simStatus
string

The status of the SIM.

Valid values[ "INACTIVE", "TEST", "ACTIVE" ]
sessionStatus
string

The status of the SIM session.

Valid values[ "G", "A", "R" ]
sessionStartTimestamp
integer (int64)

The timestamp the last session has started.

sessionDataLastTimestamp
integer (int64)

The timestamp the last data has been exchanged by the active session.

sessionNetworkTraffic
integer

The amount of bytes exchanged with the session.

dailyTraffic
integer

The daily average of exchanged bytes.

monthlyTraffic
integer

The monthly projection of bytes that will be exchanged.

lastCellId
string

The last cell id the SIM has been connected to.

lastUpdate
integer (int64)

The timestamp the sim details has been last updated.

tagIds
Array of string

The tag identifiers assoicated with this thing.

string
thingDefinition
object

The thing-defininition associated with the thing.

id
string

The thing definition object identifier.

name
string

The thing definition name.

description
string

The thing definition description.

defaultThingName
string

The placeholder based value to use in thing naming.

nameMetricId
string

The identifier of the metric providing the Thing name.

serialNumberMetricId
string

The identifier of the metric providing the Thing serial number.

gpsPositionMetricId
string

The identifier of the metric providing the Thing GPS position in the form "latitude,longitude".

thingDefinitionMetricId
string

The identifier of the metric providing the name of the thing-definition used to dynamically change the thing-definition associated with a thing.

superThingDefinitionId
string

The identifier of the super thing-definition from where this thing-definition is inheriting elements (can be set only during creation).

parentThingDefinitionId
string

The identifier of the parent thing-definition this thing-definition is part of.

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
customer
object

The customer associated with the thing.

id
string

The customer object identifier.

name
string

The name of the customer which could be a personal name or a business name.

country
string

The country the customer belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
creationTimestamp
integer (int64)

The timestamp at which the object was created.

firstAccessTimestamp
integer (int64)

The timestamp at which a client's user first logged in.

lastAccessTimestamp
integer (int64)

The timestamp at which a client's user last logged in.

location
object

The location associated with the thing.

id
string

The location object identifier.

name
string

The location name.

country
string

The country the location belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

gpsPosition
string

The GPS coordinates associated with this location.

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
customerId
string

The customer identifier.

serviceLevel
object

The service-level associated with the thing.

id
string

The service-level object identifier.

name
string

The name of the service level.

level
integer

The integer value used to compare and sort service levels.

alertingFeature
boolean

The flag indicating whether the alerts management is enabled or not.

notificationsFeature
boolean

The flag indicating whether the notifications management is enabled or not.

thingPricing
object

The thing pricing model.

authorizationPricing
object

The authorization pricing model.

features
object

The list of features enabled on this service level.

partner
object

The partner associated with the thing or inherited by the parent location or customer.

id
string

The partner object identifier.

name
string
code
string

The code identifying the partner.

country
string

The country the organization belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

customerCount
number

The number of customers associated to the partner.

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
creationTimestamp
integer (int64)

The timestamp at which the object was created.

customer
object

The location where the associated thing is located.

id
string

The location object identifier.

name
string

The location name.

country
string

The country the location belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

gpsPosition
string

The GPS coordinates associated with this location.

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
customerId
string

The customer identifier.

location
object

The customer own the associated thing.

id
string

The customer object identifier.

name
string

The name of the customer which could be a personal name or a business name.

country
string

The country the customer belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
creationTimestamp
integer (int64)

The timestamp at which the object was created.

firstAccessTimestamp
integer (int64)

The timestamp at which a client's user first logged in.

lastAccessTimestamp
integer (int64)

The timestamp at which a client's user last logged in.

first
boolean

The flag indicating whether the page is the first one.

last
boolean

The flag indicating whether the last page has been reached.

totalPages
integer

The total number of pages.

totalElements
integer

The total number of elements.

sort
string

The current sorting criteria.

numberOfElements
integer

The number of elements in this page.

size
integer

The requested page size.

number
integer

The number of the page (zero-based).

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