Skip to main content
Version: 2.0-rc

Data Consumer

Role overview​

note

Your mission: You access and use available data. Your goal is to find, understand, and consume Datasets.

Why your role is vital: You are the "User of data". The value of the Platform is realized when data is actually used.

Defining your scope: You access the Payload of available Datasets through their APIs.

Your core responsibilities​

  • Understand data: You review metadata and structure to understand the data
  • Consume data: You use one or more APIs of a Dataset to retrieve and use its Payload

Outside your scope​

It is not your responsibility to create, configure, or manage data-related elements. You do not modify Datasets, Data structures, or Data sources.

If you prepare or manage Datasets, the Data Steward role is likely the right role for you.

If you define structures or integrate data, the Data Architect role is likely the right role for you.

If you review or release data, the Data Owner or Data Gatekeeper role is likely the right role for you.

Understanding the Authorization Logic

To access data, you need the appropriate permissions.

The access logic: Access is always the result of a User being assigned to a Group, and that Group being assigned a Role at a specific Scope.

As a Data Consumer, your access is typically limited to the API of specific Datasets. If a Dataset is configured as open data, it may also be accessible without authentication.

→ Deep Dive Authorisation

Typical tasks​

Your work in CIVITAS/CORE focuses on using data:

  • Browse a Dataset: Browse and select a Dataset
  • Select an API: Locate the API URL
  • Copy the API URL: Use the copy icon
  • Retrieve the Dataset Payload: Use the API in your tool of choice

Your permissions​

Permissions / Data-related elementsREADCREATEUPDATEDELETERELEASE
Dataset🟣
↳ Payload🟣
Data source
Data structure
Datapool🟣

Key terms to know​

To work effectively as a Data Consumer, review these terms in our Glossary:

  • Dataset: A structured collection of data prepared for use.
  • API: The interface used to access data.
  • Payload: The data provided by a Dataset through one or more APIs.

Deep Dives​

→ Glossary

→ Consume Data