ItemApiV11 Resource

Funktionalität rund um die Resource Artikel

Grundvoraussetzung für eine erfolgreiche Benutzung dieser Resource ist, dass der HELIUM V Mandant das Modul "Artikel" installiert hat. Für praktisch alle Zugriffe auf den Artikel muss der API Benutzer zumindest Leserechte auf den Artikel haben.

Änderungen in dieser Version

Die Lagerstände stockslist werden nun als typisiertes Ergebnis geliefert

GET /api/v11/item

Einen Artikel anhand seiner Artikelnummer ermitteln

Request Parameters
name type description constraints
addComments query (optional) mit true die Artikelkommentar der Art text/html ebenfalls liefern boolean
addStockAmountInfos query (optional) mit true die allgemeinen Lagerstandsinformationen liefern boolean
itemCnr query (optional) die gesuchte Artikelnummer  
itemSerialnumber query (optional) die Seriennummer des Artikels

Eineindeutige Artikel können über ihre Seriennummer ermittelt werden. Dabei wird zuerst im aktuellen Lagerstand gesucht, danach in den Abgangsbuchungen. Ist die cnr ebenfalls angegeben, muss der Artikel der über die Seriennummer ermittelt wurde mit der angegebenen Artikelnummer übereinstimmen.

  
userid query des bei HELIUM V angemeldeten API Benutzer  
Response Body
media type data type description
application/json ItemEntry (JSON) den Artikel sofern vorhanden. Gibt es den Artikel/Seriennummer nicht wird mit StatusCode NOT_FOUND (404) geantwortet
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "cnr" : "...",
  "description" : "...",
  "description2" : "...",
  "name" : "...",
  "shortName" : "...",
  "stockAmount" : 12345.0,
  "costs" : 12345.0,
  "billOfMaterialType" : "...",
  "available" : true,
  "comments" : [ "...", "..." ],
  "hidden" : true,
  "unitCnr" : "...",
  "typeCnr" : "...",
  "itemgroupCnr" : "...",
  "itemclassCnr" : "...",
  "revision" : "...",
  "stockAmountInfo" : {
    "stockAmount" : 12345.0,
    "reservedAmount" : 12345.0,
    "missingAmount" : 12345.0,
    "availableAmount" : 12345.0
  },
  "referenceNumber" : "...",
  "index" : "...",
  "preferredType" : "...",
  "customerItemCnr" : "...",
  "id" : 12345
}

GET /api/v11/item/grouplist

Eine Liste aller Artikelgruppen ermitteln

Diese Methode ist für die Verwendung in Listboxen/Comboboxen gedacht

Request Parameters
name type description
userid query des angemeldeten HELIUM V Benutzer
Response Body
media type data type description
application/json ItemGroupEntryList (JSON) eine (leere) Liste aller Artikelgruppen
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/grouplist
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "cnr" : "...",
    "description" : "...",
    "bookReturn" : true,
    "certificationRequired" : true,
    "parentId" : 12345,
    "id" : 12345
  }, {
    "cnr" : "...",
    "description" : "...",
    "bookReturn" : true,
    "certificationRequired" : true,
    "parentId" : 12345,
    "id" : 12345
  } ]
}

GET /api/v11/item/groups

Eine Liste aller Artikelgruppen ermitteln.

Request Parameters
name type description
userid query der angemeldete HELIUM V Benutzer
Response Body
media type data type description
application/json ItemGroupEntryList (JSON) eine (leere) Liste von Artikelgruppen
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/groups
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "cnr" : "...",
    "description" : "...",
    "bookReturn" : true,
    "certificationRequired" : true,
    "parentId" : 12345,
    "id" : 12345
  }, {
    "cnr" : "...",
    "description" : "...",
    "bookReturn" : true,
    "certificationRequired" : true,
    "parentId" : 12345,
    "id" : 12345
  } ]
}

GET /api/v11/item/itemslistmanufacturer

Liefert eine (leere) Liste aller Artikel die die angegebene Herstellernummer exakt enthalten

Es werden alle Artikel geliefert, die die angegebene Herstellernummer enthalten, egal um welchen Hersteller es sich handelt. Beginnt die hier angegebene Nummer mit einem bekannten (Barcode)Lead-In, wird dieser vor der Suche entfernt.

