Docs
Ucode Docs - English
Ucode Docs - EnglishUcode Docs - Russian
Ucode Docs - English
Ucode Docs - EnglishUcode Docs - Russian
  • User Guide
    • Overview
      • Admin Panel
      • Quick-Start
        • Profile
          • User data
          • Language
          • Menu setting
          • Profile setting
          • Log out
      • Glossary
    • Menu
      • Manage setting
      • AI chat
    • Table
      • Overview
      • Create Table
      • Edit & Delete Table
      • Table setting
        • Main Setting
        • Layout
    • Items
      • Create Items
      • Update Items
      • Delete Items
    • Field & Relation
      • Field
        • Overview
        • Create Field
        • Update Field
        • Delete Field
        • Setting Field
          • Schema
          • Validation
          • AutoFill
          • AutoFilter
          • Show & Hide
        • Field Type
          • Text Field
          • Number Field
          • Date Field
          • Dropdown Field
          • Toggle Field
          • Formula Field
          • Relation Field
          • Person Field
          • File Field
          • Map Field
          • Email Field
          • Password Field
          • Link Field
          • Button Field
          • Increment ID Field
          • JSON Field
          • International Phone Field
          • Icon Field
          • QR Field
          • Color Field
          • Primary key Field
      • Relation
        • Overview Relation
        • Create Relation
        • Update Relation
        • Relation types
    • Views
      • Table View
        • Filter
        • Search
        • Fix Col's
        • Tab Group
        • Columns
        • Group
        • Import & Export
      • Calendar View
      • Timeline View
      • Board View
      • Tree View
      • Website View
    • Table Permission
      • RBAC
      • Autofilter
    • Setting
      • Project setting
      • Activity Log
  • Developer Guide
    • Getting Started
      • Introduction
      • Quick-Start
      • Architecture
      • Help & Support
    • Setting
      • Project Setting
      • Permission
      • Resources
      • API
      • Data
      • Code
      • Activity Log
    • API reference
      • Files
        • Folder upload
      • Invoke function
      • Items
        • Aggregation
        • Multiple insert
        • Multiple update
        • Upsert many
      • Auth
        • Forgot password
        • Login
          • With option
        • Logout
        • Refresh
        • Register
        • Reset password
        • Send code
Powered by GitBook
On this page
  1. Developer Guide
  2. API reference

Items

PreviousInvoke functionNextAggregation

Get item by id

get

Get item by id

Path parameters
collectionanyRequired

collection

idanyRequired

id

Responses
application/json
all ofOptional
application/json
application/json
get
GET /v2/items/{collection}/{id} HTTP/1.1
Host: 
Accept: */*

{
  "custom_message": null,
  "data": {
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "is_cached": true
  },
  "description": "text",
  "status": "text"
}

Delete item

delete

Delete item

Path parameters
collectionanyRequired

collection

idanyRequired

id

Responses
application/json
application/json
delete
DELETE /v2/items/{collection}/{id} HTTP/1.1
Host: 
Accept: */*

No content
  • GETGet all items
  • POSTCreate item
  • PUTUpdate item
  • DELETEDelete many itmes
  • PATCHMultiple Update items
  • GETGet item by id
  • DELETEDelete item

Get all items

get

Get all items

Path parameters
collectionanyRequired

collection

Query parameters
language_settinganyOptional

language_setting

dataanyOptional

data

Responses
application/json
all ofOptional
application/json
application/json
get
GET /v2/items/{collection} HTTP/1.1
Host: 
Accept: */*

{
  "custom_message": null,
  "data": {
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "is_cached": true
  },
  "description": "text",
  "status": "text"
}

Create item

post

Create item

Path parameters
collectionanyRequired

collection

Body
dataobjectOptional
is_cachedbooleanOptional
Responses
application/json
all ofOptional
application/json
application/json
post
POST /v2/items/{collection} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_cached": true
}
{
  "custom_message": null,
  "data": {
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "is_cached": true
  },
  "description": "text",
  "status": "text"
}

Update item

put

Update item

Path parameters
collectionanyRequired

collection

Body
dataobjectOptional
is_cachedbooleanOptional
Responses
application/json
all ofOptional
application/json
application/json
put
PUT /v2/items/{collection} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_cached": true
}
{
  "custom_message": null,
  "data": {
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "is_cached": true
  },
  "description": "text",
  "status": "text"
}

Delete many itmes

delete

Delete many itmes

Path parameters
collectionanyRequired

collection

Body
idsstring[]Optional
Responses
application/json
application/json
delete
DELETE /v2/items/{collection} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "ids": [
    "text"
  ]
}
No content

Multiple Update items

patch

Multiple Update items

Path parameters
collectionanyRequired

collection

Body
dataobjectOptional
idsstring[]Optional
Responses
application/json
all ofOptional
application/json
application/json
patch
PATCH /v2/items/{collection} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ids": [
    "text"
  ]
}
{
  "custom_message": null,
  "data": {
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "is_cached": true
  },
  "description": "text",
  "status": "text"
}