> For the complete documentation index, see [llms.txt](https://docs.mediarithmics.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mediarithmics.io/api-reference/datamart-management/runtime-schemas.md).

# Runtime Schemas

Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.

Relevant documentation:

* [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/validation

> Validate runtime schema

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/validation":{"post":{"summary":"Validate runtime schema","parameters":[{"explode":false,"schema":{"type":"integer","format":"int64"},"required":true,"name":"datamart_id","style":"simple","description":"The datamart owning the schema.","in":"path"},{"in":"path","schema":{"type":"integer","format":"int64"},"required":true,"name":"schema_id","explode":false,"description":"The schema to validate.","style":"simple"}],"description":"","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/RuntimeSchemaValidationInfoResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Runtime Schemas"],"operationId":"validateRuntimeSchema"}}},"components":{"schemas":{"RuntimeSchemaValidationInfoResource":{"type":"object","properties":{"datamart_id":{"type":"string","readOnly":false},"schema_id":{"type":"string","readOnly":false},"tree_index_operations":{"type":"array","items":{"$ref":"#/components/schemas/TreeIndexValidationInfoResource"},"readOnly":false},"schema_errors":{"type":"array","items":{"$ref":"#/components/schemas/RuntimeSchemaValidationErrorRecord"},"readOnly":false}},"required":["datamart_id","schema_errors","schema_id","tree_index_operations"]},"TreeIndexValidationInfoResource":{"discriminator":{"propertyName":"type","mapping":{"ERROR":"#/components/schemas/TreeIndexInvalidInfoResource","VALID":"#/components/schemas/TreeIndexValidInfoResource"}},"oneOf":[{"$ref":"#/components/schemas/TreeIndexInvalidInfoResource"},{"$ref":"#/components/schemas/TreeIndexValidInfoResource"}],"properties":{"type":{"type":"string","enum":["ERROR","VALID"]}},"required":["type"]},"TreeIndexInvalidInfoResource":{"type":"object","properties":{"datamart_id":{"type":"string","readOnly":false},"index_selection_id":{"type":"string","readOnly":false},"error_code":{"$ref":"#/components/schemas/TreeIndexValidationError"},"error_message":{"type":"string","readOnly":false}},"required":["datamart_id","error_code","error_message","index_selection_id"]},"TreeIndexValidationError":{"type":"string","enum":["INDEX_JOB_STILL_RUNNING","DRIVER_NOT_COMPATIBLE","DRIVER_DEPRECATED"],"readOnly":false},"TreeIndexValidInfoResource":{"allOf":[{"$ref":"#/components/schemas/IndexDriverVersion"},{"type":"object","properties":{"current_index_size":{"$ref":"#/components/schemas/TreeIndexSize"},"new_index_size":{"$ref":"#/components/schemas/TreeIndexSize"},"current_index_id":{"type":"string","readOnly":false},"init_strategy":{"$ref":"#/components/schemas/TreeIndexInitStrategy"},"new_index":{"type":"boolean","default":false,"readOnly":false},"init_job":{"$ref":"#/components/schemas/TreeIndexJobType"},"index_name":{"type":"string","readOnly":false},"driver_version_minor_number":{"type":"integer","format":"int32","default":0,"readOnly":false},"datamart_id":{"type":"string","readOnly":false},"driver_version_major_number":{"type":"integer","format":"int32","default":0,"readOnly":false},"index_selection_id":{"type":"string","readOnly":false}},"required":["datamart_id","driver_version_major_number","driver_version_minor_number","index_name","index_selection_id","init_strategy","new_index"]}]},"IndexDriverVersion":{"type":"object"},"TreeIndexSize":{"type":"string","enum":["SMALL","MEDIUM","LARGE","X_LARGE","XX_LARGE","XXX_LARGE","EXTRA_LARGE","XXXX_LARGE"],"readOnly":false},"TreeIndexInitStrategy":{"type":"string","enum":["AUTOMATIC","FORCE_BUILD_FROM_CURSOR","FORCE_BUILD_FROM_INDEX","FORCE_NO_BUILD","MANUAL"],"readOnly":false},"TreeIndexJobType":{"type":"string","enum":["CURSOR_BASED_FULL_BUILD","INDEX_BASED_FULL_BUILD","IN_PLACE_REFRESH"],"readOnly":false},"RuntimeSchemaValidationErrorRecord":{"type":"object","properties":{"error_code":{"$ref":"#/components/schemas/RuntimeSchemaValidationError"},"error_message":{"type":"string","readOnly":false}},"required":["error_code"]},"RuntimeSchemaValidationError":{"type":"string","enum":["COMPILATION_ERROR"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/scalar\_fields/{scalar\_field\_id}

> Get scalar field

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/scalar_fields/{scalar_field_id}":{"get":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ScalarFieldInfosResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","parameters":[{"required":true,"schema":{"type":"string"},"name":"datamart_id","in":"path","explode":false,"style":"simple"},{"schema":{"type":"string"},"in":"path","explode":false,"name":"schema_id","style":"simple","required":true},{"schema":{"type":"string"},"explode":false,"in":"path","required":true,"style":"simple","name":"object_tree_id"},{"in":"path","name":"object_type_definition_id","style":"simple","schema":{"type":"string"},"explode":false,"required":true},{"in":"path","schema":{"type":"string"},"style":"simple","required":true,"name":"scalar_field_id","explode":false}],"operationId":"getScalarField","summary":"Get scalar field","tags":["Runtime Schemas"]}}},"components":{"schemas":{"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/scalar\_fields/{scalar\_field\_id}

> Update scalar field

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/scalar_fields/{scalar_field_id}":{"put":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ScalarFieldInfosResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"in":"path","style":"simple","required":true,"name":"datamart_id","schema":{"type":"string"},"explode":false},{"explode":false,"schema":{"type":"string"},"in":"path","required":true,"style":"simple","name":"schema_id"},{"explode":false,"schema":{"type":"string"},"in":"path","required":true,"style":"simple","name":"object_tree_id"},{"style":"simple","name":"object_type_definition_id","schema":{"type":"string"},"explode":false,"required":true,"in":"path"},{"required":true,"explode":false,"in":"path","style":"simple","name":"scalar_field_id","schema":{"type":"string"}}],"operationId":"updateScalarField","summary":"Update scalar field","tags":["Runtime Schemas"],"requestBody":{"description":"The relationship to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalarFieldInfosResource"}}},"required":true},"description":""}}},"components":{"schemas":{"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/scalar\_fields/{scalar\_field\_id}

> Delete scalar field

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/scalar_fields/{scalar_field_id}":{"delete":{"responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"deleteScalarField","description":"","summary":"Delete scalar field","tags":["Runtime Schemas"],"parameters":[{"schema":{"type":"string"},"required":true,"explode":false,"in":"path","style":"simple","name":"datamart_id"},{"explode":false,"name":"schema_id","in":"path","required":true,"schema":{"type":"string"},"style":"simple"},{"explode":false,"in":"path","style":"simple","name":"object_tree_id","required":true,"schema":{"type":"string"}},{"schema":{"type":"string"},"required":true,"in":"path","name":"object_type_definition_id","explode":false,"style":"simple"},{"schema":{"type":"string"},"in":"path","style":"simple","explode":false,"name":"scalar_field_id","required":true}]}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}

> Get object tree

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}":{"get":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTreeInfosResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"style":"simple","explode":false,"name":"datamart_id","required":true,"in":"path","schema":{"type":"string"}},{"schema":{"type":"string"},"in":"path","name":"schema_id","explode":false,"required":true,"style":"simple"},{"required":true,"name":"object_tree_id","style":"simple","in":"path","schema":{"type":"string"},"explode":false},{"schema":{"$ref":"#/components/schemas/FieldRefFormat"},"required":false,"name":"field_ref_format","style":"form","in":"query","explode":true}],"summary":"Get object tree","description":"","tags":["Runtime Schemas"],"operationId":"getObjectTree"}}},"components":{"schemas":{"ObjectTreeInfosResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"input_stream_configs":{"type":"array","items":{"$ref":"#/components/schemas/InputStreamConfigResource"},"readOnly":false},"relation_cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"relation_name":{"type":"string","readOnly":false},"data_source_type":{"$ref":"#/components/schemas/ObjectTreeDataSourceType"},"data_warehouse_id":{"type":"string","readOnly":false},"channel_source":{"$ref":"#/components/schemas/ObjectTreeChannelSourceResource"},"computed_field_technical_name":{"type":"string","readOnly":false},"data_warehouse_live_ingestion_config":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionConfigResource"},"description":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false},"datamart_schema_id":{"type":"string","readOnly":false},"object_type_definition":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"},"user_identifiers":{"type":"array","items":{"$ref":"#/components/schemas/Generic"},"readOnly":false},"event_name":{"$ref":"#/components/schemas/ObjectTreeEventNameResource"},"object_tree_type":{"$ref":"#/components/schemas/ObjectTreeType"},"activity_type":{"$ref":"#/components/schemas/ObjectTreeActivityType"}},"required":["data_source_type","datamart_schema_id","description","id","input_stream_configs","name","object_tree_type","relation_cardinality","relation_name","user_identifiers"]},"InputStreamConfigResource":{"type":"object","properties":{"working_table_name":{"type":"string","readOnly":true},"strategy":{"$ref":"#/components/schemas/CursorStrategy"},"data_warehouse_table_id":{"type":"string","readOnly":false},"object_type_definition_id":{"type":"string","readOnly":false},"use_processing_pipeline":{"type":"boolean","default":false,"readOnly":false},"document_import_id":{"type":"string","readOnly":true},"scheduling":{"$ref":"#/components/schemas/Scheduling"}},"required":["data_warehouse_table_id","document_import_id","scheduling","strategy","use_processing_pipeline"]},"CursorStrategy":{"discriminator":{"propertyName":"type","mapping":{"MODIFIED_TS":"#/components/schemas/ModifiedTs","HASH_TABLE":"#/components/schemas/HashTable","LOG":"#/components/schemas/Log","FULL_IMPORT":"#/components/schemas/FullImport"}},"oneOf":[{"$ref":"#/components/schemas/ModifiedTs"},{"$ref":"#/components/schemas/HashTable"},{"$ref":"#/components/schemas/Log"},{"$ref":"#/components/schemas/FullImport"}],"properties":{"type":{"type":"string","enum":["MODIFIED_TS","HASH_TABLE","LOG","FULL_IMPORT"]}},"required":["type"]},"ModifiedTs":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"HashTable":{"type":"object","properties":{"column_ids":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false}},"required":["column_ids"]},"Log":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"FullImport":{"type":"object"},"Scheduling":{"discriminator":{"propertyName":"type","mapping":{"FREQUENCY":"#/components/schemas/Frequency"}},"oneOf":[{"$ref":"#/components/schemas/Frequency"}],"properties":{"type":{"type":"string","enum":["FREQUENCY"]}},"required":["type"]},"Frequency":{"type":"object","properties":{"start_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/SchedulingUnit"},"time_zone":{"type":"string","readOnly":true},"end_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"value":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["time_zone","unit","value"]},"SchedulingUnit":{"type":"string","enum":["MINUTE","HOUR","DAY"],"readOnly":false},"RelationshipCardinality":{"type":"string","enum":["ONE_TO_ONE","ONE_TO_ZERO_OR_ONE","ONE_TO_MANY"],"readOnly":false},"ObjectTreeDataSourceType":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","PREDEFINED","EDGE","COMPUTED_FIELD"],"readOnly":false},"ObjectTreeChannelSourceResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static1","MAPPING":"#/components/schemas/Mapping"}},"oneOf":[{"$ref":"#/components/schemas/Static1"},{"$ref":"#/components/schemas/Mapping"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"channel_id":{"type":"string","readOnly":false}},"required":["channel_id"]},"Mapping":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeDataWarehouseLiveIngestionConfigResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false},"status":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionStatus"},"object_tree_id":{"type":"string","readOnly":false},"creation_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"bucket_name":{"type":"string","readOnly":false},"data_warehouse_id":{"type":"string","readOnly":false}},"required":["bucket_name","creation_ts","data_warehouse_id","datamart_id","id","name","object_tree_id","status"]},"ObjectTreeDataWarehouseLiveIngestionStatus":{"type":"string","enum":["WAITING_FOR_TABLE_CREATION","PAUSED","ACTIVE"],"readOnly":false},"ObjectTypeDefinitionInfosResource":{"type":"object","properties":{"input_mapping_path":{"type":"string","readOnly":false},"update_value_object":{"type":"boolean","default":false,"readOnly":false},"object_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipInfosResource"},"readOnly":false},"cloned_from":{"type":"string","readOnly":false},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeMappingResource"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ScalarFieldInfosResource"},"readOnly":false},"input_mapping_table":{"type":"string","readOnly":false},"input_mapping_column":{"type":"string","readOnly":false}},"required":["fields","id","mappings","object_name","relationships","update_value_object"]},"RelationshipInfosResource":{"type":"object","properties":{"relation_name":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"id":{"type":"string","readOnly":true},"child":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["cardinality","relation_name"]},"ObjectTypeMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName1","DATA_WAREHOUSE_TABLE_BY_ID":"#/components/schemas/DataWarehouseTableById","JSON_PATH":"#/components/schemas/JsonPath1","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById","DATA_WAREHOUSE_TABLE_BY_NAME":"#/components/schemas/DataWarehouseTableByName"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouseTableById"},{"$ref":"#/components/schemas/JsonPath1"},{"$ref":"#/components/schemas/DataWarehouseTableByName"},{"$ref":"#/components/schemas/DataWarehouseColumnByName1"},{"$ref":"#/components/schemas/DataWarehouseColumnById"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE_TABLE_BY_ID","JSON_PATH","DATA_WAREHOUSE_TABLE_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"DataWarehouseTableById":{"type":"object","properties":{"table_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_id"]},"JsonPath1":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"DataWarehouseTableByName":{"type":"object","properties":{"table_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_name"]},"DataWarehouseColumnByName1":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_id","mapping_group_id"]},"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"Generic":{"allOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"main":{"type":"boolean","default":false,"readOnly":false},"realm_id":{"type":"string","readOnly":false},"location":{"$ref":"#/components/schemas/ObjectTreeIdentifierLocationResource"},"identifier_type":{"$ref":"#/components/schemas/IdentifierType"}},"required":["id","identifier_type","main"]}]},"ObjectTreeIdentifierResource":{"type":"object"},"ObjectTreeIdentifierLocationResource":{"discriminator":{"propertyName":"type","mapping":{"COLUMN_LOCATION":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource","FIELD_LOCATION":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}},"oneOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource"},{"$ref":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}],"properties":{"type":{"type":"string","enum":["COLUMN_LOCATION","FIELD_LOCATION"]}},"required":["type"]},"ObjectTreeIdentifierColumnLocationResource":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeIdentifierFieldLocationResource":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"IdentifierType":{"type":"string","enum":["EMAIL_HASH","USER_ACCOUNT","USER_POINT_ID","DEVICE_POINT","DEVICE_TECHNICAL_ID"],"readOnly":false},"ObjectTreeEventNameResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static","MAPPING":"#/components/schemas/Mapping1"}},"oneOf":[{"$ref":"#/components/schemas/Static"},{"$ref":"#/components/schemas/Mapping1"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event_name":{"type":"string","readOnly":false}},"required":["event_name"]},"Mapping1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeType":{"type":"string","enum":["Custom","ClusteringCohort","UserAccount","UserActivity","UserChoice","UserDevicePoint","UserEmail","UserEvent","UserProfile","UserScenario","UserSegment"],"readOnly":false},"ObjectTreeActivityType":{"type":"string","enum":["TOUCH","SITE_VISIT","APP_VISIT","CTV_VISIT"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]},"FieldRefFormat":{"type":"string","enum":["ID","NAME"],"readOnly":false}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}

> Get object types

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}":{"put":{"description":"","operationId":"updateObjectTree","summary":"Get object types","parameters":[{"name":"datamart_id","required":true,"style":"simple","schema":{"type":"string"},"explode":false,"in":"path"},{"style":"simple","in":"path","name":"schema_id","schema":{"type":"string"},"explode":false,"required":true},{"required":true,"schema":{"type":"string"},"style":"simple","in":"path","name":"object_tree_id","explode":false}],"requestBody":{"description":"The datamart to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectTreeInfosResource"}}},"required":true},"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTreeInfosResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Runtime Schemas"]}}},"components":{"schemas":{"ObjectTreeInfosResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"input_stream_configs":{"type":"array","items":{"$ref":"#/components/schemas/InputStreamConfigResource"},"readOnly":false},"relation_cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"relation_name":{"type":"string","readOnly":false},"data_source_type":{"$ref":"#/components/schemas/ObjectTreeDataSourceType"},"data_warehouse_id":{"type":"string","readOnly":false},"channel_source":{"$ref":"#/components/schemas/ObjectTreeChannelSourceResource"},"computed_field_technical_name":{"type":"string","readOnly":false},"data_warehouse_live_ingestion_config":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionConfigResource"},"description":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false},"datamart_schema_id":{"type":"string","readOnly":false},"object_type_definition":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"},"user_identifiers":{"type":"array","items":{"$ref":"#/components/schemas/Generic"},"readOnly":false},"event_name":{"$ref":"#/components/schemas/ObjectTreeEventNameResource"},"object_tree_type":{"$ref":"#/components/schemas/ObjectTreeType"},"activity_type":{"$ref":"#/components/schemas/ObjectTreeActivityType"}},"required":["data_source_type","datamart_schema_id","description","id","input_stream_configs","name","object_tree_type","relation_cardinality","relation_name","user_identifiers"]},"InputStreamConfigResource":{"type":"object","properties":{"working_table_name":{"type":"string","readOnly":true},"strategy":{"$ref":"#/components/schemas/CursorStrategy"},"data_warehouse_table_id":{"type":"string","readOnly":false},"object_type_definition_id":{"type":"string","readOnly":false},"use_processing_pipeline":{"type":"boolean","default":false,"readOnly":false},"document_import_id":{"type":"string","readOnly":true},"scheduling":{"$ref":"#/components/schemas/Scheduling"}},"required":["data_warehouse_table_id","document_import_id","scheduling","strategy","use_processing_pipeline"]},"CursorStrategy":{"discriminator":{"propertyName":"type","mapping":{"MODIFIED_TS":"#/components/schemas/ModifiedTs","HASH_TABLE":"#/components/schemas/HashTable","LOG":"#/components/schemas/Log","FULL_IMPORT":"#/components/schemas/FullImport"}},"oneOf":[{"$ref":"#/components/schemas/ModifiedTs"},{"$ref":"#/components/schemas/HashTable"},{"$ref":"#/components/schemas/Log"},{"$ref":"#/components/schemas/FullImport"}],"properties":{"type":{"type":"string","enum":["MODIFIED_TS","HASH_TABLE","LOG","FULL_IMPORT"]}},"required":["type"]},"ModifiedTs":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"HashTable":{"type":"object","properties":{"column_ids":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false}},"required":["column_ids"]},"Log":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"FullImport":{"type":"object"},"Scheduling":{"discriminator":{"propertyName":"type","mapping":{"FREQUENCY":"#/components/schemas/Frequency"}},"oneOf":[{"$ref":"#/components/schemas/Frequency"}],"properties":{"type":{"type":"string","enum":["FREQUENCY"]}},"required":["type"]},"Frequency":{"type":"object","properties":{"start_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/SchedulingUnit"},"time_zone":{"type":"string","readOnly":true},"end_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"value":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["time_zone","unit","value"]},"SchedulingUnit":{"type":"string","enum":["MINUTE","HOUR","DAY"],"readOnly":false},"RelationshipCardinality":{"type":"string","enum":["ONE_TO_ONE","ONE_TO_ZERO_OR_ONE","ONE_TO_MANY"],"readOnly":false},"ObjectTreeDataSourceType":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","PREDEFINED","EDGE","COMPUTED_FIELD"],"readOnly":false},"ObjectTreeChannelSourceResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static1","MAPPING":"#/components/schemas/Mapping"}},"oneOf":[{"$ref":"#/components/schemas/Static1"},{"$ref":"#/components/schemas/Mapping"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"channel_id":{"type":"string","readOnly":false}},"required":["channel_id"]},"Mapping":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeDataWarehouseLiveIngestionConfigResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false},"status":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionStatus"},"object_tree_id":{"type":"string","readOnly":false},"creation_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"bucket_name":{"type":"string","readOnly":false},"data_warehouse_id":{"type":"string","readOnly":false}},"required":["bucket_name","creation_ts","data_warehouse_id","datamart_id","id","name","object_tree_id","status"]},"ObjectTreeDataWarehouseLiveIngestionStatus":{"type":"string","enum":["WAITING_FOR_TABLE_CREATION","PAUSED","ACTIVE"],"readOnly":false},"ObjectTypeDefinitionInfosResource":{"type":"object","properties":{"input_mapping_path":{"type":"string","readOnly":false},"update_value_object":{"type":"boolean","default":false,"readOnly":false},"object_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipInfosResource"},"readOnly":false},"cloned_from":{"type":"string","readOnly":false},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeMappingResource"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ScalarFieldInfosResource"},"readOnly":false},"input_mapping_table":{"type":"string","readOnly":false},"input_mapping_column":{"type":"string","readOnly":false}},"required":["fields","id","mappings","object_name","relationships","update_value_object"]},"RelationshipInfosResource":{"type":"object","properties":{"relation_name":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"id":{"type":"string","readOnly":true},"child":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["cardinality","relation_name"]},"ObjectTypeMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName1","DATA_WAREHOUSE_TABLE_BY_ID":"#/components/schemas/DataWarehouseTableById","JSON_PATH":"#/components/schemas/JsonPath1","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById","DATA_WAREHOUSE_TABLE_BY_NAME":"#/components/schemas/DataWarehouseTableByName"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouseTableById"},{"$ref":"#/components/schemas/JsonPath1"},{"$ref":"#/components/schemas/DataWarehouseTableByName"},{"$ref":"#/components/schemas/DataWarehouseColumnByName1"},{"$ref":"#/components/schemas/DataWarehouseColumnById"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE_TABLE_BY_ID","JSON_PATH","DATA_WAREHOUSE_TABLE_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"DataWarehouseTableById":{"type":"object","properties":{"table_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_id"]},"JsonPath1":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"DataWarehouseTableByName":{"type":"object","properties":{"table_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_name"]},"DataWarehouseColumnByName1":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_id","mapping_group_id"]},"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"Generic":{"allOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"main":{"type":"boolean","default":false,"readOnly":false},"realm_id":{"type":"string","readOnly":false},"location":{"$ref":"#/components/schemas/ObjectTreeIdentifierLocationResource"},"identifier_type":{"$ref":"#/components/schemas/IdentifierType"}},"required":["id","identifier_type","main"]}]},"ObjectTreeIdentifierResource":{"type":"object"},"ObjectTreeIdentifierLocationResource":{"discriminator":{"propertyName":"type","mapping":{"COLUMN_LOCATION":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource","FIELD_LOCATION":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}},"oneOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource"},{"$ref":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}],"properties":{"type":{"type":"string","enum":["COLUMN_LOCATION","FIELD_LOCATION"]}},"required":["type"]},"ObjectTreeIdentifierColumnLocationResource":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeIdentifierFieldLocationResource":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"IdentifierType":{"type":"string","enum":["EMAIL_HASH","USER_ACCOUNT","USER_POINT_ID","DEVICE_POINT","DEVICE_TECHNICAL_ID"],"readOnly":false},"ObjectTreeEventNameResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static","MAPPING":"#/components/schemas/Mapping1"}},"oneOf":[{"$ref":"#/components/schemas/Static"},{"$ref":"#/components/schemas/Mapping1"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event_name":{"type":"string","readOnly":false}},"required":["event_name"]},"Mapping1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeType":{"type":"string","enum":["Custom","ClusteringCohort","UserAccount","UserActivity","UserChoice","UserDevicePoint","UserEmail","UserEvent","UserProfile","UserScenario","UserSegment"],"readOnly":false},"ObjectTreeActivityType":{"type":"string","enum":["TOUCH","SITE_VISIT","APP_VISIT","CTV_VISIT"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}

