Create Package

Create a new application package.

POST /platform/appdev/apppackages/project

Error

A valid request URL is required to generate request examples

200

{
  "apiVersion": "<string>",
  "appConfigUrl": "<string>",
  "appId": "<string>",
  "appKey": "<string>",
  "appSchemeVersion": 123,
  "applicationAttributes": [
    {
      "attributeCodes": "<string>",
      "attributeJson": "<string>",
      "attributes": [
        {
          "adminName": "<string>",
          "applicationAttributeId": 123,
          "attributeId": 123,
          "code": "<string>",
          "fqn": "<string>",
          "inputType": "<string>",
          "name": "<string>",
          "sequence": 123,
          "type": "<string>",
          "vocabularyJson": "<string>",
          "vocabularyValues": "<string>"
        }
      ],
      "isAppliedToBase": true,
      "packageId": 123,
      "productTypeJson": "<string>",
      "sourceTenantId": 123,
      "sourceTenantName": "<string>",
      "subsystem": "<string>"
    }
  ],
  "applicationBehaviors": [
    {
      "behaviorId": 123,
      "packageId": 123
    }
  ],
  "applicationCapabilities": [
    {
      "applicationCapabilityId": 123,
      "applicationCapabilityTypeId": 123,
      "applicationEndPoint": "<string>",
      "capabilityTypeContractId": 123,
      "packageId": 123
    }
  ],
  "applicationCapabilityTypes": [
    {
      "applicationCapabilities": [
        {
          "applicationCapabilityId": 123,
          "applicationCapabilityTypeId": 123,
          "applicationEndPoint": "<string>",
          "capabilityTypeContractId": 123,
          "packageId": 123
        }
      ],
      "applicationCapabilityDomains": [
        {
          "applicationCapabilityDomainId": 123,
          "applicationCapabilityDomainValues1": [
            {
              "applicationCapabilityDomainId1": 123,
              "applicationCapabilityDomainId2": 123,
              "applicationCapabilityDomainValueId": 123,
              "displayName": "<string>",
              "valueName": "<string>"
            }
          ],
          "applicationCapabilityDomainValues2": [
            {
              "applicationCapabilityDomainId1": 123,
              "applicationCapabilityDomainId2": 123,
              "applicationCapabilityDomainValueId": 123,
              "displayName": "<string>",
              "valueName": "<string>"
            }
          ],
          "applicationCapabilityTypeId": 123,
          "name": "<string>"
        }
      ],
      "applicationCapabilityTypeId": 123,
      "applicationId": 123,
      "capabilityTypeId": 123,
      "capabilityTypeName": "<string>",
      "isImplemented": true,
      "isInitializedByDefault": true,
      "packageId": 123
    }
  ],
  "applicationDescription": "<string>",
  "applicationDetailId": 123,
  "applicationEntitlements": [
    {
      "appKey": "<string>",
      "appOwnerDevAccountId": 123,
      "applicationEntitlementId": 123,
      "applicationId": 123,
      "applicationLicenseType": "<string>",
      "applicationName": "<string>",
      "applicationStatusId": "<string>",
      "applicationTransactions": [
        {
          "applicationEntitlementId": 123,
          "applicationId": 123,
          "applicationTransactionId": 123,
          "isoCurrencyCode": "<string>",
          "localeCode": 123,
          "orderNumber": "<string>",
          "siteId": 123,
          "tenantId": 123,
          "transactionDate": "2023-11-07T05:31:56Z",
          "transactionPrice": 123,
          "transactionTax": 123,
          "transactionTotal": 123
        }
      ],
      "applicationVersion": "<string>",
      "devAccountId": 123,
      "effectiveEndDate": "2023-11-07T05:31:56Z",
      "effectiveStartDate": "2023-11-07T05:31:56Z",
      "entitlementStatus": "<string>",
      "installedAppsApplicationId": "<string>",
      "installedByFirstName": "<string>",
      "installedByLastName": "<string>",
      "installedDate": "2023-11-07T05:31:56Z",
      "packageId": 123,
      "packageName": "<string>",
      "siteId": 123,
      "tenantId": 123,
      "tenantName": "<string>"
    }
  ],
  "applicationId": 123,
  "applicationName": "<string>",
  "applicationOwnerDevAccountId": 123,
  "applicationStatus": "<string>",
  "applicationStatusId": 123,
  "applicationStatusName": "<string>",
  "applicationSubscriptions": [
    {
      "applicationEndPoint": "<string>",
      "applicationSubscriptionId": 123,
      "events": [
        {
          "apiVersionNumber": "<string>",
          "eventCategory": "<string>",
          "eventId": 123,
          "eventName": "<string>"
        }
      ],
      "noCallback": true,
      "packageId": 123
    }
  ],
  "applicationTypeId": 123,
  "applicationTypeName": "<string>",
  "applicationUpdateDate": "2023-11-07T05:31:56Z",
  "assetFileCount": 123,
  "attributeNamespace": "<string>",
  "dataNamespace": "<string>",
  "hasApplicationVersions": true,
  "id": 123,
  "isDeleted": true,
  "isLocked": true,
  "isReleasePackage": true,
  "legacyNamespace": "<string>",
  "majorVersion": 123,
  "minorVersion": 123,
  "namespace": "<string>",
  "namespaceRegistryId": "<string>",
  "packageDescription": "<string>",
  "packageGuid": "<string>",
  "packageName": "<string>",
  "parentThemeAppKey": "<string>",
  "parentThemeName": "<string>",
  "publishedParentSemanticVersion": "<string>",
  "publishedParentThemeId": 123,
  "revision": 123,
  "semanticVersionRange": "<string>",
  "sharedSecret": "<string>",
  "themeEngineVersion": "<string>",
  "updateAvailable": true,
  "updateDate": "2023-11-07T05:31:56Z",
  "updateParentAppKey": "<string>",
  "updateParentThemeName": "<string>",
  "updateParentThemeVersion": "<string>",
  "userId": "<string>",
  "validApplicationStatusIdList": [
    123
  ]
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

projectId · integer<int32>

responseFields · string

limits which fields are returned in the response body

Body

application/json

apiVersion · string | null

appConfigUrl · string | null

This will be used by the 3rd party developers to set a URL the intalled applications can call from the Tenant installation/

appId · string | null

appKey · string | null

App Key for the package in question.

appSchemeVersion · integer<int32>

applicationAttributes · object[] | null

Show child attributes

applicationBehaviors · object[] | null

List of Application Behaviors that apply to this version of the application.

Show child attributes

applicationCapabilities · object[] | null

Show child attributes

applicationCapabilityTypes · object[] | null

Show child attributes

applicationDescription · string | null

applicationDetailId · integer<int32> | null

applicationEntitlements · object[] | null

Show child attributes

applicationId · integer<int32>

applicationName · string | null

applicationOwnerDevAccountId · integer<int32>

This is the DevAccountId that owns the application

applicationStatus · string | null

applicationStatusId · integer<int32>

applicationStatusName · string | null

applicationSubscriptions · object[] | null

Show child attributes

applicationTypeId · integer<int32>

applicationTypeName · string | null

applicationUpdateDate · string<date-time> | null

assetFileCount · integer<int32>

attributeNamespace · string | null

dataNamespace · string | null

hasApplicationVersions · boolean

id · integer<int32>

isDeleted · boolean

isLocked · boolean

isReleasePackage · boolean

legacyNamespace · string | null

majorVersion · integer<int32>

minorVersion · integer<int32>

namespace · string | null

namespaceRegistryId · string | null

packageDescription · string | null

packageGuid · string | null

packageName · string | null

parentThemeAppKey · string | null

The parent theme AppKey if this is a theme and the theme extends a valid, published theme.

parentThemeName · string | null

publishedParentSemanticVersion · string | null

publishedParentThemeId · integer<int32> | null

revision · integer<int32>

semanticVersionRange · string | null

sharedSecret · string | null

themeEngineVersion · string | null

updateAvailable · boolean

Whether or not there's a theme update.

updateDate · string<date-time>

updateParentAppKey · string | null

The AppKey is a runtime type. This only applies for themes that inherit from another theme. It shows the most current update available.

updateParentThemeName · string | null

This only applies for themes that inherit from another theme. It shows the name of the most current update available.

updateParentThemeVersion · string | null

This only applies for themes that inherit from another theme. It shows the version of the most current update available.

userId · string | null

validApplicationStatusIdList · integer<int32>[] | null

List of Statuses that the application can move to during the application lifecycle. This is based on what the current value of the ApplicatinStatusId is.

Response

200

application/json

OK

apiVersion · string | null

appConfigUrl · string | null

This will be used by the 3rd party developers to set a URL the intalled applications can call from the Tenant installation/

appId · string | null

appKey · string | null

App Key for the package in question.

appSchemeVersion · integer<int32>

applicationAttributes · object[] | null

Show child attributes

applicationBehaviors · object[] | null

List of Application Behaviors that apply to this version of the application.

Show child attributes

applicationCapabilities · object[] | null

Show child attributes

applicationCapabilityTypes · object[] | null

Show child attributes

applicationDescription · string | null

applicationDetailId · integer<int32> | null

applicationEntitlements · object[] | null

Show child attributes

applicationId · integer<int32>

applicationName · string | null

applicationOwnerDevAccountId · integer<int32>

This is the DevAccountId that owns the application

applicationStatus · string | null

applicationStatusId · integer<int32>

applicationStatusName · string | null

applicationSubscriptions · object[] | null

Show child attributes

applicationTypeId · integer<int32>

applicationTypeName · string | null

applicationUpdateDate · string<date-time> | null

assetFileCount · integer<int32>

attributeNamespace · string | null

dataNamespace · string | null

hasApplicationVersions · boolean

id · integer<int32>

isDeleted · boolean

isLocked · boolean

isReleasePackage · boolean

legacyNamespace · string | null

majorVersion · integer<int32>

minorVersion · integer<int32>

namespace · string | null

namespaceRegistryId · string | null

packageDescription · string | null

packageGuid · string | null

packageName · string | null

parentThemeAppKey · string | null

The parent theme AppKey if this is a theme and the theme extends a valid, published theme.

parentThemeName · string | null

publishedParentSemanticVersion · string | null

publishedParentThemeId · integer<int32> | null

revision · integer<int32>

semanticVersionRange · string | null

sharedSecret · string | null

themeEngineVersion · string | null

updateAvailable · boolean

Whether or not there's a theme update.

updateDate · string<date-time>

updateParentAppKey · string | null

The AppKey is a runtime type. This only applies for themes that inherit from another theme. It shows the most current update available.

updateParentThemeName · string | null

This only applies for themes that inherit from another theme. It shows the name of the most current update available.

updateParentThemeVersion · string | null

This only applies for themes that inherit from another theme. It shows the version of the most current update available.

userId · string | null

validApplicationStatusIdList · integer<int32>[] | null

List of Statuses that the application can move to during the application lifecycle. This is based on what the current value of the ApplicatinStatusId is.