DPF REST API (1.3)

Download OpenAPI specification:

SEAL Systems AG, Röttenbach, Germany: sales@sealsystems.de URL: https://sealsystems.de/

REST API of the SEAL Systems Digital Paper Factory

Jobs

Get list of jobs

NOT IMPLEMENTED provided for a later implementation step because it requires user authorization (This route provides access to the collection of Job IDs known in DPF. Use filters to search for specific jobs, and paging to limit the number of results retrieved.)

query Parameters

filter	string Query for searching jobs. The given value is used to perform a substring search in several columns. No wildcards required.
show	integer Number of records to return at the max (page size). Set to 0 to retrieve ALL jobs at once (careful, may be a big list).
skip	integer Number of entries to omit from top of the result list.
sort	string Job property to sort jobs by; may contain keywords ASC or DESC for ascending or descending sort order. E.g. '...?sort=status,ID,ASC' would sort the job list by status, then by ID, in ascending order.

Responses

Response samples

200
401
500
501

Content type

application/json

["string"
]

Create a new job

Creates a new job entry, either empty or, if jobInfo is provided, pre-configured with the given parameters. The job is just created, not started (see job controls).

Request Body schema: application/json

Partial or comprehensive parameters for the new job.

One of

ID	string UUID Job identifier
conversionType required	string type of DPF conversion
status	string (JobStateEnum) Enum: "undefined" "added" "transferred" "active" "finished" "sending" "canceled" "suspended" "error" current state of dpf job
	object
	object
	Array of objects
resultFileDropPath	string
profile	string
destFormat	string
	object
	object
	object
thumbnailFormat	string
thumbnailSize	string

Responses

Request samples

Payload

Content type

application/json

Example

ConversionJob

{"ID": "string",
"conversionType": "string",
"status": "undefined",
"dpfParameter": {"userName": "string",
"jobName": "string",
"language": "string",
"loglevel": "string",
"jobPriority": "string",
"deleteJob": "string",
"errDeleteJob": "string",
"forgetJob": "string",
"keepUntilForget": "string"
},
"wsControl": {"callbackURL": "string"
},
"wsdata": [{"number": "string",
"text": "string"
}
],
"resultFileDropPath": "string",
"profile": "string",
"destFormat": "string",
"stampConfig": {"color": true,
"stampText": [{"number": "string",
"text": "string"
}
],
"selection": "string",
"stpFile": "string"
},
"viewConfig": {"openAction": "string",
"pageMode": "string",
"viewPreferences": {"hideToolbar": true,
"hideMenubar": true,
"hideWindowUI": true,
"fitWindow": true,
"centerWindow": true,
"displayDocTitle": true
}
},
"cryptConfig": {"userPwd": "string",
"ownerPwd": "string",
"protectPdfConfig": {"open": true,
"rights": true,
"print": "notallowed",
"copy": "notallowed",
"change": "notallowed"
}
},
"thumbnailFormat": "string",
"thumbnailSize": "string"
}

Response samples

201
400
401
500

Content type

application/json

{"jobid": "string"
}

Get details of a job instance

Retrieves information about a job instance. Query sub-ressources for more details.

path Parameters

jobID

required

string

ID of the job instance to query

Responses

Response samples

200
401
404
500
501

Content type

application/json

Example

ConversionJob

{"ID": "string",
"conversionType": "string",
"status": "undefined",
"dpfParameter": {"userName": "string",
"jobName": "string",
"language": "string",
"loglevel": "string",
"jobPriority": "string",
"deleteJob": "string",
"errDeleteJob": "string",
"forgetJob": "string",
"keepUntilForget": "string"
},
"wsControl": {"callbackURL": "string"
},
"wsdata": [{"number": "string",
"text": "string"
}
],
"resultFileDropPath": "string",
"profile": "string",
"destFormat": "string",
"stampConfig": {"color": true,
"stampText": [{"number": "string",
"text": "string"
}
],
"selection": "string",
"stpFile": "string"
},
"viewConfig": {"openAction": "string",
"pageMode": "string",
"viewPreferences": {"hideToolbar": true,
"hideMenubar": true,
"hideWindowUI": true,
"fitWindow": true,
"centerWindow": true,
"displayDocTitle": true
}
},
"cryptConfig": {"userPwd": "string",
"ownerPwd": "string",
"protectPdfConfig": {"open": true,
"rights": true,
"print": "notallowed",
"copy": "notallowed",
"change": "notallowed"
}
},
"thumbnailFormat": "string",
"thumbnailSize": "string"
}

Update job metadata (complete, replace)

A put call to the job root record completely replaces job metadata, but does not affect sub-ressources

