Software Platform API v1

Optional multiline or single-line description in CommonMark or HTML.

Terms of service: http://example.com/terms/

Contact: API Support support@example.com

Servers

Description	URL
Production server	https://www.neoteroi.xyz/software-center/v1

Blobs

POST /api/blobs/initialize-upload

Initializes a file upload operation.

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

{
    "containerId": "c53a1cd7-8b31-401b-aacc-15d5befbb26d",
    "fileName": "like_a_sir.svg",
    "fileType": "image/svg+xml",
    "fileSize": 23307
}

Other accepted types: application/*+json, application/json-patch+json, text/json

Schema of the request body

{
    "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
}

Response 200 OK

application/json

{
    "baseURL": "string",
    "fileId": "string",
    "fileName": "string",
    "token": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "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
}

Name	Description	Schema
X-Rate-Limit-Limit	The number of allowed requests in the current period	integer
X-Rate-Limit-Remaining	The number of remaining requests in the current period	integer
X-Rate-Limit-Reset	The number of seconds left in the current period	integer

Response 400 Bad Request

Refer to the common response description: IllegalInput

Response 401 Unauthorized

Refer to the common response description: Unauthorized

Countries

GET /api/countries

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.

Response 200 OK

application/json

[
    {
        "id": "string",
        "name": "string",
        "countryCode": "string"
    }
]

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/Country"
    }
}

GET /api/system-countries

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.

Response 200 OK

application/json

[
    {
        "id": "string",
        "name": "string",
        "countryCode": "string"
    }
]

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/Country"
    }
}

Downloads

GET /api/downloads

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

Response 200 OK

application/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
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ReleaseNodeDownload"
            },
            "nullable": true
        },
        "total": {
            "type": "integer",
            "format": "int64"
        }
    },
    "additionalProperties": false
}

Health

GET /api/health

API health check

Input parameters

Parameter	In	Type	Default	Nullable	Description
AAD	header	string	N/A	No	Access token issued by Azure Active Directory.

Response 200 OK

application/json

{
    "alive": true,
    "timestamp": "2022-04-13T15:42:05.901Z",
    "regionName": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "object",
    "properties": {
        "alive": {
            "type": "boolean"
        },
        "timestamp": {
            "type": "string",
            "format": "date-time"
        },
        "regionName": {
            "type": "string",
            "nullable": true
        }
    },
    "additionalProperties": false
}

Professionals

GET /api/pro/own-context

Input parameters

Parameter	In	Type	Default	Nullable	Description
AAD	header	string	N/A	No	Access token issued by Azure Active Directory.

Response 200 OK

application/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"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "object",
    "properties": {
        "membership": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ProfessionalMembership"
            },
            "nullable": true
        },
        "signature": {
            "type": "string",
            "nullable": true
        }
    },
    "additionalProperties": false
}

Info

GET /api/info

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.

Response 200 OK

application/json

{
    "version": "string",
    "buildNumber": "string",
    "contactEmail": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "object",
    "properties": {
        "version": {
            "type": "string",
            "nullable": true
        },
        "buildNumber": {
            "type": "string",
            "nullable": true
        },
        "contactEmail": {
            "type": "string",
            "nullable": true
        }
    },
    "additionalProperties": false
}

Releases

GET /api/releases/{releaseId}

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

Response 200 OK

application/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
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "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
}

DELETE /api/releases/{releaseId}

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

Response 200 OK

PATCH /api/releases/{releaseId}

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

{
    "id": "00000000-0000-0000-0000-000000000000",
    "categoryId": "string",
    "name": "string",
    "description": "string",
    "eTag": "string",
    "countries": [
        "string"
    ]
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. Other accepted types: application/*+json, application/json-patch+json, text/json

Schema of the request body

{
    "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
}

Response 200 OK

application/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
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "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
}

GET /api/releases

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

Response 200 OK

application/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
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Release"
            },
            "nullable": true
        },
        "total": {
            "type": "integer",
            "format": "int64"
        }
    },
    "additionalProperties": false
}

POST /api/releases

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

{
    "name": "string",
    "description": "string",
    "categoryId": "string",
    "countries": [
        "string"
    ]
}

Schema of the request body

{
    "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
}

Response 200 OK

application/json

{
    "id": "00000000-0000-0000-0000-000000000000"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid"
        }
    },
    "additionalProperties": false
}

GET /api/current-releases

Input parameters

Parameter	In	Type	Default	Nullable	Description
AAD	header	string	N/A	No	Access token issued by Azure Active Directory.

Response 200 OK

application/json

[
    {
        "releaseId": "00000000-0000-0000-0000-000000000000",
        "releaseName": "string",
        "publishTime": "2022-04-13T15:42:05.901Z",
        "countryCode": "string",
        "countryName": "string",
        "categoryId": "string"
    }
]

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/CurrentRelease"
    }
}

GET /api/orgs/current-releases

Input parameters

Parameter	In	Type	Default	Nullable	Description
AAD	header	string	N/A	No	Access token issued by Azure Active Directory.

Response 200 OK

application/json

[
    {
        "releaseId": "00000000-0000-0000-0000-000000000000",
        "releaseName": "string",
        "publishTime": "2022-04-13T15:42:05.901Z",
        "countryCode": "string",
        "countryName": "string",
        "categoryId": "string"
    }
]

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/CurrentRelease"
    }
}

GET /api/releases/{releaseId}/history

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

Response 200 OK

application/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
                }
            ]
        }
    }
]

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/ReleaseHistory"
    }
}

GET /api/releases/{releaseId}/file/{nodeId}

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

Response 200 OK

application/json

{
    "url": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "object",
    "properties": {
        "url": {
            "type": "string",
            "nullable": true
        }
    },
    "additionalProperties": false
}

GET /api/releases/{releaseId}/file/{nodeId}/downloads

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

Response 200 OK

application/json

{
    "uniqueDownloads": 26
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "type": "object",
    "properties": {
        "uniqueDownloads": {
            "type": "integer",
            "format": "int32"
        }
    },
    "additionalProperties": false
}

PUT /api/releases/{releaseId}/files

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

[
    {
        "fileId": "00000000-0000-0000-0000-000000000000",
        "fileName": "string",
        "fileSize": 26,
        "fileType": "string"
    }
]

Schema of the request body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/CreateReleaseNodeInput"
    },
    "nullable": true
}

Response 200 OK

application/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
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "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
}

DELETE /api/releases/{releaseId}/files

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

[
    {
        "id": "00000000-0000-0000-0000-000000000000"
    }
]

Schema of the request body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/DeleteReleaseNodeInput"
    },
    "nullable": true
}

Response 200 OK

application/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
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "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
}

PUT /api/releases/{releaseId}/orgs

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

{
    "items": [
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "string"
        }
    ]
}

Schema of the request body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/OrganizationBoundInput"
            },
            "nullable": true
        }
    },
    "additionalProperties": false
}

Response 200 OK

application/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
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "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
}

DELETE /api/releases/{releaseId}/orgs

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

[
    "00000000-0000-0000-0000-000000000000"
]

Schema of the request body

{
    "type": "array",
    "items": {
        "type": "string",
        "format": "uuid"
    },
    "nullable": true
}

Response 200 OK

application/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
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "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
}

POST /api/releases/{releaseId}/clone

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

Response 200 OK

application/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
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "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
}

POST /api/releases/{releaseId}/publish

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

{
    "eTag": "string",
    "sendEmailNotifications": true
}

Schema of the request body

{
    "type": "object",
    "properties": {
        "eTag": {
            "type": "string",
            "nullable": true
        },
        "sendEmailNotifications": {
            "type": "boolean"
        }
    },
    "additionalProperties": false
}

Response 200 OK

application/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
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Other possible types: text/json, text/plain

Schema of the response body

{
    "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
}

Schemas

Country

Name	Type
countryCode	string\| null
id	string\| null
name	string

CreateOrganizationsBoundInput

Name	Type
items	Array<OrganizationBoundInput>

CreateReleaseInput

Name	Type
categoryId	string
countries	Array<string>
description	string\| null
name	string\| null

CreateReleaseNodeInput

Name	Type
fileId	string(uuid)
fileName	string
fileSize	integer(int32)
fileType	string

CreateReleaseOutput

Name	Type
id	string(uuid)

CurrentRelease

Name	Type
categoryId	string\| null
countryCode	string\| null
countryName	string\| null
publishTime	string(date-time)
releaseId	string(uuid)
releaseName	string\| null

DeleteReleaseNodeInput

Name	Type
id	string(uuid)

FileDownloadStats

Name	Type
uniqueDownloads	integer(int32)

FileUrl

Name	Type
url	string\| null

GenericError

Name	Type
code	integer(int32)
message	string

HealthCheck

Name	Type
alive	boolean
regionName	string\| null
timestamp	string(date-time)

InitializeUploadInput

Name	Type
fileName	string\| null
fileSize	integer(int32)
fileType	string\| null
releaseId	string(uuid)

InitializeUploadOutput

Name	Type
baseURL	string\| null
fileId	string\| null
fileName	string\| null
token	string\| null

MetaData

Name	Type
buildNumber	string\| null
contactEmail	string\| null
version	string\| null

NodeInfo

Name	Type
creationTime	string(date-time)
eTag	string
extension	string
icon	string
id	string(uuid)
name	string
size	integer(int32)
type	string
updateTime	string(date-time)

OrganizationBoundInput

Name	Type
id	string(uuid)
name	string\| null

ProfessionalContext

Name	Type
membership	Array<ProfessionalMembership>
signature	string\| null

ProfessionalMembership

Name	Type
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

PublishReleaseInput

Name	Type
eTag	string\| null
sendEmailNotifications	boolean

Release

Name	Type
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)

ReleaseCountry

Name	Type
country	Country
countryId	string\| null
release	Release
releaseId	string(uuid)

ReleaseHistory

Name	Type
data	string\| null
description	string
id	string(uuid)
release	Release
releaseId	string(uuid)
timeStamp	string(date-time)
user	string

ReleaseNode

Name	Type
id	string(uuid)
node	NodeInfo
nodeId	string(uuid)
release	Release
releaseId	string(uuid)

ReleaseNodeDownload

Name	Type
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

ReleaseNodeDownloadPaginatedSet

Name	Type
items	Array<ReleaseNodeDownload>
total	integer(int64)

ReleaseOrganization

Name	Type
displayName	string\| null
organizationId	string(uuid)
release	Release
releaseId	string(uuid)

ReleasePaginatedSet

Name	Type
items	Array<Release>
total	integer(int64)

UpdateReleaseInput

Name	Type
categoryId	string
countries	Array<string>
description	string\| null
eTag	string\| null
id	string(uuid)
name	string\| null

Common responses

This section describes common responses that are reused across operations.

NotFound

Entity not found.

application/json

{
    "code": 404,
    "message": "Entity not found"
}

Schema of the response body

{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer",
            "format": "int32"
        },
        "message": {
            "type": "string"
        }
    }
}

IllegalInput

Illegal input for operation.

application/json

{
    "code": 400,
    "message": "Illegal Input"
}

Schema of the response body

{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer",
            "format": "int32"
        },
        "message": {
            "type": "string"
        }
    }
}

Unauthorized

The user is not authorized.

application/json

{
    "code": 401,
    "message": "Unauthorized"
}

Schema of the response body

{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer",
            "format": "int32"
        },
        "message": {
            "type": "string"
        }
    }
}

GenericError

This base error type is used for all raised exceptions.

application/json

{
    "code": 26,
    "message": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer",
            "format": "int32"
        },
        "message": {
            "type": "string"
        }
    }
}

Common parameters

This section describes common parameters that are reused across operations.

PageNumber

Name	In	Type	Default	Nullable	Description

Security schemes

Name	Type	Scheme	Description
AAD	http	bearer	Access token issued by Azure Active Directory.
AADB2C	http	bearer	Access token issued by Azure Active Directory B2C.

FilesExpand file tree

example1-output-plain.md

Latest commit

History

example1-output-plain.md

File metadata and controls

Software Platform API v1

Servers

Blobs

POST /api/blobs/initialize-upload

Response 200 OK

Response 400 Bad Request

Response 401 Unauthorized

Categories

GET /api/categories

Response 200 OK

Countries

GET /api/countries

Response 200 OK

GET /api/system-countries

Response 200 OK

Downloads

GET /api/downloads

Response 200 OK

Health

GET /api/health

Response 200 OK

Professionals

GET /api/pro/own-context

Response 200 OK

Info

GET /api/info

Response 200 OK

Releases

GET /api/releases/{releaseId}

Response 200 OK

DELETE /api/releases/{releaseId}

Response 200 OK

PATCH /api/releases/{releaseId}

Response 200 OK

GET /api/releases

Response 200 OK

POST /api/releases

Response 200 OK

GET /api/current-releases

Response 200 OK

GET /api/orgs/current-releases

Response 200 OK

GET /api/releases/{releaseId}/history

Response 200 OK

GET /api/releases/{releaseId}/file/{nodeId}

Response 200 OK

GET /api/releases/{releaseId}/file/{nodeId}/downloads

Response 200 OK

PUT /api/releases/{releaseId}/files

Response 200 OK

DELETE /api/releases/{releaseId}/files

Response 200 OK

PUT /api/releases/{releaseId}/orgs

Response 200 OK

DELETE /api/releases/{releaseId}/orgs

Response 200 OK

POST /api/releases/{releaseId}/clone

Response 200 OK

POST /api/releases/{releaseId}/publish

Response 200 OK

Schemas

Category

Country

CreateOrganizationsBoundInput

CreateReleaseInput

CreateReleaseNodeInput

CreateReleaseOutput

CurrentRelease

DeleteReleaseNodeInput

FileDownloadStats

FileUrl

GenericError

HealthCheck

InitializeUploadInput