Referanse: Asset API

Creates a listing when the asset has none (201) and updates one when it does (200). Requires write:assets and publish:marketplace.

The asking price is indicative — prisantydning, not a committed sale price; the settled price is agreed as an offer in sirk-service-backend. An absent price means 'price on request', which is a valid listed state.

The listing location is the seller's chosen pickup or viewing site, separate from the asset's own location (which the public passport never discloses). Send its name and coordinates alongside the id — they are stored as a snapshot and never resolved against orgadmin. Without coordinates the listing is still valid but is absent from map- and bounds-filtered marketplace queries.

Three location cases, and the difference matters: omitting the block publishes the asset's own location; sending a block publishes exactly what it carries (the id is optional — a name and coordinates alone are a valid pickup site); and 'deleteFields': ['location'] publishes no pickup location at all, for an object whose delivery address is agreed in the offer instead. Sending 'location': null is NOT a clear — it parses the same as an omitted block and falls back to the asset's own location, so a client clearing the field must say so with deleteFields. Sending both the block and the clear is a 400. 'location' is the only clearable field.

Listing does NOT publish the Digital Product Passport and does not require publish:dpp: the two are separate publications under separate permissions.

Parametre

Forespørselskropp *

• application/json — UpsertListingDto

Svar

The reason is required and is what the event log records: WITHDRAWN writes a DELIST event, SOLD writes a SOLD event carrying the asking price and, when supplied, the settled price. There is no SOLD status — a sale is a moment, and in the good case it is an ownership transfer to another tenant, which delists automatically.

Idempotent: delisting something already unlisted succeeds and records nothing.

Parametre

Forespørselskropp *

• application/json — DelistDto

Svar

A reserved listing stays publicly visible, badged with its end date — a hold nobody can see is not a hold. The holding party is optional and may be a tenant or free text: a project reserving an object months ahead need not be an organization here.

Requires write:assets only. Placing a hold edits an offer this organization has already published; it is not a second act of publishing.

Parametre

Forespørselskropp *

• application/json — CreateReservationDto

Svar

Returns the object to available without touching its price or location. An order-driven hold is released by the order that placed it, named through reservationRef; the owning organization may override with force=true, which the RELEASE event records. Idempotent when nothing is held.

Parametre

Svar

The filters are optional and can be combined. Categories and locations are referenced by orgadmin category id (Long); pass repeated query params for multi-select (?categoryIds=42&categoryIds=87). Subtree expansion is the frontend's job — pass the full id list (see docs/V2_API_GUIDE.md §5). A list too long for a query string (~45 ids, since global class ids are ~17 characters) goes to POST /asset/search instead. With batchId, the listing (and its count) also includes members of the batch that the caller's organization deleted after they joined it, so a completed round keeps every point it had. A deleted member is listed with deleted: true and still answers 404 on GET /asset/{id}. CSV and PDF exports leave deleted members out. Assets can be exported as csv ('Accept' header 'application/octet-stream') or pdf ('Accept' header 'application/pdf'), where the pdf export will be QR codes for the assets' tags

Parametre

Svar

Optional events are recorded against the new asset, in array order, in the same transaction as the create, under the same rules as POST /asset/{id}/events (max 10). The response echoes them as events, in order.

Parametre

Forespørselskropp *

• application/json — CreateAssetDto

Svar

Parametre

Forespørselskropp *

• application/json — AssetMultiEditDto

Svar

Parametre

Svar

CLAIMABLE when the tag is allocated to this organization and unclaimed; CLAIMED with its assetId when this organization claimed it; UNAVAILABLE for everything else. Every negative case answers identically on purpose — tag ids are enumerable, so distinguishing "does not exist" from "belongs to someone else" would map out which codes are live and who holds them.

Parametre

Svar

Same body as POST /asset. Succeeds only when the tag is allocated to the current organization, unclaimed, and its run is not voided. With no events, the asset is created PROVISIONED and activates on first write exactly like any other, so claiming itself is not billable activity. Optional events are recorded against the new asset, in array order, in the same transaction, under the same rules as POST /asset/{id}/events (max 10); the response echoes them as events, in order. A claim carrying events ends COMMISSIONED with one ACTIVATE event and can no longer be unclaimed with DELETE /asset/claim/{tag}, which requires PROVISIONED.

Parametre

Forespørselskropp *

• application/json — CreateAssetDto

Svar

Allowed while the asset is still PROVISIONED, has no documents, and the claim is younger than the configured window. Soft-deletes the asset and returns the tag to its allocation. An ordinary DELETE /asset/{id} does not release the tag — the label is on an object by then.

Parametre

Svar

