API docs by Redocly

Edison Next Panorama - Integration API (0.9.2)

Download OpenAPI specification:

API Support: support@panorama.edisonnext.it License: © 2025 - 2030 Copyright Edison Next Spa. All rights reserved

API standard di integrazione di Edison Next Panorama con sistemi esterni

Edison Next Panorama - Specifiche di Integrazione v.1.0

Data Source

operations for data sources

Restituisce le fonti dati disponibili

Authorizations:
panorama_consumer_api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Aggiunge una Fonte Dati (admin only)

Authorizations:
panorama_administrator_api_key
Request Body schema: application/json
required
id
required
string <uri>

ID univoco della Fonte Dati

name
required
string

Nome canonico della Fonte Dati

internal
required
boolean
Default: false

Indica se la fonte dati è nativa della piattaforma o meno

organization
required
string

Organizzazione di riferimento (ovvero soggetto alimentante) per la Fonte Dati

processor
string

Organizzazione che gestisce tecnicamente la Fonte Dati

Responses

Request samples

Content type
application/json
{
  • "id": "fvg_ispfor_tsgo",
  • "name": "Ministero per i Beni e le Attività Culturali",
  • "internal": false,
  • "organization": "Ministero per i Beni e le Attività Culturali",
  • "processor": "Insiel S.p.A."
}

Modifica una sorgente dati esistente (admin only)

Authorizations:
panorama_administrator_api_key
path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string <uri>

ID univoco della Fonte Dati

name
required
string

Nome canonico della Fonte Dati

internal
required
boolean
Default: false

Indica se la fonte dati è nativa della piattaforma o meno

organization
required
string

Organizzazione di riferimento (ovvero soggetto alimentante) per la Fonte Dati

processor
string

Organizzazione che gestisce tecnicamente la Fonte Dati

Responses

Request samples

Content type
application/json
{
  • "id": "fvg_ispfor_tsgo",
  • "name": "Ministero per i Beni e le Attività Culturali",
  • "internal": false,
  • "organization": "Ministero per i Beni e le Attività Culturali",
  • "processor": "Insiel S.p.A."
}

Elimina una sorgente dati (vuota) esistente (admin only)

Authorizations:
panorama_administrator_api_key
path Parameters
id
required
string

Responses

Type

operations for data types

Restituisce i Tipi di Entità definiti

Authorizations:
panorama_consumer_api_key

Responses

Response samples

Content type
application/json
[]

Crea un nuovo Tipo di Entità (admin only)

Authorizations:
panorama_administrator_api_key
Request Body schema: application/json
required
id
required
string <uri>

Identificativo univoco del Tipo di Entità

name
required
string

Nome canonico del Tipo di Entità

native
boolean
Default: false

Se il Tipo è nativo di piattaforma o importato

object (State)

Definisce una possibile rappresentazione della situazione attuale nel «divenire» delle Entità di un certo Tipo

syntax
required
string <json>

Definizione (JSON-LD) della sintassi del Tipo di Entità

object (Terminology)

Nomenclatura di riferimento per i Tipi di Entità. Può essere interna o esterna (schema.gov.it, UCUM, Google Knowledge Graph)

uri
string <uri>

URI autoritativo del Tipo (se non nativo)

Responses

Request samples

Content type
application/json
{}

Restituisce un singolo Tipo di Entità

Authorizations:
panorama_consumer_api_key
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{}

Modifica un Tipo esistente (admin only)

Authorizations:
panorama_administrator_api_key
path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string <uri>

Identificativo univoco del Tipo di Entità

name
required
string

Nome canonico del Tipo di Entità

native
boolean
Default: false

Se il Tipo è nativo di piattaforma o importato

object (State)

Definisce una possibile rappresentazione della situazione attuale nel «divenire» delle Entità di un certo Tipo

syntax
required
string <json>

Definizione (JSON-LD) della sintassi del Tipo di Entità

object (Terminology)

Nomenclatura di riferimento per i Tipi di Entità. Può essere interna o esterna (schema.gov.it, UCUM, Google Knowledge Graph)

uri
string <uri>

URI autoritativo del Tipo (se non nativo)

Responses

Request samples

Content type
application/json
{}

Elimina un Tipo (senza istanze di elementi) esistente (admin only)

Authorizations:
panorama_administrator_api_key
path Parameters
id
required
string

Responses

Restituisce le Nomenclature definite

Authorizations:
panorama_consumer_api_key

Responses

Response samples

Content type
application/json
[]

Crea una nuova Nomenclatura (admin only)

Authorizations:
panorama_administrator_api_key
Request Body schema: application/json
required
id
required
string <uri>

Identificativo univoco della Nomenclatura (terminology)

