DocumentApi Resource

POST /api/v1/document

Speichert Dokumente zu bestehenden Belegen ab, die über die Kategorie des Belegs und der Id oder Nummer des Belegs identifiziert werden. Es muss entweder die Id oder die Nummer des Belegs übermittelt werden.

Die maximale Upload-Größe ist derzeit auf 500KiB gestellt

Request Parameters
name type description constraints
category query ist die Kategorie des Belegs "DELIVERYNOTE" or "ITEM" or "ORDER" or "PRODUCTION" or "PROJECT" or "PURCHASEINVOICE"
cnr query ist die Nummer des Belegs (optional)  
grouping query ist die Gruppierung (optional)  
id query ist die Id des Belegs (optional) int
keywords query sind die Schlagworte des Dokuments (optional)  
securitylevel query ist die Sicherheitsstufe (optional) long
type query ist die Belegart (optional)  
userid query ist der Token der durch die Anmeldung (login) erhalten wurde  
Request Body
media type data type description
application/json MultipartBody (JSON) ist der multipart/form-data des Requests, der den/die Dokumente enthält
application/xml multipartBody (XML)

Example

Request
POST /api/v1/document
Content-Type: application/json

                
{
  "allAttachments" : [ {
    "contentDisposition" : {
      "type" : "...",
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "object" : { },
    "contentType" : {
      "type" : "...",
      "wildcardSubtype" : true,
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      },
      "wildcardType" : true,
      "subtype" : "..."
    },
    "contentId" : "...",
    "dataHandler" : "...",
    "headers" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    }
  }, {
    "contentDisposition" : {
      "type" : "...",
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "object" : { },
    "contentType" : {
      "type" : "...",
      "wildcardSubtype" : true,
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      },
      "wildcardType" : true,
      "subtype" : "..."
    },
    "contentId" : "...",
    "dataHandler" : "...",
    "headers" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    }
  } ],
  "type" : {
    "type" : "...",
    "wildcardSubtype" : true,
    "parameters" : {
      "property1" : "...",
      "property2" : "..."
    },
    "wildcardType" : true,
    "subtype" : "..."
  },
  "rootAttachment" : {
    "contentDisposition" : {
      "type" : "...",
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "object" : { },
    "contentType" : {
      "type" : "...",
      "wildcardSubtype" : true,
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      },
      "wildcardType" : true,
      "subtype" : "..."
    },
    "contentId" : "...",
    "dataHandler" : "...",
    "headers" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    }
  },
  "childAttachments" : [ {
    "contentDisposition" : {
      "type" : "...",
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "object" : { },
    "contentType" : {
      "type" : "...",
      "wildcardSubtype" : true,
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      },
      "wildcardType" : true,
      "subtype" : "..."
    },
    "contentId" : "...",
    "dataHandler" : "...",
    "headers" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    }
  }, {
    "contentDisposition" : {
      "type" : "...",
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "object" : { },
    "contentType" : {
      "type" : "...",
      "wildcardSubtype" : true,
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      },
      "wildcardType" : true,
      "subtype" : "..."
    },
    "contentId" : "...",
    "dataHandler" : "...",
    "headers" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    }
  } ]
}
Response
HTTP/1.1 201 Created

GET /api/v1/document/list

Eine Liste aller Dokumente eines Belegs 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.
Der Beleg wird über die Id oder Nummer des Belegs identifiziert. Es muss entweder die Id oder die Nummer des Belegs übermittelt werden.

Request Parameters
name type description constraints
category query ist die Kategorie des Belegs "DELIVERYNOTE" or "ITEM" or "ORDER" or "PRODUCTION" or "PROJECT" or "PURCHASEINVOICE"
cnr query ist die Nummer des Belegs (optional)  
id query ist die Id des Belegs (optional) int
userid query ist der Token der durch die Anmeldung (login) erhalten wurde  
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/v1/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" : "..."
  } ]
}