ItemApi

All URIs are relative to http://127.0.0.1:8000/api

Method HTTP request Description
itemByType GET /item/type/{type} Get items by type
itemChildren GET /item/children Get child items (items with a parent)
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
itemParents GET /item/parents Get parent items (items with no parent)
itemShow GET /item/{item} Display the specified resource
itemStore POST /item Store a newly created resource in storage
itemUpdate PATCH /item/{item} Update the specified resource in storage
itemUpdate2 PUT /item/{item} Update the specified resource in storage
itemUpdateTags PATCH /item/{item}/tags Update the tags associated with an item. This endpoint handles attaching and/or detaching tags from an item using a single operation. Designed for granular tag management, allowing callers to perform specific tag attach/detach operations without requiring a full item update
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)

itemByType

ItemForTag200Response itemByType()

Example

import {
    ItemApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);

let type: string; // (default to undefined)
let type2: 'object' | 'monument' | 'detail' | 'picture'; // (default to undefined)
let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.itemByType(
    type,
    type2,
    include
);

Parameters

Name Type Description Notes      
type [string]   defaults to undefined      
type2 [**'object' 'monument' 'detail' 'picture']Array<'object' | 'monument' | 'detail' | 'picture'>**   defaults to undefined
include [string]   (optional) defaults to undefined      

Return type

ItemForTag200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ItemResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemChildren

ItemForTag200Response itemChildren()

Example

import {
    ItemApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);

let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.itemChildren(
    include
);

Parameters

Name Type Description Notes
include [string]   (optional) defaults to undefined

Return type

ItemForTag200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ItemResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

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

HTTP request headers

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

ItemForTag200Response 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)
let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.itemForTag(
    tag,
    include
);

Parameters

Name Type Description Notes
tag [string] The tag ID defaults to undefined
include [string]   (optional) defaults to undefined

Return type

ItemForTag200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ItemResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

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);

let page: number; // (optional) (default to undefined)
let perPage: number; // (optional) (default to undefined)
let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.itemIndex(
    page,
    perPage,
    include
);

Parameters

Name Type Description Notes
page [number]   (optional) defaults to undefined
perPage [number]   (optional) defaults to undefined
include [string]   (optional) defaults to undefined

Return type

ItemIndex200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Paginated set of `ItemResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemParents

ItemForTag200Response itemParents()

Example

import {
    ItemApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);

let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.itemParents(
    include
);

Parameters

Name Type Description Notes
include [string]   (optional) defaults to undefined

Return type

ItemForTag200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ItemResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemShow

ItemShow200Response 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)
let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.itemShow(
    item,
    include
);

Parameters

Name Type Description Notes
item [string] The item ID defaults to undefined
include [string]   (optional) defaults to undefined

Return type

ItemShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemStore

ItemShow200Response itemStore(storeItemRequest)

Example

import {
    ItemApi,
    Configuration,
    StoreItemRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);

let storeItemRequest: StoreItemRequest; //

const { status, data } = await apiInstance.itemStore(
    storeItemRequest
);

Parameters

Name Type Description Notes
storeItemRequest StoreItemRequest    

Return type

ItemShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemUpdate

ItemShow200Response itemUpdate()

Example

import {
    ItemApi,
    Configuration,
    UpdateItemRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);

let item: string; //The item ID (default to undefined)
let updateItemRequest: UpdateItemRequest; // (optional)

const { status, data } = await apiInstance.itemUpdate(
    item,
    updateItemRequest
);

Parameters

Name Type Description Notes
updateItemRequest UpdateItemRequest    
item [string] The item ID defaults to undefined

Return type

ItemShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemUpdate2

ItemShow200Response itemUpdate2()

Example

import {
    ItemApi,
    Configuration,
    UpdateItemRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);

let item: string; //The item ID (default to undefined)
let updateItemRequest: UpdateItemRequest; // (optional)

const { status, data } = await apiInstance.itemUpdate2(
    item,
    updateItemRequest
);

Parameters

Name Type Description Notes
updateItemRequest UpdateItemRequest    
item [string] The item ID defaults to undefined

Return type

ItemShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemUpdateTags

ItemShow200Response itemUpdateTags()

Example

import {
    ItemApi,
    Configuration,
    UpdateTagsItemRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);

let item: string; //- The item to update tags for (default to undefined)
let updateTagsItemRequest: UpdateTagsItemRequest; // (optional)

const { status, data } = await apiInstance.itemUpdateTags(
    item,
    updateTagsItemRequest
);

Parameters

Name Type Description Notes
updateTagsItemRequest UpdateTagsItemRequest    
item [string] - The item to update tags for defaults to undefined

Return type

ItemShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemWithAllTags

ItemForTag200Response itemWithAllTags(withAllTagsItemRequest)

Example

import {
    ItemApi,
    Configuration,
    WithAllTagsItemRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);

let withAllTagsItemRequest: WithAllTagsItemRequest; //

const { status, data } = await apiInstance.itemWithAllTags(
    withAllTagsItemRequest
);

Parameters

Name Type Description Notes
withAllTagsItemRequest WithAllTagsItemRequest    

Return type

ItemForTag200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ItemResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemWithAnyTags

ItemForTag200Response itemWithAnyTags(withAnyTagsItemRequest)

Example

import {
    ItemApi,
    Configuration,
    WithAnyTagsItemRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemApi(configuration);

let withAnyTagsItemRequest: WithAnyTagsItemRequest; //

const { status, data } = await apiInstance.itemWithAnyTags(
    withAnyTagsItemRequest
);

Parameters

Name Type Description Notes
withAnyTagsItemRequest WithAnyTagsItemRequest    

Return type

ItemForTag200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ItemResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

This documentation was automatically generated from the TypeScript API client.