Zum Hauptinhalt springen

List Extensions of own contributor

GET/contributors/{contributorId}/extensions/
v2
GET
extension-list-own-extensions

Request​

  • contributorIdstring
    required

Responses​

Response-Header

  • X-Pagination-Limitnumber

    The limit used to select the resources for the response

  • X-Pagination-Skipnumber

    The number of skipped items

  • X-Pagination-Pagenumber

    The calculate page of the list response. Refer to parameters to learn more.

  • X-Pagination-TotalCountnumber

    The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

application/json

A list of extensions of the contributor.

  • Array[
  • *object
    • 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
        • 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
      • extensionAddedToContextobject
        • urlstring (≥ 1 characters)
          required
      • extensionInstanceRemovedFromContextobject
        • urlstring (≥ 1 characters)
          required
      • extensionInstanceSecretRotatedobject
        • urlstring (≥ 1 characters)
          required
      • extensionInstanceUpdatedobject
        • urlstring (≥ 1 characters)
          required
    • blockedboolean
    • 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
    • externalFrontendsarray of object
      • Array[
      • *object
        • namestring
          required
        • urlstring
          required
        • ]
    • frontendComponentsarray of object
      • 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
    • publishedboolean
      required
    • requestedChangesobject
      • contextstring (one of: project, customer)
      • scopesarray of string
        • Array[
        • *string
          • ]
      • 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
    • scopesarray of string
      • Array[
      • *string
        • ]
    • secretsarray of object
      required
      • Array[
      • *object
        • secretIdstring (uuid)
          required
        • usableUntilstring (date-time)
        • ]
    • statestring (one of: enabled, blocked, disabled)

      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)
    • supportobject
      • emailstring
      • phonestring
    • 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?limit=50&page=1