List Extensions of own contributor

GET/contributors/{contributorId}/extensions/

API version

v2

Request method

GET

Operation ID

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.

Format

application/json

Beschreibung

OK

Schema-Dokumentation

• Array[
• *object
  • 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
  • descriptionstring
  • detailedDescriptionsobject

    Supported languages. Format ISO-639-1.

    • 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
  • frontendComponentsarray of object
    • Array[
    • *object
      • namestring

        required
      • urlstring

        required
    ]
• frontendFragmentsobject
  • *one of 1 alternatives
    • Alternativeobject
      • urlstring

        required
• idstring (uuid)

  required
• namestring

  required
• scopesarray of string
  • Array[
  • *string
  ]

statestring (one of: enabled, blocked, disabled)

deprecated

supportobject

• emailstring
• phonestring

tagsarray of string

• Array[
• *string
]

]

Beispiel

[
  {
    "backendComponents": {
      "extensionAddedToContext": {
        "url": "string"
      },
      "extensionInstanceRemovedFromContext": {
        "url": "string"
      },
      "extensionInstanceSecretRotated": {
        "url": "string"
      },
      "extensionInstanceUpdated": {
        "url": "string"
      }
    },
    "blocked": true,
    "context": "project",
    "contributorId": "string",
    "description": "string",
    "detailedDescriptions": {
      "de": {
        "markdown": "string",
        "plain": "string"
      },
      "en": {
        "markdown": "string",
        "plain": "string"
      }
    },
    "disabled": true,
    "frontendComponents": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "frontendFragments": {
      "string": {
        "url": "string"
      }
    },
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "name": "string",
    "scopes": [
      "string"
    ],
    "state": "enabled",
    "support": {
      "email": "a.lovelace@example.com",
      "phone": "string"
    },
    "tags": [
      "string"
    ]
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "backendComponents": {
        "properties": {
          "extensionAddedToContext": {
            "properties": {
              "url": {
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "url"
            ],
            "type": "object"
          },
          "extensionInstanceRemovedFromContext": {
            "properties": {
              "url": {
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "url"
            ],
            "type": "object"
          },
          "extensionInstanceSecretRotated": {
            "properties": {
              "url": {
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "url"
            ],
            "type": "object"
          },
          "extensionInstanceUpdated": {
            "properties": {
              "url": {
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "url"
            ],
            "type": "object"
          }
        },
        "type": "object"
      },
      "blocked": {
        "deprecated": true,
        "type": "boolean"
      },
      "context": {
        "enum": [
          "project",
          "customer"
        ],
        "type": "string"
      },
      "contributorId": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "detailedDescriptions": {
        "description": "Supported languages. Format ISO-639-1.",
        "properties": {
          "de": {
            "description": "Language specific descriptions in various formats.",
            "properties": {
              "markdown": {
                "minLength": 1,
                "type": "string"
              },
              "plain": {
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "markdown"
            ],
            "type": "object"
          },
          "en": {
            "description": "Language specific descriptions in various formats.",
            "properties": {
              "markdown": {
                "minLength": 1,
                "type": "string"
              },
              "plain": {
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "markdown"
            ],
            "type": "object"
          }
        },
        "required": [
          "de"
        ],
        "type": "object"
      },
      "disabled": {
        "type": "boolean"
      },
      "frontendComponents": {
        "items": {
          "properties": {
            "name": {
              "type": "string"
            },
            "url": {
              "type": "string"
            }
          },
          "required": [
            "name",
            "url"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "frontendFragments": {
        "additionalProperties": {
          "oneOf": [
            {
              "properties": {
                "url": {
                  "type": "string"
                }
              },
              "required": [
                "url"
              ],
              "type": "object"
            }
          ]
        },
        "type": "object"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "scopes": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "state": {
        "description": "deprecated",
        "enum": [
          "enabled",
          "blocked",
          "disabled"
        ],
        "type": "string"
      },
      "support": {
        "properties": {
          "email": {
            "example": "a.lovelace@example.com",
            "type": "string"
          },
          "phone": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "tags": {
        "items": {
          "type": "string"
        },
        "minItems": 0,
        "type": "array"
      }
    },
    "required": [
      "id",
      "contributorId",
      "name"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/contributors/string/extensions?limit=50&page=1

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.extensionListOwnExtensions({
  "contributorId": "string",
  "queryParameters": {
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionListOwnExtensions\ExtensionListOwnExtensionsRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ExtensionListOwnExtensionsRequest(
  contributorId: "string"
))
  ->withLimit(50)
  ->withPage(1);
$response = $client->marketplace()->extensionListOwnExtensions($request);

var_dump($response->getBody();