PartlistApi Resource

GET /api/v1/partlist/list

Request Parameters
name type description constraints
filter_cnr query  
filter_textsearch query  
filter_withHidden query boolean
limit query int
startIndex query int
userid query  
Response Body
media type data type description
application/json PartlistEntryList (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/partlist/list
Content-Type: */*
Accept: application/json

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

                
{
  "list" : [ {
    "cnr" : "...",
    "description" : "...",
    "additionalDescription" : "...",
    "lotCount" : 12345,
    "statusCnr" : "...",
    "customerItemCnr" : "...",
    "id" : 12345
  }, {
    "cnr" : "...",
    "description" : "...",
    "additionalDescription" : "...",
    "lotCount" : 12345,
    "statusCnr" : "...",
    "customerItemCnr" : "...",
    "id" : 12345
  } ]
}

GET /api/v1/partlist/mountingmethod

Die Liste aller Montagearten

Request Parameters
name type description
userid query ist der beim Logon ermittelte "token"
Response Body
media type data type description
application/json MountingMethodEntryList (JSON) eine (leere) Liste aller Montagearten
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/partlist/mountingmethod
Content-Type: */*
Accept: application/json

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

                
{
  "entries" : [ {
    "description" : "...",
    "itemId" : 12345,
    "iSort" : 12345,
    "id" : 12345
  }, {
    "description" : "...",
    "itemId" : 12345,
    "iSort" : 12345,
    "id" : 12345
  } ]
}

GET /api/v1/partlist/productiongroup

Die Liste aller Fertigungsgruppen

Request Parameters
name type description constraints
limit query int
startIndex query int
userid query ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json ProductionGroupEntryList (JSON) eine (leere) Liste aller Fertigungsgruppen
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/partlist/productiongroup
Content-Type: */*
Accept: application/json

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

                
{
  "entries" : [ {
    "description" : "...",
    "sortOrder" : 12345,
    "id" : 12345
  }, {
    "description" : "...",
    "sortOrder" : 12345,
    "id" : 12345
  } ]
}

GET /api/v1/partlist/{partlistid}/browseposition

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

Example

Request
GET /api/v1/partlist/{partlistid}/browseposition
Content-Type: */*
Accept: application/json

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

                
{
  "list" : [ {
    "cnr" : "...",
    "description" : "...",
    "amount" : 12345.0,
    "calcPrice" : 12345.0,
    "comment" : "...",
    "position" : "...",
    "unitCnr" : "...",
    "salesPrice" : 12345.0,
    "itemId" : 12345,
    "iSort" : 12345,
    "customerItemCnr" : "...",
    "itemHidden" : true,
    "itemLocked" : true,
    "id" : 12345
  }, {
    "cnr" : "...",
    "description" : "...",
    "amount" : 12345.0,
    "calcPrice" : 12345.0,
    "comment" : "...",
    "position" : "...",
    "unitCnr" : "...",
    "salesPrice" : 12345.0,
    "itemId" : 12345,
    "iSort" : 12345,
    "customerItemCnr" : "...",
    "itemHidden" : true,
    "itemLocked" : true,
    "id" : 12345
  } ],
  "salesPrice" : 12345.0
}

POST /api/v1/partlist/{partlistid}/email

Eine Email eines Kunden zu einer Stueckliste erstellen

Request Parameters
name type description constraints
partlistid path die betreffende Stückliste int
userid query der angemeldete Benutzer  
Request Body
media type data type description
application/json PartlistEmailEntry (JSON) die zu versendende Email
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/partlist/{partlistid}/email
Content-Type: application/json

                
{
  "emailText" : "..."
}
Response
HTTP/1.1 201 Created

GET /api/v1/partlist/{partlistid}/position

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

Example

Request
GET /api/v1/partlist/{partlistid}/position
Content-Type: */*
Accept: application/json

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

                
{
  "list" : [ {
    "cnr" : "...",
    "description" : "...",
    "amount" : 12345.0,
    "calcPrice" : 12345.0,
    "comment" : "...",
    "position" : "...",
    "unitCnr" : "...",
    "salesPrice" : 12345.0,
    "itemId" : 12345,
    "iSort" : 12345,
    "customerItemCnr" : "...",
    "itemHidden" : true,
    "itemLocked" : true,
    "id" : 12345
  }, {
    "cnr" : "...",
    "description" : "...",
    "amount" : 12345.0,
    "calcPrice" : 12345.0,
    "comment" : "...",
    "position" : "...",
    "unitCnr" : "...",
    "salesPrice" : 12345.0,
    "itemId" : 12345,
    "iSort" : 12345,
    "customerItemCnr" : "...",
    "itemHidden" : true,
    "itemLocked" : true,
    "id" : 12345
  } ],
  "salesPrice" : 12345.0
}

POST /api/v1/partlist/{partlistid}/position

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

Example

Request
POST /api/v1/partlist/{partlistid}/position
Content-Type: application/json
Accept: application/json

                
{
  "itemCnr" : "...",
  "amount" : 12345.0,
  "unitCnr" : "...",
  "position" : "...",
  "comment" : "...",
  "id" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "cnr" : "...",
  "description" : "...",
  "amount" : 12345.0,
  "calcPrice" : 12345.0,
  "comment" : "...",
  "position" : "...",
  "unitCnr" : "...",
  "salesPrice" : 12345.0,
  "itemId" : 12345,
  "iSort" : 12345,
  "customerItemCnr" : "...",
  "itemHidden" : true,
  "itemLocked" : true,
  "id" : 12345
}

PUT /api/v1/partlist/{partlistid}/position

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

Example

Request
PUT /api/v1/partlist/{partlistid}/position
Content-Type: application/json
Accept: application/json

                
{
  "itemCnr" : "...",
  "amount" : 12345.0,
  "unitCnr" : "...",
  "position" : "...",
  "comment" : "...",
  "id" : 12345
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "cnr" : "...",
  "description" : "...",
  "amount" : 12345.0,
  "calcPrice" : 12345.0,
  "comment" : "...",
  "position" : "...",
  "unitCnr" : "...",
  "salesPrice" : 12345.0,
  "itemId" : 12345,
  "iSort" : 12345,
  "customerItemCnr" : "...",
  "itemHidden" : true,
  "itemLocked" : true,
  "id" : 12345
}

GET /api/v1/partlist/{partlistid}/print

Eine Stücliste als PDF 'drucken', bzw. empfangen

Request Parameters
name type description constraints
partlistid path die zu druckende Stückliste int
userid query der angemeldete Benutzer  
Response Body
media type data type description
application/json object (JSON) das PDF zur Stückliste, sofern diese erfolgreich ausgedruckt werden kann, ansonsten ein allgemeiner HTML-Text zum "Fehler"
application/xml anyType (XML)

Example

Request
GET /api/v1/partlist/{partlistid}/print
Content-Type: */*
Accept: application/json

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

                
...

GET /api/v1/partlist/{partlistid}/workstep

Die Liste der Arbeitsgänge des Arbeitsplans

Request Parameters
name type description constraints
partlistid path die betreffende Stückliste int
userid query ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json PartlistWorkstepEntryList (JSON) eine (leere) Liste von Arbeitsgängen der betreffenden Stückliste
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/partlist/{partlistid}/workstep
Content-Type: */*
Accept: application/json

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

                
{
  "entries" : [ {
    "workstepNumber" : 12345,
    "setupTimeMs" : 12345,
    "jobTimeMs" : 12345,
    "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
    },
    "machineId" : 12345,
    "text" : "...",
    "workstepType" : "...",
    "workplanComment" : "...",
    "id" : 12345
  }, {
    "workstepNumber" : 12345,
    "setupTimeMs" : 12345,
    "jobTimeMs" : 12345,
    "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
    },
    "machineId" : 12345,
    "text" : "...",
    "workstepType" : "...",
    "workplanComment" : "...",
    "id" : 12345
  } ]
}

DELETE /api/v1/partlist/{partlistid}/position/{positionid}

Eine Stücklistenposition entfernen

Request Parameters
name type description constraints
partlistid path die Stücklisten-Id die die Position enthält int
positionid path die Position die entfernt werden soll int
userid query der angemeldete Benutzer  

Example

Request
DELETE /api/v1/partlist/{partlistid}/position/{positionid}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content