> Delete object tree

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}":{"delete":{"parameters":[{"name":"datamart_id","explode":false,"style":"simple","in":"path","schema":{"type":"string"},"required":true},{"required":true,"name":"schema_id","in":"path","schema":{"type":"string"},"explode":false,"style":"simple"},{"style":"simple","schema":{"type":"string"},"required":true,"in":"path","name":"object_tree_id","explode":false}],"description":"","tags":["Runtime Schemas"],"responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"summary":"Delete object tree","operationId":"deleteObjectTree"}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{id}

> Get object type by id

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{id}":{"get":{"parameters":[{"schema":{"type":"integer","format":"int64"},"explode":false,"in":"path","style":"simple","required":true,"name":"datamart_id"},{"required":true,"schema":{"type":"integer","format":"int64"},"style":"simple","name":"schema_id","in":"path","explode":false},{"style":"simple","name":"id","required":true,"in":"path","schema":{"type":"integer","format":"int64"},"explode":false}],"description":"","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectLikeTypeResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"summary":"Get object type by id","tags":["Runtime Schemas"],"operationId":"getObjectType"}}},"components":{"schemas":{"ObjectLikeTypeResource":{"allOf":[{"$ref":"#/components/schemas/AbstractObjectLikeTypeResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"runtime_schema_id":{"type":"string","readOnly":true},"type":{"$ref":"#/components/schemas/ObjectLikeType"},"name":{"type":"string","readOnly":false}},"required":["id","name","runtime_schema_id","type"]}]},"AbstractObjectLikeTypeResource":{"type":"object"},"ObjectLikeType":{"type":"string","enum":["OBJECT_TYPE","INTERFACE_TYPE"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/user\_agent\_mappings

> Enable or disable user agent mappings

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/user_agent_mappings":{"post":{"responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","tags":["Runtime Schemas"],"operationId":"setupUserAgentMappings","parameters":[{"explode":false,"in":"path","style":"simple","name":"datamart_id","schema":{"type":"string"},"required":true},{"schema":{"type":"string"},"explode":false,"name":"schema_id","in":"path","required":true,"style":"simple"}],"summary":"Enable or disable user agent mappings","requestBody":{"description":"The action to perform","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAgentMappingActionRequest"}}},"required":true}}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]},"UserAgentMappingActionRequest":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/PredefinedObjectTreeAction"}},"required":["action"]},"PredefinedObjectTreeAction":{"type":"string","enum":["ENABLE","DISABLE"],"readOnly":false}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/relationships/{relationship\_id}

> Get object tree relationship

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/relationships/{relationship_id}":{"get":{"description":"","parameters":[{"name":"datamart_id","style":"simple","explode":false,"schema":{"type":"string"},"in":"path","required":true},{"name":"schema_id","required":true,"schema":{"type":"string"},"explode":false,"in":"path","style":"simple"},{"style":"simple","in":"path","explode":false,"schema":{"type":"string"},"required":true,"name":"object_tree_id"},{"style":"simple","required":true,"in":"path","name":"object_type_definition_id","explode":false,"schema":{"type":"string"}},{"schema":{"type":"string"},"explode":false,"in":"path","style":"simple","name":"relationship_id","required":true}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/RelationshipInfosResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Runtime Schemas"],"operationId":"getObjectTreeRelationship","summary":"Get object tree relationship"}}},"components":{"schemas":{"RelationshipInfosResource":{"type":"object","properties":{"relation_name":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"id":{"type":"string","readOnly":true},"child":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["cardinality","relation_name"]},"RelationshipCardinality":{"type":"string","enum":["ONE_TO_ONE","ONE_TO_ZERO_OR_ONE","ONE_TO_MANY"],"readOnly":false},"ObjectTypeDefinitionInfosResource":{"type":"object","properties":{"input_mapping_path":{"type":"string","readOnly":false},"update_value_object":{"type":"boolean","default":false,"readOnly":false},"object_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipInfosResource"},"readOnly":false},"cloned_from":{"type":"string","readOnly":false},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeMappingResource"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ScalarFieldInfosResource"},"readOnly":false},"input_mapping_table":{"type":"string","readOnly":false},"input_mapping_column":{"type":"string","readOnly":false}},"required":["fields","id","mappings","object_name","relationships","update_value_object"]},"ObjectTypeMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName1","DATA_WAREHOUSE_TABLE_BY_ID":"#/components/schemas/DataWarehouseTableById","JSON_PATH":"#/components/schemas/JsonPath1","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById","DATA_WAREHOUSE_TABLE_BY_NAME":"#/components/schemas/DataWarehouseTableByName"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouseTableById"},{"$ref":"#/components/schemas/JsonPath1"},{"$ref":"#/components/schemas/DataWarehouseTableByName"},{"$ref":"#/components/schemas/DataWarehouseColumnByName1"},{"$ref":"#/components/schemas/DataWarehouseColumnById"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE_TABLE_BY_ID","JSON_PATH","DATA_WAREHOUSE_TABLE_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"DataWarehouseTableById":{"type":"object","properties":{"table_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_id"]},"JsonPath1":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"DataWarehouseTableByName":{"type":"object","properties":{"table_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_name"]},"DataWarehouseColumnByName1":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_id","mapping_group_id"]},"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/relationships/{relationship\_id}

> Update object tree relationship

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/relationships/{relationship_id}":{"put":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/RelationshipInfosResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"requestBody":{"description":"The relationship to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipInfosResource"}}},"required":true},"parameters":[{"name":"datamart_id","schema":{"type":"string"},"in":"path","required":true,"style":"simple","explode":false},{"explode":false,"required":true,"schema":{"type":"string"},"style":"simple","name":"schema_id","in":"path"},{"schema":{"type":"string"},"in":"path","required":true,"explode":false,"name":"object_tree_id","style":"simple"},{"schema":{"type":"string"},"required":true,"in":"path","name":"object_type_definition_id","style":"simple","explode":false},{"style":"simple","required":true,"schema":{"type":"string"},"explode":false,"in":"path","name":"relationship_id"}],"description":"","tags":["Runtime Schemas"],"operationId":"updateObjectTreeRelationship","summary":"Update object tree relationship"}}},"components":{"schemas":{"RelationshipInfosResource":{"type":"object","properties":{"relation_name":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"id":{"type":"string","readOnly":true},"child":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["cardinality","relation_name"]},"RelationshipCardinality":{"type":"string","enum":["ONE_TO_ONE","ONE_TO_ZERO_OR_ONE","ONE_TO_MANY"],"readOnly":false},"ObjectTypeDefinitionInfosResource":{"type":"object","properties":{"input_mapping_path":{"type":"string","readOnly":false},"update_value_object":{"type":"boolean","default":false,"readOnly":false},"object_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipInfosResource"},"readOnly":false},"cloned_from":{"type":"string","readOnly":false},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeMappingResource"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ScalarFieldInfosResource"},"readOnly":false},"input_mapping_table":{"type":"string","readOnly":false},"input_mapping_column":{"type":"string","readOnly":false}},"required":["fields","id","mappings","object_name","relationships","update_value_object"]},"ObjectTypeMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName1","DATA_WAREHOUSE_TABLE_BY_ID":"#/components/schemas/DataWarehouseTableById","JSON_PATH":"#/components/schemas/JsonPath1","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById","DATA_WAREHOUSE_TABLE_BY_NAME":"#/components/schemas/DataWarehouseTableByName"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouseTableById"},{"$ref":"#/components/schemas/JsonPath1"},{"$ref":"#/components/schemas/DataWarehouseTableByName"},{"$ref":"#/components/schemas/DataWarehouseColumnByName1"},{"$ref":"#/components/schemas/DataWarehouseColumnById"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE_TABLE_BY_ID","JSON_PATH","DATA_WAREHOUSE_TABLE_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"DataWarehouseTableById":{"type":"object","properties":{"table_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_id"]},"JsonPath1":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"DataWarehouseTableByName":{"type":"object","properties":{"table_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_name"]},"DataWarehouseColumnByName1":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_id","mapping_group_id"]},"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/relationships/{relationship\_id}

> Delete object tree relationship

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/relationships/{relationship_id}":{"delete":{"summary":"Delete object tree relationship","tags":["Runtime Schemas"],"parameters":[{"in":"path","explode":false,"required":true,"name":"datamart_id","style":"simple","schema":{"type":"string"}},{"required":true,"in":"path","explode":false,"style":"simple","schema":{"type":"string"},"name":"schema_id"},{"in":"path","name":"object_tree_id","explode":false,"style":"simple","required":true,"schema":{"type":"string"}},{"required":true,"schema":{"type":"string"},"name":"object_type_definition_id","style":"simple","explode":false,"in":"path"},{"in":"path","required":true,"style":"simple","name":"relationship_id","schema":{"type":"string"},"explode":false}],"description":"","operationId":"deleteObjectTreeRelationship","responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas

