Search Item

Search for BO data records (i.e. items) based on specified a search criteria.

POST https://api.ants.tech/access/api/item/search

Headers

Name	Type	Description
Authorization*	String	Bearer <ACCESS_TOKEN>

Request Body

Name	Type	Description
itemTypeId*	Number	The ID of the BO you are searching for its data. For example, -1003
itemTypeName*	String	The name of BO you are searching. For example, customer
attrs*	String	The name of the attribute(s) you want the API to return for you. For example, "customer_id","name"
filters*	JSON	Your multi-condition filter criteria. For example: { "OR": [ { "AND": [ { "column": "customer_id", "data_type": "string", "operator": "matches", "value_type": "normal", "value": ["00020551c21392c....."], "condition_type": "comp_attr" } ] } ] }
filters.OR[]*	Array of JSON	An array of your conditions, the BO data record will be returned if it meets one of these conditions. For example: [ { "AND": [ { "column": "customer_id", "data_type": "string", "operator": "matches", "value_type": "normal", "value": ["00020551c21392c....."], "condition_type": "comp_attr" } ] } ]
filters.OR[].AND[]*	Array of JSOn	An array of your conditions, the BO data record will be returned only when it meets all of these conditions. For example: [ { "column": "customer_id", "data_type": "string", "operator": "matches", "value_type": "normal", "value": ["00020551c21392c....."], "condition_type": "comp_attr" } ]
filters.OR[].AND[].column*	String	The column you want to filter on. For example, customer_id
filters.OR[].AND[].data_type*	String	The data type of the column you are filtering on. For example, the data type of the column customer_id is string.
filters.OR[].AND[].operator*	String	The operator that you want to use to compare your BO data. For example, you want to match a list of customer_id, your operator is matches.
filters.OR[].AND[].value_type*	String	The value that you would use to compare your BO data (may have different data types based on the operator you choose). For example, if you are matching a list of customer_id, your value should be ["00020551c21392cf76b4745a37b082d2"].

200: OK The request is successful, the server responds with a list of items that match the search criteria.

{
    "code": 200,
    "message": "Search Business Object success",
    "data": {
        "status": true,
        "data": [
            {
                "name": "QBJy1TINhIWTL8DW1cP6yolv5XGwaAvCBmEgUSnlJG/cCfbXkGvNmXwkmNkQ6BRHd3aDBjQEBOl1A8Nsijtbrzc4w63seRXe0eZdLP3qigqm7PcZwLh1UXpR/Y1u8D9f1VvpeD2goN5eMWUJKbkl1OkM4CNt0R1wmhpABRn7ST4=",
                "customer_id": "87b20a420c47644f0c8ce60e05f247a4"
            }
        ]
    }
}