c27c5cae42
To comply with recent documentation policies the API documentaion should be maintained within the project source repository. Change-Id: I0f854eea33d1a895580589e91c17c89e42b3df0a
62 lines
1.0 KiB
ReStructuredText
62 lines
1.0 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=========
|
|
Job types
|
|
=========
|
|
|
|
Each plugin that supports EDP also supports specific job types.
|
|
Different versions of a plugin might actually support different job
|
|
types. Configuration options vary by plugin, version, and job type.
|
|
|
|
The job types provide information about which plugins support which
|
|
job types and how to configure the job types.
|
|
|
|
|
|
List job types
|
|
==============
|
|
|
|
.. rest_method:: GET /v1.1/{tenant_id}/job-types
|
|
|
|
Lists all job types.
|
|
|
|
You can use query parameters to filter the response.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: url_tenant_id
|
|
- plugin: plugin
|
|
- version: version
|
|
- type: type
|
|
- hints: hints
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- versions: versions
|
|
- title: title
|
|
- description: description
|
|
- job_types: job_types
|
|
- name: name
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/job-types/job-types-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|