Returns a flat list of { id, state, count } entries, where count is the number of items (the sum of quantity, so a lot of 50 counts 50), keyed by whichever of `id` and `state` `by` selects — the other is null. For `by=category` and `by=location`, `id` is the categoryId or locationCategoryId; for `by=state` the key is the AssetState name. Buckets with no matching assets are omitted, as is the unassigned (null) location bucket. `by=state` does keep its null bucket: every asset has exactly one state, so those buckets sum to the total number of matching items, and only do so with the stateless assets among them. Backend is hierarchy-blind — frontend rolls counts up against the taxonomy tree. For `by=category`, an asset tagged with N categories contributes its quantity to each of those N buckets, so the sum of counts may exceed the total matching item count. The pagination headers of GET /asset stay row counts (assets, not items). With batchId, the batch's members deleted by the caller's organization after joining it are counted, as in GET /asset.

Parametre

Svar

Parametre

Forespørselskropp *

• multipart/form-data — object

Svar

Identical in behaviour and response to GET /asset — including the X-page-total and X-entries-total headers — but the filter travels as JSON, so it is not limited by query-string length. Use it when the expanded id list is too large for a URL (see docs/V2_API_GUIDE.md §5); GET /asset remains the right call for ordinary filters. Subtree expansion is still the frontend's job: pass the full id list. With batchId, the batch's members deleted by the caller's organization after joining it are included, as in GET /asset (rows marked deleted: true).

Parametre

Forespørselskropp *

• application/json — AssetSearchRequestDto

Svar

Counts are items (the sum of quantity), not asset rows. newAssetsPerMonth sums the current quantity of the assets activated in each month, so it is retroactive: changing a lot's quantity later moves the month it was activated in.

Parametre

Svar

Parametre

Svar

Parametre

Forespørselskropp *

• application/json — UpdateAssetDto

Svar

Parametre

Svar

Decreases the lot {id} by quantity and records the link on both assets: a CONSUME event on the lot and an INCORPORATE event on the target (read them via GET /event). The lot and the target must both belong to the current organization (X-auth-owner), where write:assets is required; any other case gives 404. The target is not modified. When quantity equals the lot's quantity the lot is deleted as by DELETE /asset/{id} (open listing withdrawn, DELETE event with reason CONSUMED) and the response has remainingQuantity 0 and sourceDeleted true. 400 (error-message header): target is the lot, quantity below 1 or above the lot's, note over 500 characters. 409: the asset (quantity 1) is reserved, or the lot changed concurrently (retry).

Parametre

Forespørselskropp *

• application/json — ConsumeFromLotDto

Svar

Parametre

Forespørselskropp *

• multipart/form-data — object

Svar

Parametre

Forespørselskropp *

• application/json — UpdateDocumentDto

Svar

Parametre

Svar

Parametre

Forespørselskropp *

• multipart/form-data — object

Svar

Adds a user-authored event (e.g. a completed service, control round or note) to the asset's activity log. Read it back via GET /event?type=ASSET&id={id}. The kind is one of AssetEventType; specifics belong in the free-text note. Optional documentIds must already be attached to this asset (POST /asset/{id}/documents). Optional occurredAt/performedBy/location describe when the thing actually happened, by whom and where -- distinct from the event's own timestamp, which is always the server clock at the moment it was recorded, never occurredAt. Optional co2eKg is kilograms of CO2 equivalent attributed to this event; must be zero or greater and finite. Optional co2eReference (max 200 characters) is an opaque caller reference identifying the calculation or record co2eKg came from, e.g. reinventar:order:123:line:2 -- never parsed, resolved or otherwise interpreted by this service. There is no separate report endpoint for the figure's supporting document: upload it via POST /asset/{id}/documents with documentType: DOCUMENT, then pass the returned document id in this event's documentIds. Optional checklist records a control point's checklist visit; requires manualType INSPECTION. Its template is validated (version 1, CHECK items only, unique keys, 1-100 items), every required template item must be answered, each item's documentIds must already be attached to this asset, and resolution is not supported here. answeredBy/answeredAt on each item are server-stamped (client values ignored); the event's result is derived as DEVIATION iff any item is DEVIATION -- a supplied result must agree. Stored verbatim as data.checklist. Requires write:assets; allowed cross-tenant wherever the asset is visible to the caller.

Parametre

Forespørselskropp *

• application/json — CreateAssetEventDto

Svar

Returns a set of all batches

Parametre

Svar

If 'numberOfNewAssets' is set, type is set to ASSET_CREATION and 'assetIds' is ignored

Parametre

Forespørselskropp *

• application/json — CreateBatchDto

Svar

Parametre

Svar

Parametre

Svar

Parametre

Forespørselskropp *

• application/json — BatchMultiEditDto

Svar

Parametre

Forespørselskropp *

• application/json — UpdateBatchDto

Svar

Svar

Svar

Svar

Svar

Svar

Svar

Parametre

Svar

Parametre

Forespørselskropp *

• application/json — UserPreferencesDto

Svar

Svar

