Cocon Fiber Sync API (v1)

Download OpenAPI specification:Download

License: Proprietary

The Cocon Fiber Sync API enables synchronization of asset data between Cocon Fiber and external systems.

The Since parameter can be used to specify from which point in time the changes should be returned.

Asset synchronization

Get changes on access points

Returns changes (new, updated and deleted) on access points since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since	string <date-time> Example: since=2024-02-10T15:45:00Z A specific point in time (date & time) The point of time should be in the past
offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"type": {"id": "string",
"href": "string"
},
"stage": 0,
"project": {"id": "string",
"href": "string"
},
"address": {"property1": "string",
"property2": "string"
},
"depth": 0.1,
"installationDetails": {"date": "2019-08-24",
"installationCompany": "string"
},
"remarks": "string",
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [0,
0
]
},
"ductRoutes": [{"id": "string",
"href": "string"
}
]
}
],
"deletes": ["string"
]
}

Get changes on buildings

Returns changes (new, updated and deleted) on buildings since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since	string <date-time> Example: since=2024-02-10T15:45:00Z A specific point in time (date & time) The point of time should be in the past
offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"complex": {"id": "string",
"href": "string"
},
"type": {"id": "string",
"href": "string"
},
"name": "string",
"stage": 0,
"project": {"id": "string",
"href": "string"
},
"address": {"property1": "string",
"property2": "string"
},
"remarks": "string",
"installationDetails": {"date": "2019-08-24",
"installationCompany": "string"
},
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
]
},
"ductRoutes": [{"id": "string",
"href": "string"
}
],
"additionalInformation": {"property1": "string",
"property2": "string"
}
}
],
"deletes": ["string"
]
}

Get changes on cables

Returns changes (new, updated and deleted) on cables since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since	string <date-time> Example: since=2024-02-10T15:45:00Z A specific point in time (date & time) The point of time should be in the past
offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"type": {"id": "string",
"href": "string"
},
"project": {"id": "string",
"href": "string"
},
"innerducts": [{"ductReference": {"id": "string",
"href": "string"
},
"name": "string",
"color": "string",
"diameter": 0,
"owner": "string"
}
],
"endpoints": [{"id": "string",
"href": "string",
"cableEndpointType": "Frame"
}
],
"cableSegments": [{"type": "Cable",
"length": 0.1,
"geometry": {"type": "Point",
"bbox": [0
]
}
}
],
"stage": 0,
"installationDetails": {"date": "2019-08-24",
"installationCompany": "string"
},
"operator": "string",
"remarks": "string",
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [[0,
0
],
[0,
0
]
]
}
}
],
"deletes": ["string"
]
}

Get changes on drillings

Returns changes (new, updated and deleted) on drillings since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since	string <date-time> Example: since=2024-02-10T15:45:00Z A specific point in time (date & time) The point of time should be in the past
offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"type": {"id": "string",
"href": "string"
},
"stage": 0,
"project": {"id": "string",
"href": "string"
},
"length": 0,
"owner": "string",
"remarks": "string",
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [[0,
0
],
[0,
0
]
]
}
}
],
"deletes": ["string"
]
}

Get changes on ducts

Returns changes (new, updated and deleted) on ducts since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since	string <date-time> Example: since=2024-02-10T15:45:00Z A specific point in time (date & time) The point of time should be in the past
offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"type": {"id": "string",
"href": "string"
},
"color": "string",
"owner": "string",
"diameter": 0,
"stage": 0,
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [[0,
0
],
[0,
0
]
]
},
"length": 0,
"innerducts": [{"name": "string",
"color": "string",
"owner": "string",
"diameter": 0,
"duct": {"id": "string",
"href": "string"
},
"cable": {"id": "string",
"href": "string",
"type": "string"
},
"project": {"id": "string",
"href": "string"
}
}
],
"numberOfAvailableInnerducts": 0,
"remarks": "string",
"project": {"id": "string",
"href": "string"
},
"ductRoute": {"id": "string",
"href": "string"
},
"locations": [{"id": "string",
"href": "string",
"type": "Unknown"
}
]
}
],
"deletes": ["string"
]
}

Get changes on enclosures

Returns changes (new, updated and deleted) on enclosures since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since	string <date-time> Example: since=2024-02-10T15:45:00Z A specific point in time (date & time) The point of time should be in the past
offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"location": {"id": "string",
"href": "string",
"locationType": "Unknown"
},
"type": {"id": "string",
"href": "string"
},
"project": {"id": "string",
"href": "string"
},
"stage": 0,
"installationDetails": {"date": "2019-08-24",
"installationCompany": "string"
},
"remarks": "string",
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [0,
0
]
}
}
],
"deletes": ["string"
]
}

Get changes on frames

Returns changes (new, updated and deleted) on frames since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since	string <date-time> Example: since=2024-02-10T15:45:00Z A specific point in time (date & time) The point of time should be in the past
offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"location": {"id": "string",
"href": "string",
"locationType": "Unknown"
},
"type": {"id": "string",
"href": "string"
},
"project": {"id": "string",
"href": "string"
},
"stage": 0,
"installationDetails": {"date": "2019-08-24",
"installationCompany": "string"
},
"remarks": "string",
"geometry": {"type": "Point",
"bbox": [0
]
}
}
],
"deletes": ["string"
]
}