> Find runtime schemas

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Mediarithmics most used API","description":"These operations where flagged by mediarithmics teams as most useful."},{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas":{"get":{"summary":"Find runtime schemas","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"max_results":{"type":"integer"},"first_result":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RuntimeSchemaResource"}}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"findRuntimeSchemas","description":"","tags":["Runtime Schemas","Mediarithmics most used API"],"parameters":[{"in":"path","name":"datamart_id","required":true,"schema":{"type":"string"},"description":"The datamart to get the schemas from.","style":"simple","explode":false}]}}},"components":{"schemas":{"RuntimeSchemaResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"creation_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"last_modification_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"publication_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"datamart_id":{"type":"string","readOnly":true},"schema_type":{"$ref":"#/components/schemas/DatamartSchemaType"},"status":{"$ref":"#/components/schemas/SchemaStatus"},"suspension_date":{"type":"integer","format":"int64","default":0,"readOnly":true}},"required":["creation_date","datamart_id","id","last_modification_date","publication_date","schema_type","status"]},"DatamartSchemaType":{"type":"string","enum":["OBJECT_TREE","PLAIN_TEXT"],"readOnly":false},"SchemaStatus":{"type":"string","enum":["DRAFT","PUBLISHED","LIVE","SUSPENDED","ARCHIVED","actives"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas

> Create runtime schema

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Mediarithmics most used API","description":"These operations where flagged by mediarithmics teams as most useful."},{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas":{"post":{"description":"","summary":"Create runtime schema","operationId":"createRuntimeSchema","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/RuntimeSchemaResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Runtime Schemas","Mediarithmics most used API"],"parameters":[{"required":true,"explode":false,"description":"The datamart to get the schemas from.","schema":{"type":"string"},"name":"datamart_id","style":"simple","in":"path"},{"name":"schema_type","style":"form","explode":true,"description":"The type of schema to create","required":false,"schema":{"$ref":"#/components/schemas/DatamartSchemaType"},"in":"query"}]}}},"components":{"schemas":{"RuntimeSchemaResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"creation_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"last_modification_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"publication_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"datamart_id":{"type":"string","readOnly":true},"schema_type":{"$ref":"#/components/schemas/DatamartSchemaType"},"status":{"$ref":"#/components/schemas/SchemaStatus"},"suspension_date":{"type":"integer","format":"int64","default":0,"readOnly":true}},"required":["creation_date","datamart_id","id","last_modification_date","publication_date","schema_type","status"]},"DatamartSchemaType":{"type":"string","enum":["OBJECT_TREE","PLAIN_TEXT"],"readOnly":false},"SchemaStatus":{"type":"string","enum":["DRAFT","PUBLISHED","LIVE","SUSPENDED","ARCHIVED","actives"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/directives/{directive\_id}/arguments/{id}

> Get argument by id

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/directives/{directive_id}/arguments/{id}":{"get":{"summary":"Get argument by id","parameters":[{"required":true,"schema":{"type":"integer","format":"int64"},"explode":false,"in":"path","style":"simple","name":"datamart_id"},{"explode":false,"required":true,"style":"simple","schema":{"type":"integer","format":"int64"},"in":"path","name":"schema_id"},{"style":"simple","required":true,"schema":{"type":"integer","format":"int64"},"in":"path","explode":false,"name":"object_type_id"},{"schema":{"type":"integer","format":"int64"},"required":true,"name":"directive_id","explode":false,"style":"simple","in":"path"},{"explode":false,"in":"path","schema":{"type":"integer","format":"int64"},"required":true,"name":"id","style":"simple"}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/DirectiveArgumentResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","operationId":"getArgument","tags":["Runtime Schemas"]}}},"components":{"schemas":{"DirectiveArgumentResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"directive_id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false}},"required":["directive_id","id","name","value"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/field/index={index\_name}/object\_tree\_field\_path={object\_tree\_field\_path}/reference\_tables/records

> Search record values

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/field/index={index_name}/object_tree_field_path={object_tree_field_path}/reference_tables/records":{"get":{"tags":["Runtime Schemas"],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"first_result":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"total":{"type":"integer"},"max_results":{"type":"integer"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceTableRecordResource"}}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"summary":"Search record values","parameters":[{"schema":{"type":"string"},"required":true,"in":"path","name":"datamart_id","style":"simple","explode":false},{"required":true,"explode":false,"name":"schema_id","schema":{"type":"string"},"in":"path","style":"simple"},{"style":"simple","in":"path","name":"index_name","explode":false,"schema":{"type":"string"},"required":true},{"in":"path","schema":{"type":"string"},"required":true,"explode":false,"style":"simple","name":"object_tree_field_path"},{"description":"locale","schema":{"$ref":"#/components/schemas/Locale"},"explode":true,"style":"form","in":"query","required":false,"name":"locale"},{"description":"keywords","name":"keywords","style":"form","in":"query","schema":{"type":"string"},"required":false,"explode":true},{"schema":{"type":"integer","format":"int32"},"required":false,"description":"Offset from which the search must be performed","style":"form","name":"first_result","explode":true,"in":"query"},{"description":"Number of maximum items that shall be return by this search","style":"form","explode":true,"name":"max_results","schema":{"type":"integer","format":"int32"},"in":"query","required":false}],"description":"","operationId":"findReferenceTableRecords"}}},"components":{"schemas":{"ReferenceTableRecordResource":{"type":"object","properties":{"display_value":{"type":"string","readOnly":true},"locale":{"type":"string","enum":["fr-FR","de-DE","en-GB","en-US","es-ES"],"readOnly":true},"value":{"type":"string","readOnly":true}},"required":["display_value","locale","value"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]},"Locale":{"type":"string","enum":["fr-FR","de-DE","en-GB","en-US","es-ES"],"readOnly":false}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/input\_stream\_configs

> Get object tree input stream configs

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/input_stream_configs":{"get":{"tags":["Runtime Schemas"],"summary":"Get object tree input stream configs","operationId":"getInputStreamConfigLegacy","description":"","parameters":[{"in":"path","name":"datamart_id","explode":false,"style":"simple","schema":{"type":"string"},"required":true},{"in":"path","style":"simple","schema":{"type":"string"},"explode":false,"name":"schema_id","required":true},{"style":"simple","schema":{"type":"string"},"in":"path","explode":false,"name":"object_tree_id","required":true},{"required":false,"style":"form","schema":{"type":"string"},"name":"data_warehouse_table_id","explode":true,"in":"query"},{"in":"query","required":false,"schema":{"type":"integer","format":"int32"},"name":"first_result","explode":true,"style":"form"},{"explode":true,"style":"form","name":"max_results","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"first_result":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"max_results":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InputStreamConfigResource"}},"count":{"type":"integer"},"total":{"type":"integer"}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"InputStreamConfigResource":{"type":"object","properties":{"working_table_name":{"type":"string","readOnly":true},"strategy":{"$ref":"#/components/schemas/CursorStrategy"},"data_warehouse_table_id":{"type":"string","readOnly":false},"object_type_definition_id":{"type":"string","readOnly":false},"use_processing_pipeline":{"type":"boolean","default":false,"readOnly":false},"document_import_id":{"type":"string","readOnly":true},"scheduling":{"$ref":"#/components/schemas/Scheduling"}},"required":["data_warehouse_table_id","document_import_id","scheduling","strategy","use_processing_pipeline"]},"CursorStrategy":{"discriminator":{"propertyName":"type","mapping":{"MODIFIED_TS":"#/components/schemas/ModifiedTs","HASH_TABLE":"#/components/schemas/HashTable","LOG":"#/components/schemas/Log","FULL_IMPORT":"#/components/schemas/FullImport"}},"oneOf":[{"$ref":"#/components/schemas/ModifiedTs"},{"$ref":"#/components/schemas/HashTable"},{"$ref":"#/components/schemas/Log"},{"$ref":"#/components/schemas/FullImport"}],"properties":{"type":{"type":"string","enum":["MODIFIED_TS","HASH_TABLE","LOG","FULL_IMPORT"]}},"required":["type"]},"ModifiedTs":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"HashTable":{"type":"object","properties":{"column_ids":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false}},"required":["column_ids"]},"Log":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"FullImport":{"type":"object"},"Scheduling":{"discriminator":{"propertyName":"type","mapping":{"FREQUENCY":"#/components/schemas/Frequency"}},"oneOf":[{"$ref":"#/components/schemas/Frequency"}],"properties":{"type":{"type":"string","enum":["FREQUENCY"]}},"required":["type"]},"Frequency":{"type":"object","properties":{"start_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/SchedulingUnit"},"time_zone":{"type":"string","readOnly":true},"end_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"value":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["time_zone","unit","value"]},"SchedulingUnit":{"type":"string","enum":["MINUTE","HOUR","DAY"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/input\_stream\_configs

> Create input stream config

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/input_stream_configs":{"post":{"operationId":"createInputStreamConfigLegacy","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/InputStreamConfigResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"summary":"Create input stream config","description":"","parameters":[{"in":"path","schema":{"type":"string"},"explode":false,"required":true,"name":"datamart_id","style":"simple"},{"name":"schema_id","in":"path","schema":{"type":"string"},"style":"simple","required":true,"explode":false},{"in":"path","required":true,"name":"object_tree_id","explode":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"description":"The identifier to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputStreamConfigResource"}}},"required":true},"tags":["Runtime Schemas"]}}},"components":{"schemas":{"InputStreamConfigResource":{"type":"object","properties":{"working_table_name":{"type":"string","readOnly":true},"strategy":{"$ref":"#/components/schemas/CursorStrategy"},"data_warehouse_table_id":{"type":"string","readOnly":false},"object_type_definition_id":{"type":"string","readOnly":false},"use_processing_pipeline":{"type":"boolean","default":false,"readOnly":false},"document_import_id":{"type":"string","readOnly":true},"scheduling":{"$ref":"#/components/schemas/Scheduling"}},"required":["data_warehouse_table_id","document_import_id","scheduling","strategy","use_processing_pipeline"]},"CursorStrategy":{"discriminator":{"propertyName":"type","mapping":{"MODIFIED_TS":"#/components/schemas/ModifiedTs","HASH_TABLE":"#/components/schemas/HashTable","LOG":"#/components/schemas/Log","FULL_IMPORT":"#/components/schemas/FullImport"}},"oneOf":[{"$ref":"#/components/schemas/ModifiedTs"},{"$ref":"#/components/schemas/HashTable"},{"$ref":"#/components/schemas/Log"},{"$ref":"#/components/schemas/FullImport"}],"properties":{"type":{"type":"string","enum":["MODIFIED_TS","HASH_TABLE","LOG","FULL_IMPORT"]}},"required":["type"]},"ModifiedTs":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"HashTable":{"type":"object","properties":{"column_ids":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false}},"required":["column_ids"]},"Log":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"FullImport":{"type":"object"},"Scheduling":{"discriminator":{"propertyName":"type","mapping":{"FREQUENCY":"#/components/schemas/Frequency"}},"oneOf":[{"$ref":"#/components/schemas/Frequency"}],"properties":{"type":{"type":"string","enum":["FREQUENCY"]}},"required":["type"]},"Frequency":{"type":"object","properties":{"start_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/SchedulingUnit"},"time_zone":{"type":"string","readOnly":true},"end_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"value":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["time_zone","unit","value"]},"SchedulingUnit":{"type":"string","enum":["MINUTE","HOUR","DAY"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/input\_stream\_configs

> Update input stream config

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/input_stream_configs":{"put":{"summary":"Update input stream config","description":"","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/InputStreamConfigResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Runtime Schemas"],"operationId":"updateInputStreamConfigLegacy","requestBody":{"description":"The identifier to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputStreamConfigResource"}}},"required":true},"parameters":[{"name":"datamart_id","style":"simple","schema":{"type":"string"},"required":true,"in":"path","explode":false},{"schema":{"type":"string"},"name":"schema_id","style":"simple","required":true,"in":"path","explode":false},{"in":"path","explode":false,"schema":{"type":"string"},"required":true,"style":"simple","name":"object_tree_id"},{"in":"query","explode":true,"style":"form","name":"data_warehouse_table_id","required":true,"schema":{"type":"string"}},{"required":false,"explode":true,"in":"query","style":"form","name":"object_type_definition_id","schema":{"type":"string"}}]}}},"components":{"schemas":{"InputStreamConfigResource":{"type":"object","properties":{"working_table_name":{"type":"string","readOnly":true},"strategy":{"$ref":"#/components/schemas/CursorStrategy"},"data_warehouse_table_id":{"type":"string","readOnly":false},"object_type_definition_id":{"type":"string","readOnly":false},"use_processing_pipeline":{"type":"boolean","default":false,"readOnly":false},"document_import_id":{"type":"string","readOnly":true},"scheduling":{"$ref":"#/components/schemas/Scheduling"}},"required":["data_warehouse_table_id","document_import_id","scheduling","strategy","use_processing_pipeline"]},"CursorStrategy":{"discriminator":{"propertyName":"type","mapping":{"MODIFIED_TS":"#/components/schemas/ModifiedTs","HASH_TABLE":"#/components/schemas/HashTable","LOG":"#/components/schemas/Log","FULL_IMPORT":"#/components/schemas/FullImport"}},"oneOf":[{"$ref":"#/components/schemas/ModifiedTs"},{"$ref":"#/components/schemas/HashTable"},{"$ref":"#/components/schemas/Log"},{"$ref":"#/components/schemas/FullImport"}],"properties":{"type":{"type":"string","enum":["MODIFIED_TS","HASH_TABLE","LOG","FULL_IMPORT"]}},"required":["type"]},"ModifiedTs":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"HashTable":{"type":"object","properties":{"column_ids":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false}},"required":["column_ids"]},"Log":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"FullImport":{"type":"object"},"Scheduling":{"discriminator":{"propertyName":"type","mapping":{"FREQUENCY":"#/components/schemas/Frequency"}},"oneOf":[{"$ref":"#/components/schemas/Frequency"}],"properties":{"type":{"type":"string","enum":["FREQUENCY"]}},"required":["type"]},"Frequency":{"type":"object","properties":{"start_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/SchedulingUnit"},"time_zone":{"type":"string","readOnly":true},"end_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"value":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["time_zone","unit","value"]},"SchedulingUnit":{"type":"string","enum":["MINUTE","HOUR","DAY"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/input\_stream\_configs

> Delete input stream config

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/input_stream_configs":{"delete":{"parameters":[{"required":true,"in":"path","explode":false,"style":"simple","name":"datamart_id","schema":{"type":"string"}},{"schema":{"type":"string"},"name":"schema_id","required":true,"in":"path","style":"simple","explode":false},{"style":"simple","in":"path","schema":{"type":"string"},"name":"object_tree_id","required":true,"explode":false},{"schema":{"type":"string"},"required":true,"name":"data_warehouse_table_id","explode":true,"in":"query","style":"form"}],"responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"summary":"Delete input stream config","operationId":"deleteInputStreamConfigLegacy","tags":["Runtime Schemas"],"description":""}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/scalar\_fields

> Get scalar fields

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/scalar_fields":{"get":{"description":"","summary":"Get scalar fields","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"max_results":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ScalarFieldInfosResource"}},"status":{"type":"string","enum":["ok"]},"first_result":{"type":"integer"},"total":{"type":"integer"}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"getScalarFields","parameters":[{"explode":false,"required":true,"name":"datamart_id","style":"simple","in":"path","schema":{"type":"string"}},{"in":"path","name":"schema_id","style":"simple","schema":{"type":"string"},"explode":false,"required":true},{"in":"path","required":true,"name":"object_tree_id","explode":false,"style":"simple","schema":{"type":"string"}},{"explode":false,"schema":{"type":"string"},"style":"simple","in":"path","required":true,"name":"object_type_definition_id"},{"required":false,"schema":{"type":"integer","format":"int32"},"name":"first_result","style":"form","in":"query","explode":true},{"explode":true,"in":"query","schema":{"type":"integer","format":"int32"},"style":"form","required":false,"name":"max_results"}],"tags":["Runtime Schemas"]}}},"components":{"schemas":{"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/scalar\_fields

> Create scalar field

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/scalar_fields":{"post":{"tags":["Runtime Schemas"],"requestBody":{"description":"The relationship to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalarFieldInfosResource"}}},"required":true},"parameters":[{"style":"simple","name":"datamart_id","in":"path","explode":false,"schema":{"type":"string"},"required":true},{"required":true,"name":"schema_id","in":"path","explode":false,"style":"simple","schema":{"type":"string"}},{"style":"simple","explode":false,"in":"path","schema":{"type":"string"},"name":"object_tree_id","required":true},{"required":true,"explode":false,"style":"simple","schema":{"type":"string"},"name":"object_type_definition_id","in":"path"}],"summary":"Create scalar field","description":"","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ScalarFieldInfosResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"createScalarField"}}},"components":{"schemas":{"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/relationships

> Get object trees relationships

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/relationships":{"get":{"description":"","parameters":[{"in":"path","schema":{"type":"string"},"name":"datamart_id","explode":false,"style":"simple","required":true},{"explode":false,"required":true,"schema":{"type":"string"},"in":"path","name":"schema_id","style":"simple"},{"schema":{"type":"string"},"explode":false,"required":true,"style":"simple","in":"path","name":"object_tree_id"},{"style":"simple","required":true,"name":"object_type_definition_id","schema":{"type":"string"},"explode":false,"in":"path"},{"schema":{"type":"integer","format":"int32"},"required":false,"name":"first_result","in":"query","explode":true,"style":"form"},{"name":"max_results","in":"query","required":false,"style":"form","schema":{"type":"integer","format":"int32"},"explode":true}],"tags":["Runtime Schemas"],"summary":"Get object trees relationships","operationId":"getObjectTreeRelationships","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"max_results":{"type":"integer"},"total":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"count":{"type":"integer"},"first_result":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipInfosResource"}}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"RelationshipInfosResource":{"type":"object","properties":{"relation_name":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"id":{"type":"string","readOnly":true},"child":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["cardinality","relation_name"]},"RelationshipCardinality":{"type":"string","enum":["ONE_TO_ONE","ONE_TO_ZERO_OR_ONE","ONE_TO_MANY"],"readOnly":false},"ObjectTypeDefinitionInfosResource":{"type":"object","properties":{"input_mapping_path":{"type":"string","readOnly":false},"update_value_object":{"type":"boolean","default":false,"readOnly":false},"object_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipInfosResource"},"readOnly":false},"cloned_from":{"type":"string","readOnly":false},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeMappingResource"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ScalarFieldInfosResource"},"readOnly":false},"input_mapping_table":{"type":"string","readOnly":false},"input_mapping_column":{"type":"string","readOnly":false}},"required":["fields","id","mappings","object_name","relationships","update_value_object"]},"ObjectTypeMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName1","DATA_WAREHOUSE_TABLE_BY_ID":"#/components/schemas/DataWarehouseTableById","JSON_PATH":"#/components/schemas/JsonPath1","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById","DATA_WAREHOUSE_TABLE_BY_NAME":"#/components/schemas/DataWarehouseTableByName"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouseTableById"},{"$ref":"#/components/schemas/JsonPath1"},{"$ref":"#/components/schemas/DataWarehouseTableByName"},{"$ref":"#/components/schemas/DataWarehouseColumnByName1"},{"$ref":"#/components/schemas/DataWarehouseColumnById"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE_TABLE_BY_ID","JSON_PATH","DATA_WAREHOUSE_TABLE_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"DataWarehouseTableById":{"type":"object","properties":{"table_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_id"]},"JsonPath1":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"DataWarehouseTableByName":{"type":"object","properties":{"table_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_name"]},"DataWarehouseColumnByName1":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_id","mapping_group_id"]},"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/relationships

> Create object trees relationships

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/relationships":{"post":{"summary":"Create object trees relationships","parameters":[{"style":"simple","schema":{"type":"string"},"name":"datamart_id","in":"path","explode":false,"required":true},{"name":"schema_id","explode":false,"style":"simple","required":true,"schema":{"type":"string"},"in":"path"},{"name":"object_tree_id","in":"path","schema":{"type":"string"},"required":true,"style":"simple","explode":false},{"schema":{"type":"string"},"style":"simple","in":"path","explode":false,"required":true,"name":"object_type_definition_id"}],"requestBody":{"description":"The relationship to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipInfosResource"}}},"required":true},"tags":["Runtime Schemas"],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/RelationshipInfosResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","operationId":"createObjectTreeRelationship"}}},"components":{"schemas":{"RelationshipInfosResource":{"type":"object","properties":{"relation_name":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"id":{"type":"string","readOnly":true},"child":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["cardinality","relation_name"]},"RelationshipCardinality":{"type":"string","enum":["ONE_TO_ONE","ONE_TO_ZERO_OR_ONE","ONE_TO_MANY"],"readOnly":false},"ObjectTypeDefinitionInfosResource":{"type":"object","properties":{"input_mapping_path":{"type":"string","readOnly":false},"update_value_object":{"type":"boolean","default":false,"readOnly":false},"object_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipInfosResource"},"readOnly":false},"cloned_from":{"type":"string","readOnly":false},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeMappingResource"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ScalarFieldInfosResource"},"readOnly":false},"input_mapping_table":{"type":"string","readOnly":false},"input_mapping_column":{"type":"string","readOnly":false}},"required":["fields","id","mappings","object_name","relationships","update_value_object"]},"ObjectTypeMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName1","DATA_WAREHOUSE_TABLE_BY_ID":"#/components/schemas/DataWarehouseTableById","JSON_PATH":"#/components/schemas/JsonPath1","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById","DATA_WAREHOUSE_TABLE_BY_NAME":"#/components/schemas/DataWarehouseTableByName"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouseTableById"},{"$ref":"#/components/schemas/JsonPath1"},{"$ref":"#/components/schemas/DataWarehouseTableByName"},{"$ref":"#/components/schemas/DataWarehouseColumnByName1"},{"$ref":"#/components/schemas/DataWarehouseColumnById"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE_TABLE_BY_ID","JSON_PATH","DATA_WAREHOUSE_TABLE_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"DataWarehouseTableById":{"type":"object","properties":{"table_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_id"]},"JsonPath1":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"DataWarehouseTableByName":{"type":"object","properties":{"table_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_name"]},"DataWarehouseColumnByName1":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_id","mapping_group_id"]},"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}

> Get object type definition

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}":{"get":{"summary":"Get object type definition","operationId":"getObjectTypeDefinition","description":"","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"name":"datamart_id","in":"path","schema":{"type":"string"},"explode":false,"required":true,"style":"simple"},{"name":"schema_id","style":"simple","explode":false,"schema":{"type":"string"},"required":true,"in":"path"},{"schema":{"type":"string"},"explode":false,"style":"simple","in":"path","name":"object_tree_id","required":true},{"in":"path","name":"object_type_definition_id","style":"simple","explode":false,"schema":{"type":"string"},"required":true}],"tags":["Runtime Schemas"]}}},"components":{"schemas":{"ObjectTypeDefinitionInfosResource":{"type":"object","properties":{"input_mapping_path":{"type":"string","readOnly":false},"update_value_object":{"type":"boolean","default":false,"readOnly":false},"object_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipInfosResource"},"readOnly":false},"cloned_from":{"type":"string","readOnly":false},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeMappingResource"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ScalarFieldInfosResource"},"readOnly":false},"input_mapping_table":{"type":"string","readOnly":false},"input_mapping_column":{"type":"string","readOnly":false}},"required":["fields","id","mappings","object_name","relationships","update_value_object"]},"RelationshipInfosResource":{"type":"object","properties":{"relation_name":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"id":{"type":"string","readOnly":true},"child":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["cardinality","relation_name"]},"RelationshipCardinality":{"type":"string","enum":["ONE_TO_ONE","ONE_TO_ZERO_OR_ONE","ONE_TO_MANY"],"readOnly":false},"ObjectTypeMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName1","DATA_WAREHOUSE_TABLE_BY_ID":"#/components/schemas/DataWarehouseTableById","JSON_PATH":"#/components/schemas/JsonPath1","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById","DATA_WAREHOUSE_TABLE_BY_NAME":"#/components/schemas/DataWarehouseTableByName"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouseTableById"},{"$ref":"#/components/schemas/JsonPath1"},{"$ref":"#/components/schemas/DataWarehouseTableByName"},{"$ref":"#/components/schemas/DataWarehouseColumnByName1"},{"$ref":"#/components/schemas/DataWarehouseColumnById"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE_TABLE_BY_ID","JSON_PATH","DATA_WAREHOUSE_TABLE_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"DataWarehouseTableById":{"type":"object","properties":{"table_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_id"]},"JsonPath1":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"DataWarehouseTableByName":{"type":"object","properties":{"table_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_name"]},"DataWarehouseColumnByName1":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_id","mapping_group_id"]},"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}

> Update object type definition

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}":{"put":{"operationId":"updateObjectTypeDefinition","summary":"Update object type definition","tags":["Runtime Schemas"],"parameters":[{"style":"simple","required":true,"explode":false,"name":"datamart_id","in":"path","schema":{"type":"string"}},{"required":true,"schema":{"type":"string"},"in":"path","style":"simple","explode":false,"name":"schema_id"},{"explode":false,"schema":{"type":"string"},"in":"path","name":"object_tree_id","required":true,"style":"simple"},{"schema":{"type":"string"},"style":"simple","name":"object_type_definition_id","in":"path","explode":false,"required":true}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"requestBody":{"description":"The object type definiton to update. Fields and relationship can be created via this call but not updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}}},"required":true},"description":""}}},"components":{"schemas":{"ObjectTypeDefinitionInfosResource":{"type":"object","properties":{"input_mapping_path":{"type":"string","readOnly":false},"update_value_object":{"type":"boolean","default":false,"readOnly":false},"object_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipInfosResource"},"readOnly":false},"cloned_from":{"type":"string","readOnly":false},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeMappingResource"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ScalarFieldInfosResource"},"readOnly":false},"input_mapping_table":{"type":"string","readOnly":false},"input_mapping_column":{"type":"string","readOnly":false}},"required":["fields","id","mappings","object_name","relationships","update_value_object"]},"RelationshipInfosResource":{"type":"object","properties":{"relation_name":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"id":{"type":"string","readOnly":true},"child":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["cardinality","relation_name"]},"RelationshipCardinality":{"type":"string","enum":["ONE_TO_ONE","ONE_TO_ZERO_OR_ONE","ONE_TO_MANY"],"readOnly":false},"ObjectTypeMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName1","DATA_WAREHOUSE_TABLE_BY_ID":"#/components/schemas/DataWarehouseTableById","JSON_PATH":"#/components/schemas/JsonPath1","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById","DATA_WAREHOUSE_TABLE_BY_NAME":"#/components/schemas/DataWarehouseTableByName"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouseTableById"},{"$ref":"#/components/schemas/JsonPath1"},{"$ref":"#/components/schemas/DataWarehouseTableByName"},{"$ref":"#/components/schemas/DataWarehouseColumnByName1"},{"$ref":"#/components/schemas/DataWarehouseColumnById"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE_TABLE_BY_ID","JSON_PATH","DATA_WAREHOUSE_TABLE_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"DataWarehouseTableById":{"type":"object","properties":{"table_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_id"]},"JsonPath1":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"DataWarehouseTableByName":{"type":"object","properties":{"table_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_name"]},"DataWarehouseColumnByName1":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_id","mapping_group_id"]},"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}

> Delete object type definition

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}":{"delete":{"operationId":"deleteObjectTypeDefinition","parameters":[{"in":"path","required":true,"schema":{"type":"string"},"name":"datamart_id","style":"simple","explode":false},{"required":true,"schema":{"type":"string"},"name":"schema_id","explode":false,"in":"path","style":"simple"},{"required":true,"explode":false,"in":"path","style":"simple","schema":{"type":"string"},"name":"object_tree_id"},{"required":true,"explode":false,"in":"path","style":"simple","name":"object_type_definition_id","schema":{"type":"string"}}],"tags":["Runtime Schemas"],"responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"summary":"Delete object type definition","description":""}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/event\_names/{event\_name\_id}

