Skip to main content
POST
/
mappings
/
{mapping_id}
/
accept
Accept a mapping
curl --request POST \
  --url https://api-dev.narrative.io/mappings/{mapping_id}/accept \
  --header 'Authorization: Bearer <token>'
{
  "id": "ea9dddd2-e3ee-40b5-b03e-c3cd37c8a7f0",
  "attribute_id": 1,
  "created_at": "2021-12-10T00:00:00Z",
  "dataset_id": 3,
  "mapping": {
    "type": "object_mapping",
    "property_mappings": [
      {
        "path": "foo",
        "expression": "upper(`US Kennel ID`)",
        "dependencies": {
          "properties": [
            "US Kennel ID"
          ]
        }
      },
      {
        "path": "bar.baz.qux",
        "expression": "weight * 10000",
        "dependencies": {
          "properties": [
            "weight"
          ]
        }
      }
    ]
  },
  "status": "active",
  "updated_at": "2021-12-10T00:00:01Z",
  "created_by": 1,
  "updated_by": 1,
  "company_id": 100,
  "scope": "global",
  "source": "admin",
  "derived_from": "ea9dddd2-e3ee-40b5-b03e-c3cd37c8a6f0"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

mapping_id
string<uuid>
required

Unique identifier for a mapping.

Response

200 - application/json

OK

id
string<uuid>
required

Unique identifier for a mapping.

Example:

"ea9dddd2-e3ee-40b5-b03e-c3cd37c8a6f0"

attribute_id
integer
required

The target attribute's ID.

created_at
string
required

ISO-8601 timestamp indicating when the mapping was created.

Example:

"2021-08-26T21:06:07.710357Z"

dataset_id
integer
required

The source dataset's ID.

mapping
object
required
status
enum<string>
required

The status of the mapping.

  • active - Active mappings can be used
  • archived - Archived/Deleted mappings - mapping no longer in use
  • pending - Pending mappings need to be accepted before they can be used
Available options:
active,
archived,
pending
updated_at
string
required

ISO-8601 timestamp indicating when the mapping was last updated.

Example:

"2021-08-26T21:06:07.710357Z"

created_by
integer<int64>
required

Unique id from a user who created it.

Example:

20

updated_by
integer<int64>
required

Unique id from a user who updated it.

Example:

20

scope
enum<string>
required

The scope of the mapping.

  • global - Mappings available to all
  • private - Company private mappings
Available options:
global,
private
source
enum<string>
required

The source of the mapping.

  • company - Company private mapping
  • admin - Admin created/promoted mapping
  • system - System (Automated/ML) mappings
Available options:
company,
admin,
system
company_id
integer<int64>

The id of an existing company

Example:

345

derived_from
string<uuid>

Unique identifier for a mapping.

Example:

"ea9dddd2-e3ee-40b5-b03e-c3cd37c8a6f0"