Skip to main content
Version: V2-Next

Consume Data

Overview​

Who is this guide for?

Role: Data Consumer

Goal: You want to find a DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. and retrieve the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. Payload through one of its APIs.

Required Permissions: read DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.

What you will achieve​

After completing this guide, you will have:

  • Found an Available DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
  • Located an API of the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
  • Accessed data through the API

Before you start​

Make sure that:

  • the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. is Available
  • you have access to the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
  • or Open Data is enabled

Understand data consumption​

CIVITAS/CORE provides access to stored data through APIs.

This means:

  • a DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. can provide one or more APIs
  • each API provides access to the data of the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
  • access is controlled through Groups, Roles, or Open Data without authentication

Step-by-step guide​

Step 1: Find a Dataset​

  1. Go to DatasetsDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
  2. Browse the list or search for the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. you want to access
  3. Open the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.

Screenshot: Dataset list view

You can only open DatasetsDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. that you have access to.

Step 2: Select an API​

  1. Go to Dataflow → APIs in the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. detail view
  2. Locate the API you want to use
  3. Copy the API URL using the copy icon next to the URL

Screenshot: Data Flow section with API URL highlighted

Step 3: Access data through the API​

  1. Paste the full API URL into the API client of your choice
  2. Authenticate if required
  3. Send the request
  4. Retrieve the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. Data

Optional: Access Open Data directly​

If Open Data is enabled for the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions., authentication is not required.

Use the API URL directly to access the data.

Outcome​

You have successfully:

  • found an Available DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
  • located one of its APIs
  • copied the API URL
  • accessed data through the API