The General API Endpoints section of the InvenTree API schema is documented below.
InvenTree API 435¶
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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,
"customize": null,
"database": "string",
"debug_mode": true,
"default_locale": "string",
"django_admin": "string",
"docker_mode": true,
"email_configured": true,
"id": "string",
"installer": "string",
"instance": "string",
"platform": "string",
"plugins_enabled": true,
"plugins_install_disabled": true,
"server": "string",
"settings": null,
"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"
},
"customize": {
"allOf": [
{
"$ref": "#/components/schemas/Customize"
}
],
"readOnly": true
},
"database": {
"readOnly": true,
"type": "string"
},
"debug_mode": {
"readOnly": true,
"type": "boolean"
},
"default_locale": {
"readOnly": true,
"type": "string"
},
"django_admin": {
"readOnly": true,
"type": "string"
},
"docker_mode": {
"readOnly": true,
"type": "boolean"
},
"email_configured": {
"readOnly": true,
"type": "boolean"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/Settings"
}
],
"readOnly": true
},
"system_health": {
"readOnly": true,
"type": "boolean"
},
"target": {
"nullable": true,
"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",
"customize",
"database",
"debug_mode",
"default_locale",
"django_admin",
"docker_mode",
"email_configured",
"installer",
"instance",
"platform",
"plugins_enabled",
"plugins_install_disabled",
"server",
"settings",
"system_health",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
Response 400 Bad Request
{
"action": "string",
"error": "string"
}
Schema of the response body
{
"description": "Serializer for the ActionPluginView error responses.",
"properties": {
"action": {
"type": "string"
},
"error": {
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
}
Response 404 Not Found
{
"action": "string",
"error": "string"
}
Schema of the response body
{
"description": "Serializer for the ActionPluginView error responses.",
"properties": {
"action": {
"type": "string"
},
"error": {
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
}
admin¶
GET /api/admin/config/¶
Description
List view for all accessed configurations.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
[
{
"accessed": "2022-04-13T15:42:05.901Z",
"config_key": "string",
"env_var": "string",
"key": "string",
"source": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/Config"
},
"type": "array"
}
GET /api/admin/config/{key}/¶
Description
Detail view for an individual configuration.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"accessed": "2022-04-13T15:42:05.901Z",
"config_key": "string",
"env_var": "string",
"key": "string",
"source": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTree configuration.\n\nThis is a read-only serializer.",
"properties": {
"accessed": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"config_key": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"env_var": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"source": {
"readOnly": true,
"type": "string"
}
},
"required": [
"accessed",
"key",
"source"
],
"type": "object"
}
DELETE /api/admin/email/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Response 204 No Content
GET /api/admin/email/¶
Description
List view for email objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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. Searched fields: global_id, message_id_key, sender, subject, thread_id_key, to. |
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": [
{
"body": "string",
"delivery_options": null,
"direction": null,
"error_code": "string",
"error_message": "string",
"error_timestamp": "2022-04-13T15:42:05.901Z",
"full_message": "string",
"global_id": "8f202430-9ca9-4536-8c17-da9a24e11fe9",
"headers": null,
"message_id_key": "string",
"pk": "5b396ebd-873d-40d7-b632-aebfae9457b1",
"priority": null,
"sender": "derp@meme.org",
"status": null,
"subject": "string",
"thread": "23f7a736-c5d4-4a77-a0c2-846d30540780",
"thread_id_key": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"to": "derp@meme.org"
}
]
}
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/EmailMessage"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/admin/email/test/¶
Description
Send a test email.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "derp@meme.org"
}
Schema of the request body
{
"description": "Serializer to send a test email.",
"properties": {
"email": {
"format": "email",
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
{
"email": "derp@meme.org"
}
Schema of the request body
{
"description": "Serializer to send a test email.",
"properties": {
"email": {
"format": "email",
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
{
"email": "derp@meme.org"
}
Schema of the request body
{
"description": "Serializer to send a test email.",
"properties": {
"email": {
"format": "email",
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
Response 201 Created
{
"email": "derp@meme.org"
}
Schema of the response body
{
"description": "Serializer to send a test email.",
"properties": {
"email": {
"format": "email",
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
DELETE /api/admin/email/{global_id}/¶
Description
Detail view for an email object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
global_id |
path | string | No |
Response 204 No Content
GET /api/admin/email/{global_id}/¶
Description
Detail view for an email object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
global_id |
path | string | No |
Response 200 OK
{
"body": "string",
"delivery_options": null,
"direction": null,
"error_code": "string",
"error_message": "string",
"error_timestamp": "2022-04-13T15:42:05.901Z",
"full_message": "string",
"global_id": "988eb936-d064-4eff-bdbb-b0ca46bd7646",
"headers": null,
"message_id_key": "string",
"pk": "39f5f86b-b5ab-4400-95cd-16d431342f7d",
"priority": null,
"sender": "derp@meme.org",
"status": null,
"subject": "string",
"thread": "3c7c3f84-3ae8-477c-a4dc-dbc6d8c4e2fe",
"thread_id_key": "string",
"timestamp": "2022-04-13T15:42:05.901Z",
"to": "derp@meme.org"
}
Schema of the response body
{
"description": "Serializer for the EmailMessage model.",
"properties": {
"body": {
"type": "string"
},
"delivery_options": {
"nullable": true
},
"direction": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/DirectionEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"error_code": {
"maxLength": 50,
"nullable": true,
"type": "string"
},
"error_message": {
"nullable": true,
"type": "string"
},
"error_timestamp": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"full_message": {
"nullable": true,
"type": "string"
},
"global_id": {
"description": "Unique identifier for this message",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"headers": {
"nullable": true
},
"message_id_key": {
"description": "Identifier for this message (might be supplied by external system)",
"maxLength": 250,
"nullable": true,
"title": "Message ID",
"type": "string"
},
"pk": {
"description": "Unique identifier for this message",
"format": "uuid",
"readOnly": true,
"title": "Global ID",
"type": "string"
},
"priority": {
"allOf": [
{
"$ref": "#/components/schemas/PriorityEnum"
}
],
"maximum": 9223372036854775807,
"minimum": -9223372036854775808
},
"sender": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"status": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EmailMessageStatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"subject": {
"maxLength": 250,
"type": "string"
},
"thread": {
"description": "Linked thread for this message",
"format": "uuid",
"nullable": true,
"type": "string"
},
"thread_id_key": {
"description": "Identifier for this message thread (might be supplied by external system)",
"maxLength": 250,
"nullable": true,
"title": "Thread ID",
"type": "string"
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"to": {
"format": "email",
"maxLength": 254,
"type": "string"
}
},
"required": [
"body",
"global_id",
"pk",
"priority",
"sender",
"subject",
"timestamp",
"to"
],
"type": "object"
}
attachment¶
DELETE /api/attachment/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Response 204 No Content
GET /api/attachment/¶
Description
List API endpoint for Attachment objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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. Searched fields: comment, model_id, model_type. | |
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": 137,
"model_type": "part",
"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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/attachment/¶
Description
List API endpoint for Attachment objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": 35,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 21,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 122,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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",
"user_detail"
],
"type": "object"
}
Response 201 Created
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 85,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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",
"user_detail"
],
"type": "object"
}
DELETE /api/attachment/{id}/¶
Description
Detail API endpoint for Attachment objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": 254,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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",
"user_detail"
],
"type": "object"
}
PATCH /api/attachment/{id}/¶
Description
Detail API endpoint for Attachment objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": 42,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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": 21,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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": 24,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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": 129,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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",
"user_detail"
],
"type": "object"
}
PUT /api/attachment/{id}/¶
Description
Detail API endpoint for Attachment objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": 80,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 26,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 146,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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",
"user_detail"
],
"type": "object"
}
Response 200 OK
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 145,
"model_type": "part",
"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": 2000,
"nullable": true,
"type": "string"
},
"model_id": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"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",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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. Searched fields: app_label, model. |
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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
GET /api/contenttype/model/{model}/¶
Description
Detail view for a ContentType model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
data-output¶
DELETE /api/data-output/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Response 204 No Content
GET /api/data-output/¶
Description
List view for DataOutput objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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. | |
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": [
{
"complete": true,
"created": "2022-04-13",
"errors": null,
"output": "string",
"output_type": "string",
"pk": 0,
"plugin": "string",
"progress": 201,
"template_name": "string",
"total": 24,
"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/DataOutput"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
DELETE /api/data-output/{id}/¶
Description
Detail view for a DataOutput object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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/data-output/{id}/¶
Description
Detail view for a DataOutput object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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,
"created": "2022-04-13",
"errors": null,
"output": "string",
"output_type": "string",
"pk": 0,
"plugin": "string",
"progress": 37,
"template_name": "string",
"total": 208,
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the DataOutput model.",
"properties": {
"complete": {
"type": "boolean"
},
"created": {
"format": "date",
"readOnly": true,
"type": "string"
},
"errors": {
"nullable": true
},
"output": {
"format": "uri",
"nullable": true,
"readOnly": true,
"type": "string"
},
"output_type": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"plugin": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"progress": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"template_name": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"total": {
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"user": {
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"created",
"pk",
"user_detail"
],
"type": "object"
}
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.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Response 204 No Content
GET /api/error-report/¶
Description
List view for server error messages.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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. Searched fields: data, info. |
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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
DELETE /api/error-report/{id}/¶
Description
Detail view for a single error message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": [
"info",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": [
"info",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": [
"info",
"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": [
"info",
"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": [
"info",
"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": [
"info",
"pk",
"when"
],
"type": "object"
}
flags¶
GET /api/flags/¶
Description
List view for feature flags.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
[
{
"conditions": [
{}
],
"key": "string",
"state": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/Flag"
},
"type": "array"
}
GET /api/flags/{key}/¶
Description
Detail view for an individual feature flag.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"conditions": [
{}
],
"key": "string",
"state": "string"
}
Schema of the response body
{
"description": "Serializer for feature flags.",
"properties": {
"conditions": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"key": {
"readOnly": true,
"type": "string"
},
"state": {
"readOnly": true,
"type": "string"
}
},
"required": [
"key",
"state"
],
"type": "object"
}
generate¶
POST /api/generate/batch-code/¶
Description
Generate a new batch code.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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_number": "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_number\" field will return a string with multiple serial numbers\nseparated 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_number": {
"description": "Generated serial number",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"part": 0,
"quantity": 0,
"serial_number": "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_number\" field will return a string with multiple serial numbers\nseparated 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_number": {
"description": "Generated serial number",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"part": 0,
"quantity": 0,
"serial_number": "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_number\" field will return a string with multiple serial numbers\nseparated 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_number": {
"description": "Generated serial number",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"part": 0,
"quantity": 0,
"serial_number": "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_number\" field will return a string with multiple serial numbers\nseparated 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_number": {
"description": "Generated serial number",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
Schema of the response body
{
"additionalProperties": {},
"type": "object"
}
GET /api/generic/status/custom/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
query | integer | 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. | |
reference_status |
query | string | No | ||
search |
query | string | No | A search term. Searched fields: key, label, name, reference_status. |
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": 186,
"label": "string",
"logical_key": 279,
"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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/generic/status/custom/¶
Description
List view for all custom states.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": 126,
"label": "string",
"logical_key": 86,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 17,
"label": "string",
"logical_key": 129,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 249,
"label": "string",
"logical_key": 209,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
Response 201 Created
{
"color": null,
"key": 279,
"label": "string",
"logical_key": 178,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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_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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": 215,
"label": "string",
"logical_key": 212,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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_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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": 292,
"label": "string",
"logical_key": 215,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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": 59,
"label": "string",
"logical_key": 50,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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": 60,
"label": "string",
"logical_key": 28,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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": 127,
"label": "string",
"logical_key": 3,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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_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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": 210,
"label": "string",
"logical_key": 91,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 228,
"label": "string",
"logical_key": 261,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 195,
"label": "string",
"logical_key": 109,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
Response 200 OK
{
"color": null,
"key": 138,
"label": "string",
"logical_key": 23,
"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": "Numerical value that will be saved in the models database",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"title": "Value",
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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_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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"status_class": "string",
"values": {}
}
Schema of the response body
{
"description": "API serializer for generic state class information.",
"properties": {
"status_class": {
"readOnly": true,
"title": "Class",
"type": "string"
},
"values": {
"additionalProperties": {
"$ref": "#/components/schemas/GenericStateValue"
},
"type": "object"
}
},
"required": [
"status_class",
"values"
],
"type": "object"
}
Response 400 Bad Request
icons¶
GET /api/icons/¶
Description
List view for available icon packages.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
},
"required": [
"count",
"results"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
GET /api/importer/column-mapping/{id}/¶
Description
Detail endpoint for a single DataImportColumnMap object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
[
{
"api_url": "string",
"model_type": "string",
"serializer": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/DataImporterModel"
},
"type": "array"
}
DELETE /api/importer/row/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
DELETE /api/importer/row/{id}/¶
Description
Detail endpoint for a single DataImportRow object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"pk",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"pk",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"pk",
"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",
"pk",
"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",
"pk",
"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",
"pk",
"row_index",
"session",
"valid"
],
"type": "object"
}
DELETE /api/importer/session/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/importer/session/¶
Description
API endpoint for accessing a list of DataImportSession objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": "projectcode",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"update_records": true,
"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"
},
"update_records": {
"description": "If enabled, existing records will be updated with new data",
"title": "Update Existing Records",
"type": "boolean"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": [
null
],
"frontend": [
null
]
}
Schema of the response body
{
"description": "Serializer for license information.",
"properties": {
"backend": {
"description": "Backend licenses texts",
"items": {},
"readOnly": true,
"type": "array"
},
"frontend": {
"description": "Frontend licenses texts",
"items": {},
"readOnly": true,
"type": "array"
}
},
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Response 204 No Content
GET /api/news/¶
Description
List view for all news items.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
DELETE /api/news/{id}/¶
Description
Detail view for an individual news feed object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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. Searched fields: model_id, model_type, user. |
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": 127,
"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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/notes-image-upload/¶
Description
List view for all notes images.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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": 1,
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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"
],
"type": "object"
}
{
"date": "2022-04-13T15:42:05.901Z",
"image": "string",
"model_id": 287,
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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"
],
"type": "object"
}
{
"date": "2022-04-13T15:42:05.901Z",
"image": "string",
"model_id": 95,
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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"
],
"type": "object"
}
Response 201 Created
{
"date": "2022-04-13T15:42:05.901Z",
"image": "string",
"model_id": 78,
"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",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"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"
],
"type": "object"
}
notifications¶
DELETE /api/notifications/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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. Searched fields: message, name. |
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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
GET /api/notifications/readall/¶
Description
Set all messages for the current user as read.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"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",
"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",
"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",
"name",
"pk",
"read",
"source",
"target",
"user"
],
"type": "object"
}
parameter¶
DELETE /api/parameter/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Response 204 No Content
GET /api/parameter/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
enabled |
query | boolean | No | Template Enabled | |
limit |
query | integer | No | Number of results to return per page. | |
model_id |
query | integer | No | ||
model_type |
query | string | No | Model Type | |
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. Searched fields: data, template__description, template__name, template__units. | |
template |
query | integer | No | ||
updated_by |
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": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 118,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_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/Parameter"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/parameter/¶
Description
List API endpoint for Parameter objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"data": "string",
"data_numeric": 10.12,
"model_id": 19,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the request body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"data",
"model_id",
"pk",
"template",
"template_detail",
"updated_by_detail"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"model_id": 72,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the request body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"data",
"model_id",
"pk",
"template",
"template_detail",
"updated_by_detail"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"model_id": 46,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the request body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"data",
"model_id",
"pk",
"template",
"template_detail",
"updated_by_detail"
],
"type": "object"
}
Response 201 Created
{
"data": "string",
"data_numeric": 10.12,
"model_id": 183,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the response body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"data",
"model_id",
"pk",
"template",
"template_detail",
"updated_by_detail"
],
"type": "object"
}
GET /api/parameter/template/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
checkbox |
query | boolean | No | ||
enabled |
query | boolean | No | ||
exists_for_model |
query | string | No | Exists For Model | |
for_model |
query | string | No | For Model | |
has_choices |
query | boolean | No | Has Choice | |
has_units |
query | boolean | No | Has Units | |
limit |
query | integer | No | Number of results to return per page. | |
model_type |
query | string | No | Model Type | |
name |
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. Searched fields: description, name. | |
units |
query | string | 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": [
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "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/ParameterTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/parameter/template/¶
Description
List view for ParameterTemplate objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the request body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the request body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the request body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
Response 201 Created
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the response body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
DELETE /api/parameter/template/{id}/¶
Description
Detail view for a ParameterTemplate object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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/parameter/template/{id}/¶
Description
Detail view for a ParameterTemplate object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the response body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
PATCH /api/parameter/template/{id}/¶
Description
Detail view for a ParameterTemplate object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the request body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the request body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the request body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the response body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
PUT /api/parameter/template/{id}/¶
Description
Detail view for a ParameterTemplate object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the request body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the request body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the request body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
Response 200 OK
{
"checkbox": true,
"choices": "string",
"description": "string",
"enabled": true,
"model_type": null,
"name": "string",
"pk": 0,
"selectionlist": 0,
"units": "string"
}
Schema of the response body
{
"description": "Serializer for the ParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Is this parameter template enabled?",
"type": "boolean"
},
"model_type": {
"default": "",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"pk"
],
"type": "object"
}
GET /api/parameter/template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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/parameter/template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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/parameter/template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
DELETE /api/parameter/{id}/¶
Description
Detail API endpoint for Parameter objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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/parameter/{id}/¶
Description
Detail API endpoint for Parameter objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"data_numeric": 10.12,
"model_id": 89,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the response body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"data",
"model_id",
"pk",
"template",
"template_detail",
"updated_by_detail"
],
"type": "object"
}
PATCH /api/parameter/{id}/¶
Description
Detail API endpoint for Parameter objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"data_numeric": 10.12,
"model_id": 283,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the request body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"model_id": 88,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the request body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"model_id": 82,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the request body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"data": "string",
"data_numeric": 10.12,
"model_id": 141,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the response body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"data",
"model_id",
"pk",
"template",
"template_detail",
"updated_by_detail"
],
"type": "object"
}
PUT /api/parameter/{id}/¶
Description
Detail API endpoint for Parameter objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"data_numeric": 10.12,
"model_id": 25,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the request body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"data",
"model_id",
"pk",
"template",
"template_detail",
"updated_by_detail"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"model_id": 172,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the request body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"data",
"model_id",
"pk",
"template",
"template_detail",
"updated_by_detail"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"model_id": 208,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the request body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"data",
"model_id",
"pk",
"template",
"template_detail",
"updated_by_detail"
],
"type": "object"
}
Response 200 OK
{
"data": "string",
"data_numeric": 10.12,
"model_id": 7,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
Schema of the response body
{
"description": "Serializer for the Parameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"model_id": {
"description": "ID of the target model for this parameter",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"model_type": {
"allOf": [
{
"$ref": "#/components/schemas/ModelType98eEnum"
}
],
"default": ""
},
"note": {
"description": "Optional note field",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"updated_by": {
"description": "User who last updated this object",
"nullable": true,
"readOnly": true,
"title": "Update By",
"type": "integer"
},
"updated_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"data",
"model_id",
"pk",
"template",
"template_detail",
"updated_by_detail"
],
"type": "object"
}
GET /api/parameter/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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/parameter/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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/parameter/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
project-code¶
GET /api/project-code/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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. Searched fields: code, description. |
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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/project-code/¶
Description
List view for all project codes.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"code",
"pk"
],
"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"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"code",
"pk"
],
"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"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"code",
"pk"
],
"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"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"code",
"pk"
],
"type": "object"
}
DELETE /api/project-code/{id}/¶
Description
Detail view for a particular project code.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"code",
"pk"
],
"type": "object"
}
PATCH /api/project-code/{id}/¶
Description
Detail view for a particular project code.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"code",
"pk"
],
"type": "object"
}
PUT /api/project-code/{id}/¶
Description
Detail view for a particular project code.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"code",
"pk"
],
"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"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"code",
"pk"
],
"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"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"code",
"pk"
],
"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"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"code",
"pk"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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_notes": true,
"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_notes": {
"default": false,
"type": "boolean"
},
"search_regex": {
"default": false,
"type": "boolean"
},
"search_whole": {
"default": false,
"type": "boolean"
}
},
"required": [
"search"
],
"type": "object"
}
{
"limit": 0,
"offset": 0,
"search": "string",
"search_notes": true,
"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_notes": {
"default": false,
"type": "boolean"
},
"search_regex": {
"default": false,
"type": "boolean"
},
"search_whole": {
"default": false,
"type": "boolean"
}
},
"required": [
"search"
],
"type": "object"
}
{
"limit": 0,
"offset": 0,
"search": "string",
"search_notes": true,
"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_notes": {
"default": false,
"type": "boolean"
},
"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_notes": true,
"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_notes": {
"default": false,
"type": "boolean"
},
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/selection/¶
Description
List view for SelectionList objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/selection/{id}/entry/¶
Description
List view for SelectionEntry objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"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",
"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",
"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",
"value"
],
"type": "object"
}
DELETE /api/selection/{id}/entry/{entrypk}/¶
Description
Detail view for a SelectionEntry object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"value"
],
"type": "object"
}
PATCH /api/selection/{id}/entry/{entrypk}/¶
Description
Detail view for a SelectionEntry object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"value"
],
"type": "object"
}
PUT /api/selection/{id}/entry/{entrypk}/¶
Description
Detail view for a SelectionEntry object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"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",
"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",
"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",
"value"
],
"type": "object"
}
supplier¶
POST /api/supplier/import/¶
Description
Import a part by supplier.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"category_id": 0,
"part_id": 0,
"part_import_id": "string",
"plugin": "string",
"supplier": "string"
}
Schema of the request body
{
"description": "Serializer for the import request.",
"properties": {
"category_id": {
"nullable": true,
"type": "integer"
},
"part_id": {
"nullable": true,
"type": "integer"
},
"part_import_id": {
"type": "string"
},
"plugin": {
"type": "string"
},
"supplier": {
"type": "string"
}
},
"required": [
"part_import_id",
"plugin",
"supplier"
],
"type": "object"
}
{
"category_id": 0,
"part_id": 0,
"part_import_id": "string",
"plugin": "string",
"supplier": "string"
}
Schema of the request body
{
"description": "Serializer for the import request.",
"properties": {
"category_id": {
"nullable": true,
"type": "integer"
},
"part_id": {
"nullable": true,
"type": "integer"
},
"part_import_id": {
"type": "string"
},
"plugin": {
"type": "string"
},
"supplier": {
"type": "string"
}
},
"required": [
"part_import_id",
"plugin",
"supplier"
],
"type": "object"
}
{
"category_id": 0,
"part_id": 0,
"part_import_id": "string",
"plugin": "string",
"supplier": "string"
}
Schema of the request body
{
"description": "Serializer for the import request.",
"properties": {
"category_id": {
"nullable": true,
"type": "integer"
},
"part_id": {
"nullable": true,
"type": "integer"
},
"part_import_id": {
"type": "string"
},
"plugin": {
"type": "string"
},
"supplier": {
"type": "string"
}
},
"required": [
"part_import_id",
"plugin",
"supplier"
],
"type": "object"
}
Response 200 OK
{
"manufacturer_part_id": 0,
"parameters": [
{
"name": "string",
"on_category": true,
"parameter_template": 0,
"value": "string"
}
],
"part_detail": {
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 248,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 23,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
},
"part_id": 0,
"pricing": [
[
10.12
]
],
"supplier_part_id": 0
}
Schema of the response body
{
"description": "Serializer for the import result.",
"properties": {
"manufacturer_part_id": {
"type": "integer"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/ImportParameter"
},
"type": "array"
},
"part_detail": {
"$ref": "#/components/schemas/Part"
},
"part_id": {
"type": "integer"
},
"pricing": {
"description": "Return the pricing data as a dictionary.",
"items": {
"items": {
"format": "double",
"type": "number"
},
"maxLength": 2,
"minLength": 2,
"type": "array"
},
"readOnly": true,
"type": "array"
},
"supplier_part_id": {
"type": "integer"
}
},
"required": [
"manufacturer_part_id",
"parameters",
"part_detail",
"part_id",
"pricing",
"supplier_part_id"
],
"type": "object"
}
GET /api/supplier/list/¶
Description
List all available supplier plugins.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
[
{
"plugin_slug": "string",
"supplier_name": "string",
"supplier_slug": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/SupplierList"
},
"type": "array"
}
GET /api/supplier/search/¶
Description
Search parts by supplier.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
plugin |
query | string | No | Plugin slug | |
supplier |
query | string | No | Supplier slug | |
term |
query | string | No | Search term |
Response 200 OK
[
{
"description": "string",
"exact": true,
"existing_part_id": 0,
"id": "string",
"image_url": "string",
"link": "string",
"name": "string",
"price": "string",
"sku": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/SearchResult"
},
"type": "array"
}
units¶
GET /api/units/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/units/¶
Description
List view for custom units.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"available_systems": [
"string"
],
"available_units": {},
"default_system": "string"
}
Schema of the response body
{
"description": "Serializer for the AllUnitList.",
"properties": {
"available_systems": {
"items": {
"type": "string"
},
"type": "array"
},
"available_units": {
"additionalProperties": {
"$ref": "#/components/schemas/Unit"
},
"type": "object"
},
"default_system": {
"type": "string"
}
},
"required": [
"available_systems",
"available_units",
"default_system"
],
"type": "object"
}
DELETE /api/units/{id}/¶
Description
Detail view for a particular custom unit.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
start_version |
query | integer | No | First version to report. Defaults to return the latest {versions} versions. | |
versions |
query | integer | 10 | No | Number of versions to return. |
Response 200 OK
[
{
"date": "2022-04-13",
"gh": "string",
"latest": true,
"text": [
"string"
],
"version": "string"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/VersionInformation"
},
"type": "array"
}
version¶
GET /api/version/¶
Description
Return information about the InvenTree server.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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",
"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"
}
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 |
ActionPluginError¶
| Name | Type |
|---|---|
action |
string |
error |
string |
AllUnitListResponse¶
| Name | Type |
|---|---|
available_systems |
Array<string> |
available_units |
|
default_system |
string |
APISearchView¶
| Name | Type |
|---|---|
limit |
integer |
offset |
integer |
search |
string |
search_notes |
boolean |
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(int64) |
model_type |
AttachmentModelTypeEnum |
pk |
integer |
tags |
Array<string> |
upload_date |
string(date) |
upload_user |
integer| null |
user_detail |
AttachmentModelTypeEnum¶
Type: string
BlankEnum¶
Type:
BulkRequest¶
| Name | Type |
|---|---|
filters |
|
items |
Array<integer> |
Category¶
| Name | Type |
|---|---|
default_keywords |
string| null |
default_location |
integer| null |
description |
string |
icon |
string| null |
level |
integer |
name |
string |
parent |
integer| null |
parent_default_location |
integer| null |
part_count |
integer| null |
path |
Array<> |
pathstring |
string |
pk |
integer |
starred |
boolean |
structural |
boolean |
subcategories |
integer| null |
ColorEnum¶
Type: string
Config¶
| Name | Type |
|---|---|
accessed |
string(date-time) |
config_key |
string| null |
env_var |
string| null |
key |
string |
source |
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) |
Customize¶
| Name | Type |
|---|---|
login_message |
string| null |
logo |
string |
navbar_message |
string| null |
splash |
string |
CustomState¶
| Name | Type |
|---|---|
color |
|
key |
integer(int64) |
label |
string |
logical_key |
integer(int64) |
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 |
DataImporterModel¶
| Name | Type |
|---|---|
api_url |
string(uri)| null |
model_type |
string |
serializer |
string |
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) |
update_records |
boolean |
user |
integer| null |
user_detail |
DataImportSessionModelTypeEnum¶
Type: string
DataImportSessionStatusEnum¶
Type: integer
DataOutput¶
| Name | Type |
|---|---|
complete |
boolean |
created |
string(date) |
errors |
|
output |
string(uri)| null |
output_type |
string| null |
pk |
integer |
plugin |
string| null |
progress |
integer(int64) |
template_name |
string| null |
total |
integer(int64) |
user |
integer| null |
user_detail |
DefaultLocation¶
| Name | Type |
|---|---|
name |
string |
pathstring |
string |
pk |
integer |
DirectionEnum¶
Type: string
DuplicatePart¶
| Name | Type |
|---|---|
copy_bom |
boolean |
copy_image |
boolean |
copy_notes |
boolean |
copy_parameters |
boolean |
copy_tests |
boolean |
part |
integer |
EmailMessage¶
| Name | Type |
|---|---|
body |
string |
delivery_options |
|
direction |
|
error_code |
string| null |
error_message |
string| null |
error_timestamp |
string(date-time)| null |
full_message |
string| null |
global_id |
string(uuid) |
headers |
|
message_id_key |
string| null |
pk |
string(uuid) |
priority |
|
sender |
string(email) |
status |
|
subject |
string |
thread |
string(uuid)| null |
thread_id_key |
string| null |
timestamp |
string(date-time) |
to |
string(email) |
EmailMessageStatusEnum¶
Type: string
ErrorMessage¶
| Name | Type |
|---|---|
data |
string| null |
info |
string |
path |
string(uri)| null |
pk |
integer |
when |
string(date-time) |
Flag¶
| Name | Type |
|---|---|
conditions |
Array<> |
key |
string |
state |
string |
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_number |
string| null |
GenericStateClass¶
| Name | Type |
|---|---|
status_class |
string |
values |
GenericStateValue¶
| Name | Type |
|---|---|
color |
string |
custom |
boolean |
key |
integer |
label |
string |
logical_key |
string |
name |
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 |
ImportParameter¶
| Name | Type |
|---|---|
name |
string |
on_category |
boolean |
parameter_template |
integer| null |
value |
string |
ImportRequest¶
| Name | Type |
|---|---|
category_id |
integer| null |
part_id |
integer| null |
part_import_id |
string |
plugin |
string |
supplier |
string |
ImportResult¶
| Name | Type |
|---|---|
manufacturer_part_id |
integer |
parameters |
Array<ImportParameter> |
part_detail |
Part |
part_id |
integer |
pricing |
Array<Array<number(double)>> |
supplier_part_id |
integer |
InfoApi¶
| Name | Type |
|---|---|
active_plugins |
|
apiVersion |
integer |
customize |
|
database |
string |
debug_mode |
boolean |
default_locale |
string |
django_admin |
string |
docker_mode |
boolean |
email_configured |
boolean |
id |
string| null |
installer |
string |
instance |
string |
platform |
string |
plugins_enabled |
boolean |
plugins_install_disabled |
boolean |
server |
string |
settings |
|
system_health |
boolean |
target |
string| null |
version |
string |
worker_count |
integer |
worker_pending_tasks |
integer |
worker_running |
boolean |
InitialStock¶
| Name | Type |
|---|---|
location |
integer| null |
quantity |
string(decimal) |
InitialSupplier¶
| Name | Type |
|---|---|
manufacturer |
integer| null |
mpn |
string |
sku |
string |
supplier |
integer| null |
LicenseView¶
| Name | Type |
|---|---|
backend |
Array<> |
frontend |
Array<> |
Link¶
| Name | Type |
|---|---|
app |
string(uri) |
bug |
string(uri) |
code |
string(uri) |
doc |
string(uri) |
LocatePlugin¶
| Name | Type |
|---|---|
item |
integer |
location |
integer |
plugin |
string |
Metadata¶
| Name | Type |
|---|---|
metadata |
ModelType98eEnum¶
Type: string
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(int64)| 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 |
NullEnum¶
Type:
Owner¶
| Name | Type |
|---|---|
label |
string |
name |
string |
owner_id |
integer(int64)| null |
owner_model |
string |
pk |
integer |
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> |
PaginatedDataOutputList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<DataOutput> |
PaginatedEmailMessageList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<EmailMessage> |
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> |
PaginatedParameterList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<Parameter> |
PaginatedParameterTemplateList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ParameterTemplate> |
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> |
Parameter¶
| Name | Type |
|---|---|
data |
string |
data_numeric |
number(double)| null |
model_id |
integer(int64) |
model_type |
|
note |
string |
pk |
integer |
template |
integer |
template_detail |
|
updated |
string(date-time)| null |
updated_by |
integer| null |
updated_by_detail |
ParameterTemplate¶
| Name | Type |
|---|---|
checkbox |
boolean |
choices |
string |
description |
string |
enabled |
boolean |
model_type |
|
name |
string |
pk |
integer |
selectionlist |
integer| null |
units |
string |
Part¶
| Name | Type |
|---|---|
active |
boolean |
allocated_to_build_orders |
number(double)| null |
allocated_to_sales_orders |
number(double)| null |
assembly |
boolean |
barcode_hash |
string |
building |
number(double)| null |
category |
integer| null |
category_default_location |
integer| null |
category_detail |
|
category_name |
string |
category_path |
Array<> |
component |
boolean |
copy_category_parameters |
boolean |
creation_date |
string(date)| null |
creation_user |
integer| null |
default_expiry |
integer(int64) |
default_location |
integer| null |
default_location_detail |
|
default_supplier |
integer| null |
description |
string |
duplicate |
|
existing_image |
string |
external_stock |
number(double)| null |
full_name |
string |
image |
string(uri)| null |
in_stock |
number(double)| null |
initial_stock |
|
initial_supplier |
|
IPN |
string |
is_template |
boolean |
keywords |
string| null |
link |
string(uri)| null |
locked |
boolean |
minimum_stock |
number(double) |
name |
string |
notes |
string| null |
ordering |
number(double)| null |
parameters |
Array<Parameter> |
pk |
integer |
price_breaks |
Array<PartSalePrice> |
pricing_max |
string(decimal)| null |
pricing_min |
string(decimal)| null |
pricing_updated |
string(date-time)| null |
purchaseable |
boolean |
remote_image |
string(uri) |
required_for_build_orders |
integer| null |
required_for_sales_orders |
integer| null |
responsible |
integer| null |
revision |
string| null |
revision_count |
integer| null |
revision_of |
integer| null |
salable |
boolean |
scheduled_to_build |
number(double)| null |
starred |
boolean |
stock_item_count |
integer| null |
tags |
Array<string> |
testable |
boolean |
thumbnail |
string |
total_in_stock |
number(double)| null |
trackable |
boolean |
unallocated_stock |
number(double)| null |
units |
string| null |
variant_of |
integer| null |
variant_stock |
number(double)| null |
virtual |
boolean |
PartSalePrice¶
| Name | Type |
|---|---|
part |
integer |
pk |
integer |
price |
string(decimal)| null |
price_currency |
string |
quantity |
number(double) |
PatchedAttachment¶
| Name | Type |
|---|---|
attachment |
string(uri)| null |
comment |
string |
file_size |
integer |
filename |
string |
link |
string(uri)| null |
model_id |
integer(int64) |
model_type |
AttachmentModelTypeEnum |
pk |
integer |
tags |
Array<string> |
upload_date |
string(date) |
upload_user |
integer| null |
user_detail |
PatchedCustomState¶
| Name | Type |
|---|---|
color |
|
key |
integer(int64) |
label |
string |
logical_key |
integer(int64) |
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) |
update_records |
boolean |
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 |
PatchedParameter¶
| Name | Type |
|---|---|
data |
string |
data_numeric |
number(double)| null |
model_id |
integer(int64) |
model_type |
|
note |
string |
pk |
integer |
template |
integer |
template_detail |
|
updated |
string(date-time)| null |
updated_by |
integer| null |
updated_by_detail |
PatchedParameterTemplate¶
| Name | Type |
|---|---|
checkbox |
boolean |
choices |
string |
description |
string |
enabled |
boolean |
model_type |
|
name |
string |
pk |
integer |
selectionlist |
integer| null |
units |
string |
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 |
PriorityEnum¶
Type: integer
ProjectCode¶
| Name | Type |
|---|---|
code |
string |
description |
string |
pk |
integer |
responsible |
integer| null |
responsible_detail |
ReferenceStatusEnum¶
Type: string
SearchResult¶
| Name | Type |
|---|---|
description |
string |
exact |
boolean |
existing_part_id |
integer| null |
id |
string |
image_url |
string |
link |
string |
name |
string |
price |
string |
sku |
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 |
Settings¶
| Name | Type |
|---|---|
password_forgotten_enabled |
boolean |
registration_enabled |
boolean |
sso_registration |
boolean |
SupplierList¶
| Name | Type |
|---|---|
plugin_slug |
string |
supplier_name |
string |
supplier_slug |
string |
TestEmail¶
| Name | Type |
|---|---|
email |
string(email) |
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| null |
commit_date |
string |
commit_hash |
string |
django |
string |
python |
string |
server |
string |
VersionInformation¶
| Name | Type |
|---|---|
date |
string(date) |
gh |
string| null |
latest |
boolean |
text |
Array<string> |
version |
string |
VersionView¶
| Name | Type |
|---|---|
dev |
boolean |
links |
Link |
up_to_date |
boolean |
version |
Version |
Common responses¶
This section describes common responses that are reused across operations.
allauth.AddAuthenticatorConflict¶
The account prohibits adding an authenticator, e.g. because of an unverified email address.
Schema of the response body
null
allauth.AddWebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.\n",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data",
"meta"
],
"type": "object"
}
allauth.Authenticated¶
The user is authenticated.
Schema of the response body
null
allauth.AuthenticatedByCode¶
Authenticated by code.
{
"summary": "Authenticated by code.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "code"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPassword¶
Authenticated by password.
{
"summary": "Authenticated by password.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPasswordAnd2FA¶
Authenticated by password and 2FA.
{
"summary": "Fully authenticated using by password and 2FA.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.Authentication¶
Not authenticated.
{
"summary": "Reauthentication required\n",
"value": {
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
}
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending 2FA\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "mfa_authenticate",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending email verification\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "verify_email",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending provider signup\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "provider_signup",
"is_pending": true,
"provider": {
"client_id": "123.apps.googleusercontent.com",
"flows": [
"provider_redirect",
"provider_token"
],
"id": "google",
"name": "Google"
}
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.AuthenticationOrReauthentication¶
The response indicates authentication or re-authentication is required.
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/allauth.AuthenticationResponse"
},
{
"$ref": "#/components/schemas/allauth.ReauthenticationResponse"
}
]
}
allauth.Authenticators¶
List of authenticators.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.AuthenticatorList"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.Configuration¶
The django-allauth configuration.
Schema of the response body
null
allauth.EmailAddresses¶
List of email addresses.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.EmailVerificationInfo¶
Email verification information.
Schema of the response body
null
allauth.Error¶
An input error occurred.
Schema of the response body
null
allauth.Forbidden¶
A forbidden response.
Schema of the response body
null
allauth.NotFound¶
Not found.
{
"status": 0
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.PasswordResetInfo¶
Information about the password reset key.
{
"data": {
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.PhoneNumbers¶
List of phone numbers.
Schema of the response body
null
allauth.ProviderAccounts¶
List of third-party provider accounts.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ProviderSignup¶
Information relating to the pending provider signup.
{
"data": {
"account": null,
"email": [
null
],
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"account": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"email": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"required": [
"email",
"account",
"user"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ReauthenticationRequired¶
The response indicates reauthentication is required.
{
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
Schema of the response body
null
allauth.RecoveryCodes¶
Information on the recovery codes.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.SensitiveRecoveryCodesAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.RefreshToken¶
A new access token (and optionally new refresh token).
{
"data": {
"access_token": null,
"refresh_token": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"access_token": {
"$ref": "#/components/schemas/allauth.AccessToken"
},
"refresh_token": {
"$ref": "#/components/schemas/allauth.RefreshToken"
}
},
"required": [
"access_token"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"data",
"status"
],
"type": "object"
}
allauth.SessionGone¶
The response indicates session is invalid or no longer exists.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.Sessions¶
List of sessions.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.Session"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.StatusOK¶
A success response.
{
"status": null
}
Schema of the response body
{
"properties": {
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.TOTPAuthenticator¶
Information on the TOTP authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.TOTPAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.TOTPAuthenticatorNotFound¶
No TOTP authenticator has been set up.
{
"meta": {
"secret": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"totp_url": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example"
},
"status": 0
}
Schema of the response body
{
"properties": {
"meta": {
"properties": {
"secret": {
"description": "A TOTP secret that can be used to setup a new authenticator.\n",
"example": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"type": "string"
},
"totp_url": {
"description": "otpauth URI from which a QR code can be generated and scanned by OTP clients.\n",
"example": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example",
"type": "string"
}
},
"required": [
"secret",
"totp_url"
],
"type": "object"
},
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status",
"meta"
],
"type": "object"
}
allauth.TooManyRequests¶
Too many requests.
{
"status": 0
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
429
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.Unauthenticated¶
There is no authenticated session.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.WebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnCreationOptionsResponse¶
WebAuthn credential creation options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialCreationOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnRequestOptionsResponse¶
WebAuthn credential request options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialRequestOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
Common parameters¶
This section describes common parameters that are reused across operations.
allauth.EmailVerificationKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Email-Verification-Key |
header | string | No |
allauth.PasswordLess¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
passwordless |
query | boolean | No |
allauth.PasswordResetKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Password-Reset-Key |
header | string | No |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| oauth2 | oauth2 | ||
| 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