For the complete documentation index, see llms.txt. This page is also available as Markdown.

Datamart Device Id Registry Selections

Operations related to Datamart Device ID Registry Selections for querying and managing device identifier collections.

Search device id registry selection

get
/datamarts/{datamart_id}/device_id_registries
Path parameters
datamart_idinteger · int64Required
Query parameters
device_id_registry_idstringOptional

Id of device id registry to search

created_bystringOptional

User who created the device id registry selection

first_resultinteger · int32Optional

Offset from which the search must be performed

max_resultsinteger · int32Optional

Number of maximum items that shall be return by this search

Responses
200

Success !

application/json
first_resultintegerRequired
countintegerRequired
statusstring · enumRequiredPossible values:
max_resultsintegerRequired
totalintegerRequired
get/datamarts/{datamart_id}/device_id_registries
GET /v1/datamarts/{datamart_id}/device_id_registries HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "data": [
    {
      "created_by": "text",
      "last_modified_ts": 0,
      "creation_ts": 0,
      "datamart_id": "text",
      "id": "text",
      "triggers_device_point_merge": false,
      "device_id_registry_id": "text",
      "last_modified_by": "text"
    }
  ],
  "first_result": 1,
  "count": 1,
  "status": "ok",
  "max_results": 1,
  "total": 1
}

Create a device id registry selection

post
/datamarts/{datamart_id}/device_id_registries
Path parameters
datamart_idinteger · int64Required
Body
created_bystringRead-onlyRequired
last_modified_tsinteger · int64Read-onlyRequiredDefault: 0
creation_tsinteger · int64Read-onlyRequiredDefault: 0
datamart_idstringRequired
idstringRead-onlyRequired
triggers_device_point_mergebooleanRequiredDefault: false
device_id_registry_idstringRequired
last_modified_bystringRead-onlyRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/device_id_registries
POST /v1/datamarts/{datamart_id}/device_id_registries HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "datamart_id": "text",
  "triggers_device_point_merge": false,
  "device_id_registry_id": "text"
}
{
  "status": "ok",
  "data": {
    "created_by": "text",
    "last_modified_ts": 0,
    "creation_ts": 0,
    "datamart_id": "text",
    "id": "text",
    "triggers_device_point_merge": false,
    "device_id_registry_id": "text",
    "last_modified_by": "text"
  }
}

Search device id registry datamart selections

get
/device_id_registries/{device_id_registry_id}/datamart_selections
Path parameters
device_id_registry_idstringRequired
Query parameters
organisation_idstringOptional

Id of organisation to search

datamart_idstringOptional

Id of datamart to search

created_bystringOptional

User who created the device id registry selection

first_resultinteger · int32Optional

Offset from which the search must be performed

max_resultsinteger · int32Optional

Number of maximum items that shall be return by this search

Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
totalintegerRequired
max_resultsintegerRequired
first_resultintegerRequired
countintegerRequired
get/device_id_registries/{device_id_registry_id}/datamart_selections
GET /v1/device_id_registries/{device_id_registry_id}/datamart_selections HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "total": 1,
  "max_results": 1,
  "first_result": 1,
  "data": [
    {
      "created_by": "text",
      "last_modified_ts": 0,
      "creation_ts": 0,
      "datamart_id": "text",
      "id": "text",
      "triggers_device_point_merge": false,
      "device_id_registry_id": "text",
      "last_modified_by": "text"
    }
  ],
  "count": 1
}

Update device id registry datamart selections

put
/device_id_registries/{device_id_registry_id}/datamart_selections
Path parameters
device_id_registry_idstringRequired
Query parameters
organisation_idstringOptional

Id of the organisation of the registry datamart selections

Body
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
put/device_id_registries/{device_id_registry_id}/datamart_selections
PUT /v1/device_id_registries/{device_id_registry_id}/datamart_selections HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "datamart_selections": [
    {
      "datamart_id": "text",
      "triggers_device_point_merge": false
    }
  ]
}
{
  "status": "ok"
}

Get device id registry from datamart

get
/datamarts/{datamart_id}/device_id_registries/{id}
Path parameters
idstringRequired

The device id registry selection id

datamart_idinteger · int64Required
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/datamarts/{datamart_id}/device_id_registries/{id}
GET /v1/datamarts/{datamart_id}/device_id_registries/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "created_by": "text",
    "last_modified_ts": 0,
    "creation_ts": 0,
    "datamart_id": "text",
    "id": "text",
    "triggers_device_point_merge": false,
    "device_id_registry_id": "text",
    "last_modified_by": "text"
  }
}

Delete device id registry

delete
/datamarts/{datamart_id}/device_id_registries/{id}
Path parameters
idstringRequired

The device id registry selection id

datamart_idinteger · int64Required
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/datamarts/{datamart_id}/device_id_registries/{id}
DELETE /v1/datamarts/{datamart_id}/device_id_registries/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

Last updated

Was this helpful?