The General API Endpoints section of the InvenTree API schema is documented below.
InvenTree API 294¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
Endpoints¶
GET /api/¶
Description
Serve current server information.
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
{
"active_plugins": null,
"apiVersion": 0,
"database": "string",
"debug_mode": true,
"default_locale": null,
"django_admin": "string",
"docker_mode": true,
"email_configured": true,
"installer": "string",
"instance": "string",
"platform": "string",
"plugins_enabled": true,
"plugins_install_disabled": true,
"server": "string",
"system_health": true,
"target": "string",
"version": "string",
"worker_count": 0,
"worker_pending_tasks": 0,
"worker_running": true
}
Schema of the response body
{
"description": "InvenTree server information - some information might be blanked if called without elevated credentials.",
"properties": {
"active_plugins": {
"readOnly": true
},
"apiVersion": {
"readOnly": true,
"type": "integer"
},
"database": {
"readOnly": true,
"type": "string"
},
"debug_mode": {
"readOnly": true,
"type": "boolean"
},
"default_locale": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocaleEnum"
}
],
"readOnly": true
},
"django_admin": {
"readOnly": true,
"type": "string"
},
"docker_mode": {
"readOnly": true,
"type": "boolean"
},
"email_configured": {
"readOnly": true,
"type": "boolean"
},
"installer": {
"readOnly": true,
"type": "string"
},
"instance": {
"readOnly": true,
"type": "string"
},
"platform": {
"readOnly": true,
"type": "string"
},
"plugins_enabled": {
"readOnly": true,
"type": "boolean"
},
"plugins_install_disabled": {
"readOnly": true,
"type": "boolean"
},
"server": {
"readOnly": true,
"type": "string"
},
"system_health": {
"readOnly": true,
"type": "boolean"
},
"target": {
"readOnly": true,
"type": "string"
},
"version": {
"readOnly": true,
"type": "string"
},
"worker_count": {
"readOnly": true,
"type": "integer"
},
"worker_pending_tasks": {
"readOnly": true,
"type": "integer"
},
"worker_running": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"active_plugins",
"apiVersion",
"database",
"debug_mode",
"default_locale",
"django_admin",
"docker_mode",
"email_configured",
"installer",
"instance",
"platform",
"plugins_enabled",
"plugins_install_disabled",
"server",
"system_health",
"target",
"version",
"worker_count",
"worker_pending_tasks",
"worker_running"
],
"type": "object"
}
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
attachment¶
DELETE /api/attachment/¶
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/attachment/¶
Description
List API endpoint for Attachment 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" |
is_file |
query | boolean | No | Is File | |
is_link |
query | boolean | No | Is Link | |
limit |
query | integer | No | Number of results to return per page. | |
model_id |
query | integer | No | ||
model_type |
query | string | No | ||
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. | |
upload_user |
query | integer | 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": [
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_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/Attachment"
},
"type": "array"
}
},
"type": "object"
}
POST /api/attachment/¶
Description
List API endpoint for Attachment 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" |
Request body
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
Response 201 Created
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
DELETE /api/attachment/{id}/¶
Description
Detail API endpoint for Attachment 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/attachment/{id}/¶
Description
Detail API endpoint for Attachment 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
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
PATCH /api/attachment/{id}/¶
Description
Detail API endpoint for Attachment 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
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
PUT /api/attachment/{id}/¶
Description
Detail API endpoint for Attachment 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
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
Response 200 OK
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
GET /api/attachment/{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/attachment/{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/attachment/{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"
}
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. | |
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": [
{
"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/model/{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"
}
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"
}
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
generate¶
POST /api/generate/batch-code/¶
Description
Generate a new batch 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" |
Request body
{
"batch_code": "string",
"build_order": 0,
"item": 0,
"location": 0,
"part": 0,
"purchase_order": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for generating a batch code.\n\nAny of the provided write-only fields can be used for additional context.",
"properties": {
"batch_code": {
"description": "Generated batch code",
"readOnly": true,
"type": "string"
},
"build_order": {
"description": "Select build order",
"nullable": true,
"type": "integer"
},
"item": {
"description": "Select stock item to generate batch code for",
"nullable": true,
"title": "Stock Item",
"type": "integer"
},
"location": {
"description": "Select location to generate batch code for",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Select part to generate batch code for",
"nullable": true,
"type": "integer"
},
"purchase_order": {
"description": "Select purchase order",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for batch code",
"format": "double",
"nullable": true,
"type": "number"
}
},
"required": [
"batch_code"
],
"type": "object"
}
{
"batch_code": "string",
"build_order": 0,
"item": 0,
"location": 0,
"part": 0,
"purchase_order": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for generating a batch code.\n\nAny of the provided write-only fields can be used for additional context.",
"properties": {
"batch_code": {
"description": "Generated batch code",
"readOnly": true,
"type": "string"
},
"build_order": {
"description": "Select build order",
"nullable": true,
"type": "integer"
},
"item": {
"description": "Select stock item to generate batch code for",
"nullable": true,
"title": "Stock Item",
"type": "integer"
},
"location": {
"description": "Select location to generate batch code for",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Select part to generate batch code for",
"nullable": true,
"type": "integer"
},
"purchase_order": {
"description": "Select purchase order",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for batch code",
"format": "double",
"nullable": true,
"type": "number"
}
},
"required": [
"batch_code"
],
"type": "object"
}
{
"batch_code": "string",
"build_order": 0,
"item": 0,
"location": 0,
"part": 0,
"purchase_order": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for generating a batch code.\n\nAny of the provided write-only fields can be used for additional context.",
"properties": {
"batch_code": {
"description": "Generated batch code",
"readOnly": true,
"type": "string"
},
"build_order": {
"description": "Select build order",
"nullable": true,
"type": "integer"
},
"item": {
"description": "Select stock item to generate batch code for",
"nullable": true,
"title": "Stock Item",
"type": "integer"
},
"location": {
"description": "Select location to generate batch code for",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Select part to generate batch code for",
"nullable": true,
"type": "integer"
},
"purchase_order": {
"description": "Select purchase order",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for batch code",
"format": "double",
"nullable": true,
"type": "number"
}
},
"required": [
"batch_code"
],
"type": "object"
}
Response 200 OK
{
"batch_code": "string",
"build_order": 0,
"item": 0,
"location": 0,
"part": 0,
"purchase_order": 0,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for generating a batch code.\n\nAny of the provided write-only fields can be used for additional context.",
"properties": {
"batch_code": {
"description": "Generated batch code",
"readOnly": true,
"type": "string"
},
"build_order": {
"description": "Select build order",
"nullable": true,
"type": "integer"
},
"item": {
"description": "Select stock item to generate batch code for",
"nullable": true,
"title": "Stock Item",
"type": "integer"
},
"location": {
"description": "Select location to generate batch code for",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Select part to generate batch code for",
"nullable": true,
"type": "integer"
},
"purchase_order": {
"description": "Select purchase order",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for batch code",
"format": "double",
"nullable": true,
"type": "number"
}
},
"required": [
"batch_code"
],
"type": "object"
}
POST /api/generate/serial-number/¶
Description
Generate a new serial number.
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
{
"part": 0,
"quantity": 0,
"serial": "string"
}
Schema of the request body
{
"description": "Serializer for generating one or multiple serial numbers.\n\nAny of the provided write-only fields can be used for additional context.\n\nNote that in the case where multiple serial numbers are required,\nthe \"serial\" field will return a string with multiple serial numbers separated by a comma.",
"properties": {
"part": {
"description": "Select part to generate serial number for",
"nullable": true,
"type": "integer"
},
"quantity": {
"default": 1,
"description": "Quantity of serial numbers to generate",
"type": "integer"
},
"serial": {
"description": "Generated serial number",
"readOnly": true,
"title": "Serial Number",
"type": "string"
}
},
"required": [
"serial"
],
"type": "object"
}
{
"part": 0,
"quantity": 0,
"serial": "string"
}
Schema of the request body
{
"description": "Serializer for generating one or multiple serial numbers.\n\nAny of the provided write-only fields can be used for additional context.\n\nNote that in the case where multiple serial numbers are required,\nthe \"serial\" field will return a string with multiple serial numbers separated by a comma.",
"properties": {
"part": {
"description": "Select part to generate serial number for",
"nullable": true,
"type": "integer"
},
"quantity": {
"default": 1,
"description": "Quantity of serial numbers to generate",
"type": "integer"
},
"serial": {
"description": "Generated serial number",
"readOnly": true,
"title": "Serial Number",
"type": "string"
}
},
"required": [
"serial"
],
"type": "object"
}
{
"part": 0,
"quantity": 0,
"serial": "string"
}
Schema of the request body
{
"description": "Serializer for generating one or multiple serial numbers.\n\nAny of the provided write-only fields can be used for additional context.\n\nNote that in the case where multiple serial numbers are required,\nthe \"serial\" field will return a string with multiple serial numbers separated by a comma.",
"properties": {
"part": {
"description": "Select part to generate serial number for",
"nullable": true,
"type": "integer"
},
"quantity": {
"default": 1,
"description": "Quantity of serial numbers to generate",
"type": "integer"
},
"serial": {
"description": "Generated serial number",
"readOnly": true,
"title": "Serial Number",
"type": "string"
}
},
"required": [
"serial"
],
"type": "object"
}
Response 200 OK
{
"part": 0,
"quantity": 0,
"serial": "string"
}
Schema of the response body
{
"description": "Serializer for generating one or multiple serial numbers.\n\nAny of the provided write-only fields can be used for additional context.\n\nNote that in the case where multiple serial numbers are required,\nthe \"serial\" field will return a string with multiple serial numbers separated by a comma.",
"properties": {
"part": {
"description": "Select part to generate serial number for",
"nullable": true,
"type": "integer"
},
"quantity": {
"default": 1,
"description": "Quantity of serial numbers to generate",
"type": "integer"
},
"serial": {
"description": "Generated serial number",
"readOnly": true,
"title": "Serial Number",
"type": "string"
}
},
"required": [
"serial"
],
"type": "object"
}
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/custom/¶
Description
Override the 'get' method to check for the export query parameter.
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": [
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
]
}
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/CustomState"
},
"type": "array"
}
},
"type": "object"
}
POST /api/generic/status/custom/¶
Description
List view for all custom states.
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
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
Response 201 Created
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the response body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
DELETE /api/generic/status/custom/{id}/¶
Description
Detail view for a particular custom states.
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/generic/status/custom/{id}/¶
Description
Detail view for a particular custom states.
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
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the response body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
PATCH /api/generic/status/custom/{id}/¶
Description
Detail view for a particular custom states.
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
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"type": "object"
}
Response 200 OK
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the response body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
PUT /api/generic/status/custom/{id}/¶
Description
Detail view for a particular custom states.
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
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
Response 200 OK
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the response body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
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
icons¶
GET /api/icons/¶
Description
List view for available icon packages.
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": [
{
"fonts": {},
"icons": {},
"name": "string",
"prefix": "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/IconPackage"
},
"type": "array"
}
},
"type": "object"
}
importer¶
GET /api/importer/column-mapping/¶
Description
API endpoint for accessing a list of DataImportColumnMap 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" |
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. | |
session |
query | integer | 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": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 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/DataImportColumnMap"
},
"type": "array"
}
},
"type": "object"
}
GET /api/importer/column-mapping/{id}/¶
Description
Detail endpoint for a single DataImportColumnMap 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
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the response body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
PATCH /api/importer/column-mapping/{id}/¶
Description
Detail endpoint for a single DataImportColumnMap 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
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"type": "object"
}
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"type": "object"
}
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"type": "object"
}
Response 200 OK
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the response body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
PUT /api/importer/column-mapping/{id}/¶
Description
Detail endpoint for a single DataImportColumnMap 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
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
Response 200 OK
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the response body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
GET /api/importer/models/¶
Description
Return a list of models available for import.
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
DELETE /api/importer/row/¶
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/importer/row/¶
Description
API endpoint for accessing a list of DataImportRow 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" |
complete |
query | boolean | 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. | |
search |
query | string | No | A search term. | |
session |
query | integer | No | ||
valid |
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": [
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
]
}
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/DataImportRow"
},
"type": "array"
}
},
"type": "object"
}
DELETE /api/importer/row/{id}/¶
Description
Detail endpoint for a single DataImportRow 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/importer/row/{id}/¶
Description
Detail endpoint for a single DataImportRow 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
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the response body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
PATCH /api/importer/row/{id}/¶
Description
Detail endpoint for a single DataImportRow 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
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
Response 200 OK
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the response body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
PUT /api/importer/row/{id}/¶
Description
Detail endpoint for a single DataImportRow 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
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
Response 200 OK
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the response body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
DELETE /api/importer/session/¶
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/importer/session/¶
Description
API endpoint for accessing a list of DataImportSession 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" |
limit |
query | integer | No | Number of results to return per page. | |
model_type |
query | string | No | ||
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. | |
status |
query | integer | No | Import status * `0` - Initializing * `10` - Mapping Columns * `20` - Importing Data * `30` - Processing Data * `40` - Complete | |
user |
query | integer | 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": [
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_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/DataImportSession"
},
"type": "array"
}
},
"type": "object"
}
POST /api/importer/session/¶
Description
API endpoint for accessing a list of DataImportSession 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" |
Request body
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
Response 201 Created
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
DELETE /api/importer/session/{id}/¶
Description
Detail endpoint for a single DataImportSession 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/importer/session/{id}/¶
Description
Detail endpoint for a single DataImportSession 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
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
PATCH /api/importer/session/{id}/¶
Description
Detail endpoint for a single DataImportSession 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
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
PUT /api/importer/session/{id}/¶
Description
Detail endpoint for a single DataImportSession 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
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
Response 200 OK
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
POST /api/importer/session/{id}/accept_fields/¶
Description
Accept the field mapping for a DataImportSession.
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
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
POST /api/importer/session/{id}/accept_rows/¶
Description
API endpoint to accept the rows for a DataImportSession.
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
{
"rows": [
0
]
}
Schema of the request body
{
"description": "Serializer for accepting rows of data.",
"properties": {
"rows": {
"description": "List of row IDs to accept",
"items": {
"title": "Rows",
"type": "integer"
},
"type": "array"
}
},
"required": [
"rows"
],
"type": "object"
}
{
"rows": [
0
]
}
Schema of the request body
{
"description": "Serializer for accepting rows of data.",
"properties": {
"rows": {
"description": "List of row IDs to accept",
"items": {
"title": "Rows",
"type": "integer"
},
"type": "array"
}
},
"required": [
"rows"
],
"type": "object"
}
{
"rows": [
0
]
}
Schema of the request body
{
"description": "Serializer for accepting rows of data.",
"properties": {
"rows": {
"description": "List of row IDs to accept",
"items": {
"title": "Rows",
"type": "integer"
},
"type": "array"
}
},
"required": [
"rows"
],
"type": "object"
}
Response 201 Created
{
"rows": [
0
]
}
Schema of the response body
{
"description": "Serializer for accepting rows of data.",
"properties": {
"rows": {
"description": "List of row IDs to accept",
"items": {
"title": "Rows",
"type": "integer"
},
"type": "array"
}
},
"required": [
"rows"
],
"type": "object"
}
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. | |
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": [
{
"date": "2022-04-13T15:42:05.901Z",
"image": "string",
"model_id": 0,
"model_type": "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",
"model_id": 0,
"model_type": "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"
},
"model_id": {
"description": "Target model ID for this image",
"nullable": true,
"type": "integer"
},
"model_type": {
"description": "Target model type for this image",
"maxLength": 100,
"nullable": true,
"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",
"model_id": 0,
"model_type": "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"
},
"model_id": {
"description": "Target model ID for this image",
"nullable": true,
"type": "integer"
},
"model_type": {
"description": "Target model type for this image",
"maxLength": 100,
"nullable": true,
"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",
"model_id": 0,
"model_type": "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"
},
"model_id": {
"description": "Target model ID for this image",
"nullable": true,
"type": "integer"
},
"model_type": {
"description": "Target model type for this image",
"maxLength": 100,
"nullable": true,
"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",
"model_id": 0,
"model_type": "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"
},
"model_id": {
"description": "Target model ID for this image",
"nullable": true,
"type": "integer"
},
"model_type": {
"description": "Target model type for this image",
"maxLength": 100,
"nullable": true,
"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
Override the 'get' method to check for the export query parameter.
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"
}
selection¶
GET /api/selection/¶
Description
List view for SelectionList 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" |
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": [
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "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/SelectionList"
},
"type": "array"
}
},
"type": "object"
}
POST /api/selection/¶
Description
List view for SelectionList 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" |
Request body
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the request body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"created",
"default",
"entry_count",
"last_updated",
"name",
"pk"
],
"type": "object"
}
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the request body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"created",
"default",
"entry_count",
"last_updated",
"name",
"pk"
],
"type": "object"
}
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the request body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"created",
"default",
"entry_count",
"last_updated",
"name",
"pk"
],
"type": "object"
}
Response 201 Created
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the response body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"created",
"default",
"entry_count",
"last_updated",
"name",
"pk"
],
"type": "object"
}
DELETE /api/selection/{id}/¶
Description
Detail view for a SelectionList 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/selection/{id}/¶
Description
Detail view for a SelectionList 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
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the response body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"created",
"default",
"entry_count",
"last_updated",
"name",
"pk"
],
"type": "object"
}
PATCH /api/selection/{id}/¶
Description
Detail view for a SelectionList 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
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the request body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"type": "object"
}
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the request body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"type": "object"
}
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the request body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the response body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"created",
"default",
"entry_count",
"last_updated",
"name",
"pk"
],
"type": "object"
}
PUT /api/selection/{id}/¶
Description
Detail view for a SelectionList 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
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the request body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"created",
"default",
"entry_count",
"last_updated",
"name",
"pk"
],
"type": "object"
}
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the request body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"created",
"default",
"entry_count",
"last_updated",
"name",
"pk"
],
"type": "object"
}
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the request body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"created",
"default",
"entry_count",
"last_updated",
"name",
"pk"
],
"type": "object"
}
Response 200 OK
{
"active": true,
"choices": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
],
"created": "2022-04-13T15:42:05.901Z",
"default": null,
"description": "string",
"entry_count": 0,
"last_updated": "2022-04-13T15:42:05.901Z",
"locked": true,
"name": "string",
"pk": 0,
"source_plugin": 0,
"source_string": "string"
}
Schema of the response body
{
"description": "Serializer for a selection list.",
"properties": {
"active": {
"description": "Can this selection list be used?",
"type": "boolean"
},
"choices": {
"items": {
"$ref": "#/components/schemas/SelectionEntry"
},
"type": "array"
},
"created": {
"description": "Date and time that the selection list was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/SelectionEntry"
}
],
"readOnly": true
},
"description": {
"description": "Description of the selection list",
"maxLength": 250,
"type": "string"
},
"entry_count": {
"readOnly": true,
"type": "integer"
},
"last_updated": {
"description": "Date and time that the selection list was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"locked": {
"description": "Is this selection list locked?",
"type": "boolean"
},
"name": {
"description": "Name of the selection list",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"source_plugin": {
"description": "Plugin which provides the selection list",
"nullable": true,
"type": "integer"
},
"source_string": {
"description": "Optional string identifying the source used for this list",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"created",
"default",
"entry_count",
"last_updated",
"name",
"pk"
],
"type": "object"
}
GET /api/selection/{id}/entry/¶
Description
List view for SelectionEntry 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 | ||
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": [
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "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/SelectionEntry"
},
"type": "array"
}
},
"type": "object"
}
POST /api/selection/{id}/entry/¶
Description
List view for SelectionEntry 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
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"required": [
"id",
"label",
"list",
"value"
],
"type": "object"
}
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"required": [
"id",
"label",
"list",
"value"
],
"type": "object"
}
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"required": [
"id",
"label",
"list",
"value"
],
"type": "object"
}
Response 201 Created
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"required": [
"id",
"label",
"list",
"value"
],
"type": "object"
}
DELETE /api/selection/{id}/entry/{entrypk}/¶
Description
Detail view for a SelectionEntry 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" |
entrypk |
path | integer | No | ||
id |
path | integer | No |
Response 204 No Content
GET /api/selection/{id}/entry/{entrypk}/¶
Description
Detail view for a SelectionEntry 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" |
entrypk |
path | integer | No | ||
id |
path | integer | No |
Response 200 OK
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"required": [
"id",
"label",
"list",
"value"
],
"type": "object"
}
PATCH /api/selection/{id}/entry/{entrypk}/¶
Description
Detail view for a SelectionEntry 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" |
entrypk |
path | integer | No | ||
id |
path | integer | No |
Request body
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"type": "object"
}
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"type": "object"
}
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"required": [
"id",
"label",
"list",
"value"
],
"type": "object"
}
PUT /api/selection/{id}/entry/{entrypk}/¶
Description
Detail view for a SelectionEntry 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" |
entrypk |
path | integer | No | ||
id |
path | integer | No |
Request body
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"required": [
"id",
"label",
"list",
"value"
],
"type": "object"
}
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"required": [
"id",
"label",
"list",
"value"
],
"type": "object"
}
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"required": [
"id",
"label",
"list",
"value"
],
"type": "object"
}
Response 200 OK
{
"active": true,
"description": "string",
"id": 0,
"label": "string",
"list": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for a selection entry.",
"properties": {
"active": {
"description": "Is this selection list entry active?",
"type": "boolean"
},
"description": {
"description": "Description of the selection list entry",
"maxLength": 250,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"label": {
"description": "Label for the selection list entry",
"maxLength": 255,
"type": "string"
},
"list": {
"description": "Selection list to which this entry belongs",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"value": {
"description": "Value of the selection list entry",
"maxLength": 255,
"type": "string"
}
},
"required": [
"id",
"label",
"list",
"value"
],
"type": "object"
}
units¶
GET /api/units/¶
Description
Override the 'get' method to check for the export query parameter.
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"
}
GET /api/units/all/¶
Description
Return a list of all available 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. |
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": [
{
"available_systems": [
"string"
],
"available_units": [
{
"compatible_units": [
"string"
],
"is_alias": true,
"isdimensionless": true,
"name": "string"
}
],
"default_system": "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/AllUnitListResponse"
},
"type": "array"
}
},
"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 |
AllUnitListResponse¶
| Name | Type |
|---|---|
available_systems |
Array<string> |
available_units |
Array<Unit> |
default_system |
string |
APISearchView¶
| Name | Type |
|---|---|
limit |
integer |
offset |
integer |
search |
string |
search_regex |
boolean |
search_whole |
boolean |
Attachment¶
| Name | Type |
|---|---|
attachment |
string(uri)| null |
comment |
string |
file_size |
integer |
filename |
string |
link |
string(uri)| null |
model_id |
integer |
model_type |
AttachmentModelTypeEnum |
pk |
integer |
tags |
Array<string> |
upload_date |
string(date) |
upload_user |
integer| null |
user_detail |
AttachmentModelTypeEnum¶
Type: string
ColorEnum¶
Type: string
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) |
CustomState¶
| Name | Type |
|---|---|
color |
|
key |
integer |
label |
string |
logical_key |
integer |
model |
integer| null |
model_name |
string |
name |
string |
pk |
integer |
reference_status |
ReferenceStatusEnum |
CustomUnit¶
| Name | Type |
|---|---|
definition |
string |
name |
string |
pk |
integer |
symbol |
string |
DataImportAcceptRow¶
| Name | Type |
|---|---|
rows |
Array<integer> |
DataImportColumnMap¶
| Name | Type |
|---|---|
column |
string |
description |
string |
field |
string |
label |
string |
pk |
integer |
session |
integer |
DataImportRow¶
| Name | Type |
|---|---|
complete |
boolean |
data |
|
errors |
|
pk |
integer |
row_data |
|
row_index |
integer |
session |
integer |
valid |
boolean |
DataImportSession¶
| Name | Type |
|---|---|
available_fields |
|
column_mappings |
Array<DataImportColumnMap> |
columns |
|
completed_row_count |
integer |
data_file |
string(uri) |
field_defaults |
|
field_filters |
|
field_overrides |
|
model_type |
DataImportSessionModelTypeEnum |
pk |
integer |
row_count |
integer |
status |
|
timestamp |
string(date-time) |
user |
integer| null |
user_detail |
DataImportSessionModelTypeEnum¶
Type: string
DataImportSessionStatusEnum¶
Type: integer
DefaultLocaleEnum¶
Type: string
ErrorMessage¶
| Name | Type |
|---|---|
data |
string| null |
info |
string |
path |
string(uri)| null |
pk |
integer |
when |
string(date-time) |
GenerateBatchCode¶
| Name | Type |
|---|---|
batch_code |
string |
build_order |
integer| null |
item |
integer| null |
location |
integer| null |
part |
integer| null |
purchase_order |
integer| null |
quantity |
number(double)| null |
GenerateSerialNumber¶
| Name | Type |
|---|---|
part |
integer| null |
quantity |
integer |
serial |
string |
GetSimpleLogin¶
| Name | Type |
|---|---|
email |
string |
Icon¶
| Name | Type |
|---|---|
category |
string |
name |
string |
tags |
Array<string> |
variants |
IconPackage¶
| Name | Type |
|---|---|
fonts |
|
icons |
|
name |
string |
prefix |
string |
InfoApi¶
| Name | Type |
|---|---|
active_plugins |
|
apiVersion |
integer |
database |
string |
debug_mode |
boolean |
default_locale |
|
django_admin |
string |
docker_mode |
boolean |
email_configured |
boolean |
installer |
string |
instance |
string |
platform |
string |
plugins_enabled |
boolean |
plugins_install_disabled |
boolean |
server |
string |
system_health |
boolean |
target |
string |
version |
string |
worker_count |
integer |
worker_pending_tasks |
integer |
worker_running |
boolean |
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) |
model_id |
integer| null |
model_type |
string| null |
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 |
PaginatedAllUnitListResponseList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<AllUnitListResponse> |
PaginatedAttachmentList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<Attachment> |
PaginatedContentTypeList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ContentType> |
PaginatedCustomStateList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<CustomState> |
PaginatedCustomUnitList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<CustomUnit> |
PaginatedDataImportColumnMapList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<DataImportColumnMap> |
PaginatedDataImportRowList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<DataImportRow> |
PaginatedDataImportSessionList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<DataImportSession> |
PaginatedErrorMessageList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ErrorMessage> |
PaginatedIconPackageList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<IconPackage> |
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> |
PaginatedSelectionEntryList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<SelectionEntry> |
PaginatedSelectionListList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<SelectionList> |
PaginatedVersionInformationList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<VersionInformation> |
PatchedAttachment¶
| Name | Type |
|---|---|
attachment |
string(uri)| null |
comment |
string |
file_size |
integer |
filename |
string |
link |
string(uri)| null |
model_id |
integer |
model_type |
AttachmentModelTypeEnum |
pk |
integer |
tags |
Array<string> |
upload_date |
string(date) |
upload_user |
integer| null |
user_detail |
PatchedCustomState¶
| Name | Type |
|---|---|
color |
|
key |
integer |
label |
string |
logical_key |
integer |
model |
integer| null |
model_name |
string |
name |
string |
pk |
integer |
reference_status |
ReferenceStatusEnum |
PatchedCustomUnit¶
| Name | Type |
|---|---|
definition |
string |
name |
string |
pk |
integer |
symbol |
string |
PatchedDataImportColumnMap¶
| Name | Type |
|---|---|
column |
string |
description |
string |
field |
string |
label |
string |
pk |
integer |
session |
integer |
PatchedDataImportRow¶
| Name | Type |
|---|---|
complete |
boolean |
data |
|
errors |
|
pk |
integer |
row_data |
|
row_index |
integer |
session |
integer |
valid |
boolean |
PatchedDataImportSession¶
| Name | Type |
|---|---|
available_fields |
|
column_mappings |
Array<DataImportColumnMap> |
columns |
|
completed_row_count |
integer |
data_file |
string(uri) |
field_defaults |
|
field_filters |
|
field_overrides |
|
model_type |
DataImportSessionModelTypeEnum |
pk |
integer |
row_count |
integer |
status |
|
timestamp |
string(date-time) |
user |
integer| null |
user_detail |
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 |
PatchedSelectionEntry¶
| Name | Type |
|---|---|
active |
boolean |
description |
string |
id |
integer |
label |
string |
list |
integer| null |
value |
string |
PatchedSelectionList¶
| Name | Type |
|---|---|
active |
boolean |
choices |
Array<SelectionEntry> |
created |
string(date-time) |
default |
|
description |
string |
entry_count |
integer |
last_updated |
string(date-time) |
locked |
boolean |
name |
string |
pk |
integer |
source_plugin |
integer| null |
source_string |
string |
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 |
ReferenceStatusEnum¶
Type: string
SelectionEntry¶
| Name | Type |
|---|---|
active |
boolean |
description |
string |
id |
integer |
label |
string |
list |
integer| null |
value |
string |
SelectionList¶
| Name | Type |
|---|---|
active |
boolean |
choices |
Array<SelectionEntry> |
created |
string(date-time) |
default |
|
description |
string |
entry_count |
integer |
last_updated |
string(date-time) |
locked |
boolean |
name |
string |
pk |
integer |
source_plugin |
integer| null |
source_string |
string |
Unit¶
| Name | Type |
|---|---|
compatible_units |
Array<string> |
is_alias |
boolean |
isdimensionless |
boolean |
name |
string |
User¶
| Name | Type |
|---|---|
email |
string(email) |
first_name |
string |
last_name |
string |
pk |
integer |
username |
string |
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