Request Parameters
name type description constraints
addComments query (optional) mit true die Artikelkommentar der Art text/html ebenfalls liefern boolean
addCommentsMedia query (optional) mit true die Infos über die Artikelkommentare liefern boolean
addDocuments query (optional) mit true die Infos über die vom angemeldeten Benutzer sichtbaren Dokumente aus der Dokumentenablage liefern boolean
addProducerInfos query (optional) mit true die herstellerspezifischen Infos (Artikelnummer, Bezeichnung des Herstellers, Leadin, ...) liefern boolean
addStockAmountInfos query (optional) mit true die allgemeinen Lagerstandsinformationen liefern boolean
addStockPlaceInfos query (optional) mit true die Infos der zugewiesenen Lagerplätze liefern boolean
manufacturerbarcode query die Herstellernummer  
userid query des angemeldeten HELIUM V Benutzers  
Response Body
media type data type description
application/json ItemV1EntryList (JSON) eine (leere) Liste jener Artikel, die in den Bestelldaten die Herstellernummer enthalten
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/itemslistmanufacturer
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "cnr" : "...",
    "description" : "...",
    "description2" : "...",
    "name" : "...",
    "shortName" : "...",
    "stockAmount" : 12345.0,
    "costs" : 12345.0,
    "billOfMaterialType" : "...",
    "available" : true,
    "comments" : [ "...", "..." ],
    "hidden" : true,
    "unitCnr" : "...",
    "typeCnr" : "...",
    "itemgroupCnr" : "...",
    "itemclassCnr" : "...",
    "revision" : "...",
    "stockAmountInfo" : {
      "stockAmount" : 12345.0,
      "reservedAmount" : 12345.0,
      "missingAmount" : 12345.0,
      "availableAmount" : 12345.0
    },
    "referenceNumber" : "...",
    "index" : "...",
    "hasSerialnr" : true,
    "hasChargenr" : true,
    "producerInfoEntry" : {
      "producerId" : 12345,
      "itemCnr" : "...",
      "itemDescription" : "...",
      "barcodeLeadIn" : "...",
      "hasInfo" : true
    },
    "packagingEntries" : {
      "entries" : [ { }, { } ]
    },
    "packagingAmount" : 12345.0,
    "batchSize" : 12345.0,
    "packagingAverageAmount" : 12345.0,
    "stockplaceInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "documentInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "itemCommentMediaInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "id" : 12345
  }, {
    "cnr" : "...",
    "description" : "...",
    "description2" : "...",
    "name" : "...",
    "shortName" : "...",
    "stockAmount" : 12345.0,
    "costs" : 12345.0,
    "billOfMaterialType" : "...",
    "available" : true,
    "comments" : [ "...", "..." ],
    "hidden" : true,
    "unitCnr" : "...",
    "typeCnr" : "...",
    "itemgroupCnr" : "...",
    "itemclassCnr" : "...",
    "revision" : "...",
    "stockAmountInfo" : {
      "stockAmount" : 12345.0,
      "reservedAmount" : 12345.0,
      "missingAmount" : 12345.0,
      "availableAmount" : 12345.0
    },
    "referenceNumber" : "...",
    "index" : "...",
    "hasSerialnr" : true,
    "hasChargenr" : true,
    "producerInfoEntry" : {
      "producerId" : 12345,
      "itemCnr" : "...",
      "itemDescription" : "...",
      "barcodeLeadIn" : "...",
      "hasInfo" : true
    },
    "packagingEntries" : {
      "entries" : [ { }, { } ]
    },
    "packagingAmount" : 12345.0,
    "batchSize" : 12345.0,
    "packagingAverageAmount" : 12345.0,
    "stockplaceInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "documentInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "itemCommentMediaInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "id" : 12345
  } ]
}

GET /api/v11/item/itemv1

Einen Artikel anhand seiner Artikelnummer ermitteln

Request Parameters
name type description constraints
addComments query (optional) mit true die Artikelkommentar der Art text/html ebenfalls liefern boolean
addCommentsMedia query (optional) mit true die Infos über die Artikelkommentare liefern boolean
addDocuments query (optional) mit true die Infos über die vom angemeldeten Benutzer sichtbaren Dokumente aus der Dokumentenablage liefern boolean
addProducerInfos query (optional) mit true die herstellerspezifischen Infos (Artikelnummer, Bezeichnung des Herstellers, Leadin, ...) liefern boolean
addStockAmountInfos query (optional) mit true die allgemeinen Lagerstandsinformationen liefern boolean
addStockPlaceInfos query (optional) mit true die Infos der zugewiesenen Lagerplätze liefern boolean
itemBarcode query (optional) der EAN / Barcode des Artikels
  
itemCnr query (optional) die gesuchte Artikelnummer  
itemSerialnumber query (optional) die Seriennummer des Artikels

Eineindeutige Artikel können über ihre Seriennummer ermittelt werden. Dabei wird zuerst im aktuellen Lagerstand gesucht, danach in den Abgangsbuchungen. Ist die cnr ebenfalls angegeben, muss der Artikel der über die Seriennummer ermittelt wurde mit der angegebenen Artikelnummer übereinstimmen.

  
userid query des bei HELIUM V angemeldeten API Benutzer  
Response Body
media type data type description
application/json ItemV1Entry (JSON) den Artikel sofern vorhanden. Gibt es den Artikel/Seriennummer nicht wird mit StatusCode NOT_FOUND (404) geantwortet
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/itemv1
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "cnr" : "...",
  "description" : "...",
  "description2" : "...",
  "name" : "...",
  "shortName" : "...",
  "stockAmount" : 12345.0,
  "costs" : 12345.0,
  "billOfMaterialType" : "...",
  "available" : true,
  "comments" : [ "...", "..." ],
  "hidden" : true,
  "unitCnr" : "...",
  "typeCnr" : "...",
  "itemgroupCnr" : "...",
  "itemclassCnr" : "...",
  "revision" : "...",
  "stockAmountInfo" : {
    "stockAmount" : 12345.0,
    "reservedAmount" : 12345.0,
    "missingAmount" : 12345.0,
    "availableAmount" : 12345.0
  },
  "referenceNumber" : "...",
  "index" : "...",
  "hasSerialnr" : true,
  "hasChargenr" : true,
  "producerInfoEntry" : {
    "producerId" : 12345,
    "itemCnr" : "...",
    "itemDescription" : "...",
    "barcodeLeadIn" : "...",
    "hasInfo" : true
  },
  "packagingEntries" : {
    "entries" : [ {
      "barcode" : "...",
      "amount" : 12345.0
    }, {
      "barcode" : "...",
      "amount" : 12345.0
    } ]
  },
  "packagingAmount" : 12345.0,
  "batchSize" : 12345.0,
  "packagingAverageAmount" : 12345.0,
  "stockplaceInfoEntries" : {
    "entries" : [ {
      "stockEntry" : { },
      "stockplaceEntries" : { }
    }, {
      "stockEntry" : { },
      "stockplaceEntries" : { }
    } ]
  },
  "documentInfoEntries" : {
    "entries" : [ {
      "name" : "...",
      "filename" : "...",
      "size" : 12345,
      "cnr" : "..."
    }, {
      "name" : "...",
      "filename" : "...",
      "size" : 12345,
      "cnr" : "..."
    } ]
  },
  "itemCommentMediaInfoEntries" : {
    "entries" : [ {
      "mimeType" : "IMAGEPNG",
      "iSort" : 12345,
      "commentType" : "...",
      "filename" : "...",
      "size" : 12345,
      "commentTypeDescription" : "...",
      "content" : "...",
      "id" : 12345
    }, {
      "mimeType" : "IMAGEJPEG",
      "iSort" : 12345,
      "commentType" : "...",
      "filename" : "...",
      "size" : 12345,
      "commentTypeDescription" : "...",
      "content" : "...",
      "id" : 12345
    } ]
  },
  "id" : 12345
}