> Get object tree event name

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/event_names/{event_name_id}":{"get":{"summary":"Get object tree event name","operationId":"getObjectTreeEventName","description":"","parameters":[{"explode":false,"required":true,"name":"datamart_id","schema":{"type":"string"},"style":"simple","in":"path"},{"schema":{"type":"string"},"style":"simple","explode":false,"in":"path","name":"schema_id","required":true},{"schema":{"type":"string"},"in":"path","name":"object_tree_id","explode":false,"style":"simple","required":true},{"required":true,"in":"path","style":"simple","name":"event_name_id","schema":{"type":"string"},"explode":false}],"tags":["Runtime Schemas"],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTreeEventNameResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"ObjectTreeEventNameResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static","MAPPING":"#/components/schemas/Mapping1"}},"oneOf":[{"$ref":"#/components/schemas/Static"},{"$ref":"#/components/schemas/Mapping1"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event_name":{"type":"string","readOnly":false}},"required":["event_name"]},"Mapping1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/event\_names/{event\_name\_id}

> Update object tree event name

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/event_names/{event_name_id}":{"put":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTreeEventNameResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"updateObjectTreeEventName","tags":["Runtime Schemas"],"requestBody":{"description":"The event name to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectTreeEventNameResource"}}},"required":true},"description":"","parameters":[{"in":"path","name":"datamart_id","style":"simple","required":true,"explode":false,"schema":{"type":"string"}},{"name":"schema_id","explode":false,"schema":{"type":"string"},"style":"simple","in":"path","required":true},{"style":"simple","required":true,"in":"path","name":"object_tree_id","schema":{"type":"string"},"explode":false},{"style":"simple","name":"event_name_id","in":"path","schema":{"type":"string"},"explode":false,"required":true}],"summary":"Update object tree event name"}}},"components":{"schemas":{"ObjectTreeEventNameResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static","MAPPING":"#/components/schemas/Mapping1"}},"oneOf":[{"$ref":"#/components/schemas/Static"},{"$ref":"#/components/schemas/Mapping1"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event_name":{"type":"string","readOnly":false}},"required":["event_name"]},"Mapping1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/event\_names/{event\_name\_id}

> Delete object tree event name

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/event_names/{event_name_id}":{"delete":{"summary":"Delete object tree event name","description":"","tags":["Runtime Schemas"],"responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"deleteObjectTreeEventName","parameters":[{"style":"simple","name":"datamart_id","in":"path","explode":false,"required":true,"schema":{"type":"string"}},{"name":"schema_id","explode":false,"style":"simple","schema":{"type":"string"},"in":"path","required":true},{"in":"path","required":true,"schema":{"type":"string"},"style":"simple","explode":false,"name":"object_tree_id"},{"in":"path","style":"simple","name":"event_name_id","explode":false,"required":true,"schema":{"type":"string"}}]}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/fields

> Get fields

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/fields":{"get":{"description":"","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FieldResource"}},"count":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"total":{"type":"integer"},"first_result":{"type":"integer"},"max_results":{"type":"integer"}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"summary":"Get fields","tags":["Runtime Schemas"],"operationId":"getFields","parameters":[{"schema":{"type":"integer","format":"int64"},"name":"datamart_id","explode":false,"in":"path","style":"simple","required":true},{"schema":{"type":"integer","format":"int64"},"style":"simple","name":"schema_id","explode":false,"in":"path","required":true},{"name":"object_type_id","style":"simple","explode":false,"in":"path","schema":{"type":"integer","format":"int64"},"required":true},{"style":"form","in":"query","required":false,"explode":true,"schema":{"type":"string"},"name":"name"},{"name":"keywords","in":"query","required":false,"schema":{"type":"string"},"explode":true,"style":"form"},{"required":false,"in":"query","style":"form","schema":{"type":"string"},"explode":true,"name":"field_type"},{"in":"query","name":"first_result","explode":true,"required":false,"schema":{"type":"integer","format":"int32"},"style":"form"},{"schema":{"type":"integer","format":"int32"},"style":"form","name":"max_results","explode":true,"in":"query","required":false}]}}},"components":{"schemas":{"FieldResource":{"allOf":[{"$ref":"#/components/schemas/AbstractFieldResource"},{"type":"object","properties":{"name":{"type":"string","readOnly":true},"id":{"type":"string","readOnly":true},"field_type":{"type":"string","readOnly":true},"object_like_type_id":{"type":"string","readOnly":true},"runtime_schema_id":{"type":"string","readOnly":true}},"required":["field_type","id","name","object_like_type_id","runtime_schema_id"]}]},"AbstractFieldResource":{"type":"object"},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/input\_stream\_configs

> Get object tree input stream configs

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/input_stream_configs":{"get":{"description":"","tags":["Runtime Schemas"],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/InputStreamConfigResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"summary":"Get object tree input stream configs","parameters":[{"required":true,"style":"simple","name":"datamart_id","in":"path","schema":{"type":"string"},"explode":false},{"explode":false,"name":"schema_id","required":true,"in":"path","style":"simple","schema":{"type":"string"}},{"explode":false,"required":true,"style":"simple","schema":{"type":"string"},"name":"object_tree_id","in":"path"},{"explode":false,"required":true,"schema":{"type":"string"},"in":"path","name":"object_type_definition_id","style":"simple"}],"operationId":"getInputStreamConfig"}}},"components":{"schemas":{"InputStreamConfigResource":{"type":"object","properties":{"working_table_name":{"type":"string","readOnly":true},"strategy":{"$ref":"#/components/schemas/CursorStrategy"},"data_warehouse_table_id":{"type":"string","readOnly":false},"object_type_definition_id":{"type":"string","readOnly":false},"use_processing_pipeline":{"type":"boolean","default":false,"readOnly":false},"document_import_id":{"type":"string","readOnly":true},"scheduling":{"$ref":"#/components/schemas/Scheduling"}},"required":["data_warehouse_table_id","document_import_id","scheduling","strategy","use_processing_pipeline"]},"CursorStrategy":{"discriminator":{"propertyName":"type","mapping":{"MODIFIED_TS":"#/components/schemas/ModifiedTs","HASH_TABLE":"#/components/schemas/HashTable","LOG":"#/components/schemas/Log","FULL_IMPORT":"#/components/schemas/FullImport"}},"oneOf":[{"$ref":"#/components/schemas/ModifiedTs"},{"$ref":"#/components/schemas/HashTable"},{"$ref":"#/components/schemas/Log"},{"$ref":"#/components/schemas/FullImport"}],"properties":{"type":{"type":"string","enum":["MODIFIED_TS","HASH_TABLE","LOG","FULL_IMPORT"]}},"required":["type"]},"ModifiedTs":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"HashTable":{"type":"object","properties":{"column_ids":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false}},"required":["column_ids"]},"Log":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"FullImport":{"type":"object"},"Scheduling":{"discriminator":{"propertyName":"type","mapping":{"FREQUENCY":"#/components/schemas/Frequency"}},"oneOf":[{"$ref":"#/components/schemas/Frequency"}],"properties":{"type":{"type":"string","enum":["FREQUENCY"]}},"required":["type"]},"Frequency":{"type":"object","properties":{"start_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/SchedulingUnit"},"time_zone":{"type":"string","readOnly":true},"end_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"value":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["time_zone","unit","value"]},"SchedulingUnit":{"type":"string","enum":["MINUTE","HOUR","DAY"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/input\_stream\_configs

> Create input stream config

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/input_stream_configs":{"post":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/InputStreamConfigResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"required":true,"explode":false,"name":"datamart_id","schema":{"type":"string"},"style":"simple","in":"path"},{"in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"name":"schema_id"},{"schema":{"type":"string"},"name":"object_tree_id","in":"path","explode":false,"required":true,"style":"simple"},{"schema":{"type":"string"},"required":true,"name":"object_type_definition_id","in":"path","explode":false,"style":"simple"}],"summary":"Create input stream config","requestBody":{"description":"The identifier to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputStreamConfigResource"}}},"required":true},"description":"","operationId":"createInputStreamConfig","tags":["Runtime Schemas"]}}},"components":{"schemas":{"InputStreamConfigResource":{"type":"object","properties":{"working_table_name":{"type":"string","readOnly":true},"strategy":{"$ref":"#/components/schemas/CursorStrategy"},"data_warehouse_table_id":{"type":"string","readOnly":false},"object_type_definition_id":{"type":"string","readOnly":false},"use_processing_pipeline":{"type":"boolean","default":false,"readOnly":false},"document_import_id":{"type":"string","readOnly":true},"scheduling":{"$ref":"#/components/schemas/Scheduling"}},"required":["data_warehouse_table_id","document_import_id","scheduling","strategy","use_processing_pipeline"]},"CursorStrategy":{"discriminator":{"propertyName":"type","mapping":{"MODIFIED_TS":"#/components/schemas/ModifiedTs","HASH_TABLE":"#/components/schemas/HashTable","LOG":"#/components/schemas/Log","FULL_IMPORT":"#/components/schemas/FullImport"}},"oneOf":[{"$ref":"#/components/schemas/ModifiedTs"},{"$ref":"#/components/schemas/HashTable"},{"$ref":"#/components/schemas/Log"},{"$ref":"#/components/schemas/FullImport"}],"properties":{"type":{"type":"string","enum":["MODIFIED_TS","HASH_TABLE","LOG","FULL_IMPORT"]}},"required":["type"]},"ModifiedTs":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"HashTable":{"type":"object","properties":{"column_ids":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false}},"required":["column_ids"]},"Log":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"FullImport":{"type":"object"},"Scheduling":{"discriminator":{"propertyName":"type","mapping":{"FREQUENCY":"#/components/schemas/Frequency"}},"oneOf":[{"$ref":"#/components/schemas/Frequency"}],"properties":{"type":{"type":"string","enum":["FREQUENCY"]}},"required":["type"]},"Frequency":{"type":"object","properties":{"start_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/SchedulingUnit"},"time_zone":{"type":"string","readOnly":true},"end_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"value":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["time_zone","unit","value"]},"SchedulingUnit":{"type":"string","enum":["MINUTE","HOUR","DAY"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/input\_stream\_configs

> Update input stream config

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/input_stream_configs":{"put":{"operationId":"updateInputStreamConfig","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/InputStreamConfigResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"requestBody":{"description":"The identifier to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputStreamConfigResource"}}},"required":true},"tags":["Runtime Schemas"],"parameters":[{"in":"path","style":"simple","explode":false,"required":true,"name":"datamart_id","schema":{"type":"string"}},{"explode":false,"required":true,"name":"schema_id","schema":{"type":"string"},"in":"path","style":"simple"},{"in":"path","style":"simple","schema":{"type":"string"},"name":"object_tree_id","required":true,"explode":false},{"in":"path","schema":{"type":"string"},"name":"object_type_definition_id","explode":false,"style":"simple","required":true}],"description":"","summary":"Update input stream config"}}},"components":{"schemas":{"InputStreamConfigResource":{"type":"object","properties":{"working_table_name":{"type":"string","readOnly":true},"strategy":{"$ref":"#/components/schemas/CursorStrategy"},"data_warehouse_table_id":{"type":"string","readOnly":false},"object_type_definition_id":{"type":"string","readOnly":false},"use_processing_pipeline":{"type":"boolean","default":false,"readOnly":false},"document_import_id":{"type":"string","readOnly":true},"scheduling":{"$ref":"#/components/schemas/Scheduling"}},"required":["data_warehouse_table_id","document_import_id","scheduling","strategy","use_processing_pipeline"]},"CursorStrategy":{"discriminator":{"propertyName":"type","mapping":{"MODIFIED_TS":"#/components/schemas/ModifiedTs","HASH_TABLE":"#/components/schemas/HashTable","LOG":"#/components/schemas/Log","FULL_IMPORT":"#/components/schemas/FullImport"}},"oneOf":[{"$ref":"#/components/schemas/ModifiedTs"},{"$ref":"#/components/schemas/HashTable"},{"$ref":"#/components/schemas/Log"},{"$ref":"#/components/schemas/FullImport"}],"properties":{"type":{"type":"string","enum":["MODIFIED_TS","HASH_TABLE","LOG","FULL_IMPORT"]}},"required":["type"]},"ModifiedTs":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"HashTable":{"type":"object","properties":{"column_ids":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false}},"required":["column_ids"]},"Log":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"FullImport":{"type":"object"},"Scheduling":{"discriminator":{"propertyName":"type","mapping":{"FREQUENCY":"#/components/schemas/Frequency"}},"oneOf":[{"$ref":"#/components/schemas/Frequency"}],"properties":{"type":{"type":"string","enum":["FREQUENCY"]}},"required":["type"]},"Frequency":{"type":"object","properties":{"start_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/SchedulingUnit"},"time_zone":{"type":"string","readOnly":true},"end_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"value":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["time_zone","unit","value"]},"SchedulingUnit":{"type":"string","enum":["MINUTE","HOUR","DAY"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/object\_type\_definitions/{object\_type\_definition\_id}/input\_stream\_configs

> Delete input stream config

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/object_type_definitions/{object_type_definition_id}/input_stream_configs":{"delete":{"tags":["Runtime Schemas"],"operationId":"deleteInputStreamConfig","responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","parameters":[{"style":"simple","name":"datamart_id","in":"path","schema":{"type":"string"},"explode":false,"required":true},{"in":"path","explode":false,"name":"schema_id","style":"simple","required":true,"schema":{"type":"string"}},{"explode":false,"style":"simple","required":true,"in":"path","schema":{"type":"string"},"name":"object_tree_id"},{"name":"object_type_definition_id","explode":false,"schema":{"type":"string"},"required":true,"style":"simple","in":"path"}],"summary":"Delete input stream config"}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## Get full graphdb ORM schema as text

> Aggregates all object trees of the schema and returns the full ORM schema

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_orm_schemas/{schema_id}/text":{"get":{"operationId":"getFullGraphDbORMSchemaAsText","tags":["Runtime Schemas"],"parameters":[{"required":true,"schema":{"type":"string"},"in":"path","explode":false,"style":"simple","name":"datamart_id","description":"The datamart owning the schema."},{"required":true,"in":"path","name":"schema_id","description":"The schema to get as full text.","style":"simple","explode":false,"schema":{"type":"string"}},{"schema":{"type":"string"},"name":"mapping_group_id","required":false,"in":"query","style":"form","description":"The object tree mapping group to get as text.","explode":true}],"summary":"Get full graphdb ORM schema as text","description":"Aggregates all object trees of the schema and returns the full ORM schema","responses":{"200":{"description":"Success !","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types

> Get object types

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types":{"get":{"operationId":"getObjectTypes","description":"","summary":"Get object types","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"max_results":{"type":"integer"},"total":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"first_result":{"type":"integer"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ObjectLikeTypeResource"}}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"explode":false,"schema":{"type":"integer","format":"int64"},"style":"simple","name":"datamart_id","required":true,"in":"path"},{"explode":false,"in":"path","name":"schema_id","style":"simple","schema":{"type":"integer","format":"int64"},"required":true},{"style":"form","name":"name","in":"query","explode":true,"required":false,"schema":{"type":"string"}},{"style":"form","name":"keywords","schema":{"type":"string"},"required":false,"explode":true,"in":"query"},{"explode":true,"style":"form","schema":{"type":"integer","format":"int32"},"name":"first_result","required":false,"in":"query"},{"schema":{"type":"integer","format":"int32"},"name":"max_results","explode":true,"required":false,"in":"query","style":"form"}],"tags":["Runtime Schemas"]}}},"components":{"schemas":{"ObjectLikeTypeResource":{"allOf":[{"$ref":"#/components/schemas/AbstractObjectLikeTypeResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"runtime_schema_id":{"type":"string","readOnly":true},"type":{"$ref":"#/components/schemas/ObjectLikeType"},"name":{"type":"string","readOnly":false}},"required":["id","name","runtime_schema_id","type"]}]},"AbstractObjectLikeTypeResource":{"type":"object"},"ObjectLikeType":{"type":"string","enum":["OBJECT_TYPE","INTERFACE_TYPE"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/data\_warehouse\_live\_ingestion\_config

> Get data warehouse live ingestion config for object tree

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/data_warehouse_live_ingestion_config":{"get":{"operationId":"getDataWarehouseLiveIngestionConfig","summary":"Get data warehouse live ingestion config for object tree","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionConfigResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"style":"simple","name":"datamart_id","explode":false,"schema":{"type":"string"},"required":true,"in":"path"},{"required":true,"schema":{"type":"string"},"explode":false,"in":"path","style":"simple","name":"schema_id"},{"explode":false,"required":true,"style":"simple","schema":{"type":"string"},"in":"path","name":"object_tree_id"}],"description":"","tags":["Runtime Schemas"]}}},"components":{"schemas":{"ObjectTreeDataWarehouseLiveIngestionConfigResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false},"status":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionStatus"},"object_tree_id":{"type":"string","readOnly":false},"creation_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"bucket_name":{"type":"string","readOnly":false},"data_warehouse_id":{"type":"string","readOnly":false}},"required":["bucket_name","creation_ts","data_warehouse_id","datamart_id","id","name","object_tree_id","status"]},"ObjectTreeDataWarehouseLiveIngestionStatus":{"type":"string","enum":["WAITING_FOR_TABLE_CREATION","PAUSED","ACTIVE"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/data\_warehouse\_live\_ingestion\_config

> Create or update data warehouse live ingestion config for object tree

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/data_warehouse_live_ingestion_config":{"put":{"summary":"Create or update data warehouse live ingestion config for object tree","parameters":[{"schema":{"type":"string"},"in":"path","required":true,"name":"datamart_id","style":"simple","explode":false},{"explode":false,"schema":{"type":"string"},"name":"schema_id","style":"simple","in":"path","required":true},{"required":true,"in":"path","explode":false,"schema":{"type":"string"},"style":"simple","name":"object_tree_id"}],"operationId":"upsertDataWarehouseLiveIngestionConfig","requestBody":{"description":"The data warehouse live ingestion config to create or update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionConfigResource"}}},"required":true},"description":"","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionConfigResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Runtime Schemas"]}}},"components":{"schemas":{"ObjectTreeDataWarehouseLiveIngestionConfigResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false},"status":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionStatus"},"object_tree_id":{"type":"string","readOnly":false},"creation_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"bucket_name":{"type":"string","readOnly":false},"data_warehouse_id":{"type":"string","readOnly":false}},"required":["bucket_name","creation_ts","data_warehouse_id","datamart_id","id","name","object_tree_id","status"]},"ObjectTreeDataWarehouseLiveIngestionStatus":{"type":"string","enum":["WAITING_FOR_TABLE_CREATION","PAUSED","ACTIVE"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/data\_warehouse\_live\_ingestion\_config

> Delete data warehouse live ingestion config for object tree

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/data_warehouse_live_ingestion_config":{"delete":{"parameters":[{"required":true,"name":"datamart_id","schema":{"type":"string"},"in":"path","explode":false,"style":"simple"},{"schema":{"type":"string"},"style":"simple","required":true,"explode":false,"in":"path","name":"schema_id"},{"in":"path","required":true,"style":"simple","name":"object_tree_id","explode":false,"schema":{"type":"string"}}],"description":"","responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Runtime Schemas"],"operationId":"deleteDataWarehouseLiveIngestionConfig","summary":"Delete data warehouse live ingestion config for object tree"}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/directives/{id}

> Get directive by id

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/directives/{id}":{"get":{"operationId":"getObjectTypeDirective","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectLikeTypeDirectiveResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Runtime Schemas"],"summary":"Get directive by id","description":"","parameters":[{"schema":{"type":"integer","format":"int64"},"explode":false,"style":"simple","name":"datamart_id","required":true,"in":"path"},{"required":true,"style":"simple","schema":{"type":"integer","format":"int64"},"name":"schema_id","in":"path","explode":false},{"style":"simple","schema":{"type":"integer","format":"int64"},"explode":false,"name":"object_type_id","required":true,"in":"path"},{"name":"id","in":"path","schema":{"type":"integer","format":"int64"},"required":true,"explode":false,"style":"simple"}]}}},"components":{"schemas":{"ObjectLikeTypeDirectiveResource":{"allOf":[{"$ref":"#/components/schemas/AbstractObjectLikeTypeDirectiveResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"$ref":"#/components/schemas/ObjectLikeType"},"name":{"type":"string","readOnly":false}},"required":["id","name","type"]}]},"AbstractObjectLikeTypeDirectiveResource":{"type":"object"},"ObjectLikeType":{"type":"string","enum":["OBJECT_TYPE","INTERFACE_TYPE"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/predefined\_object\_trees/action

> Enable or disable predefined object tree like mappings, clustering\_cohort

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/predefined_object_trees/action":{"post":{"operationId":"predefinedObjectTreeActions","responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","parameters":[{"style":"simple","name":"datamart_id","required":true,"schema":{"type":"string"},"explode":false,"in":"path"},{"required":true,"style":"simple","schema":{"type":"string"},"explode":false,"name":"schema_id","in":"path"}],"tags":["Runtime Schemas"],"summary":"Enable or disable predefined object tree like mappings, clustering_cohort","requestBody":{"description":"The action to perform","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedObjectTreeActionRequest"}}},"required":true}}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]},"PredefinedObjectTreeActionRequest":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/PredefinedObjectTreeAction"},"args":{"$ref":"#/components/schemas/PredefinedObjectTreeActionRequestArgs"}},"required":["action","args"]},"PredefinedObjectTreeAction":{"type":"string","enum":["ENABLE","DISABLE"],"readOnly":false},"PredefinedObjectTreeActionRequestArgs":{"type":"object","properties":{"predefined_object_tree":{"type":"string","readOnly":false}},"required":["predefined_object_tree"]}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/clone

