Appearance

On this page

Accessing Items ​

The ItemsService provides access to perform operations on items in a collection. It requires a collection and a schema to operate.

js
export default defineEndpoint((router, context) => {
  const { services, getSchema } = context;
  const { ItemsService } = services;

  router.get('/', async (req, res) => {
    const itemsService = new ItemsService('collection_name', {
      schema: await getSchema(),
      accountability: req.accountability
    });

    // Your route handler logic
  });
});
export default defineEndpoint((router, context) => {
  const { services, getSchema } = context;
  const { ItemsService } = services;

  router.get('/', async (req, res) => {
    const itemsService = new ItemsService('collection_name', {
      schema: await getSchema(),
      accountability: req.accountability
    });

    // Your route handler logic
  });
});

Create an Item ​

js
router.post('/', async (req, res) => {
  const itemsService = new ItemsService('collection_name', {
    schema: await getSchema(),
    accountability: req.accountability
  });

  const data = await itemsService.createOne({
    title: 'Hello world!',
    body: 'This is our first article',
  });

  res.json(data);
});
router.post('/', async (req, res) => {
  const itemsService = new ItemsService('collection_name', {
    schema: await getSchema(),
    accountability: req.accountability
  });

  const data = await itemsService.createOne({
    title: 'Hello world!',
    body: 'This is our first article',
  });

  res.json(data);
});

Get an Item ​

js
router.get('/', async (req, res) => {
  const itemsService = new ItemsService('collection_name', {
    schema: await getSchema(),
    accountability: req.accountability
  });

  const data = await itemsService.readOne('item_id');

  res.json(data);
});
router.get('/', async (req, res) => {
  const itemsService = new ItemsService('collection_name', {
    schema: await getSchema(),
    accountability: req.accountability
  });

  const data = await itemsService.readOne('item_id');

  res.json(data);
});

Update an Item ​

js
router.patch('/', async (req, res) => {
  const itemsService = new ItemsService('collection_name', {
    schema: await getSchema(),
    accountability: req.accountability
  });

  const data = await itemsService.updateOne('item_id', {
    title: "An updated title"
  });

  res.json(data);
});
router.patch('/', async (req, res) => {
  const itemsService = new ItemsService('collection_name', {
    schema: await getSchema(),
    accountability: req.accountability
  });

  const data = await itemsService.updateOne('item_id', {
    title: "An updated title"
  });

  res.json(data);
});

Delete an Item ​

js
router.delete('/', async (req, res) => {
  const itemsService = new ItemsService('collection_name', {
    schema: await getSchema(),
    accountability: req.accountability
  });

  const data = await itemsService.deleteOne('item_id');

	res.json(data);
});
router.delete('/', async (req, res) => {
  const itemsService = new ItemsService('collection_name', {
    schema: await getSchema(),
    accountability: req.accountability
  });

  const data = await itemsService.deleteOne('item_id');

	res.json(data);
});

Explore ItemsService In-Depth

Refer to the full list of methods in our codebase.