GET /api/v11/item/list

Eine Liste aller Artikel ermitteln.

Das Ergebnis kann dabei durch Filter eingeschränkt werden

Request Parameters
name type description constraints
$orderby query definiert die Sortierung der Daten. Es können durch Komma getrennt mehrere Datenfelder angegeben werden. Getrennt durch Leerzeichen kann "asc" (aufsteigend) oder auch "desc" (absteigend) sortiert werden. "cnr desc" oder auch "cnr asc, customerItemCnr desc", oder auch "cnr, customerItemCnr desc"  
filter_cnr query die (optionale) Artikelnummer nach der die Suche eingeschränkt werden soll  
filter_customeritemcnr query die (optionale) Kundenartikelnummer nach der gesucht werden kann  
filter_deliverycnr query auf die (optionale) Lieferantennr. bzw Bezeichnung einschränken  
filter_itemgroupclass query auf die (optionale) Artikelgruppe bzw. Artikelklasse einschränken  
filter_itemgroupid query die (optionale) IId der Artikelgruppe in der die Artikel gesucht werden. Die cnr wird aus der angegebenen iid ermittelt und dann auch für die Artikelklasse verwendet int
filter_itemgroupids query  
filter_itemreferencenr query auf die (optionale) Artikelreferenznummer einschränken  
filter_textsearch query der (optionale) Text der die Suche einschränkt  
filter_withHidden query mit true werden auch versteckte Artikel in die Suche einbezogen boolean
limit query die maximale Anzahl von zurückgelieferten Datensätzen int
startIndex query die Index-Nummer desjenigen Satzes mit dem begonnen werden soll int
userid query des angemeldeten HELIUM V Benutzer  
Response Body
media type data type description
application/json ItemEntryList (JSON) eine (leere) Liste von ItemEntry
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/list
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "cnr" : "...",
    "description" : "...",
    "description2" : "...",
    "name" : "...",
    "shortName" : "...",
    "stockAmount" : 12345.0,
    "costs" : 12345.0,
    "billOfMaterialType" : "...",
    "available" : true,
    "comments" : [ "...", "..." ],
    "hidden" : true,
    "unitCnr" : "...",
    "typeCnr" : "...",
    "itemgroupCnr" : "...",
    "itemclassCnr" : "...",
    "revision" : "...",
    "stockAmountInfo" : {
      "stockAmount" : 12345.0,
      "reservedAmount" : 12345.0,
      "missingAmount" : 12345.0,
      "availableAmount" : 12345.0
    },
    "referenceNumber" : "...",
    "index" : "...",
    "preferredType" : "...",
    "customerItemCnr" : "...",
    "id" : 12345
  }, {
    "cnr" : "...",
    "description" : "...",
    "description2" : "...",
    "name" : "...",
    "shortName" : "...",
    "stockAmount" : 12345.0,
    "costs" : 12345.0,
    "billOfMaterialType" : "...",
    "available" : true,
    "comments" : [ "...", "..." ],
    "hidden" : true,
    "unitCnr" : "...",
    "typeCnr" : "...",
    "itemgroupCnr" : "...",
    "itemclassCnr" : "...",
    "revision" : "...",
    "stockAmountInfo" : {
      "stockAmount" : 12345.0,
      "reservedAmount" : 12345.0,
      "missingAmount" : 12345.0,
      "availableAmount" : 12345.0
    },
    "referenceNumber" : "...",
    "index" : "...",
    "preferredType" : "...",
    "customerItemCnr" : "...",
    "id" : 12345
  } ],
  "rowCount" : 12345
}

GET /api/v11/item/list

Eine Liste aller Artikel ermitteln.

Das Ergebnis kann dabei durch Filter eingeschränkt werden