> Clone a runtime schema

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/clone":{"post":{"tags":["Runtime Schemas"],"operationId":"cloneRuntimeSchema","summary":"Clone a runtime schema","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/RuntimeSchemaResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"in":"path","explode":false,"schema":{"type":"integer","format":"int64"},"description":"The datamart owning the schema.","required":true,"name":"datamart_id","style":"simple"},{"explode":false,"in":"path","required":true,"schema":{"type":"integer","format":"int64"},"description":"The schema to clone.","style":"simple","name":"schema_id"}],"description":""}}},"components":{"schemas":{"RuntimeSchemaResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"creation_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"last_modification_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"publication_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"datamart_id":{"type":"string","readOnly":true},"schema_type":{"$ref":"#/components/schemas/DatamartSchemaType"},"status":{"$ref":"#/components/schemas/SchemaStatus"},"suspension_date":{"type":"integer","format":"int64","default":0,"readOnly":true}},"required":["creation_date","datamart_id","id","last_modification_date","publication_date","schema_type","status"]},"DatamartSchemaType":{"type":"string","enum":["OBJECT_TREE","PLAIN_TEXT"],"readOnly":false},"SchemaStatus":{"type":"string","enum":["DRAFT","PUBLISHED","LIVE","SUSPENDED","ARCHIVED","actives"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/schema\_decorators

> Get all schema decorators for this runtime schema.

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/schema_decorators":{"get":{"parameters":[{"name":"datamart_id","required":true,"explode":false,"style":"simple","in":"path","schema":{"type":"integer","format":"int64"}},{"required":true,"schema":{"type":"integer","format":"int64"},"style":"simple","name":"schema_id","explode":false,"in":"path"}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"first_result":{"type":"integer"},"total":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDecoratorResource"}},"max_results":{"type":"integer"},"count":{"type":"integer"},"status":{"type":"string","enum":["ok"]}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"summary":"Get all schema decorators for this runtime schema.","operationId":"getSchemaDecorators","description":"","tags":["Runtime Schemas"]}}},"components":{"schemas":{"SchemaDecoratorResource":{"type":"object","properties":{"help_text":{"type":"string","readOnly":false},"hidden":{"type":"boolean","default":false,"readOnly":false},"field_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":false},"object_name":{"type":"string","readOnly":false},"locale":{"type":"string","enum":["fr-FR","de-DE","en-GB","en-US","es-ES"],"readOnly":false},"label":{"type":"string","readOnly":false},"schema_id":{"type":"string","readOnly":false}},"required":["datamart_id","field_name","hidden","id","label","locale","object_name","schema_id"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/schema\_decorators

> Update all the schema decorators for this runtime schema.

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/schema_decorators":{"post":{"operationId":"putSchemaDecorators","requestBody":{"description":"The new schema decorators","content":{"text/csv":{"schema":{"type":"string"}}},"required":true},"description":"","parameters":[{"in":"path","style":"simple","schema":{"type":"integer","format":"int64"},"explode":false,"required":true,"name":"datamart_id"},{"style":"simple","name":"schema_id","explode":false,"required":true,"schema":{"type":"integer","format":"int64"},"in":"path"}],"summary":"Update all the schema decorators for this runtime schema.","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDecoratorResource"}},"total":{"type":"integer"},"first_result":{"type":"integer"},"count":{"type":"integer"},"max_results":{"type":"integer"}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Runtime Schemas"]}}},"components":{"schemas":{"SchemaDecoratorResource":{"type":"object","properties":{"help_text":{"type":"string","readOnly":false},"hidden":{"type":"boolean","default":false,"readOnly":false},"field_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":false},"object_name":{"type":"string","readOnly":false},"locale":{"type":"string","enum":["fr-FR","de-DE","en-GB","en-US","es-ES"],"readOnly":false},"label":{"type":"string","readOnly":false},"schema_id":{"type":"string","readOnly":false}},"required":["datamart_id","field_name","hidden","id","label","locale","object_name","schema_id"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/schema\_decorators

> Delete all schema decorators for a given schema id

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/schema_decorators":{"delete":{"description":"","summary":"Delete all schema decorators for a given schema id","responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"deleteSchemaDecorators","parameters":[{"required":true,"name":"datamart_id","in":"path","schema":{"type":"integer","format":"int64"},"style":"simple","explode":false},{"schema":{"type":"integer","format":"int64"},"required":true,"name":"schema_id","style":"simple","explode":false,"in":"path"}],"tags":["Runtime Schemas"]}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/directives

> Get directives

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/directives":{"get":{"description":"","operationId":"getObjectTypeDirectives","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"count":{"type":"integer"},"max_results":{"type":"integer"},"total":{"type":"integer"},"first_result":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ObjectLikeTypeDirectiveResource"}}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"style":"simple","in":"path","required":true,"schema":{"type":"integer","format":"int64"},"name":"datamart_id","explode":false},{"required":true,"explode":false,"style":"simple","schema":{"type":"integer","format":"int64"},"name":"schema_id","in":"path"},{"explode":false,"required":true,"schema":{"type":"integer","format":"int64"},"name":"object_type_id","in":"path","style":"simple"},{"name":"name","in":"query","style":"form","schema":{"type":"string"},"explode":true,"required":false},{"required":false,"explode":true,"name":"keywords","schema":{"type":"string"},"style":"form","in":"query"},{"name":"comment","in":"query","schema":{"type":"string"},"style":"form","explode":true,"required":false},{"explode":true,"name":"first_result","schema":{"type":"integer","format":"int32"},"in":"query","style":"form","required":false},{"name":"max_results","schema":{"type":"integer","format":"int32"},"in":"query","style":"form","explode":true,"required":false}],"summary":"Get directives","tags":["Runtime Schemas"]}}},"components":{"schemas":{"ObjectLikeTypeDirectiveResource":{"allOf":[{"$ref":"#/components/schemas/AbstractObjectLikeTypeDirectiveResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"$ref":"#/components/schemas/ObjectLikeType"},"name":{"type":"string","readOnly":false}},"required":["id","name","type"]}]},"AbstractObjectLikeTypeDirectiveResource":{"type":"object"},"ObjectLikeType":{"type":"string","enum":["OBJECT_TYPE","INTERFACE_TYPE"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/fields/{field\_id}/directives/{directive\_id}/arguments

> Get field arguments

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/fields/{field_id}/directives/{directive_id}/arguments":{"get":{"parameters":[{"explode":false,"in":"path","schema":{"type":"integer","format":"int64"},"name":"datamart_id","style":"simple","required":true},{"style":"simple","in":"path","explode":false,"schema":{"type":"integer","format":"int64"},"name":"schema_id","required":true},{"explode":false,"schema":{"type":"integer","format":"int64"},"style":"simple","required":true,"in":"path","name":"object_type_id"},{"in":"path","style":"simple","schema":{"type":"integer","format":"int64"},"name":"field_id","explode":false,"required":true},{"explode":false,"name":"directive_id","required":true,"style":"simple","schema":{"type":"integer","format":"int64"},"in":"path"},{"explode":true,"name":"name","schema":{"type":"string"},"required":false,"in":"query","style":"form"},{"schema":{"type":"string"},"style":"form","name":"keywords","explode":true,"in":"query","required":false},{"in":"query","schema":{"type":"string"},"name":"comment","required":false,"explode":true,"style":"form"},{"schema":{"type":"integer","format":"int32"},"required":false,"explode":true,"in":"query","style":"form","name":"first_result"},{"in":"query","required":false,"name":"max_results","style":"form","schema":{"type":"integer","format":"int32"},"explode":true}],"tags":["Runtime Schemas"],"description":"","operationId":"getFieldArguments","summary":"Get field arguments","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"count":{"type":"integer"},"total":{"type":"integer"},"max_results":{"type":"integer"},"first_result":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DirectiveArgumentResource"}}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"DirectiveArgumentResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"directive_id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false}},"required":["directive_id","id","name","value"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/schema\_check

> Check the runtime schema

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/schema_check":{"post":{"description":"","parameters":[{"required":true,"name":"datamart_id","in":"path","style":"simple","schema":{"type":"integer","format":"int64"},"explode":false}],"requestBody":{"description":"The schema document to validate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryValidationRequest"}}},"required":true},"operationId":"checkRuntimeSchema","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/SchemaValidationResponse"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"summary":"Check the runtime schema","tags":["Runtime Schemas"]}}},"components":{"schemas":{"QueryValidationRequest":{"type":"object","properties":{"query":{"type":"string","readOnly":false}},"required":["query"]},"SchemaValidationResponse":{"discriminator":{"propertyName":"type","mapping":{"VALID":"#/components/schemas/SchemaValidationOkResponse","PARSING_ERROR":"#/components/schemas/SchemaParsingErrorResponse","VALIDATION_ERROR":"#/components/schemas/SchemaValidationErrorResponse"}},"oneOf":[{"$ref":"#/components/schemas/SchemaValidationOkResponse"},{"$ref":"#/components/schemas/SchemaParsingErrorResponse"},{"$ref":"#/components/schemas/SchemaValidationErrorResponse"}],"properties":{"type":{"type":"string","enum":["VALID","PARSING_ERROR","VALIDATION_ERROR"]}},"required":["type"]},"SchemaValidationOkResponse":{"type":"object"},"SchemaParsingErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/SchemaParsingError"}},"required":["error"]},"SchemaParsingError":{"type":"object","properties":{"message":{"type":"string","readOnly":false},"position":{"$ref":"#/components/schemas/PositionResource"}},"required":["message","position"]},"PositionResource":{"type":"object","properties":{"row":{"type":"integer","format":"int32","default":0,"readOnly":false},"col":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["col","row"]},"SchemaValidationErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/SchemaValidationErrorResource"},"readOnly":false}},"required":["errors"]},"SchemaValidationErrorResource":{"type":"object","properties":{"message":{"type":"string","readOnly":false},"position":{"$ref":"#/components/schemas/PositionResource"}},"required":["message"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/text

> Get runtime schema as text

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/text":{"get":{"operationId":"getRuntimeSchemaAsText","description":"","responses":{"200":{"description":"Success !","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"description":"The datamart owning the schema.","schema":{"type":"integer","format":"int64"},"name":"datamart_id","style":"simple","in":"path","required":true,"explode":false},{"style":"simple","name":"schema_id","required":true,"description":"The schema to get as text.","explode":false,"in":"path","schema":{"type":"integer","format":"int64"}}],"tags":["Runtime Schemas"],"summary":"Get runtime schema as text"}}},"components":{"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/text

> Update runtime schema by text

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/text":{"put":{"tags":["Runtime Schemas"],"description":"","requestBody":{"description":"The new schema content.","content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"parameters":[{"name":"datamart_id","schema":{"type":"integer","format":"int64"},"description":"The datamart owning the schema.","in":"path","style":"simple","required":true,"explode":false},{"name":"schema_id","schema":{"type":"integer","format":"int64"},"in":"path","required":true,"explode":false,"description":"The schema to update with text.","style":"simple"}],"summary":"Update runtime schema by text","responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"updateRuntimeSchemaByText"}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/publication

> Publish runtime schema

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Mediarithmics most used API","description":"These operations where flagged by mediarithmics teams as most useful."},{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/publication":{"post":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/RuntimeSchemaPublicationInfoResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"description":"The datamart owning the schema.","required":true,"explode":false,"style":"simple","in":"path","name":"datamart_id","schema":{"type":"integer","format":"int64"}},{"style":"simple","explode":false,"in":"path","description":"The schema to publish.","name":"schema_id","schema":{"type":"integer","format":"int64"},"required":true}],"operationId":"publishRuntimeSchema","tags":["Runtime Schemas","Mediarithmics most used API"],"summary":"Publish runtime schema","description":""}}},"components":{"schemas":{"RuntimeSchemaPublicationInfoResource":{"type":"object","properties":{"datamart_id":{"type":"string","readOnly":false},"schema_id":{"type":"string","readOnly":false},"tree_indices":{"type":"array","items":{"$ref":"#/components/schemas/TreeIndexPublicationInfoResource"},"readOnly":false}},"required":["datamart_id","schema_id","tree_indices"]},"TreeIndexPublicationInfoResource":{"allOf":[{"$ref":"#/components/schemas/IndexDriverVersion"},{"type":"object","properties":{"driver_version_major_number":{"type":"integer","format":"int32","default":0,"readOnly":false},"init_job":{"$ref":"#/components/schemas/TreeIndexJobType"},"init_strategy":{"$ref":"#/components/schemas/TreeIndexInitStrategy"},"driver_version_minor_number":{"type":"integer","format":"int32","default":0,"readOnly":false},"object_tree_index_cluster_id":{"type":"string","readOnly":false},"index_id":{"type":"string","readOnly":false},"new_index":{"type":"boolean","default":false,"readOnly":false},"index_name":{"type":"string","readOnly":false},"index_size":{"$ref":"#/components/schemas/TreeIndexSize"}},"required":["driver_version_major_number","driver_version_minor_number","index_id","index_name","index_size","init_strategy","new_index","object_tree_index_cluster_id"]}]},"IndexDriverVersion":{"type":"object"},"TreeIndexJobType":{"type":"string","enum":["CURSOR_BASED_FULL_BUILD","INDEX_BASED_FULL_BUILD","IN_PLACE_REFRESH"],"readOnly":false},"TreeIndexInitStrategy":{"type":"string","enum":["AUTOMATIC","FORCE_BUILD_FROM_CURSOR","FORCE_BUILD_FROM_INDEX","FORCE_NO_BUILD","MANUAL"],"readOnly":false},"TreeIndexSize":{"type":"string","enum":["SMALL","MEDIUM","LARGE","X_LARGE","XX_LARGE","XXX_LARGE","EXTRA_LARGE","XXXX_LARGE"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/fields/{field\_id}/directives/{directive\_id}/arguments/{id}

> Get field argument by id

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/fields/{field_id}/directives/{directive_id}/arguments/{id}":{"get":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/DirectiveArgumentResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","summary":"Get field argument by id","operationId":"getFieldArgument","tags":["Runtime Schemas"],"parameters":[{"schema":{"type":"integer","format":"int64"},"name":"datamart_id","required":true,"explode":false,"style":"simple","in":"path"},{"schema":{"type":"integer","format":"int64"},"style":"simple","explode":false,"in":"path","name":"schema_id","required":true},{"in":"path","required":true,"schema":{"type":"integer","format":"int64"},"explode":false,"style":"simple","name":"object_type_id"},{"name":"field_id","schema":{"type":"integer","format":"int64"},"explode":false,"in":"path","style":"simple","required":true},{"required":true,"schema":{"type":"integer","format":"int64"},"in":"path","style":"simple","explode":false,"name":"directive_id"},{"required":true,"style":"simple","name":"id","schema":{"type":"integer","format":"int64"},"in":"path","explode":false}]}}},"components":{"schemas":{"DirectiveArgumentResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"directive_id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false}},"required":["directive_id","id","name","value"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/tree\_index\_selections

> Get the tree index selections for the schema

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/tree_index_selections":{"get":{"parameters":[{"name":"datamart_id","required":true,"in":"path","style":"simple","schema":{"type":"integer","format":"int64"},"explode":false},{"name":"schema_id","in":"path","schema":{"type":"integer","format":"int64"},"style":"simple","required":true,"explode":false}],"tags":["Runtime Schemas"],"summary":"Get the tree index selections for the schema","operationId":"findTreeIndexSelections","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"count":{"type":"integer"},"max_results":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TreeIndexSelectionInfoResource"}},"first_result":{"type":"integer"}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":""}}},"components":{"schemas":{"TreeIndexSelectionInfoResource":{"allOf":[{"$ref":"#/components/schemas/TreeIndexMetaData"},{"type":"object","properties":{"size":{"$ref":"#/components/schemas/TreeIndexSize"},"technical_device_migrated":{"type":"boolean","default":false,"readOnly":false},"index_name":{"type":"string","readOnly":true},"status":{"$ref":"#/components/schemas/TreeIndexStatus"},"driver_version_minor_number":{"type":"integer","format":"int32","default":0,"readOnly":false},"datamart_id":{"format":"int64","default":0,"readOnly":true,"type":"integer"},"init_strategy":{"$ref":"#/components/schemas/TreeIndexInitStrategy"},"driver_version_major_number":{"type":"integer","format":"int32","default":0,"readOnly":false},"id":{"type":"integer","format":"int64","default":0,"readOnly":true},"index_id":{"format":"int64","default":0,"type":"integer","readOnly":true},"object_tree_index_cluster_id":{"type":"string","readOnly":false},"datafarm":{"type":"string","readOnly":true}},"required":["datafarm","datamart_id","driver_version_major_number","driver_version_minor_number","id","index_name","object_tree_index_cluster_id","technical_device_migrated"]}]},"TreeIndexMetaData":{"allOf":[{"$ref":"#/components/schemas/IndexDriverVersion"},{"type":"object"}]},"IndexDriverVersion":{"type":"object"},"TreeIndexSize":{"type":"string","enum":["SMALL","MEDIUM","LARGE","X_LARGE","XX_LARGE","XXX_LARGE","EXTRA_LARGE","XXXX_LARGE"],"readOnly":false},"TreeIndexStatus":{"type":"string","enum":["DRAFT","PUBLISHED","LIVE","ARCHIVED","actives"],"readOnly":false},"TreeIndexInitStrategy":{"type":"string","enum":["AUTOMATIC","FORCE_BUILD_FROM_CURSOR","FORCE_BUILD_FROM_INDEX","FORCE_NO_BUILD","MANUAL"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/directives/{directive\_id}/arguments

> Get arguments

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/directives/{directive_id}/arguments":{"get":{"tags":["Runtime Schemas"],"parameters":[{"required":true,"schema":{"type":"integer","format":"int64"},"style":"simple","name":"datamart_id","in":"path","explode":false},{"style":"simple","required":true,"schema":{"type":"integer","format":"int64"},"explode":false,"name":"schema_id","in":"path"},{"required":true,"in":"path","explode":false,"style":"simple","schema":{"type":"integer","format":"int64"},"name":"object_type_id"},{"in":"path","name":"directive_id","explode":false,"required":true,"schema":{"type":"integer","format":"int64"},"style":"simple"},{"in":"query","style":"form","schema":{"type":"string"},"explode":true,"name":"name","required":false},{"required":false,"style":"form","schema":{"type":"string"},"name":"keywords","in":"query","explode":true},{"in":"query","name":"comment","explode":true,"style":"form","schema":{"type":"string"},"required":false},{"style":"form","explode":true,"schema":{"type":"integer","format":"int32"},"name":"first_result","in":"query","required":false},{"in":"query","style":"form","name":"max_results","schema":{"type":"integer","format":"int32"},"explode":true,"required":false}],"operationId":"getArguments","summary":"Get arguments","description":"","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"first_result":{"type":"integer"},"total":{"type":"integer"},"count":{"type":"integer"},"max_results":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DirectiveArgumentResource"}},"status":{"type":"string","enum":["ok"]}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"DirectiveArgumentResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"directive_id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false}},"required":["directive_id","id","name","value"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/fields/{field\_id}/directives

> Get field directives

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/fields/{field_id}/directives":{"get":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"first_result":{"type":"integer"},"max_results":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FieldDirectiveResource"}},"total":{"type":"integer"}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"getFieldDirectives","tags":["Runtime Schemas"],"summary":"Get field directives","description":"","parameters":[{"name":"datamart_id","required":true,"explode":false,"in":"path","schema":{"type":"integer","format":"int64"},"style":"simple"},{"style":"simple","explode":false,"in":"path","required":true,"name":"schema_id","schema":{"type":"integer","format":"int64"}},{"name":"object_type_id","schema":{"type":"integer","format":"int64"},"required":true,"style":"simple","in":"path","explode":false},{"required":true,"explode":false,"name":"field_id","in":"path","schema":{"type":"integer","format":"int64"},"style":"simple"},{"name":"name","explode":true,"required":false,"style":"form","schema":{"type":"string"},"in":"query"},{"in":"query","name":"keywords","schema":{"type":"string"},"required":false,"explode":true,"style":"form"},{"in":"query","name":"comment","required":false,"schema":{"type":"string"},"style":"form","explode":true},{"required":false,"in":"query","name":"first_result","schema":{"type":"integer","format":"int32"},"style":"form","explode":true},{"style":"form","required":false,"schema":{"type":"integer","format":"int32"},"name":"max_results","explode":true,"in":"query"}]}}},"components":{"schemas":{"FieldDirectiveResource":{"allOf":[{"$ref":"#/components/schemas/AbstractFieldDirectiveResource"},{"type":"object","properties":{"runtime_schema_id":{"type":"string","readOnly":true},"field_id":{"type":"string","readOnly":true},"id":{"type":"string","readOnly":true},"comment":{"type":"string","readOnly":false},"object_like_type_id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false}},"required":["comment","field_id","id","name","object_like_type_id","runtime_schema_id"]}]},"AbstractFieldDirectiveResource":{"type":"object"},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/identifiers/{object\_tree\_identifier\_id}

> Get object tree identifier

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/identifiers/{object_tree_identifier_id}":{"get":{"operationId":"getObjectTreeIdentifier","description":"","summary":"Get object tree identifier","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/Generic"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Runtime Schemas"],"parameters":[{"required":true,"schema":{"type":"string"},"style":"simple","explode":false,"in":"path","name":"datamart_id"},{"name":"schema_id","required":true,"explode":false,"style":"simple","schema":{"type":"string"},"in":"path"},{"explode":false,"in":"path","schema":{"type":"string"},"required":true,"style":"simple","name":"object_tree_id"},{"schema":{"type":"string"},"explode":false,"style":"simple","name":"object_tree_identifier_id","required":true,"in":"path"}]}}},"components":{"schemas":{"Generic":{"allOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"main":{"type":"boolean","default":false,"readOnly":false},"realm_id":{"type":"string","readOnly":false},"location":{"$ref":"#/components/schemas/ObjectTreeIdentifierLocationResource"},"identifier_type":{"$ref":"#/components/schemas/IdentifierType"}},"required":["id","identifier_type","main"]}]},"ObjectTreeIdentifierResource":{"type":"object"},"ObjectTreeIdentifierLocationResource":{"discriminator":{"propertyName":"type","mapping":{"COLUMN_LOCATION":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource","FIELD_LOCATION":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}},"oneOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource"},{"$ref":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}],"properties":{"type":{"type":"string","enum":["COLUMN_LOCATION","FIELD_LOCATION"]}},"required":["type"]},"ObjectTreeIdentifierColumnLocationResource":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeIdentifierFieldLocationResource":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"IdentifierType":{"type":"string","enum":["EMAIL_HASH","USER_ACCOUNT","USER_POINT_ID","DEVICE_POINT","DEVICE_TECHNICAL_ID"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/identifiers/{object\_tree\_identifier\_id}

> Update object tree identifier

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/identifiers/{object_tree_identifier_id}":{"put":{"operationId":"updateObjectTreeIdentifier","requestBody":{"description":"The identifier to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Generic"}}},"required":true},"summary":"Update object tree identifier","parameters":[{"explode":false,"style":"simple","name":"datamart_id","schema":{"type":"string"},"in":"path","required":true},{"required":true,"schema":{"type":"string"},"in":"path","style":"simple","name":"schema_id","explode":false},{"required":true,"in":"path","style":"simple","explode":false,"name":"object_tree_id","schema":{"type":"string"}},{"in":"path","schema":{"type":"string"},"name":"object_tree_identifier_id","style":"simple","required":true,"explode":false}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/Generic"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","tags":["Runtime Schemas"]}}},"components":{"schemas":{"Generic":{"allOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"main":{"type":"boolean","default":false,"readOnly":false},"realm_id":{"type":"string","readOnly":false},"location":{"$ref":"#/components/schemas/ObjectTreeIdentifierLocationResource"},"identifier_type":{"$ref":"#/components/schemas/IdentifierType"}},"required":["id","identifier_type","main"]}]},"ObjectTreeIdentifierResource":{"type":"object"},"ObjectTreeIdentifierLocationResource":{"discriminator":{"propertyName":"type","mapping":{"COLUMN_LOCATION":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource","FIELD_LOCATION":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}},"oneOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource"},{"$ref":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}],"properties":{"type":{"type":"string","enum":["COLUMN_LOCATION","FIELD_LOCATION"]}},"required":["type"]},"ObjectTreeIdentifierColumnLocationResource":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeIdentifierFieldLocationResource":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"IdentifierType":{"type":"string","enum":["EMAIL_HASH","USER_ACCOUNT","USER_POINT_ID","DEVICE_POINT","DEVICE_TECHNICAL_ID"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/identifiers/{object\_tree\_identifier\_id}

> Delete object tree identifier

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/identifiers/{object_tree_identifier_id}":{"delete":{"tags":["Runtime Schemas"],"parameters":[{"name":"datamart_id","in":"path","style":"simple","explode":false,"schema":{"type":"string"},"required":true},{"schema":{"type":"string"},"explode":false,"in":"path","name":"schema_id","style":"simple","required":true},{"required":true,"in":"path","explode":false,"schema":{"type":"string"},"style":"simple","name":"object_tree_id"},{"name":"object_tree_identifier_id","required":true,"style":"simple","in":"path","schema":{"type":"string"},"explode":false}],"responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","operationId":"deleteObjectTreeIdentifier","summary":"Delete object tree identifier"}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/channel\_sources/{channel\_source\_id}

> Get object tree channel source

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/channel_sources/{channel_source_id}":{"get":{"operationId":"getObjectTreeChannelSource","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTreeChannelSourceResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"summary":"Get object tree channel source","tags":["Runtime Schemas"],"parameters":[{"style":"simple","name":"datamart_id","explode":false,"schema":{"type":"string"},"required":true,"in":"path"},{"name":"schema_id","in":"path","style":"simple","required":true,"explode":false,"schema":{"type":"string"}},{"required":true,"in":"path","schema":{"type":"string"},"explode":false,"style":"simple","name":"object_tree_id"},{"required":true,"name":"channel_source_id","in":"path","explode":false,"schema":{"type":"string"},"style":"simple"}],"description":""}}},"components":{"schemas":{"ObjectTreeChannelSourceResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static1","MAPPING":"#/components/schemas/Mapping"}},"oneOf":[{"$ref":"#/components/schemas/Static1"},{"$ref":"#/components/schemas/Mapping"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"channel_id":{"type":"string","readOnly":false}},"required":["channel_id"]},"Mapping":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/channel\_sources/{channel\_source\_id}

> Update object tree channel source

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/channel_sources/{channel_source_id}":{"put":{"parameters":[{"required":true,"in":"path","explode":false,"style":"simple","schema":{"type":"string"},"name":"datamart_id"},{"in":"path","style":"simple","explode":false,"schema":{"type":"string"},"required":true,"name":"schema_id"},{"name":"object_tree_id","in":"path","explode":false,"schema":{"type":"string"},"style":"simple","required":true},{"explode":false,"schema":{"type":"string"},"name":"channel_source_id","required":true,"in":"path","style":"simple"}],"tags":["Runtime Schemas"],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTreeChannelSourceResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"updateObjectTreeChannelSource","summary":"Update object tree channel source","description":"","requestBody":{"description":"The channel source to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectTreeChannelSourceResource"}}},"required":true}}}},"components":{"schemas":{"ObjectTreeChannelSourceResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static1","MAPPING":"#/components/schemas/Mapping"}},"oneOf":[{"$ref":"#/components/schemas/Static1"},{"$ref":"#/components/schemas/Mapping"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"channel_id":{"type":"string","readOnly":false}},"required":["channel_id"]},"Mapping":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/channel\_sources/{channel\_source\_id}

> Delete object tree channel source

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/channel_sources/{channel_source_id}":{"delete":{"responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"required":true,"explode":false,"name":"datamart_id","style":"simple","in":"path","schema":{"type":"string"}},{"schema":{"type":"string"},"name":"schema_id","required":true,"style":"simple","explode":false,"in":"path"},{"schema":{"type":"string"},"required":true,"name":"object_tree_id","in":"path","explode":false,"style":"simple"},{"explode":false,"style":"simple","required":true,"in":"path","schema":{"type":"string"},"name":"channel_source_id"}],"operationId":"deleteObjectTreeChannelSource","tags":["Runtime Schemas"],"summary":"Delete object tree channel source","description":""}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## PUT /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/data\_warehouse\_live\_ingestion\_credentials

