Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Datacomponents

Datacomponents hold configuration for dataplugins, and are the building blocks for constructing pipelines. One dataplugin may be referenced by many datacomponents, each with a different set of properties for the dataplugin settings. One pipeline may reference multiple datacomponents.

Objects

Datacomponent

Path Type Format Description
id String Version 4 UUID The datacomponent ID
created String ISO 8601 timestamp When the datacomponent was created
lastModified String ISO 8601 timestamp When the datacomponent was last modified
name String   The datacomponent name
dataPlugin String   Create / update with dataplugin fullyQualifiedName
properties Properties   The datacomponent properties, defined by the dataplugin settings 
{
  "id" : "269ed070-9bfb-4372-8d3f-ae4f7841b0ed",
  "created" : "2024-04-10T14:04:34.78166",
  "lastModified" : "2024-04-10T14:04:35.032637",
  "name" : "extractors/tap-matatika-sit",
  "properties" : { },
  "commands" : { },
  "dataPlugin" : "extractors/tap-matatika-sit--matatika",
  "_embedded" : {
    "dataplugin" : {
      "id" : "e654a6ba-ad71-46d9-b3d7-f5fc19c1924d",
      "pluginType" : "EXTRACTOR",
      "name" : "tap-matatika-sit",
      "namespace" : "tap_matatika_sit",
      "variant" : "matatika",
      "label" : "Matatika SIT",
      "description" : "Test extractor based on tap-spreadsheets-anywhere used during Matatika SIT runs",
      "logoUrl" : "/assets/images/datasource/tap-matatika-sit.svg",
      "hidden" : false,
      "docs" : "https://meltano.com/plugins/extractors/spreadsheets-anywhere.html",
      "pipUrl" : "git+https://github.com/ets/tap-spreadsheets-anywhere.git",
      "repo" : "https://github.com/ets/tap-spreadsheets-anywhere",
      "executable" : "tap-spreadsheets-anywhere",
      "capabilities" : [ "DISCOVER", "STATE", "CATALOG" ],
      "select" : [ ],
      "update" : { },
      "vars" : { },
      "settings" : [ {
        "name" : "tables",
        "aliases" : [ ],
        "label" : "Tables",
        "value" : "[{\"path\":\"https://raw.githubusercontent.com/Matatika/matatika-examples/master/example_data\",\"name\":\"gitflixusers\",\"pattern\":\"GitFlixUsers.csv\",\"start_date\":\"2021-01-01T00:00:00Z\",\"key_properties\":[\"id\"],\"format\":\"csv\"}]",
        "kind" : "ARRAY",
        "description" : "A setting in Matatika SIT that allows users to view and manage tables of data.",
        "protected" : false
      } ],
      "variants" : [ ],
      "commands" : { },
      "matatikaHidden" : true,
      "requires" : [ ],
      "fullDescription" : "Test extractor based on tap-spreadsheets-anywhere used during Matatika SIT runs\n\n## Settings\n\n\n### Tables\n\nA setting in Matatika SIT that allows users to view and manage tables of data.",
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/dataplugins/e654a6ba-ad71-46d9-b3d7-f5fc19c1924d"
        },
        "update dataplugin" : {
          "href" : "https://catalog.matatika.com/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/dataplugins/e654a6ba-ad71-46d9-b3d7-f5fc19c1924d",
          "type" : "PUT"
        }
      }
    }
  },
  "draft" : false,
  "managed" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    },
    "update datacomponent" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    },
    "delete datacomponent" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    }
  }
}

Properties

For each setting s in the dataplugin settings:

Path Type Description
s.name s.kind Refer to s.description

Requests

View all datacomponents in a workspace

GET

/api/workspaces/{workspace-id}/datacomponents

Returns all datacomponents in the workspace {workspace-id}.

Prerequisites

  • Workspace {workspace-id} must exist

Request

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/datacomponents' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/datacomponents"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Datacomponent collection with HAL links.

