ExperimentalRawFilesResource Resource

Experimental REST API endpoint for rawfile handling. Please note that endpoints of this resource are expected to be changed in an incompatible way in any of the future releases.

GET /experimental-rawfiles

List experimental raw files.

Response Body
media type data type description
application/json ExperimentalRawFilesInfo (JSON) Raw files info

Example

Request
GET /experimental-rawfiles
Content-Type: */*
Accept: application/json

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

                
{
  "rawfiles" : [ {
    "size" : 12345,
    "time" : 12345,
    "description" : "...",
    "contenttype" : "...",
    "url" : "...",
    "name" : "..."
  }, {
    "size" : 12345,
    "time" : 12345,
    "description" : "...",
    "contenttype" : "...",
    "url" : "...",
    "name" : "..."
  } ]
}

POST /experimental-rawfiles

Experimental file upload. Experimental functionality with no auhorization/authentication. The posted content is visible for all users. Note that content type is not guessed / recognized from the file name / its contents.

Request Parameters
name type description
contenttype formdata Optional content type to be used. When no content type is specified application/octet-stream will be used.
description formdata Description of the uploaded resource
fileDetail formdata Details containing original uploaded file name
nameprefix formdata Resource name suggestion / prefix
uploadedInputStream formdata InputStream to read content data
Request Body
media type data type
multipart/form-data (custom)
Response Body
media type data type description
application/json ExperimentalRawFileInfo (JSON) New resource info

Example

Request
POST /experimental-rawfiles
Content-Type: multipart/form-data
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "size" : 12345,
  "time" : 12345,
  "description" : "...",
  "contenttype" : "...",
  "url" : "...",
  "name" : "..."
}

DELETE /experimental-rawfiles/{res}

Delete a specific raw file.

Request Parameters
name type description
res path Resource name to delete

Example

Request
DELETE /experimental-rawfiles/{res}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /experimental-rawfiles/{res}

Get raw file info DTO.

Request Parameters
name type description
res path Raw file
Response Body
media type data type description
application/json ExperimentalRawFileInfo (JSON) File info

Example

Request
GET /experimental-rawfiles/{res}
Content-Type: */*
Accept: application/json

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

                
{
  "size" : 12345,
  "time" : 12345,
  "description" : "...",
  "contenttype" : "...",
  "url" : "...",
  "name" : "..."
}

PUT /experimental-rawfiles/{res}

Experimental file upload. Experimental functionality with no auhorization/authentication. The posted content is visible for all users. If there is a rawfile stored with the same name it will be overwritten, otherwise a new resource with the given name will be created.

Request Parameters
name type description
contenttype formdata Optional content type to be used. When no content type is specified application/octet-stream will be used.
description formdata Optional description of the uploaded resource
fileDetail formdata Details containing original uploaded file name
uploadedInputStream formdata InputStream to read content data
res path Resource name to add/update
Request Body
media type data type
multipart/form-data (custom)
Response Body
media type data type description
application/json ExperimentalRawFileInfo (JSON) New resource info

Example

Request
PUT /experimental-rawfiles/{res}
Content-Type: multipart/form-data
Accept: application/json

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

                
{
  "size" : 12345,
  "time" : 12345,
  "description" : "...",
  "contenttype" : "...",
  "url" : "...",
  "name" : "..."
}

GET /experimental-rawfiles/{res}/get-sizeinfo

Experimental endpoint to estimate allocated size. Please note that this endpoint is under construction, use with caution: execution might fail and execution might have significant memory/cpu impact. The availability/functionality of this endpoint might change in any of the subsequent releases.

Request Parameters
name type description constraints
res path Content  
method query Size info method to use. "CALCULATED" or "JAVAAGENT"
Response Body
media type data type description
application/json SizeInfoDto (JSON) Size info description

Example

Request
GET /experimental-rawfiles/{res}/get-sizeinfo
Content-Type: */*
Accept: application/json

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

                
{
  "size" : 12345,
  "details" : [ {
    "size" : 12345,
    "name" : "..."
  }, {
    "size" : 12345,
    "name" : "..."
  } ]
}

GET /experimental-rawfiles/{res}/raw

Get the raw file content with content-disposition. The response media type will be filled according to the stored media type.

Additionally the response will be filled with content-disposition header with value attachment; filename = [NAME] where [NAME] is the resource name. Accessing this endpoint from a browser typically opens a download dialog with the specified file name.

Request Parameters
name type description
res path Raw file
Response Body
media type data type description
application/json object (JSON) Response

Example

Request
GET /experimental-rawfiles/{res}/raw
Content-Type: */*
Accept: application/json

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

                
...

GET /experimental-rawfiles/{res}/raw-nocd

Get the raw file content with no content-disposition. The response media type will be filled according to the stored media type. The response is the same as the response of GET ExperimentalRawFilesResource. The path associated to this method (rawfiles/{res/raw-nocd}) represents REST semantics, where the response is a view/representation (raw-nocd) of the resource (rawfiles/{res/raw-nocd}).

Request Parameters
name type description
res path Raw file
Response Body
media type data type description
application/json object (JSON) Response

Example

Request
GET /experimental-rawfiles/{res}/raw-nocd
Content-Type: */*
Accept: application/json

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

                
...

GET /experimental-rawfiles/{res}/segment

Get a segment of the raw file.

Request Parameters
name type description constraints
res path Raw file  
length query Maximal number of bytes to return long
start query Index (0-based) of the first byte to return. long
Response Body
media type data type description
application/octet-stream (custom) Response

Example

Request
GET /experimental-rawfiles/{res}/segment
Content-Type: */*
Accept: application/octet-stream

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

                
...