> Set data warehouse live ingestion credentials for object tree

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/data_warehouse_live_ingestion_credentials":{"put":{"parameters":[{"style":"simple","explode":false,"in":"path","name":"datamart_id","schema":{"type":"string"},"required":true},{"explode":false,"style":"simple","required":true,"name":"schema_id","in":"path","schema":{"type":"string"}},{"in":"path","style":"simple","required":true,"schema":{"type":"string"},"name":"object_tree_id","explode":false}],"description":"","responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"requestBody":{"description":"The data warehouse live ingestion credentials to set","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionCredentialResource"}}},"required":true},"tags":["Runtime Schemas"],"operationId":"upsertDataWarehouseLiveIngestionCredentials","summary":"Set data warehouse live ingestion credentials for object tree"}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]},"ObjectTreeDataWarehouseLiveIngestionCredentialResource":{"discriminator":{"propertyName":"type","mapping":{"OBJECT_STORAGE":"#/components/schemas/ObjectStorage"}},"oneOf":[{"$ref":"#/components/schemas/ObjectStorage"}],"properties":{"type":{"type":"string","enum":["OBJECT_STORAGE"]}},"required":["type"]},"ObjectStorage":{"type":"object","properties":{"endpoint":{"type":"string","readOnly":false},"secret_key":{"type":"string","readOnly":false},"protocol":{"$ref":"#/components/schemas/S3Protocol"},"s3_prefix":{"type":"string","readOnly":false},"access_key":{"type":"string","readOnly":false}},"required":["access_key","protocol","secret_key"]},"S3Protocol":{"type":"string","enum":["GS","S3"],"readOnly":false}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/directives/{directive\_id}/inputValues/{id}

