The General API Endpoints section of the InvenTree API schema is documented below.
InvenTree API 264¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
action¶
POST /api/action/¶
Description
This function checks if all required info was submitted and then performs a plugin_action or returns an error.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"action": "string",
"data": {}
}
Schema of the request body
{
"description": "Serializer for the ActionPluginView responses.",
"properties": {
"action": {
"type": "string"
},
"data": {
"additionalProperties": {},
"type": "object"
}
},
"required": [
"action",
"data"
],
"type": "object"
}
{
"action": "string",
"data": {}
}
Schema of the request body
{
"description": "Serializer for the ActionPluginView responses.",
"properties": {
"action": {
"type": "string"
},
"data": {
"additionalProperties": {},
"type": "object"
}
},
"required": [
"action",
"data"
],
"type": "object"
}
{
"action": "string",
"data": {}
}
Schema of the request body
{
"description": "Serializer for the ActionPluginView responses.",
"properties": {
"action": {
"type": "string"
},
"data": {
"additionalProperties": {},
"type": "object"
}
},
"required": [
"action",
"data"
],
"type": "object"
}
Response 200 OK
{
"action": "string",
"data": {}
}
Schema of the response body
{
"description": "Serializer for the ActionPluginView responses.",
"properties": {
"action": {
"type": "string"
},
"data": {
"additionalProperties": {},
"type": "object"
}
},
"required": [
"action",
"data"
],
"type": "object"
}
admin¶
GET /api/admin/config/¶
Description
List view for all accessed configurations.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
GET /api/admin/config/{key}/¶
Description
Detail view for an individual configuration.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
key |
path | string | No |
Response 200 OK
attachment¶
DELETE /api/attachment/¶
Description
Perform a DELETE operation against this list endpoint.
We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/attachment/¶
Description
List API endpoint for Attachment objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
is_file |
query | boolean | No | Is File | |
is_link |
query | boolean | No | Is Link | |
limit |
query | integer | No | Number of results to return per page. | |
model_id |
query | integer | No | ||
model_type |
query | string | No | ||
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. | |
upload_user |
query | integer | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Attachment"
},
"type": "array"
}
},
"type": "object"
}
POST /api/attachment/¶
Description
List API endpoint for Attachment objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
Response 201 Created
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
DELETE /api/attachment/{id}/¶
Description
Detail API endpoint for Attachment objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/attachment/{id}/¶
Description
Detail API endpoint for Attachment objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
PATCH /api/attachment/{id}/¶
Description
Detail API endpoint for Attachment objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
PUT /api/attachment/{id}/¶
Description
Detail API endpoint for Attachment objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
Response 200 OK
{
"attachment": "string",
"comment": "string",
"file_size": 0,
"filename": "string",
"link": "string",
"model_id": 0,
"model_type": "build",
"pk": 0,
"tags": [
"string"
],
"upload_date": "2022-04-13",
"upload_user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer class for the Attachment model.",
"properties": {
"attachment": {
"format": "uri",
"nullable": true,
"type": "string"
},
"comment": {
"description": "Attachment comment",
"maxLength": 250,
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"readOnly": true,
"type": "integer"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"model_id": {
"type": "integer"
},
"model_type": {
"$ref": "#/components/schemas/AttachmentModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"upload_user": {
"description": "User",
"nullable": true,
"readOnly": true,
"title": "User",
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"file_size",
"model_id",
"model_type",
"pk",
"upload_date",
"upload_user",
"user_detail"
],
"type": "object"
}
GET /api/attachment/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/attachment/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/attachment/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
contenttype¶
GET /api/contenttype/¶
Description
List view for ContentTypes.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"app_label": "string",
"app_labeled_name": "string",
"is_plugin": true,
"model": "string",
"pk": 0
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ContentType"
},
"type": "array"
}
},
"type": "object"
}
GET /api/contenttype/model/{model}/¶
Description
Detail view for a ContentType model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
model |
path | string | No |
Response 200 OK
{
"app_label": "string",
"app_labeled_name": "string",
"is_plugin": true,
"model": "string",
"pk": 0
}
Schema of the response body
{
"description": "Serializer for ContentType models.",
"properties": {
"app_label": {
"readOnly": true,
"type": "string"
},
"app_labeled_name": {
"readOnly": true,
"type": "string"
},
"is_plugin": {
"description": "Return True if the model is a plugin model.",
"readOnly": true,
"type": "boolean"
},
"model": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"type": "integer"
}
},
"required": [
"app_label",
"app_labeled_name",
"is_plugin",
"model",
"pk"
],
"type": "object"
}
GET /api/contenttype/{id}/¶
Description
Detail view for a ContentType model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"app_label": "string",
"app_labeled_name": "string",
"is_plugin": true,
"model": "string",
"pk": 0
}
Schema of the response body
{
"description": "Serializer for ContentType models.",
"properties": {
"app_label": {
"readOnly": true,
"type": "string"
},
"app_labeled_name": {
"readOnly": true,
"type": "string"
},
"is_plugin": {
"description": "Return True if the model is a plugin model.",
"readOnly": true,
"type": "boolean"
},
"model": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"type": "integer"
}
},
"required": [
"app_label",
"app_labeled_name",
"is_plugin",
"model",
"pk"
],
"type": "object"
}
currency¶
GET /api/currency/exchange/¶
Description
Return information on available currency conversions.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
{
"base_currency": "string",
"exchange_rates": {},
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "Serializer for a Currency Exchange request.\n\nIt's only purpose is describing the results correctly in the API schema right now.",
"properties": {
"base_currency": {
"readOnly": true,
"type": "string"
},
"exchange_rates": {
"additionalProperties": {
"format": "double",
"type": "number"
},
"type": "object"
},
"updated": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"base_currency",
"exchange_rates",
"updated"
],
"type": "object"
}
POST /api/currency/refresh/¶
Description
Performing a POST request will update currency exchange rates.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
email¶
POST /api/email/generate/¶
Description
Get the token for the current user or fail.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"email": "string"
}
Schema of the request body
{
"description": "Serializer for the simple login view.",
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
{
"email": "string"
}
Schema of the request body
{
"description": "Serializer for the simple login view.",
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
{
"email": "string"
}
Schema of the request body
{
"description": "Serializer for the simple login view.",
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
Response 200 OK
{
"email": "string"
}
Schema of the response body
{
"description": "Serializer for the simple login view.",
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
}
error-report¶
DELETE /api/error-report/¶
Description
Perform a DELETE operation against this list endpoint.
We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/error-report/¶
Description
List view for server error messages.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ErrorMessage"
},
"type": "array"
}
},
"type": "object"
}
DELETE /api/error-report/{id}/¶
Description
Detail view for a single error message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/error-report/{id}/¶
Description
Detail view for a single error message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
PATCH /api/error-report/{id}/¶
Description
Detail view for a single error message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
PUT /api/error-report/{id}/¶
Description
Detail view for a single error message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
Response 200 OK
{
"data": "string",
"info": "string",
"path": "string",
"pk": 0,
"when": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "DRF serializer for server error messages.",
"properties": {
"data": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"info": {
"readOnly": true,
"type": "string"
},
"path": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"when": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"data",
"info",
"path",
"pk",
"when"
],
"type": "object"
}
flags¶
GET /api/flags/¶
Description
List view for feature flags.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
GET /api/flags/{key}/¶
Description
Detail view for an individual feature flag.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
key |
path | string | No |
Response 200 OK
generate¶
POST /api/generate/batch-code/¶
Description
Generate a new batch code.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"batch_code": "string",
"build_order": 0,
"item": 0,
"location": 0,
"part": 0,
"purchase_order": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for generating a batch code.\n\nAny of the provided write-only fields can be used for additional context.",
"properties": {
"batch_code": {
"description": "Generated batch code",
"readOnly": true,
"type": "string"
},
"build_order": {
"description": "Select build order",
"nullable": true,
"type": "integer"
},
"item": {
"description": "Select stock item to generate batch code for",
"nullable": true,
"title": "Stock Item",
"type": "integer"
},
"location": {
"description": "Select location to generate batch code for",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Select part to generate batch code for",
"nullable": true,
"type": "integer"
},
"purchase_order": {
"description": "Select purchase order",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for batch code",
"format": "double",
"nullable": true,
"type": "number"
}
},
"required": [
"batch_code"
],
"type": "object"
}
{
"batch_code": "string",
"build_order": 0,
"item": 0,
"location": 0,
"part": 0,
"purchase_order": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for generating a batch code.\n\nAny of the provided write-only fields can be used for additional context.",
"properties": {
"batch_code": {
"description": "Generated batch code",
"readOnly": true,
"type": "string"
},
"build_order": {
"description": "Select build order",
"nullable": true,
"type": "integer"
},
"item": {
"description": "Select stock item to generate batch code for",
"nullable": true,
"title": "Stock Item",
"type": "integer"
},
"location": {
"description": "Select location to generate batch code for",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Select part to generate batch code for",
"nullable": true,
"type": "integer"
},
"purchase_order": {
"description": "Select purchase order",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for batch code",
"format": "double",
"nullable": true,
"type": "number"
}
},
"required": [
"batch_code"
],
"type": "object"
}
{
"batch_code": "string",
"build_order": 0,
"item": 0,
"location": 0,
"part": 0,
"purchase_order": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for generating a batch code.\n\nAny of the provided write-only fields can be used for additional context.",
"properties": {
"batch_code": {
"description": "Generated batch code",
"readOnly": true,
"type": "string"
},
"build_order": {
"description": "Select build order",
"nullable": true,
"type": "integer"
},
"item": {
"description": "Select stock item to generate batch code for",
"nullable": true,
"title": "Stock Item",
"type": "integer"
},
"location": {
"description": "Select location to generate batch code for",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Select part to generate batch code for",
"nullable": true,
"type": "integer"
},
"purchase_order": {
"description": "Select purchase order",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for batch code",
"format": "double",
"nullable": true,
"type": "number"
}
},
"required": [
"batch_code"
],
"type": "object"
}
Response 200 OK
{
"batch_code": "string",
"build_order": 0,
"item": 0,
"location": 0,
"part": 0,
"purchase_order": 0,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for generating a batch code.\n\nAny of the provided write-only fields can be used for additional context.",
"properties": {
"batch_code": {
"description": "Generated batch code",
"readOnly": true,
"type": "string"
},
"build_order": {
"description": "Select build order",
"nullable": true,
"type": "integer"
},
"item": {
"description": "Select stock item to generate batch code for",
"nullable": true,
"title": "Stock Item",
"type": "integer"
},
"location": {
"description": "Select location to generate batch code for",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Select part to generate batch code for",
"nullable": true,
"type": "integer"
},
"purchase_order": {
"description": "Select purchase order",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for batch code",
"format": "double",
"nullable": true,
"type": "number"
}
},
"required": [
"batch_code"
],
"type": "object"
}
POST /api/generate/serial-number/¶
Description
Generate a new serial number.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"part": 0,
"quantity": 0,
"serial": "string"
}
Schema of the request body
{
"description": "Serializer for generating one or multiple serial numbers.\n\nAny of the provided write-only fields can be used for additional context.\n\nNote that in the case where multiple serial numbers are required,\nthe \"serial\" field will return a string with multiple serial numbers separated by a comma.",
"properties": {
"part": {
"description": "Select part to generate serial number for",
"nullable": true,
"type": "integer"
},
"quantity": {
"default": 1,
"description": "Quantity of serial numbers to generate",
"type": "integer"
},
"serial": {
"description": "Generated serial number",
"readOnly": true,
"title": "Serial Number",
"type": "string"
}
},
"required": [
"serial"
],
"type": "object"
}
{
"part": 0,
"quantity": 0,
"serial": "string"
}
Schema of the request body
{
"description": "Serializer for generating one or multiple serial numbers.\n\nAny of the provided write-only fields can be used for additional context.\n\nNote that in the case where multiple serial numbers are required,\nthe \"serial\" field will return a string with multiple serial numbers separated by a comma.",
"properties": {
"part": {
"description": "Select part to generate serial number for",
"nullable": true,
"type": "integer"
},
"quantity": {
"default": 1,
"description": "Quantity of serial numbers to generate",
"type": "integer"
},
"serial": {
"description": "Generated serial number",
"readOnly": true,
"title": "Serial Number",
"type": "string"
}
},
"required": [
"serial"
],
"type": "object"
}
{
"part": 0,
"quantity": 0,
"serial": "string"
}
Schema of the request body
{
"description": "Serializer for generating one or multiple serial numbers.\n\nAny of the provided write-only fields can be used for additional context.\n\nNote that in the case where multiple serial numbers are required,\nthe \"serial\" field will return a string with multiple serial numbers separated by a comma.",
"properties": {
"part": {
"description": "Select part to generate serial number for",
"nullable": true,
"type": "integer"
},
"quantity": {
"default": 1,
"description": "Quantity of serial numbers to generate",
"type": "integer"
},
"serial": {
"description": "Generated serial number",
"readOnly": true,
"title": "Serial Number",
"type": "string"
}
},
"required": [
"serial"
],
"type": "object"
}
Response 200 OK
{
"part": 0,
"quantity": 0,
"serial": "string"
}
Schema of the response body
{
"description": "Serializer for generating one or multiple serial numbers.\n\nAny of the provided write-only fields can be used for additional context.\n\nNote that in the case where multiple serial numbers are required,\nthe \"serial\" field will return a string with multiple serial numbers separated by a comma.",
"properties": {
"part": {
"description": "Select part to generate serial number for",
"nullable": true,
"type": "integer"
},
"quantity": {
"default": 1,
"description": "Quantity of serial numbers to generate",
"type": "integer"
},
"serial": {
"description": "Generated serial number",
"readOnly": true,
"title": "Serial Number",
"type": "string"
}
},
"required": [
"serial"
],
"type": "object"
}
generic¶
GET /api/generic/status/¶
Description
Perform a GET request to learn information about status codes.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
GET /api/generic/status/custom/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/CustomState"
},
"type": "array"
}
},
"type": "object"
}
POST /api/generic/status/custom/¶
Description
List view for all custom states.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
Response 201 Created
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the response body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
DELETE /api/generic/status/custom/{id}/¶
Description
Detail view for a particular custom states.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/generic/status/custom/{id}/¶
Description
Detail view for a particular custom states.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the response body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
PATCH /api/generic/status/custom/{id}/¶
Description
Detail view for a particular custom states.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"type": "object"
}
Response 200 OK
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the response body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
PUT /api/generic/status/custom/{id}/¶
Description
Detail view for a particular custom states.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the request body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
Response 200 OK
{
"color": null,
"key": 0,
"label": "string",
"logical_key": 0,
"model": 0,
"model_name": "string",
"name": "string",
"pk": 0,
"reference_status": "BuildStatus"
}
Schema of the response body
{
"description": "Serializer for the custom state model.",
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/ColorEnum"
}
],
"description": "Color that will be displayed in the frontend\n\n* `primary` - primary\n* `secondary` - secondary\n* `success` - success\n* `danger` - danger\n* `warning` - warning\n* `info` - info\n* `dark` - dark"
},
"key": {
"description": "Value that will be saved in the models database",
"type": "integer"
},
"label": {
"description": "Label that will be displayed in the frontend",
"maxLength": 250,
"type": "string"
},
"logical_key": {
"description": "State logical key that is equal to this custom state in business logic",
"type": "integer"
},
"model": {
"description": "Model this state is associated with",
"nullable": true,
"type": "integer"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the state",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference_status": {
"$ref": "#/components/schemas/ReferenceStatusEnum"
}
},
"required": [
"key",
"label",
"logical_key",
"model",
"model_name",
"name",
"pk",
"reference_status"
],
"type": "object"
}
GET /api/generic/status/{statusmodel}/¶
Description
Retrieve information about a specific status code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
statusmodel |
path | string | No |
Response 200 OK
Response 400 Bad Request
icons¶
GET /api/icons/¶
Description
List view for available icon packages.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"fonts": {},
"icons": {},
"name": "string",
"prefix": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/IconPackage"
},
"type": "array"
}
},
"type": "object"
}
importer¶
GET /api/importer/column-mapping/¶
Description
API endpoint for accessing a list of DataImportColumnMap objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. | |
session |
query | integer | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"type": "array"
}
},
"type": "object"
}
GET /api/importer/column-mapping/{id}/¶
Description
Detail endpoint for a single DataImportColumnMap object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the response body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
PATCH /api/importer/column-mapping/{id}/¶
Description
Detail endpoint for a single DataImportColumnMap object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"type": "object"
}
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"type": "object"
}
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"type": "object"
}
Response 200 OK
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the response body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
PUT /api/importer/column-mapping/{id}/¶
Description
Detail endpoint for a single DataImportColumnMap object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the request body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
Response 200 OK
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
Schema of the response body
{
"description": "Serializer for the DataImportColumnMap model.",
"properties": {
"column": {
"maxLength": 100,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"field": {
"readOnly": true,
"type": "string"
},
"label": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
}
},
"required": [
"description",
"field",
"label",
"pk",
"session"
],
"type": "object"
}
GET /api/importer/models/¶
Description
Return a list of models available for import.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
DELETE /api/importer/row/¶
Description
Perform a DELETE operation against this list endpoint.
We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/importer/row/¶
Description
API endpoint for accessing a list of DataImportRow objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
complete |
query | boolean | No | ||
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. | |
session |
query | integer | No | ||
valid |
query | boolean | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/DataImportRow"
},
"type": "array"
}
},
"type": "object"
}
DELETE /api/importer/row/{id}/¶
Description
Detail endpoint for a single DataImportRow object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/importer/row/{id}/¶
Description
Detail endpoint for a single DataImportRow object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the response body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
PATCH /api/importer/row/{id}/¶
Description
Detail endpoint for a single DataImportRow object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
Response 200 OK
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the response body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
PUT /api/importer/row/{id}/¶
Description
Detail endpoint for a single DataImportRow object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
Response 200 OK
{
"complete": true,
"data": null,
"errors": null,
"pk": 0,
"row_data": null,
"row_index": 0,
"session": 0,
"valid": true
}
Schema of the response body
{
"description": "Serializer for the DataImportRow model.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"data": {
"nullable": true
},
"errors": {
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_data": {
"nullable": true,
"readOnly": true,
"title": "Original row data"
},
"row_index": {
"readOnly": true,
"type": "integer"
},
"session": {
"readOnly": true,
"title": "Import Session",
"type": "integer"
},
"valid": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"complete",
"errors",
"pk",
"row_data",
"row_index",
"session",
"valid"
],
"type": "object"
}
DELETE /api/importer/session/¶
Description
Perform a DELETE operation against this list endpoint.
We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/importer/session/¶
Description
API endpoint for accessing a list of DataImportSession objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
model_type |
query | string | No | ||
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. | |
status |
query | integer | No | Import status * `0` - Initializing * `10` - Mapping Columns * `20` - Importing Data * `30` - Processing Data * `40` - Complete | |
user |
query | integer | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/DataImportSession"
},
"type": "array"
}
},
"type": "object"
}
POST /api/importer/session/¶
Description
API endpoint for accessing a list of DataImportSession objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
Response 201 Created
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
DELETE /api/importer/session/{id}/¶
Description
Detail endpoint for a single DataImportSession object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/importer/session/{id}/¶
Description
Detail endpoint for a single DataImportSession object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
PATCH /api/importer/session/{id}/¶
Description
Detail endpoint for a single DataImportSession object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
PUT /api/importer/session/{id}/¶
Description
Detail endpoint for a single DataImportSession object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters": null,
"field_overrides": null,
"model_type": "partcategory",
"pk": 0,
"row_count": 0,
"status": null,
"timestamp": "2022-04-13T15:42:05.901Z",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the DataImportSession model.",
"properties": {
"available_fields": {
"readOnly": true
},
"column_mappings": {
"items": {
"$ref": "#/components/schemas/DataImportColumnMap"
},
"readOnly": true,
"type": "array"
},
"columns": {
"nullable": true,
"readOnly": true
},
"completed_row_count": {
"readOnly": true,
"type": "integer"
},
"data_file": {
"format": "uri",
"type": "string"
},
"field_defaults": {
"nullable": true
},
"field_filters": {
"nullable": true
},
"field_overrides": {
"nullable": true
},
"model_type": {
"$ref": "#/components/schemas/DataImportSessionModelTypeEnum"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"row_count": {
"readOnly": true,
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportSessionStatusEnum"
}
],
"description": "Import status\n\n* `0` - Initializing\n* `10` - Mapping Columns\n* `20` - Importing Data\n* `30` - Processing Data\n* `40` - Complete",
"readOnly": true
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"available_fields",
"column_mappings",
"columns",
"completed_row_count",
"data_file",
"model_type",
"pk",
"row_count",
"status",
"timestamp",
"user",
"user_detail"
],
"type": "object"
}
{
"available_fields": null,
"column_mappings": [
{
"column": "string",
"description": "string",
"field": "string",
"label": "string",
"pk": 0,
"session": 0
}
],
"columns": null,
"completed_row_count": 0,
"data_file": "string",
"field_defaults": null,
"field_filters":