path Parameters

jobID

required

string

ID of the job instance to query

Request Body schema: application/json

Partial or comprehensive metadata for the new job.

One of

ID	string UUID Job identifier
conversionType required	string type of DPF conversion
status	string (JobStateEnum) Enum: "undefined" "added" "transferred" "active" "finished" "sending" "canceled" "suspended" "error" current state of dpf job
	object
	object
	Array of objects
resultFileDropPath	string
profile	string
destFormat	string
	object
	object
	object
thumbnailFormat	string
thumbnailSize	string

Responses

Request samples

Payload

Content type

application/json

Example

ConversionJob

{"ID": "string",
"conversionType": "string",
"status": "undefined",
"dpfParameter": {"userName": "string",
"jobName": "string",
"language": "string",
"loglevel": "string",
"jobPriority": "string",
"deleteJob": "string",
"errDeleteJob": "string",
"forgetJob": "string",
"keepUntilForget": "string"
},
"wsControl": {"callbackURL": "string"
},
"wsdata": [{"number": "string",
"text": "string"
}
],
"resultFileDropPath": "string",
"profile": "string",
"destFormat": "string",
"stampConfig": {"color": true,
"stampText": [{"number": "string",
"text": "string"
}
],
"selection": "string",
"stpFile": "string"
},
"viewConfig": {"openAction": "string",
"pageMode": "string",
"viewPreferences": {"hideToolbar": true,
"hideMenubar": true,
"hideWindowUI": true,
"fitWindow": true,
"centerWindow": true,
"displayDocTitle": true
}
},
"cryptConfig": {"userPwd": "string",
"ownerPwd": "string",
"protectPdfConfig": {"open": true,
"rights": true,
"print": "notallowed",
"copy": "notallowed",
"change": "notallowed"
}
},
"thumbnailFormat": "string",
"thumbnailSize": "string"
}

Response samples

200
401
409
500
501

Content type

application/json

{"code": 0,
"message": "string",
"fields": "string"
}

Delete a job

path Parameters

jobID

required

string

Responses

Response samples

200
401
404
500
501

Content type

application/json

{"code": 0,
"message": "string",
"fields": "string"
}

Add an input file

Define an additional input file for the job. A POST call to this route creates a new entry in the list. Without any parameters, an empty record is create. You may include metadata (such as a source URL) with the call to define the file

path Parameters

jobID

required

string

ID of the DPF job to modify

Request Body schema: application/json

Input file parameter passed as JSON object. See schema 'InputFile'

fileName	string
dpfParamName	string
fileType	string

Responses

Request samples

Payload

Content type

application/json

{"fileName": "string",
"dpfParamName": "string",
"fileType": "string"
}

Response samples

201
400
401
404
500

Content type

application/json

{"fileid": 0
}

Upload content of input file as stream

path Parameters

jobID required	string ID of the DPF job to query
fileID required	integer ID of the input file

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"code": 0,
"message": "string",
"fields": "string"
}

Start a job

When a DPF job is defined and ready for processing, it may be started by a POST query to this route.

path Parameters

jobID

required

string

ID of the DPF job to start

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"trackerURL": "string"
}

Stop a running job

A running DPF job may be aborted by a POST query to this route.

path Parameters

jobID

required

string

ID of the DPF job to stop

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"code": 0,
"message": "string",
"fields": "string"
}

Get status of job

Get status of DPF Job

path Parameters

jobID

required

string

ID of the DPF job to stop

query Parameters

verbose

boolean

use verbose to get detailed status information and job history

Responses

Response samples

200
401
404
500

Content type

application/json

{"jobstate": "undefined",
"message": "string",
"jobTrackerUrl": "string",
"db_jobstates": {"db_jobstate": "string",
"db_internalstate": "string"
},
"jobstate_history": [{"jobid": "string",
"exitstatus": "string",
"wfname": "string",
"wfpos": "string",
"wfpath": "string",
"time": "string",
"internalstate": "string",
"nodename": "string"
}
]
}

Get result parameter

Delievers a result object with result parameters and a list of file IDs of generated output files. This subresoures can be received by a GET request to route /jobs/{jobID}/result/{fileID}.

path Parameters

jobID

required

string

ID of the DPF job to query

Responses

Response samples

200
401
404
500

Content type

application/json

{"jobState": "undefined",
"message": "string",
"resultParams": [{"name": "TargetDir",
"value": "t:\\dh"
},
{"name": "JobStatus",
"value": "FINISHED"
}
],
"resultFileIDs": [0
]
}

Retrieve metadata of a result file

A GET query to this route retrieves (if available) meta-information about a job result, e.g. status, size, etc. See Result schema for details.

