Backend resource · STATIC DECLARATIONS

Product Knowledge API reference · mansoq-core

Static source contract for Product Knowledge: 9 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Declared route and availability

This resource is declared in mansoq-core at /api/v1/product_knowledge/. verified core mount in config/urls.py A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

Method	Path	Action	Evidence
GET	`/api/v1/product_knowledge/`	list	declared/inherited method
POST	`/api/v1/product_knowledge/`	create	declared/inherited method
GET	`/api/v1/product_knowledge/{slug}/`	retrieve	declared/inherited method
PUT	`/api/v1/product_knowledge/{slug}/`	update	declared/inherited method
PATCH	`/api/v1/product_knowledge/{slug}/`	partial_update	declared/inherited method
GET	`/api/v1/product_knowledge/favorite_lists/`	favorite_lists	@action declaration
POST	`/api/v1/product_knowledge/{slug}/add_favorite/`	add_favorite	@action declaration
POST	`/api/v1/product_knowledge/{slug}/remove_favorite/`	remove_favorite	@action declaration
POST	`/api/v1/product_knowledge/upsert/`	upsert	@action declaration

list · GET

GET /api/v1/product_knowledge/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`category`	not declared at read site	not established
query	`facility`	not declared at read site	direct indexing; validation may be upstream
query	`include_instance`	not declared at read site	not established
query	`include_children`	not declared at read site	not established

response: ProductKnowledgeReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field	Type	Required	Constraints
meta	dict	false	No extra constraint extracted
id	UUID4 \| None	false	No extra constraint extracted
alternate_identifier	str \| None	false	No extra constraint extracted
status	ProductKnowledgeStatusOptions	true	No extra constraint extracted
product_type	ProductTypeOptions	true	No extra constraint extracted
code	Coding \| None	false	No extra constraint extracted
base_unit	ValueSetBoundCoding[MANSOQ_UCUM_UNITS.slug]	true	No extra constraint extracted
name	str	true	No extra constraint extracted
names	list[ProductName] \| None	false	No extra constraint extracted
storage_guidelines	list[StorageGuideline] \| None	false	No extra constraint extracted
definitional	ProductDefinitionSpec \| None	false	No extra constraint extracted
is_instance_level	bool	true	No extra constraint extracted
category	dict \| None	false	No extra constraint extracted
slug_config	dict	true	No extra constraint extracted
slug	str	true	No extra constraint extracted
identifier_type	str \| None	false	No extra constraint extracted
public_price	Decimal \| None	false	No extra constraint extracted
price_currency	str	false	No extra constraint extracted

Observed authorization checks: can_list_facility_product_knowledge. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read product knowledge.

create · POST

POST /api/v1/product_knowledge/ — action create. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`category`	not declared at read site	not established
query	`facility`	not declared at read site	direct indexing; validation may be upstream
query	`include_instance`	not declared at read site	not established
query	`include_children`	not declared at read site	not established

request: ProductKnowledgeWriteSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field	Type	Required	Constraints
meta	dict	false	No extra constraint extracted
id	UUID4 \| None	false	No extra constraint extracted
alternate_identifier	str \| None	false	No extra constraint extracted
status	ProductKnowledgeStatusOptions	true	No extra constraint extracted
product_type	ProductTypeOptions	true	No extra constraint extracted
code	Coding \| None	false	No extra constraint extracted
base_unit	ValueSetBoundCoding[MANSOQ_UCUM_UNITS.slug]	true	No extra constraint extracted
name	str	true	No extra constraint extracted
names	list[ProductName] \| None	false	No extra constraint extracted
storage_guidelines	list[StorageGuideline] \| None	false	No extra constraint extracted
definitional	ProductDefinitionSpec \| None	false	No extra constraint extracted
category	str \| None	false	No extra constraint extracted
slug_value	SlugType	true	No extra constraint extracted
facility	UUID4 \| None	false	No extra constraint extracted

response: ProductKnowledgeReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: can_list_facility_product_knowledge, can_write_facility_product_knowledge. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read product knowledge; PermissionDenied: Cannot create product knowledge; ValidationError: Slug already exists..

retrieve · GET

GET /api/v1/product_knowledge/{slug}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	slug	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`category`	not declared at read site	not established
query	`facility`	not declared at read site	direct indexing; validation may be upstream
query	`include_instance`	not declared at read site	not established
query	`include_children`	not declared at read site	not established

response: ProductKnowledgeReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: can_list_facility_product_knowledge. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read product knowledge.

