Create new circuit with port

28 Oct 2024
14 Minutes to read
Contributors

Print
Dark
Light
PDF

Create new circuit with port

Updated on 28 Oct 2024
14 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/createNewCircuitWithPort/

NOTE: This API is provided by a separate service.

Creates a new circuit into KeyCom with port reservation information based on parameters given in request. Required parameters for this endpoint are: (a) addressId or (sourceSystem and sourceSystemKey) (a.a) addressId can either be apartment-level or address-level. Also supports optional source system and source system key parameters for both levels. Priority is as follows: apartment >> address >> apartment-level source system >> address-level source system. Available from product version 3.6.3. (b) premId (c) deviceId Also either: (d) portId or portName must be provided to correctly resrve a port Available from product version 3.4.0.

If logical_res is true, the service will create logical reservations. The service will only create physical reservations if both logical_res and logical_physical_res are true. Available from product version 3.6.3.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

properties to create circuit with and device with port to reserve to it

object

bitrateId

integer

ID of section bitrate which is related to the speed of section

connectDatePlanned

string (date-time)

section connect date planned

connectDateReal

string (date-time)

section connect date real

constStateId

integer

ID of section construction state

disconnectionDate

string (date-time)

section disconnect date real

plannedDisconnectionDate

string (date-time)

section disconnect date planned

sectionName

string

section name

usageId

integer

ID of section usage purpose. REQUIRED for circuit section and created if countOfSections is greater than 1.

usageStateId

integer

ID of section usage state

contractLength

integer

Circuit contract length for new or update circuit

contractNumber

string

circuit contract number for new or update circuit

customerId

integer

ID of customer related to circuit customer for new or update circuit

importanceId

integer

Internal ID of circuit importance information for new or update circuit

name

string

circuit identifier for new or update circuit

name2

string

circuit alternate identifier for new or update circuit

orderNumber

string

circuit order number for new or update circuit

organisationId

integer

Internal ID of circuit organisation information for new or update circuit

redundancyId

integer

Internal ID of circuit redundancy information for new or update circuit

addressId

integer

addressId with portId as search criteria for which automatic reservation is connected to new circuit.

countOfSections

integer

The number of sections to be created. 0 indicates no section level information to be created. Default of 1 if not provided.

deviceId

integer

deviceId with portName as alternative to PortId in search criteria.

logicalPhysicalReservations

boolean

indicates if port will be reserved only for physical reservations

logicalReservations

boolean

indicates if port will be reserved only for logical reservations

portId

integer

portId with addressId as search criteria for which automatic reservation is connected to new circuit.

portName

string

portName with deviceId as alternative to PortId in search criteria.

reservationDirection

integer

Direction in which reservation is ordered. Default of 1 if not provided. Available from product version 3.6.8. 1 - Ascending (Customer premise to Central office), 2 - Descending (Central office to Customer premise)

Valid values[ 1, 2 ]

sourceSystem

integer

alternative to addressId together with sourceSystemKey. Available from product version 3.6.3.

sourceSystemKey

integer

alternative to addressId together with sourceSystem. Available from product version 3.6.3.

premId

string Required

premiseId for connected port.

Responses

201

New Circuit with port, section and location. Section also has logical and physical reservations if there is a preconnected logical route.

[
  {
    "areaCode": "",
    "comments": "",
    "contractLength": null,
    "contractNumber": "100",
    "createdBy": "KEYCOM_STAGE",
    "createdTs": "2021-10-07",
    "customer": 2810,
    "directLength": null,
    "id": 293957,
    "identifier": "circuitName",
    "identifierAlt": "circuitOtherName",
    "importance": null,
    "installationAddresses": [
      {
        "apartment": 4289,
        "circuit": 293957,
        "id": 43305850,
        "installationType": 6410
      }
    ],
    "length": null,
    "orderNumber": "100",
    "organisation": null,
    "redundancy": null,
    "sections": [
      {
        "bitrate": 2850,
        "circuit": 293957,
        "connectionDate": null,
        "constructionState": 6050,
        "disconnectionDate": null,
        "id": 3508801,
        "name": "sectionName",
        "plannedConnectionDate": null,
        "plannedDisconnectionDate": null,
        "reservations": [
          {
            "logical": [
              {
                "address": 80750,
                "ccp": 1319590,
                "circuit": 293957,
                "connection": null,
                "details": "",
                "device": 21050,
                "hierarchy": null,
                "id": 2449550,
                "order": 1,
                "premises": 23610,
                "section": 3508801
              }
            ],
            "physical": [
              {
                "circuit": "https://keycom.example.com/api/v2/circuits/293957/",
                "circuitOrder": 1,
                "component": "1",
                "componentAttenuation": 0.5,
                "componentLength": null,
                "componentState": "Ready",
                "componentType": "connector",
                "container": "1",
                "containerId": 21050,
                "containerState": "",
                "containerType": "device",
                "section": "https://keycom.example.com/api/v2/sections/3508801/",
                "topContainer": "PUISTIKKOKATU 1",
                "topContainerState": "In use",
                "topContainerType": "telecom premises"
              }
            ]
          }
        ],
        "usagePurpose": 15050,
        "usageState": 6350
      }
    ],
    "updatedBy": "KEYCOM_STAGE",
    "updatedTs": "2021-10-07"
  }
]

Expand All

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

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

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 ]

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

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

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

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

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

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

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 ]

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

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

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

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

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

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

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

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

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 ]

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

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

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

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

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

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

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 ]

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

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

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

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

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

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

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

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

billingName

string

Customer billing name

businessId

string

Customer bussiness id

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

string

Customer email

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

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

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

directLength

number (float)

Circuit direct length

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

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

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

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

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

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

sections

Array of object (CircuitSection)

Circuit sections

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

disconnectionDate

string (date-time)

actual section disconnection date

integer

Primary key

name

string

Section name

plannedConnectionDate

string (date-time)

planned section connection date

plannedDisconnectionDate

string (date-time)

planned section disconnection date

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

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

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

errors

Array of object

Circuit list of errors when it is partially created

object

Fields which failed validation

code

string

Field error code

property*

Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

400

Bad Request

{
  "details": "Bad request syntax or unsupported method"
}

object

details

string

Detailed description of error

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

Delete work order