name
required
string

Nome canonico della Nomenclatura

description
string

Descrizione della Nomenclatura

documentation
string <uri>

Link alla documentazione della Nomenclatura

subject
string

Soggetto titolare del Tipo

uri
string <uri>

URI autoritativa della Nomenclatura

Responses

Request samples

Content type
application/json
{}

Restituisce una singola Nomenclatura

Authorizations:
panorama_consumer_api_key
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{}

Modifica una Nomenclatura esistente (admin only)

Authorizations:
panorama_administrator_api_key
path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string <uri>

Identificativo univoco della Nomenclatura (terminology)

name
required
string

Nome canonico della Nomenclatura

description
string

Descrizione della Nomenclatura

documentation
string <uri>

Link alla documentazione della Nomenclatura

subject
string

Soggetto titolare del Tipo

uri
string <uri>

URI autoritativa della Nomenclatura

Responses

Request samples

Content type
application/json
{}

Elimina una Nomenclatura (senza riferimenti in qualche tipo) esistente (admin only)

Authorizations:
panorama_administrator_api_key
path Parameters
id
required
string

Responses

Entity

operations to browse and manage entities

Ricerca di entità

Authorizations:
panorama_consumer_api_key
query Parameters
type
string

Filter by entity type

catalog
string

Filter by data catalog

state
string

Filter by entity state

Responses

Response samples

Content type
application/json
[]

Crea una nuova entità

Authorizations:
panorama_provider_api_key
Request Body schema: application/json
required
id
required
string

ID univoco dell'Entità sulla piattaforma

name
string

Nome canonico dell'Entità sulla piattaforma

object

Coordinate geografiche dell'Entità

required
object (Type)

Tipi di entità, comprensivi di riferimento al nomenclatore e definizione della struttura del payload specifico

parent
object (Entity) Recursive

rappresenta un generico oggetto urbano, è di uno specifico Tipo, afferisce a una Sorgente Dati, ha uno Stato dinamico, è dotato di proprietà type-specific, può avere un Device associato, è tipicamente geo-localizzabile

required
object (Source)

Fonte dati, interna o esterna, relativa a un soggetto alimentante

externalId
string

Identificativo dell'Entità nel sistema sorgente

object

Stato dell'entità

object

Attributi personalizzati in base al tipo di entità

object (Device)

Device associato all'entità

createdDate
required
string <date-time>

Data e ora di creazione dell'entità (timestamp ISO 8601)

updatedDate
required
string <date-time>

Data e ora dell'ultima modifica all'entità, escluse le modifiche di stato (timestamp ISO 8601)

Responses

Request samples

Content type
application/json
{}

Ottiene una singola entità

Authorizations:
panorama_consumer_api_key
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{}

Modifica un'entità esistente (escluso lo stato)

Authorizations:
panorama_provider_api_key
path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string

ID univoco dell'Entità sulla piattaforma

name
string

Nome canonico dell'Entità sulla piattaforma

object

Coordinate geografiche dell'Entità

required
object (Type)

Tipi di entità, comprensivi di riferimento al nomenclatore e definizione della struttura del payload specifico

parent
object (Entity) Recursive

rappresenta un generico oggetto urbano, è di uno specifico Tipo, afferisce a una Sorgente Dati, ha uno Stato dinamico, è dotato di proprietà type-specific, può avere un Device associato, è tipicamente geo-localizzabile

required
object (Source)

Fonte dati, interna o esterna, relativa a un soggetto alimentante

externalId
string

Identificativo dell'Entità nel sistema sorgente

object

Stato dell'entità

object

Attributi personalizzati in base al tipo di entità

object (Device)

Device associato all'entità

createdDate
required
string <date-time>

Data e ora di creazione dell'entità (timestamp ISO 8601)

updatedDate
required
string <date-time>

Data e ora dell'ultima modifica all'entità, escluse le modifiche di stato (timestamp ISO 8601)

Responses

Request samples

Content type
application/json
{}

Elimina un'entità

Authorizations:
panorama_provider_api_key
path Parameters
id
required
string

Responses

Modifica lo stato di un'Entità

Authorizations:
panorama_provider_api_key
path Parameters
id
required
string
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Ottiene la storia delle variazioni di stato di un'Entità

Authorizations:
panorama_consumer_api_key
path Parameters
id
required
string

l'ID dell'entità di cui ottenere la storia

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Device

Operations about Devices

Elenco di tutti i dispositivi

Authorizations:
panorama_consumer_api_key

Responses

Response samples

Content type
application/json
[]

Ottiene informazioni su un singolo dispositivo

Authorizations:
panorama_consumer_api_key
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{}