ItemsAPI documentation

# Items

Items are a single elements of index. They are a SQL row / record counterpart consisting of fields like id, name, tags etc

# Get item

# Example

  curl -X GET 'http://localhost:3000/index1/items/1'

# Response: 200 Ok

{
  "id": 1,
  "name": "The Shawshank Redemption",
  "year": 1994,
  "rating": 9.3,
  "votes": 1790841,
  "description": "Two imprisoned men bond over a number of years, finding solace and eventual redemption through acts of common decency.",
  "storyline": "Chronicles the experiences of a formerly successful banker as a prisoner in the gloomy jailhouse of Shawshank after being found guilty of a crime he did not commit. The film portrays the man's unique way of dealing with his new, torturous life; along the way he befriends a number of fellow prisoners, most notably a wise long-term inmate named Red. Written by J-S-Golden",
  "director": [
    "Frank Darabont"
  ]
}

# Update item

# Example

  curl -X POST 'http://localhost:3000/index1/items/1/update' \
    --header "Content-Type: application/json" \
    --data '{"id": 1, "name":"xyz","year":"1955"}'

# Partial update item

# Example

  curl -X POST 'http://localhost:3000/index1/items/1/partial' \
   --header "Content-Type: application/json" \
   --data '{"name":"abc"}'

# Delete item

# Example

  curl -X DELETE 'http://localhost:3000/index1/items/1'

# Add items

# Example

  curl -X POST 'http://localhost:3000/index1/items' \
   --header "Content-Type: application/json" \
   --data '[{"name":"xyz","year":"1955"}]'

← Search →