Yeeflow is a no-code application development platform that empowers you to build enterprise-class applications that run on mobile, tablet, and web. Create custom forms, configure workflows, build informative dashboard, and get your app up and running in minutes.
Status: Preview |
Tier: Premium |
Version: 1.1 |
Name |
Summary |
AddItem (string application, string listID, [Optional]AddItemParameterBody body) |
Add an item to a list |
GetListFieldsSchema (integer appID, string listID, [Optional]string type) |
Get List Fields Schema |
Get an item by ID |
|
Delete an item |
|
UpdateItem (string application, string listID, string id, [Optional]UpdateItemParameterBody body) |
Update an item by ID |
Get fields of a list |
|
Get Applications |
|
GetApplicationLists (string listID, [Optional]integer appID) |
Get Lists of Application |
QueryItems (string application, string listID, [Optional]QueryItemsParameterBody body) |
Query items |
Delete a trigger |
Name |
Summary |
When an item is created |
|
When an item is modified |
|
When an item is created or modified |
|
When an item is deleted |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Add an item to a list
Description: Add an item to a list
Syntax:
Yeeflow.AddItem (string application, string listID, [Optional]AddItemParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
application |
string (Application) |
Select an application |
True |
|
listID |
string (List) |
Select a list |
True |
|
body |
|
|
False |
Returns:
Type:AddItemResponse
Summary: Get List Fields Schema
Description: Get List Fields Schema
Syntax:
Yeeflow.GetListFieldsSchema (integer appID, string listID, [Optional]string type)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
appID |
integer
|
|
True |
|
listID |
string
|
|
True |
|
type |
string (Field types fitler)Values: [all, editable] |
|
False |
Returns:
Type:GetListFieldsSchemaResponse
Summary: Get an item by ID
Description: Get an item by ID
Syntax:
Yeeflow.GetItem (string application, string listID, string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
application |
string (Application) |
Select an application |
True |
|
listID |
string (List) |
Select a list |
True |
|
id |
string (Item ID) |
ListDataID |
True |
Returns:
Type:GetItemResponse
Summary: Delete an item
Description: Delete an item
Syntax:
Yeeflow.DeleteItem (string application, string listID, string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
application |
string (Application) |
Select an application |
True |
|
listID |
string (List) |
Select a list |
True |
|
id |
string (Item ID) |
ListDataID |
True |
Returns:
Type:DeleteItemResponse
Summary: Update an item by ID
Description: Update an item by ID
Syntax:
Yeeflow.UpdateItem (string application, string listID, string id, [Optional]UpdateItemParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
application |
string (Application) |
Select an application |
True |
|
listID |
string (List) |
Select a list |
True |
|
id |
string (Item ID) |
ListDataID |
True |
|
body |
|
|
False |
Returns:
Type:UpdateItemResponse
Summary: Get fields of a list
Description: Get fields of a list
Syntax:
Yeeflow.GetListFields (string application, string listID)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
application |
string (Application) |
Select an application |
True |
|
listID |
string (List) |
Select a list |
True |
Returns:
Summary: Get Applications
Description: Get Applications
Syntax:
Yeeflow.GetApplications ([Optional]integer appID)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
appID |
integer
|
|
False |
Returns:
Summary: Get Lists of Application
Description: Get Lists of Application
Syntax:
Yeeflow.GetApplicationLists (string listID, [Optional]integer appID)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
listID |
string
|
|
True |
|
appID |
integer
|
|
False |
Returns:
Type:GetApplicationListsResponse
Summary: Query items
Description: Query items
Syntax:
Yeeflow.QueryItems (string application, string listID, [Optional]QueryItemsParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
application |
string (Application) |
Select an application |
True |
|
listID |
string (List) |
Select a list |
True |
|
body |
|
|
False |
Returns:
Type:QueryItemsResponse
Summary: Delete a trigger
Description: Delete a trigger
Syntax:
Yeeflow.DeleteTrigger (string appID, string listID, string hookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
appID |
string
|
|
True |
|
listID |
string
|
|
True |
|
hookId |
string
|
|
True |
Returns:
Summary: When an item is created
Description: When an item is created
Syntax:
Yeeflow.OnItemCreated (string application, string listID, [internal]string channel, OnItemCreatedParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
application |
string (Application) |
Select an application |
True |
|
listID |
string (List) |
Select a list |
True |
|
channel |
string (Channel for trigger) |
Channel for trigger |
True |
|
body |
|
|
True |
Returns:
Summary: When an item is modified
Description: When an item is modified
Syntax:
Yeeflow.OnItemModified (string application, string listID, [internal]string channel, OnItemModifiedParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
application |
string (Application) |
Select an application |
True |
|
listID |
string (List) |
Select a list |
True |
|
channel |
string (Channel for trigger) |
Channel for trigger |
True |
|
body |
|
|
True |
Returns:
Summary: When an item is created or modified
Description: When an item is created or modified
Syntax:
Yeeflow.OnItemCreatedModified (string application, string listID, [internal]string channel, OnItemCreatedModifiedParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
application |
string (Application) |
Select an application |
True |
|
listID |
string (List) |
Select a list |
True |
|
channel |
string (Channel for trigger) |
Channel for trigger |
True |
|
body |
OnItemCreatedModifiedParameterBody
|
|
True |
Returns:
Type:OnItemCreatedModifiedResponse
Summary: When an item is deleted
Description: When an item is deleted
Syntax:
Yeeflow.OnItemDeleted (string application, string listID, [internal]string channel, OnItemDeletedParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
application |
string (Application) |
Select an application |
True |
|
listID |
string (List) |
Select a list |
True |
|
channel |
string (Channel for trigger) |
Channel for trigger |
True |
|
body |
|
|
True |
Returns:
Summary:
Description:
Properties:
Name |
Type |
Summary |
Data |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Data |
string Item ID |
ID of added item |
Status |
integer(int32)
|
0 is success |
Message |
string
|
Error message |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Data |
string Item ID |
ID of deleted item |
Status |
integer(int32)
|
Status |
Message |
string
|
Message |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Data |
array of (DataItem)
|
Data |
Status |
integer(int32)
|
Status |
Message |
string
|
Message |
Summary:
Description:
Properties:
Name |
Type |
Summary |
AppID |
integer(int32)
|
AppID |
ListID |
string
|
ListID |
Title |
string
|
Title |
Description |
string
|
Description |
IsVerRecord |
boolean
|
IsVerRecord |
IconUrl |
string
|
IconUrl |
Created |
string
|
Created |
Modified |
string
|
Modified |
CreatedBy |
string
|
CreatedBy |
ModifiedBy |
string
|
ModifiedBy |
WorkspaceID |
string
|
WorkspaceID |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Data |
array of (DataItem)
|
Data |
Status |
integer(int32)
|
Status |
Message |
string
|
Message |
Summary:
Description:
Properties:
Name |
Type |
Summary |
AppID |
integer(int32)
|
AppID |
ListID |
string
|
ListID |
Title |
string
|
Title |
Description |
string
|
Description |
IsVerRecord |
boolean
|
IsVerRecord |
IconUrl |
string
|
IconUrl |
Created |
string
|
Created |
Modified |
string
|
Modified |
CreatedBy |
string
|
CreatedBy |
ModifiedBy |
string
|
ModifiedBy |
WorkspaceID |
string
|
WorkspaceID |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Data |
|
|
Status |
integer(int32)
|
Status |
Message |
string
|
Message |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Data |
array of (DataItem)
|
Data |
Status |
integer(int32)
|
Status |
Message |
string
|
Message |
TotalCount |
integer(int32)
|
TotalCount |
Summary:
Description:
Properties:
Name |
Type |
Summary |
FieldID |
string
|
Field ID |
FieldName |
string
|
Field Name |
DisplayName |
string
|
Display Name |
InternalName |
string
|
Internal Name |
Type |
string
|
Type |
DefaultValue |
string
|
Default Value |
Rules |
string
|
Rules |
IsSort |
boolean
|
IsSort |
IsIndex |
boolean
|
IsIndex |
IsSystem |
boolean
|
IsSystem |
IsUnique |
boolean
|
IsUnique |
Created |
string
|
Created |
Modified |
string
|
Modified |
CreatedBy |
string
|
Created By |
ModifiedBy |
string
|
Modified By |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Data |
|
List fields schema |
Summary:
Description: List fields schema
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Field |
string Field |
Select a field |
Value |
string
|
Value |
Type |
integer(int32) Filter type |
https://developer.yeeflow.com/api/#defFilterTypes |
Pre |
string
|
Relation to the previous condition Values: [and, or] |
Child |
array of (listDataWhereRequest)
|
Nested filter objects |
Summary:
Description:
Properties:
Name |
Type |
Summary |
callbackUrl |
string
|
callbackUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
callbackUrl |
string
|
callbackUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
callbackUrl |
string
|
callbackUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
callbackUrl |
string
|
callbackUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Fields |
array of (string)
|
Only data for fields whose IDs are in this list will be included in the result. If you don't need every field, you can use this parameter to reduce the amount of data transferred. Server will return all fields value of the item if you don't pass this parameter. |
Filters |
array of (listDataWhereRequest)
|
Filters |
Sorts |
array of (SortsItem)
|
Sorts |
PageIndex |
integer(int32) Page number |
Page number |
PageSize |
integer(int32) Page size |
Number of records per page |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Field |
string Field |
Select a field |
Desc |
boolean Is descending |
Desc |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Data |
array of (DataItem) Items |
Query retrieved items |
Status |
integer(int32)
|
Status |
Message |
string
|
Message |
TotalCount |
integer(int32)
|
TotalCount |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
RowVersion |
integer(int32)
|
RowVersion |
Data |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Data |
string Item ID |
ID of updated item |
Status |
integer(int32)
|
Status |
Message |
string
|
Message |