ItemApi
All URIs are relative to http://localhost:8000/api
Method | HTTP request | Description |
---|---|---|
itemDestroy | DELETE /item/{item} | Remove the specified resource from storage |
itemForTag | GET /item/for-tag/{tag} | Get items for a specific tag |
itemIndex | GET /item | Display a listing of the resource |
itemShow | GET /item/{item} | Display the specified resource |
itemStore | POST /item | Store a newly created resource in storage |
itemUpdate | PUT /item/{item} | Update the specified resource in storage |
itemUpdateTags | PATCH /item/{item}/tags | Update tags for the specified item without modifying other item properties |
itemWithAllTags | POST /item/with-all-tags | Get items that have ALL of the specified tags (AND condition) |
itemWithAnyTags | POST /item/with-any-tags | Get items that have ANY of the specified tags (OR condition) |
itemDestroy
itemDestroy()
Example
import {
ItemApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);
let item: string; //The item ID (default to undefined)
const { status, data } = await apiInstance.itemDestroy(
item
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
item | [string] | The item ID | defaults to undefined |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |204 | No content | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
itemForTag
ItemIndex200Response itemForTag()
Example
import {
ItemApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);
let tag: string; //The tag ID (default to undefined)
const { status, data } = await apiInstance.itemForTag(
tag
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tag | [string] | The tag ID | defaults to undefined |
Return type
ItemIndex200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ItemResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
itemIndex
ItemIndex200Response itemIndex()
Example
import {
ItemApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);
const { status, data } = await apiInstance.itemIndex();
Parameters
This endpoint does not have any parameters.
Return type
ItemIndex200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ItemResource` | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
itemShow
ItemStore200Response itemShow()
Example
import {
ItemApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);
let item: string; //The item ID (default to undefined)
const { status, data } = await apiInstance.itemShow(
item
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
item | [string] | The item ID | defaults to undefined |
Return type
ItemStore200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
itemStore
ItemStore200Response itemStore(itemStoreRequest)
Example
import {
ItemApi,
Configuration,
ItemStoreRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);
let itemStoreRequest: ItemStoreRequest; //
const { status, data } = await apiInstance.itemStore(
itemStoreRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
itemStoreRequest | ItemStoreRequest |
Return type
ItemStore200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
itemUpdate
ItemStore200Response itemUpdate(itemStoreRequest)
Example
import {
ItemApi,
Configuration,
ItemStoreRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);
let item: string; //The item ID (default to undefined)
let itemStoreRequest: ItemStoreRequest; //
const { status, data } = await apiInstance.itemUpdate(
item,
itemStoreRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
itemStoreRequest | ItemStoreRequest | ||
item | [string] | The item ID | defaults to undefined |
Return type
ItemStore200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemResource` | - | |422 | Validation error | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
itemUpdateTags
ItemStore200Response itemUpdateTags()
This endpoint allows quick editing of tag associations by specifying which tags to attach or detach from the item. It provides fine-grained control over tag operations without requiring a full item update.
Example
import {
ItemApi,
Configuration,
ItemUpdateTagsRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);
let item: string; //- The item to update tags for (default to undefined)
let itemUpdateTagsRequest: ItemUpdateTagsRequest; // (optional)
const { status, data } = await apiInstance.itemUpdateTags(
item,
itemUpdateTagsRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
itemUpdateTagsRequest | ItemUpdateTagsRequest | ||
item | [string] | - The item to update tags for | defaults to undefined |
Return type
ItemStore200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemResource` | - | |422 | Validation error | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
itemWithAllTags
ItemIndex200Response itemWithAllTags(itemWithAllTagsRequest)
Example
import {
ItemApi,
Configuration,
ItemWithAllTagsRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);
let itemWithAllTagsRequest: ItemWithAllTagsRequest; //
const { status, data } = await apiInstance.itemWithAllTags(
itemWithAllTagsRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
itemWithAllTagsRequest | ItemWithAllTagsRequest |
Return type
ItemIndex200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ItemResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
itemWithAnyTags
ItemIndex200Response itemWithAnyTags(itemWithAllTagsRequest)
Example
import {
ItemApi,
Configuration,
ItemWithAllTagsRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);
let itemWithAllTagsRequest: ItemWithAllTagsRequest; //
const { status, data } = await apiInstance.itemWithAnyTags(
itemWithAllTagsRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
itemWithAllTagsRequest | ItemWithAllTagsRequest |
Return type
ItemIndex200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ItemResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
This documentation was automatically generated from the TypeScript API client.