Contents x
    Get list of Devices
    • 28 Oct 2024
    • 5 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get list of Devices

    • Updated on 28 Oct 2024
    • 5 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get
    /devices/

    Operation is used to get a list of Devices. Available from product version 3.0.24.

    Devices can be filtered by giving filtering parameters at HTTP querystring (see parameters).

    Security
    API Key
    Header parameter nameAuthorization

    Token issued for API consumer.

    Query parameters
    offset
    integer

    Offset to start returning results.

    Minimum0
    limit
    integer

    Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.

    Minimum1
    __any of the object fields__
    string

    Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

    • For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
    • For numerics: gt, lt, gte, lte, isnull
    • For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++ Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++
    orderby
    string

    Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date

    Responses
    200

    A result response object.

    {
  "comments": "",
  "connectorCount": 100,
  "createdBy": "user@keypro.fi",
  "createdTs": "2099-12-17T06:00:33Z",
  "id": 12345,
  "identification": "test111",
  "interface": "",
  "managementAddress": "testAddress",
  "managementAddress2": "testAddress2",
  "orderNo": "111",
  "owner": {
    "availability_end_ts": "2020-12-31",
    "availability_start_ts": "2020-01-01",
    "available": true,
    "groupname": "DEVICE_OWNER",
    "id": 222,
    "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/DEVICE_OWNER/",
    "logical_txt": "Keypro",
    "num_value": 10.1,
    "num_value2": 20.2,
    "num_value3": 30.3,
    "num_value4": 40.4,
    "txt": "ABC"
  },
  "parent": "http://keycom.example.com/api/v2/devices/158370/",
  "renter": {
    "availability_end_ts": "2020-12-31",
    "availability_start_ts": "2020-01-01",
    "available": true,
    "groupname": "DEVICE_OWNER",
    "id": 222,
    "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/DEVICE_OWNER/",
    "logical_txt": "Keypro",
    "num_value": 10.1,
    "num_value2": 20.2,
    "num_value3": 30.3,
    "num_value4": 40.4,
    "txt": "ABC"
  },
  "startPin": 1,
  "type": "http://keycom.example.com/api/v2/types/22461/",
  "updatedBy": "user@keypro.fi",
  "updatedTs": "2099-12-17T06:00:33Z",
  "usageState": {
    "availability_end_ts": "2020-12-31",
    "availability_start_ts": "2020-01-01",
    "available": true,
    "groupname": "TERMINAL_STATE",
    "id": 14630,
    "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/TERMINAL_STATE/",
    "logical_txt": "Käytössä",
    "num_value": 10.1,
    "num_value2": 20.2,
    "num_value3": 30.3,
    "num_value4": 40.4,
    "txt": "Käytössä"
  }
}
    Expand All
    object
    Next
    string (url)

    Url to next page of Devices. Null if No next page exist

    Prev
    string (url)

    Url to previous page of Devices. Null if No previous page exist

    Results
    Array of object (Device)

    List of fetched Devices

    object
    comments
    string

    Remarks

    connectorCount
    integer

    Connector count

    createdBy
    string

    creator

    createdTs
    string (date-time)

    Creation date and time

    id
    integer

    Primary key

    identification
    string

    Identification

    interface
    string

    Interface

    locationArea
    string

    Location area. Available from product version 3.6.

    locationRack
    string

    Location rack. Available from product version 3.6.

    locationRackRow
    string

    Location rack row. Available from product version 3.6.

    locationSide
    string

    Location side. Available from product version 3.6.

    locationSlot
    string

    Location slot. Available from product version 3.6.

    locationSubSlot
    string

    Location sub slot. Available from product version 3.6.

    locationSubrack
    string

    Location sub rack. Available from product version 3.6.

    managementAddress
    string

    Management address

    managementAddress2
    string

    Management address 2

    orderNo
    integer

    Order number

    owner
    object (TerminalOwner)

    Terminal owner

    availability_end_ts
    string (date-time)

    Ending date time for availability

    availability_start_ts
    string (date-time)

    Beginning date time for availability

    available
    boolean

    Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

    groupname

    Group name of constant

    Valid values[ "DEVICE_OWNER" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    num_value
    number (float)

    Numeric value

    num_value2
    number (float)

    Numeric value 2

    num_value3
    number (float)

    Numeric value 3

    num_value4
    number (float)

    Numeric value 4

    txt
    string

    Human readable textual representation

    parent
    object (Device) Recursive
    premise
    string (url)

    Url to fetch details of related telecom premises.

    renter
    object (TerminalRenter)

    Terminal renter

    availability_end_ts
    string (date-time)

    Ending date time for availability

    availability_start_ts
    string (date-time)

    Beginning date time for availability

    available
    boolean

    Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

    groupname

    Group name of constant

    Valid values[ "DEVICE_OWNER" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    num_value
    number (float)

    Numeric value

    num_value2
    number (float)

    Numeric value 2

    num_value3
    number (float)

    Numeric value 3

    num_value4
    number (float)

    Numeric value 4

    txt
    string

    Human readable textual representation

    sourceSystem
    object (SourceSystem)

    External source system

    availability_end_ts
    string (date-time)

    Ending date time for availability

    availability_start_ts
    string (date-time)

    Beginning date time for availability

    available
    boolean

    Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

    groupname

    Group name of constant

    Valid values[ "SOURCE_SYSTEM" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    num_value
    number (float)

    Numeric value

    num_value2
    number (float)

    Numeric value 2

    num_value3
    number (float)

    Numeric value 3

    num_value4
    number (float)

    Numeric value 4

    txt
    string

    Human readable textual representation

    sourceSystemKey
    integer

    source system key. Available from product version 3.4.

    startPin
    integer

    Start connector

    type
    object (TerminalType)

    Terminal type

    availabilityEnd
    string (date-time)

    Availability end date and time

    availabilityStart
    string (date-time)

    Availability start date and time

    clazz
    object (TerminalTypeClass)

    Terminal type class

    availability_end_ts
    string (date-time)

    Ending date time for availability

    availability_start_ts
    string (date-time)

    Beginning date time for availability

    available
    boolean

    Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

    groupname

    Group name of constant

    Valid values[ "DEVICE, CTV_DEVICE" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    num_value
    number (float)

    Numeric value

    num_value2
    number (float)

    Numeric value 2

    num_value3
    number (float)

    Numeric value 3

    num_value4
    number (float)

    Numeric value 4

    txt
    string

    Human readable textual representation

    connectors
    integer

    Connectors

    fcode
    integer

    Feature code

    id
    integer

    Primary key

    listUrl
    string (url)

    Url to fetch all contants from terminal types

    technology
    object (TerminalTech)

    Terminal type technology

    availability_end_ts
    string (date-time)

    Ending date time for availability

    availability_start_ts
    string (date-time)

    Beginning date time for availability

    available
    boolean

    Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

    groupname

    Group name of constant

    Valid values[ "TERMINAL_TECH" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    num_value
    number (float)

    Numeric value

    num_value2
    number (float)

    Numeric value 2

    num_value3
    number (float)

    Numeric value 3

    num_value4
    number (float)

    Numeric value 4

    txt
    string

    Human readable textual representation

    type
    string

    Type

    updatedBy
    string

    Last updater

    updatedTs
    string (date-time)

    Last update date time

    usageState
    object (TerminalState)

    Terminal usage purpose

    availability_end_ts
    string (date-time)

    Ending date time for availability

    availability_start_ts
    string (date-time)

    Beginning date time for availability

    available
    boolean

    Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

    groupname

    Group name of constant

    Valid values[ "TERMINAL_STATE" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    num_value
    number (float)

    Numeric value

    num_value2
    number (float)

    Numeric value 2

    num_value3
    number (float)

    Numeric value 3

    num_value4
    number (float)

    Numeric value 4

    txt
    string

    Human readable textual representation

    Total
    integer

    Total number of Devices

    401

    Authentication credentials are missing or invalid

    {
  "details": "Authentication credentials were not provided"
}
    object
    details
    string

    Detailed description of error

    Was this article helpful?
    What's Next
    Products
    Company
    Our Mission
    Connect With Us
    Support
    Copyright © Keypro Oy. All Rights Reserved