Add Form

post https://neon-config-qa.spika.com/config/v1/{space}/forms

Path Params

space

string

required

The name of the space (database) assigned to you.

Body Params

assignedTo

string

length between 0 and 50

Can contain the user Id of a portal user who the Entity belongs to.

bizId

string

length between 0 and 50

An optional business identifier for the Entity.
This may be a reference to a different system, and if specified must be unique across the platform.
When looking up Entities by business Id, it must be preceded by the '$' sign.

category

string

length between 0 and 50

An optional free-text field which can be used by applications to categorize Entities or filter by and group related Entities.

cmsContent

object

Optional rich content associated with the Entity. Not applicable for all Entity Types.

cmsDefinitionId

string

Optional CMS Definition assigned to the Entity to control and validate associated CMS fields. Not applicable to all Entity Types.

config

object

Configuration JSON, specific to each type of Entry

description

string

length between 0 and 1000

An optional description of what the Entity is for.

dimensionGate

json

Optional Dimension Gate, controlling under what circumstances the Entity is accessible. Not applicable for all Entity Types.

string

length ≤ 15

Unique Internal Id of the entity. Set on creation and can't be changed.
Lowercase letters, digits and underscore allowed.
If not specified then an id will be generated.

name

string

required

length between 0 and 100

The unique name of the entity (case sensitive).
Upper and lowercase, digits and undescore allowed.
When referencing Entities by name in scripts, the name should be preceded by the '@' sign.

state

string

required

The Entity's state

Response

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://neon-config-qa.spika.com/config/v1/space/forms \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"state":"DRAFT"}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created