Versions Compared

Version Old Version 8 New Version Current
Changes made by

Content Writers

Content Writers

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

References:

In this section, you can see various option while creation model for API types let’s understand each:

Let’s explore the screens that follow, after clicking on Model Creation + button and Type as API.

Details

In this tab, user can specify the REST API Connection for integration and its details, on whose basis model is to be created.

...

Request Config Group

Config Name

Description

Request Parameters

Method

Allows to specify HTTP method among different HTTP methods such as GET, POST, PATCH, etc. are used to perform specific operations on resources. You can explore more about methods by clicking here.

Note: By default, Method is set as Post.

URL

  • Allows to add the relevant URL that corresponds to the connection from which user wishes to perform CRUD.

  • User has also accessibility to specify URL dynamically using Merge Text.

Info

Reference: Merge Text

Is Array?

Allows to specify whether the data retrieved requested from resource should be treated as a single record or multiple records (an array).

NoteNotes:

  • When enabled, it allows handling multiple records as a list, suitable for displaying data in components like Tables or Repeater.

  • When disabled, it treats the data as a single record, ideal for components like Form.

  • By default, Is Array is disabled.

Type

Allows to specify type of request query argument which will passed to URL, which is basically of two types:

  • Object: Query argument passed to the URL will be JSON body or Object.

  • String: Query argument passed to the URL will be a s string.

Note: When Is Array? is enabled, the Type is automatically set to Object by default and cannot be changed.

Request Body

Generate Schema

Allows to define object JSON schema which will be passed on to request.

Info

Reference: Schema Designer

Create New Field

Allows users to create fields that can be utilized to build an object JSON schema.

Note: When a new field is created, it will be automatically mapped in JSON structure of Generate Schema as follows:

image-20240926-101731.pngImage Addedimage-20240926-101818.pngImage Added
Info

Reference: Schema Designer

...

Response Config Group

Config Name

Description

Response Parameters

Status Code

It indicates whether a specific HTTP request has been successfully completed.

New Button

It allows to specify new Status Code as per one's business need.

Record Count

Set the record count to either Multirecord or Single, depending on whether you are dealing with multiple records or a single record in the data operationIs Array?

Allows to specify whether the data retrieved from resource should be treated as a single record or multiple records (an array).

Notes:

  • When enabled, it allows handling multiple records as a list, suitable for displaying data in components like Tables or Repeater.

  • When disabled, it treats the data as a single record, ideal for components like Form.

  • By default, Is Array is disabled.

Type

Allows to specify type of response which will retrieved through REST request, which is basically of two types:

  • Object: Provides a structured response that includes detailed data such as headers, response codes, and other relevant information

  • String: Offers a simpler text-based response.

Notes:

  • When Is Array? is enabled, the Type is automatically set to Object by default and cannot be changed.

  • The Object allows returning HTTP data along with your method's response, offering details like headers and response codes, which a String cannot provide. While using a String is sufficient for many cases, utilizing the Object can be more beneficial and convenient.

Response Body

Generate Schema

It can define fields using JSON formatAllows to define object JSON schema which will be retrieved from response.

Info

Reference: Schema Designer

Create New Field

It can create fields using the create field Model.Allows users to create fields that can be utilized to build an object JSON schema that will be received from response.

Note: When a new field is created, it will be automatically mapped in JSON structure of Generate Schema as follows:

image-20240926-101731.pngImage Addedimage-20240926-101818.pngImage Added
Info

Reference: Schema Designer

...

Schema Designer

...

Generate Schema

  • A "generate Generate schema" typically refers to the process of defining or creating a structured format that outlines how data is organized, validated, and transmitted, especially in contexts like APIs or databases.

  • In noKodr, users can define fields using JSON format.

...

Field Type

Description

Array

  • It represents a collection of items, where each item can be of the same type or a specified set of types.

  • Arrays are useful for storing lists or multiple values under a single field.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

For example, A list of user roles in a system: ["admin", "editor", "viewer"]

Checkbox

  • It represents a boolean value, typically used in forms to indicate a true/false or yes/no option.

  • This field type is ideal for settings or preferences that can be toggled on or off.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

For example, A Subscribe to newsletter option

Date

  • It stores a date value without time information.

  • This type is used when only the date is relevant, such as a birthdate or a specific event date.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

For example, "2024-08-26"

Date and Time

  • It stores both date and time information.

  • This is used when the exact moment of an event is important, such as timestamps for record creation or updates.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

For example, "2024-08-26T14:30:00Z"

Double

  • It represents a floating-point number, suitable for storing decimal values or precise measurements.

  • This type is ideal for fields that require numeric data with fractions.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

For example, 1234.56

Integer

  • It represents a whole number without any decimal points.

  • This type is used for counting or indexing, such as user IDs, quantity fields, or age.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

For example, 42

Object

  • It represents a structured data type that can contain multiple named properties, each with its own type.

  • Objects are used for more complex data structures, such as nested entities.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

For example,

image-20240826-061126.png

Text

  • It stores plain text, which can be a short string or a longer block of text.

  • This field type is used for any data that needs to be expressed in words, such as names, descriptions, or comments.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

For example, "This is a sample text field."

...

Info

String type offers a simpler text-based response thus data will be of Text type, which will be set by default.