The 'states' query param is a comma separated list of DeviationState (OPEN, CLOSED); 'batchGuid' filters on the originating batch (e.g. a control round); 'assetId' on the anchoring asset; 'checkKey' on the checklist check the deviation was raised from (keys are only unique within one asset's template, so combine it with 'assetId' for a per-check history).

Parametre

Svar

A follow-up record for a fault found on an asset. Anchored on the asset ('assetId'); 'batchGuid' optionally references the batch (e.g. control round) it was found in. Creator and timestamp are server-derived. Optional documentIds must already be attached to the asset. Optional checkKey names the check this deviation was found from: it requires batchGuid, must match ^[a-z0-9][a-z0-9_-]{0,63}$, and must be a key of the template on the latest ASSET/MANUAL checklist visit on this asset in that batch, else 400. Fixed at creation; not settable on update. Audited via the event log (GET /event?type=DEVIATION&id={id}).

Parametre

Forespørselskropp *

• application/json — CreateDeviationDto

Svar

Parametre

Svar

Enrichment of correctiveAction, dueDate and responsible. A CLOSED deviation is immutable and rejects updates with 400.

Parametre

Forespørselskropp *

• application/json — UpdateDeviationDto

Svar

Records the closing user id and timestamp as the auditable signature; the deviation is immutable afterwards. Closing an already CLOSED deviation is rejected with 400.

Parametre

Forespørselskropp *

• application/json — CloseDeviationDto

Svar

Parametre

Svar

Anonymous and cross-tenant: no JWT, no X-auth-owner. Returns only listings a tenant explicitly published, excluding discarded and deleted assets and anything outside the queried channel.

Pagination follows the solutions marketplace rather than this backend's house style — pageNumber/pageSize (max 100), a flat array, and the match count in X-Total-Count — so the marketplace frontend consumes both the same way. Ordered by listedAt descending with an id tiebreak, so paging is stable.

categoryMatch=DESCENDANTS expands each global taxonomy id to its subtree server-side; an organization-specific id is always matched exactly, because it means nothing to another tenant. A bounding box needs all four coordinates, and a listing whose location carries none is absent from a bounded result. status defaults to AVAILABLE; an elapsed reservation reads as AVAILABLE whether or not the sweep has run. UNLISTED is not a queryable status.

The asking price is indicative and is per item; quantity is the number of items on offer, and a reservation or sale takes the whole lot. askingPriceMin and askingPriceMax filter on the price per item. A listing with no price is returned with a null amount ('price on request') and matches neither price bound.

Parametre

Svar

Anonymous and cross-tenant like the list, and bounded by the same rule: only a listing a tenant published, on the queried channel, whose asset is neither discarded nor deleted.

A held object is served — its status reads RESERVED and carries the end date, never the party holding it — because the list's AVAILABLE default is a browsing convenience, not a rule about what may be read.

A listing that was withdrawn and one that never existed answer the same 404, so ids cannot be walked to discover what a tenant has not published.

Parametre

Svar

One entry per organization owning at least one asset, document or activation event. 'stored' is current inventory in items (the sum of quantity) regardless of range; 'handled.asset' counts activation events (one per lot) and has one zero-filled bucket per month in the range. Figures may be up to the cache TTL old — see the Cache-Control header.

Parametre

Svar

Svar

Creates `quantity` tags belonging to a new run, none attached to an asset and none allocated. Between 1 and 5000. Records one TAG/CREATE event for the run, not one per tag.

Forespørselskropp *

• application/json — MintRunDto

Svar

Parametre

Svar

Give the range as fromTag+toTag or fromTag+count. Resolved run-relative in id order, never by id arithmetic. All-or-nothing on conflict; re-applying an identical allocation is a no-op, not an error. With `?dryRun=true` the range is resolved and validated exactly as a real allocation — same 400s, same 409s, same body — but nothing is written and no event is recorded, so an operator can check the resolved end code against the stack of labels in their hand before committing. The resolution is advisory: the commit re-validates, and an allocation landing in between still fails it with a 409. The flag takes `true` or `false` and nothing else — any other value is a 400, not a commit — and the answer echoes `dryRun` so a caller can tell the two apart.

Parametre

Forespørselskropp *

• application/json — AllocateRangeDto

Svar

The reversal for an allocation to the wrong organization. Same range forms as the allocation. Refused if any tag in the range has been claimed, or is allocated to a different organization than the one given. All-or-nothing.

Parametre

Forespørselskropp *

• application/json — AllocateRangeDto

Svar

Unclaimed tags become unclaimable and unallocatable. Already-claimed tags are unaffected — they are on objects in use. Idempotent.

Parametre

Svar

Which run, which organization, whether claimed, whether voided — the answer to "this code doesn't work". Carries no asset content.

Parametre

Svar

Parametre

Svar

Parametre

Forespørselskropp *

• application/json — GrantWarrantyDto

Svar