Create new splice
  • 28 Oct 2024
  • 3 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Create new splice

  • Dark
    Light
  • PDF

Article summary

Post
/splices/
Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Splice to be created

object

Information of a telecom splice object

address
integer

id of splice address apartments.

angle
integer

Angle. Available from product version 3.2.24

attenuation
integer

Attenuation. Available from product version 3.2.24

createdBy
string

Creator. Available from product version 3.2.24

createdTs
string (date-time)

Creation date time. Available from product version 3.2.24

heightAccuracy
integer

id of splice height accuracy. Available from product version 3.2.24

historyDate
string (date)

Mapping date. Available from product version 3.2.24

id
integer

Splice primary key

identification
string

Splice identification. Checked based on Identification Uniqueness Rule

installYear
integer

Install year. Available from product version 3.6.8.

location
string (ewkt)

Geographical location. Available from product version 3.2.24

locationAccuracy
integer

id of splice location accuracy. Available from product version 3.2.24

manhole
integer

id of splice manhole. Available from product version 3.2.24

mapper
string

Mapper. Available from product version 3.2.24

mappingMethod
integer

id of splice mapping method. Available from product version 3.2.24

owner
integer

Owner id. Available from product version 3.2.24

placement
integer

id of splice placement. Available from product version 3.2.24

plan
integer

id of splice plan

productName
integer

id of splice product name. Available from product version 3.2.24

remarks
string

Remarks. Available from product version 3.2.24

renter
integer

Renter id. Available from product version 3.2.24

safetyDistance
integer

Safety distance id. Available from product version 3.6.4.

scale
integer

Scale. Available from product version 3.2.24

survey_amount
string (number)

Survey amount. Available from product version 3.2.24

telecomArea
integer

id of splice telecom area. Available from product version 3.2.24

telecomPremise
integer

id of splice telecom premise. Available from product version 3.2.24

type
integer

id of telecom Splice type.

updatedBy
string

Last updater. Available from product version 3.2.24

updatedTs
string (date-time)

Last update date time. Available from product version 3.2.24

usageState
integer

id of splice usage state. Available from product version 3.2.24

Responses
201

A created Splice

{
  "address": null,
  "angle": null,
  "attenuation": null,
  "createdBy": "user",
  "createdTs": "2022-10-13T11:23:07Z",
  "heightAccuracy": null,
  "historyDate": null,
  "id": 238730,
  "identification": "ABCDEX",
  "installYear": 2023,
  "location": null,
  "locationAccuracy": null,
  "manhole": null,
  "mapper": "",
  "mappingMethod": null,
  "owner": null,
  "placement": null,
  "plan": null,
  "productName": null,
  "remarks": "",
  "renter": null,
  "scale": null,
  "survey_amount": "",
  "telecomArea": null,
  "telecomPremise": null,
  "type": 379790,
  "updatedBy": "user",
  "updatedTs": "2022-10-13T11:23:07Z",
  "usageState": 380090
}
object

Information of a telecom splice object

address
integer

id of splice address apartments.

angle
integer

Angle. Available from product version 3.2.24

attenuation
integer

Attenuation. Available from product version 3.2.24

createdBy
string

Creator. Available from product version 3.2.24

createdTs
string (date-time)

Creation date time. Available from product version 3.2.24

heightAccuracy
integer

id of splice height accuracy. Available from product version 3.2.24

historyDate
string (date)

Mapping date. Available from product version 3.2.24

id
integer

Splice primary key

identification
string

Splice identification. Checked based on Identification Uniqueness Rule

installYear
integer

Install year. Available from product version 3.6.8.

location
string (ewkt)

Geographical location. Available from product version 3.2.24

locationAccuracy
integer

id of splice location accuracy. Available from product version 3.2.24

manhole
integer

id of splice manhole. Available from product version 3.2.24

mapper
string

Mapper. Available from product version 3.2.24

mappingMethod
integer

id of splice mapping method. Available from product version 3.2.24

owner
integer

Owner id. Available from product version 3.2.24

placement
integer

id of splice placement. Available from product version 3.2.24

plan
integer

id of splice plan

productName
integer

id of splice product name. Available from product version 3.2.24

remarks
string

Remarks. Available from product version 3.2.24

renter
integer

Renter id. Available from product version 3.2.24

safetyDistance
integer

Safety distance id. Available from product version 3.6.4.

scale
integer

Scale. Available from product version 3.2.24

survey_amount
string (number)

Survey amount. Available from product version 3.2.24

telecomArea
integer

id of splice telecom area. Available from product version 3.2.24

telecomPremise
integer

id of splice telecom premise. Available from product version 3.2.24

type
integer

id of telecom Splice type.

updatedBy
string

Last updater. Available from product version 3.2.24

updatedTs
string (date-time)

Last update date time. Available from product version 3.2.24

usageState
integer

id of splice usage state. Available from product version 3.2.24

400

There was an error in request. Usually field validation failed.

{
  "state": [
    "This field is required."
  ],
  "type": [
    "This field is required."
  ]
}
object

Fields which failed validation

property*
Array of string additionalProperties

List of validation errors for this fieldname

string

Validation 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