{
  "_embedded" : {
    "datacomponents" : [ {
      "id" : "5dfef712-d820-4750-8635-33c300bf41e6",
      "created" : "2024-04-10T14:04:33.240211",
      "lastModified" : "2024-04-10T14:04:33.240212",
      "name" : "Warehouse",
      "properties" : {
        "password" : "HKd7QK2n_6SM9hZfv_Xs19gD8g",
        "dbname" : "mhuukgw",
        "default_target_schema" : "analytics",
        "port" : "5432",
        "host" : "sharp-banana.postgres.database.azure.com",
        "user" : "mhuukgw"
      },
      "commands" : { },
      "dataPlugin" : "loaders/target-postgres--matatika",
      "_embedded" : {
        "dataplugin" : {
          "id" : "a82e2731-87e3-4fda-8c52-b43666de909a",
          "pluginType" : "LOADER",
          "name" : "target-postgres",
          "namespace" : "postgres_transferwise",
          "variant" : "matatika",
          "label" : "Postgres Warehouse",
          "description" : "Postgres Warehouse is a data warehousing solution built on top of the Postgres database management system.\n\nPostgres Warehouse is designed to handle large volumes of data and complex queries, making it an ideal solution for businesses that need to store and analyze large amounts of data. It provides a number of features that are specifically tailored to data warehousing, such as columnar storage, parallel processing, and support for advanced analytics. Additionally, Postgres Warehouse is highly scalable, allowing businesses to easily add more resources as their data needs grow. Overall, Postgres Warehouse is a powerful and flexible data warehousing solution that can help businesses make better decisions by providing them with the insights they need to succeed.\n### Prerequisites\nThe process of obtaining the required settings for connecting to a Postgres Warehouse may vary depending on the specific setup and configuration of the database. However, here are some general ways to obtain each of the required settings:\n\n- User: The user is typically created when the database is set up. You can ask the database administrator or check the database documentation to find out the username.\n- Password: The password is also typically created when the database is set up. You can ask the database administrator or check the database documentation to find out the password.\n- Host: The host is the server where the database is located. You can ask the database administrator or check the database documentation to find out the host name or IP address.\n- Port: The port is the number that the database listens on for incoming connections. The default port for Postgres is 5432, but it may be different depending on the configuration. You can ask the database administrator or check the database documentation to find out the port number.\n- Database Name: The database name is the name of the specific database you want to connect to. You can ask the database administrator or check the database documentation to find out the database name.\n- Default Target Schema: The default target schema is the schema that you want to use as the default when connecting to the database. This may be set up by the database administrator or you may need to create it yourself. You can ask the database administrator or check the database documentation to find out the default target schema.",
          "logoUrl" : "/assets/logos/loaders/postgres.png",
          "hidden" : false,
          "docs" : "https://www.matatika.com/data-details/target-postgres/",
          "pipUrl" : "git+https://github.com/Matatika/[email protected]",
          "repo" : "git+https://github.com/Matatika/[email protected]",
          "capabilities" : [ ],
          "select" : [ ],
          "update" : { },
          "vars" : { },
          "settings" : [ {
            "name" : "user",
            "aliases" : [ "username" ],
            "label" : "User",
            "kind" : "STRING",
            "description" : "The username used to connect to the Postgres Warehouse.",
            "required" : "true",
            "protected" : false
          }, {
            "name" : "password",
            "aliases" : [ ],
            "label" : "Password",
            "kind" : "PASSWORD",
            "description" : "The password used to authenticate the user.",
            "required" : "true",
            "protected" : false
          }, {
            "name" : "host",
            "aliases" : [ "address" ],
            "label" : "Host",
            "kind" : "STRING",
            "description" : "The hostname or IP address of the Postgres Warehouse server.",
            "required" : "true",
            "protected" : false
          }, {
            "name" : "port",
            "aliases" : [ ],
            "label" : "Port",
            "value" : "5432",
            "kind" : "INTEGER",
            "description" : "The port number used to connect to the Postgres Warehouse server.",
            "required" : "true",
            "protected" : false
          }, {
            "name" : "dbname",
            "aliases" : [ "database" ],
            "label" : "Database Name",
            "kind" : "STRING",
            "description" : "The name of the database to connect to.",
            "required" : "true",
            "protected" : false
          }, {
            "name" : "default_target_schema",
            "aliases" : [ ],
            "label" : "Default Target Schema",
            "value" : "analytics",
            "kind" : "STRING",
            "description" : "The default schema to use when writing data to the Postgres Warehouse.",
            "required" : "true",
            "protected" : false
          }, {
            "name" : "ssl",
            "aliases" : [ ],
            "label" : "SSL",
            "value" : "false",
            "kind" : "HIDDEN",
            "description" : "Whether or not to use SSL encryption when connecting to the Postgres Warehouse.",
            "protected" : false,
            "value_post_processor" : "STRINGIFY"
          }, {
            "name" : "batch_size_rows",
            "aliases" : [ ],
            "label" : "Batch Size Rows",
            "value" : "100000",
            "kind" : "INTEGER",
            "description" : "The number of rows to write to the Postgres Warehouse in each batch.",
            "protected" : false
          }, {
            "name" : "underscore_camel_case_fields",
            "aliases" : [ ],
            "label" : "Underscore Camel Case Fields",
            "value" : "true",
            "kind" : "HIDDEN",
            "description" : "Whether or not to convert field names from camel case to underscore-separated format.",
            "protected" : false
          }, {
            "name" : "flush_all_streams",
            "aliases" : [ ],
            "label" : "Flush All Streams",
            "value" : "false",
            "kind" : "HIDDEN",
            "description" : "Whether or not to flush all streams to the Postgres Warehouse before closing the connection.",
            "protected" : false
          }, {
            "name" : "parallelism",
            "aliases" : [ ],
            "label" : "Parallelism",
            "value" : "0",
            "kind" : "HIDDEN",
            "description" : "The number of threads to use when writing data to the Postgres Warehouse.",
            "protected" : false
          }, {
            "name" : "parallelism_max",
            "aliases" : [ ],
            "label" : "Max Parallelism",
            "value" : "16",
            "kind" : "HIDDEN",
            "description" : "The maximum number of threads to use when writing data to the Postgres Warehouse.",
            "protected" : false
          }, {
            "name" : "default_target_schema_select_permission",
            "aliases" : [ ],
            "label" : "Default Target Schema Select Permission",
            "kind" : "HIDDEN",
            "description" : "The permission level required to select data from the default target schema.",
            "protected" : false
          }, {
            "name" : "schema_mapping",
            "aliases" : [ ],
            "label" : "Schema Mapping",
            "kind" : "HIDDEN",
            "description" : "A mapping of source schema names to target schema names.",
            "protected" : false
          }, {
            "name" : "add_metadata_columns",
            "aliases" : [ ],
            "label" : "Add Metadata Columns",
            "value" : "true",
            "kind" : "HIDDEN",
            "description" : "Whether or not to add metadata columns to the target table.",
            "protected" : false
          }, {
            "name" : "hard_delete",
            "aliases" : [ ],
            "label" : "Hard Delete",
            "value" : "false",
            "kind" : "HIDDEN",
            "description" : "Whether or not to perform hard deletes when deleting data from the Postgres Warehouse.",
            "protected" : false
          }, {
            "name" : "data_flattening_max_level",
            "aliases" : [ ],
            "label" : "Data Flattening Max Level",
            "value" : "10",
            "kind" : "HIDDEN",
            "description" : "The maximum level of nested data structures to flatten when writing data to the Postgres Warehouse.",
            "protected" : false
          }, {
            "name" : "primary_key_required",
            "aliases" : [ ],
            "label" : "Primary Key Required",
            "value" : "false",
            "kind" : "BOOLEAN",
            "description" : "Whether or not a primary key is required for the target table.",
            "protected" : false
          }, {
            "name" : "validate_records",
            "aliases" : [ ],
            "label" : "Validate Records",
            "value" : "false",
            "kind" : "BOOLEAN",
            "description" : "Whether or not to validate records before writing them to the Postgres Warehouse.",
            "protected" : false
          }, {
            "name" : "temp_dir",
            "aliases" : [ ],
            "label" : "Temporary Directory",
            "kind" : "HIDDEN",
            "description" : "The directory to use for temporary files when writing data to the Postgres Warehouse.",
            "protected" : false
          } ],
          "variants" : [ ],
          "commands" : { },
          "matatikaHidden" : false,
          "requires" : [ ],
          "fullDescription" : "Postgres Warehouse is a data warehousing solution built on top of the Postgres database management system.\n\nPostgres Warehouse is designed to handle large volumes of data and complex queries, making it an ideal solution for businesses that need to store and analyze large amounts of data. It provides a number of features that are specifically tailored to data warehousing, such as columnar storage, parallel processing, and support for advanced analytics. Additionally, Postgres Warehouse is highly scalable, allowing businesses to easily add more resources as their data needs grow. Overall, Postgres Warehouse is a powerful and flexible data warehousing solution that can help businesses make better decisions by providing them with the insights they need to succeed.\n### Prerequisites\nThe process of obtaining the required settings for connecting to a Postgres Warehouse may vary depending on the specific setup and configuration of the database. However, here are some general ways to obtain each of the required settings:\n\n- User: The user is typically created when the database is set up. You can ask the database administrator or check the database documentation to find out the username.\n- Password: The password is also typically created when the database is set up. You can ask the database administrator or check the database documentation to find out the password.\n- Host: The host is the server where the database is located. You can ask the database administrator or check the database documentation to find out the host name or IP address.\n- Port: The port is the number that the database listens on for incoming connections. The default port for Postgres is 5432, but it may be different depending on the configuration. You can ask the database administrator or check the database documentation to find out the port number.\n- Database Name: The database name is the name of the specific database you want to connect to. You can ask the database administrator or check the database documentation to find out the database name.\n- Default Target Schema: The default target schema is the schema that you want to use as the default when connecting to the database. This may be set up by the database administrator or you may need to create it yourself. You can ask the database administrator or check the database documentation to find out the default target schema.\n\n## Settings\n\n\n### User\n\nThe username used to connect to the Postgres Warehouse.\n\n### Password\n\nThe password used to authenticate the user.\n\n### Host\n\nThe hostname or IP address of the Postgres Warehouse server.\n\n### Port\n\nThe port number used to connect to the Postgres Warehouse server.\n\n### Database Name\n\nThe name of the database to connect to.\n\n### Default Target Schema\n\nThe default schema to use when writing data to the Postgres Warehouse.\n\n### Batch Size Rows\n\nThe number of rows to write to the Postgres Warehouse in each batch.\n\n### Primary Key Required\n\nWhether or not a primary key is required for the target table.\n\n### Validate Records\n\nWhether or not to validate records before writing them to the Postgres Warehouse.",
          "_links" : {
            "self" : {
              "href" : "https://catalog.matatika.com/api/dataplugins/a82e2731-87e3-4fda-8c52-b43666de909a"
            },
            "update dataplugin" : {
              "href" : "https://catalog.matatika.com/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/dataplugins/a82e2731-87e3-4fda-8c52-b43666de909a",
              "type" : "PUT"
            }
          }
        }
      },
      "draft" : false,
      "managed" : true,
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/datacomponents/5dfef712-d820-4750-8635-33c300bf41e6"
        },
        "update datacomponent" : {
          "href" : "https://catalog.matatika.com/api/datacomponents/5dfef712-d820-4750-8635-33c300bf41e6"
        },
        "delete datacomponent" : {
          "href" : "https://catalog.matatika.com/api/datacomponents/5dfef712-d820-4750-8635-33c300bf41e6"
        }
      }
    }, {
      "id" : "9128c867-75d9-4c51-ab29-98ad323c1424",
      "created" : "2024-04-10T14:04:33.31889",
      "lastModified" : "2024-04-10T14:04:33.31889",
      "name" : "dbt",
      "properties" : { },
      "commands" : {
        "docs-generate" : {
          "args" : "docs generate",
          "description" : "Generate documentation artifacts for your project."
        },
        "seed" : {
          "args" : "seed",
          "description" : "Load data from csv files into your data warehouse."
        },
        "compile" : {
          "args" : "compile",
          "description" : "Generates executable SQL from source model, test, and analysis files. Compiled SQL files are written to the target/ directory."
        },
        "test" : {
          "args" : "test",
          "description" : "Runs tests on data in deployed models."
        },
        "run" : {
          "args" : "run",
          "description" : "Compile SQL and execute against the current target database."
        },
        "deps" : {
          "args" : "deps",
          "description" : "Pull the most recent version of the dependencies listed in packages.yml"
        },
        "clean" : {
          "args" : "clean",
          "description" : "Delete all folders in the clean-targets list (usually the dbt_modules and target directories.)"
        },
        "snapshot" : {
          "args" : "snapshot",
          "description" : "Execute snapshots defined in your project."
        }
      },
      "dataPlugin" : "transformers/dbt--dbt-labs",
      "_embedded" : {
        "dataplugin" : {
          "id" : "bf090a17-4b81-4ea6-8f9d-2e704c5fe169",
          "pluginType" : "TRANSFORMER",
          "name" : "dbt",
          "namespace" : "dbt",
          "variant" : "dbt-labs",
          "label" : "dbt",
          "logoUrl" : "/assets/images/transformer/dbt.png",
          "hidden" : false,
          "docs" : "https://www.matatika.com/data-details/dbt/",
          "pipUrl" : "dbt-core~=1.3.0 dbt-postgres~=1.3.0 dbt-snowflake~=1.3.0\n",
          "repo" : "https://github.com/dbt-labs/dbt-core",
          "capabilities" : [ ],
          "select" : [ ],
          "update" : { },
          "vars" : { },
          "settings" : [ {
            "name" : "project_dir",
            "aliases" : [ ],
            "value" : "$MELTANO_PROJECT_ROOT/transform",
            "kind" : "STRING",
            "protected" : false
          }, {
            "name" : "profiles_dir",
            "aliases" : [ ],
            "value" : "$MELTANO_PROJECT_ROOT/transform/profile",
            "kind" : "STRING",
            "env" : "DBT_PROFILES_DIR",
            "protected" : false
          }, {
            "name" : "target",
            "aliases" : [ ],
            "value" : "$MELTANO_LOAD__DIALECT",
            "kind" : "STRING",
            "protected" : false
          }, {
            "name" : "source_schema",
            "aliases" : [ ],
            "value" : "$MELTANO_LOAD__TARGET_SCHEMA",
            "kind" : "STRING",
            "protected" : false
          }, {
            "name" : "target_schema",
            "aliases" : [ ],
            "value" : "analytics",
            "kind" : "STRING",
            "protected" : false
          }, {
            "name" : "models",
            "aliases" : [ ],
            "value" : "$MELTANO_TRANSFORM__PACKAGE_NAME $MELTANO_EXTRACTOR_NAMESPACE my_meltano_project",
            "kind" : "STRING",
            "protected" : false
          } ],
          "variants" : [ ],
          "commands" : {
            "docs-generate" : {
              "args" : "docs generate",
              "description" : "Generate documentation artifacts for your project."
            },
            "seed" : {
              "args" : "seed",
              "description" : "Load data from csv files into your data warehouse."
            },
            "compile" : {
              "args" : "compile",
              "description" : "Generates executable SQL from source model, test, and analysis files. Compiled SQL files are written to the target/ directory."
            },
            "test" : {
              "args" : "test",
              "description" : "Runs tests on data in deployed models."
            },
            "run" : {
              "args" : "run",
              "description" : "Compile SQL and execute against the current target database."
            },
            "deps" : {
              "args" : "deps",
              "description" : "Pull the most recent version of the dependencies listed in packages.yml"
            },
            "clean" : {
              "args" : "clean",
              "description" : "Delete all folders in the clean-targets list (usually the dbt_modules and target directories.)"
            },
            "snapshot" : {
              "args" : "snapshot",
              "description" : "Execute snapshots defined in your project."
            }
          },
          "matatikaHidden" : false,
          "requires" : [ {
            "id" : "e6c1ad3d-ebf5-4c4a-b129-f68156b47555",
            "pluginType" : "FILE",
            "name" : "files-dbt",
            "namespace" : "dbt",
            "variant" : "matatika",
            "hidden" : false,
            "pipUrl" : "git+https://github.com/Matatika/[email protected]",
            "repo" : "https://github.com/Matatika/files-dbt",
            "capabilities" : [ ],
            "select" : [ ],
            "update" : {
              "transform/profile/profiles.yml" : "true"
            },
            "vars" : { },
            "settings" : [ ],
            "variants" : [ ],
            "commands" : { },
            "matatikaHidden" : false,
            "requires" : [ ],
            "fullDescription" : ""
          } ],
          "fullDescription" : "",
          "_links" : {
            "self" : {
              "href" : "https://catalog.matatika.com/api/dataplugins/bf090a17-4b81-4ea6-8f9d-2e704c5fe169"
            },
            "update dataplugin" : {
              "href" : "https://catalog.matatika.com/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/dataplugins/bf090a17-4b81-4ea6-8f9d-2e704c5fe169",
              "type" : "PUT"
            }
          }
        }
      },
      "draft" : false,
      "managed" : true,
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/datacomponents/9128c867-75d9-4c51-ab29-98ad323c1424"
        },
        "update datacomponent" : {
          "href" : "https://catalog.matatika.com/api/datacomponents/9128c867-75d9-4c51-ab29-98ad323c1424"
        },
        "delete datacomponent" : {
          "href" : "https://catalog.matatika.com/api/datacomponents/9128c867-75d9-4c51-ab29-98ad323c1424"
        }
      }
    }, {
      "id" : "269ed070-9bfb-4372-8d3f-ae4f7841b0ed",
      "created" : "2024-04-10T14:04:34.78166",
      "lastModified" : "2024-04-10T14:04:35.032637",
      "name" : "extractors/tap-matatika-sit",
      "properties" : { },
      "commands" : { },
      "dataPlugin" : "extractors/tap-matatika-sit--matatika",
      "_embedded" : {
        "dataplugin" : {
          "id" : "e654a6ba-ad71-46d9-b3d7-f5fc19c1924d",
          "pluginType" : "EXTRACTOR",
          "name" : "tap-matatika-sit",
          "namespace" : "tap_matatika_sit",
          "variant" : "matatika",
          "label" : "Matatika SIT",
          "description" : "Test extractor based on tap-spreadsheets-anywhere used during Matatika SIT runs",
          "logoUrl" : "/assets/images/datasource/tap-matatika-sit.svg",
          "hidden" : false,
          "docs" : "https://meltano.com/plugins/extractors/spreadsheets-anywhere.html",
          "pipUrl" : "git+https://github.com/ets/tap-spreadsheets-anywhere.git",
          "repo" : "https://github.com/ets/tap-spreadsheets-anywhere",
          "executable" : "tap-spreadsheets-anywhere",
          "capabilities" : [ "DISCOVER", "STATE", "CATALOG" ],
          "select" : [ ],
          "update" : { },
          "vars" : { },
          "settings" : [ {
            "name" : "tables",
            "aliases" : [ ],
            "label" : "Tables",
            "value" : "[{\"path\":\"https://raw.githubusercontent.com/Matatika/matatika-examples/master/example_data\",\"name\":\"gitflixusers\",\"pattern\":\"GitFlixUsers.csv\",\"start_date\":\"2021-01-01T00:00:00Z\",\"key_properties\":[\"id\"],\"format\":\"csv\"}]",
            "kind" : "ARRAY",
            "description" : "A setting in Matatika SIT that allows users to view and manage tables of data.",
            "protected" : false
          } ],
          "variants" : [ ],
          "commands" : { },
          "matatikaHidden" : true,
          "requires" : [ ],
          "fullDescription" : "Test extractor based on tap-spreadsheets-anywhere used during Matatika SIT runs\n\n## Settings\n\n\n### Tables\n\nA setting in Matatika SIT that allows users to view and manage tables of data.",
          "_links" : {
            "self" : {
              "href" : "https://catalog.matatika.com/api/dataplugins/e654a6ba-ad71-46d9-b3d7-f5fc19c1924d"
            },
            "update dataplugin" : {
              "href" : "https://catalog.matatika.com/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/dataplugins/e654a6ba-ad71-46d9-b3d7-f5fc19c1924d",
              "type" : "PUT"
            }
          }
        }
      },
      "draft" : false,
      "managed" : false,
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
        },
        "update datacomponent" : {
          "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
        },
        "delete datacomponent" : {
          "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/datacomponents?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

View a datacomponent

GET

/api/datacomponents/{datacomponent-id}

Returns the datacomponent {datacomponent-id}.

Prerequisites

  • Datacomponent {datacomponent-id} must exist

Request

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Datacomponent with HAL links.

{
  "id" : "269ed070-9bfb-4372-8d3f-ae4f7841b0ed",
  "created" : "2024-04-10T14:04:34.78166",
  "lastModified" : "2024-04-10T14:04:35.032637",
  "name" : "extractors/tap-matatika-sit",
  "properties" : { },
  "commands" : { },
  "dataPlugin" : "extractors/tap-matatika-sit--matatika",
  "_embedded" : {
    "dataplugin" : {
      "id" : "e654a6ba-ad71-46d9-b3d7-f5fc19c1924d",
      "pluginType" : "EXTRACTOR",
      "name" : "tap-matatika-sit",
      "namespace" : "tap_matatika_sit",
      "variant" : "matatika",
      "label" : "Matatika SIT",
      "description" : "Test extractor based on tap-spreadsheets-anywhere used during Matatika SIT runs",
      "logoUrl" : "/assets/images/datasource/tap-matatika-sit.svg",
      "hidden" : false,
      "docs" : "https://meltano.com/plugins/extractors/spreadsheets-anywhere.html",
      "pipUrl" : "git+https://github.com/ets/tap-spreadsheets-anywhere.git",
      "repo" : "https://github.com/ets/tap-spreadsheets-anywhere",
      "executable" : "tap-spreadsheets-anywhere",
      "capabilities" : [ "DISCOVER", "STATE", "CATALOG" ],
      "select" : [ ],
      "update" : { },
      "vars" : { },
      "settings" : [ {
        "name" : "tables",
        "aliases" : [ ],
        "label" : "Tables",
        "value" : "[{\"path\":\"https://raw.githubusercontent.com/Matatika/matatika-examples/master/example_data\",\"name\":\"gitflixusers\",\"pattern\":\"GitFlixUsers.csv\",\"start_date\":\"2021-01-01T00:00:00Z\",\"key_properties\":[\"id\"],\"format\":\"csv\"}]",
        "kind" : "ARRAY",
        "description" : "A setting in Matatika SIT that allows users to view and manage tables of data.",
        "protected" : false
      } ],
      "variants" : [ ],
      "commands" : { },
      "matatikaHidden" : true,
      "requires" : [ ],
      "fullDescription" : "Test extractor based on tap-spreadsheets-anywhere used during Matatika SIT runs\n\n## Settings\n\n\n### Tables\n\nA setting in Matatika SIT that allows users to view and manage tables of data.",
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/dataplugins/e654a6ba-ad71-46d9-b3d7-f5fc19c1924d"
        },
        "update dataplugin" : {
          "href" : "https://catalog.matatika.com/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/dataplugins/e654a6ba-ad71-46d9-b3d7-f5fc19c1924d",
          "type" : "PUT"
        }
      }
    }
  },
  "draft" : false,
  "managed" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    },
    "update datacomponent" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    },
    "delete datacomponent" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    }
  }
}