> Get argument by id

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/directives/{directive_id}/inputValues/{id}":{"get":{"description":"","tags":["Runtime Schemas"],"parameters":[{"required":true,"in":"path","schema":{"type":"integer","format":"int64"},"explode":false,"style":"simple","name":"datamart_id"},{"in":"path","required":true,"name":"schema_id","style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}},{"explode":false,"schema":{"type":"integer","format":"int64"},"style":"simple","required":true,"name":"object_type_id","in":"path"},{"name":"directive_id","explode":false,"schema":{"type":"integer","format":"int64"},"style":"simple","required":true,"in":"path"},{"style":"simple","schema":{"type":"integer","format":"int64"},"name":"id","explode":false,"required":true,"in":"path"}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/DirectiveArgumentResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"getInputValue","summary":"Get argument by id"}}},"components":{"schemas":{"DirectiveArgumentResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"directive_id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false}},"required":["directive_id","id","name","value"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/data\_warehouse\_live\_ingestion\_config/initial\_config\_script

> Get data warehouse live ingestion initial config script

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/data_warehouse_live_ingestion_config/initial_config_script":{"get":{"description":"","parameters":[{"required":true,"name":"datamart_id","explode":false,"style":"simple","schema":{"type":"string"},"in":"path"},{"required":true,"name":"schema_id","in":"path","explode":false,"style":"simple","schema":{"type":"string"}},{"in":"path","name":"object_tree_id","explode":false,"required":true,"style":"simple","schema":{"type":"string"}}],"summary":"Get data warehouse live ingestion initial config script","operationId":"getInitialConfigScript","tags":["Runtime Schemas"],"responses":{"200":{"description":"Success !","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/schema\_decorators/object\_name={object\_name}/field\_name={field\_name}

> Find the schema decorator matching criteria

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/schema_decorators/object_name={object_name}/field_name={field_name}":{"get":{"description":"","summary":"Find the schema decorator matching criteria","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/SchemaDecoratorResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"name":"datamart_id","required":true,"explode":false,"style":"simple","schema":{"type":"integer","format":"int64"},"in":"path"},{"style":"simple","required":true,"schema":{"type":"integer","format":"int64"},"in":"path","explode":false,"name":"schema_id"},{"in":"path","explode":false,"required":true,"name":"object_name","style":"simple","schema":{"type":"string"}},{"name":"field_name","style":"simple","in":"path","explode":false,"required":true,"schema":{"type":"string"}},{"name":"locale","schema":{"type":"string"},"in":"query","style":"form","required":false,"explode":true}],"operationId":"findSchemaDecorator","tags":["Runtime Schemas"]}}},"components":{"schemas":{"SchemaDecoratorResource":{"type":"object","properties":{"help_text":{"type":"string","readOnly":false},"hidden":{"type":"boolean","default":false,"readOnly":false},"field_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":false},"object_name":{"type":"string","readOnly":false},"locale":{"type":"string","enum":["fr-FR","de-DE","en-GB","en-US","es-ES"],"readOnly":false},"label":{"type":"string","readOnly":false},"schema_id":{"type":"string","readOnly":false}},"required":["datamart_id","field_name","hidden","id","label","locale","object_name","schema_id"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees

> Get object trees

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees":{"get":{"description":"","tags":["Runtime Schemas"],"summary":"Get object trees","parameters":[{"schema":{"type":"string"},"explode":false,"in":"path","required":true,"name":"datamart_id","style":"simple"},{"explode":false,"name":"schema_id","in":"path","style":"simple","required":true,"schema":{"type":"string"}},{"in":"query","schema":{"type":"string"},"required":false,"explode":true,"name":"name","style":"form"},{"in":"query","name":"deep","explode":true,"style":"form","schema":{"type":"boolean"},"required":false},{"schema":{"type":"string"},"name":"keywords","style":"form","in":"query","required":false,"explode":true},{"schema":{"type":"integer","format":"int32"},"required":false,"name":"first_result","in":"query","style":"form","explode":true},{"style":"form","explode":true,"name":"max_results","required":false,"schema":{"type":"integer","format":"int32"},"in":"query"},{"name":"field_ref_format","required":false,"in":"query","explode":true,"schema":{"$ref":"#/components/schemas/FieldRefFormat"},"style":"form"}],"operationId":"getObjectTrees","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"first_result":{"type":"integer"},"count":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"total":{"type":"integer"},"max_results":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTreeInfosResource"}}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"FieldRefFormat":{"type":"string","enum":["ID","NAME"],"readOnly":false},"ObjectTreeInfosResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"input_stream_configs":{"type":"array","items":{"$ref":"#/components/schemas/InputStreamConfigResource"},"readOnly":false},"relation_cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"relation_name":{"type":"string","readOnly":false},"data_source_type":{"$ref":"#/components/schemas/ObjectTreeDataSourceType"},"data_warehouse_id":{"type":"string","readOnly":false},"channel_source":{"$ref":"#/components/schemas/ObjectTreeChannelSourceResource"},"computed_field_technical_name":{"type":"string","readOnly":false},"data_warehouse_live_ingestion_config":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionConfigResource"},"description":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false},"datamart_schema_id":{"type":"string","readOnly":false},"object_type_definition":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"},"user_identifiers":{"type":"array","items":{"$ref":"#/components/schemas/Generic"},"readOnly":false},"event_name":{"$ref":"#/components/schemas/ObjectTreeEventNameResource"},"object_tree_type":{"$ref":"#/components/schemas/ObjectTreeType"},"activity_type":{"$ref":"#/components/schemas/ObjectTreeActivityType"}},"required":["data_source_type","datamart_schema_id","description","id","input_stream_configs","name","object_tree_type","relation_cardinality","relation_name","user_identifiers"]},"InputStreamConfigResource":{"type":"object","properties":{"working_table_name":{"type":"string","readOnly":true},"strategy":{"$ref":"#/components/schemas/CursorStrategy"},"data_warehouse_table_id":{"type":"string","readOnly":false},"object_type_definition_id":{"type":"string","readOnly":false},"use_processing_pipeline":{"type":"boolean","default":false,"readOnly":false},"document_import_id":{"type":"string","readOnly":true},"scheduling":{"$ref":"#/components/schemas/Scheduling"}},"required":["data_warehouse_table_id","document_import_id","scheduling","strategy","use_processing_pipeline"]},"CursorStrategy":{"discriminator":{"propertyName":"type","mapping":{"MODIFIED_TS":"#/components/schemas/ModifiedTs","HASH_TABLE":"#/components/schemas/HashTable","LOG":"#/components/schemas/Log","FULL_IMPORT":"#/components/schemas/FullImport"}},"oneOf":[{"$ref":"#/components/schemas/ModifiedTs"},{"$ref":"#/components/schemas/HashTable"},{"$ref":"#/components/schemas/Log"},{"$ref":"#/components/schemas/FullImport"}],"properties":{"type":{"type":"string","enum":["MODIFIED_TS","HASH_TABLE","LOG","FULL_IMPORT"]}},"required":["type"]},"ModifiedTs":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"HashTable":{"type":"object","properties":{"column_ids":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false}},"required":["column_ids"]},"Log":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"FullImport":{"type":"object"},"Scheduling":{"discriminator":{"propertyName":"type","mapping":{"FREQUENCY":"#/components/schemas/Frequency"}},"oneOf":[{"$ref":"#/components/schemas/Frequency"}],"properties":{"type":{"type":"string","enum":["FREQUENCY"]}},"required":["type"]},"Frequency":{"type":"object","properties":{"start_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/SchedulingUnit"},"time_zone":{"type":"string","readOnly":true},"end_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"value":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["time_zone","unit","value"]},"SchedulingUnit":{"type":"string","enum":["MINUTE","HOUR","DAY"],"readOnly":false},"RelationshipCardinality":{"type":"string","enum":["ONE_TO_ONE","ONE_TO_ZERO_OR_ONE","ONE_TO_MANY"],"readOnly":false},"ObjectTreeDataSourceType":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","PREDEFINED","EDGE","COMPUTED_FIELD"],"readOnly":false},"ObjectTreeChannelSourceResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static1","MAPPING":"#/components/schemas/Mapping"}},"oneOf":[{"$ref":"#/components/schemas/Static1"},{"$ref":"#/components/schemas/Mapping"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"channel_id":{"type":"string","readOnly":false}},"required":["channel_id"]},"Mapping":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeDataWarehouseLiveIngestionConfigResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false},"status":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionStatus"},"object_tree_id":{"type":"string","readOnly":false},"creation_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"bucket_name":{"type":"string","readOnly":false},"data_warehouse_id":{"type":"string","readOnly":false}},"required":["bucket_name","creation_ts","data_warehouse_id","datamart_id","id","name","object_tree_id","status"]},"ObjectTreeDataWarehouseLiveIngestionStatus":{"type":"string","enum":["WAITING_FOR_TABLE_CREATION","PAUSED","ACTIVE"],"readOnly":false},"ObjectTypeDefinitionInfosResource":{"type":"object","properties":{"input_mapping_path":{"type":"string","readOnly":false},"update_value_object":{"type":"boolean","default":false,"readOnly":false},"object_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipInfosResource"},"readOnly":false},"cloned_from":{"type":"string","readOnly":false},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeMappingResource"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ScalarFieldInfosResource"},"readOnly":false},"input_mapping_table":{"type":"string","readOnly":false},"input_mapping_column":{"type":"string","readOnly":false}},"required":["fields","id","mappings","object_name","relationships","update_value_object"]},"RelationshipInfosResource":{"type":"object","properties":{"relation_name":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"id":{"type":"string","readOnly":true},"child":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["cardinality","relation_name"]},"ObjectTypeMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName1","DATA_WAREHOUSE_TABLE_BY_ID":"#/components/schemas/DataWarehouseTableById","JSON_PATH":"#/components/schemas/JsonPath1","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById","DATA_WAREHOUSE_TABLE_BY_NAME":"#/components/schemas/DataWarehouseTableByName"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouseTableById"},{"$ref":"#/components/schemas/JsonPath1"},{"$ref":"#/components/schemas/DataWarehouseTableByName"},{"$ref":"#/components/schemas/DataWarehouseColumnByName1"},{"$ref":"#/components/schemas/DataWarehouseColumnById"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE_TABLE_BY_ID","JSON_PATH","DATA_WAREHOUSE_TABLE_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"DataWarehouseTableById":{"type":"object","properties":{"table_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_id"]},"JsonPath1":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"DataWarehouseTableByName":{"type":"object","properties":{"table_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_name"]},"DataWarehouseColumnByName1":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_id","mapping_group_id"]},"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"Generic":{"allOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"main":{"type":"boolean","default":false,"readOnly":false},"realm_id":{"type":"string","readOnly":false},"location":{"$ref":"#/components/schemas/ObjectTreeIdentifierLocationResource"},"identifier_type":{"$ref":"#/components/schemas/IdentifierType"}},"required":["id","identifier_type","main"]}]},"ObjectTreeIdentifierResource":{"type":"object"},"ObjectTreeIdentifierLocationResource":{"discriminator":{"propertyName":"type","mapping":{"COLUMN_LOCATION":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource","FIELD_LOCATION":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}},"oneOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource"},{"$ref":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}],"properties":{"type":{"type":"string","enum":["COLUMN_LOCATION","FIELD_LOCATION"]}},"required":["type"]},"ObjectTreeIdentifierColumnLocationResource":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeIdentifierFieldLocationResource":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"IdentifierType":{"type":"string","enum":["EMAIL_HASH","USER_ACCOUNT","USER_POINT_ID","DEVICE_POINT","DEVICE_TECHNICAL_ID"],"readOnly":false},"ObjectTreeEventNameResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static","MAPPING":"#/components/schemas/Mapping1"}},"oneOf":[{"$ref":"#/components/schemas/Static"},{"$ref":"#/components/schemas/Mapping1"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event_name":{"type":"string","readOnly":false}},"required":["event_name"]},"Mapping1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeType":{"type":"string","enum":["Custom","ClusteringCohort","UserAccount","UserActivity","UserChoice","UserDevicePoint","UserEmail","UserEvent","UserProfile","UserScenario","UserSegment"],"readOnly":false},"ObjectTreeActivityType":{"type":"string","enum":["TOUCH","SITE_VISIT","APP_VISIT","CTV_VISIT"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees

> Create an object tree

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees":{"post":{"description":"","requestBody":{"description":"The datamart to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectTreeInfosResource"}}},"required":true},"parameters":[{"name":"datamart_id","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"in":"path"},{"schema":{"type":"string"},"explode":false,"style":"simple","in":"path","name":"schema_id","required":true}],"operationId":"createObjectTree","tags":["Runtime Schemas"],"summary":"Create an object tree","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTreeInfosResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"ObjectTreeInfosResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"input_stream_configs":{"type":"array","items":{"$ref":"#/components/schemas/InputStreamConfigResource"},"readOnly":false},"relation_cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"relation_name":{"type":"string","readOnly":false},"data_source_type":{"$ref":"#/components/schemas/ObjectTreeDataSourceType"},"data_warehouse_id":{"type":"string","readOnly":false},"channel_source":{"$ref":"#/components/schemas/ObjectTreeChannelSourceResource"},"computed_field_technical_name":{"type":"string","readOnly":false},"data_warehouse_live_ingestion_config":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionConfigResource"},"description":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false},"datamart_schema_id":{"type":"string","readOnly":false},"object_type_definition":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"},"user_identifiers":{"type":"array","items":{"$ref":"#/components/schemas/Generic"},"readOnly":false},"event_name":{"$ref":"#/components/schemas/ObjectTreeEventNameResource"},"object_tree_type":{"$ref":"#/components/schemas/ObjectTreeType"},"activity_type":{"$ref":"#/components/schemas/ObjectTreeActivityType"}},"required":["data_source_type","datamart_schema_id","description","id","input_stream_configs","name","object_tree_type","relation_cardinality","relation_name","user_identifiers"]},"InputStreamConfigResource":{"type":"object","properties":{"working_table_name":{"type":"string","readOnly":true},"strategy":{"$ref":"#/components/schemas/CursorStrategy"},"data_warehouse_table_id":{"type":"string","readOnly":false},"object_type_definition_id":{"type":"string","readOnly":false},"use_processing_pipeline":{"type":"boolean","default":false,"readOnly":false},"document_import_id":{"type":"string","readOnly":true},"scheduling":{"$ref":"#/components/schemas/Scheduling"}},"required":["data_warehouse_table_id","document_import_id","scheduling","strategy","use_processing_pipeline"]},"CursorStrategy":{"discriminator":{"propertyName":"type","mapping":{"MODIFIED_TS":"#/components/schemas/ModifiedTs","HASH_TABLE":"#/components/schemas/HashTable","LOG":"#/components/schemas/Log","FULL_IMPORT":"#/components/schemas/FullImport"}},"oneOf":[{"$ref":"#/components/schemas/ModifiedTs"},{"$ref":"#/components/schemas/HashTable"},{"$ref":"#/components/schemas/Log"},{"$ref":"#/components/schemas/FullImport"}],"properties":{"type":{"type":"string","enum":["MODIFIED_TS","HASH_TABLE","LOG","FULL_IMPORT"]}},"required":["type"]},"ModifiedTs":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"TimestampUnit":{"type":"string","enum":["SECOND","MILLISECOND","MICROSECOND","NANOSECOND"],"readOnly":false},"HashTable":{"type":"object","properties":{"column_ids":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false}},"required":["column_ids"]},"Log":{"type":"object","properties":{"ts_column":{"type":"string","readOnly":false},"from":{"type":"integer","format":"int64","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["ts_column"]},"FullImport":{"type":"object"},"Scheduling":{"discriminator":{"propertyName":"type","mapping":{"FREQUENCY":"#/components/schemas/Frequency"}},"oneOf":[{"$ref":"#/components/schemas/Frequency"}],"properties":{"type":{"type":"string","enum":["FREQUENCY"]}},"required":["type"]},"Frequency":{"type":"object","properties":{"start_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"unit":{"$ref":"#/components/schemas/SchedulingUnit"},"time_zone":{"type":"string","readOnly":true},"end_hour":{"type":"integer","format":"int32","default":0,"readOnly":false},"value":{"type":"integer","format":"int32","default":0,"readOnly":false}},"required":["time_zone","unit","value"]},"SchedulingUnit":{"type":"string","enum":["MINUTE","HOUR","DAY"],"readOnly":false},"RelationshipCardinality":{"type":"string","enum":["ONE_TO_ONE","ONE_TO_ZERO_OR_ONE","ONE_TO_MANY"],"readOnly":false},"ObjectTreeDataSourceType":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","PREDEFINED","EDGE","COMPUTED_FIELD"],"readOnly":false},"ObjectTreeChannelSourceResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static1","MAPPING":"#/components/schemas/Mapping"}},"oneOf":[{"$ref":"#/components/schemas/Static1"},{"$ref":"#/components/schemas/Mapping"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"channel_id":{"type":"string","readOnly":false}},"required":["channel_id"]},"Mapping":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeDataWarehouseLiveIngestionConfigResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false},"status":{"$ref":"#/components/schemas/ObjectTreeDataWarehouseLiveIngestionStatus"},"object_tree_id":{"type":"string","readOnly":false},"creation_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"bucket_name":{"type":"string","readOnly":false},"data_warehouse_id":{"type":"string","readOnly":false}},"required":["bucket_name","creation_ts","data_warehouse_id","datamart_id","id","name","object_tree_id","status"]},"ObjectTreeDataWarehouseLiveIngestionStatus":{"type":"string","enum":["WAITING_FOR_TABLE_CREATION","PAUSED","ACTIVE"],"readOnly":false},"ObjectTypeDefinitionInfosResource":{"type":"object","properties":{"input_mapping_path":{"type":"string","readOnly":false},"update_value_object":{"type":"boolean","default":false,"readOnly":false},"object_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipInfosResource"},"readOnly":false},"cloned_from":{"type":"string","readOnly":false},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeMappingResource"},"readOnly":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ScalarFieldInfosResource"},"readOnly":false},"input_mapping_table":{"type":"string","readOnly":false},"input_mapping_column":{"type":"string","readOnly":false}},"required":["fields","id","mappings","object_name","relationships","update_value_object"]},"RelationshipInfosResource":{"type":"object","properties":{"relation_name":{"type":"string","readOnly":false},"cloned_from":{"type":"string","readOnly":false},"cardinality":{"$ref":"#/components/schemas/RelationshipCardinality"},"id":{"type":"string","readOnly":true},"child":{"$ref":"#/components/schemas/ObjectTypeDefinitionInfosResource"}},"required":["cardinality","relation_name"]},"ObjectTypeMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName1","DATA_WAREHOUSE_TABLE_BY_ID":"#/components/schemas/DataWarehouseTableById","JSON_PATH":"#/components/schemas/JsonPath1","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById","DATA_WAREHOUSE_TABLE_BY_NAME":"#/components/schemas/DataWarehouseTableByName"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouseTableById"},{"$ref":"#/components/schemas/JsonPath1"},{"$ref":"#/components/schemas/DataWarehouseTableByName"},{"$ref":"#/components/schemas/DataWarehouseColumnByName1"},{"$ref":"#/components/schemas/DataWarehouseColumnById"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE_TABLE_BY_ID","JSON_PATH","DATA_WAREHOUSE_TABLE_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"DataWarehouseTableById":{"type":"object","properties":{"table_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_id"]},"JsonPath1":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"DataWarehouseTableByName":{"type":"object","properties":{"table_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","table_name"]},"DataWarehouseColumnByName1":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_id","mapping_group_id"]},"ScalarFieldInfosResource":{"type":"object","properties":{"cloned_from":{"type":"string","readOnly":false},"input_mapping":{"$ref":"#/components/schemas/FieldInputMappingResource"},"field_name":{"type":"string","readOnly":false},"optional":{"type":"boolean","default":false,"readOnly":false},"primary_key":{"type":"boolean","default":false,"readOnly":false},"id":{"type":"string","readOnly":true},"tree_index_data_type":{"$ref":"#/components/schemas/TreeIndexDataType"},"foreign_key":{"$ref":"#/components/schemas/FieldRef"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/FieldMappingResource"},"readOnly":true},"field_type":{"type":"string","readOnly":false},"tree_index":{"$ref":"#/components/schemas/ObjectTreeIndexResource"},"reference_table":{"$ref":"#/components/schemas/ReferenceTableResource"},"list":{"type":"boolean","default":false,"readOnly":false},"predefined":{"type":"boolean","default":false,"readOnly":true}},"required":["field_name","field_type","list","mappings","optional","predefined","primary_key"]},"FieldInputMappingResource":{"discriminator":{"propertyName":"type","mapping":{"DATA_WAREHOUSE":"#/components/schemas/DataWarehouse","JSON_DATA_STREAM":"#/components/schemas/JsonDataStream","CONVERT_FROM":"#/components/schemas/ConvertFrom1"}},"oneOf":[{"$ref":"#/components/schemas/DataWarehouse"},{"$ref":"#/components/schemas/JsonDataStream"},{"$ref":"#/components/schemas/ConvertFrom1"}],"properties":{"type":{"type":"string","enum":["DATA_WAREHOUSE","JSON_DATA_STREAM","CONVERT_FROM"]}},"required":["type"]},"DataWarehouse":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id"]},"JsonDataStream":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false}},"required":["json_path"]},"ConvertFrom1":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"}},"required":["field"]},"FieldRef":{"discriminator":{"propertyName":"type","mapping":{"FIELD_NAME":"#/components/schemas/FieldName","FIELD_ID":"#/components/schemas/FieldId1"}},"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"$ref":"#/components/schemas/FieldId1"}],"properties":{"type":{"type":"string","enum":["FIELD_NAME","FIELD_ID"]}},"required":["type"]},"FieldName":{"type":"object","properties":{"field_name":{"type":"string","readOnly":false}},"required":["field_name"]},"FieldId1":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"TreeIndexDataType":{"type":"string","enum":["TEXT","KEYWORD"],"readOnly":false},"FieldMappingResource":{"discriminator":{"propertyName":"type","mapping":{"CONVERT_FROM":"#/components/schemas/ConvertFrom","DATA_WAREHOUSE_COLUMN_BY_NAME":"#/components/schemas/DataWarehouseColumnByName","JSON_DATA_STREAM":"#/components/schemas/JsonPath","DATA_WAREHOUSE_COLUMN_BY_ID":"#/components/schemas/DataWarehouseColumnById1","JSON_PATH":"#/components/schemas/JsonPath","AUTO_GENERATED":"#/components/schemas/AutoGenerated"}},"oneOf":[{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/AutoGenerated"},{"$ref":"#/components/schemas/JsonPath"},{"$ref":"#/components/schemas/ConvertFrom"},{"$ref":"#/components/schemas/DataWarehouseColumnByName"},{"$ref":"#/components/schemas/DataWarehouseColumnById1"}],"properties":{"type":{"type":"string","enum":["JSON_PATH","AUTO_GENERATED","JSON_DATA_STREAM","CONVERT_FROM","DATA_WAREHOUSE_COLUMN_BY_NAME","DATA_WAREHOUSE_COLUMN_BY_ID"]}},"required":["type"]},"JsonPath":{"type":"object","properties":{"json_path":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["json_path","mapping_group_id"]},"AutoGenerated":{"type":"object","properties":{"strategy":{"$ref":"#/components/schemas/AutoGeneratedStrategy"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["mapping_group_id","strategy"]},"AutoGeneratedStrategy":{"type":"string","enum":["INDEX","UUID"],"readOnly":false},"ConvertFrom":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldRef"},"source_unit":{"$ref":"#/components/schemas/TimestampUnit"},"mapping_group_id":{"type":"string","readOnly":false}},"required":["field","mapping_group_id"]},"DataWarehouseColumnByName":{"type":"object","properties":{"column_name":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["column_name","mapping_group_id"]},"DataWarehouseColumnById1":{"type":"object","properties":{"data_warehouse_column_id":{"type":"string","readOnly":false},"mapping_group_id":{"type":"string","readOnly":false}},"required":["data_warehouse_column_id","mapping_group_id"]},"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"ReferenceTableResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ReferenceTableType"},"model_type":{"type":"string","readOnly":false}},"required":["model_type","type"]},"ReferenceTableType":{"type":"string","enum":["CORE_OBJECT","STATIC","SYSTEM_ENUM","DISCOVERED"],"readOnly":false},"Generic":{"allOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"main":{"type":"boolean","default":false,"readOnly":false},"realm_id":{"type":"string","readOnly":false},"location":{"$ref":"#/components/schemas/ObjectTreeIdentifierLocationResource"},"identifier_type":{"$ref":"#/components/schemas/IdentifierType"}},"required":["id","identifier_type","main"]}]},"ObjectTreeIdentifierResource":{"type":"object"},"ObjectTreeIdentifierLocationResource":{"discriminator":{"propertyName":"type","mapping":{"COLUMN_LOCATION":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource","FIELD_LOCATION":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}},"oneOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource"},{"$ref":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}],"properties":{"type":{"type":"string","enum":["COLUMN_LOCATION","FIELD_LOCATION"]}},"required":["type"]},"ObjectTreeIdentifierColumnLocationResource":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeIdentifierFieldLocationResource":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"IdentifierType":{"type":"string","enum":["EMAIL_HASH","USER_ACCOUNT","USER_POINT_ID","DEVICE_POINT","DEVICE_TECHNICAL_ID"],"readOnly":false},"ObjectTreeEventNameResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static","MAPPING":"#/components/schemas/Mapping1"}},"oneOf":[{"$ref":"#/components/schemas/Static"},{"$ref":"#/components/schemas/Mapping1"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event_name":{"type":"string","readOnly":false}},"required":["event_name"]},"Mapping1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeType":{"type":"string","enum":["Custom","ClusteringCohort","UserAccount","UserActivity","UserChoice","UserDevicePoint","UserEmail","UserEvent","UserProfile","UserScenario","UserSegment"],"readOnly":false},"ObjectTreeActivityType":{"type":"string","enum":["TOUCH","SITE_VISIT","APP_VISIT","CTV_VISIT"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/event\_names

> Create object tree event name

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/event_names":{"post":{"parameters":[{"in":"path","explode":false,"required":true,"schema":{"type":"string"},"style":"simple","name":"datamart_id"},{"name":"schema_id","required":true,"in":"path","explode":false,"style":"simple","schema":{"type":"string"}},{"name":"object_tree_id","style":"simple","schema":{"type":"string"},"in":"path","explode":false,"required":true}],"summary":"Create object tree event name","tags":["Runtime Schemas"],"requestBody":{"description":"The event name to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectTreeEventNameResource"}}},"required":true},"description":"","operationId":"createObjectTreeEventName","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTreeEventNameResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"ObjectTreeEventNameResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static","MAPPING":"#/components/schemas/Mapping1"}},"oneOf":[{"$ref":"#/components/schemas/Static"},{"$ref":"#/components/schemas/Mapping1"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event_name":{"type":"string","readOnly":false}},"required":["event_name"]},"Mapping1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/directives/{directive\_id}/inputValues

> Get input values

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/directives/{directive_id}/inputValues":{"get":{"operationId":"getInputValues","summary":"Get input values","description":"","tags":["Runtime Schemas"],"parameters":[{"schema":{"type":"integer","format":"int64"},"style":"simple","in":"path","required":true,"explode":false,"name":"datamart_id"},{"schema":{"type":"integer","format":"int64"},"style":"simple","explode":false,"in":"path","name":"schema_id","required":true},{"schema":{"type":"integer","format":"int64"},"in":"path","style":"simple","required":true,"name":"object_type_id","explode":false},{"style":"simple","explode":false,"name":"directive_id","schema":{"type":"integer","format":"int64"},"required":true,"in":"path"},{"style":"form","in":"query","explode":true,"schema":{"type":"string"},"required":false,"name":"name"},{"style":"form","schema":{"type":"string"},"required":false,"explode":true,"name":"keywords","in":"query"},{"explode":true,"name":"comment","schema":{"type":"string"},"style":"form","in":"query","required":false},{"in":"query","style":"form","name":"first_result","explode":true,"schema":{"type":"integer","format":"int32"},"required":false},{"style":"form","required":false,"in":"query","name":"max_results","schema":{"type":"integer","format":"int32"},"explode":true}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/DirectiveArgumentResource"}},"count":{"type":"integer"},"max_results":{"type":"integer"},"total":{"type":"integer"},"first_result":{"type":"integer"}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"DirectiveArgumentResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"directive_id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false}},"required":["directive_id","id","name","value"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}

