Axway · Schema

Application

API ManagementEnterpriseIntegrationSecurity

Properties

Name Type Description
_id string ID of the application.
apis array
automatic boolean
env string
guid string Application guid.
org_guid string The `guid` of the org the application belongs to.
platform string Name of the platform the application being developed for.
provider_guid string
providers array The provider marketplaces the application is published to. Set for "product" and "documentresource" applications.
source string
subtype string
type string Type of the application
View JSON Schema on GitHub

JSON Schema

axway-application-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Application",
  "title": "Application",
  "type": "object",
  "required": [
    "guid",
    "name",
    "org_guid",
    "platform",
    "type"
  ],
  "unevaluatedProperties": false,
  "allOf": [
    {
      "$ref": "#/components/schemas/DefaultFields"
    }
  ],
  "if": {
    "type": "object",
    "title": "Document Resource",
    "properties": {
      "type": {
        "type": "string",
        "enum": [
          "documentresource"
        ]
      }
    }
  },
  "then": {
    "type": "object",
    "title": "Document Resource",
    "properties": {
      "default_lang": {
        "type": [
          "string",
          "null"
        ],
        "enum": [
          "en-US",
          "fr-FR",
          "de-DE",
          "pt-BR"
        ]
      },
      "description": {
        "type": "object",
        "description": "Description of the application.",
        "properties": {
          "en-US": {
            "type": [
              "string",
              "null"
            ],
            "description": "English language value.",
            "x-no-tags": true
          },
          "fr-FR": {
            "type": [
              "string",
              "null"
            ],
            "description": "French language value.",
            "x-no-tags": true
          },
          "de-DE": {
            "type": [
              "string",
              "null"
            ],
            "description": "German language value.",
            "x-no-tags": true
          },
          "pt-BR": {
            "type": [
              "string",
              "null"
            ],
            "description": "Portuguese language value.",
            "x-no-tags": true
          }
        }
      },
      "name": {
        "type": "object",
        "description": "Name of the application.",
        "properties": {
          "en-US": {
            "type": [
              "string",
              "null"
            ],
            "description": "English language value.",
            "x-no-tags": true
          },
          "fr-FR": {
            "type": [
              "string",
              "null"
            ],
            "description": "French language value.",
            "x-no-tags": true
          },
          "de-DE": {
            "type": [
              "string",
              "null"
            ],
            "description": "German language value.",
            "x-no-tags": true
          },
          "pt-BR": {
            "type": [
              "string",
              "null"
            ],
            "description": "Portuguese language value.",
            "x-no-tags": true
          }
        }
      },
      "url": {
        "type": "object",
        "description": "URL for the application.",
        "properties": {
          "en-US": {
            "type": [
              "string",
              "null"
            ],
            "description": "English language value.",
            "x-no-tags": true
          },
          "fr-FR": {
            "type": [
              "string",
              "null"
            ],
            "description": "French language value.",
            "x-no-tags": true
          },
          "de-DE": {
            "type": [
              "string",
              "null"
            ],
            "description": "German language value.",
            "x-no-tags": true
          },
          "pt-BR": {
            "type": [
              "string",
              "null"
            ],
            "description": "Portuguese language value.",
            "x-no-tags": true
          }
        }
      }
    }
  },
  "else": {
    "type": "object",
    "title": "Other Type",
    "properties": {
      "description": {
        "type": "string",
        "description": "Description of the application.",
        "x-no-tags": true
      },
      "name": {
        "type": "string",
        "description": "Name of the application.",
        "x-no-tags": true
      },
      "url": {
        "type": "string",
        "description": "URL for the application.",
        "x-no-tags": true
      }
    }
  },
  "properties": {
    "_id": {
      "type": "string",
      "description": "ID of the application.",
      "readOnly": true,
      "deprecated": true,
      "example": "507f1f77bcf86cd799439011"
    },
    "apis": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "example_value"
      ]
    },
    "automatic": {
      "type": "boolean",
      "example": true
    },
    "env": {
      "type": "string",
      "example": "example_value"
    },
    "guid": {
      "type": "string",
      "description": "Application guid.",
      "example": "example_value"
    },
    "org_guid": {
      "type": "string",
      "description": "The `guid` of the org the application belongs to.",
      "example": "example_value"
    },
    "platform": {
      "type": "string",
      "description": "Name of the platform the application being developed for.",
      "example": "example_value"
    },
    "provider_guid": {
      "type": "string",
      "example": "example_value"
    },
    "providers": {
      "type": "array",
      "description": "The provider marketplaces the application is published to. Set for \"product\" and \"documentresource\" applications.",
      "items": {
        "type": "object",
        "required": [
          "guid"
        ],
        "properties": {
          "guid": {
            "type": "string",
            "description": "The `guid` of the provider marketplace."
          },
          "published_id": {
            "type": "string",
            "description": "The published id of the application in the provider marketplace."
          }
        }
      },
      "example": [
        {
          "guid": "example_value",
          "published_id": "507f1f77bcf86cd799439011"
        }
      ]
    },
    "source": {
      "type": "string",
      "x-no-tags": true,
      "example": "example_value"
    },
    "subtype": {
      "type": "string",
      "x-no-tags": true,
      "example": "example_value"
    },
    "type": {
      "type": "string",
      "description": "Type of the application",
      "x-no-tags": true,
      "example": "example_value"
    }
  }
}