path Parameters

jobID required	string ID of the DPF job to query
fileID required	integer ID of the result file

Responses

Response samples

200
401
404
500

Content type

application/json

{"fileID": 0,
"fileName": "string",
"fileSize": "string",
"comment": "string"
}

Retreive content of result file as stream

A GET query to this route retrieves the content of the result file as stream.

path Parameters

jobID required	string
fileID required	integer

Responses

Response samples

401
404
500

Content type

application/json

{"code": 0,
"message": "string",
"fields": "string"
}

Retrieve log file of an job

DPF files log information for each job. Use a GET query to this route to access it.

path Parameters

jobID

required

string

ID of the DPF job to query

Responses

Response samples

401
404
500
501

Content type

application/json

{"code": 0,
"message": "string",
"fields": "string"
}

Input Files

Add an input file

Define an additional input file for the job. A POST call to this route creates a new entry in the list. Without any parameters, an empty record is create. You may include metadata (such as a source URL) with the call to define the file

path Parameters

jobID

required

string

ID of the DPF job to modify

Request Body schema: application/json

Input file parameter passed as JSON object. See schema 'InputFile'

fileName	string
dpfParamName	string
fileType	string

Responses

Request samples

Payload

Content type

application/json

{"fileName": "string",
"dpfParamName": "string",
"fileType": "string"
}

Response samples

201
400
401
404
500

Content type

application/json

{"fileid": 0
}

Upload content of input file as stream

path Parameters

jobID required	string ID of the DPF job to query
fileID required	integer ID of the input file

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"code": 0,
"message": "string",
"fields": "string"
}

Control

Start a job

When a DPF job is defined and ready for processing, it may be started by a POST query to this route.

path Parameters

jobID

required

string

ID of the DPF job to start

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"trackerURL": "string"
}

Stop a running job

A running DPF job may be aborted by a POST query to this route.

path Parameters

jobID

required

string

ID of the DPF job to stop

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"code": 0,
"message": "string",
"fields": "string"
}

Get status of job

Get status of DPF Job

path Parameters

jobID

required

string

ID of the DPF job to stop

query Parameters

verbose

boolean

use verbose to get detailed status information and job history

Responses

Response samples

200
401
404
500

Content type

application/json

{"jobstate": "undefined",
"message": "string",
"jobTrackerUrl": "string",
"db_jobstates": {"db_jobstate": "string",
"db_internalstate": "string"
},
"jobstate_history": [{"jobid": "string",
"exitstatus": "string",
"wfname": "string",
"wfpos": "string",
"wfpath": "string",
"time": "string",
"internalstate": "string",
"nodename": "string"
}
]
}

Results

Get result parameter

Delievers a result object with result parameters and a list of file IDs of generated output files. This subresoures can be received by a GET request to route /jobs/{jobID}/result/{fileID}.

path Parameters

jobID

required

string

ID of the DPF job to query

Responses

Response samples

200
401
404
500

Content type

application/json

{"jobState": "undefined",
"message": "string",
"resultParams": [{"name": "TargetDir",
"value": "t:\\dh"
},
{"name": "JobStatus",
"value": "FINISHED"
}
],
"resultFileIDs": [0
]
}

Retrieve metadata of a result file

A GET query to this route retrieves (if available) meta-information about a job result, e.g. status, size, etc. See Result schema for details.

path Parameters

jobID required	string ID of the DPF job to query
fileID required	integer ID of the result file

Responses

Response samples

200
401
404
500

Content type

application/json

{"fileID": 0,
"fileName": "string",
"fileSize": "string",
"comment": "string"
}

Retreive content of result file as stream

A GET query to this route retrieves the content of the result file as stream.

path Parameters

jobID required	string
fileID required	integer

Responses

Response samples

401
404
500

Content type

application/json

{"code": 0,
"message": "string",
"fields": "string"
}

Logs

Retrieve log file of an job

DPF files log information for each job. Use a GET query to this route to access it.

path Parameters

jobID

required

string

ID of the DPF job to query

Responses

Response samples

401
404
500
501

Content type

application/json

{"code": 0,
"message": "string",
"fields": "string"
}

UI

Retrieve the panel configuration for Seal Operator

Panel configuration for Seal Operator dynamically generated from DPF Configuration File

Responses

Response samples

401
404
500

Content type

application/json

{"code": 0,
"message": "string",
"fields": "string"
}

Version

Retrieve the version information

Retreive versions of Swagger API, war file and git

Responses

Response samples

200
500

Content type

application/json

{"Swagger_API_Version": "string",
"War_File_Version": "string",
"Git_Commit_ID": "string"
}