File admin API Resource

HDC WS for converting drawing files

GET /api/admin/file

Returns original files for given state

Request Parameters
name type description constraints
limit query - file entries limit per request long
offset query - offset of file entries long
state query - file state  
Response Body
media type data type description
application/json object (JSON) - list of files

Example

Request
GET /api/admin/file
Content-Type: */*
Accept: application/json

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

                
...

GET /api/admin/notecontent

Returns original note files for given state

Request Parameters
name type description constraints
limit query - file entries limit per request long
offset query - offset of file entries long
state query - file state  
Response Body
media type data type description
application/json object (JSON) - list of files

Example

Request
GET /api/admin/notecontent
Content-Type: */*
Accept: application/json

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

                
...

GET /api/admin/file/convertondemand

Tiles single image on demand

Request Parameters
name type description constraints
fileId query - file identifier long
paramsOnly query - flag indicating process raster parameters mode boolean
versionId query - version identifier long
Response Body
media type data type description
application/json object (JSON)

Example

Request
GET /api/admin/file/convertondemand
Content-Type: */*
Accept: application/json

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

                
...

POST /api/admin/file/convertondemand

Request Parameters
name type description constraints
paramsOnly query boolean
Request Body
media type data type
application/json array of HdcFileId (JSON)
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /api/admin/file/convertondemand
Content-Type: application/json
Accept: application/json

                
[ {
  "versionId" : 12345,
  "fileId" : 12345
} ]
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /api/admin/notecontent/convertondemand

Tiles single image on demand

Request Parameters
name type description constraints
fileId query - file identifier long
Response Body
media type data type description
application/json HdcLazyTilingStateTO (JSON)

Example

Request
GET /api/admin/notecontent/convertondemand
Content-Type: */*
Accept: application/json

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

                
{ }

POST /api/admin/notecontent/convertondemand

Request Body
media type data type
application/json array of HdcFileId (JSON)
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /api/admin/notecontent/convertondemand
Content-Type: application/json
Accept: application/json

                
[ {
  "fileId" : 12345,
  "versionId" : 12345
} ]
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /api/admin/file/convert/{state}

Tiles all files with given state.

Request Parameters
name type description constraints
state path - file state. Recommended states for this operation: UPLOADED, UNCONVERTIBLE, IN_QUEUE, CONVERTING  
paramsOnly query boolean
Response Body
media type data type description
application/json HdcLazyTilingStateTO (JSON) - long running process description

Example

Request
GET /api/admin/file/convert/{state}
Content-Type: */*
Accept: application/json

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

                
{ }

GET /api/admin/notecontent/convert/{state}

Tiles all files with given state.

Request Parameters
name type description
state path - file state. Recommended states for this operation: UPLOADED, UNCONVERTIBLE, IN_QUEUE, CONVERTING
Response Body
media type data type description
application/json HdcLazyTilingStateTO (JSON) - long running process description

Example

Request
GET /api/admin/notecontent/convert/{state}
Content-Type: */*
Accept: application/json

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

                
{ }