cronjob-Softwaretemplates auslesen

GET /v1/cronjobs/softwaretemplates/

API version

v1

Request method

GET

Operation ID

getCronjobSoftwaretemplates

---

Diese Operation liest die die Cronjob-Softwaretemplates aus

Request

No request parameters.

Responses

Format

application/json

Description

Die Cronjob-Softwaretemplates

Schema documentation

• Array[
• *object
  • namestring

    required
  • uidnumber

    required
  • softwareobject

    required
    • identifierstring

      required
    • uidnumber

      required
  • cronjobobject

    required
    • uidinteger

      required
    • namestring

      required
    • enabledboolean

      required
    • errorReportingstring (one of: NONE, MAIL_ON_FAILURE, MAIL)

      required
    • errorReportingEmailstring

      required
    • customTimeoutModenumber (one of: 0, 1)

      required

      Whether a custom timeout is set

    • customTimeoutValuenumber

      Amount of custom timeout

    • typestring (one of: SERVER, BROWSER, INTERPRETER)

      required

      Type of cronjob (server based, browser based, custom interpreter)

    • intervalarray of string

      required

      Crontab interval

      • Array[
      • *string
      ]
  • statusnumber

    required
  • filestring
  • paramsstring
  • urlstring
  • interpreterobject
    • hiddenboolean

      required
    • namestring

      required
    • typestring

      required
    • uidnumber

      required

]

Example

[
  {
    "name": "string",
    "uid": 123,
    "software": {
      "identifier": "string",
      "uid": 123
    },
    "cronjob": {
      "uid": 123,
      "name": "string",
      "enabled": true,
      "errorReporting": "NONE",
      "errorReportingEmail": "string",
      "customTimeoutMode": 123,
      "customTimeoutValue": 123,
      "type": "SERVER",
      "interval": [
        "string"
      ],
      "status": 123,
      "file": "string",
      "params": "string",
      "url": "string",
      "interpreter": {
        "hidden": true,
        "name": "string",
        "type": "string",
        "uid": 123
      }
    }
  }
]

JSON Schema

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "cronjob",
      "name",
      "software",
      "uid"
    ],
    "properties": {
      "name": {
        "type": "string"
      },
      "uid": {
        "type": "number"
      },
      "software": {
        "type": "object",
        "required": [
          "identifier",
          "uid"
        ],
        "properties": {
          "identifier": {
            "type": "string"
          },
          "uid": {
            "type": "number"
          }
        }
      },
      "cronjob": {
        "type": "object",
        "required": [
          "uid",
          "name",
          "enabled",
          "errorReporting",
          "errorReportingEmail",
          "customTimeoutMode",
          "type",
          "interval",
          "status"
        ],
        "properties": {
          "uid": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "errorReporting": {
            "type": "string",
            "enum": [
              "NONE",
              "MAIL_ON_FAILURE",
              "MAIL"
            ]
          },
          "errorReportingEmail": {
            "type": "string"
          },
          "customTimeoutMode": {
            "description": "Whether a custom timeout is set",
            "type": "number",
            "enum": [
              0,
              1
            ]
          },
          "customTimeoutValue": {
            "description": "Amount of custom timeout",
            "type": "number"
          },
          "type": {
            "description": "Type of cronjob (server based, browser based, custom interpreter)",
            "type": "string",
            "enum": [
              "SERVER",
              "BROWSER",
              "INTERPRETER"
            ]
          },
          "interval": {
            "description": "Crontab interval",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "status": {
            "type": "number"
          },
          "file": {
            "type": "string"
          },
          "params": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "interpreter": {
            "type": "object",
            "required": [
              "hidden",
              "name",
              "type",
              "uid"
            ],
            "properties": {
              "hidden": {
                "type": "boolean"
              },
              "name": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "uid": {
                "type": "number"
              }
            }
          }
        }
      }
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/cronjobs/softwaretemplates