Initialise a new datacomponent in a workspace

POST

/api/workspaces/{workspace-id}/datacomponents

Initialises a new datacomponent in the workspace {workspace-id}.

Request

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/datacomponents' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/datacomponents"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

datacomponent with HAL links.

{
  "id" : "269ed070-9bfb-4372-8d3f-ae4f7841b0ed",
  "created" : "2024-04-10T14:04:34.506083442",
  "lastModified" : "2024-04-10T14:04:34.506083642",
  "properties" : { },
  "commands" : { },
  "draft" : false,
  "managed" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    },
    "create datacomponent" : {
      "href" : "https://catalog.matatika.com/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    }
  }
}

Create or update a datacomponent in a workspace

PUT

/api/workspaces/{workspace-id}/datacomponents/{datacomponent-id}

Creates or updates the datacomponent {datacomponent-id} in the workspace {workspace-id}.

Request

Body

Datacomponent resource.

{
  "name" : "extractors/tap-matatika-sit",
  "dataPlugin" : "extractors/tap-matatika-sit"
}

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/hal+json; charset=ISO-8859-1' \
    -d '{
  "name" : "extractors/tap-matatika-sit",
  "dataPlugin" : "extractors/tap-matatika-sit"
}'

Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"

data = {
  "name" : "extractors/tap-matatika-sit",
  "dataPlugin" : "extractors/tap-matatika-sit"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK / 201 Created

Datacomponent with HAL links.

{
  "id" : "269ed070-9bfb-4372-8d3f-ae4f7841b0ed",
  "created" : "2024-04-10T14:04:34.78166",
  "lastModified" : "2024-04-10T14:04:34.781661",
  "name" : "extractors/tap-matatika-sit",
  "properties" : { },
  "commands" : { },
  "dataPlugin" : "extractors/tap-matatika-sit--matatika",
  "_embedded" : {
    "dataplugin" : {
      "id" : "e654a6ba-ad71-46d9-b3d7-f5fc19c1924d",
      "pluginType" : "EXTRACTOR",
      "name" : "tap-matatika-sit",
      "namespace" : "tap_matatika_sit",
      "variant" : "matatika",
      "label" : "Matatika SIT",
      "description" : "Test extractor based on tap-spreadsheets-anywhere used during Matatika SIT runs",
      "logoUrl" : "/assets/images/datasource/tap-matatika-sit.svg",
      "hidden" : false,
      "docs" : "https://meltano.com/plugins/extractors/spreadsheets-anywhere.html",
      "pipUrl" : "git+https://github.com/ets/tap-spreadsheets-anywhere.git",
      "repo" : "https://github.com/ets/tap-spreadsheets-anywhere",
      "executable" : "tap-spreadsheets-anywhere",
      "capabilities" : [ "DISCOVER", "STATE", "CATALOG" ],
      "select" : [ ],
      "update" : { },
      "vars" : { },
      "settings" : [ {
        "name" : "tables",
        "aliases" : [ ],
        "label" : "Tables",
        "value" : "[{\"path\":\"https://raw.githubusercontent.com/Matatika/matatika-examples/master/example_data\",\"name\":\"gitflixusers\",\"pattern\":\"GitFlixUsers.csv\",\"start_date\":\"2021-01-01T00:00:00Z\",\"key_properties\":[\"id\"],\"format\":\"csv\"}]",
        "kind" : "ARRAY",
        "description" : "A setting in Matatika SIT that allows users to view and manage tables of data.",
        "protected" : false
      } ],
      "variants" : [ ],
      "commands" : { },
      "matatikaHidden" : true,
      "requires" : [ ],
      "fullDescription" : "Test extractor based on tap-spreadsheets-anywhere used during Matatika SIT runs\n\n## Settings\n\n\n### Tables\n\nA setting in Matatika SIT that allows users to view and manage tables of data.",
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/dataplugins/e654a6ba-ad71-46d9-b3d7-f5fc19c1924d"
        },
        "update dataplugin" : {
          "href" : "https://catalog.matatika.com/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/dataplugins/e654a6ba-ad71-46d9-b3d7-f5fc19c1924d",
          "type" : "PUT"
        }
      }
    }
  },
  "draft" : false,
  "managed" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    },
    "update datacomponent" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    },
    "delete datacomponent" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    }
  }
}

