Skip to main content

Important Information

Query Parameters: information that will be passed through the header of an API

Fields​

Information that users can retrieve

Example​

{
  "fields": "info1,info2" // There will be 2 pieces of information, info1, info2 in the returned result
}

Filtering​

Information that users can use as filtering conditions to retrieve data

Condition Operation​

OperationDescription
eqEqual
isIs value
inIn array
not_inNot in array
containsContains characters
betweenIn range
not_betweenNot in range
gteGreater than or equal
gtGreater than
lteLess than or equal
ltLess than

Example​

{
  "filtering": {
    "info1:eq": 1,  // If info1 is equal to 1
    "info1:is": 1,  // If info1 is 1
    "info1:in": [1,2,3],  // If info1 has a value in the array [1,2,3]
    "info1:not_in": [1,2,3],  // If info1 does not have a value in the array [1,2,3]
    "info1:contains": "info", // If info1 contains the value "info"
    "info1:between": [1,10],  // If info1 has a value between 1 and 10
    "info1:not_between": [1,10],  // If info1 does not have a value between 1 and 10
    "info1:gte": 1, // If info1 is greater than or equal to 1
    "info1:gt": 1,  // If info1 is greater than 1
    "info1:lte": 1, // If info1 is less than or equal to 1
    "info1:lt": 1,  // If info1 is less than 1
  }
}

Sort​

Information will be sorted

Example​

{
  "sort": "info1" // The returned result will be sorted by info1
}

If there is no Direction, the default will be asc

Direction​

Data sorting direction

DirectionDescription
ascSmallest to largest
descLargest to smallest

Example​

{
  "direction": "asc" // The returned result will be sorted from smallest to largest
}

Accompanied by Sort

Limit​

Limit the number of results returned

Example​

{
  "limit": 5 // 5 results will be returned
}
}

Offset​

Determine the starting position of the returned results

Example​

{
  "offset": 5 // Will skip the first 5 results and start from the 6th result
}

Information related to POST, PUT methods​

Body Parameters: information that will be passed through the body of an API

  • Data definition refers to information separately configured by the user that did not previously exist in the system.
  • Data can be defined for each separate feature.
  • The list of data definitions can be retrieved via the following API: api/v6/feature_name/custom_fields
  • Data definition information can be included with the main information.

Example​

{
  "custom_fields": {
    "custom_field_1": "info 1" // This is a piece of information in the data definition that the system does not have by default, users can set it up themselves
  } 
}