Get changes on patch positions

Returns changes (new, updated and deleted) on patch positions since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since	string <date-time> Example: since=2024-02-10T15:45:00Z A specific point in time (date & time) The point of time should be in the past
offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"terminationUnit": {"id": "string",
"href": "string"
},
"trayNumber": 0,
"trayLabel": "string",
"position": 0,
"connectorType": "string",
"fiberConnections": [{"fiber": {"id": "string",
"href": "string"
},
"project": {"id": "string",
"href": "string"
},
"stage": 0,
"attenuation": 0.1
}
]
}
],
"deletes": ["string"
]
}

Get changes on permits

Returns changes (new, updated and deleted) on permits since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since	string <date-time> Example: since=2024-02-10T15:45:00Z A specific point in time (date & time) The point of time should be in the past
offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"issuer": "string",
"issuerType": "string",
"project": {"id": "string",
"href": "string"
},
"remarks": "string",
"geometry": {"type": "Point",
"bbox": [0
]
}
}
],
"deletes": ["string"
]
}

Get changes on projects

Returns changes (new, updated and deleted) on projects since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since	string <date-time> Example: since=2024-02-10T15:45:00Z A specific point in time (date & time) The point of time should be in the past
offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": null,
"description": "string",
"type": "string",
"locked": true,
"defaultInstallationCompany": "string",
"progressStatus": "string"
}
],
"deletes": ["string"
]
}

Get changes on splice trays

Returns changes (new, updated and deleted) on splice trays since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"type": {"id": "string",
"href": "string"
},
"spliceTrayContainer": {"id": "string",
"href": "string",
"position": 0,
"side": "string",
"type": "Unknown"
},
"splicePositions": [{"position": 0,
"fiber": {"id": "string",
"href": "string"
},
"stage": 0
}
]
}
],
"deletes": ["string"
]
}

Get changes on termination units

Returns changes (new, updated and deleted) on termination units since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"frame": {"id": "string",
"href": "string",
"position": 0
},
"type": {"id": "string",
"href": "string"
},
"project": {"id": "string",
"href": "string"
},
"stage": 0,
"installationDetails": {"date": "2019-08-24",
"installationCompany": "string"
}
}
],
"deletes": ["string"
]
}

Asset type synchronization

Get changes on access point types

Returns changes (new, updated and deleted) on access point types since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"isAllowed": true,
"maximumEnclosures": 0
}
],
"deletes": ["string"
]
}

Get changes on building types

Returns changes (new, updated and deleted) on building types since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": [ ],
"name": "string",
"isAllowed": true
}
],
"deletes": ["string"
]
}

Get changes on cable types

Returns changes (new, updated and deleted) on cable types since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"medium": 0,
"layout": "string",
"color": "string",
"remarks": "string",
"diameter": 0,
"numberOfFibers": 0,
"isAllowed": true,
"numberOfTubes": 0,
"tubes": [{"number": 0,
"color": "string",
"fibers": [{"number": 0,
"color": "string",
"type": {"id": "string",
"href": "string"
}
}
]
}
]
}
],
"deletes": ["string"
]
}

Get changes on drilling types

Returns changes (new, updated and deleted) on drilling types since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"isAllowed": true
}
],
"deletes": ["string"
]
}

Get changes on duct types

Returns changes (new, updated and deleted) on duct types since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"isAllowed": true,
"remarks": "string"
}
],
"deletes": ["string"
]
}

Get changes on enclosure types

Returns changes (new, updated and deleted) on enclosure types since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"isAllowed": true,
"maximumSpliceTrays": 0,
"numberOfSpliceTrayPositions": 0
}
],
"deletes": ["string"
]
}

Get changes on fiber types

Returns changes (new, updated and deleted) on fiber types since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"attenuation": {"nm1310": 0,
"nm1550": 0,
"nm1625": 0
},
"chromaticDispersion": {"nm1310": 0,
"nm1550": 0,
"nm1625": 0
},
"isAllowed": true
}
],
"deletes": ["string"
]
}

Get changes on frame types

Returns changes (new, updated and deleted) on frame types since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"isAllowed": true,
"numberOfRackUnits": 0,
"numberingDirection": "string",
"numberingStartsAt": 0
}
],
"deletes": ["string"
]
}

Get changes on project types

Returns changes (new, updated and deleted) on project types since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"isAllowed": true
}
],
"deletes": ["string"
]
}

Get changes on splice tray types

Returns changes (new, updated and deleted) on splice tray types since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"numberOfSplicePositions": 0,
"heightInSpliceTrayPositions": 0,
"numberOfTrays": 0,
"isAllowed": true
}
],
"deletes": ["string"
]
}

Get changes on termination unit types

Returns changes (new, updated and deleted) on termination unit types since a given timestamp

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

since

string <date-time>

Example: since=2024-02-10T15:45:00Z

A specific point in time (date & time) The point of time should be in the past

Responses

Response samples

200
401
403
500

Content type

application/json

{"upserts": [{"id": "string",
"name": "string",
"heightInRackUnits": 0,
"maximumCables": 0,
"width": 0,
"isAllowed": true
}
],
"deletes": ["string"
]
}