Request Parameters
name type description constraints
filter_cnr query die (optionale) Artikelnummer nach der die Suche eingeschränkt werden soll  
filter_deliverycnr query auf die (optionale) Lieferantennr. bzw Bezeichnung einschränken  
filter_itemgroupclass query auf die (optionale) Artikelgruppe bzw. Artikelklasse einschränken  
filter_itemreferencenr query auf die (optionale) Artikelreferenznummer einschränken  
filter_textsearch query der (optionale) Text der die Suche einschränkt  
filter_withHidden query mit true werden auch versteckte Artikel in die Suche einbezogen boolean
limit query die maximale Anzahl von zurückgelieferten Datensätzen int
startIndex query die Index-Nummer desjenigen Satzes mit dem begonnen werden soll int
userid query des angemeldeten HELIUM V Benutzer  
Response Body
media type data type description
application/json array of ItemEntry (JSON) eine (leere) Liste von ItemEntry
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/list
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "cnr" : "...",
  "description" : "...",
  "description2" : "...",
  "name" : "...",
  "shortName" : "...",
  "stockAmount" : 12345.0,
  "costs" : 12345.0,
  "billOfMaterialType" : "...",
  "available" : true,
  "comments" : [ "...", "..." ],
  "hidden" : true,
  "unitCnr" : "...",
  "typeCnr" : "...",
  "itemgroupCnr" : "...",
  "itemclassCnr" : "...",
  "revision" : "...",
  "stockAmountInfo" : {
    "stockAmount" : 12345.0,
    "reservedAmount" : 12345.0,
    "missingAmount" : 12345.0,
    "availableAmount" : 12345.0
  },
  "referenceNumber" : "...",
  "index" : "...",
  "preferredType" : "...",
  "customerItemCnr" : "...",
  "id" : 12345
} ]

GET /api/v11/item/pricelist

Die Artikelpreisliste ermitteln

Abhängig vom Umfang der Artikel bzw. der Preisliste kann dieser Aufruf auch mehrere Sekunden oder sogar Minuten dauern. Die Rückgabe kann auch mehrere MB groß sein.

Request Parameters
name type description constraints
filter_itemclasscnr query optional nur Artikel mit dieser Artikelklassenummer  
filter_itemclassid query optional nur Artikel mit dieser ArtikelklassenId int
filter_itemgroupcnr query optional nur Artikel mit dieser Artikelgruppe selektieren  
filter_itemgroupid query optional nur Artikel mit dieser ArtikelgruppenId selektieren int
filter_shopgroupcnr query optional nur Artikel mit dieser Shopgruppekennung (oder Kindern dieser Shopgruppe) selektieren  
filter_shopgroupid query optional nur Artikel mit dieser ShopgruppenId (oder Kindern dieser ShopgruppenId) selektieren int
filter_start_itemcnr query optional nur Artikel ab dieser Artikelnummer  
filter_stop_itemcnr query optional nur Artikel bis (einschließlich) zu dieser Artikelnummer  
filter_validitydate query optional mit dem angebenen Preisgültigkeitsdatum im ISO8601 Format (Beispiel: JJJJ-MM-TT"T"hh:mm ... 2013-12-31T14:00Z oder 2013-12-31T14:59+01:00)  
filter_withHidden query mit true werden auch versteckte Artikel in die Preisliste aufgenommen boolean
pricelistCnr query wird die Preislistenkennung angegeben, wird der Preis entsprechend der Preisliste ausgegeben. Wird keine Kennung angegeben, wird die "Verkaufspreisbasis" des Artikels ausgegeben  
userid query ist der Token der durch die Anmeldung (login) erhalten wurde  
Response Body
media type data type description
application/json CustomerPricelistReportDto (JSON) die (leere) Liste aller Artikel entsprechend der Kriterien mit dem Preis
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/pricelist
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "withHidden" : true,
  "priceValidityMs" : 12345,
  "itemclass" : {
    "value" : "...",
    "id" : 12345
  },
  "itemgroup" : {
    "value" : "...",
    "id" : 12345
  },
  "shopgroup" : {
    "value" : "...",
    "id" : 12345
  },
  "onlyWebshopItems" : true,
  "itemRangeTo" : "...",
  "items" : [ {
    "name" : "...",
    "additionalName" : "...",
    "hidden" : true,
    "VATId" : 12345,
    "clientDescriptionDto" : {
      "additionalName2" : "...",
      "shortName" : "...",
      "additionalName" : "...",
      "name" : "..."
    },
    "shopgroupDto" : {
      "id" : 12345,
      "cnr" : "...",
      "name" : "..."
    },
    "specialCondition" : true,
    "itemKursMaterialzuschlag" : 12345.0,
    "itemMaterialgewicht" : 12345.0,
    "itemClass" : "...",
    "unit" : "...",
    "item" : {
      "value" : "...",
      "id" : 12345
    },
    "itemGroupDto" : {
      "value" : "...",
      "id" : 12345
    },
    "descriptionDto" : {
      "additionalName2" : "...",
      "shortName" : "...",
      "additionalName" : "...",
      "name" : "..."
    },
    "shortName" : "...",
    "additionalName2" : "...",
    "kundeartikelbezeichnung" : "...",
    "kundeartikelnummer" : "...",
    "prices" : [ {
      "basePrice" : 12345.0,
      "discountRate" : 12345.0,
      "pricetypKey" : "...",
      "amount" : 12345.0,
      "fixPrice" : 12345.0,
      "currency" : "...",
      "calculatedPrice" : 12345.0,
      "specialCondition" : true
    }, {
      "basePrice" : 12345.0,
      "discountRate" : 12345.0,
      "pricetypKey" : "...",
      "amount" : 12345.0,
      "fixPrice" : 12345.0,
      "currency" : "...",
      "calculatedPrice" : 12345.0,
      "specialCondition" : true
    } ],
    "itemGroup" : "...",
    "itemMaterial" : "..."
  }, {
    "name" : "...",
    "additionalName" : "...",
    "hidden" : true,
    "VATId" : 12345,
    "clientDescriptionDto" : {
      "additionalName2" : "...",
      "shortName" : "...",
      "additionalName" : "...",
      "name" : "..."
    },
    "shopgroupDto" : {
      "id" : 12345,
      "cnr" : "...",
      "name" : "..."
    },
    "specialCondition" : true,
    "itemKursMaterialzuschlag" : 12345.0,
    "itemMaterialgewicht" : 12345.0,
    "itemClass" : "...",
    "unit" : "...",
    "item" : {
      "value" : "...",
      "id" : 12345
    },
    "itemGroupDto" : {
      "value" : "...",
      "id" : 12345
    },
    "descriptionDto" : {
      "additionalName2" : "...",
      "shortName" : "...",
      "additionalName" : "...",
      "name" : "..."
    },
    "shortName" : "...",
    "additionalName2" : "...",
    "kundeartikelbezeichnung" : "...",
    "kundeartikelnummer" : "...",
    "prices" : [ {
      "basePrice" : 12345.0,
      "discountRate" : 12345.0,
      "pricetypKey" : "...",
      "amount" : 12345.0,
      "fixPrice" : 12345.0,
      "currency" : "...",
      "calculatedPrice" : 12345.0,
      "specialCondition" : true
    }, {
      "basePrice" : 12345.0,
      "discountRate" : 12345.0,
      "pricetypKey" : "...",
      "amount" : 12345.0,
      "fixPrice" : 12345.0,
      "currency" : "...",
      "calculatedPrice" : 12345.0,
      "specialCondition" : true
    } ],
    "itemGroup" : "...",
    "itemMaterial" : "..."
  } ],
  "customer" : {
    "value" : "...",
    "id" : 12345
  },
  "onlySpecialCondition" : true,
  "appliedQuantityScale" : true,
  "itemRangeFrom" : "...",
  "withBlocked" : true,
  "withClientLanguage" : true
}

