Portal

Portals are the core resource to any project.

The Portal Object

Attributes

Type

Description

id

Integer

Unique Id for a Portal

portalName

String

Display name for a Portal

externalPortalId

String

Unique string identifier for a Portal. Example: FK, AMZ, etc.

isBrandStore

Flag to identify if it is a website portal or marketplace portal

portalLogoUrl

String

Url path for the logo of Portal

status

boolean

This flag is used to define a Portal Active or Inactive

fields

The fields which are linked to this portal

createdAt

String

Creation date and time

updatedAt

String

Updation date and time

The Fields Object

Fields

Description

id

Integer

Unique auto-increment id for a field

portalId

Integer

The portal for which the field has been created

fieldName

String

Name of the field

fieldType

String

The Type of the field viz.STRING ,NUMBER ,PASSWORD ,OPTIONS

optionValues

String

The allowed values of the field if the type is options

isRequired

boolean

Flag to maintain the mandatory check in the field

hint

String

The hint as an additional information if the type is Password

createdAt

String

Created at date and time

updatedAt

String

Updated at Date and time

The Is Brand Store Object

Is Brand Store Value

Description

1

The defined portal is a brand store/website

0

The defined portal is a marketplace

Last updated