Connectors Reference

Yeeflow

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

 

Actions:

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

GetItem (string application, string listID, string id)

Get an item by ID

DeleteItem (string application, string listID, string id)

Delete an item

UpdateItem (string application, string listID, string id, [Optional]UpdateItemParameterBody body)

Update an item by ID

GetListFields (string application, string listID)

Get fields of a list

GetApplications ([Optional]integer appID)

Get Applications

GetApplicationLists (string listID, [Optional]integer appID)

Get Lists of Application

QueryItems (string application, string listID, [Optional]QueryItemsParameterBody body)

Query items

DeleteTrigger (string appID, string listID, string hookId)

Delete a trigger

 

Triggers:

Name

Summary

OnItemCreated (string application, string listID, [internal]string channel, OnItemCreatedParameterBody body)

When an item is created

OnItemModified (string application, string listID, [internal]string channel, OnItemModifiedParameterBody body)

When an item is modified

OnItemCreatedModified (string application, string listID, [internal]string channel, OnItemCreatedModifiedParameterBody body)

When an item is created or modified

OnItemDeleted (string application, string listID, [internal]string channel, OnItemDeletedParameterBody body)

When an item is deleted

 

Objects:

Name

Summary

AddItemParameterBody

 

AddItemResponse

 

DeleteItemResponse

 

DeleteTriggerResponse

 

GetApplicationListsResponse

 

GetApplicationsResponse

 

GetItemResponse

 

GetListFieldsResponse

 

GetListFieldsSchemaResponse

 

listDataWhereRequest

 

OnItemCreatedModifiedParameterBody

 

OnItemCreatedModifiedResponse

 

OnItemCreatedParameterBody

 

OnItemCreatedResponse

 

OnItemDeletedParameterBody

 

OnItemDeletedResponse

 

OnItemModifiedParameterBody

 

OnItemModifiedResponse

 

QueryItemsParameterBody

 

QueryItemsResponse

 

UpdateItemParameterBody

 

UpdateItemResponse

 

 

Actions:

AddItem

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

GetApplications

listID

string

(List)

Select a list

True

GetApplicationLists

body

AddItemParameterBody

 

 

False

 

Returns:

          Type:AddItemResponse

 

GetListFieldsSchema

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

 

GetItem

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

GetApplications

listID

string

(List)

Select a list

True

GetApplicationLists

id

string

(Item ID)

ListDataID

True

 

Returns:

          Type:GetItemResponse

 

DeleteItem

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

GetApplications

listID

string

(List)

Select a list

True

GetApplicationLists

id

string

(Item ID)

ListDataID

True

 

Returns:

          Type:DeleteItemResponse

 

UpdateItem

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

GetApplications

listID

string

(List)

Select a list

True

GetApplicationLists

id

string

(Item ID)

ListDataID

True

body

UpdateItemParameterBody

 

 

False

 

Returns:

          Type:UpdateItemResponse

 

GetListFields

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

GetApplications

listID

string

(List)

Select a list

True

GetApplicationLists

 

Returns:

          Type:GetListFieldsResponse

 

GetApplications

Summary: Get Applications

Description: Get Applications

 

Syntax:

Yeeflow.GetApplications ([Optional]integer appID)

 

Parameters:

Name

Type

Summary

Required

Related Action

appID

integer

 

 

False

 

Returns:

          Type:GetApplicationsResponse

 

GetApplicationLists

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

 

QueryItems

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

GetApplications

listID

string

(List)

Select a list

True

GetApplicationLists

body

QueryItemsParameterBody

 

 

False

 

Returns:

          Type:QueryItemsResponse

 

DeleteTrigger

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:

          Type:DeleteTriggerResponse

 

Triggers:

Trigger OnItemCreated

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

GetApplications

listID

string

(List)

Select a list

True

GetApplicationLists

channel

string

(Channel for trigger)

Channel for trigger

True

body

OnItemCreatedParameterBody

 

 

True

 

Returns:

          Type:OnItemCreatedResponse

 

Trigger OnItemModified

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

GetApplications

listID

string

(List)

Select a list

True

GetApplicationLists

channel

string

(Channel for trigger)

Channel for trigger

True

body

OnItemModifiedParameterBody

 

 

True

 

Returns:

          Type:OnItemModifiedResponse

 

Trigger OnItemCreatedModified

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

GetApplications

listID

string

(List)

Select a list

True

GetApplicationLists

channel

string

(Channel for trigger)

Channel for trigger

True

body

OnItemCreatedModifiedParameterBody

 

 

True

 

Returns:

          Type:OnItemCreatedModifiedResponse

 

Trigger OnItemDeleted

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

GetApplications

listID

string

(List)

Select a list

True

GetApplicationLists

channel

string

(Channel for trigger)

Channel for trigger

True

body

OnItemDeletedParameterBody

 

 

True

 

Returns:

          Type:OnItemDeletedResponse

 


 

AddItemParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

Data

Data

 

 

 

Data

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

AddItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Data

string

Item ID

ID of added item

Status

integer(int32)

 

0 is success

Message

string

 

Error message


 

DeleteItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Data

string

Item ID

ID of deleted item

Status

integer(int32)

 

Status

Message

string

 

Message


 

DeleteTriggerResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetApplicationListsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Data

array of (DataItem)

 

Data

Status

integer(int32)

 

Status

Message

string

 

Message

 

DataItem

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

 


 

GetApplicationsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Data

array of (DataItem)

 

Data

Status

integer(int32)

 

Status

Message

string

 

Message

 

DataItem

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

 


 

GetItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Data

Data

 

 

Status

integer(int32)

 

Status

Message

string

 

Message

 

Data

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

GetListFieldsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Data

array of (DataItem)

 

Data

Status

integer(int32)

 

Status

Message

string

 

Message

TotalCount

integer(int32)

 

TotalCount

 

DataItem

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

 


 

GetListFieldsSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Data

Data

 

List fields schema

 

Data

Summary:

Description: List fields schema

 

          Properties:

Name

Type

Summary

 


 

listDataWhereRequest

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


 

OnItemCreatedModifiedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

 

callbackUrl


 

OnItemCreatedModifiedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OnItemCreatedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

 

callbackUrl


 

OnItemCreatedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OnItemDeletedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

 

callbackUrl


 

OnItemDeletedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OnItemModifiedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

 

callbackUrl


 

OnItemModifiedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

QueryItemsParameterBody

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

 

SortsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Field

string

Field

Select a field

Desc

boolean

Is descending

Desc

 


 

QueryItemsResponse

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

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

UpdateItemParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

RowVersion

integer(int32)

 

RowVersion

Data

Data

 

 

 

Data

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

UpdateItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Data

string

Item ID

ID of updated item

Status

integer(int32)

 

Status

Message

string

 

Message