Skip to content

Data Source

Definition

Une DataSource correspond à une MemoryBase Braincube.

Utilisation dans une requête

Attributes

Name Type Required Description
name String true Nom de la DataSource

JSON example

Exemple de document JSON pour une DataSource utilisée en paramètre d'une requête (entrée) :

// DataSource correspondant à la MemoryBase mb1 de Braincube.
{
    "name" : "mb1",
}

Utilisation dans une réponse

Une DataSource en résultat d'un webservice (sortie) peut être représentée sous trois formes différentes :

  • Simple
  • Full
  • Extended

Vue Simple

La vue Simple d'une DataSource présente les identifiants des variables de la MemoryBase.

Attributes

Name Type Required Description
name String true Nom de la DataSource
order String true Identifiant de la variable d'ordre
datadefs Array(String) true Liste des identifiants des variables de la DataSource

JSON example

{
  "name": "mb1",
  "order": "mb1/d1000001",
  "datadefs": [
    "mb1/d1000006",
    "mb1/d1000028"
  ]
}

Vue Full

La vue Full d'une DataSource présente les variables de la MemoryBase avec leur définition basique.

Attributes

Name Type Required Description
name String true Nom de la DataSource
order String true Identifiant de la variable d'ordre
datadefs Array(Variable) true Liste des variables de la DataSource avec leur définition basique

JSON example

{
  "name": "mb1",
  "order": "mb1/d1000001",
  "datadefs": [
    {
      "id": "mb1/d1000006",
      "lf": {
        "id": "mb1/d1000006",
        "type": "NUMERIC",
        "rewriter": {
          "precision": 2
        },
        "reference": "mb1/d1000001",
        "context": {
          "dataSource": "mb1"
        },
        "definition": "d1000006"
      }
    },
    {
      "id": "mb1/d1000028",
      "lf": {
        "id": "mb1/d1000028",
        "type": "NUMERIC",
        "rewriter": {
          "precision": 2
        },
        "reference": "mb1/d1000001",
        "context": {
          "dataSource": "mb1"
        },
        "definition": "d1000028"
      }
    }]
}

Vue Extended

La vue Extended d'une DataSource présente les variables de la MemoryBase avec leur définition étendue.

Attributes

Name Type Required Description
name String true Nom de la DataSource
order String true Identifiant de la variable d'ordre
datadefs Array(Variable) true Liste des variables de la DataSource avec leur définition étendue

JSON

{
  "name": "mb1",
  "order": "mb1/d10000123",
  "datadefs": [
    {
      "id": "mb1/d10000216",
      "lf": {
        "id": "mb1/d10000216",
        "type": "DISCRET",
        "reference": "mb1/d10000453",
        "context": {
          "dataSource": "mb1"
        },
        "definition": "d10000216"
      },
      "tag": "tag1",
      "local": "Local 1",
      "standard": "Local 1 - tag1",
      "digits": 2
    },
    {
      "id": "mb1/d10000215",
      "lf": {
        "id": "mb1/d10000215",
        "type": "DISCRET",
        "reference": "mb1/d10000453",
        "context": {
          "dataSource": "mb1"
        },
        "definition": "d10000215"
      },
      "tag": "tag2",
      "local": "Local 2",
      "standard": "Local 2 - tag2",
      "digits": 2
    }]
}