Update a datacomponent

PUT

/api/datacomponents/{datacomponent-id}

Updates the datacomponent {datacomponent-id}.

Prerequisites

  • Datacomponent {datacomponent-id} must exist

Request

Body

Datacomponent resource.

{
  "name" : "extractors/tap-matatika-sit",
  "dataPlugin" : "extractors/tap-matatika-sit"
}

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/hal+json; charset=ISO-8859-1' \
    -d '{
  "name" : "extractors/tap-matatika-sit",
  "dataPlugin" : "extractors/tap-matatika-sit"
}'

Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"

data = {
  "name" : "extractors/tap-matatika-sit",
  "dataPlugin" : "extractors/tap-matatika-sit"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK

Datacomponent with HAL links.

{
  "id" : "269ed070-9bfb-4372-8d3f-ae4f7841b0ed",
  "created" : "2024-04-10T14:04:34.78166",
  "lastModified" : "2024-04-10T14:04:35.032637",
  "name" : "extractors/tap-matatika-sit",
  "properties" : { },
  "commands" : { },
  "dataPlugin" : "extractors/tap-matatika-sit--matatika",
  "_embedded" : {
    "dataplugin" : {
      "id" : "e654a6ba-ad71-46d9-b3d7-f5fc19c1924d",
      "pluginType" : "EXTRACTOR",
      "name" : "tap-matatika-sit",
      "namespace" : "tap_matatika_sit",
      "variant" : "matatika",
      "label" : "Matatika SIT",
      "description" : "Test extractor based on tap-spreadsheets-anywhere used during Matatika SIT runs",
      "logoUrl" : "/assets/images/datasource/tap-matatika-sit.svg",
      "hidden" : false,
      "docs" : "https://meltano.com/plugins/extractors/spreadsheets-anywhere.html",
      "pipUrl" : "git+https://github.com/ets/tap-spreadsheets-anywhere.git",
      "repo" : "https://github.com/ets/tap-spreadsheets-anywhere",
      "executable" : "tap-spreadsheets-anywhere",
      "capabilities" : [ "DISCOVER", "STATE", "CATALOG" ],
      "select" : [ ],
      "update" : { },
      "vars" : { },
      "settings" : [ {
        "name" : "tables",
        "aliases" : [ ],
        "label" : "Tables",
        "value" : "[{\"path\":\"https://raw.githubusercontent.com/Matatika/matatika-examples/master/example_data\",\"name\":\"gitflixusers\",\"pattern\":\"GitFlixUsers.csv\",\"start_date\":\"2021-01-01T00:00:00Z\",\"key_properties\":[\"id\"],\"format\":\"csv\"}]",
        "kind" : "ARRAY",
        "description" : "A setting in Matatika SIT that allows users to view and manage tables of data.",
        "protected" : false
      } ],
      "variants" : [ ],
      "commands" : { },
      "matatikaHidden" : true,
      "requires" : [ ],
      "fullDescription" : "Test extractor based on tap-spreadsheets-anywhere used during Matatika SIT runs\n\n## Settings\n\n\n### Tables\n\nA setting in Matatika SIT that allows users to view and manage tables of data.",
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/dataplugins/e654a6ba-ad71-46d9-b3d7-f5fc19c1924d"
        },
        "update dataplugin" : {
          "href" : "https://catalog.matatika.com/api/workspaces/64194e04-d98f-4ebe-91e5-e38f6f4c563a/dataplugins/e654a6ba-ad71-46d9-b3d7-f5fc19c1924d",
          "type" : "PUT"
        }
      }
    }
  },
  "draft" : false,
  "managed" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    },
    "update datacomponent" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    },
    "delete datacomponent" : {
      "href" : "https://catalog.matatika.com/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"
    }
  }
}

Delete a datacomponent

DELETE

/api/datacomponents/{datacomponent-id}

Deletes the datacomponent {datacomponent-id}.

Request

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/datacomponents/269ed070-9bfb-4372-8d3f-ae4f7841b0ed"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("DELETE", url, headers=headers)

print(response.text.encode('utf8'))

Response

204 No Content

No response body provided.