> Get runtime schema

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}":{"get":{"summary":"Get runtime schema","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/RuntimeSchemaResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"getRuntimeSchema","tags":["Runtime Schemas"],"parameters":[{"required":true,"style":"simple","schema":{"type":"integer","format":"int64"},"description":"The datamart owning the schema.","in":"path","explode":false,"name":"datamart_id"},{"explode":false,"name":"schema_id","description":"The schema to look for.","required":true,"style":"simple","in":"path","schema":{"type":"integer","format":"int64"}}],"description":""}}},"components":{"schemas":{"RuntimeSchemaResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"creation_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"last_modification_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"publication_date":{"type":"integer","format":"int64","default":0,"readOnly":true},"datamart_id":{"type":"string","readOnly":true},"schema_type":{"$ref":"#/components/schemas/DatamartSchemaType"},"status":{"$ref":"#/components/schemas/SchemaStatus"},"suspension_date":{"type":"integer","format":"int64","default":0,"readOnly":true}},"required":["creation_date","datamart_id","id","last_modification_date","publication_date","schema_type","status"]},"DatamartSchemaType":{"type":"string","enum":["OBJECT_TREE","PLAIN_TEXT"],"readOnly":false},"SchemaStatus":{"type":"string","enum":["DRAFT","PUBLISHED","LIVE","SUSPENDED","ARCHIVED","actives"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## DELETE /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}

> Delete runtime schema

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}":{"delete":{"operationId":"deleteRuntimeSchema","summary":"Delete runtime schema","tags":["Runtime Schemas"],"parameters":[{"explode":false,"required":true,"style":"simple","schema":{"type":"integer","format":"int64"},"in":"path","description":"The datamart owning the schema.","name":"datamart_id"},{"name":"schema_id","explode":false,"style":"simple","description":"The schema to delete.","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":""}}},"components":{"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/tree\_index\_selections/{id}

> Get the tree index selections for the schema by id

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/tree_index_selections/{id}":{"get":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/TreeIndexSelectionInfoResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["Runtime Schemas"],"parameters":[{"explode":false,"style":"simple","required":true,"name":"datamart_id","in":"path","schema":{"type":"integer","format":"int64"}},{"schema":{"type":"integer","format":"int64"},"required":true,"explode":false,"style":"simple","in":"path","name":"schema_id"},{"style":"simple","name":"id","schema":{"type":"integer","format":"int64"},"explode":false,"in":"path","required":true}],"summary":"Get the tree index selections for the schema by id","description":"","operationId":"findTreeIndexSelection"}}},"components":{"schemas":{"TreeIndexSelectionInfoResource":{"allOf":[{"$ref":"#/components/schemas/TreeIndexMetaData"},{"type":"object","properties":{"size":{"$ref":"#/components/schemas/TreeIndexSize"},"technical_device_migrated":{"type":"boolean","default":false,"readOnly":false},"index_name":{"type":"string","readOnly":true},"status":{"$ref":"#/components/schemas/TreeIndexStatus"},"driver_version_minor_number":{"type":"integer","format":"int32","default":0,"readOnly":false},"datamart_id":{"format":"int64","default":0,"readOnly":true,"type":"integer"},"init_strategy":{"$ref":"#/components/schemas/TreeIndexInitStrategy"},"driver_version_major_number":{"type":"integer","format":"int32","default":0,"readOnly":false},"id":{"type":"integer","format":"int64","default":0,"readOnly":true},"index_id":{"format":"int64","default":0,"type":"integer","readOnly":true},"object_tree_index_cluster_id":{"type":"string","readOnly":false},"datafarm":{"type":"string","readOnly":true}},"required":["datafarm","datamart_id","driver_version_major_number","driver_version_minor_number","id","index_name","object_tree_index_cluster_id","technical_device_migrated"]}]},"TreeIndexMetaData":{"allOf":[{"$ref":"#/components/schemas/IndexDriverVersion"},{"type":"object"}]},"IndexDriverVersion":{"type":"object"},"TreeIndexSize":{"type":"string","enum":["SMALL","MEDIUM","LARGE","X_LARGE","XX_LARGE","XXX_LARGE","EXTRA_LARGE","XXXX_LARGE"],"readOnly":false},"TreeIndexStatus":{"type":"string","enum":["DRAFT","PUBLISHED","LIVE","ARCHIVED","actives"],"readOnly":false},"TreeIndexInitStrategy":{"type":"string","enum":["AUTOMATIC","FORCE_BUILD_FROM_CURSOR","FORCE_BUILD_FROM_INDEX","FORCE_NO_BUILD","MANUAL"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_tree\_indices

> Get object trees indices

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_tree_indices":{"get":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTreeIndexResource"}},"max_results":{"type":"integer"},"first_result":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"total":{"type":"integer"}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"in":"path","schema":{"type":"string"},"style":"simple","name":"datamart_id","explode":false,"required":true},{"name":"schema_id","in":"path","required":true,"explode":false,"style":"simple","schema":{"type":"string"}},{"style":"form","required":false,"in":"query","name":"first_result","schema":{"type":"integer","format":"int32"},"explode":true},{"style":"form","explode":true,"required":false,"schema":{"type":"integer","format":"int32"},"in":"query","name":"max_results"}],"tags":["Runtime Schemas"],"description":"","operationId":"getObjectTreeIndices","summary":"Get object trees indices"}}},"components":{"schemas":{"ObjectTreeIndexResource":{"type":"object","properties":{"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["name"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/fields/{field\_id}/directives/{id}

> Get field directive by id

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/fields/{field_id}/directives/{id}":{"get":{"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/FieldDirectiveResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"required":true,"name":"datamart_id","explode":false,"style":"simple","in":"path","schema":{"type":"integer","format":"int64"}},{"schema":{"type":"integer","format":"int64"},"explode":false,"style":"simple","name":"schema_id","required":true,"in":"path"},{"name":"object_type_id","style":"simple","in":"path","required":true,"explode":false,"schema":{"type":"integer","format":"int64"}},{"style":"simple","name":"field_id","in":"path","schema":{"type":"integer","format":"int64"},"explode":false,"required":true},{"name":"id","schema":{"type":"integer","format":"int64"},"required":true,"style":"simple","in":"path","explode":false}],"tags":["Runtime Schemas"],"description":"","operationId":"getFieldDirective","summary":"Get field directive by id"}}},"components":{"schemas":{"FieldDirectiveResource":{"allOf":[{"$ref":"#/components/schemas/AbstractFieldDirectiveResource"},{"type":"object","properties":{"runtime_schema_id":{"type":"string","readOnly":true},"field_id":{"type":"string","readOnly":true},"id":{"type":"string","readOnly":true},"comment":{"type":"string","readOnly":false},"object_like_type_id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false}},"required":["comment","field_id","id","name","object_like_type_id","runtime_schema_id"]}]},"AbstractFieldDirectiveResource":{"type":"object"},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/deep

> Get object types whole structure

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/deep":{"get":{"operationId":"getDeepObjectTypes","description":"","tags":["Runtime Schemas"],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"first_result":{"type":"integer"},"count":{"type":"integer"},"max_results":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ObjectLikeTypeInfoResource"}},"total":{"type":"integer"}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"name":"datamart_id","style":"simple","required":true,"in":"path","schema":{"type":"integer","format":"int64"},"explode":false},{"schema":{"type":"integer","format":"int64"},"in":"path","explode":false,"name":"schema_id","required":true,"style":"simple"}],"summary":"Get object types whole structure"}}},"components":{"schemas":{"ObjectLikeTypeInfoResource":{"allOf":[{"$ref":"#/components/schemas/AbstractObjectLikeTypeResource"},{"type":"object","properties":{"runtime_schema_id":{"type":"string","readOnly":false},"fields":{"type":"array","items":{"$ref":"#/components/schemas/FieldInfoResource"},"readOnly":false},"directives":{"type":"array","items":{"$ref":"#/components/schemas/ObjectLikeTypeDirectiveInfoResource"},"readOnly":false},"type":{"$ref":"#/components/schemas/ObjectLikeType"},"id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false}},"required":["directives","fields","id","name","runtime_schema_id","type"]}]},"AbstractObjectLikeTypeResource":{"type":"object"},"FieldInfoResource":{"allOf":[{"$ref":"#/components/schemas/AbstractFieldResource"},{"type":"object","properties":{"name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":false},"directives":{"type":"array","items":{"$ref":"#/components/schemas/FieldDirectiveInfoResource"},"readOnly":false},"decorator":{"$ref":"#/components/schemas/SchemaDecoratorResource"},"field_type":{"type":"string","readOnly":false},"runtime_schema_id":{"type":"string","readOnly":false},"object_like_type_id":{"type":"string","readOnly":false}},"required":["directives","field_type","id","name","object_like_type_id","runtime_schema_id"]}]},"AbstractFieldResource":{"type":"object"},"FieldDirectiveInfoResource":{"allOf":[{"$ref":"#/components/schemas/AbstractFieldDirectiveResource"},{"type":"object","properties":{"runtime_schema_id":{"type":"string","readOnly":false},"name":{"type":"string","readOnly":false},"field_id":{"type":"string","readOnly":false},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/DirectiveArgumentResource"},"readOnly":false},"comment":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":false},"object_like_type_id":{"type":"string","readOnly":false}},"required":["arguments","comment","field_id","id","name","object_like_type_id","runtime_schema_id"]}]},"AbstractFieldDirectiveResource":{"type":"object"},"DirectiveArgumentResource":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"directive_id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":false},"value":{"type":"string","readOnly":false}},"required":["directive_id","id","name","value"]},"SchemaDecoratorResource":{"type":"object","properties":{"help_text":{"type":"string","readOnly":false},"hidden":{"type":"boolean","default":false,"readOnly":false},"field_name":{"type":"string","readOnly":false},"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":false},"object_name":{"type":"string","readOnly":false},"locale":{"type":"string","enum":["fr-FR","de-DE","en-GB","en-US","es-ES"],"readOnly":false},"label":{"type":"string","readOnly":false},"schema_id":{"type":"string","readOnly":false}},"required":["datamart_id","field_name","hidden","id","label","locale","object_name","schema_id"]},"ObjectLikeTypeDirectiveInfoResource":{"allOf":[{"$ref":"#/components/schemas/AbstractObjectLikeTypeDirectiveResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":false},"type":{"$ref":"#/components/schemas/ObjectLikeType"},"name":{"type":"string","readOnly":false},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/DirectiveArgumentResource"},"readOnly":false}},"required":["arguments","id","name","type"]}]},"AbstractObjectLikeTypeDirectiveResource":{"type":"object"},"ObjectLikeType":{"type":"string","enum":["OBJECT_TYPE","INTERFACE_TYPE"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_orm\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/text

> Get graphdb ORM schema as text

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_orm_schemas/{schema_id}/object_trees/{object_tree_id}/text":{"get":{"tags":["Runtime Schemas"],"responses":{"200":{"description":"Success !","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","operationId":"getGraphDbORMSchemaAsText","parameters":[{"name":"datamart_id","explode":false,"required":true,"description":"The datamart owning the schema.","schema":{"type":"string"},"style":"simple","in":"path"},{"description":"The schema to get as text.","name":"schema_id","required":true,"style":"simple","in":"path","schema":{"type":"string"},"explode":false},{"schema":{"type":"string"},"in":"path","description":"The object tree to get as text.","required":true,"style":"simple","explode":false,"name":"object_tree_id"},{"style":"form","name":"mapping_group_id","description":"The object tree mapping group to get as text.","required":false,"schema":{"type":"string"},"in":"query","explode":true}],"summary":"Get graphdb ORM schema as text"}}},"components":{"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"schemas":{"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_types/{object\_type\_id}/fields/{id}

> Get field by id

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_types/{object_type_id}/fields/{id}":{"get":{"description":"","tags":["Runtime Schemas"],"summary":"Get field by id","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/FieldResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"getField","parameters":[{"explode":false,"style":"simple","schema":{"type":"integer","format":"int64"},"name":"datamart_id","in":"path","required":true},{"schema":{"type":"integer","format":"int64"},"in":"path","explode":false,"name":"schema_id","style":"simple","required":true},{"required":true,"name":"object_type_id","style":"simple","in":"path","schema":{"type":"integer","format":"int64"},"explode":false},{"name":"id","explode":false,"schema":{"type":"integer","format":"int64"},"style":"simple","required":true,"in":"path"}]}}},"components":{"schemas":{"FieldResource":{"allOf":[{"$ref":"#/components/schemas/AbstractFieldResource"},{"type":"object","properties":{"name":{"type":"string","readOnly":true},"id":{"type":"string","readOnly":true},"field_type":{"type":"string","readOnly":true},"object_like_type_id":{"type":"string","readOnly":true},"runtime_schema_id":{"type":"string","readOnly":true}},"required":["field_type","id","name","object_like_type_id","runtime_schema_id"]}]},"AbstractFieldResource":{"type":"object"},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/channel\_sources

> Create object tree channel source

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/channel_sources":{"post":{"requestBody":{"description":"The channel source to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectTreeChannelSourceResource"}}},"required":true},"summary":"Create object tree channel source","tags":["Runtime Schemas"],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/ObjectTreeChannelSourceResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"description":"","parameters":[{"explode":false,"in":"path","name":"datamart_id","schema":{"type":"string"},"required":true,"style":"simple"},{"style":"simple","required":true,"in":"path","explode":false,"schema":{"type":"string"},"name":"schema_id"},{"style":"simple","schema":{"type":"string"},"name":"object_tree_id","required":true,"explode":false,"in":"path"}],"operationId":"createObjectTreeChannelSource"}}},"components":{"schemas":{"ObjectTreeChannelSourceResource":{"discriminator":{"propertyName":"type","mapping":{"STATIC":"#/components/schemas/Static1","MAPPING":"#/components/schemas/Mapping"}},"oneOf":[{"$ref":"#/components/schemas/Static1"},{"$ref":"#/components/schemas/Mapping"}],"properties":{"type":{"type":"string","enum":["STATIC","MAPPING"]}},"required":["type"]},"Static1":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"channel_id":{"type":"string","readOnly":false}},"required":["channel_id"]},"Mapping":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/identifiers

> Get object trees identifiers

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/identifiers":{"get":{"parameters":[{"schema":{"type":"string"},"in":"path","explode":false,"style":"simple","name":"datamart_id","required":true},{"explode":false,"name":"schema_id","in":"path","required":true,"style":"simple","schema":{"type":"string"}},{"name":"object_tree_id","style":"simple","explode":false,"in":"path","schema":{"type":"string"},"required":true},{"explode":true,"schema":{"type":"integer","format":"int32"},"in":"query","style":"form","name":"first_result","required":false},{"required":false,"in":"query","explode":true,"name":"max_results","style":"form","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"first_result":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Generic"}},"max_results":{"type":"integer"},"count":{"type":"integer"},"status":{"type":"string","enum":["ok"]}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"getObjectTreeIdentifiers","description":"","summary":"Get object trees identifiers","tags":["Runtime Schemas"]}}},"components":{"schemas":{"Generic":{"allOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"main":{"type":"boolean","default":false,"readOnly":false},"realm_id":{"type":"string","readOnly":false},"location":{"$ref":"#/components/schemas/ObjectTreeIdentifierLocationResource"},"identifier_type":{"$ref":"#/components/schemas/IdentifierType"}},"required":["id","identifier_type","main"]}]},"ObjectTreeIdentifierResource":{"type":"object"},"ObjectTreeIdentifierLocationResource":{"discriminator":{"propertyName":"type","mapping":{"COLUMN_LOCATION":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource","FIELD_LOCATION":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}},"oneOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource"},{"$ref":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}],"properties":{"type":{"type":"string","enum":["COLUMN_LOCATION","FIELD_LOCATION"]}},"required":["type"]},"ObjectTreeIdentifierColumnLocationResource":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeIdentifierFieldLocationResource":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"IdentifierType":{"type":"string","enum":["EMAIL_HASH","USER_ACCOUNT","USER_POINT_ID","DEVICE_POINT","DEVICE_TECHNICAL_ID"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/graphdb\_runtime\_schemas/{schema\_id}/object\_trees/{object\_tree\_id}/identifiers

> Create an object tree identifier

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"Runtime Schemas","description":"Operations related to **Runtime Schemas**, the GraphQL SDL configurations that define the data model of a Datamart, specifying which objects and fields are stored, structured, and indexed for querying. **Indexed fields** can be used in OTQL queries and segment building, while non-indexed fields remain stored but not queryable. Schema changes can be applied with historical data reindexing.\n\nRelevant documentation:\n- [Schema](https://userguides.mediarithmics.io/basics/key-concepts/what-is-a-data-schema)\n"}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/graphdb_runtime_schemas/{schema_id}/object_trees/{object_tree_id}/identifiers":{"post":{"tags":["Runtime Schemas"],"operationId":"createObjectTreeIdentifier","summary":"Create an object tree identifier","description":"","requestBody":{"description":"The identifier to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Generic"}}},"required":true},"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/Generic"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"explode":false,"required":true,"name":"datamart_id","style":"simple","in":"path","schema":{"type":"string"}},{"name":"schema_id","style":"simple","schema":{"type":"string"},"explode":false,"in":"path","required":true},{"required":true,"in":"path","explode":false,"schema":{"type":"string"},"name":"object_tree_id","style":"simple"}]}}},"components":{"schemas":{"Generic":{"allOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierResource"},{"type":"object","properties":{"id":{"type":"string","readOnly":true},"main":{"type":"boolean","default":false,"readOnly":false},"realm_id":{"type":"string","readOnly":false},"location":{"$ref":"#/components/schemas/ObjectTreeIdentifierLocationResource"},"identifier_type":{"$ref":"#/components/schemas/IdentifierType"}},"required":["id","identifier_type","main"]}]},"ObjectTreeIdentifierResource":{"type":"object"},"ObjectTreeIdentifierLocationResource":{"discriminator":{"propertyName":"type","mapping":{"COLUMN_LOCATION":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource","FIELD_LOCATION":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}},"oneOf":[{"$ref":"#/components/schemas/ObjectTreeIdentifierColumnLocationResource"},{"$ref":"#/components/schemas/ObjectTreeIdentifierFieldLocationResource"}],"properties":{"type":{"type":"string","enum":["COLUMN_LOCATION","FIELD_LOCATION"]}},"required":["type"]},"ObjectTreeIdentifierColumnLocationResource":{"type":"object","properties":{"column_id":{"type":"string","readOnly":false}},"required":["column_id"]},"ObjectTreeIdentifierFieldLocationResource":{"type":"object","properties":{"field_id":{"type":"string","readOnly":false}},"required":["field_id"]},"IdentifierType":{"type":"string","enum":["EMAIL_HASH","USER_ACCOUNT","USER_POINT_ID","DEVICE_POINT","DEVICE_TECHNICAL_ID"],"readOnly":false},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.mediarithmics.io/api-reference/datamart-management/runtime-schemas.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.