API Guide
API GuideDeveloper Guide
  • Welcome to the API Guide
  • Getting Started
    • Introduction
    • Prerequisites
  • Authentication
  • Endpoint
    • Profile API
      • Get Customer Profile
      • Get Customer ID by phone number
    • Segment API
      • Listing Segments
      • Create new Segment
        • Upload file data for Segment
      • Export data Segment
      • Download exported Segment data
        • Check Segment exporting status
    • Event API
      • Get Event(s) List
      • Get Event History
    • Item API
      • Get Business Object(s) List
      • Get BO Attributes
      • Search Item
      • Explore Item
    • Promotion API
    • App Inbox API
      • Get Message Detail
      • Update Message
      • Count Message Unread
      • Mark All As Read
      • Get Message Performance
      • Get Catalog Performance
      • Get Destination
Powered by GitBook
On this page
  1. Endpoint
  2. Item API

Get BO Attributes

Retrieve a list of a Business Object attributes.

GET http://api.ants.tech/access/api/item/:bo_id/attribute

Path Parameters

Name
Type
Description

bo_id

Number

The ID of the BO you want to get its attributes. For example, if you want to get BO Customer's attributes, pass -1003.

Headers

Name
Type
Description

Authorization*

String

Bearer <ACCESS_TOKEN>

{
    "code": 200,
    "message": "Success",
    "data": {
        "entries": [
            {
                "row_count": 93,
                "status": 1,
                "item_property_display": "Label external data customers",
                "type": 2,
                "process_status": 8,
                "portal_id": 564244922,
                "item_type_id": -1003,
                "item_property_name": "label_external_data_customers",
                "storage_type": 3,
                "compute_type": null,
                "created_date": "2023-08-18T02:16:39.759Z",
                "last_updated_date": "2023-08-18T02:16:39.759Z",
                "property_display_multilang": {
                    "EN": "Label external data customers",
                    "DEFAULT_LANG": "EN"
                },
                "size": null,
                "type_labels": [
                    "_ATTR_TYPE_CUSTOM_TYPE"
                ],
                "accepted_actions": {},
                "group_name_multilang": {
                    "EN": "",
                    "DEFAULT_LANG": "EN"
                },
                "group_display": null
            },
            {
                "row_count": 93,
                "status": 1,
                "item_property_display": "Phone",
                "type": 2,
                "process_status": 8,
                "portal_id": 564244922,
                "item_type_id": -1003,
                "item_property_name": "phone",
                "storage_type": 3,
                "compute_type": null,
                "created_date": "2020-07-10T07:24:24.738Z",
                "last_updated_date": "2023-07-20T06:49:50.903Z",
                "property_display_multilang": {
                    "EN": "Phone",
                    "DEFAULT_LANG": "EN"
                },
                "size": null,
                "type_labels": [
                    "_ATTR_TYPE_CUSTOM_TYPE"
                ],
                "accepted_actions": {},
                "group_name_multilang": {
                    "EN": "",
                    "DEFAULT_LANG": "EN"
                },
                "group_display": null
            }
            // ... More BO Attribute
        ],
        "meta": {
            "total": 93
        }
    },
    "duration": "0.454 ms"
}
{
    "code": 301,
    "message": "Permission denied",
    "data": "You don't have permission to access this request!"
}
PreviousGet Business Object(s) ListNextSearch Item

Last updated 6 months ago