Zum Hauptinhalt springen

Get a system software version

GET/system-softwares/{systemSoftwareId}/versions/{systemSoftwareVersionId}/
v2
GET
app-get-systemsoftwareversion

Request​

  • systemSoftwareIdstring (uuid)
    required
  • systemSoftwareVersionIdstring (uuid)
    required

Responses​

application/json

The systemSoftwareVersion object.

  • expiryDatestring (date-time)
  • externalVersionstring
    required
  • feeone of 2 alternatives

    A strategy for fees of resources.

    • Alternativeobject

      A strategy for fees that occur once.

      • pricenumber
        required

        The one-time price in Euro Cents.

    • Alternativeobject

      A strategy for fees that occur periodically

      • periodsarray of object
        required
        • Array[
          • *object
            • feeValidFromstring (date-time)
            • feeValidUntilstring (date-time)
            • monthlyPricenumber
              required

              The monthly price in Euro Cents.

          ]
  • idstring (uuid)
    required
  • internalVersionstring
    required
  • recommendedboolean
  • systemSoftwareDependenciesarray of object
    • Array[

      A SystemSoftwareDependency is a description of a need for a specific SystemSoftware in a semver versionRange.

      • *object

        A SystemSoftwareDependency is a description of a need for a specific SystemSoftware in a semver versionRange.

        • systemSoftwareIdstring (uuid)
          required
        • versionRangestring
          required
      ]
  • userInputsarray of object
    • Array[

      A UserInput is a description of an information which cannot be determined or estimated by mittwald, but has to be given by the person who is requesting an AppInstallation or SystemSoftware.

      • *object

        A UserInput is a description of an information which cannot be determined or estimated by mittwald, but has to be given by the person who is requesting an AppInstallation or SystemSoftware.

        • additionalValidationSchemaobject

          AdditionalValidationSchema is a stringified custom validation schema, e.g password rules.

          • kind"password-rule"

            AdditionalValidationSchemaKind is an enum, describing the possible types of an additional validation schema.

          • schemastring
        • dataSourcestring

          Optional field to tell the frontend, which data to put into the select.

        • dataTypestring (one of: text, number, boolean, select)
          required

          UserInputDataType is an enum, describing the possible data types of a UserInput.

        • defaultValuestring
        • formatstring (one of: email, password, url, uri)

          UserInputFormat is an enum, describing the possible data formats of a UserInput, the given values can be validated against.

        • lifecycleConstraintstring (one of: installation, update, reconfigure)
          required

          The AppInstallationLifecycle can be used to express a specific point in the AppInstallation Lifecycle, e.g. while installing a new AppInstallation.

        • namestring
          required
        • positionMetaobject

          UserInputPositionMeta is a utility information, helping to position the UserInput properly on the frontend.

          • indexinteger
          • sectionstring
          • stepstring
        • requiredboolean
          required
        • validationSchemastring
          required

          JSON Schema formatted (https://json-schema.org/).

      ]

Usage examples​

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/system-softwares/f0f86186-0a5a-45b2-aa33-502777496347/versions/f0f86186-0a5a-45b2-aa33-502777496347