Metavault API - Get information mart list

GetInformationMarts - GET

Path

/api/projects/{projectId}/informationmarts

Http Method

GET

Overview

Required permissions

  • Read access to the Distribute module. Distribute read

Request

Query parameters

See: Metavault API - General concepts for collection query parameters.

Response

Success response (200 OK)

JSON
{
  "_embedded": {
    "informationMarts": [
      {
        "_embedded": {
          "informationMartScripts": [
            {
              "_embedded": {
                "columns": [
                  {
                    "name": "col1",
                    "id": "0173d421-59fe-454a-a430-44594962bebc",
                    "informationMartId": "703a749d-37a2-4062-a3f9-3c283090fc92",
                    "informationMartScriptId": "8d12dd1d-a27e-4bdd-b4de-a500ac1d5639",
                    "comment": "the first column",
                    "softRule": "SOFT_RULE",
                    "sourceColumns": [
                      {
                        "id": "479587d8-1c8d-4259-bfd9-150b0010fb18",
                        "informationMartId": "703a749d-37a2-4062-a3f9-3c283090fc92",
                        "informationMartScriptId": "8d12dd1d-a27e-4bdd-b4de-a500ac1d5639",
                        "informationMartScriptColumnId": "0173d421-59fe-454a-a430-44594962bebc",
                        "entityType": "Hub",
                        "entityName": "h_Team",
                        "columnName": "bk"
                      },
                      {
                        "id": "434a2e29-dc5f-4517-ab86-75f7468435a6",
                        "informationMartId": "703a749d-37a2-4062-a3f9-3c283090fc92",
                        "informationMartScriptId": "8d12dd1d-a27e-4bdd-b4de-a500ac1d5639",
                        "informationMartScriptColumnId": "0173d421-59fe-454a-a430-44594962bebc",
                        "entityType": "Satellite",
                        "entityName": "sh_Employee_info",
                        "columnName": "hdiff"
                      }
                    ]
                  },
                  {
                    "name": "col2",
                    "id": "0eaac712-c4a3-409b-9976-cbc5c8d8aa5f",
                    "informationMartId": "703a749d-37a2-4062-a3f9-3c283090fc92",
                    "informationMartScriptId": "8d12dd1d-a27e-4bdd-b4de-a500ac1d5639",
                    "comment": "oh ok",
                    "softRule": "terrence",
                    "sourceColumns": [
                      {
                        "id": "b00207e7-c632-478a-9696-d5fd7a54c786",
                        "informationMartId": "703a749d-37a2-4062-a3f9-3c283090fc92",
                        "informationMartScriptId": "8d12dd1d-a27e-4bdd-b4de-a500ac1d5639",
                        "informationMartScriptColumnId": "0eaac712-c4a3-409b-9976-cbc5c8d8aa5f",
                        "entityType": "Satellite",
                        "entityName": "sh_Team_info",
                        "columnName": "lead"
                      }
                    ]
                  }
                ]
              },
              "name": "HMA1",
              "id": "8d12dd1d-a27e-4bdd-b4de-a500ac1d5639",
              "informationMartId": "703a749d-37a2-4062-a3f9-3c283090fc92",
              "businessDescription": "",
              "technicalDescription": "",
              "tableName": "",
              "typeTag": "Custom",
              "order": 1,
              "timeout": 60,
              "code": "DROP VIEW script_view_hma1 ..; CREATE VIEW script_view_2"
            },
            {
              "_embedded": {
                "columns": []
              },
              "name": "HMA2",
              "id": "be3da312-1a72-422a-bccb-9ef9a0743fe5",
              "informationMartId": "703a749d-37a2-4062-a3f9-3c283090fc92",
              "businessDescription": "",
              "technicalDescription": "",
              "tableName": "",
              "typeTag": "Custom",
              "order": 1,
              "timeout": 60,
              "code": "DROP VIEW script_view_hma2 ..; CREATE VIEW script_view_2"
            }
          ]
        },
        "name": "HMA",
        "id": "703a749d-37a2-4062-a3f9-3c283090fc92",
        "entityType": "InformationMart",
        "schema": "stg",
        "prefix": "impre1",
        "scriptsCount": 2,
        "snapshotId": "bdc559dd-bf03-4e1c-b2b8-c724b80da1d3"
      }
    ]
  },
  "sort": [],
  "index": 0,
  "limit": 10,
  "expand": [],
  "total": 1
}