API docs by Redocly

DPF Management REST API (1.0)

Download OpenAPI specification:

jobs

Job Management APIs

get all jobIds

Returns a list of all jobIds currently held in storage backend. The result of this query can be reduced by filters provided in query parameters. If no filters are provided, all available jobIds are returned.

query Parameters
limit
integer
Example: limit=100

Maximum number of jobId's per page. If parameter 'limit' is not provided, the response will use it's default limit value to limit items per page.

offset
integer
Example: offset=150

Start index of the requested page. If no offset is provided, index at position '0' is assumed, meaning the first page is returned.

sort
string
Example: sort=sort=wf,-timestamp.tsInserted

The sort argument is a comma separated list of fields to sort the results by. If the sort field is prefixed with a minus sign (-), the results will be sorted in descending order, otherwise in ascending order.

total
boolean
Example: total=total=false

The total argument spezifies if the total number of jobIds should be returned. Default of total is `true``.

.*
string.*
Example: .*=wf=example&current.exitStatus!=OK

Any other query parameter will be treated as a filter. The filter parameter is a key-value pair where the key is an arbitrary field in the job object to filter by and the value is the value to filter for. Standard comparison operations (=, !=, >, <, >=, <=) are supported. All given filters are combined with a logical AND.

Responses

Response samples

Content type
application/json
{
  • "total": 23,
  • "limit": 10,
  • "offset": 20,
  • "jobIds": [
    ]
}

get job details

Returns a single job including details and history data according to the JSON schema defined in ADR 0001.

path Parameters
jobId
required
string (jobId)
Example: 2024041909203198765

a DPF job's jobID

Responses

Response samples

Content type
application/json
{
  • "_id": "3fb45606-dd85-434b-b349-cd5c124824d0",
  • "jobId": "2024041909203198765",
  • "jobName": "Vom Client vergebener Name",
  • "timestamps": {
    },
  • "wf": "string",
  • "jobPriority": 0,
  • "current": {
    },
  • "history": [
    ]
}

delete jobs

Marks the job identified by parameter jobId for deletion in backend.

path Parameters
jobId
required
string (jobId)
Example: 2024041909203198765

a DPF job's jobID

Responses

modify jobs

Modifies a job and returns the resulting job details. For now only the current status of a job can be changed. When the job's state is changed to cancel, of course the job is cancelled. When a job's state is set to repeat, the service will change the job's state to repeat, clean up the job's directory and afterwards set it's state to transferred again, so the job will be processed once more.

path Parameters
jobId
required
string (jobId)
Example: 2024041909203198765

a DPF job's jobID

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "current": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "3fb45606-dd85-434b-b349-cd5c124824d0",
  • "jobId": "2024041909203198765",
  • "jobName": "Vom Client vergebener Name",
  • "timestamps": {
    },
  • "wf": "string",
  • "jobPriority": 0,
  • "current": {
    },
  • "history": [
    ]
}

version

Version Information

get version information

Returns this service's version information

Responses

Response samples

Content type
application/json
{
  • "swaggerApiVersion": "1.0",
  • "serviceName": "dpf-management-rest-api",
  • "serviceVersion": "1.6.3"
}