Product Releases Schemas

Licensing.DeleteReleaseDownloadResponse


{
  "success": true,
  "message": "string"
}

Response for DeleteReleaseDownload.

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	Indicates whether the operation was successful.
message	string¦null	false	none	A human-readable message indicating the result of the operation.

Licensing.GetReleaseDownloadsResponse


{
  "success": true,
  "releaseDownloads": [
    {
      "id": 0,
      "platform": "string",
      "kind": "string",
      "fileName": "string",
      "sourceKind": "string",
      "url": "string",
      "size": 0,
      "sha256": "string",
      "sha512": "string",
      "signature": "string",
      "signatureKeyId": "string",
      "downloads": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "totalReleaseDownloadsCount": 0
}

Response for the GetReleaseDownloadsRequest.

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	Indicates whether the operation was successful.
releaseDownloads	[Licensing.ReleaseDownloadDto]¦null	false	none	The list of release downloads.
totalReleaseDownloadsCount	integer(int32)	false	none	The total number of release downloads.

Licensing.InsertReleaseDownloadRequest


{
  "releaseDownload": {
    "id": 0,
    "platform": "string",
    "kind": "string",
    "fileName": "string",
    "sourceKind": "string",
    "url": "string",
    "size": 0,
    "sha256": "string",
    "sha512": "string",
    "signature": "string",
    "signatureKeyId": "string",
    "downloads": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Request to register a url-sourced release download.

Properties

Name	Type	Required	Restrictions	Description
releaseDownload	Licensing.ReleaseDownloadDto	false	none	A downloadable artifact of a product release, as exposed by the admin API.

Licensing.InsertReleaseDownloadResponse


{
  "success": true,
  "id": 0,
  "platform": "string",
  "kind": "string",
  "size": 0,
  "sha256": "string",
  "sha512": "string",
  "message": "string"
}

Response for InsertReleaseDownloadRequest / an artifact upload.

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	Indicates whether the operation was successful.
id	integer(int32)	false	none	The id of the created release download.
platform	string¦null	false	none	The artifact’s platform.
kind	string¦null	false	none	The artifact’s kind.
size	integer(int64)	false	none	The artifact size in bytes.
sha256	string¦null	false	none	The SHA-256 hash, lowercase hex.
sha512	string¦null	false	none	The SHA-512 hash, base64.
message	string¦null	false	none	A human-readable message indicating the result of the operation.

Licensing.ReleaseDownloadDto


{
  "id": 0,
  "platform": "string",
  "kind": "string",
  "fileName": "string",
  "sourceKind": "string",
  "url": "string",
  "size": 0,
  "sha256": "string",
  "sha512": "string",
  "signature": "string",
  "signatureKeyId": "string",
  "downloads": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

A downloadable artifact of a product release, as exposed by the admin API.

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)¦null	false	none	The unique identifier of the release download.
platform	string¦null	false	none	One of the recognised platform identifiers (e.g. darwin-arm64, win-x64).
kind	string¦null	false	none	installer
fileName	string¦null	false	none	The artifact’s file name.
sourceKind	string¦null	false	none	url
url	string¦null	false	none	The externally-hosted URL, when SourceKind is url.
size	integer(int64)¦null	false	none	The artifact size in bytes.
sha256	string¦null	false	none	The SHA-256 hash, lowercase hex.
sha512	string¦null	false	none	The SHA-512 hash, base64.
signature	string¦null	false	none	An optional detached signature over the artifact.
signatureKeyId	string¦null	false	none	The id of the key used to produce Signature.
downloads	integer(int64)¦null	false	none	The number of times this artifact has been downloaded.
createdAt	string(date-time)¦null	false	none	When the release download was created.
updatedAt	string(date-time)¦null	false	none	When the release download was last updated.

Licensing.UpdateReleaseDownloadRequest


{
  "releaseDownload": {
    "id": 0,
    "platform": "string",
    "kind": "string",
    "fileName": "string",
    "sourceKind": "string",
    "url": "string",
    "size": 0,
    "sha256": "string",
    "sha512": "string",
    "signature": "string",
    "signatureKeyId": "string",
    "downloads": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Request to update an existing release download.

Properties

Name	Type	Required	Restrictions	Description
releaseDownload	Licensing.ReleaseDownloadDto	false	none	A downloadable artifact of a product release, as exposed by the admin API.

Licensing.UpdateReleaseDownloadResponse


{
  "success": true,
  "message": "string"
}

Response for UpdateReleaseDownloadRequest.

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	Indicates whether the operation was successful.
message	string¦null	false	none	A human-readable message indicating the result of the operation.

Licensing.VerifyReleaseDownloadsResponse


{
  "success": true,
  "verified": 0,
  "drifted": [
    0
  ]
}

Response for VerifyReleaseDownloads.

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	Indicates whether the operation was successful.
verified	integer(int32)	false	none	The number of local/resource artifacts checked.
drifted	[integer]¦null	false	none	The ids of the artifacts whose recomputed hashes no longer match, or whose bytes are missing.

Management.DeleteProductReleaseAssemblyResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.DeleteProductReleaseResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.GetProductReleaseAssembliesResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "assemblies": [
    {
      "id": 0,
      "name": "string",
      "version": "string",
      "culture": "string",
      "publicKeyToken": "string",
      "mappingFileId": 0,
      "debugSymbolsKey": "string"
    }
  ],
  "totalAssembliesCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
assemblies	[Management.Assembly]¦null	false	none	none
totalAssembliesCount	integer(int32)	false	none	none

Management.GetProductReleaseLicenseTemplatesResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenseTemplates": [
    {
      "id": 0,
      "name": "string",
      "code": "string",
      "licenseType": "string",
      "format": 0,
      "licensingMode": 0,
      "licenseFileName": "string",
      "issueDate": true,
      "expireDays": 0,
      "supportDays": 0,
      "generateKeyInfo": true,
      "userKey": "string",
      "description": "string",
      "template": "string",
      "productId": 0,
      "signatureKeysId": 0,
      "releaseId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    }
  ],
  "totalLicenseTemplatesCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
licenseTemplates	[Management.LicenseTemplate]¦null	false	none	none
totalLicenseTemplatesCount	integer(int32)¦null	false	none	none

Management.GetProductReleasesResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "releases": [
    {
      "id": 0,
      "releaseDate": "2019-08-24T14:15:22Z",
      "name": "string",
      "version": "string",
      "description": "string",
      "public": true,
      "requiresMaintenance": true,
      "releaseNotes": "string",
      "channel": "stable"
    }
  ],
  "totalReleasesCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
releases	[Management.Release]¦null	false	none	none
totalReleasesCount	integer(int32)¦null	false	none	none

Management.InsertProductReleaseAssemblyRequest


{
  "productId": 0,
  "releaseId": 0,
  "assembly": {
    "id": 0,
    "name": "string",
    "version": "string",
    "culture": "string",
    "publicKeyToken": "string",
    "mappingFileId": 0,
    "debugSymbolsKey": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
productId	integer(int32)	false	none	none
releaseId	integer(int32)	false	none	none
assembly	Management.Assembly	false	none	none

Management.InsertProductReleaseAssemblyResponse


{
  "assemblyId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
assemblyId	integer(int32)¦null	false	none	none
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.InsertProductReleaseRequest


{
  "release": {
    "id": 0,
    "releaseDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "version": "string",
    "description": "string",
    "public": true,
    "requiresMaintenance": true,
    "releaseNotes": "string",
    "channel": "stable"
  }
}

Properties

Name	Type	Required	Restrictions	Description
release	Management.Release	false	none	none

Management.InsertProductReleaseResponse


{
  "releaseId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
releaseId	integer(int32)¦null	false	none	none
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.Release


{
  "id": 0,
  "releaseDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "version": "string",
  "description": "string",
  "public": true,
  "requiresMaintenance": true,
  "releaseNotes": "string",
  "channel": "stable"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)¦null	false	none	none
releaseDate	string(date-time)	false	none	none
name	string¦null	false	none	none
version	string¦null	false	none	none
description	string¦null	false	none	none
public	boolean¦null	false	none	Whether the release is published. A release is not returned by `v1/updates` until this is `true`.
requiresMaintenance	boolean¦null	false	none	Whether the maintenance check applies to this release. When omitted on insert, it defaults to `true`.
releaseNotes	string¦null	false	none	Release notes in Markdown.
channel	string¦null	false	none	Release channel: `stable` or `insider`.

Management.UpdateProductReleaseAssemblyRequest


{
  "assembly": {
    "id": 0,
    "name": "string",
    "version": "string",
    "culture": "string",
    "publicKeyToken": "string",
    "mappingFileId": 0,
    "debugSymbolsKey": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
assembly	Management.Assembly	false	none	none

Management.UpdateProductReleaseAssemblyResponse


{
  "assemblyId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
assemblyId	integer(int32)¦null	false	none	none
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.UpdateProductReleaseRequest


{
  "release": {
    "id": 0,
    "releaseDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "version": "string",
    "description": "string",
    "public": true,
    "requiresMaintenance": true,
    "releaseNotes": "string",
    "channel": "stable"
  }
}

Properties

Name	Type	Required	Restrictions	Description
release	Management.Release	false	none	none

Management.UpdateProductReleaseResponse


{
  "releaseId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
releaseId	integer(int32)¦null	false	none	none
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none