GET /api/v11/item/pricelists

Eine (leere) Liste aller verfügbaren Preislisten

Request Parameters
name type description
userid query ist der Token der durch die Anmeldung (login) erhalten wurde
Response Body
media type data type description
application/json PriceListEntryList (JSON) eine (leere) Liste aller verfügbaren Preislisten
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/pricelists
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "cnr" : "...",
    "currency" : "...",
    "active" : true,
    "id" : 12345
  }, {
    "cnr" : "...",
    "currency" : "...",
    "active" : true,
    "id" : 12345
  } ],
  "rowCount" : 12345
}

GET /api/v11/item/properties

Eine Liste aller Artikeleigenschaften eines Artikels ermitteln

Request Parameters
name type description
itemCnr query die gewünschte Artikelnummer
userid query userId der angemeldete HELIUM V Benutzer
Response Body
media type data type description
application/json ItemPropertyEntryList (JSON) eine (leere) Liste von Artikeleigenschaften
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/properties
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "datatype" : "...",
    "content" : "...",
    "name" : "...",
    "mandatory" : true,
    "itemgroupId" : 12345,
    "layoutId" : 12345,
    "id" : 12345
  }, {
    "datatype" : "...",
    "content" : "...",
    "name" : "...",
    "mandatory" : true,
    "itemgroupId" : 12345,
    "layoutId" : 12345,
    "id" : 12345
  } ]
}

POST /api/v11/item/property

Erzeugt eine neue Eigenschaft eines Artikels über die Id der Beschreibung.
Ist zur Id der Beschreibung bereits eine entsprechende Eigenschaft existent, so wird mit StatusCode CONFLICT (409) geantwortet.
Eine Ausnahme bilden Eigenschaften, die mit ihrem Inhalt dem Defaultwert ihrer Beschreibung entsprechen. In diesem Fall wird diese Eigenschaft aktualisiert.

Request Parameters
name type description
userid query des angemeldeten HELIUM V Benutzers
Request Body
media type data type description
application/json CreateItemPropertyEntry (JSON) die Daten zur Anlage @see {#link CreateItemPropertyEntry
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json ItemPropertyEntry (JSON) die neu angelegte Eigenschaft
application/xml;charset=UTF-8 object

Example

Request
POST /api/v11/item/property
Content-Type: application/json
Accept: application/json

                
{
  "itemId" : 12345,
  "itemCnr" : "...",
  "layoutId" : 12345,
  "content" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "datatype" : "...",
  "content" : "...",
  "name" : "...",
  "mandatory" : true,
  "itemgroupId" : 12345,
  "layoutId" : 12345,
  "id" : 12345
}

PUT /api/v11/item/property

Aktualisiert die Daten einer Eigenschaft eines Artikels.
Die Eigenschaft muss bereits existieren, sonst wird mit StatusCode NOT_FOUND (404) geantwortet

Request Parameters
name type description
userid query des angemeldeten HELIUM V Benutzers
Request Body
media type data type description
application/json UpdateItemPropertyEntry (JSON) die Daten zur Aktualisierung @see {UpdateItemPropertyEntry
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json ItemPropertyEntry (JSON) die aktualisierte Eigenschaft
application/xml;charset=UTF-8 object

Example

Request
PUT /api/v11/item/property
Content-Type: application/json
Accept: application/json

                
{
  "itemId" : 12345,
  "itemCnr" : "...",
  "propertyId" : 12345,
  "content" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "datatype" : "...",
  "content" : "...",
  "name" : "...",
  "mandatory" : true,
  "itemgroupId" : 12345,
  "layoutId" : 12345,
  "id" : 12345
}

GET /api/v11/item/propertylayouts

Eine Liste aller Beschreibungen der Eigenschaften des Artikels.
Der Artikel kann optional über die Id oder Artikelnummer bestimmt werden.

Request Parameters
name type description constraints
itemCnr query (optional) Artikelnummer  
itemid query (optional) Id des Artikels. Ist auch die Artikelnummer angegeben hat die Id Priorität int
userid query des angemeldeten HELIUM V Benutzers  
Response Body
media type data type description
application/json PropertyLayoutEntryList (JSON) eine (leere) Liste aller Beschreibungen der Eigenschaften des Artikels
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/propertylayouts
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "type" : "LABEL",
    "row" : 12345,
    "column" : 12345,
    "height" : 12345,
    "paddingX" : 12345,
    "width" : 12345,
    "paddingY" : 12345,
    "orientation" : "NORTHWEST",
    "fill" : "HORIZONTAL",
    "weightX" : 12345.0,
    "weightY" : 12345.0,
    "gapTop" : 12345,
    "gapRight" : 12345,
    "gapBottom" : 12345,
    "gapLeft" : 12345,
    "mandatory" : true,
    "heading" : true,
    "name" : "...",
    "text" : "...",
    "id" : 12345
  }, {
    "type" : "PRINTBUTTON",
    "row" : 12345,
    "column" : 12345,
    "height" : 12345,
    "paddingX" : 12345,
    "width" : 12345,
    "paddingY" : 12345,
    "orientation" : "SOUTHEAST",
    "fill" : "NONE",
    "weightX" : 12345.0,
    "weightY" : 12345.0,
    "gapTop" : 12345,
    "gapRight" : 12345,
    "gapBottom" : 12345,
    "gapLeft" : 12345,
    "mandatory" : true,
    "heading" : true,
    "name" : "...",
    "text" : "...",
    "id" : 12345
  } ]
}

