The General API Endpoints section of the InvenTree API schema is documented below.
InvenTree API 196¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
action¶
POST /api/action/¶
Description
This function checks if all required info was submitted and then performs a plugin_action or returns an error.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"action": "string",
"data": {}
}
Schema of the request body
{
"description": "Serializer for the ActionPluginView responses.",
"properties": {
"action": {
"type": "string"
},
"data": {
"additionalProperties": {},
"type": "object"
}
},
"required": [
"action",
"data"
],
"type": "object"
}
{
"action": "string",
"data": {}
}
Schema of the request body
{
"description": "Serializer for the ActionPluginView responses.",
"properties": {
"action": {
"type": "string"
},
"data": {
"additionalProperties": {},
"type": "object"
}
},
"required": [
"action",
"data"
],
"type": "object"
}
{
"action": "string",
"data": {}
}
Schema of the request body
{
"description": "Serializer for the ActionPluginView responses.",
"properties": {
"action": {
"type": "string"
},
"data": {
"additionalProperties": {},
"type": "object"
}
},
"required": [
"action",
"data"
],
"type": "object"
}
Response 200 OK
{
"action": "string",
"data": {}
}
Schema of the response body
{
"description": "Serializer for the ActionPluginView responses.",
"properties": {
"action": {
"type": "string"
},
"data": {
"additionalProperties": {},
"type": "object"
}
},
"required": [
"action",
"data"
],
"type": "object"
}
admin¶
GET /api/admin/config/¶
Description
List view for all accessed configurations.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
GET /api/admin/config/{key}/¶
Description
Detail view for an individual configuration.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
key |
path | string | No |
Response 200 OK
contenttype¶
GET /api/contenttype/¶
Description
List view for ContentTypes.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"app_label": "string",
"app_labeled_name": "string",
"is_plugin": true,
"model": "string",
"pk": 0
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ContentType"
},
"type": "array"
}
},
"type": "object"
}
GET /api/contenttype/{id}/¶
Description
Detail view for a ContentType model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"app_label": "string",
"app_labeled_name": "string",
"is_plugin": true,
"model": "string",
"pk": 0
}
Schema of the response body
{
"description": "Serializer for ContentType models.",
"properties": {
"app_label": {
"readOnly": true,
"type": "string"
},
"app_labeled_name": {
"readOnly": true,
"type": "string"
},
"is_plugin": {
"description": "Return True if the model is a plugin model.",
"readOnly": true,
"type": "boolean"
},
"model": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"type": "integer"
}
},
"required": [
"app_label",
"app_labeled_name",
"is_plugin",
"model",
"pk"
],
"type": "object"
}
GET /api/contenttype/{model}/¶
Description
Detail view for a ContentType model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
model |
path | string | No |
Response 200 OK
{
"app_label": "string",
"app_labeled_name": "string",
"is_plugin": true,
"model": "string",
"pk": 0
}
Schema of the response body
{
"description": "Serializer for ContentType models.",
"properties": {
"app_label": {
"readOnly": true,
"type": "string"
},
"app_labeled_name": {
"readOnly": true,
"type": "string"
},
"is_plugin": {
"description": "Return True if the model is a plugin model.",
"readOnly": true,
"type": "boolean"
},
"model": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"type": "integer"
}
},
"required": [
"app_label",
"app_labeled_name",
"is_plugin",
"model",
"pk"
],
"type": "object"
}
currency¶
GET /api/currency/exchange/¶
Description
Return information on available currency conversions.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
{
"base_currency": "string",
"exchange_rates": {},
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "Serializer for a Currency Exchange request.\n\nIt's only purpose is describing the results correctly in the API schema right now.",
"properties": {
"base_currency": {
"readOnly": true,
"type": "string"
},
"exchange_rates": {
"additionalProperties": {
"format": "double",
"type": "number"
},
"type": "object"
},
"updated": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"base_currency",
"exchange_rates",
"updated"
],
"type": "object"
}
POST /api/currency/refresh/¶
Description
Performing a POST request will update currency exchange rates.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
email¶
POST /api/email/generate/¶
Description
Get the token for the current user or fail.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"email": "string"
}
Schema of the request body
{
"description": "Serializer for the simple login view.",
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
{
"email": "string"
}
Schema of the request body
{
"description": "Serializer for the simple login view.",
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
{
"email": "string"
}
Schema of the request body
{
"description": "Serializer for the simple login view.",
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
Response 200 OK
{
"email": "string"
}
Schema of the response body
{
"description": "Serializer for the simple login view.",
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
error-report¶
DELETE /api/error-report/¶
Description
Perform a DELETE operation against this list endpoint.
We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/error-report/¶
Description
List view for server error messages.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ErrorMessage"
},
"type": "array"
}
},
"type": "object"
}
DELETE /api/error-report/{id}/¶
Description
Detail view for a single error message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/error-report/{id}/¶
Description
Detail view for a single error message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
PATCH /api/error-report/{id}/¶
Description
Detail view for a single error message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
PUT /api/error-report/{id}/¶
Description
Detail view for a single error message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
Response 200 OK
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
flags¶
GET /api/flags/¶
Description
List view for feature flags.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
GET /api/flags/{key}/¶
Description
Detail view for an individual feature flag.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
key |
path | string | No |
Response 200 OK
generic¶
GET /api/generic/status/¶
Description
Perform a GET request to learn information about status codes.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
GET /api/generic/status/{statusmodel}/¶
Description
Retrieve information about a specific status code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
statusmodel |
path | string | No |
Response 200 OK
Response 400 Bad Request
license¶
GET /api/license/¶
Description
Return information about the InvenTree server.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
{
"backend": "string",
"frontend": "string"
}
Schema of the response body
{
"description": "Serializer for license information.",
"properties": {
"backend": {
"description": "Backend licenses texts",
"readOnly": true,
"type": "string"
},
"frontend": {
"description": "Frontend licenses texts",
"readOnly": true,
"type": "string"
}
},
"required": [
"backend",
"frontend"
],
"type": "object"
}
locate¶
POST /api/locate/¶
Description
Identify or 'locate' a stock item or location with a plugin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"item": 0,
"location": 0,
"plugin": "string"
}
Schema of the request body
{
"description": "Serializer for the LocatePluginView API endpoint.",
"properties": {
"item": {
"description": "StockItem to identify",
"type": "integer"
},
"location": {
"description": "StockLocation to identify",
"type": "integer"
},
"plugin": {
"description": "Plugin to use for location identification",
"type": "string"
}
},
"required": [
"plugin"
],
"type": "object"
}
{
"item": 0,
"location": 0,
"plugin": "string"
}
Schema of the request body
{
"description": "Serializer for the LocatePluginView API endpoint.",
"properties": {
"item": {
"description": "StockItem to identify",
"type": "integer"
},
"location": {
"description": "StockLocation to identify",
"type": "integer"
},
"plugin": {
"description": "Plugin to use for location identification",
"type": "string"
}
},
"required": [
"plugin"
],
"type": "object"
}
{
"item": 0,
"location": 0,
"plugin": "string"
}
Schema of the request body
{
"description": "Serializer for the LocatePluginView API endpoint.",
"properties": {
"item": {
"description": "StockItem to identify",
"type": "integer"
},
"location": {
"description": "StockLocation to identify",
"type": "integer"
},
"plugin": {
"description": "Plugin to use for location identification",
"type": "string"
}
},
"required": [
"plugin"
],
"type": "object"
}
Response 200 OK
{
"item": 0,
"location": 0,
"plugin": "string"
}
Schema of the response body
{
"description": "Serializer for the LocatePluginView API endpoint.",
"properties": {
"item": {
"description": "StockItem to identify",
"type": "integer"
},
"location": {
"description": "StockLocation to identify",
"type": "integer"
},
"plugin": {
"description": "Plugin to use for location identification",
"type": "string"
}
},
"required": [
"plugin"
],
"type": "object"
}
news¶
DELETE /api/news/¶
Description
Perform a DELETE operation against this list endpoint.
We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/news/¶
Description
List view for all news items.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
read |
query | boolean | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"author": "string",
"feed_id": "string",
"link": "string",
"pk": 0,
"published": "2022-04-13T15:42:05.901Z",
"read": true,
"summary": "string",
"title": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/NewsFeedEntry"
},
"type": "array"
}
},
"type": "object"
}
DELETE /api/news/{id}/¶
Description
Detail view for an individual news feed object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/news/{id}/¶
Description
Detail view for an individual news feed object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"author": "string",
"feed_id": "string",
"link": "string",
"pk": 0,
"published": "2022-04-13T15:42:05.901Z",
"read": true,
"summary": "string",
"title": "string"
}
Schema of the response body
{
"description": "Serializer for the NewsFeedEntry model.",
"properties": {
"author": {
"maxLength": 250,
"type": "string"
},
"feed_id": {
"maxLength": 250,
"title": "Id",
"type": "string"
},
"link": {
"format": "uri",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"published": {
"format": "date-time",
"type": "string"
},
"read": {
"type": "boolean"
},
"summary": {
"maxLength": 250,
"type": "string"
},
"title": {
"maxLength": 250,
"type": "string"
}
},
"required": [
"author",
"feed_id",
"link",
"pk",
"published",
"read",
"summary",
"title"
],
"type": "object"
}
PATCH /api/news/{id}/¶
Description
Detail view for an individual news feed object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"author": "string",
"feed_id": "string",
"link": "string",
"pk": 0,
"published": "2022-04-13T15:42:05.901Z",
"read": true,
"summary": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the NewsFeedEntry model.",
"properties": {
"author": {
"maxLength": 250,
"type": "string"
},
"feed_id": {
"maxLength": 250,
"title": "Id",
"type": "string"
},
"link": {
"format": "uri",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"published": {
"format": "date-time",
"type": "string"
},
"read": {
"type": "boolean"
},
"summary": {
"maxLength": 250,
"type": "string"
},
"title": {
"maxLength": 250,
"type": "string"
}
},
"type": "object"
}
{
"author": "string",
"feed_id": "string",
"link": "string",
"pk": 0,
"published": "2022-04-13T15:42:05.901Z",
"read": true,
"summary": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the NewsFeedEntry model.",
"properties": {
"author": {
"maxLength": 250,
"type": "string"
},
"feed_id": {
"maxLength": 250,
"title": "Id",
"type": "string"
},
"link": {
"format": "uri",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"published": {
"format": "date-time",
"type": "string"
},
"read": {
"type": "boolean"
},
"summary": {
"maxLength": 250,
"type": "string"
},
"title": {
"maxLength": 250,
"type": "string"
}
},
"type": "object"
}
{
"author": "string",
"feed_id": "string",
"link": "string",
"pk": 0,
"published": "2022-04-13T15:42:05.901Z",
"read": true,
"summary": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the NewsFeedEntry model.",
"properties": {
"author": {
"maxLength": 250,
"type": "string"
},
"feed_id": {
"maxLength": 250,
"title": "Id",
"type": "string"
},
"link": {
"format": "uri",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"published": {
"format": "date-time",
"type": "string"
},
"read": {
"type": "boolean"
},
"summary": {
"maxLength": 250,
"type": "string"
},
"title": {
"maxLength": 250,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"author": "string",
"feed_id": "string",
"link": "string",
"pk": 0,
"published": "2022-04-13T15:42:05.901Z",
"read": true,
"summary": "string",
"title": "string"
}
Schema of the response body
{
"description": "Serializer for the NewsFeedEntry model.",
"properties": {
"author": {
"maxLength": 250,
"type": "string"
},
"feed_id": {
"maxLength": 250,
"title": "Id",
"type": "string"
},
"link": {
"format": "uri",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"published": {
"format": "date-time",
"type": "string"
},
"read": {
"type": "boolean"
},
"summary": {
"maxLength": 250,
"type": "string"
},
"title": {
"maxLength": 250,
"type": "string"
}
},
"required": [
"author",
"feed_id",
"link",
"pk",
"published",
"read",
"summary",
"title"
],
"type": "object"
}
PUT /api/news/{id}/¶
Description
Detail view for an individual news feed object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"author": "string",
"feed_id": "string",
"link": "string",
"pk": 0,
"published": "2022-04-13T15:42:05.901Z",
"read": true,
"summary": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the NewsFeedEntry model.",
"properties": {
"author": {
"maxLength": 250,
"type": "string"
},
"feed_id": {
"maxLength": 250,
"title": "Id",
"type": "string"
},
"link": {
"format": "uri",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"published": {
"format": "date-time",
"type": "string"
},
"read": {
"type": "boolean"
},
"summary": {
"maxLength": 250,
"type": "string"
},
"title": {
"maxLength": 250,
"type": "string"
}
},
"required": [
"author",
"feed_id",
"link",
"pk",
"published",
"read",
"summary",
"title"
],
"type": "object"
}
{
"author": "string",
"feed_id": "string",
"link": "string",
"pk": 0,
"published": "2022-04-13T15:42:05.901Z",
"read": true,
"summary": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the NewsFeedEntry model.",
"properties": {
"author": {
"maxLength": 250,
"type": "string"
},
"feed_id": {
"maxLength": 250,
"title": "Id",
"type": "string"
},
"link": {
"format": "uri",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"published": {
"format": "date-time",
"type": "string"
},
"read": {
"type": "boolean"
},
"summary": {
"maxLength": 250,
"type": "string"
},
"title": {
"maxLength": 250,
"type": "string"
}
},
"required": [
"author",
"feed_id",
"link",
"pk",
"published",
"read",
"summary",
"title"
],
"type": "object"
}
{
"author": "string",
"feed_id": "string",
"link": "string",
"pk": 0,
"published": "2022-04-13T15:42:05.901Z",
"read": true,
"summary": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the NewsFeedEntry model.",
"properties": {
"author": {
"maxLength": 250,
"type": "string"
},
"feed_id": {
"maxLength": 250,
"title": "Id",
"type": "string"
},
"link": {
"format": "uri",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"published": {
"format": "date-time",
"type": "string"
},
"read": {
"type": "boolean"
},
"summary": {
"maxLength": 250,
"type": "string"
},
"title": {
"maxLength": 250,
"type": "string"
}
},
"required": [
"author",
"feed_id",
"link",
"pk",
"published",
"read",
"summary",
"title"
],
"type": "object"
}
Response 200 OK
{
"author": "string",
"feed_id": "string",
"link": "string",
"pk": 0,
"published": "2022-04-13T15:42:05.901Z",
"read": true,
"summary": "string",
"title": "string"
}
Schema of the response body
{
"description": "Serializer for the NewsFeedEntry model.",
"properties": {
"author": {
"maxLength": 250,
"type": "string"
},
"feed_id": {
"maxLength": 250,
"title": "Id",
"type": "string"
},
"link": {
"format": "uri",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"published": {
"format": "date-time",
"type": "string"
},
"read": {
"type": "boolean"
},
"summary": {
"maxLength": 250,
"type": "string"
},
"title": {
"maxLength": 250,
"type": "string"
}
},
"required": [
"author",
"feed_id",
"link",
"pk",
"published",
"read",
"summary",
"title"
],
"type": "object"
}
notes-image-upload¶
GET /api/notes-image-upload/¶
Description
List view for all notes images.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"date": "2022-04-13T15:42:05.901Z",
"image": "string",
"pk": 0,
"user": 0
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/NotesImage"
},
"type": "array"
}
},
"type": "object"
}
POST /api/notes-image-upload/¶
Description
List view for all notes images.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"date": "2022-04-13T15:42:05.901Z",
"image": "string",
"pk": 0,
"user": 0
}
Schema of the request body
{
"description": "Serializer for the NotesImage model.",
"properties": {
"date": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"date",
"image",
"pk",
"user"
],
"type": "object"
}
{
"date": "2022-04-13T15:42:05.901Z",
"image": "string",
"pk": 0,
"user": 0
}
Schema of the request body
{
"description": "Serializer for the NotesImage model.",
"properties": {
"date": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"date",
"image",
"pk",
"user"
],
"type": "object"
}
{
"date": "2022-04-13T15:42:05.901Z",
"image": "string",
"pk": 0,
"user": 0
}
Schema of the request body
{
"description": "Serializer for the NotesImage model.",
"properties": {
"date": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"date",
"image",
"pk",
"user"
],
"type": "object"
}
Response 201 Created
{
"date": "2022-04-13T15:42:05.901Z",
"image": "string",
"pk": 0,
"user": 0
}
Schema of the response body
{
"description": "Serializer for the NotesImage model.",
"properties": {
"date": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"date",
"image",
"pk",
"user"
],
"type": "object"
}
notifications¶
DELETE /api/notifications/¶
Description
Perform a DELETE operation against this list endpoint.
We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/notifications/¶
Description
List view for all notifications of the current user.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
category |
query | string | No | ||
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
read |
query | boolean | No | ||
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"age": 0,
"age_human": "string",
"category": "string",
"creation": "2022-04-13T15:42:05.901Z",
"message": "string",
"name": "string",
"pk": 0,
"read": true,
"source": {},
"target": {},
"user": 0
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/NotificationMessage"
},
"type": "array"
}
},
"type": "object"
}
GET /api/notifications/readall/¶
Description
Set all messages for the current user as read.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
{
"age": 0,
"age_human": "string",
"category": "string",
"creation": "2022-04-13T15:42:05.901Z",
"message": "string",
"name": "string",
"pk": 0,
"read": true,
"source": {},
"target": {},
"user": 0
}
Schema of the response body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"age": {
"description": "Age of the message in seconds.",
"readOnly": true,
"type": "integer"
},
"age_human": {
"description": "Humanized age.",
"readOnly": true,
"type": "string"
},
"category": {
"readOnly": true,
"type": "string"
},
"creation": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"read": {
"type": "boolean"
},
"source": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to source.",
"readOnly": true,
"type": "object"
},
"target": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to target.",
"readOnly": true,
"type": "object"
},
"user": {
"readOnly": true,
"type": "integer"
}
},
"required": [
"age",
"age_human",
"category",
"creation",
"message",
"name",
"pk",
"read",
"source",
"target",
"user"
],
"type": "object"
}
DELETE /api/notifications/{id}/¶
Description
Detail view for an individual notification object.
- User can only view / delete their own notification objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/notifications/{id}/¶
Description
Detail view for an individual notification object.
- User can only view / delete their own notification objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"age": 0,
"age_human": "string",
"category": "string",
"creation": "2022-04-13T15:42:05.901Z",
"message": "string",
"name": "string",
"pk": 0,
"read": true,
"source": {},
"target": {},
"user": 0
}
Schema of the response body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"age": {
"description": "Age of the message in seconds.",
"readOnly": true,
"type": "integer"
},
"age_human": {
"description": "Humanized age.",
"readOnly": true,
"type": "string"
},
"category": {
"readOnly": true,
"type": "string"
},
"creation": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"read": {
"type": "boolean"
},
"source": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to source.",
"readOnly": true,
"type": "object"
},
"target": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to target.",
"readOnly": true,
"type": "object"
},
"user": {
"readOnly": true,
"type": "integer"
}
},
"required": [
"age",
"age_human",
"category",
"creation",
"message",
"name",
"pk",
"read",
"source",
"target",
"user"
],
"type": "object"
}
PATCH /api/notifications/{id}/¶
Description
Detail view for an individual notification object.
- User can only view / delete their own notification objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"age": 0,
"age_human": "string",
"category": "string",
"creation": "2022-04-13T15:42:05.901Z",
"message": "string",
"name": "string",
"pk": 0,
"read": true,
"source": {},
"target": {},
"user": 0
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"age": {
"description": "Age of the message in seconds.",
"readOnly": true,
"type": "integer"
},
"age_human": {
"description": "Humanized age.",
"readOnly": true,
"type": "string"
},
"category": {
"readOnly": true,
"type": "string"
},
"creation": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"read": {
"type": "boolean"
},
"source": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to source.",
"readOnly": true,
"type": "object"
},
"target": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to target.",
"readOnly": true,
"type": "object"
},
"user": {
"readOnly": true,
"type": "integer"
}
},
"type": "object"
}
{
"age": 0,
"age_human": "string",
"category": "string",
"creation": "2022-04-13T15:42:05.901Z",
"message": "string",
"name": "string",
"pk": 0,
"read": true,
"source": {},
"target": {},
"user": 0
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"age": {
"description": "Age of the message in seconds.",
"readOnly": true,
"type": "integer"
},
"age_human": {
"description": "Humanized age.",
"readOnly": true,
"type": "string"
},
"category": {
"readOnly": true,
"type": "string"
},
"creation": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"read": {
"type": "boolean"
},
"source": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to source.",
"readOnly": true,
"type": "object"
},
"target": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to target.",
"readOnly": true,
"type": "object"
},
"user": {
"readOnly": true,
"type": "integer"
}
},
"type": "object"
}
{
"age": 0,
"age_human": "string",
"category": "string",
"creation": "2022-04-13T15:42:05.901Z",
"message": "string",
"name": "string",
"pk": 0,
"read": true,
"source": {},
"target": {},
"user": 0
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"age": {
"description": "Age of the message in seconds.",
"readOnly": true,
"type": "integer"
},
"age_human": {
"description": "Humanized age.",
"readOnly": true,
"type": "string"
},
"category": {
"readOnly": true,
"type": "string"
},
"creation": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"read": {
"type": "boolean"
},
"source": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to source.",
"readOnly": true,
"type": "object"
},
"target": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to target.",
"readOnly": true,
"type": "object"
},
"user": {
"readOnly": true,
"type": "integer"
}
},
"type": "object"
}
Response 200 OK
{
"age": 0,
"age_human": "string",
"category": "string",
"creation": "2022-04-13T15:42:05.901Z",
"message": "string",
"name": "string",
"pk": 0,
"read": true,
"source": {},
"target": {},
"user": 0
}
Schema of the response body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"age": {
"description": "Age of the message in seconds.",
"readOnly": true,
"type": "integer"
},
"age_human": {
"description": "Humanized age.",
"readOnly": true,
"type": "string"
},
"category": {
"readOnly": true,
"type": "string"
},
"creation": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"read": {
"type": "boolean"
},
"source": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to source.",
"readOnly": true,
"type": "object"
},
"target": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to target.",
"readOnly": true,
"type": "object"
},
"user": {
"readOnly": true,
"type": "integer"
}
},
"required": [
"age",
"age_human",
"category",
"creation",
"message",
"name",
"pk",
"read",
"source",
"target",
"user"
],
"type": "object"
}
PUT /api/notifications/{id}/¶
Description
Detail view for an individual notification object.
- User can only view / delete their own notification objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"age": 0,
"age_human": "string",
"category": "string",
"creation": "2022-04-13T15:42:05.901Z",
"message": "string",
"name": "string",
"pk": 0,
"read": true,
"source": {},
"target": {},
"user": 0
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"age": {
"description": "Age of the message in seconds.",
"readOnly": true,
"type": "integer"
},
"age_human": {
"description": "Humanized age.",
"readOnly": true,
"type": "string"
},
"category": {
"readOnly": true,
"type": "string"
},
"creation": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"read": {
"type": "boolean"
},
"source": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to source.",
"readOnly": true,
"type": "object"
},
"target": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to target.",
"readOnly": true,
"type": "object"
},
"user": {
"readOnly": true,
"type": "integer"
}
},
"required": [
"age",
"age_human",
"category",
"creation",
"message",
"name",
"pk",
"read",
"source",
"target",
"user"
],
"type": "object"
}
{
"age": 0,
"age_human": "string",
"category": "string",
"creation": "2022-04-13T15:42:05.901Z",
"message": "string",
"name": "string",
"pk": 0,
"read": true,
"source": {},
"target": {},
"user": 0
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"age": {
"description": "Age of the message in seconds.",
"readOnly": true,
"type": "integer"
},
"age_human": {
"description": "Humanized age.",
"readOnly": true,
"type": "string"
},
"category": {
"readOnly": true,
"type": "string"
},
"creation": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"read": {
"type": "boolean"
},
"source": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to source.",
"readOnly": true,
"type": "object"
},
"target": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to target.",
"readOnly": true,
"type": "object"
},
"user": {
"readOnly": true,
"type": "integer"
}
},
"required": [
"age",
"age_human",
"category",
"creation",
"message",
"name",
"pk",
"read",
"source",
"target",
"user"
],
"type": "object"
}
{
"age": 0,
"age_human": "string",
"category": "string",
"creation": "2022-04-13T15:42:05.901Z",
"message": "string",
"name": "string",
"pk": 0,
"read": true,
"source": {},
"target": {},
"user": 0
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"age": {
"description": "Age of the message in seconds.",
"readOnly": true,
"type": "integer"
},
"age_human": {
"description": "Humanized age.",
"readOnly": true,
"type": "string"
},
"category": {
"readOnly": true,
"type": "string"
},
"creation": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"read": {
"type": "boolean"
},
"source": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to source.",
"readOnly": true,
"type": "object"
},
"target": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to target.",
"readOnly": true,
"type": "object"
},
"user": {
"readOnly": true,
"type": "integer"
}
},
"required": [
"age",
"age_human",
"category",
"creation",
"message",
"name",
"pk",
"read",
"source",
"target",
"user"
],
"type": "object"
}
Response 200 OK
{
"age": 0,
"age_human": "string",
"category": "string",
"creation": "2022-04-13T15:42:05.901Z",
"message": "string",
"name": "string",
"pk": 0,
"read": true,
"source": {},
"target": {},
"user": 0
}
Schema of the response body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"age": {
"description": "Age of the message in seconds.",
"readOnly": true,
"type": "integer"
},
"age_human": {
"description": "Humanized age.",
"readOnly": true,
"type": "string"
},
"category": {
"readOnly": true,
"type": "string"
},
"creation": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"read": {
"type": "boolean"
},
"source": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to source.",
"readOnly": true,
"type": "object"
},
"target": {
"additionalProperties": {},
"description": "Function to resolve generic object reference to target.",
"readOnly": true,
"type": "object"
},
"user": {
"readOnly": true,
"type": "integer"
}
},
"required": [
"age",
"age_human",
"category",
"creation",
"message",
"name",
"pk",
"read",
"source",
"target",
"user"
],
"type": "object"
}
project-code¶
GET /api/project-code/¶
Description
List view for all project codes.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ProjectCode"
},
"type": "array"
}
},
"type": "object"
}
POST /api/project-code/¶
Description
List view for all project codes.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the request body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"required": [
"code",
"pk",
"responsible_detail"
],
"type": "object"
}
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the request body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"required": [
"code",
"pk",
"responsible_detail"
],
"type": "object"
}
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the request body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"required": [
"code",
"pk",
"responsible_detail"
],
"type": "object"
}
Response 201 Created
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the response body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"required": [
"code",
"pk",
"responsible_detail"
],
"type": "object"
}
DELETE /api/project-code/{id}/¶
Description
Detail view for a particular project code.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/project-code/{id}/¶
Description
Detail view for a particular project code.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the response body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"required": [
"code",
"pk",
"responsible_detail"
],
"type": "object"
}
PATCH /api/project-code/{id}/¶
Description
Detail view for a particular project code.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the request body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the request body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the request body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the response body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"required": [
"code",
"pk",
"responsible_detail"
],
"type": "object"
}
PUT /api/project-code/{id}/¶
Description
Detail view for a particular project code.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the request body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"required": [
"code",
"pk",
"responsible_detail"
],
"type": "object"
}
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the request body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"required": [
"code",
"pk",
"responsible_detail"
],
"type": "object"
}
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the request body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"required": [
"code",
"pk",
"responsible_detail"
],
"type": "object"
}
Response 200 OK
{
"code": "string",
"description": "string",
"pk": 0,
"responsible": 0,
"responsible_detail": null
}
Schema of the response body
{
"description": "Serializer for the ProjectCode model.",
"properties": {
"code": {
"description": "Unique project code",
"maxLength": 50,
"title": "Project Code",
"type": "string"
},
"description": {
"description": "Project description",
"maxLength": 200,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"responsible": {
"description": "User or group responsible for this project",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
}
},
"required": [
"code",
"pk",
"responsible_detail"
],
"type": "object"
}
GET /api/project-code/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/project-code/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/project-code/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
search¶
POST /api/search/¶
Description
Perform search query against available models.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"limit": 0,
"offset": 0,
"search": "string",
"search_regex": true,
"search_whole": true
}
Schema of the request body
{
"description": "Serializer for the APISearchView.",
"properties": {
"limit": {
"default": 1,
"type": "integer"
},
"offset": {
"default": 0,
"type": "integer"
},
"search": {
"type": "string"
},
"search_regex": {
"default": false,
"type": "boolean"
},
"search_whole": {
"default": false,
"type": "boolean"
}
},
"required": [
"search"
],
"type": "object"
}
{
"limit": 0,
"offset": 0,
"search": "string",
"search_regex": true,
"search_whole": true
}
Schema of the request body
{
"description": "Serializer for the APISearchView.",
"properties": {
"limit": {
"default": 1,
"type": "integer"
},
"offset": {
"default": 0,
"type": "integer"
},
"search": {
"type": "string"
},
"search_regex": {
"default": false,
"type": "boolean"
},
"search_whole": {
"default": false,
"type": "boolean"
}
},
"required": [
"search"
],
"type": "object"
}
{
"limit": 0,
"offset": 0,
"search": "string",
"search_regex": true,
"search_whole": true
}
Schema of the request body
{
"description": "Serializer for the APISearchView.",
"properties": {
"limit": {
"default": 1,
"type": "integer"
},
"offset": {
"default": 0,
"type": "integer"
},
"search": {
"type": "string"
},
"search_regex": {
"default": false,
"type": "boolean"
},
"search_whole": {
"default": false,
"type": "boolean"
}
},
"required": [
"search"
],
"type": "object"
}
Response 200 OK
{
"limit": 0,
"offset": 0,
"search": "string",
"search_regex": true,
"search_whole": true
}
Schema of the response body
{
"description": "Serializer for the APISearchView.",
"properties": {
"limit": {
"default": 1,
"type": "integer"
},
"offset": {
"default": 0,
"type": "integer"
},
"search": {
"type": "string"
},
"search_regex": {
"default": false,
"type": "boolean"
},
"search_whole": {
"default": false,
"type": "boolean"
}
},
"required": [
"search"
],
"type": "object"
}
units¶
GET /api/units/¶
Description
List view for custom units.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/CustomUnit"
},
"type": "array"
}
},
"type": "object"
}
POST /api/units/¶
Description
List view for custom units.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the request body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"required": [
"definition",
"name",
"pk"
],
"type": "object"
}
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the request body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"required": [
"definition",
"name",
"pk"
],
"type": "object"
}
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the request body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"required": [
"definition",
"name",
"pk"
],
"type": "object"
}
Response 201 Created
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the response body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"required": [
"definition",
"name",
"pk"
],
"type": "object"
}
DELETE /api/units/{id}/¶
Description
Detail view for a particular custom unit.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/units/{id}/¶
Description
Detail view for a particular custom unit.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the response body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"required": [
"definition",
"name",
"pk"
],
"type": "object"
}
PATCH /api/units/{id}/¶
Description
Detail view for a particular custom unit.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the request body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"type": "object"
}
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the request body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"type": "object"
}
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the request body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the response body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"required": [
"definition",
"name",
"pk"
],
"type": "object"
}
PUT /api/units/{id}/¶
Description
Detail view for a particular custom unit.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the request body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"required": [
"definition",
"name",
"pk"
],
"type": "object"
}
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the request body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"required": [
"definition",
"name",
"pk"
],
"type": "object"
}
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the request body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"required": [
"definition",
"name",
"pk"
],
"type": "object"
}
Response 200 OK
{
"definition": "string",
"name": "string",
"pk": 0,
"symbol": "string"
}
Schema of the response body
{
"description": "DRF serializer for CustomUnit model.",
"properties": {
"definition": {
"description": "Unit definition",
"maxLength": 50,
"type": "string"
},
"name": {
"description": "Unit name",
"maxLength": 50,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"symbol": {
"description": "Optional unit symbol",
"maxLength": 10,
"type": "string"
}
},
"required": [
"definition",
"name",
"pk"
],
"type": "object"
}
version-text¶
GET /api/version-text¶
Description
Simple JSON endpoint for InvenTree version text.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"date": "string",
"gh": "string",
"latest": true,
"text": "string",
"version": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/VersionInformation"
},
"type": "array"
}
},
"type": "object"
}
version¶
GET /api/version/¶
Description
Return information about the InvenTree server.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
{
"dev": true,
"links": {
"app": "string",
"bug": "string",
"code": "string",
"credit": "string",
"doc": "string"
},
"up_to_date": true,
"version": {
"api": 0,
"commit_branch": "string",
"commit_date": "string",
"commit_hash": "string",
"django": "string",
"python": "string",
"server": "string"
}
}
Schema of the response body
{
"description": "Serializer for a single version.",
"properties": {
"dev": {
"type": "boolean"
},
"links": {
"$ref": "#/components/schemas/Link"
},
"up_to_date": {
"type": "boolean"
},
"version": {
"$ref": "#/components/schemas/Version"
}
},
"required": [
"dev",
"links",
"up_to_date",
"version"
],
"type": "object"
}
web¶
GET /api/web/ui_preference/¶
Description
Set preferred UI (CIU/PUI).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
{
"cui": true,
"preferred_method": "cui",
"pui": true
}
Schema of the response body
{
"description": "Serializer for the preferred serializer session setting.",
"properties": {
"cui": {
"description": "Return true if preferred method is CUI.",
"readOnly": true,
"type": "boolean"
},
"preferred_method": {
"$ref": "#/components/schemas/PreferredMethodEnum"
},
"pui": {
"description": "Return true if preferred method is PUI.",
"readOnly": true,
"type": "boolean"
}
},
"required": [
"cui",
"preferred_method",
"pui"
],
"type": "object"
}
PUT /api/web/ui_preference/¶
Description
Set preferred UI (CIU/PUI).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"cui": true,
"preferred_method": "cui",
"pui": true
}
Schema of the request body
{
"description": "Serializer for the preferred serializer session setting.",
"properties": {
"cui": {
"description": "Return true if preferred method is CUI.",
"readOnly": true,
"type": "boolean"
},
"preferred_method": {
"$ref": "#/components/schemas/PreferredMethodEnum"
},
"pui": {
"description": "Return true if preferred method is PUI.",
"readOnly": true,
"type": "boolean"
}
},
"required": [
"cui",
"preferred_method",
"pui"
],
"type": "object"
}
{
"cui": true,
"preferred_method": "cui",
"pui": true
}
Schema of the request body
{
"description": "Serializer for the preferred serializer session setting.",
"properties": {
"cui": {
"description": "Return true if preferred method is CUI.",
"readOnly": true,
"type": "boolean"
},
"preferred_method": {
"$ref": "#/components/schemas/PreferredMethodEnum"
},
"pui": {
"description": "Return true if preferred method is PUI.",
"readOnly": true,
"type": "boolean"
}
},
"required": [
"cui",
"preferred_method",
"pui"
],
"type": "object"
}
{
"cui": true,
"preferred_method": "cui",
"pui": true
}
Schema of the request body
{
"description": "Serializer for the preferred serializer session setting.",
"properties": {
"cui": {
"description": "Return true if preferred method is CUI.",
"readOnly": true,
"type": "boolean"
},
"preferred_method": {
"$ref": "#/components/schemas/PreferredMethodEnum"
},
"pui": {
"description": "Return true if preferred method is PUI.",
"readOnly": true,
"type": "boolean"
}
},
"required": [
"cui",
"preferred_method",
"pui"
],
"type": "object"
}
Response 200 OK
{
"cui": true,
"preferred_method": "cui",
"pui": true
}
Schema of the response body
{
"description": "Serializer for the preferred serializer session setting.",
"properties": {
"cui": {
"description": "Return true if preferred method is CUI.",
"readOnly": true,
"type": "boolean"
},
"preferred_method": {
"$ref": "#/components/schemas/PreferredMethodEnum"
},
"pui": {
"description": "Return true if preferred method is PUI.",
"readOnly": true,
"type": "boolean"
}
},
"required": [
"cui",
"preferred_method",
"pui"
],
"type": "object"
}
webhook¶
POST /api/webhook/{endpoint}/¶
Description
Process incoming webhook.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
endpoint |
path | string | No |
Response 200 OK
Schemas¶
ActionPlugin¶
| Name | Type |
|---|---|
action |
string |
data |
APISearchView¶
| Name | Type |
|---|---|
limit |
integer |
offset |
integer |
search |
string |
search_regex |
boolean |
search_whole |
boolean |
ContentType¶
| Name | Type |
|---|---|
app_label |
string |
app_labeled_name |
string |
is_plugin |
boolean |
model |
string |
pk |
integer |
CurrencyExchange¶
| Name | Type |
|---|---|
base_currency |
string |
exchange_rates |
|
updated |
string(date-time) |
CustomUnit¶
| Name | Type |
|---|---|
definition |
string |
name |
string |
pk |
integer |
symbol |
string |
ErrorMessage¶
| Name | Type |
|---|---|
data |
string| null |
info |
string |
path |
string(uri)| null |
pk |
integer |
when |
string(date-time) |
GetSimpleLogin¶
| Name | Type |
|---|---|
email |
string |
LicenseView¶
| Name | Type |
|---|---|
backend |
string |
frontend |
string |
Link¶
| Name | Type |
|---|---|
app |
string(uri) |
bug |
string(uri) |
code |
string(uri) |
credit |
string(uri) |
doc |
string(uri) |
LocatePlugin¶
| Name | Type |
|---|---|
item |
integer |
location |
integer |
plugin |
string |
Metadata¶
| Name | Type |
|---|---|
metadata |
NewsFeedEntry¶
| Name | Type |
|---|---|
author |
string |
feed_id |
string |
link |
string(uri) |
pk |
integer |
published |
string(date-time) |
read |
boolean |
summary |
string |
title |
string |
NotesImage¶
| Name | Type |
|---|---|
date |
string(date-time) |
image |
string(uri) |
pk |
integer |
user |
integer| null |
NotificationMessage¶
| Name | Type |
|---|---|
age |
integer |
age_human |
string |
category |
string |
creation |
string(date-time) |
message |
string| null |
name |
string |
pk |
integer |
read |
boolean |
source |
|
target |
|
user |
integer |
Owner¶
| Name | Type |
|---|---|
label |
string |
name |
string |
owner_id |
integer| null |
pk |
integer |
PaginatedContentTypeList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ContentType> |
PaginatedCustomUnitList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<CustomUnit> |
PaginatedErrorMessageList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ErrorMessage> |
PaginatedNewsFeedEntryList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<NewsFeedEntry> |
PaginatedNotesImageList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<NotesImage> |
PaginatedNotificationMessageList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<NotificationMessage> |
PaginatedProjectCodeList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ProjectCode> |
PaginatedVersionInformationList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<VersionInformation> |
PatchedCustomUnit¶
| Name | Type |
|---|---|
definition |
string |
name |
string |
pk |
integer |
symbol |
string |
PatchedErrorMessage¶
| Name | Type |
|---|---|
data |
string| null |
info |
string |
path |
string(uri)| null |
pk |
integer |
when |
string(date-time) |
PatchedMetadata¶
| Name | Type |
|---|---|
metadata |
PatchedNewsFeedEntry¶
| Name | Type |
|---|---|
author |
string |
feed_id |
string |
link |
string(uri) |
pk |
integer |
published |
string(date-time) |
read |
boolean |
summary |
string |
title |
string |
PatchedNotificationMessage¶
| Name | Type |
|---|---|
age |
integer |
age_human |
string |
category |
string |
creation |
string(date-time) |
message |
string| null |
name |
string |
pk |
integer |
read |
boolean |
source |
|
target |
|
user |
integer |
PatchedProjectCode¶
| Name | Type |
|---|---|
code |
string |
description |
string |
pk |
integer |
responsible |
integer| null |
responsible_detail |
Preferred¶
| Name | Type |
|---|---|
cui |
boolean |
preferred_method |
PreferredMethodEnum |
pui |
boolean |
PreferredMethodEnum¶
Type: string
ProjectCode¶
| Name | Type |
|---|---|
code |
string |
description |
string |
pk |
integer |
responsible |
integer| null |
responsible_detail |
Version¶
| Name | Type |
|---|---|
api |
integer |
commit_branch |
string |
commit_date |
string |
commit_hash |
string |
django |
string |
python |
string |
server |
string |
VersionInformation¶
| Name | Type |
|---|---|
date |
string |
gh |
string |
latest |
boolean |
text |
string |
version |
string |
VersionView¶
| Name | Type |
|---|---|
dev |
boolean |
links |
Link |
up_to_date |
boolean |
version |
Version |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| tokenAuth | apiKey | Token-based authentication with required prefix "Token" |
More documentation¶
More information about InvenTree in the official docs
For more information: https://docs.inventree.org