The Report Generation section of the InvenTree API schema is documented below.
InvenTree API 196¶
API for InvenTree - the intuitive open source inventory management system
Servers¶
Description | URL |
---|---|
http://localhost:8000 | http://localhost:8000 |
report¶
GET /api/report/asset/¶
Description
API endpoint for listing ReportAsset objects.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"asset": "string",
"description": "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/ReportAsset"
},
"type": "array"
}
},
"type": "object"
}
POST /api/report/asset/¶
Description
API endpoint for listing ReportAsset 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
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the request body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"asset",
"description",
"pk"
],
"type": "object"
}
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the request body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"asset",
"description",
"pk"
],
"type": "object"
}
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the request body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"asset",
"description",
"pk"
],
"type": "object"
}
Response 201 Created
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the response body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"asset",
"description",
"pk"
],
"type": "object"
}
DELETE /api/report/asset/{id}/¶
Description
API endpoint for a single ReportAsset 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/report/asset/{id}/¶
Description
API endpoint for a single ReportAsset 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
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the response body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"asset",
"description",
"pk"
],
"type": "object"
}
PATCH /api/report/asset/{id}/¶
Description
API endpoint for a single ReportAsset 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
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the request body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the request body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the request body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
Response 200 OK
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the response body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"asset",
"description",
"pk"
],
"type": "object"
}
PUT /api/report/asset/{id}/¶
Description
API endpoint for a single ReportAsset 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
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the request body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"asset",
"description",
"pk"
],
"type": "object"
}
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the request body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"asset",
"description",
"pk"
],
"type": "object"
}
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the request body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"asset",
"description",
"pk"
],
"type": "object"
}
Response 200 OK
{
"asset": "string",
"description": "string",
"pk": 0
}
Schema of the response body
{
"description": "Serializer class for the ReportAsset model.",
"properties": {
"asset": {
"format": "uri",
"type": "string"
},
"description": {
"description": "Asset file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"asset",
"description",
"pk"
],
"type": "object"
}
GET /api/report/bom/¶
Description
API endpoint for viewing a list of BillOfMaterialReport objects.
Filterably by:
- enabled: Filter by enabled / disabled status
- part: Filter by part(s)
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" |
enabled |
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. | |
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": [
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "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/BOMReport"
},
"type": "array"
}
},
"type": "object"
}
POST /api/report/bom/¶
Description
API endpoint for viewing a list of BillOfMaterialReport objects.
Filterably by:
- enabled: Filter by enabled / disabled status
- part: Filter by part(s)
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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 201 Created
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
DELETE /api/report/bom/{id}/¶
Description
API endpoint for a single BillOfMaterialReport 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/report/bom/{id}/¶
Description
API endpoint for a single BillOfMaterialReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PATCH /api/report/bom/{id}/¶
Description
API endpoint for a single BillOfMaterialReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PUT /api/report/bom/{id}/¶
Description
API endpoint for a single BillOfMaterialReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/bom/{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/report/bom/{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/report/bom/{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"
}
GET /api/report/bom/{id}/print/¶
Description
Default implementation of GET for a print endpoint.
Note that it expects the class has defined a get_items() method
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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the BillOfMaterialsReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Part query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Part Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/build/¶
Description
API endpoint for viewing a list of BuildReport objects.
Can be filtered by:
- enabled: Filter by enabled / disabled status
- build: Filter by Build 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" |
enabled |
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. | |
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": [
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "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/BuildReport"
},
"type": "array"
}
},
"type": "object"
}
POST /api/report/build/¶
Description
API endpoint for viewing a list of BuildReport objects.
Can be filtered by:
- enabled: Filter by enabled / disabled status
- build: Filter by Build 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" |
Request body
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 201 Created
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
DELETE /api/report/build/{id}/¶
Description
API endpoint for a single BuildReport 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/report/build/{id}/¶
Description
API endpoint for a single BuildReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PATCH /api/report/build/{id}/¶
Description
API endpoint for a single BuildReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PUT /api/report/build/{id}/¶
Description
API endpoint for a single BuildReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/build/{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/report/build/{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/report/build/{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"
}
GET /api/report/build/{id}/print/¶
Description
Default implementation of GET for a print endpoint.
Note that it expects the class has defined a get_items() method
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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the BuildReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Build query filters (comma-separated list of key=value pairs",
"maxLength": 250,
"title": "Build Filters",
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/po/¶
Description
API list endpoint for the PurchaseOrderReport 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" |
enabled |
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. | |
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": [
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "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/PurchaseOrderReport"
},
"type": "array"
}
},
"type": "object"
}
POST /api/report/po/¶
Description
API list endpoint for the PurchaseOrderReport 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" |
Request body
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 201 Created
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
DELETE /api/report/po/{id}/¶
Description
API endpoint for a single PurchaseOrderReport 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/report/po/{id}/¶
Description
API endpoint for a single PurchaseOrderReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PATCH /api/report/po/{id}/¶
Description
API endpoint for a single PurchaseOrderReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PUT /api/report/po/{id}/¶
Description
API endpoint for a single PurchaseOrderReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/po/{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/report/po/{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/report/po/{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"
}
GET /api/report/po/{id}/print/¶
Description
Default implementation of GET for a print endpoint.
Note that it expects the class has defined a get_items() method
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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrdeReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Purchase order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/ro/¶
Description
API list endpoint for the ReturnOrderReport 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" |
enabled |
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. | |
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": [
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "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/ReturnOrderReport"
},
"type": "array"
}
},
"type": "object"
}
POST /api/report/ro/¶
Description
API list endpoint for the ReturnOrderReport 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" |
Request body
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 201 Created
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
DELETE /api/report/ro/{id}/¶
Description
API endpoint for a single ReturnOrderReport 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/report/ro/{id}/¶
Description
API endpoint for a single ReturnOrderReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PATCH /api/report/ro/{id}/¶
Description
API endpoint for a single ReturnOrderReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PUT /api/report/ro/{id}/¶
Description
API endpoint for a single ReturnOrderReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/ro/{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/report/ro/{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/report/ro/{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"
}
GET /api/report/ro/{id}/print/¶
Description
Default implementation of GET for a print endpoint.
Note that it expects the class has defined a get_items() method
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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the ReturnOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Return order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/slr/¶
Description
API list endpoint for the StockLocationReportList 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" |
enabled |
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. | |
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": [
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "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/StockLocationReport"
},
"type": "array"
}
},
"type": "object"
}
POST /api/report/slr/¶
Description
API list endpoint for the StockLocationReportList 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" |
Request body
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 201 Created
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
DELETE /api/report/slr/{id}/¶
Description
API endpoint for a single StockLocationReportDetail 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/report/slr/{id}/¶
Description
API endpoint for a single StockLocationReportDetail 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PATCH /api/report/slr/{id}/¶
Description
API endpoint for a single StockLocationReportDetail 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PUT /api/report/slr/{id}/¶
Description
API endpoint for a single StockLocationReportDetail 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/slr/{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/report/slr/{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/report/slr/{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"
}
GET /api/report/slr/{id}/print/¶
Description
Default implementation of GET for a print endpoint.
Note that it expects the class has defined a get_items() method
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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the StockLocationReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "stock location query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/snippet/¶
Description
API endpoint for listing ReportSnippet objects.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"description": "string",
"pk": 0,
"snippet": "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/ReportSnippet"
},
"type": "array"
}
},
"type": "object"
}
POST /api/report/snippet/¶
Description
API endpoint for listing ReportSnippet 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
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"pk",
"snippet"
],
"type": "object"
}
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"pk",
"snippet"
],
"type": "object"
}
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"pk",
"snippet"
],
"type": "object"
}
Response 201 Created
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the response body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"pk",
"snippet"
],
"type": "object"
}
DELETE /api/report/snippet/{id}/¶
Description
API endpoint for a single ReportSnippet 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/report/snippet/{id}/¶
Description
API endpoint for a single ReportSnippet 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
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the response body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"pk",
"snippet"
],
"type": "object"
}
PATCH /api/report/snippet/{id}/¶
Description
API endpoint for a single ReportSnippet 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
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the response body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"pk",
"snippet"
],
"type": "object"
}
PUT /api/report/snippet/{id}/¶
Description
API endpoint for a single ReportSnippet 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
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"pk",
"snippet"
],
"type": "object"
}
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"pk",
"snippet"
],
"type": "object"
}
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the request body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"pk",
"snippet"
],
"type": "object"
}
Response 200 OK
{
"description": "string",
"pk": 0,
"snippet": "string"
}
Schema of the response body
{
"description": "Serializer class for the ReportSnippet model.",
"properties": {
"description": {
"description": "Snippet file description",
"maxLength": 250,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"snippet": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"pk",
"snippet"
],
"type": "object"
}
GET /api/report/so/¶
Description
API list endpoint for the SalesOrderReport 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" |
enabled |
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. | |
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": [
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "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/SalesOrderReport"
},
"type": "array"
}
},
"type": "object"
}
POST /api/report/so/¶
Description
API list endpoint for the SalesOrderReport 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" |
Request body
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 201 Created
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
DELETE /api/report/so/{id}/¶
Description
API endpoint for a single SalesOrderReport 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/report/so/{id}/¶
Description
API endpoint for a single SalesOrderReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PATCH /api/report/so/{id}/¶
Description
API endpoint for a single SalesOrderReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PUT /api/report/so/{id}/¶
Description
API endpoint for a single SalesOrderReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/so/{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/report/so/{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/report/so/{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"
}
GET /api/report/so/{id}/print/¶
Description
Default implementation of GET for a print endpoint.
Note that it expects the class has defined a get_items() method
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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the SalesOrderReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "Sales order query filters",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/test/¶
Description
API endpoint for viewing list of TestReport objects.
Filterable by:
- enabled: Filter by enabled / disabled status
- item: Filter by stock item(s)
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" |
enabled |
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. | |
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": [
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "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/TestReport"
},
"type": "array"
}
},
"type": "object"
}
POST /api/report/test/¶
Description
API endpoint for viewing list of TestReport objects.
Filterable by:
- enabled: Filter by enabled / disabled status
- item: Filter by stock item(s)
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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 201 Created
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
DELETE /api/report/test/{id}/¶
Description
API endpoint for a single TestReport 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/report/test/{id}/¶
Description
API endpoint for a single TestReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PATCH /api/report/test/{id}/¶
Description
API endpoint for a single TestReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
PUT /api/report/test/{id}/¶
Description
API endpoint for a single TestReport 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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the request body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
GET /api/report/test/{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/report/test/{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/report/test/{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"
}
GET /api/report/test/{id}/print/¶
Description
Default implementation of GET for a print endpoint.
Note that it expects the class has defined a get_items() method
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
{
"description": "string",
"enabled": true,
"filters": "string",
"landscape": true,
"name": "string",
"page_size": null,
"pk": 0,
"template": "string"
}
Schema of the response body
{
"description": "Serializer class for the TestReport model.",
"properties": {
"description": {
"description": "Report template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Report template is enabled",
"type": "boolean"
},
"filters": {
"description": "StockItem query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"landscape": {
"description": "Render report in landscape orientation",
"type": "boolean"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"page_size": {
"allOf": [
{
"$ref": "#/components/schemas/PageSizeEnum"
}
],
"description": "Page size for PDF reports\n\n* `A4` - A4\n* `A3` - A3\n* `Legal` - Legal\n* `Letter` - Letter"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
}
},
"required": [
"description",
"name",
"pk",
"template"
],
"type": "object"
}
Schemas¶
BOMReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
BuildReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
Metadata¶
Name | Type |
---|---|
metadata |
PageSizeEnum¶
Type: string
PaginatedBOMReportList¶
Name | Type |
---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<BOMReport> |
PaginatedBuildReportList¶
Name | Type |
---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<BuildReport> |
PaginatedPurchaseOrderReportList¶
Name | Type |
---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PurchaseOrderReport> |
PaginatedReportAssetList¶
Name | Type |
---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ReportAsset> |
PaginatedReportSnippetList¶
Name | Type |
---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ReportSnippet> |
PaginatedReturnOrderReportList¶
Name | Type |
---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ReturnOrderReport> |
PaginatedSalesOrderReportList¶
Name | Type |
---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<SalesOrderReport> |
PaginatedStockLocationReportList¶
Name | Type |
---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<StockLocationReport> |
PaginatedTestReportList¶
Name | Type |
---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<TestReport> |
PatchedBOMReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
PatchedBuildReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
PatchedMetadata¶
Name | Type |
---|---|
metadata |
PatchedPurchaseOrderReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
PatchedReportAsset¶
Name | Type |
---|---|
asset |
string(uri) |
description |
string |
pk |
integer |
PatchedReportSnippet¶
Name | Type |
---|---|
description |
string |
pk |
integer |
snippet |
string(uri) |
PatchedReturnOrderReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
PatchedSalesOrderReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
PatchedStockLocationReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
PatchedTestReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
PurchaseOrderReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
ReportAsset¶
Name | Type |
---|---|
asset |
string(uri) |
description |
string |
pk |
integer |
ReportSnippet¶
Name | Type |
---|---|
description |
string |
pk |
integer |
snippet |
string(uri) |
ReturnOrderReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
SalesOrderReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
StockLocationReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
TestReport¶
Name | Type |
---|---|
description |
string |
enabled |
boolean |
filters |
string |
landscape |
boolean |
name |
string |
page_size |
|
pk |
integer |
template |
string(uri) |
Security schemes¶
Name | Type | Scheme | Description |
---|---|---|---|
basicAuth | http | basic | |
cookieAuth | apiKey | ||
tokenAuth | apiKey | Token-based authentication with required prefix "Token" |
More documentation¶
More information about InvenTree in the official docs