跳转到内容

输入数据

格式

{
    "entity" :{"Entity Attributes and values"},
    "list_info": {"Attributes and values for List view kind of navigation"}
}

它是一个包含所有字段及其值的 JSON 字符串。它将作为所需操作的参数传递。


列表信息

输入数据的一般结构

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”,
    "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)
    "fields_required" : [ "list of fields required" ]
}

为了导航和获取数据,可以在 input_data 中提供 list_info。list_info 对象必须用作请求 URL 的参数,而不是作为表单数据。list_info 对象应进行编码。list_info 对象只能用于获取全部(获取列表)。list_info 可用字段有

start_index
整数
被认为数值较小的数字。
示例
39
使用此项以获取从该索引开始的任务列表。
例如:6
row_count
整数
被认为数值较小的数字。
示例
39
用于指定需要返回的行数。一次最多只能检索 100 行。要一次检索超过 100 行,可以同时使用 "start_index" 和 "row_count"。
例如:15
search_criteria
JSON数组 | JSON对象
包含应匹配以获取响应的条件。
示例
The following will retrieve all the open requests
{
  "list_info": {
    "row_count": 100,
    "search_criteria": {
      "field": "status",
      "condition": "is",
      "value": {
        "id": "100000000000008033",
        "name": "Open"
      }
    }
  }
}
需搜索的字段名称和带特定条件的值(可用条件为 "是, 不是, 小于, 大于, 小于等于, 大于等于, 包含, 不包含, 以…开始, 以…结束, 之间")。
例如 {field:'project.id',condition:'is',value:project_id}
sort_field
字符串
纯文本格式。不允许富文本或换行字符。
排序功能的列名
例如:requester
sort_order
字符串
纯文本格式。不允许富文本或换行字符。
排序顺序,升序或降序。
例如:asc 或 desc
has_more_rows
布尔值
布尔值,只有 false 和 true 两个可能的值。
指示是否有更多行。
例如:true, false
get_total_count
布尔值
布尔值,只有 false 和 true 两个可能的值。
指示是否获取数据的总数。
例如:true, false
total_count
长整数
被认为数值较大的数字。
示例
234759602834500
根据 "get_total_count" 变量包含数据的总数。
例如:true, false
fields_required
JSONARRAY
纯文本格式。不允许富文本或换行字符。
响应中需要的字段可以作为 'fields_required' 提供。必须输入 JSON 数组。响应中只会显示 fields_required 中给出的字段,以及标识符字段(即)id。
例如: ["title","priority"]