Attachment admin API Resource

HDC WS for converting attachment files

GET /api/admin/attachment

Returns original files for given state

Request Parameters
name type description constraints
limit query - raster file entries limit per request long
offset query - offset of raster 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/attachment
Content-Type: */*
Accept: application/json

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

                
...

GET /api/admin/attachment/convertondemand

Converts one file with given id.

Request Parameters
name type description constraints
fileId query - file identifier long
versionId query long
Response Body
media type data type description
application/json array of HdcFileModelTO (JSON) - long running process description

Example

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

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

                
[ {
  "md5" : "...",
  "versionId" : 12345,
  "mimeType" : "...",
  "status" : "CONVERTED",
  "errorMessage" : "...",
  "fullPath" : {
    "fileSystem" : {
      "userPrincipalLookupService" : { },
      "fileStores" : { },
      "open" : true,
      "rootDirectories" : { },
      "separator" : "...",
      "readOnly" : true
    },
    "root" : { },
    "fileName" : { },
    "parent" : { },
    "absolute" : true,
    "nameCount" : 12345
  },
  "derivedId" : 12345,
  "fileName" : "...",
  "fileId" : 12345,
  "originalId" : 12345,
  "size" : 12345,
  "path" : "..."
} ]

POST /api/admin/attachment/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/attachment/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/attachment/convert/{state}

Converts 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/attachment/convert/{state}
Content-Type: */*
Accept: application/json

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

                
{ }