Skip to main content
GET
Get mappings for a company

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

company_id
integer<int64>
required

The id of an existing company

Query Parameters

source
enum<string>[]

Return only mappings with one of these sources. Repeat the parameter to name several; omitted, every stored mapping is returned. Naming derived adds the derived mappings the stored mappings imply, whatever their own source: each is computed on the request by applying a derivation rule to a stored mapping, has no id because nothing is stored, and carries a provenance saying how it was produced.

The source of the mapping.

  • company - Company private mapping
  • admin - Admin created/promoted mapping
  • system - System (Automated/ML) mappings
  • lineage - Lineage-derived mappings (editable without admin)
  • rosetta_stone - Rosetta Stone mappings (editable without admin)
  • derived - Computed on the request from a stored mapping and a derivation rule. Not stored, so it has no id; listed only when asked for by source
Available options:
company,
admin,
system,
lineage,
rosetta_stone,
derived
depends_on_dataset_field
string[]

Return only mappings whose expression reads this dataset field. Name a top-level column (email) to match every mapping that reads it or anything nested under it, or a dotted path (address.postal_code) to match only mappings that read that nested field. Repeat the parameter to match any of several. Matching uses the dependencies computed when a mapping was saved, so with source=derived a derived mapping matches through the expression it was built from. Requires dataset_id; a request with depends_on_dataset_field and no dataset_id is rejected.

attribute_id
integer[]

Attribute identifier. Repeat the parameter to retrieve mappings for multiple attributes.

dataset_id
integer[]

Dataset identifier. Repeat the parameter to retrieve mappings for multiple datasets.

Response

200 - application/json

Ok

records
object[]
required