List extension instances

GET/extension-instances/

API version

v2

Request method

GET

Operation ID

extension-list-extension-instances

---

Request

Responses

Response-Header

• X-Pagination-Limitinteger

  The limit used to select the resources for the response

• X-Pagination-Skipinteger

  The number of skipped items

• X-Pagination-Pagenumber

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

• X-Pagination-TotalCountinteger

  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

A list of extension instances.

Schema-Dokumentation

• Array[
  • *object
    • aggregateReferenceobject

      required
      • aggregatestring

        required
      • domainstring

        required
      • idstring (uuid)

        required
    • chargeabilityobject

      required
      • isChargeableboolean

        required
      • reasonsobject

        required
        • isNonChargeableCustomerboolean

          required
        • isOwnExtensionboolean

          required
    • consentedScopesarray of string

      required
      • Array[
        • *string
        ]
    • contributorIdstring

      required
    • contributorNamestring

      required
    • createdAtstring (date-time)
    • disabledboolean

      required
    • extensionIdstring (uuid)

      required
    • extensionNamestring

      required
    • extensionSubTitleobject

      A few words to promote your Extension.

      • destring (≤ 40 characters)

        required
      • enstring (≤ 40 characters)
    • frontendFragmentsobject
      • *
    • idstring (uuid)

      required
    • pendingInstallationboolean

      required
    • pendingRemovalboolean

      required
    • variantKeystring
  ]

Beispiel

Content-Type: application/json

[
  {
    "aggregateReference": {
      "aggregate": "string",
      "domain": "string",
      "id": "f0f86186-0a5a-45b2-aa33-502777496347"
    },
    "chargeability": {
      "isChargeable": true,
      "reasons": {
        "isNonChargeableCustomer": true,
        "isOwnExtension": true
      }
    },
    "consentedScopes": [
      "string"
    ],
    "contributorId": "string",
    "contributorName": "string",
    "createdAt": "1985-10-26T01:21:00.000Z",
    "disabled": true,
    "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "extensionName": "string",
    "extensionSubTitle": {
      "de": "Ping deine App an",
      "en": "Ping your app"
    },
    "frontendFragments": {
      "string": null
    },
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "pendingInstallation": true,
    "pendingRemoval": true,
    "variantKey": "default"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "aggregateReference": {
        "properties": {
          "aggregate": {
            "type": "string"
          },
          "domain": {
            "type": "string"
          },
          "id": {
            "format": "uuid",
            "type": "string"
          }
        },
        "required": [
          "id",
          "domain",
          "aggregate"
        ],
        "type": "object"
      },
      "chargeability": {
        "properties": {
          "isChargeable": {
            "default": false,
            "type": "boolean"
          },
          "reasons": {
            "properties": {
              "isNonChargeableCustomer": {
                "type": "boolean"
              },
              "isOwnExtension": {
                "type": "boolean"
              }
            },
            "required": [
              "isOwnExtension",
              "isNonChargeableCustomer"
            ],
            "type": "object"
          }
        },
        "required": [
          "isChargeable",
          "reasons"
        ],
        "type": "object"
      },
      "consentedScopes": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "contributorId": {
        "type": "string"
      },
      "contributorName": {
        "type": "string"
      },
      "createdAt": {
        "format": "date-time",
        "type": "string"
      },
      "disabled": {
        "default": false,
        "type": "boolean"
      },
      "extensionId": {
        "format": "uuid",
        "type": "string"
      },
      "extensionName": {
        "type": "string"
      },
      "extensionSubTitle": {
        "description": "A few words to promote your Extension.",
        "properties": {
          "de": {
            "example": "Ping deine App an",
            "maxLength": 40,
            "type": "string"
          },
          "en": {
            "example": "Ping your app",
            "maxLength": 40,
            "type": "string"
          }
        },
        "required": [
          "de"
        ],
        "type": "object"
      },
      "frontendFragments": {
        "additionalProperties": {
          "allOf": [
            {
              "properties": {
                "additionalProperties": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "type": "object"
                }
              },
              "type": "object"
            },
            {
              "oneOf": [
                {
                  "properties": {
                    "url": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "url"
                  ],
                  "type": "object"
                }
              ]
            }
          ]
        },
        "type": "object"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "pendingInstallation": {
        "default": false,
        "type": "boolean"
      },
      "pendingRemoval": {
        "default": false,
        "type": "boolean"
      },
      "variantKey": {
        "example": "default",
        "type": "string"
      }
    },
    "required": [
      "id",
      "extensionId",
      "contributorId",
      "disabled",
      "pendingInstallation",
      "pendingRemoval",
      "consentedScopes",
      "aggregateReference",
      "extensionName",
      "contributorName",
      "chargeability"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/extension-instances?context=project&contextId=string&extensionId=f0f86186-0a5a-45b2-aa33-502777496347&searchTerm=string&anchor=string&limit=50&page=1&sort=createdAt&order=asc

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.extensionListExtensionInstances({
  "queryParameters": {
    "context": "project",
    "contextId": "string",
    "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "searchTerm": "string",
    "anchor": "string",
    "limit": 50,
    "page": 1,
    "sort": [
      "createdAt"
    ],
    "order": [
      "asc"
    ]
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ExtensionListExtensionInstancesRequest())
  ->withContext("project")
  ->withContextId("string")
  ->withExtensionId("f0f86186-0a5a-45b2-aa33-502777496347")
  ->withSearchTerm("string")
  ->withAnchor("string")
  ->withLimit(50)
  ->withPage(1)
  ->withSort(["createdAt"])
  ->withOrder(["asc"]);
$response = $client->marketplace()->extensionListExtensionInstances($request);

var_dump($response->getBody();