Get circuit section details

2 minute(s) read

Prev Next

Get

/sections/{id}/

Operation is used to retrieve full details of given circuit section id. Available from product version 3.2.2.

Security

API Key: Token

Header parameter nameAuthorization

Token issued for API consumer.

Path parameters

integerRequired

Id of circuit section

Responses

200

Circuit section

Expand All

object

bitrate

object (Bitrate)

description

string

Bitrate description

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" ]

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" ]

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

integer

Primary key

Example1

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" ]

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" ]

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

401

Authentication credentials are missing or invalid

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

object

details

string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}

object

details

string

Detailed description of error