GET /api/v11/item/shopgrouplist

Eine Liste aller Shopgruppen ermitteln

Request Parameters
name type description constraints
limit query (optional) die maximale Anzahl von zu liefernden Shopgruppen. Bei 0 werden alle geliefert int
startIndex query (optional) die Index-Nummer desjenigen Satzes mit dem begonnen werden soll int
userid query des angemeldeten HELIUM V Benutzer  
Response Body
media type data type description
application/json ShopGroupEntryList (JSON) eine (leere) Liste von ShopGroupEntry
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/shopgrouplist
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "cnr" : "...",
    "description" : "...",
    "parentId" : 12345,
    "parentCnr" : "...",
    "parentDescription" : "...",
    "id" : 12345
  }, {
    "cnr" : "...",
    "description" : "...",
    "parentId" : 12345,
    "parentCnr" : "...",
    "parentDescription" : "...",
    "id" : 12345
  } ]
}

GET /api/v11/item/stocks

Liefert eine Liste aller Lagerstände dieses Artikels

Es werden nur Lager geliefert, die einen Lagerstand > 0 haben. Es werden nur jene Lagerstände geliefert, für die der Benutzer das Recht hat das jeweilige Lager zu benutzen.

Request Parameters
name type description constraints
itemCnr query die gesuchte Artikelnummer  
returnItemInfo query mit true werden neben den Lagerständen auch die Daten des betreffenden Artikels zurückgeliefert. boolean
userid query der angemeldete API Benutzer  
Response Body
media type data type description
application/json array of StockAmountEntry (JSON) eine (leere) Liste von Lagerständen
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/stocks
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "amount" : 12345.0,
  "stock" : {
    "name" : "...",
    "typeCnr" : "...",
    "id" : 12345
  },
  "item" : {
    "cnr" : "...",
    "description" : "...",
    "description2" : "...",
    "name" : "...",
    "shortName" : "...",
    "stockAmount" : 12345.0,
    "costs" : 12345.0,
    "billOfMaterialType" : "...",
    "available" : true,
    "comments" : [ "...", "..." ],
    "hidden" : true,
    "unitCnr" : "...",
    "typeCnr" : "...",
    "itemgroupCnr" : "...",
    "itemclassCnr" : "...",
    "revision" : "...",
    "stockAmountInfo" : {
      "stockAmount" : 12345.0,
      "reservedAmount" : 12345.0,
      "missingAmount" : 12345.0,
      "availableAmount" : 12345.0
    },
    "referenceNumber" : "...",
    "index" : "...",
    "preferredType" : "...",
    "customerItemCnr" : "...",
    "id" : 12345
  },
  "itemIdentityList" : {
    "entries" : [ {
      "identity" : "...",
      "amount" : 12345.0,
      "version" : "...",
      "bundleIdentity" : "...",
      "bundleAmount" : 12345.0
    }, {
      "identity" : "...",
      "amount" : 12345.0,
      "version" : "...",
      "bundleIdentity" : "...",
      "bundleAmount" : 12345.0
    } ]
  },
  "stockplaceList" : {
    "entries" : [ {
      "name" : "...",
      "items" : { },
      "id" : 12345
    }, {
      "name" : "...",
      "items" : { },
      "id" : 12345
    } ]
  }
} ]

GET /api/v11/item/stockslist

Liefert eine Liste aller Lagerstände dieses Artikels

Es werden nur Lager geliefert, die einen Lagerstand > 0 haben. Es werden nur jene Lagerstände geliefert, für die der Benutzer das Recht hat das jeweilige Lager zu benutzen.

