2026-10-23 12.00 UTC - There are currently no active events. All systems operational.

Automatic Circuit Reservation

Prev Next
Post
/automaticCircuitReservations/

NOTE: This API is provided by a separate service.

This service automatically reserves a routed logical and/or physical connection for an existing circuit section, without the caller having to resolve the route itself. Two lookup/routing styles are supported: (a) Use Case A - a specific active device port is given via premId together with portId or portName (deviceId + portName is equivalent to portId). The service routes the reservation starting from that port. (b) Use Case B - only the installation address (addressId, or sourceSystem + sourceSystemKey) and usageId are given. The service automatically discovers a free, ready port at that installation address and routes the reservation from it. deviceClassId can restrict which device class the free port is searched on.

The target circuit (and its unreserved section) is resolved using any combination of circuitId, sectionId, name, name2, contractNumber, orderNumber, addressId, or sourceSystem + sourceSystemKey. At least one of these lookup parameters is required. If the lookup only identifies an installation address (addressId or sourceSystem/sourceSystemKey), usageId is also required to find a single, unambiguous section. sourceSystem and sourceSystemKey must always be given together.

At least one of logicalReservations or physicalReservations must be true; logicalReservations defaults to true for this endpoint. For Use Case A, premId is required together with portId or portName.

If the circuit has several unreserved sections, Use Case A reserves only the first of them, because the given port can back a single section. Use Case B reserves each unreserved section in order, each from the next free port found at the installation address.

On success, the resolved circuit section's usage state, construction state, bitrate and connection dates are updated as given, and the routed logical and/or physical reservations are created for the section.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

search criteria identifying the circuit section, and route/update parameters for the automatic reservation

object
circuitId
integer

Optional parameter for filtering in cases of multiple circuits retrieved

sectionId
integer

Optional parameter for filtering in cases of multiple circuit sections retrieved

contractNumber
string

Circuit contract number as alternative search criteria or update value

name
string

Circuit identifier as alternative search criteria or update value

name2
string

Circuit alternative identifier as alternative search criteria or update value

orderNumber
string

Circuit order number as alternative search criteria or update value

addressId
integer

Apartment level ID of circuit installation address, used to look up the circuit

deviceId
integer

Device ID of the active device port (Note! Used together with portName, or with portId alone)

portId
integer

Port ID of the active device port

portName
string

Port Name of the active device port (Note! Requires deviceId to also be given)

usageId
integer

Usage purpose ID of circuit section, used to look up the circuit

connectDatePlanned
string (date-time)

Circuit section connect date planned

connectDateReal
string (date-time)

Circuit section connect date real

disconnectDatePlanned
string (date-time)

Circuit section disconnect date planned

disconnectDateReal
string (date-time)

Circuit section disconnect date real

sourceSystem
integer

External source system ID. Must be given together with sourceSystemKey.

sourceSystemKey
integer

External source system address/apartment key. Must be given together with sourceSystem.

bitrateId
integer

Internal ID of circuit section speed information

constStateId
integer

Internal ID of circuit section construction state information

deviceClassId
integer

Internal ID restricting the device class of the automatically discovered free port (Use Case B)

installationAddressType
integer

Internal ID restricting the type of installation address used to resolve the circuit

logicalOEConnectionOnly
boolean

If true, only follow logical other-end connections when routing the reservation. Default is set to false. Only JSON booleans true/false are accepted; any other value (e.g. "false", "0", 0 or null) returns 400 (err1200000011).

Defaultfalse
logicalReservations
boolean

Allow logical reservations creation. Default is set to true for this endpoint. Only JSON booleans true/false are accepted; any other value (e.g. "false", "0", 0 or null) returns 400 (err1200000011).

Defaulttrue
physicalReservations
boolean

Allow physical reservations creation. Default is set to false. Only JSON booleans true/false are accepted; any other value (e.g. "false", "0", 0 or null) returns 400 (err1200000011).

Defaultfalse
premId
integer

Telecom Premise ID of the active device (Use Case A). Required together with portId or portName.

reservationDirection
integer

Logical direction to follow when routing the automatic reservation. 1 = ascending (to-center), 2 = descending (from-center), -1 = both directions. Default is 1. Any other value returns 400.

Valid values[ 1, 2, -1 ]
Default1
sectionName
string

Name for the circuit section, used when the reservation creates a new section

usageStateId
integer

Internal ID of circuit section usage state to set after the reservation

Responses
200

Circuit and sections with the created reservation data, route information, total length and total attenuation.

