CollectionApi

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

Method HTTP request Description
collectionAttachItem POST /collection/{collection}/attach-item Attach an item to a collection via many-to-many relationship
collectionAttachItems POST /collection/{collection}/attach-items Attach multiple items to a collection
collectionByType GET /collection/type/{type} Get collections by type
collectionDestroy DELETE /collection/{collection} Remove the specified collection from storage
collectionDetachItem DELETE /collection/{collection}/detach-item Detach an item from a collection
collectionDetachItems DELETE /collection/{collection}/detach-items Detach multiple items from a collection
collectionIndex GET /collection Display a listing of the collections
collectionShow GET /collection/{collection} Display the specified collection
collectionStore POST /collection Store a newly created collection in storage
collectionUpdate PATCH /collection/{collection} Update the specified collection in storage
collectionUpdate2 PUT /collection/{collection} Update the specified collection in storage

collectionAttachItem

CollectionAttachItem200Response collectionAttachItem(attachItemCollectionRequest)

Example

import {
    CollectionApi,
    Configuration,
    AttachItemCollectionRequest
} from './api';

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

let collection: string; //The collection ID (default to undefined)
let attachItemCollectionRequest: AttachItemCollectionRequest; //

const { status, data } = await apiInstance.collectionAttachItem(
    collection,
    attachItemCollectionRequest
);

Parameters

Name Type Description Notes
attachItemCollectionRequest AttachItemCollectionRequest    
collection [string] The collection ID defaults to undefined

Return type

CollectionAttachItem200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `OperationSuccessResource` | - | |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

collectionAttachItems

CollectionAttachItem200Response collectionAttachItems(attachItemsCollectionRequest)

Example

import {
    CollectionApi,
    Configuration,
    AttachItemsCollectionRequest
} from './api';

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

let collection: string; //The collection ID (default to undefined)
let attachItemsCollectionRequest: AttachItemsCollectionRequest; //

const { status, data } = await apiInstance.collectionAttachItems(
    collection,
    attachItemsCollectionRequest
);

Parameters

Name Type Description Notes
attachItemsCollectionRequest AttachItemsCollectionRequest    
collection [string] The collection ID defaults to undefined

Return type

CollectionAttachItem200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `OperationSuccessResource` | - | |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

collectionByType

CollectionByType200Response collectionByType()

Example

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

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

let type: string; // (default to undefined)
let type2: 'collection' | 'exhibition' | 'gallery'; // (default to undefined)

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

Parameters

Name Type Description Notes    
type [string]   defaults to undefined    
type2 [**'collection' 'exhibition' 'gallery']Array<'collection' | 'exhibition' | 'gallery'>**   defaults to undefined

Return type

CollectionByType200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

collectionDestroy

collectionDestroy()

Example

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

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

let collection: string; //The collection ID (default to undefined)

const { status, data } = await apiInstance.collectionDestroy(
    collection
);

Parameters

Name Type Description Notes
collection [string] The collection 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

collectionDetachItem

CollectionAttachItem200Response collectionDetachItem()

Example

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

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

let collection: string; //The collection ID (default to undefined)
let itemId: string; // (default to undefined)

const { status, data } = await apiInstance.collectionDetachItem(
    collection,
    itemId
);

Parameters

Name Type Description Notes
collection [string] The collection ID defaults to undefined
itemId [string]   defaults to undefined

Return type

CollectionAttachItem200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `OperationSuccessResource` | - | |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

collectionDetachItems

CollectionAttachItem200Response collectionDetachItems()

Example

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

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

let collection: string; //The collection ID (default to undefined)
let itemIds: Array<string>; // (default to undefined)

const { status, data } = await apiInstance.collectionDetachItems(
    collection,
    itemIds
);

Parameters

Name Type Description Notes
collection [string] The collection ID defaults to undefined
itemIds Array<string>   defaults to undefined

Return type

CollectionAttachItem200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `OperationSuccessResource` | - | |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

collectionIndex

CollectionIndex200Response collectionIndex()

Example

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

const configuration = new Configuration();
const apiInstance = new CollectionApi(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.collectionIndex(
    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

CollectionIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

collectionShow

CollectionShow200Response collectionShow()

Example

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

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

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

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

Parameters

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

Return type

CollectionShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `CollectionResource` | - | |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

collectionStore

CollectionShow200Response collectionStore(storeCollectionRequest)

Example

import {
    CollectionApi,
    Configuration,
    StoreCollectionRequest
} from './api';

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

let storeCollectionRequest: StoreCollectionRequest; //

const { status, data } = await apiInstance.collectionStore(
    storeCollectionRequest
);

Parameters

Name Type Description Notes
storeCollectionRequest StoreCollectionRequest    

Return type

CollectionShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

collectionUpdate

CollectionShow200Response collectionUpdate()

Example

import {
    CollectionApi,
    Configuration,
    UpdateCollectionRequest
} from './api';

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

let collection: string; //The collection ID (default to undefined)
let updateCollectionRequest: UpdateCollectionRequest; // (optional)

const { status, data } = await apiInstance.collectionUpdate(
    collection,
    updateCollectionRequest
);

Parameters

Name Type Description Notes
updateCollectionRequest UpdateCollectionRequest    
collection [string] The collection ID defaults to undefined

Return type

CollectionShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `CollectionResource` | - | |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

collectionUpdate2

CollectionShow200Response collectionUpdate2()

Example

import {
    CollectionApi,
    Configuration,
    UpdateCollectionRequest
} from './api';

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

let collection: string; //The collection ID (default to undefined)
let updateCollectionRequest: UpdateCollectionRequest; // (optional)

const { status, data } = await apiInstance.collectionUpdate2(
    collection,
    updateCollectionRequest
);

Parameters

Name Type Description Notes
updateCollectionRequest UpdateCollectionRequest    
collection [string] The collection ID defaults to undefined

Return type

CollectionShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `CollectionResource` | - | |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

This documentation was automatically generated from the TypeScript API client.