Skip to content

Input Data

Format

{
"entity" :{"Entity Attributes and values"},
"list_info": {"Attributes and values for List view kind of navigation"},
"fields_required" : [ "list of fields required" ]
}

It is a JSON string which contain all the fields and their values. It will be passed as a parameter for required operations.


List Info

The General structure of Input Data

list_info :
{
row_count         : number of rows to be returned(maximum row_count = 100)
start_index       : starting row index
sort_field        : "fieldName"
sort_order        : “asc/desc”,
search_fields     : { "field1" : "value", "field2" : value }, 
get_total_count   : boolean (by default it will be false)
has_more_rows     : boolean (will be returned with the response)
total_count       : count (will be returned with the response only)
search_criteria   :  Refer search criteria object given in the attributes of List Info(For performing advanced search)
}

For navigating and getting data, list_info can be provided with input_data. list_info object must be used as parameters for the requesting URL not as form data. list_info object should be encoded. list_info object can only be used for get all(get list). Fields available for list_info are

start_index
INT
Numerical digits which are considered to have smaller numbers.
Example
39
Use this to get a list of tasks starting from this index.
e.g: 6
row_count
INT
Numerical digits which are considered to have smaller numbers.
Example
39
Use this to mention the number of rows that needs to be returned. Maximum of only 100 rows can retrieved at a time. To retrieve more than 100 rows at a time, you can use both"start_index" and "row_count".
e.g: 15
search_fields
JSONOBJECT
Contains the column name and value to be searched for in a json object.
Example
{
  "search_fields": {
    "title ": "Telecom change",
    "priority": "High"
  }
}
The column name and value to be searched for in the format of a json object.
e.g {"title":"Change like this","priority":"High"}
search_criteria
JSONARRAY | JSONOBJECT
Contains the conditions that should be matched to fetch the response.
Example
The following will retrieve all the open requests
{
  "list_info": {
    "row_count": 100,
    "search_criteria": {
      "field": "status",
      "condition": "is",
      "value": {
        "id": "100000000000008033",
        "name": "Open"
      }
    }
  }
}
The field name and the value with specific conditions(Conditions that can be given are "is, is not, lesser than, greater than, lesser or equal, greater or equal, contains, not contains, starts with, ends with, between") to be searched.
e.g {field:'project.id',condition:'is',value:project_id}
sort_field
STRING
A text in a plain format. No rich text or new line characters allowed.
The column name for the sorting functionality
e.g:requester
sort_order
STRING
A text in a plain format. No rich text or new line characters allowed.
The sorting order, either ascending or descending.
e.g: asc or desc
has_more_rows
BOOLEAN
Boolean value which can have two possible values i.e false, true.
Indicates whether there are more rows or not.
e.g: true, false
get_total_count
BOOLEAN
Boolean value which can have two possible values i.e false, true.
Indicates whether to get the total count of data or not.
e.g: true, false
total_count
LONG
Numerical digits which are considered to have larger numbers.
Example
234759602834500
Contains the total count of the data based on the "get_total_count" variable.
e.g: true, false
fields_required
JSONARRAY
A text in a plain format. No rich text or new line characters allowed.
Fields that are needed in the response can be given as 'fields_required'. JSON array must be given as input. Only the fields that are given in fields required will be shown in response, along with the identifier field (i.e) id.
e.g: ["title","priority"]