ItemApi 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.

GET /api/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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
  } ]
}

GET /api/v1/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/v1/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/v1/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/v1/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
  } ]
}