Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Referencer

...

Reference

...

Titel

...

Forfatter

...

Version

...

D0180

...

D0180 – Integrationsdesign

...

Sune Rievers

...

0.1

...

D0130

...

D0130 – Logisk datamodel – Metadata

...

Theis Klement Søe-Pedersen

...

0.1

Indholdsfortegnelse

Table of Contents

...

Dette dokument har til formål at beskrive JSON strukturen, der udstilles af Jobindsats datamodel API’et. Der henvises til D0180 Jobindsats – Integrationsdesign for en beskrivelse af grænsefladerne og til D0130 – Jobindsats - Logisk datamodel - Metadata for en detaljeret beskrivelse af reglerne for udtræk af data fra metadatamodellen.

...

JSON: ​Api​/DatabankElementPage

{

  "maalingId": "string",

  "cubeId": "string",

  "footnote": "string",

  "dataSourceTexts": [

    "string"

  ],

  "updateInfo": {

    "lastUpdate": "Datetime",

    "nextUpdate": "Datetime"

  },

  "periodes": [

    {

      "displayName": "string",

      "year": "int",

      "period": "string",

      "periodType": "string",

      "taller": "int"

    }

  ],

  "mGroups": [

    {

      "displayName": "string",

      "footnote": "string",

      "mgroupID": "string",

      "mgroupCount": "int"

    }

  ],

  "maalingHierarchiesContainer": [

    {

      "displayName": "string",

      "footnote": "string",

      "hierarchyId": "string",

      "dimensionId": "string",

      "required": "boolean",

      "selectable": "boolean",

      "hierarchies": [

        {

          "hrchyId": "string",

          "name": "string",

          "children": [

            null

          ]

        }

      ]

    }

  ]

}

JSON: API/DatabankTemaPage

{

    "maalingId": "string",

    "updateInfo": {

        "lastUpdate": "Datetime",

        "nextUpdate": "Datetime"

    },

    "period": {

        "firstAndLast": [

            "string"

        ],

        "types": [

            "string"

        ]

    },

    "updateFreq": "string",

    "area": {

        "wholeCountry": "boolean",

        "areas": [

            "string"

        ]

    },

    "mGroups": [

        "string"

    ],

    "dimensions": [

        "string"

    ]

}

JSON: API/getdata

POST objekt:

{

    "DataParameterObject": {

        "type": "object",

        "properties": {

            "cube": {

                "type": "string",

                "description": "The Cube for which the maaling is located, can be any string",

                "nullable": true

            },

            "period": {

                "type": "string",

                "description": "Period - must be valid Json or null",

                "nullable": true

            },

            "area": {

                "type": "string",

                "description": "Area - must be valid Json or null",

                "nullable": true

            },

            "measure": {

                "type": "string",

                "description": "Measure - must be valid Json or null",

                "nullable": true

            },

            "dimension": {

                "type": "string",

                "description": "Dimension - must be valid Json or null",

                "nullable": true

            },

            "dim1": {

                "type": "string",

                "description": "Dim1 - must be valid Json or null",

                "nullable": true

            },

            "dim2": {

                "type": "string",

                "description": "Dim2 - must be valid Json or null",

                "nullable": true

            },

            "dim3": {

                "type": "string",

                "description": "Dim3 - must be valid Json or null",

                "nullable": true

            },

            "dim4": {

                "type": "string",

                "description": "Dim4 - must be valid Json or null",

                "nullable": true

            },

            "dim5": {

                "type": "string",

                "description": "Dim5 - must be valid Json or null",

                "nullable": true

            },

            "dim6": {

                "type": "string",

                "description": "Dim6 - must be valid Json or null",

                "nullable": true

            },

            "dim7": {

                "type": "string",

                "description": "Dim7 - must be valid Json or null",

                "nullable": true

            },

            "dim8": {

                "type": "string",

                "description": "Dim8 - must be valid Json or null",

                "nullable": true

            }

        }

    }

}

Responseobjekt:

Caching

For at optimere hastighed på loads fra metadatadatabasen (og views) er der oprettet caching på data til databank temasider samt elementsider.

...

Hvis der opstår en fejl i processen med at fortolke de hierarkier som benyttes til visning. Hvis der er tale om fejl som automatisk kan rettes (se eksempel på fejl i D0130 Jobindsats - Logisk datamodel) vil der i logen indføres en tekst som denne:

2021-12-22 15:07:46.453 +01:00 [INF] Parent with hierarchy id /50/ were automatically found for child with hierarchy id /50/1000/2/

System.Collections.Generic.KeyNotFoundException: The given key '/50/1000/' was not present in the dictionary.

   at System.Collections.Generic.Dictionary`2.get_Item(TKey key)

   at Jobindsats.Datamart.Service.API.Controllers.ApiController.AddChildNodesToParents(IEnumerable`1 hierarchy) in C:\Users\rvso\source\repos\SFARJOBIN\Jobindsats.Datamart.Service\Jobindsats.Datamart.Service.API\Controllers\ApiController.cs:line 408

Hvis der optræder en fejl som ikke automatisk kan rettes gemmes denne besked i loggen:

...