Optional multiline or single-line description in CommonMark or HTML.
Terms of service: http://example.com/terms/
Contact: API Support support@example.com
License: Apache 2.0
| Description | URL |
|---|---|
| Production server | https://www.neoteroi.xyz/software-center/v1 |
Initializes a file upload operation.
??? note "Description" The client receives a Shared Access Signature that can be used to upload a file directly to the Azure Storage Blob Service.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
Request body
=== "application/json"
```json
{
"containerId": "c53a1cd7-8b31-401b-aacc-15d5befbb26d",
"fileName": "like_a_sir.svg",
"fileType": "image/svg+xml",
"fileSize": 23307
}
```
<em class="small-note alt-types">Other accepted types: application/*+json, application/json-patch+json, text/json</em>
??? hint "Schema of the request body"
```json
{
"type": "object",
"properties": {
"releaseId": {
"type": "string",
"format": "uuid"
},
"fileName": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int32"
},
"fileType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
```
Responses
=== "200 OK"
=== "application/json"
```json
{
"baseURL": "string",
"fileId": "string",
"fileName": "string",
"token": "string"
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"baseURL": {
"type": "string",
"nullable": true
},
"fileId": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"token": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
```
**Response headers**
| Name | Description | Schema |
| --- | --- | --- |
| `X-Rate-Limit-Limit` | The number of allowed requests in the current period |<span class="integer-type">integer</span> |
| `X-Rate-Limit-Remaining` | The number of remaining requests in the current period |<span class="integer-type">integer</span> |
| `X-Rate-Limit-Reset` | The number of seconds left in the current period |<span class="integer-type">integer</span> |
=== "400 Bad Request"
Refer to the common response description: IllegalInput.
Refer to the common response description: Unauthorized.
Gets the list of categories supported by the system.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
Responses
=== "200 OK"
=== "application/json"
```json
[
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": [
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": null,
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": [
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": null
}
],
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
}
]
}
]
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Category"
}
}
```
Gets a list of countries of the World with English dislay names and ISO country codes.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
Responses
=== "200 OK"
=== "application/json"
```json
[
{
"id": "string",
"name": "string",
"countryCode": "string"
}
]
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Country"
}
}
```
Gets a list of countries supported by the system, with English dislay names and ISO country codes.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
Responses
=== "200 OK"
=== "application/json"
```json
[
{
"id": "string",
"name": "string",
"countryCode": "string"
}
]
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Country"
}
}
```
Gets a paginated set of downloads records.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
category |
query | string | Yes | ||
country |
query | string | Yes | ||
organizationId |
query | string | Yes | ||
page |
query | integer | 1 | Yes | |
search |
query | string | Yes | ||
size |
query | integer | 30 | Yes | |
sortBy |
query | string | Yes |
Responses
=== "200 OK"
=== "application/json"
```json
{
"items": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"userEmail": "string",
"userId": "string",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": null
},
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": null,
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": [
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": null
}
],
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
},
"timeStamp": "2022-04-13T15:42:05.901Z",
"accessGrantedByOrganizationId": "00000000-0000-0000-0000-000000000000"
}
],
"total": 26
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseNodeDownload"
},
"nullable": true
},
"total": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
}
```
API health check
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
Responses
=== "200 OK"
=== "application/json"
```json
{
"alive": true,
"timestamp": "2022-04-13T15:42:05.901Z",
"regionName": "string"
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"alive": {
"type": "boolean"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"regionName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
Responses
=== "200 OK"
=== "application/json"
```json
{
"membership": [
{
"id": "00000000-0000-0000-0000-000000000000",
"organizationName": "string",
"organizationNumber": "string",
"organizationId": "00000000-0000-0000-0000-000000000000",
"categoryId": "string",
"role": "string",
"organizationBrands": [
"00000000-0000-0000-0000-000000000000"
],
"organizationMarkets": [
"00000000-0000-0000-0000-000000000000"
],
"brandNames": [
"string"
],
"marketCodes": [
"string"
],
"scope": "string"
}
],
"signature": "string"
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"membership": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfessionalMembership"
},
"nullable": true
},
"signature": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
```
Returns information about the API itself.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
Responses
=== "200 OK"
=== "application/json"
```json
{
"version": "string",
"buildNumber": "string",
"contactEmail": "string"
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"version": {
"type": "string",
"nullable": true
},
"buildNumber": {
"type": "string",
"nullable": true
},
"contactEmail": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
```
Returns details about a release by id.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
releaseId |
path | string | No |
Responses
=== "200 OK"
=== "application/json"
```json
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": [
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": null,
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": [
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": null
}
],
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
}
]
},
"nodes": null,
"countries": null,
"history": null,
"organizations": null
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"required": [
"creationTime",
"draft",
"eTag",
"name",
"updateTime"
],
"type": "object",
"properties": {
"eTag": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"maxLength": 250,
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"draft": {
"type": "boolean"
},
"requestedNotification": {
"type": "boolean"
},
"categoryId": {
"type": "string",
"nullable": true
},
"category": {
"$ref": "#/components/schemas/Category"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseNode"
},
"nullable": true
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseCountry"
},
"nullable": true
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseHistory"
},
"nullable": true
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseOrganization"
},
"nullable": true
}
},
"additionalProperties": false
}
```
Deletes a release by id.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
releaseId |
path | string | No |
Responses
=== "200 OK"
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
releaseId |
path | string | No |
Request body
=== "application/json"
```json
{
"id": "00000000-0000-0000-0000-000000000000",
"categoryId": "string",
"name": "string",
"description": "string",
"eTag": "string",
"countries": [
"string"
]
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other accepted types: application/*+json, application/json-patch+json, text/json</em>
??? hint "Schema of the request body"
```json
{
"required": [
"categoryId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"categoryId": {
"maxLength": 20,
"type": "string"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
},
"countries": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
```
Responses
=== "200 OK"
=== "application/json"
```json
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": [
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": null,
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": [
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": null
}
],
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
}
]
},
"nodes": null,
"countries": null,
"history": null,
"organizations": null
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"required": [
"creationTime",
"draft",
"eTag",
"name",
"updateTime"
],
"type": "object",
"properties": {
"eTag": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"maxLength": 250,
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"draft": {
"type": "boolean"
},
"requestedNotification": {
"type": "boolean"
},
"categoryId": {
"type": "string",
"nullable": true
},
"category": {
"$ref": "#/components/schemas/Category"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseNode"
},
"nullable": true
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseCountry"
},
"nullable": true
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseHistory"
},
"nullable": true
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseOrganization"
},
"nullable": true
}
},
"additionalProperties": false
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
category |
query | string | Yes | ||
country |
query | string | Yes | ||
draft |
query | boolean | Yes | ||
page |
query | integer | 1 | Yes | |
search |
query | string | Yes | ||
size |
query | integer | 30 | Yes | |
sortBy |
query | string | Yes |
Responses
=== "200 OK"
=== "application/json"
```json
{
"items": [
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": null
},
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": [
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": null
}
],
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
}
],
"total": 26
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Release"
},
"nullable": true
},
"total": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
Request body
=== "application/json"
```json
{
"name": "string",
"description": "string",
"categoryId": "string",
"countries": [
"string"
]
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other accepted types: application/*+json, application/json-patch+json, text/json</em>
??? hint "Schema of the request body"
```json
{
"required": [
"categoryId"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"categoryId": {
"maxLength": 20,
"type": "string"
},
"countries": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
```
Responses
=== "200 OK"
=== "application/json"
```json
{
"id": "00000000-0000-0000-0000-000000000000"
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
Responses
=== "200 OK"
=== "application/json"
```json
[
{
"releaseId": "00000000-0000-0000-0000-000000000000",
"releaseName": "string",
"publishTime": "2022-04-13T15:42:05.901Z",
"countryCode": "string",
"countryName": "string",
"categoryId": "string"
}
]
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CurrentRelease"
}
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
Responses
=== "200 OK"
=== "application/json"
```json
[
{
"releaseId": "00000000-0000-0000-0000-000000000000",
"releaseName": "string",
"publishTime": "2022-04-13T15:42:05.901Z",
"countryCode": "string",
"countryName": "string",
"categoryId": "string"
}
]
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CurrentRelease"
}
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
releaseId |
path | string | No |
Responses
=== "200 OK"
=== "application/json"
```json
[
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": null
},
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": null,
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
}
}
]
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseHistory"
}
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
nodeId |
path | string | No | ||
releaseId |
path | string | No |
Responses
=== "200 OK"
=== "application/json"
```json
{
"url": "string"
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"url": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
nodeId |
path | string | No | ||
releaseId |
path | string | No |
Responses
=== "200 OK"
=== "application/json"
```json
{
"uniqueDownloads": 26
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"uniqueDownloads": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
releaseId |
path | string | No |
Request body
=== "application/json"
```json
[
{
"fileId": "00000000-0000-0000-0000-000000000000",
"fileName": "string",
"fileSize": 26,
"fileType": "string"
}
]
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other accepted types: application/*+json, application/json-patch+json, text/json</em>
??? hint "Schema of the request body"
```json
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateReleaseNodeInput"
},
"nullable": true
}
```
Responses
=== "200 OK"
=== "application/json"
```json
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": [
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": null,
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": [
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": null
}
],
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
}
]
},
"nodes": null,
"countries": null,
"history": null,
"organizations": null
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"required": [
"creationTime",
"draft",
"eTag",
"name",
"updateTime"
],
"type": "object",
"properties": {
"eTag": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"maxLength": 250,
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"draft": {
"type": "boolean"
},
"requestedNotification": {
"type": "boolean"
},
"categoryId": {
"type": "string",
"nullable": true
},
"category": {
"$ref": "#/components/schemas/Category"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseNode"
},
"nullable": true
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseCountry"
},
"nullable": true
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseHistory"
},
"nullable": true
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseOrganization"
},
"nullable": true
}
},
"additionalProperties": false
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
releaseId |
path | string | No |
Request body
=== "application/json"
```json
[
{
"id": "00000000-0000-0000-0000-000000000000"
}
]
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other accepted types: application/*+json, application/json-patch+json, text/json</em>
??? hint "Schema of the request body"
```json
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DeleteReleaseNodeInput"
},
"nullable": true
}
```
Responses
=== "200 OK"
=== "application/json"
```json
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": [
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": null,
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": [
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": null
}
],
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
}
]
},
"nodes": null,
"countries": null,
"history": null,
"organizations": null
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"required": [
"creationTime",
"draft",
"eTag",
"name",
"updateTime"
],
"type": "object",
"properties": {
"eTag": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"maxLength": 250,
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"draft": {
"type": "boolean"
},
"requestedNotification": {
"type": "boolean"
},
"categoryId": {
"type": "string",
"nullable": true
},
"category": {
"$ref": "#/components/schemas/Category"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseNode"
},
"nullable": true
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseCountry"
},
"nullable": true
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseHistory"
},
"nullable": true
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseOrganization"
},
"nullable": true
}
},
"additionalProperties": false
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
releaseId |
path | string | No |
Request body
=== "application/json"
```json
{
"items": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string"
}
]
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other accepted types: application/*+json, application/json-patch+json, text/json</em>
??? hint "Schema of the request body"
```json
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationBoundInput"
},
"nullable": true
}
},
"additionalProperties": false
}
```
Responses
=== "200 OK"
=== "application/json"
```json
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": [
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": null,
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": [
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": null
}
],
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
}
]
},
"nodes": null,
"countries": null,
"history": null,
"organizations": null
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"required": [
"creationTime",
"draft",
"eTag",
"name",
"updateTime"
],
"type": "object",
"properties": {
"eTag": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"maxLength": 250,
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"draft": {
"type": "boolean"
},
"requestedNotification": {
"type": "boolean"
},
"categoryId": {
"type": "string",
"nullable": true
},
"category": {
"$ref": "#/components/schemas/Category"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseNode"
},
"nullable": true
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseCountry"
},
"nullable": true
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseHistory"
},
"nullable": true
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseOrganization"
},
"nullable": true
}
},
"additionalProperties": false
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
releaseId |
path | string | No |
Request body
=== "application/json"
```json
[
"00000000-0000-0000-0000-000000000000"
]
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other accepted types: application/*+json, application/json-patch+json, text/json</em>
??? hint "Schema of the request body"
```json
{
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
```
Responses
=== "200 OK"
=== "application/json"
```json
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": [
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": null,
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": [
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": null
}
],
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
}
]
},
"nodes": null,
"countries": null,
"history": null,
"organizations": null
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"required": [
"creationTime",
"draft",
"eTag",
"name",
"updateTime"
],
"type": "object",
"properties": {
"eTag": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"maxLength": 250,
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"draft": {
"type": "boolean"
},
"requestedNotification": {
"type": "boolean"
},
"categoryId": {
"type": "string",
"nullable": true
},
"category": {
"$ref": "#/components/schemas/Category"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseNode"
},
"nullable": true
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseCountry"
},
"nullable": true
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseHistory"
},
"nullable": true
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseOrganization"
},
"nullable": true
}
},
"additionalProperties": false
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
releaseId |
path | string | No |
Responses
=== "200 OK"
=== "application/json"
```json
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": [
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": null,
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": [
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": null
}
],
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
}
]
},
"nodes": null,
"countries": null,
"history": null,
"organizations": null
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"required": [
"creationTime",
"draft",
"eTag",
"name",
"updateTime"
],
"type": "object",
"properties": {
"eTag": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"maxLength": 250,
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"draft": {
"type": "boolean"
},
"requestedNotification": {
"type": "boolean"
},
"categoryId": {
"type": "string",
"nullable": true
},
"category": {
"$ref": "#/components/schemas/Category"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseNode"
},
"nullable": true
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseCountry"
},
"nullable": true
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseHistory"
},
"nullable": true
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseOrganization"
},
"nullable": true
}
},
"additionalProperties": false
}
```
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
AAD |
header | string | N/A | No | Access token issued by Azure Active Directory. |
releaseId |
path | string | No |
Request body
=== "application/json"
```json
{
"eTag": "string",
"sendEmailNotifications": true
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other accepted types: application/*+json, application/json-patch+json, text/json</em>
??? hint "Schema of the request body"
```json
{
"type": "object",
"properties": {
"eTag": {
"type": "string",
"nullable": true
},
"sendEmailNotifications": {
"type": "boolean"
}
},
"additionalProperties": false
}
```
Responses
=== "200 OK"
=== "application/json"
```json
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "string",
"name": "string",
"description": "string",
"releases": [
{
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"draft": true,
"requestedNotification": true,
"categoryId": "string",
"category": null,
"nodes": [
{
"id": "00000000-0000-0000-0000-000000000000",
"nodeId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"node": {
"eTag": "string",
"creationTime": "2022-04-13T15:42:05.901Z",
"updateTime": "2022-04-13T15:42:05.901Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extension": "string",
"type": "string",
"icon": "string",
"size": 26
},
"release": null
}
],
"countries": [
{
"countryId": "string",
"releaseId": "00000000-0000-0000-0000-000000000000",
"country": {
"id": "string",
"name": "string",
"countryCode": "string"
},
"release": null
}
],
"history": [
{
"id": "00000000-0000-0000-0000-000000000000",
"user": "string",
"description": "string",
"data": "string",
"timeStamp": "2022-04-13T15:42:05.901Z",
"releaseId": "00000000-0000-0000-0000-000000000000",
"release": null
}
],
"organizations": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"releaseId": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"release": null
}
]
}
]
},
"nodes": null,
"countries": null,
"history": null,
"organizations": null
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
<em class="small-note alt-types">Other possible types: text/json, text/plain</em>
??? hint "Schema of the response body"
```json
{
"required": [
"creationTime",
"draft",
"eTag",
"name",
"updateTime"
],
"type": "object",
"properties": {
"eTag": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"maxLength": 250,
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"draft": {
"type": "boolean"
},
"requestedNotification": {
"type": "boolean"
},
"categoryId": {
"type": "string",
"nullable": true
},
"category": {
"$ref": "#/components/schemas/Category"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseNode"
},
"nullable": true
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseCountry"
},
"nullable": true
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseHistory"
},
"nullable": true
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseOrganization"
},
"nullable": true
}
},
"additionalProperties": false
}
```
| Name | Type | Description |
|---|---|---|
creationTime |
string(date-time) | |
description |
string | null | |
eTag |
string | |
id |
string | null | |
name |
string | |
releases |
Array<Release> | |
updateTime |
string(date-time) |
| Name | Type | Description |
|---|---|---|
countryCode |
string | null | |
id |
string | null | |
name |
string |
| Name | Type | Description |
|---|---|---|
items |
Array<OrganizationBoundInput> |
| Name | Type | Description |
|---|---|---|
categoryId |
string | |
countries |
Array<string> | |
description |
string | null | |
name |
string | null |
| Name | Type | Description |
|---|---|---|
fileId |
string(uuid) | |
fileName |
string | |
fileSize |
integer(int32) | |
fileType |
string |
| Name | Type | Description |
|---|---|---|
id |
string(uuid) |
| Name | Type | Description |
|---|---|---|
categoryId |
string | null | |
countryCode |
string | null | |
countryName |
string | null | |
publishTime |
string(date-time) | |
releaseId |
string(uuid) | |
releaseName |
string | null |
| Name | Type | Description |
|---|---|---|
id |
string(uuid) |
| Name | Type | Description |
|---|---|---|
uniqueDownloads |
integer(int32) |
| Name | Type | Description |
|---|---|---|
url |
string | null |
| Name | Type | Description |
|---|---|---|
code |
integer(int32) | |
message |
string |
| Name | Type | Description |
|---|---|---|
alive |
boolean | |
regionName |
string | null | |
timestamp |
string(date-time) |
| Name | Type | Description |
|---|---|---|
fileName |
string | null | |
fileSize |
integer(int32) | |
fileType |
string | null | |
releaseId |
string(uuid) |
| Name | Type | Description |
|---|---|---|
baseURL |
string | null | |
fileId |
string | null | |
fileName |
string | null | |
token |
string | null |
| Name | Type | Description |
|---|---|---|
buildNumber |
string | null | |
contactEmail |
string | null | |
version |
string | null |
| Name | Type | Description |
|---|---|---|
creationTime |
string(date-time) | |
eTag |
string | |
extension |
string | |
icon |
string | |
id |
string(uuid) | |
name |
string | |
size |
integer(int32) | |
type |
string | |
updateTime |
string(date-time) |
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
name |
string | null |
| Name | Type | Description |
|---|---|---|
membership |
Array<ProfessionalMembership> | |
signature |
string | null |
| Name | Type | Description |
|---|---|---|
brandNames |
Array<string> | |
categoryId |
string | null | |
id |
string(uuid) | |
marketCodes |
Array<string> | |
organizationBrands |
Array<string(uuid)> | |
organizationId |
string(uuid) | |
organizationMarkets |
Array<string(uuid)> | |
organizationName |
string | null | |
organizationNumber |
string | null | |
role |
string | null | |
scope |
string | null |
| Name | Type | Description |
|---|---|---|
eTag |
string | null | |
sendEmailNotifications |
boolean |
| Name | Type | Description |
|---|---|---|
category |
Category | |
categoryId |
string | null | |
countries |
Array<ReleaseCountry> | |
creationTime |
string(date-time) | |
description |
string | null | |
draft |
boolean | |
eTag |
string | |
history |
Array<ReleaseHistory> | |
id |
string(uuid) | |
name |
string | |
nodes |
Array<ReleaseNode> | |
organizations |
Array<ReleaseOrganization> | |
requestedNotification |
boolean | |
updateTime |
string(date-time) |
| Name | Type | Description |
|---|---|---|
country |
Country | |
countryId |
string | null | |
release |
Release | |
releaseId |
string(uuid) |
| Name | Type | Description |
|---|---|---|
data |
string | null | |
description |
string | |
id |
string(uuid) | |
release |
Release | |
releaseId |
string(uuid) | |
timeStamp |
string(date-time) | |
user |
string |
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
node |
NodeInfo | |
nodeId |
string(uuid) | |
release |
Release | |
releaseId |
string(uuid) |
| Name | Type | Description |
|---|---|---|
accessGrantedByOrganizationId |
string(uuid) | null | |
id |
string(uuid) | |
node |
NodeInfo | |
nodeId |
string(uuid) | |
release |
Release | |
releaseId |
string(uuid) | |
timeStamp |
string(date-time) | |
userEmail |
string | |
userId |
string |
| Name | Type | Description |
|---|---|---|
items |
Array<ReleaseNodeDownload> | |
total |
integer(int64) |
| Name | Type | Description |
|---|---|---|
displayName |
string | null | |
organizationId |
string(uuid) | |
release |
Release | |
releaseId |
string(uuid) |
| Name | Type | Description |
|---|---|---|
items |
Array<Release> | |
total |
integer(int64) |
| Name | Type | Description |
|---|---|---|
categoryId |
string | |
countries |
Array<string> | |
description |
string | null | |
eTag |
string | null | |
id |
string(uuid) | |
name |
string | null |
This section describes common responses that are reused across operations.
Entity not found.
=== "application/json"
```json
{
"code": 404,
"message": "Entity not found"
}
```
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
}
```
Illegal input for operation.
=== "application/json"
```json
{
"code": 400,
"message": "Illegal Input"
}
```
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
}
```
The user is not authorized.
=== "application/json"
```json
{
"code": 401,
"message": "Unauthorized"
}
```
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
}
```
This base error type is used for all raised exceptions.
=== "application/json"
```json
{
"code": 26,
"message": "string"
}
```
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
??? hint "Schema of the response body"
```json
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
}
```
This section describes common parameters that are reused across operations.
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 1 | Yes |
<tr>
<td>AAD</td>
<td>http</td>
<td>bearer</td>
<td>Access token issued by Azure Active Directory.</td>
</tr>
<tr>
<td>AADB2C</td>
<td>http</td>
<td>bearer</td>
<td>Access token issued by Azure Active Directory B2C.</td>
</tr>
</tbody>
| Name | Type | Scheme | Description |
|---|