[
  {
    "areaCode": null,
    "comments": null,
    "contractLength": 4,
    "contractNumber": "O2738",
    "customer": null,
    "directLength": null,
    "id": 2216174,
    "identifier": "Circuit X",
    "identifierAlt": "Circuit Test",
    "importance": null,
    "installationAddresses": [
      "http://keycom.example.com/api/v2/circuitlocations/40934190/"
    ],
    "length": null,
    "orderNumber": "O4260",
    "organisation": null,
    "redundancy": null,
    "sections": [
      {
        "abnormalConnections": [],
        "circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
        "connectionsToDelete": [],
        "constructionState": {
          "groupname": "KN_CONST_STATE",
          "id": 6050,
          "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
          "logical_txt": "Valmis",
          "num_value": 1.0,
          "txt": "Ready"
        },
        "id": 34734341,
        "listUrl": "http://keycom.example.com/api/v2/sections/",
        "name": "Circuit Section X",
        "provisioningDevices": [],
        "reservations": {
          "logical": [
            {
              "ccp": {
                "id": 829922070,
                "listUrl": "http://keycom.example.com/api/v2/ccps/",
                "name": "1",
                "terminal": "http://keycom.example.com/api/v2/devices/53336290/"
              },
              "circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
              "connection": null,
              "device": "http://keycom.example.com/api/v2/devices/53336290/",
              "id": 14886290,
              "premises": "http://keycom.example.com/api/v2/premises/80538490/",
              "section": "http://keycom.example.com/api/v2/sections/34734341/"
            }
          ],
          "physical": [
            {
              "componentId": 829922070,
              "componentType": "ccp",
              "id": 40521170,
              "listUrl": "http://keycom.example.com/api/v2/circuitphysicalreservations/"
            }
          ]
        },
        "totalAttenuation": 0.9,
        "totalLength": 125.4,
        "usagePurpose": {
          "groupname": "USAGE",
          "id": 14750,
          "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/USAGE/",
          "logical_txt": "5 rahapuhelin",
          "num_value": 5.0,
          "txt": "5 Coin phone"
        },
        "usageState": {
          "groupname": "KN_USAGE_STATE",
          "id": 63501,
          "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_USAGE_STATE/",
          "logical_txt": "Pian käytössä",
          "num_value": 4.0,
          "txt": "Soon used"
        }
      }
    ]
  }
]
Array of object
object
areaCode
string

Circuit area code

comments
string

Circuit comments. Available from product version 3.2.8.

contractLength
integer

Circuit contract length

contractNumber
string

Circuit contract number

createdAt
string (date-time)

Creation timestamp (date and time). Available from product version v2026.1.

createdBy
string

Creator username

createdTs
string (date)

Creation date (date only, existing field)

customer
object (Customer)
address
object (Apartment)
address
object (Address)
buildingId
string

Building id

buildingName
string

Building name

city
string

Building city name

cityAlt
string

Building city name in alternative language

country
string

Building country

createdBy
string

creator

createdTs
string (date-time)

Creation date and time

district
string

Building district

empty
integer

Address with this value as 1 is default address. Modifying or deleting such address is prohibited.

Valid values[ 0, 1 ]
id
integer

Primary key

location
string (ewkt)

Geographical location

municipality
string

Building municipality

propertyId
string

Property number

province
string

Building province

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 constants 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

streetname
string

Building street name

streetnameAlt
string

Building street name in alternative language

streetno
string

Building number

subdivision
string

Building municipality subdivision

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

usagePurpose
object (BuildingUsage)