update · PUT

PUT /api/v1/product_knowledge/{slug}/ — action update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	slug	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`category`	not declared at read site	not established
query	`facility`	not declared at read site	direct indexing; validation may be upstream
query	`include_instance`	not declared at read site	not established
query	`include_children`	not declared at read site	not established

request: ProductKnowledgeUpdateSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field	Type	Required	Constraints
meta	dict	false	No extra constraint extracted
id	UUID4 \| None	false	No extra constraint extracted
alternate_identifier	str \| None	false	No extra constraint extracted
status	ProductKnowledgeStatusOptions	true	No extra constraint extracted
product_type	ProductTypeOptions	true	No extra constraint extracted
code	Coding \| None	false	No extra constraint extracted
base_unit	ValueSetBoundCoding[MANSOQ_UCUM_UNITS.slug]	true	No extra constraint extracted
name	str	true	No extra constraint extracted
names	list[ProductName] \| None	false	No extra constraint extracted
storage_guidelines	list[StorageGuideline] \| None	false	No extra constraint extracted
definitional	ProductDefinitionSpec \| None	false	No extra constraint extracted
category	str \| None	false	No extra constraint extracted
slug_value	SlugType	true	No extra constraint extracted

response: ProductKnowledgeReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: can_list_facility_product_knowledge, can_write_facility_product_knowledge. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read product knowledge; PermissionDenied: Cannot update product knowledge; ValidationError: Slug already exists..

partial_update · PATCH

PATCH /api/v1/product_knowledge/{slug}/ — action partial_update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	slug	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`category`	not declared at read site	not established
query	`facility`	not declared at read site	direct indexing; validation may be upstream
query	`include_instance`	not declared at read site	not established
query	`include_children`	not declared at read site	not established

request: ProductKnowledgeUpdateSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

response: ProductKnowledgeReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: can_list_facility_product_knowledge, can_write_facility_product_knowledge. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read product knowledge; ValidationError: Slug already exists.; PermissionDenied: Cannot update product knowledge.

favorite_lists · GET

GET /api/v1/product_knowledge/favorite_lists/ — action favorite_lists. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`facility`	not declared at read site	direct indexing; validation may be upstream
query	`category`	not declared at read site	not established
query	`include_instance`	not declared at read site	not established
query	`include_children`	not declared at read site	not established

Observed authorization checks: can_list_facility_product_knowledge. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read product knowledge.

add_favorite · POST

POST /api/v1/product_knowledge/{slug}/add_favorite/ — action add_favorite. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	slug	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`category`	not declared at read site	not established
query	`facility`	not declared at read site	direct indexing; validation may be upstream
query	`include_instance`	not declared at read site	not established
query	`include_children`	not declared at read site	not established

Observed authorization checks: can_list_facility_product_knowledge. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read product knowledge.

remove_favorite · POST

POST /api/v1/product_knowledge/{slug}/remove_favorite/ — action remove_favorite. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	slug	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`category`	not declared at read site	not established
query	`facility`	not declared at read site	direct indexing; validation may be upstream
query	`include_instance`	not declared at read site	not established
query	`include_children`	not declared at read site	not established

Observed authorization checks: can_list_facility_product_knowledge. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Favorite List not found; PermissionDenied: Cannot read product knowledge.

upsert · POST

POST /api/v1/product_knowledge/upsert/ — action upsert. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
body	`datapoints`	not declared at read site	not established
query	`category`	not declared at read site	not established
query	`facility`	not declared at read site	direct indexing; validation may be upstream
query	`include_instance`	not declared at read site	not established
query	`include_children`	not declared at read site	not established

Observed authorization checks: can_list_facility_product_knowledge, can_write_facility_product_knowledge. Helper/queryset evidence is included; this is not proof of complete security review.

Explicit response statuses in observed code: 400. Other branches/framework exception handling may differ.

Declared refusal/error evidence: RestFrameworkValidationError: Invalid request data; RestFrameworkValidationError: No datapoints provided; RestFrameworkValidationError: Too many datapoints provided; PermissionDenied: Cannot read product knowledge; ValidationError: Slug already exists.; PermissionDenied: Cannot update product knowledge; PermissionDenied: Cannot create product knowledge.

Conditional gates: conditional/computed expression; inspect pinned declaration comparison settings.MAX_DATAPOINTS_PER_UPSERT.

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.

Pinned source evidence

Links require access to the private source repository.