Request Parameters
name type description constraints
addStockPlaceInfos query (optional) mit true die Infos der zugewiesenen Lagerplätze liefern boolean
itemCnr query die gesuchte Artikelnummer  
returnAllStocks query (optional) mit true auch jene Lager liefern, die einen Lagerstand = 0 haben, für die der Benutzer aber das Recht hat das jeweilige Lager zu benutzen. boolean
returnItemInfo query mit true werden neben den Lagerständen auch die Daten des betreffenden Artikels zurückgeliefert. boolean
userid query der angemeldete API Benutzer  
Response Body
media type data type description
application/json StockAmountEntryList (JSON) eine (leere) Liste von Lagerständen
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/stockslist
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "amount" : 12345.0,
    "stock" : {
      "name" : "...",
      "typeCnr" : "...",
      "id" : 12345
    },
    "item" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "preferredType" : "...",
      "customerItemCnr" : "...",
      "id" : 12345
    },
    "itemIdentityList" : {
      "entries" : [ { }, { } ]
    },
    "stockplaceList" : {
      "entries" : [ { }, { } ]
    }
  }, {
    "amount" : 12345.0,
    "stock" : {
      "name" : "...",
      "typeCnr" : "...",
      "id" : 12345
    },
    "item" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "preferredType" : "...",
      "customerItemCnr" : "...",
      "id" : 12345
    },
    "itemIdentityList" : {
      "entries" : [ { }, { } ]
    },
    "stockplaceList" : {
      "entries" : [ { }, { } ]
    }
  } ]
}

GET /api/v11/item/property/{propertyid}

Liefert die angeforderte Eigenschaft eines Artikels.
Der Artikel kann optional über die Id oder Artikelnummer bestimmt werden.

Request Parameters
name type description constraints
propertyid path Id der Eigenschaft des Artikels int
itemCnr query (optional) Artikelnummer  
itemid query (optional) Id des Artikels. Ist auch die Artikelnummer angegeben hat die Id Priorität int
userid query des angemeldeten HELIUM V Benutzers  
Response Body
media type data type description
application/json ItemPropertyEntry (JSON) Eigenschaft des Artikels sofern vorhanden, ansonsten wird mit StatusCode NOT_FOUND (404) geantwortet
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/property/{propertyid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "datatype" : "...",
  "content" : "...",
  "name" : "...",
  "mandatory" : true,
  "itemgroupId" : 12345,
  "layoutId" : 12345,
  "id" : 12345
}

PUT /api/v11/item/{itemid}/discardremaining

Verteilt die Restmenge der Charge zu gleichen Teilen auf ihre Verwendung in den Losen und liefert als Ergebnis eine Liste der betroffenen Lose.
Die Lose in der Liste sind nur mit ihrer id und cnr befüllt. Für Detailinformation der Lose sind die Ressourcen der ProductionApi zu verwenden.
Ist die Chargennummer nicht mehr auf Lager, so wird eine leere Liste retourniert.

Request Parameters
name type description constraints
itemid path Id des Artikels int
chargenr query Chargennummer des Artikels  
userid query des angemeldeten HELIUM V Benutzer  
Response Body
media type data type description
application/json ProductionEntryList (JSON) eine Liste von Losen, auf die die Charge aufgeteilt wurde
application/xml;charset=UTF-8 object

Example

Request
PUT /api/v11/item/{itemid}/discardremaining
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "entries" : [ {
    "cnr" : "...",
    "amount" : 12345.0,
    "orderOrItemCnr" : "...",
    "startDateMs" : 12345,
    "endDateMs" : 12345,
    "project" : "...",
    "comment" : "...",
    "itemEntry" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "hasSerialnr" : true,
      "hasChargenr" : true,
      "producerInfoEntry" : { },
      "packagingEntries" : { },
      "packagingAmount" : 12345.0,
      "batchSize" : 12345.0,
      "packagingAverageAmount" : 12345.0,
      "stockplaceInfoEntries" : { },
      "documentInfoEntries" : { },
      "itemCommentMediaInfoEntries" : { },
      "id" : 12345
    },
    "customer" : {
      "name1" : "...",
      "name2" : "...",
      "sign" : "...",
      "countryCode" : "...",
      "zipcode" : "...",
      "phone" : "...",
      "city" : "...",
      "deliveryAllowed" : true,
      "classification" : "...",
      "addressType" : "...",
      "representativeSign" : "...",
      "id" : 12345
    },
    "additionalStatuses" : {
      "entries" : [ { }, { } ]
    },
    "status" : "INPRODUCTION",
    "partlistId" : 12345,
    "worksteps" : {
      "entries" : [ { }, { } ]
    },
    "targetMaterials" : {
      "entries" : [ { }, { } ]
    },
    "deliveredAmount" : 12345.0,
    "productionWorksteps" : {
      "entries" : [ { }, { } ]
    },
    "targetStockId" : 12345,
    "customerName" : "...",
    "itemDescription" : "...",
    "itemDescription2" : "...",
    "documentInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "itemCommentMediaInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "itemCnr" : "...",
    "orderCnr" : "...",
    "manufactoringPlace" : "...",
    "testPlanEntries" : {
      "entries" : [ { }, { } ]
    },
    "id" : 12345
  }, {
    "cnr" : "...",
    "amount" : 12345.0,
    "orderOrItemCnr" : "...",
    "startDateMs" : 12345,
    "endDateMs" : 12345,
    "project" : "...",
    "comment" : "...",
    "itemEntry" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "hasSerialnr" : true,
      "hasChargenr" : true,
      "producerInfoEntry" : { },
      "packagingEntries" : { },
      "packagingAmount" : 12345.0,
      "batchSize" : 12345.0,
      "packagingAverageAmount" : 12345.0,
      "stockplaceInfoEntries" : { },
      "documentInfoEntries" : { },
      "itemCommentMediaInfoEntries" : { },
      "id" : 12345
    },
    "customer" : {
      "name1" : "...",
      "name2" : "...",
      "sign" : "...",
      "countryCode" : "...",
      "zipcode" : "...",
      "phone" : "...",
      "city" : "...",
      "deliveryAllowed" : true,
      "classification" : "...",
      "addressType" : "...",
      "representativeSign" : "...",
      "id" : 12345
    },
    "additionalStatuses" : {
      "entries" : [ { }, { } ]
    },
    "status" : "CANCELLED",
    "partlistId" : 12345,
    "worksteps" : {
      "entries" : [ { }, { } ]
    },
    "targetMaterials" : {
      "entries" : [ { }, { } ]
    },
    "deliveredAmount" : 12345.0,
    "productionWorksteps" : {
      "entries" : [ { }, { } ]
    },
    "targetStockId" : 12345,
    "customerName" : "...",
    "itemDescription" : "...",
    "itemDescription2" : "...",
    "documentInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "itemCommentMediaInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "itemCnr" : "...",
    "orderCnr" : "...",
    "manufactoringPlace" : "...",
    "testPlanEntries" : {
      "entries" : [ { }, { } ]
    },
    "id" : 12345
  } ]
}

