Fieldset - create a fieldset

POST

/segments/v2/{bucket}/fieldset

Create a fieldset that can be used to create a segment, report or export

Parameters

Path Parameters

bucket

required

string

The bucket to create the fieldset for

Query Parameters

name

string

default: Field list based on {resource_type}

The name of the fieldset

description

string

default: Field list based on {resource_type}

The description of the fieldset

fields

Array<string>

default: field_name

The fields of the fieldset

resource

string

Used to generate the fieldset from all the fields on a resource

applicable_resources

Array<string>

default: resource_type

The applicable resources of the fieldset

Responses

201

A single fieldset

object

active

boolean

applicable_resources

Array<string>

created

string

description

string

field_display

Array<object>

object

field

string

type

string

fields

Array<string>

last_updated

string

locked

boolean

name

string

record_state

string

uid

string

uri

string

400

A standard error message

object

description

A human readable description of the error

string

error

A concise error message

string

type

A machine readable error type

string