Building 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[ "BUILDING_USAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

usagePurposeAlt
object (AddressSecondaryUsage)

Address 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[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

zipcode
string

Building zipcode

apartmentDivision
string

apartment division

apartmentLetter
string

apartment letter

apartmentNumber
string

apartment number

empty
integer

Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.

Valid values[ 0, 1 ]
id
integer

Primary key

originProperty
string

apartment original property id

originalStreetno
string

apartment original streen number

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 constants 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

usagePurpose
object (ApartmentUsage)

Apartment 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[ "APARTMENT_USAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

usagePurposeAlt
object (AddressSecondaryUsage)

Address 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[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

usageState
object (ApartmentStatus)

Apartment status

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[ "APARTMENT_STATUS" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

addressAlt
object (Apartment)
address
object (Address)
buildingId
string

Building id

buildingName
string

Building name

city
string

Building city name

cityAlt
string

Building city name in alternative language

country
string

Building country

createdBy
string

creator

createdTs
string (date-time)

Creation date and time

district
string

Building district

empty
integer

Address with this value as 1 is default address. Modifying or deleting such address is prohibited.

Valid values[ 0, 1 ]
id
integer

Primary key

location
string (ewkt)

Geographical location

municipality
string

Building municipality

propertyId
string

Property number

province
string

Building province

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 constants 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

streetname
string

Building street name

streetnameAlt
string

Building street name in alternative language

streetno
string

Building number

subdivision
string

Building municipality subdivision

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

usagePurpose
object (BuildingUsage)

Building 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[ "BUILDING_USAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

usagePurposeAlt
object (AddressSecondaryUsage)

Address 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[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

zipcode
string

Building zipcode

apartmentDivision
string

apartment division

apartmentLetter
string

apartment letter

apartmentNumber
string

apartment number

empty
integer

Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.

Valid values[ 0, 1 ]
id
integer

Primary key

originProperty
string

apartment original property id

originalStreetno
string

apartment original streen number

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 constants 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

usagePurpose
object (ApartmentUsage)

Apartment 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[ "APARTMENT_USAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

usagePurposeAlt
object (AddressSecondaryUsage)

Address 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[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

usageState
object (ApartmentStatus)

Apartment status

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[ "APARTMENT_STATUS" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

billingName
string

Customer billing name

businessId
string

Customer bussiness id

contactName
string

Customer contact name or null. Available from product version 2026.1

createdBy
string

creator

createdTs
string (date-time)

Creation date and time

email
string

Customer email

id
integer

Primary key

mobilePhone
string

Customer mobile phone number name

name
string

Customer name

number
string

Customer number

phone
string

Customer phone number

smsProhibited
boolean

Sending sms is prohibited to customer

telefax
string

Customer fax number

type
object (CustomerType)

Customer type

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[ "KN_CUST_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

directLength
number (float)

Circuit direct length

id
integer

Primary key

identifier
string

Circuit identifier

identifierAlt
string

Circuit alternative identifier

importance
object (CircuitImportance)

Circuit importance

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[ "CIRCUIT_IMPORTANCE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

installationAddresses
Array of string

Circuit installations addresses

string (url)
length
number (float)

Circuit length

orderNumber
string

Circuit order number

organisation
object (CircuitOrganisation)

Circuit organisation

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[ "KN_ORGANISATION" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

redundancy
object (CircuitRedundancy)

Circuit redundancy

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[ "CIRCUIT_REDUNDANCY" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

sections
Array of object (CircuitSection)

Circuit sections

object
bitrate
object (Bitrate)
description
string

Bitrate description

id
integer

Primary key

rate
integer

Bitrate value

circuit
string (url)

Circuit the section is in

connectionDate
string (date-time)

actual section connection date

constructionState
object (ConstructionState)

Txt constants construction state

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[ "KN_CONST_STATE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

createdBy
string

Creator username. Available from product version v2026.1.

createdTs
string (date-time)

Creation timestamp. Available from product version v2026.1.

disconnectionDate
string (date-time)

actual section disconnection date

extraUsages
Array of object (CircuitSectionExtraUsage)

Extra usages for the Circuit Section. Available from product version 2026.1

object
customerUrl
string (uri)

Hyperlink to the related customer

extraUsage
object (ExtraUsage)

Circuit Section Extra Usage Txt Constant definition

availability_end_ts
string (date-time)

Availability end timestamp

availability_start_ts
string (date-time)

Availability start timestamp

available
boolean

Whether the constant is available

groupname

Group name of constant

Valid values[ "KN_EXTRAUSAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

Examplehttps://keycom.example.com/api/v2/txt_constants/groupname/KN_EXTRAUSAGE/
logical_txt
string

Logical textual value

ExampleIPTV DSL-liittymälle
num_value
integer

Numeric value 1

Example3.0
num_value2
integer

Numeric value 2

num_value3
integer

Numeric value 3

num_value4
integer

Numeric value 4

txt
string

Human readable textual representation

information
string

Free text information

name1
string

Optional name field 1

ExampleJohn Doe
name2
string

Optional name field 2

ExampleJane Doe
name3
string

Optional name field 3

ExampleJane Doe
name4
string

Optional name field 4

ExampleJane Doe
pk
integer

Primary key

Example1
id
integer

Primary key

name
string

Section name

plannedConnectionDate
string (date-time)

planned section connection date

plannedDisconnectionDate
string (date-time)

planned section disconnection date

updatedBy
string

Last updater username. Available from product version v2026.1.

updatedTs
string (date-time)

Last update timestamp. Available from product version v2026.1.

usagePurpose
object (CircuitUsage)

Circuit usage

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[ "USAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

usageState
object (CircuitUsageState)

Circuit usage state

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[ "KN_USAGE_STATE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

supercircuit
object (SuperCircuit)

Super circuit (nested in Circuit responses). Available from product version v2026.2.

id
integer

Primary key

identifier
string

Super circuit identifier

itemType
object (TxtConstant)
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
string

Group name of constant

id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

networkType
object (TxtConstant)
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
string

Group name of constant

id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

state
object (TxtConstant)
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
string

Group name of constant

id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

supercircuitOrderNo
integer

Order number of this circuit within the super circuit. Available from product version v2026.2.

updatedAt
string (date-time)

Last update timestamp (date and time). Available from product version v2026.1.

updatedBy
string

Last updater username

updatedTs
string (date)

Last update date (date only, existing field)

300

Multiple Choices

{
  "details": "Object has multiple resources"
}
object
details
string

Detailed description of error

400

Request could not be processed because it was invalid.

Either validation failed (field-level errors are returned), or a generic bad request message is provided.

{
  "email": [
    "Email is required",
    "Email must be valid"
  ],
  "password": [
    "Password must be at least 8 characters"
  ]
}
object

Validation errors by field name or a generic bad request description

details
string

Description of the error for generic bad request responses

property*
Array of string additionalProperties

List of validation error messages for this field name

string

Validation error message

401

Authentication credentials are missing or invalid

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

Standard error response payload

details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object

Standard error response payload

details
string

Detailed description of error