# Set or Update Dataset Definitions

Set or update one or more definitions for a Dataset.
: While the PATCH payload can include the , Honeycomb does not use this field when updating Dataset Definitions.


Endpoint: PATCH /1/dataset_definitions/{datasetSlug}
Version: 1.0.0
Security: configuration_key

## Path parameters:

  - `datasetSlug` (string, required)
    The dataset slug.

## Request fields (application/json):

  - `span_id` (null,object)
    The unique identifier (ID) for each span.

  - `span_id.name` (string, required)
    The name of the Column or of the Calculated Field (also called Derived Column) to map to this Dataset Definition Type. An empty string clears the mapping, potentially reverting to a default mapping.

  - `trace_id` (null,object)
    The ID of the trace this span belongs to.

  - `parent_id` (null,object)
    The Parent Span ID - The ID of this span's parent span, the call location the current span was called from.

  - `name` (null,object)
    The name of the function or method where the span was created.

  - `service_name` (null,object)
    The name of the instrumented service.

  - `duration_ms` (null,object)
    Span Duration - How much time the span took, in milliseconds.

  - `span_kind` (null,object)
    Metadata: Kind - The kind of Span. For example,  or . The use of this field to identify Span Events and Links is deprecated. Use the field Metadata: Annotation Type.

  - `annotation_type` (null,object)
    Metadata: Annotation Type - The type of span annotation. For example,  or . This lets Honeycomb visualize this type of event differently in a trace. Do not use this field for other purposes.

  - `link_span_id` (null,object)
    Metadata: Link Span ID - Links let you tie traces and spans to one another. The Link Span ID lets you link to a different span (when used with Link Trace ID).

  - `link_trace_id` (null,object)
    Metadata: Link Trace ID - Links let you tie traces and spans to one another. The Link Trace Id lets you link to a different trace or a different span in the same trace (when used with Link Span ID).

  - `error` (null,object)
    Use a Boolean or String to indicate error.

  - `status` (null,object)
    Indicates the success, failure, or other status of a request.

  - `route` (null,object)
    The HTTP URL or equivalent route processed by the request.

  - `user` (null,object)
    The user making the request in the system.

  - `log_severity` (null,object)
    Severity level of the event (also known as log level). Supported values: trace, debug, info, warn, error, fatal, unspecified.

  - `log_message` (null,object)
    A value containing the log event message. Can be a human-readable string message (including multi-line) describing the event in a free form.

## Response 200 fields (application/json):

  - `span_id` (null,object)
    The unique identifier (ID) for each span.

  - `span_id.name` (string, required)
    The name of the Column or of the Calculated Field (also called Derived Column) to map to this Dataset Definition Type. An empty string clears the mapping, potentially reverting to a default mapping.

  - `span_id.column_type` (string)
    Optional:  for regular columns and  for Calculated Fields (also called Derived Columns) when setting Dataset Definitions. Honeycomb does not use this field when updating Dataset definitions.
    Enum: "column", "derived_column"

  - `trace_id` (null,object)
    The ID of the trace this span belongs to.

  - `parent_id` (null,object)
    The Parent Span ID - The ID of this span's parent span, the call location the current span was called from.

  - `name` (null,object)
    The name of the function or method where the span was created.

  - `service_name` (null,object)
    The name of the instrumented service.

  - `duration_ms` (null,object)
    Span Duration - How much time the span took, in milliseconds.

  - `span_kind` (null,object)
    Metadata: Kind - The kind of Span. For example,  or . The use of this field to identify Span Events and Links is deprecated. Use the field Metadata: Annotation Type.

  - `annotation_type` (null,object)
    Metadata: Annotation Type - The type of span annotation. For example,  or . This lets Honeycomb visualize this type of event differently in a trace. Do not use this field for other purposes.

  - `link_span_id` (null,object)
    Metadata: Link Span ID - Links let you tie traces and spans to one another. The Link Span ID lets you link to a different span (when used with Link Trace ID).

  - `link_trace_id` (null,object)
    Metadata: Link Trace ID - Links let you tie traces and spans to one another. The Link Trace Id lets you link to a different trace or a different span in the same trace (when used with Link Span ID).

  - `error` (null,object)
    Use a Boolean or String to indicate error.

  - `status` (null,object)
    Indicates the success, failure, or other status of a request.

  - `route` (null,object)
    The HTTP URL or equivalent route processed by the request.

  - `user` (null,object)
    The user making the request in the system.

  - `log_severity` (null,object)
    Severity level of the event (also known as log level). Supported values: trace, debug, info, warn, error, fatal, unspecified.

  - `log_message` (null,object)
    A value containing the log event message. Can be a human-readable string message (including multi-line) describing the event in a free form.

## Response 400 fields (application/json):

  - `error` (string, required)

  - `status` (number, required)
    The HTTP status code of the error.

  - `type` (string, required)
    Type is a URI used to uniquely identify the type of error.

  - `title` (string, required)
    Title is a human-readable summary that explains the  of the problem.

  - `detail` (string)
    The general, human-readable error message.

  - `instance` (string)
    The unique identifier (ID) for this specific error.

## Response 401 fields (application/json):

  - `error` (string)

## Response 404 fields (application/json):

  - `error` (string)

## Response 422 fields (application/json):

  - `error` (string)