Get a license

GET/licenses/{licenseId}/

API version

v2

Request method

GET

Operation ID

license-get-license

---

Request

• licenseIdstring (uuid)

  required

  ID of the license to be retrieved.

Responses

Format

application/json

Description

OK

Schema documentation

• descriptionstring

  required
• expiryDatestring (date-time)
• idstring (uuid)

  required
• keyReferenceone of 2 alternatives
  • Alternativeobject
    • keystring

      required
  • Alternativeobject
    • externalKeystring

      required
• kind"typo3-elts"

  required
• metaobject

  required
  • appVersionobject
    • descriptionstring

      required
• referenceobject

  required
  • aggregate"project"

    required
  • domain"project"

    required
  • idstring

    required
• volumeinteger

Example

Content-Type: application/json

{
  "description": "string",
  "expiryDate": "1985-10-26T01:21:00.000Z",
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "keyReference": {
    "key": "Afdkj49dsfj3"
  },
  "kind": "typo3-elts",
  "meta": {
    "appVersion": {
      "description": "string"
    }
  },
  "reference": {
    "aggregate": "project",
    "domain": "project",
    "id": "string"
  },
  "volume": 123
}

JSON Schema

{
  "properties": {
    "description": {
      "type": "string"
    },
    "expiryDate": {
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "keyReference": {
      "oneOf": [
        {
          "properties": {
            "key": {
              "example": "Afdkj49dsfj3",
              "type": "string"
            }
          },
          "required": [
            "key"
          ],
          "type": "object"
        },
        {
          "properties": {
            "externalKey": {
              "type": "string"
            }
          },
          "required": [
            "externalKey"
          ],
          "type": "object"
        }
      ]
    },
    "kind": {
      "enum": [
        "typo3-elts"
      ],
      "type": "string"
    },
    "meta": {
      "properties": {
        "appVersion": {
          "properties": {
            "description": {
              "type": "string"
            }
          },
          "required": [
            "description"
          ],
          "type": "object"
        }
      },
      "type": "object"
    },
    "reference": {
      "properties": {
        "aggregate": {
          "enum": [
            "project"
          ],
          "type": "string"
        },
        "domain": {
          "enum": [
            "project"
          ],
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "domain",
        "aggregate"
      ],
      "type": "object"
    },
    "volume": {
      "type": "integer"
    }
  },
  "required": [
    "id",
    "description",
    "kind",
    "reference",
    "meta"
  ],
  "type": "object"
}

Usage examples

cURL

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

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.license.getLicense({
  "licenseId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\License\GetLicense\GetLicenseRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetLicenseRequest(
  licenseId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->license()->getLicense($request);

var_dump($response->getBody();