GET /api/v11/item/{itemid}/document

Ein Dokument anhand seiner Cnr eines Artikels ermitteln

Request Parameters
name type description constraints
itemid path Id des Artikels int
documentcnr query Id des Dokumentes  
userid query des angemeldeten HELIUM V Benutzers  
Response Body
media type data type description
application/json object (JSON) das Dokument sofern vorhanden. Gibt es das Dokument nicht wird mit StatusCode NOT_FOUND (404) geantwortet
application/xml anyType (XML)

Example

Request
GET /api/v11/item/{itemid}/document
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/v11/item/{itemid}/price

Request Parameters
name type description constraints
itemid path int
amount query  
customerid query int
unit query  
userid query  
Response Body
media type data type description
application/json number (JSON)
application/xml decimal (XML)

Example

Request
GET /api/v11/item/{itemid}/price
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/v11/item/{itemid}/printlabel

Das Etikett des Artikels ausdrucken

Das Artikeletikett wird auf dem Drucker ausgedruckt, der dem Arbeitsplatz (des mobilen Endgerätes) zugewiesen worden ist

Request Parameters
name type description constraints
itemid path Id des Artikels int
amount query (optional) Menge des Artikels  
chargenr query (optional) Serien-/Chargennummer des Artikels  
copies query (optional) Anzahl der Exemplare. Wenn nicht angegeben wird 1 Exemplar gedruckt int
identitystockid query (optional) Id des Lagers der Serien-/Chargennummer, für den Andruck des Lagerstandes der Serien-/Chargennummer int
userid query des angemeldeten HELIUM V Benutzers  
Response Body
media type data type description
application/json number (JSON) itemId sofern das Artikeletikett gedruckt werden konnte
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/{itemid}/printlabel
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/v11/item/{itemid}/properties

Eine Liste aller Artikeleigenschaften eines Artikels ermitteln.

Request Parameters
name type description constraints
itemid path die Id des gewünschten Artikels int
userid query userId der angemeldete HELIUM V Benutzer  
Response Body
media type data type description
application/json ItemPropertyEntryList (JSON) eine (leere) Liste von Artikeleigenschaften
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/{itemid}/properties
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "datatype" : "...",
    "content" : "...",
    "name" : "...",
    "mandatory" : true,
    "itemgroupId" : 12345,
    "layoutId" : 12345,
    "id" : 12345
  }, {
    "datatype" : "...",
    "content" : "...",
    "name" : "...",
    "mandatory" : true,
    "itemgroupId" : 12345,
    "layoutId" : 12345,
    "id" : 12345
  } ]
}

GET /api/v11/item/{itemid}/commentmedia/list

Request Parameters
name type description constraints
itemid path int
userid query  
Response Body
media type data type description
application/json ItemCommentMediaInfoEntryList (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/{itemid}/commentmedia/list
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "mimeType" : "IMAGEPNG",
    "iSort" : 12345,
    "commentType" : "...",
    "filename" : "...",
    "size" : 12345,
    "commentTypeDescription" : "...",
    "content" : "...",
    "id" : 12345
  }, {
    "mimeType" : "TEXTHTML",
    "iSort" : 12345,
    "commentType" : "...",
    "filename" : "...",
    "size" : 12345,
    "commentTypeDescription" : "...",
    "content" : "...",
    "id" : 12345
  } ]
}

GET /api/v11/item/{itemid}/commentmedia/{itemcommentid}

Request Parameters
name type description constraints
itemcommentid path int
itemid path int
userid query  
Response Body
media type data type description
application/json object (JSON)
application/xml anyType (XML)

Example

Request
GET /api/v11/item/{itemid}/commentmedia/{itemcommentid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/v11/item/{itemid}/document/list

Eine Liste aller Dokumente des Artikels aus der Dokumentenablage ermitteln.
Es werden alle Dokumente angeführt, die für der angemeldeten Benutzer sichtbar sind. Ein Element der Liste entählt aber nicht die tatsächlichen Daten des Dokuments, sondern nur Metainformation.

Request Parameters
name type description constraints
itemid path Id des Artikels int
userid query des angemeldeten HELIUM V Benutzers  
Response Body
media type data type description
application/json DocumentInfoEntryList (JSON) eine (leere) Liste mit Infos über die gefundenen Dokumente
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/item/{itemid}/document/list
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "name" : "...",
    "filename" : "...",
    "size" : 12345,
    "cnr" : "..."
  }, {
    "name" : "...",
    "filename" : "...",
    "size" : 12345,
    "cnr" : "..."
  } ]
}