Application Packages

List

Retrieve application package(s).

GET/api/AppPackage

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

packageNamenullable string

Package name

displayNamenullable string

Application package display name

versionnullable string

Application package version

publishernullable string

Application package publisher name

msixImagePathnullable string

MSIX image path

packagedAppsnullable array of PackagedApp (object)

List of applications in the application package

dependenciesnullable string

Application pacakge dependencies

certificateAppPackageCertificate (object)

Application Package Certificate

siteIdinteger (int32)

ID of the Site

enabledboolean

Whether the application package is enabled or not

tagIdsnullable array of integer (int32)

Application tag IDs

Request

JavaScriptCurlPython

const response = await fetch('/api/AppPackage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T07:28:23.454Z",
    "timeLastMod": "2024-11-07T07:28:23.454Z",
    "packageName": "text",
    "displayName": "text",
    "version": "text",
    "publisher": "text",
    "msixImagePath": "text",
    "packagedApps": [
      {
        "name": "text"
      }
    ],
    "dependencies": "text",
    "certificate": {
      "status": [
        "0 = Valid",
        "1 = Expiring",
        "2 = Expired",
        "3 = InProgress",
        "4 = Revoked",
        "5 = Issuing",
        "6 = IssuingFailed",
        "7 = Renewing",
        "8 = RenewingFailed",
        "9 = Revoking",
        "10 = RevokingFailed"
      ],
      "publicKey": "text",
      "expirationDate": "2024-11-07T07:28:23.454Z",
      "keySize": [
        "0 = KeySize1024",
        "1 = KeySize2048",
        "2 = KeySize4096",
        "3 = KeySize3072",
        "4 = KeySize521",
        "255 = KeySizeUnknown"
      ],
      "commonName": "text"
    },
    "enabled": false,
    "tagIds": []
  }
]

Create

Create a new application package.

POST/api/AppPackage

Body

application/json; api-version=1.0

Application package settings.

displayNamenullable string

Display name of the new application package.

packageName*nullable string

Package name of the new application package.

msixImagePath*nullable string

MSIX image path of the new application package.

Response

201401409

Created

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

packageNamenullable string

Package name

displayNamenullable string

Application package display name

versionnullable string

Application package version

publishernullable string

Application package publisher name

msixImagePathnullable string

MSIX image path

packagedAppsnullable array of PackagedApp (object)

List of applications in the application package

dependenciesnullable string

Application pacakge dependencies

certificateAppPackageCertificate (object)

Application Package Certificate

siteIdinteger (int32)

ID of the Site

enabledboolean

Whether the application package is enabled or not

tagIdsnullable array of integer (int32)

Application tag IDs

Request

JavaScriptCurlPython

const response = await fetch('/api/AppPackage', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "msixImagePath": "text",
      "packageName": "text"
    }),
});
const data = await response.json();

Response

201401409

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:28:23.454Z",
  "timeLastMod": "2024-11-07T07:28:23.454Z",
  "packageName": "text",
  "displayName": "text",
  "version": "text",
  "publisher": "text",
  "msixImagePath": "text",
  "packagedApps": [
    {
      "name": "text"
    }
  ],
  "dependencies": "text",
  "certificate": {
    "status": [
      "0 = Valid",
      "1 = Expiring",
      "2 = Expired",
      "3 = InProgress",
      "4 = Revoked",
      "5 = Issuing",
      "6 = IssuingFailed",
      "7 = Renewing",
      "8 = RenewingFailed",
      "9 = Revoking",
      "10 = RevokingFailed"
    ],
    "publicKey": "text",
    "expirationDate": "2024-11-07T07:28:23.454Z",
    "keySize": [
      "0 = KeySize1024",
      "1 = KeySize2048",
      "2 = KeySize4096",
      "3 = KeySize3072",
      "4 = KeySize521",
      "255 = KeySizeUnknown"
    ],
    "commonName": "text"
  },
  "enabled": false,
  "tagIds": []
}

Get

Retrieve an application package by ID.

GET/api/AppPackage/{id}

Path parameters

id*integer (int32)

Application package ID.

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

packageNamenullable string

Package name

displayNamenullable string

Application package display name

versionnullable string

Application package version

publishernullable string

Application package publisher name

msixImagePathnullable string

MSIX image path

packagedAppsnullable array of PackagedApp (object)

List of applications in the application package

dependenciesnullable string

Application pacakge dependencies

certificateAppPackageCertificate (object)

Application Package Certificate

siteIdinteger (int32)

ID of the Site

enabledboolean

Whether the application package is enabled or not

tagIdsnullable array of integer (int32)

Application tag IDs

Request

JavaScriptCurlPython

const response = await fetch('/api/AppPackage/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:28:23.454Z",
  "timeLastMod": "2024-11-07T07:28:23.454Z",
  "packageName": "text",
  "displayName": "text",
  "version": "text",
  "publisher": "text",
  "msixImagePath": "text",
  "packagedApps": [
    {
      "name": "text"
    }
  ],
  "dependencies": "text",
  "certificate": {
    "status": [
      "0 = Valid",
      "1 = Expiring",
      "2 = Expired",
      "3 = InProgress",
      "4 = Revoked",
      "5 = Issuing",
      "6 = IssuingFailed",
      "7 = Renewing",
      "8 = RenewingFailed",
      "9 = Revoking",
      "10 = RevokingFailed"
    ],
    "publicKey": "text",
    "expirationDate": "2024-11-07T07:28:23.454Z",
    "keySize": [
      "0 = KeySize1024",
      "1 = KeySize2048",
      "2 = KeySize4096",
      "3 = KeySize3072",
      "4 = KeySize521",
      "255 = KeySizeUnknown"
    ],
    "commonName": "text"
  },
  "enabled": false,
  "tagIds": []
}

Update

Update application package settings.

PUT/api/AppPackage/{id}

Path parameters

id*integer (int32)

Application package ID.

Body

application/json; api-version=1.0

Application package settings.

enablednullable boolean

Enable or disable the application package.

displayNamenullable string

The new display name of the application package.

tagId1nullable boolean

Enable or disable Tag with Id 1.

tagId2nullable boolean

Enable or disable Tag with Id 2.

tagId3nullable boolean

Enable or disable Tag with Id 3.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/AppPackage/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Delete an application package.

DELETE/api/AppPackage/{id}

Path parameters

id*integer (int32)

Application package ID.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/AppPackage/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}