Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /ariel/taggedfields

Create a new Tagged field.

Creates a new Tagged field as specified by input parameters

Table 1: POST /ariel/taggedfields Resource Details

MIME Type

application/json

Table 2: POST /ariel/taggedfields Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

tag

query

Required

String

text/plain

The number to be assigned to this tagged property

name

query

Required

String

text/plain

The name of this tagged property

catalog

query

Required

String

text/plain

The name of the Ariel database that will contain the new tagged field.

type

query

Required

String

text/plain

The type of this tagged field

array

query

Required

Boolean

text/plain

Is this field an array?

format_

class_

name

query

Optional

String

text/plain

Fully qualified name of formatter class

format_

params

query

Optional

String

text/plain

Optional parameter for formatter

description

query

Optional

String

text/plain

Optional description of tagged property

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: POST /ariel/taggedfields Response Codes

HTTP Response Code

Unique Code

Description

201

 

A new tagged field was successfully created.

404

1002

null

500

1020

null

Response Description

New Tagged field

Response Sample