Skip to main content

Get Extension of own contributor

GET/contributors/{contributorId}/extensions/{extensionId}/
v2
GET
extension-get-own-extension

Request​

  • contributorIdstring
    required
  • extensionIdstring (uuid)
    required

Responses​

application/json

Get your own extension.

  • assetsarray of object
    required
    • Array[

      The following assets are the media that are associated with the extension and will be shown in extension details page.

      • *object

        The following assets are the media that are associated with the extension and will be shown in extension details page.

        • assetTypestring (one of: image, video)
          required
        • fileNamestring
          deprecated
        • idstring (uuid)
          required

          The asset ID and reference ID to its file. Retrieve the file with this id on `/v2/files/{id}

        • indexinteger
          required

          The index of the asset. Does not have to be successive. Can be used to order the assets.

      ]
  • backendComponentsobject
    deprecated
    • extensionAddedToContextobject
      deprecated
      • urlstring (≥ 1 characters)
        required
    • extensionInstanceRemovedFromContextobject
      deprecated
      • urlstring (≥ 1 characters)
        required
    • extensionInstanceSecretRotatedobject
      deprecated
      • urlstring (≥ 1 characters)
        required
    • extensionInstanceUpdatedobject
      deprecated
      • urlstring (≥ 1 characters)
        required
  • blockedboolean
    deprecated
  • contextstring (one of: project, customer)
  • contributorIdstring
    required
  • deprecationobject

    The Extension is deprecated by the contributor and will expire at the given date.

    • deprecatedAtstring (date-time)
      required
    • notestring
    • successorIdstring (uuid)

      The ID of the successor extension.

  • descriptionstring
  • detailedDescriptionsobject

    A detailed description of the capabilities of the extension.

    • deobject
      required

      Language specific descriptions in various formats.

      • markdownstring (≥ 1 characters)
        required
      • plainstring (≥ 1 characters)
    • enobject

      Language specific descriptions in various formats.

      • markdownstring (≥ 1 characters)
        required
      • plainstring (≥ 1 characters)
  • disabledboolean
    deprecated
  • externalFrontendsarray of object
    • Array[
      • *object
        • namestring
          required
        • urlstring
          required
      ]
  • frontendComponentsarray of object
    deprecated
    • Array[
      • *object
        • namestring
          required
        • urlstring
          required
      ]
  • frontendFragmentsobject
    • *
  • functionalboolean
    required
  • idstring (uuid)
    required
  • logoRefIdstring (uuid)

    This is the FileId of the Logo. Retrieve the file with this id on /v2/files/{logoRefId}.

  • namestring
    required
  • pricingone of 1 alternatives
    • Alternativearray of object

      A price plan with (multiple) variants, including different prices for different included service descriptions

      • Array[
        • *object
          • deletionDeadlinestring (date-time)
          • descriptionstring
          • isBookingStoppedboolean
            required

            If a variant is no longer bookable the existing extension instances will not be removed but no new ones can be created.

          • isDeletionScheduledboolean
            required
          • keystring
            required
          • namestring
          • priceInCentsinteger
            required

            The monthly price in Euro Cents before tax.

        ]
  • pricingDetailsobject

    The details section of the price plan. It informs if choosing different variants as a upgrade or downgrade is possible.

    • isDowngradeAllowedboolean
      required
    • isUpgradeAllowedboolean
      required
  • publishedboolean
    required
  • requestedChangesobject
    • contextstring (one of: project, customer)
    • scopesarray of string
      • Array[
        • *string
        ]
    • webhookUrlsone of 2 alternatives
      • Alternativeobject
        • extensionAddedToContextobject
          required
          • urlstring (≥ 1 characters)
            required
        • extensionInstanceRemovedFromContextobject
          required
          • urlstring (≥ 1 characters)
            required
        • extensionInstanceSecretRotatedobject
          required
          • urlstring (≥ 1 characters)
            required
        • extensionInstanceUpdatedobject
          required
          • urlstring (≥ 1 characters)
            required
      • Alternativeobject
    • scopesarray of string
      • Array[
        • *string
        ]
    • secretsarray of object
      required
      • Array[
        • *object
          • secretIdstring (uuid)
            required
          • usableUntilstring (date-time)
        ]
    • statestring (one of: enabled, blocked, disabled)
      deprecated

      deprecated

    • statisticsobject
      required
      • amountOfInstancesinteger (≥ 0)

        The amout of instances for this extension. Accurate for the Contributor. Publicly rounded to the next lower hundred.

    • subTitleobject

      A few words to promote your Extension.

      • destring (≤ 40 characters)
        required
      • enstring (≤ 40 characters)
    • support
    • tagsarray of string
      • Array[
        • *string
        ]
    • verificationRequestedboolean
      required
    • verifiedboolean
      required
    • webhookUrlsobject
      • extensionAddedToContextobject
        required
        • urlstring (≥ 1 characters)
          required
      • extensionInstanceRemovedFromContextobject
        required
        • urlstring (≥ 1 characters)
          required
      • extensionInstanceSecretRotatedobject
        required
        • urlstring (≥ 1 characters)
          required
      • extensionInstanceUpdatedobject
        required
        • urlstring (≥ 1 characters)
          required

    Usage examples​

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