/
APP (Data model)

APP (Data model)

Table name : ie_app

Field Name

Business Purpose

Field type (with size)

Data Type

Should Index?

Is Primary Key?

Is Foreign Key?

Is it a required field?

Is it editable?

Is it Unique?

Specific validations for some field type

 

REFERENCE OF OTHER BUILDING BLOCK

Field Name

Business Purpose

Field type (with size)

Data Type

Should Index?

Is Primary Key?

Is Foreign Key?

Is it a required field?

Is it editable?

Is it Unique?

Specific validations for some field type

 

REFERENCE OF OTHER BUILDING BLOCK

Id

Unique identifier for this app

Integer

bigint

Yes

Yes

No

Yes

No

Yes

No

No

slug

Unique identifier for this app

string

varchar

No

No

No

Yes

No

Yes

No

No

title

App’s real name

string

varchar

No

No

No

Yes

Yes

Yes

No

No

description

Description of app’s core features

string

varchar

No

No

No

Yes

Yes

No

No

No

partnerId

unique and incremental id for this table

number

big int

Yes

No

Yes

yes

No

Yes

incremental

Yes (Partner)

homePageUrl

Homepage URL of App

string

varchar

No

No

No

No

Yes

No

Follow a pattern: URL

No

logoUrl

 App’s logo

string

varchar

No

No

No

No

Yes

No

Follow a pattern: URL

No

intendedAudience

Integration type of app

Enum [Public, Private]

enum

No

No

No

Yes

Yes

No

No

Private: Integration to be used on your own or inside the company
Public: To share integration with third parties

appCategory

App Category

Array[String]

enum

No

No

No

Yes

Yes

No

No

eg: Accounting, Ecommerce, Finance etc

status

Current status of the app

Enum[draft, under review, active]

enum

No

No

No

Yes

Yes

No

No

Draft: App is in the integration phase
Under review: App has been submitted for being reviewed
Active: App has been reviewed

whitelistedRedirectUrls

The URL to which a user is redirected after authorizing the client

Array[string]

text

No

No

No

Yes

Yes

No

Follow a pattern: URL

No

clientId

It is a public identifier for apps

string

varchar

No

No

No

Yes

No

Yes

No

No

metaTagline

It is a one-line advertisement for your app that will appear in search results

string

text

No

No

No

No

Yes

No

No

No

metaTwitterUsername

Twitter user name

string

varchar

No

No

No

No

Yes

Yes

No

No

metaExpectedResponseTime

Expected response time if an issue is encountered

string

varchar

No

No

No

No

Yes

No

No

No

metaDocumentationUrl

The API documentation of your app.

string

text

No

No

No

No

Yes

No

Follow a pattern: URL

No

metaAppFeatureDetails

A detailed description of API features

string

text

No

No

No

No

Yes

No

No

No

metaScreenshotUrls

A collection of screenshot URLs

Array[string]

text

No

No

No

No

Yes

No

Follow a pattern: URL

No

metaNotes

Details regarding app access

string

text

No

No

No

No

Yes

No

No

No

metaMarketingEmail

Contact email of a marketing-related person

string

varchar

No

No

No

No

Yes

No

No

No

metaMarketingNumber

Contact phone number of a marketing-related person

string

varchar

No

No

No

No

Yes

No

No

No

metaTechnicalEmail

Contact email in case of a technical issue

string

varchar

No

No

No

No

Yes

No

No

No

metaTechnicalNumber

Contact phone number in case of a technical issue

string

varchar

No

No

No

No

Yes

No

No

No

metaTestAccountUsername

Username to test app

string

varchar

No

No

No

No

Yes

No

No

No

metaTestAccountPassword

Password to test App

string

varchar

No

No

No

No

Yes

No

No

No

createdBy

UserId of the creator of App

string

bigint

No

No

No

No

No

No

No

No

createdAt

App creation date

string

timestamp

No

No

No

Yes

No

No

yyyy-mm-dd h:m:s

No

updatedAt

Last updated date

string

timestamp

No

No

No

Yes

Yes

No

yyyy-mm-dd h:m:s

No

 

Table name: ie_app_credential

Field Name

Business Purpose

Field type (with size)
Rich text
Text (short text, long text)
Number (integer, decimal)
Date and Time
Location
Media
Boolean
enum [value1, value 2]
Array[of what]
JSON object
Reference

Data Type

Should Index?

Is Primary Key?

Is Foreign Key?

Is it a required field?

Is it editable?

Is it Unique?

Specific validations for some field type

  1. Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern

  1. Media (file type, image dimensions, file size)

 

REFERENCE OF OTHER BUILDING BLOCK

Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records

In case there is the condition, mention the condition

In case of enum and Boolean, explain meaning of each enum value or boolean value

Field Name

Business Purpose

Field type (with size)
Rich text
Text (short text, long text)
Number (integer, decimal)
Date and Time
Location
Media
Boolean
enum [value1, value 2]
Array[of what]
JSON object
Reference

Data Type

Should Index?

Is Primary Key?

Is Foreign Key?

Is it a required field?

Is it editable?

Is it Unique?

Specific validations for some field type

  1. Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern

  1. Media (file type, image dimensions, file size)

 

REFERENCE OF OTHER BUILDING BLOCK

Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records

In case there is the condition, mention the condition

In case of enum and Boolean, explain meaning of each enum value or boolean value

Id

Unique identifier for app_credential

Integer

bigint

Yes

Yes

No

Yes

No

Yes

No

No

appId

Unique identifier for this app

Integer

bigint

Yes

No

Yes

Yes

No

Yes

No

No

clientSecret

It is a secret known only to the application and the authorization server.

string

varchar

No

No

No

Yes

Yes

Yes

No

No

createdAt

App creation date

string

timestamp

No

No

No

Yes

No

No

yyyy-mm-dd h:m:s

No

updatedAt

Last updated date

string

timestamp

No

No

No

Yes

Yes

No

yyyy-mm-dd h:m:s

No