Skip to content

Instantly share code, notes, and snippets.

@simenandre
Created November 7, 2021 18:22
Show Gist options
  • Save simenandre/fb68fd88412a81281d83aca83f2c5c0b to your computer and use it in GitHub Desktop.
Save simenandre/fb68fd88412a81281d83aca83f2c5c0b to your computer and use it in GitHub Desktop.
{
"openapi": "3.0.1",
"info": {
"title": "Crayon Group Customer API",
"version": "v1"
},
"servers": [{ "url": "https://api.crayon.com/api/v1" }],
"paths": {
"/ActivityLogs": {
"get": {
"operationId": "ListActivityLogs",
"tags": ["ActivityLogs"],
"parameters": [
{
"name": "Entity",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "Id",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Ids",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "SearchDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "From",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "To",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityLogItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityLogItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityLogItem"
}
}
}
}
}
}
}
},
"/organizations/{organizationId}/Addresses": {
"get": {
"tags": ["Addresses"],
"operationId": "ListAddresses",
"parameters": [
{
"name": "organizationId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "type",
"in": "query",
"schema": {
"$ref": "#/components/schemas/AddressType"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Address"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Address"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Address"
}
}
}
}
}
}
}
},
"/organizations/{organizationId}/Addresses/{id}": {
"get": {
"tags": ["Addresses"],
"operationId": "GetAddress",
"parameters": [
{
"name": "organizationId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Address"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Address"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Address"
}
}
}
}
}
}
},
"/AgreementProducts": {
"get": {
"operationId": "ListAgreementProducts",
"tags": ["AgreementProducts"],
"parameters": [
{
"name": "AgreementTypeIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementType"
},
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "PriceListId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CustomerTenantId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "AgreementId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsTrial",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
},
{
"name": "AgreementIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "SearchDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "Include.PartNumbers",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.PublisherIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "Include.PublisherNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.PoolNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.OperatingSystemNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.LevelNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.LanguageNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.LicenseAgreementTypeNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.LicenseTypeNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.ProductFamilyNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.ProductTypeNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.ProgramNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.OfferingNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.PurchasePeriodNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.PurchaseUnitNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.VersionNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.RegionNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.ProductCategoryNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.CatalogNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Include.BillingCycles",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.PartNumbers",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.PublisherIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "Exclude.PublisherNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.PoolNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.OperatingSystemNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.LevelNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.LanguageNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.LicenseAgreementTypeNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.LicenseTypeNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.ProductFamilyNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.ProductTypeNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.ProgramNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.OfferingNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.PurchasePeriodNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.PurchaseUnitNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.VersionNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.RegionNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.ProductCategoryNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.CatalogNames",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Exclude.BillingCycles",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "SortKey",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "IncludeProductInformation",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "SortOrder",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortOrder"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementProduct"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementProduct"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementProduct"
}
}
}
}
}
}
},
"post": {
"tags": ["AgreementProducts"],
"operationId": "CreateAgreementProduct",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AgreementProductFilter"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgreementProductFilter"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgreementProductFilter"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AgreementProductFilter"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementProduct"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementProduct"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementProduct"
}
}
}
}
}
}
}
},
"/AgreementProducts/file/xlsx": {
"post": {
"tags": ["AgreementProducts"],
"operationId": "UploadAgreementProductsFileInXLSX",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AgreementProductFilter"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgreementProductFilter"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgreementProductFilter"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AgreementProductFilter"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/AgreementProducts/{partNumber}/supportedbillingcycles": {
"get": {
"tags": ["AgreementProducts"],
"operationId": "ListSupportedBillingCycles",
"parameters": [
{
"name": "resellerCustomerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "partNumber",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingCycleEnum"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingCycleEnum"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingCycleEnum"
}
}
}
}
}
}
}
},
"/AgreementReports/{productContainerId}": {
"get": {
"tags": ["AgreementReports"],
"operationId": "ListAgreementReports",
"parameters": [
{
"name": "productContainerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementReport"
}
}
}
}
}
}
}
},
"/AgreementReports/{agreementId}": {
"put": {
"tags": ["AgreementReports"],
"operationId": "UpdateAgreementReport",
"parameters": [
{
"name": "agreementId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AgreementReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgreementReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgreementReport"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AgreementReport"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AgreementReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgreementReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgreementReport"
}
}
}
}
}
}
},
"/Agreements": {
"get": {
"tags": ["Agreements"],
"operationId": "ListAgreements",
"parameters": [
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OrganizationIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "PricelistIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "Status",
"in": "query",
"schema": {
"$ref": "#/components/schemas/AgreementStatus"
}
},
{
"name": "AgreementTypes",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementType"
},
"nullable": true
}
},
{
"name": "PublisherIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "ProgramIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "SearchDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "AgreementIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "SalesPriceCurrency",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "TermRequired",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "PublisherId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "EndDateFrom",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "EndDateTo",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Agreement"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Agreement"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Agreement"
}
}
}
}
}
}
}
},
"/Assets": {
"get": {
"tags": ["Assets"],
"operationId": "ListAssets",
"parameters": [
{
"name": "ResellerCustomerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PublisherId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalOrderId",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "ExternalOrderIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "ReservationId",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "AssetType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/AssetType"
}
},
{
"name": "Status",
"in": "query",
"schema": {
"$ref": "#/components/schemas/AssetStatus"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "SortBy",
"in": "query",
"schema": {
"$ref": "#/components/schemas/AssetSortBy"
}
},
{
"name": "SortOrder",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortOrder"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Asset"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Asset"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Asset"
}
}
}
}
}
}
}
},
"/Assets/{id}": {
"get": {
"tags": ["Assets"],
"operationId": "GetAsset",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Asset"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Asset"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Asset"
}
}
}
}
}
}
},
"/Assets/orders": {
"get": {
"tags": ["Assets"],
"operationId": "ListAssetOrders",
"parameters": [
{
"name": "ResellerCustomerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PublisherId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalOrderId",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "ExternalOrderIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "ReservationId",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "AssetType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/AssetType"
}
},
{
"name": "Status",
"in": "query",
"schema": {
"$ref": "#/components/schemas/AssetStatus"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "SortBy",
"in": "query",
"schema": {
"$ref": "#/components/schemas/AssetSortBy"
}
},
{
"name": "SortOrder",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortOrder"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetOrder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetOrder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetOrder"
}
}
}
}
}
}
}
},
"/Assets/verify": {
"post": {
"tags": ["Assets"],
"operationId": "CreateAssetVerifyOrder",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AssetOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssetOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssetOrder"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AssetOrder"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AssetOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssetOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssetOrder"
}
}
}
}
}
}
},
"/Assets/checkout": {
"post": {
"tags": ["Assets"],
"operationId": "CreateAssetCheckoutOrder",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AssetOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssetOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssetOrder"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AssetOrder"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/Assets/{assetId}": {
"put": {
"tags": ["Assets"],
"operationId": "UpdateAsset",
"parameters": [
{
"name": "assetId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Asset"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Asset"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Asset"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Asset"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/Assets/{assetId}/tags": {
"post": {
"tags": ["Assets"],
"operationId": "ListAssetTags",
"parameters": [
{
"name": "assetId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AssetTags"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssetTags"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssetTags"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AssetTags"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
},
"put": {
"tags": ["Assets"],
"operationId": "UpdateAssetTags",
"parameters": [
{
"name": "assetId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AssetTags"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssetTags"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssetTags"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AssetTags"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": ["Assets"],
"operationId": "DeleteAssetTags",
"parameters": [
{
"name": "assetId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/AwsAccounts": {
"get": {
"tags": ["AwsAccounts"],
"operationId": "ListAwsAccounts",
"parameters": [
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PublisherId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ConsumerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CustomerTenantType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/CustomerTenantType"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AwsAccount"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AwsAccount"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AwsAccount"
}
}
}
}
}
}
}
},
"/AwsAccounts/{id}": {
"get": {
"tags": ["AwsAccounts"],
"operationId": "GetAwsAccount",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AwsAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AwsAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AwsAccount"
}
}
}
}
}
},
"put": {
"tags": ["AwsAccounts"],
"operationId": "UpdateAwsAccount",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AwsAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AwsAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AwsAccount"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AwsAccount"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AwsAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AwsAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AwsAccount"
}
}
}
}
}
}
},
"/AzurePlans/{azurePlanId}": {
"get": {
"tags": ["AzurePlans"],
"operationId": "GetAzurePlan",
"parameters": [
{
"name": "azurePlanId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AzurePlan"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AzurePlan"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AzurePlan"
}
}
}
}
}
}
},
"/AzurePlans/{azurePlanId}/azureSubscriptions": {
"get": {
"tags": ["AzurePlans"],
"operationId": "GetAzurePlanSubscriptions",
"parameters": [
{
"name": "azurePlanId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AzureSubscription"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AzureSubscription"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AzureSubscription"
}
}
}
}
}
}
},
"post": {
"tags": ["AzurePlans"],
"operationId": "CreateAzurePlanSubscription",
"parameters": [
{
"name": "azurePlanId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateAzureSubscriptionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAzureSubscriptionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateAzureSubscriptionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateAzureSubscriptionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/AzurePlans/{azurePlanId}/azureSubscriptions/{id}": {
"get": {
"tags": ["AzurePlans"],
"operationId": "GetAzurePlanSubscriptioById",
"parameters": [
{
"name": "azurePlanId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AzureSubscription"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscription"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscription"
}
}
}
}
}
},
"put": {
"tags": ["AzurePlans"],
"operationId": "UpdateAzureSubscription",
"parameters": [
{
"name": "azurePlanId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PutAzureSubscription"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutAzureSubscription"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PutAzureSubscription"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PutAzureSubscription"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AzureSubscription"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscription"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscription"
}
}
}
}
}
}
},
"/AzurePlans/{azurePlanId}/azureSubscriptions/{id}/assign-unique-admin": {
"put": {
"tags": ["AzurePlans"],
"operationId": "AssignUniqueAdminAzureSubscription",
"parameters": [
{
"name": "azurePlanId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionAssignAdmin"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionAssignAdmin"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionAssignAdmin"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionAssignAdmin"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/AzurePlans/{azurePlanId}/azureSubscriptions/{id}/cancel": {
"post": {
"tags": ["AzurePlans"],
"operationId": "CancelAzureSubscription",
"parameters": [
{
"name": "azurePlanId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionUpdated"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionUpdated"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionUpdated"
}
}
}
}
}
}
},
"/AzurePlans/{azurePlanId}/azureSubscriptions/{id}/enable": {
"post": {
"tags": ["AzurePlans"],
"operationId": "enableAzureSubscription",
"parameters": [
{
"name": "azurePlanId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionUpdated"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionUpdated"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionUpdated"
}
}
}
}
}
}
},
"/AzurePlans/{azurePlanId}/azureSubscriptions/{id}/rename": {
"patch": {
"tags": ["AzurePlans"],
"operationId": "RenameAzureSubscription",
"parameters": [
{
"name": "azurePlanId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionRename"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionRename"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionRename"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionRename"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionUpdated"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionUpdated"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AzureSubscriptionUpdated"
}
}
}
}
}
}
},
"/BillingCycles": {
"get": {
"tags": ["BillingCycles"],
"operationId": "ListBillingCycles",
"parameters": [
{
"name": "includeUnknown",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingCycle"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingCycle"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingCycle"
}
}
}
}
}
}
}
},
"/BillingCycles/productVariant/{productVariantId}": {
"get": {
"tags": ["BillingCycles"],
"operationId": "GetBillingCycleProductVariant",
"parameters": [
{
"name": "productVariantId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingCycle"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingCycle"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingCycle"
}
}
}
}
}
}
}
},
"/BillingCycles/cspNameDictionary": {
"get": {
"tags": ["BillingCycles"],
"operationId": "ListBillingCyclesCSPNameDictionary",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
},
"/BillingStatements": {
"get": {
"tags": ["BillingStatements"],
"operationId": "ListBillingStatements",
"parameters": [
{
"name": "InvoiceProfileId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ProvisionType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ProvisionType"
}
},
{
"name": "From",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "To",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingStatement"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingStatement"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingStatement"
}
}
}
}
}
}
}
},
"/BillingStatements/grouped": {
"get": {
"tags": ["BillingStatements"],
"operationId": "ListGroupedBillingStatements",
"parameters": [
{
"name": "InvoiceProfileId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ProvisionType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ProvisionType"
}
},
{
"name": "From",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "To",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupedBillingStatement"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupedBillingStatement"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupedBillingStatement"
}
}
}
}
}
}
}
},
"/BillingStatements/file/{id}": {
"get": {
"tags": ["BillingStatements"],
"operationId": "GetBillingStatementFile",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
}
}
}
}
},
"/BillingStatements/{id}/reconciliationfile": {
"get": {
"tags": ["BillingStatements"],
"operationId": "GetBillingStatementReconciliationFile",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
}
}
}
}
},
"/BillingStatements/{id}/billingrecordsfile": {
"get": {
"tags": ["BillingStatements"],
"operationId": "GetBillingStatementRecordsFile",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
}
}
}
}
},
"/BlogItems": {
"get": {
"tags": ["BlogItems"],
"operationId": "ListBlogItems",
"parameters": [
{
"name": "count",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 6
}
},
{
"name": "organizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlogItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlogItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlogItem"
}
}
}
}
}
}
}
},
"/Clients": {
"get": {
"tags": ["Clients"],
"operationId": "ListClients",
"parameters": [
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Client"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Client"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Client"
}
}
}
}
}
}
},
"post": {
"tags": ["Clients"],
"operationId": "CreateClient",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
}
}
}
}
}
},
"/Clients/{clientId}": {
"get": {
"tags": ["Clients"],
"operationId": "GetClient",
"parameters": [
{
"name": "clientId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
}
}
}
}
},
"put": {
"tags": ["Clients"],
"parameters": [
{
"name": "clientId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Client"
}
}
}
}
}
},
"delete": {
"tags": ["Clients"],
"parameters": [
{
"name": "clientId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/Consumers": {
"get": {
"tags": ["Consumers"],
"operationId": "ListConsumers",
"parameters": [
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Consumer"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Consumer"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Consumer"
}
}
}
}
}
}
},
"post": {
"tags": ["Consumers"],
"operationId": "CreateConsumer",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
}
}
}
}
}
},
"/Consumers/{id}": {
"get": {
"tags": ["Consumers"],
"operationId": "GetConsumer",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
}
}
}
}
},
"put": {
"tags": ["Consumers"],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Consumer"
}
}
}
}
}
},
"delete": {
"tags": ["Consumers"],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/CrayonAccounts": {
"get": {
"tags": ["CrayonAccounts"],
"operationId": "ListCrayonAccounts",
"parameters": [
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PublisherId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ConsumerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CustomerTenantType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/CustomerTenantType"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrayonAccount"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrayonAccount"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrayonAccount"
}
}
}
}
}
}
},
"post": {
"tags": ["CrayonAccounts"],
"operationId": "CreateCrayonAccount",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
}
}
}
}
}
},
"/CrayonAccounts/{id}": {
"get": {
"tags": ["CrayonAccounts"],
"operationId": "GetCrayonAccount",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
}
}
}
}
},
"put": {
"tags": ["CrayonAccounts"],
"operationId": "UpdateCrayonAccount",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CrayonAccount"
}
}
}
}
}
}
},
"/customertenants/{customerTenantId}/agreements": {
"get": {
"tags": ["CustomerTenantAgreements"],
"operationId": "ListCustomerTenantAgreements",
"parameters": [
{
"name": "customerTenantId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "AgreementTypeConsent",
"in": "query",
"schema": {
"$ref": "#/components/schemas/AgreementTypeConsent"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceAccountAgreement"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceAccountAgreement"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceAccountAgreement"
}
}
}
}
}
}
},
"post": {
"tags": ["CustomerTenantAgreements"],
"operationId": "CreateCustomerTenantAgreements",
"parameters": [
{
"name": "customerTenantId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountAgreement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountAgreement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountAgreement"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountAgreement"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountAgreement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountAgreement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountAgreement"
}
}
}
}
}
}
},
"/CustomerTenants": {
"get": {
"tags": ["CustomerTenants"],
"operationId": "ListCustomerTenants",
"parameters": [
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PublisherId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ProgramId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ConsumerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Domain",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "DomainPrefix",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "CustomerTenantType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/CustomerTenantType"
}
},
{
"name": "InvoiceProfileId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerTenant"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerTenant"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerTenant"
}
}
}
}
}
}
},
"post": {
"tags": ["CustomerTenants"],
"operationId": "CreateCustomerTenant",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
}
}
}
}
}
},
"/CustomerTenants/{id}": {
"get": {
"tags": ["CustomerTenants"],
"operationId": "GetCustomerTenant",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomerTenant"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenant"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenant"
}
}
}
}
}
},
"put": {
"tags": ["CustomerTenants"],
"operationId": "UpdateCustomerTenant",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
}
}
}
}
},
"delete": {
"tags": ["CustomerTenants"],
"operationId": "DeleteCustomerTenant",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/CustomerTenants/{id}/detailed": {
"get": {
"tags": ["CustomerTenants"],
"operationId": "GetCustomerTenantDetails",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
}
}
}
}
}
},
"/CustomerTenants/existing": {
"post": {
"tags": ["CustomerTenants"],
"operationId": "CreateCustomerTenantFromExisting",
"parameters": [
{
"name": "syncFromPublisher",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTenantDetailed"
}
}
}
}
}
}
},
"/CustomerTenants/{customerTenantId}/azurePlan": {
"get": {
"tags": ["CustomerTenants"],
"operationId": "ListCustomerTenantAzurePlan",
"parameters": [
{
"name": "customerTenantId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AzurePlan"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AzurePlan"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AzurePlan"
}
}
}
}
}
}
},
"/connect/token": {
"post": {
"tags": ["CustomerToken"],
"operationId": "GetCustomerToken",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Token"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
}
}
}
}
}
},
"/FacebookOrders/checkout": {
"post": {
"tags": ["FacebookOrders"],
"operationId": "CheckoutFacebookOrder",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/FacebookOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacebookOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FacebookOrder"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/FacebookOrder"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/GoogleOrders/checkout": {
"post": {
"tags": ["GoogleOrders"],
"operationId": "CheckoutGoogleOrder",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GoogleOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GoogleOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GoogleOrder"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GoogleOrder"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/Groupings": {
"get": {
"tags": ["Groupings"],
"operationId": "ListGroupings",
"parameters": [
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IncludeRemoved",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Grouping"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Grouping"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Grouping"
}
}
}
}
}
}
},
"post": {
"tags": ["Groupings"],
"operationId": "CreateGrouping",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
}
}
}
}
}
},
"/Groupings/{id}": {
"get": {
"tags": ["Groupings"],
"operationId": "GetGrouping",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
}
}
}
}
},
"put": {
"tags": ["Groupings"],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Grouping"
}
}
}
}
}
},
"delete": {
"tags": ["Groupings"],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/InvoiceProfiles": {
"get": {
"tags": ["InvoiceProfiles"],
"operationId": "ListInvoiceProfiles",
"parameters": [
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceProfile"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceProfile"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceProfile"
}
}
}
}
}
}
},
"post": {
"tags": ["InvoiceProfiles"],
"operationId": "CreateInvoiceProfile",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
}
}
}
}
}
},
"/InvoiceProfiles/{id}": {
"get": {
"tags": ["InvoiceProfiles"],
"operationId": "GetInvoiceProfile",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
}
}
}
}
},
"put": {
"tags": ["InvoiceProfiles"],
"operationId": "UpdateInvoiceProfile",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceProfile"
}
}
}
}
}
},
"delete": {
"tags": ["InvoiceProfiles"],
"operationId": "DeleteInvoiceProfile",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/ManagementLinks": {
"get": {
"tags": ["ManagementLinks"],
"operationId": "ListManagementLinks",
"parameters": [
{
"name": "SubscriptionIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "ResellerCustomerIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagementLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagementLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagementLink"
}
}
}
}
}
}
}
},
"/ManagementLinks/grouped": {
"get": {
"tags": ["ManagementLinks"],
"operationId": "ListGroupedManagementLinks",
"parameters": [
{
"name": "SubscriptionIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "ResellerCustomerIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagementLinkGrouped"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagementLinkGrouped"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagementLinkGrouped"
}
}
}
}
}
}
}
},
"/Me": {
"get": {
"tags": ["Me"],
"operationId": "GetMe",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Me"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Me"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Me"
}
}
}
}
}
}
},
"/OrganizationAccess/grant": {
"get": {
"tags": ["OrganizationAccess"],
"operationId": "GrantOrganizationAccess",
"parameters": [
{
"name": "userId",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "organizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10000
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
}
}
}
}
}
}
}
},
"/OrganizationAccess": {
"get": {
"tags": ["OrganizationAccess"],
"operationId": "ListOrganizationAccess",
"parameters": [
{
"name": "userId",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "organizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10000
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
}
}
}
}
}
}
},
"put": {
"tags": ["OrganizationAccess"],
"operationId": "UpdateOrganizationAccess",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationAccess"
}
}
}
}
}
}
}
},
"/Organizations": {
"get": {
"tags": ["Organizations"],
"operationId": "ListOrganizations",
"parameters": [
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organization"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organization"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organization"
}
}
}
}
}
}
}
},
"/Organizations/{id}": {
"get": {
"tags": ["Organizations"],
"operationId": "GetOrganization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
}
}
}
}
}
},
"/Organizations/{organizationId}/salescontact": {
"get": {
"tags": ["Organizations"],
"operationId": "ListSalesContacts",
"parameters": [
{
"name": "organizationId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OrganizationSalesContact"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationSalesContact"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationSalesContact"
}
}
}
}
}
}
},
"/Organizations/HasAccess/{id}": {
"get": {
"tags": ["Organizations"],
"operationId": "GetOrganizationHazAccess",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/Ping": {
"get": {
"tags": ["Ping"],
"operationId": "Ping",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/ProductContainers": {
"get": {
"tags": ["ProductContainers"],
"operationId": "ListProductContainers",
"parameters": [
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ActiveDraft",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "ProgramId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Year",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Month",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "UserId",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "SentByUserId",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "Type",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ProductContainerType"
}
},
{
"name": "Category",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ProductContainerCategory"
}
},
{
"name": "From",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "To",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "IncludeRemoved",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeSubsidiaries",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductContainer"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductContainer"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductContainer"
}
}
}
}
}
}
}
},
"/ProductContainers/{id}": {
"get": {
"tags": ["ProductContainers"],
"operationId": "GetProductContainer",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
}
}
}
}
},
"put": {
"tags": ["ProductContainers"],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "requireEulaAnalysis",
"in": "query",
"schema": {
"type": "boolean",
"default": false,
"nullable": true
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
}
}
}
}
},
"delete": {
"tags": ["ProductContainers"],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/ProductContainers/rowissues/{id}": {
"get": {
"tags": ["ProductContainers"],
"operationId": "GetProductContainerRowIssue",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
}
}
}
}
}
},
"/ProductContainers/{productContainerId}/row/{productRowId}": {
"patch": {
"tags": ["ProductContainers"],
"operationId": "UpdateProductRow",
"parameters": [
{
"name": "productContainerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "productRowId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ProductRowPatch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductRowPatch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductRowPatch"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ProductRowPatch"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
}
}
}
}
}
},
"/ProductContainers/reportbymonth": {
"post": {
"tags": ["ProductContainers"],
"operationId": "GetProductContainersReportByMonth",
"parameters": [
{
"name": "year",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "programId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "organizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "copyLast",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
}
}
}
}
}
},
"/ProductContainers/getorcreateshoppingcart": {
"get": {
"tags": ["ProductContainers"],
"operationId": "GetOrCreateProductContainerShoppingCart",
"parameters": [
{
"name": "organizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductContainer"
}
}
}
}
}
}
},
"/Programs": {
"get": {
"tags": ["Programs"],
"operationId": "ListPrograms",
"parameters": [
{
"name": "PublisherId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ProgramType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ProgramType"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Program"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Program"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Program"
}
}
}
}
}
}
}
},
"/Programs/{id}": {
"get": {
"tags": ["Programs"],
"operationId": "GetProgram",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Program"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Program"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Program"
}
}
}
}
}
}
},
"/Publishers": {
"get": {
"tags": ["Publishers"],
"operationId": "ListPublishers",
"parameters": [
{
"name": "Names",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "ProgramType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ProgramType"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Publisher"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Publisher"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Publisher"
}
}
}
}
}
}
}
},
"/Publishers/{id}": {
"get": {
"tags": ["Publishers"],
"operationId": "GetPublisher",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Publisher"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Publisher"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Publisher"
}
}
}
}
}
}
},
"/Regions": {
"get": {
"tags": ["Regions"],
"operationId": "ListRegions",
"parameters": [
{
"name": "RegionList",
"in": "query",
"schema": {
"$ref": "#/components/schemas/RegionList"
}
},
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Region"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Region"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Region"
}
}
}
}
}
}
}
},
"/Regions/bycode": {
"get": {
"tags": ["Regions"],
"operationId": "GetRegionByCode",
"parameters": [
{
"name": "regionCode",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "regionList",
"in": "query",
"schema": {
"$ref": "#/components/schemas/RegionList"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Region"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Region"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Region"
}
}
}
}
}
}
},
"/ResellerSalesPrices": {
"get": {
"tags": ["ResellerSalesPrices"],
"operationId": "GetResellerSalesPrices",
"parameters": [
{
"name": "Type",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ResellerSalesPriceType"
}
},
{
"name": "ObjectId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ObjectType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ResellerSalesPriceObjectType"
}
},
{
"name": "FromDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
}
}
}
}
}
},
"post": {
"tags": ["ResellerSalesPrices"],
"operationId": "CreateResellerSalesPrices",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
}
}
}
}
},
"delete": {
"tags": ["ResellerSalesPrices"],
"operationId": "DeleteResellerSalesPrices",
"parameters": [
{
"name": "Type",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ResellerSalesPriceType"
}
},
{
"name": "ObjectId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ObjectType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ResellerSalesPriceObjectType"
}
},
{
"name": "FromDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/ResellerSalesPrices/current": {
"get": {
"tags": ["ResellerSalesPrices"],
"operationId": "GetCurrentResellerSalesPrices",
"parameters": [
{
"name": "Type",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ResellerSalesPriceType"
}
},
{
"name": "ObjectId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ObjectType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ResellerSalesPriceObjectType"
}
},
{
"name": "FromDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
}
}
}
}
}
},
"/ResellerSalesPrices/{oldFromDate}": {
"put": {
"tags": ["ResellerSalesPrices"],
"operationId": "GetResellerSalesPricesByDate",
"parameters": [
{
"name": "oldFromDate",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPrice"
}
}
}
}
}
}
},
"/ResellerSalesPrices/toggle": {
"post": {
"tags": ["ResellerSalesPrices"],
"operationId": "ToggleResellerSalesPrices",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPriceToggle"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPriceToggle"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPriceToggle"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ResellerSalesPriceToggle"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/Secrets": {
"post": {
"tags": ["Secrets"],
"operationId": "ListSecrets",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
}
}
}
}
},
"delete": {
"tags": ["Secrets"],
"operationId": "DeleteSecret",
"parameters": [
{
"name": "clientId",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "secretId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/Subscriptions": {
"get": {
"tags": ["Subscriptions"],
"operationId": "ListSubscriptions",
"parameters": [
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CustomerTenantId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PublisherId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Refresh",
"in": "query",
"schema": {
"type": "boolean",
"deprecated": true
}
},
{
"name": "Statuses",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SubscriptionStatus"
}
},
{
"name": "IsTrial",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "RegisteredForReservedInstance",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
},
{
"name": "SortBy",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SubscriptionSortBy"
}
},
{
"name": "SortOrder",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortOrder"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
}
}
}
}
}
},
"post": {
"tags": ["Subscriptions"],
"operationId": "CreateSubscription",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
}
}
}
}
}
},
"/Subscriptions/{id}": {
"get": {
"tags": ["Subscriptions"],
"operationId": "GetSubscription",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
}
}
}
}
},
"put": {
"tags": ["Subscriptions"],
"operationId": "UpdateSubscription",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
}
}
}
}
}
},
"/Subscriptions/{subscriptionId}/conversions": {
"get": {
"tags": ["Subscriptions"],
"operationId": "GetSubscriptionConversions",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionConversion"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionConversion"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionConversion"
}
}
}
}
}
}
},
"post": {
"tags": ["Subscriptions"],
"operationId": "CreateSubscriptionConversions",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionConversion"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionConversion"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionConversion"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionConversion"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDetailed"
}
}
}
}
}
}
},
"/Subscriptions/{id}/activationlink": {
"get": {
"tags": ["Subscriptions"],
"operationId": "GetSubscriptionActivationLink",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ActivationLink"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivationLink"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ActivationLink"
}
}
}
}
}
}
},
"/Subscriptions/{reservedInstance}/subscriptionId/{id}": {
"get": {
"tags": ["Subscriptions"],
"operationId": "GetSubscriptionReservedInstanceById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "reservedInstance",
"in": "path",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "boolean"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "boolean"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "boolean"
}
}
}
}
}
}
},
"post": {
"tags": ["Subscriptions"],
"operationId": "CreateReservedInstanceSubscription",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "reservedInstance",
"in": "path",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/Subscriptions/{id}/transition-eligibilities": {
"get": {
"tags": ["Subscriptions"],
"operationId": "ListSubscriptionsTransitionEligibilities",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionTransitionEligibility"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionTransitionEligibility"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionTransitionEligibility"
}
}
}
}
}
}
}
},
"/Subscriptions/{id}/transition": {
"post": {
"tags": ["Subscriptions"],
"operationId": "CreateSubscriptionTransition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTransition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTransition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTransition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTransition"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTransitionResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTransitionResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTransitionResponse"
}
}
}
}
}
}
},
"/Subscriptions/subscriptionpricetypes": {
"get": {
"tags": ["Subscriptions"],
"operationId": "ListSubscriptionPriceTypes",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectReference"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectReference"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectReference"
}
}
}
}
}
}
}
},
"/Subscriptions/{subscriptionId}/tags": {
"get": {
"tags": ["Subscriptions"],
"operationId": "ListSubscriptionTags",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTags"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTags"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTags"
}
}
}
}
}
},
"post": {
"tags": ["Subscriptions"],
"operationId": "CreateSubscriptionTags",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTags"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTags"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTags"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTags"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"delete": {
"tags": ["Subscriptions"],
"operationId": "DeleteSubscriptionTags",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/Subscriptions/{subscriptionId}/addon-offers": {
"get": {
"tags": ["Subscriptions"],
"operationId": "ListSubscriptionAddonOffers",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionAddOnOffer"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionAddOnOffer"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionAddOnOffer"
}
}
}
}
}
}
}
},
"/Subscriptions/{subscriptionId}/addons": {
"post": {
"tags": ["Subscriptions"],
"operationId": "CreateSubscriptionAddon",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PostSubscriptionAddOn"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostSubscriptionAddOn"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PostSubscriptionAddOn"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PostSubscriptionAddOn"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/UsageCost/organization/{organizationId}": {
"get": {
"tags": ["UsageCost"],
"operationId": "GetUsageCostByOrganizationId",
"parameters": [
{
"name": "organizationId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationUsageCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationUsageCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationUsageCost"
}
}
}
}
}
}
}
},
"/UsageCost/getForSubscription": {
"post": {
"tags": ["UsageCost"],
"operationId": "CreateUsageCostForSubscription",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionUsageCostRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionUsageCostRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionUsageCostRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionUsageCostRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionUsageCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionUsageCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionUsageCost"
}
}
}
}
}
}
}
},
"/UsageCost/getForCategory": {
"post": {
"tags": ["UsageCost"],
"operationId": "CreateUsageCostForCategory",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CategoryUsageCostRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategoryUsageCostRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CategoryUsageCostRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CategoryUsageCostRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CategoryUsageCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CategoryUsageCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CategoryUsageCost"
}
}
}
}
}
}
}
},
"/UsageCost/getForSubcategory": {
"post": {
"tags": ["UsageCost"],
"operationId": "CreateUsageCostForSubcategory",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SubcategoryUsageCostRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubcategoryUsageCostRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubcategoryUsageCostRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SubcategoryUsageCostRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubcategoryUsageCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubcategoryUsageCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubcategoryUsageCost"
}
}
}
}
}
}
}
},
"/UsageCost/getForSubscription/resourceGroups": {
"post": {
"tags": ["UsageCost"],
"operationId": "CreateUsageCostForSubscriptionResourceGroups",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionUsageCostRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionUsageCostRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionUsageCostRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionUsageCostRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionResourceGroupUsageCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionResourceGroupUsageCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionResourceGroupUsageCost"
}
}
}
}
}
}
}
},
"/UsageCost/getForResourceGroup": {
"post": {
"tags": ["UsageCost"],
"operationId": "CreateUsageCostForResourceGroup",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ResourceGroupUsageCostRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceGroupUsageCostRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ResourceGroupUsageCostRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ResourceGroupUsageCostRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceGroupUsageCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceGroupUsageCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceGroupUsageCost"
}
}
}
}
}
}
}
},
"/Users": {
"get": {
"tags": ["Users"],
"operationId": "ListUsers",
"parameters": [
{
"name": "Search",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "OrganizationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Role",
"in": "query",
"schema": {
"$ref": "#/components/schemas/UserRole"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"post": {
"tags": ["Users"],
"operationId": "CreateUser",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"/Users/{id}": {
"get": {
"tags": ["Users"],
"operationId": "GetUser",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
},
"put": {
"tags": ["Users"],
"operationId": "UpdateUser",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
},
"delete": {
"tags": ["Users"],
"operationId": "DeleteUser",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/Users/user": {
"get": {
"tags": ["Users"],
"operationId": "ListUsersUser",
"parameters": [
{
"name": "userName",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"/Users/{id}/changepassword": {
"put": {
"tags": ["Users"],
"operationId": "UpdateUserPassword",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UserChangePassword"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserChangePassword"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserChangePassword"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UserChangePassword"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ChangeTypeEnum": {
"enum": [1, 2, 3],
"type": "integer",
"format": "int32"
},
"ActivityLogItem": {
"type": "object",
"properties": {
"entity": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"changedBy": {
"type": "string",
"nullable": true
},
"changedDate": {
"type": "string",
"format": "date-time"
},
"changedColumn": {
"type": "string",
"nullable": true
},
"changedFrom": {
"type": "string",
"nullable": true
},
"changedTo": {
"type": "string",
"nullable": true
},
"customValues": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"changeType": {
"$ref": "#/components/schemas/ChangeTypeEnum"
}
},
"additionalProperties": false
},
"AddressType": {
"enum": [0, 1, 2],
"type": "integer",
"format": "int32"
},
"ObjectReference": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Address": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
},
"name": {
"type": "string",
"nullable": true
},
"completeAddress": {
"type": "string",
"nullable": true
},
"street": {
"type": "string",
"nullable": true
},
"zipCode": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"county": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"primary": {
"type": "boolean"
},
"addressType": {
"$ref": "#/components/schemas/AddressType"
}
},
"additionalProperties": false
},
"AgreementType": {
"enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12],
"type": "integer",
"format": "int32"
},
"SortOrder": {
"enum": [0, 1],
"type": "integer",
"format": "int32"
},
"ProductTypeDto": {
"enum": [0, 1, 2, 3],
"type": "integer",
"format": "int32"
},
"ProductReference": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"partNumber": {
"type": "string",
"nullable": true
},
"publisherProductId": {
"type": "string",
"nullable": true
},
"itemLegalName": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MinimumCommitmentLight": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"months": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ProductVariant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"product": {
"$ref": "#/components/schemas/ProductReference"
},
"partNumber": {
"type": "string",
"nullable": true
},
"productName": {
"type": "string",
"nullable": true
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
},
"program": {
"$ref": "#/components/schemas/ObjectReference"
},
"productFamily": {
"$ref": "#/components/schemas/ObjectReference"
},
"language": {
"$ref": "#/components/schemas/ObjectReference"
},
"level": {
"$ref": "#/components/schemas/ObjectReference"
},
"productType": {
"$ref": "#/components/schemas/ObjectReference"
},
"pool": {
"$ref": "#/components/schemas/ObjectReference"
},
"licenseType": {
"$ref": "#/components/schemas/ObjectReference"
},
"licenseAgreementType": {
"$ref": "#/components/schemas/ObjectReference"
},
"operatingSystem": {
"$ref": "#/components/schemas/ObjectReference"
},
"offering": {
"$ref": "#/components/schemas/ObjectReference"
},
"minimumCommitment": {
"$ref": "#/components/schemas/MinimumCommitmentLight"
},
"unitCount": {
"type": "integer",
"format": "int32"
},
"version": {
"type": "string",
"nullable": true
},
"purchaseUnit": {
"type": "string",
"nullable": true
},
"purchasePeriod": {
"type": "string",
"nullable": true
},
"addDate": {
"type": "string",
"format": "date-time"
},
"deleteDate": {
"type": "string",
"format": "date-time"
},
"productCategory": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"isTrial": {
"type": "boolean"
},
"defaultBillingCycleId": {
"type": "integer",
"format": "int32"
},
"availableBillingCycleIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false
},
"nullable": true
},
"minimumQuantity": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"Price": {
"type": "object",
"properties": {
"value": {
"type": "number",
"format": "double"
},
"currencyCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PriceCalculationType": {
"enum": [0, 1, 2, 3, 4],
"type": "integer",
"format": "int32"
},
"ProductInformation": {
"type": "object",
"properties": {
"externalProductId": {
"type": "integer",
"format": "int32"
},
"cultureCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"learnMoreLink": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AgreementProduct": {
"type": "object",
"properties": {
"uniqueId": {
"type": "string",
"nullable": true
},
"productType": {
"$ref": "#/components/schemas/ProductTypeDto"
},
"productVariant": {
"$ref": "#/components/schemas/ProductVariant"
},
"agreement": {
"$ref": "#/components/schemas/ObjectReference"
},
"name": {
"type": "string",
"nullable": true
},
"priceId": {
"type": "integer",
"format": "int32"
},
"recommendedRetailPrice": {
"$ref": "#/components/schemas/Price"
},
"salesPrice": {
"$ref": "#/components/schemas/Price"
},
"alternativeSalesPrice": {
"$ref": "#/components/schemas/Price"
},
"priceListName": {
"type": "string",
"nullable": true
},
"monthMultiplier": {
"type": "integer",
"format": "int32"
},
"priceCalculationType": {
"$ref": "#/components/schemas/PriceCalculationType"
},
"agreementType": {
"$ref": "#/components/schemas/AgreementType"
},
"productInformation": {
"$ref": "#/components/schemas/ProductInformation"
},
"minimumQuantity": {
"type": "integer",
"format": "int32"
},
"maximumQuantity": {
"type": "integer",
"format": "int32",
"nullable": true
},
"catalog": {
"$ref": "#/components/schemas/ObjectReference"
}
},
"additionalProperties": false
},
"AgreementProductsSubFilter": {
"type": "object",
"properties": {
"partNumbers": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"publisherIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"publisherNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"poolNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"operatingSystemNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"levelNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"languageNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"licenseAgreementTypeNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"licenseTypeNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"productFamilyNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"productTypeNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"programNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"offeringNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"purchasePeriodNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"purchaseUnitNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"versionNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"regionNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"productCategoryNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"catalogNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"billingCycles": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"AgreementProductFilter": {
"type": "object",
"properties": {
"agreementTypeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementType"
},
"nullable": true
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"search": {
"type": "string",
"nullable": true
},
"priceListId": {
"type": "integer",
"format": "int32"
},
"organizationId": {
"type": "integer",
"format": "int32"
},
"customerTenantId": {
"type": "integer",
"format": "int32"
},
"agreementId": {
"type": "integer",
"format": "int32"
},
"isTrial": {
"type": "boolean",
"nullable": true
},
"agreementIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"searchDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"include": {
"$ref": "#/components/schemas/AgreementProductsSubFilter"
},
"exclude": {
"$ref": "#/components/schemas/AgreementProductsSubFilter"
},
"sortKey": {
"type": "string",
"nullable": true
},
"includeProductInformation": {
"type": "boolean"
},
"sortOrder": {
"$ref": "#/components/schemas/SortOrder"
}
},
"additionalProperties": false
},
"BillingCycleEnum": {
"enum": [0, 1, 2, 3, 4, 5, 7, 8, 9],
"type": "integer",
"format": "int32"
},
"ObjectReferenceDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AgreementIdentityReferenceDto": {
"type": "object",
"properties": {
"agreementNumber": {
"type": "string",
"nullable": true
},
"commitmentLevel": {
"type": "number",
"format": "double"
},
"isCustomCommitment": {
"type": "boolean"
},
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AgreementReportStatus": {
"enum": [0, 1, 2, 4, 6],
"type": "integer",
"format": "int32"
},
"AgreementReport": {
"type": "object",
"properties": {
"productContainer": {
"$ref": "#/components/schemas/ObjectReferenceDto"
},
"agreement": {
"$ref": "#/components/schemas/AgreementIdentityReferenceDto"
},
"status": {
"$ref": "#/components/schemas/AgreementReportStatus"
},
"hasValidAgreementTerm": {
"type": "boolean"
}
},
"additionalProperties": false
},
"AgreementStatus": {
"enum": [0, 1, 2, 3],
"type": "integer",
"format": "int32"
},
"Agreement": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
},
"name": {
"type": "string",
"nullable": true
},
"salesPriceCurrencyCode": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"disabled": {
"type": "boolean"
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
},
"program": {
"$ref": "#/components/schemas/ObjectReference"
},
"number": {
"type": "string",
"nullable": true
},
"customerNumber": {
"type": "string",
"nullable": true
},
"masterAgreement": {
"type": "string",
"nullable": true
},
"hasTerms": {
"type": "boolean"
},
"agreementType": {
"$ref": "#/components/schemas/AgreementType"
},
"parentAgreementId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"commitmentLevel": {
"type": "number",
"format": "double"
},
"consumerId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"AssetType": {
"enum": [1, 2, 3],
"type": "integer",
"format": "int32"
},
"AssetStatus": {
"enum": [0, 1, 2, 4, 8, 15],
"type": "integer",
"format": "int32"
},
"AssetSortBy": {
"enum": [0, 1, 2],
"type": "integer",
"format": "int32"
},
"AssetScope": {
"enum": [1, 2],
"type": "integer",
"format": "int32"
},
"BillingCycleType": {
"enum": [0, 1, 2, 3, 4, 5],
"type": "integer",
"format": "int32"
},
"SubscriptionLite": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"publisherSubscriptionId": {
"type": "string",
"nullable": true
},
"resellerCustomerName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SalesPriceType": {
"enum": [0, 1, 2, 3, -1],
"type": "integer",
"format": "int32"
},
"AssetTags": {
"type": "object",
"properties": {
"assetId": {
"type": "integer",
"format": "int32"
},
"costCenter": {
"type": "string",
"nullable": true
},
"department": {
"type": "string",
"nullable": true
},
"project": {
"type": "string",
"nullable": true
},
"custom": {
"type": "string",
"nullable": true
},
"owner": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Asset": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"status": {
"$ref": "#/components/schemas/AssetStatus"
},
"externalOrderId": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
},
"productId": {
"type": "integer",
"format": "int32"
},
"productVariantId": {
"type": "integer",
"format": "int32"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"resellerCustomerId": {
"type": "integer",
"format": "int32"
},
"scope": {
"$ref": "#/components/schemas/AssetScope"
},
"assetType": {
"$ref": "#/components/schemas/AssetType"
},
"billingCycle": {
"$ref": "#/components/schemas/BillingCycleType"
},
"publisherId": {
"type": "integer",
"format": "int32"
},
"programId": {
"type": "integer",
"format": "int32"
},
"reservationId": {
"type": "string",
"nullable": true
},
"reservationUsedInSubscriptionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"reservationUsedInSubscription": {
"$ref": "#/components/schemas/SubscriptionLite"
},
"purchaseCurrency": {
"type": "string",
"nullable": true
},
"purchasePrice": {
"type": "number",
"format": "double"
},
"salesCurrency": {
"type": "string",
"nullable": true
},
"salesPrice": {
"type": "number",
"format": "double"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"changedBy": {
"type": "string",
"nullable": true
},
"resellerPriceType": {
"$ref": "#/components/schemas/SalesPriceType"
},
"resellerPriceTypeValue": {
"type": "number",
"format": "double"
},
"reservedInstanceArtifactResourceId": {
"type": "string",
"nullable": true
},
"purchaseDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"productVariant": {
"$ref": "#/components/schemas/ProductVariant"
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"tags": {
"$ref": "#/components/schemas/AssetTags"
}
},
"additionalProperties": false
},
"AssetOrderError": {
"type": "object",
"properties": {
"orderGroupId": {
"type": "string",
"nullable": true
},
"code": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AssetOrderLineError": {
"type": "object",
"properties": {
"reasonCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"AssetOrderLine": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"nullable": true
},
"subscriptionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"armRegionName": {
"type": "string",
"nullable": true
},
"skuId": {
"type": "string",
"nullable": true
},
"productVariantId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
},
"billingCycle": {
"$ref": "#/components/schemas/BillingCycleType"
},
"provisioningContext": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"type": {
"$ref": "#/components/schemas/AssetType"
},
"requiresInventoryCheck": {
"type": "boolean"
},
"catalogItemId": {
"type": "string",
"nullable": true
},
"termDuration": {
"type": "string",
"nullable": true
},
"scope": {
"$ref": "#/components/schemas/AssetScope"
},
"resellerPriceType": {
"$ref": "#/components/schemas/SalesPriceType"
},
"resellerPriceTypeValue": {
"type": "number",
"format": "double"
},
"isTrial": {
"type": "boolean"
},
"tags": {
"$ref": "#/components/schemas/AssetTags"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetOrderLineError"
},
"nullable": true
}
},
"additionalProperties": false
},
"AssetOrder": {
"type": "object",
"properties": {
"externalOrderId": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"resellerCustomerId": {
"type": "integer",
"format": "int32"
},
"adminAccount": {
"type": "string",
"nullable": true
},
"notificationEmail": {
"type": "string",
"nullable": true
},
"invoiceProfileId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetOrderError"
},
"nullable": true
},
"orderLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetOrderLine"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomerTenantType": {
"enum": [0, 1, 2],
"type": "integer",
"format": "int32"
},
"EntityStatus": {
"enum": [0, 1],
"type": "integer",
"format": "int32"
},
"Organization": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"parentId": {
"type": "integer",
"format": "int32"
},
"crayonCompanyName": {
"type": "string",
"nullable": true
},
"accountNumber": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SubscriptionTags": {
"type": "object",
"properties": {
"subscriptionId": {
"type": "integer",
"format": "int32"
},
"costCenter": {
"type": "string",
"nullable": true
},
"department": {
"type": "string",
"nullable": true
},
"project": {
"type": "string",
"nullable": true
},
"custom": {
"type": "string",
"nullable": true
},
"owner": {
"type": "string",
"nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"AwsMasterAccountStatus": {
"enum": [0, 1, 2, 3],
"type": "integer",
"format": "int32"
},
"AwsAccount": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
},
"externalPublisherCustomerId": {
"type": "string",
"nullable": true
},
"reference": {
"type": "string",
"nullable": true
},
"customerTenantType": {
"$ref": "#/components/schemas/CustomerTenantType"
},
"entityStatus": {
"$ref": "#/components/schemas/EntityStatus"
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"isActivated": {
"type": "boolean"
},
"tags": {
"$ref": "#/components/schemas/SubscriptionTags"
},
"payerAccountId": {
"type": "string",
"nullable": true
},
"awsAccountName": {
"type": "string",
"nullable": true
},
"masterAccountStatus": {
"$ref": "#/components/schemas/AwsMasterAccountStatus"
}
},
"additionalProperties": false
},
"SubscriptionStatus": {
"enum": [0, 1, 2, 4, 8, 16, 30, 31, 32, 64],
"type": "integer",
"format": "int32"
},
"CustomerTenantReference": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"AzurePlan": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"publisherSubscriptionId": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/SubscriptionStatus"
},
"registeredForReservedInstance": {
"type": "boolean"
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
},
"customerTenant": {
"$ref": "#/components/schemas/CustomerTenantReference"
}
},
"additionalProperties": false
},
"AzureSubscriptionTags": {
"type": "object",
"properties": {
"costCenter": {
"type": "string",
"nullable": true
},
"department": {
"type": "string",
"nullable": true
},
"project": {
"type": "string",
"nullable": true
},
"custom": {
"type": "string",
"nullable": true
},
"owner": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AzureSubscription": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"azurePlanId": {
"type": "integer",
"format": "int32"
},
"publisherSubscriptionId": {
"type": "string",
"nullable": true
},
"friendlyName": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"tags": {
"$ref": "#/components/schemas/AzureSubscriptionTags"
}
},
"additionalProperties": false
},
"CreateAzureSubscriptionRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PutAzureSubscription": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"tags": {
"$ref": "#/components/schemas/AzureSubscriptionTags"
}
},
"additionalProperties": false
},
"AzureSubscriptionAssignAdmin": {
"type": "object",
"properties": {
"azurePlanId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"azureSubscriptionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"adminEmail": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AzureSubscriptionUpdated": {
"type": "object",
"properties": {
"azureSubscriptionId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AzureSubscriptionRename": {
"type": "object",
"properties": {
"azurePlanId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"azureSubscriptionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BillingCycle": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ProvisionType": {
"enum": [0, 1, 2, 3, 4, 5],
"type": "integer",
"format": "int32"
},
"BillingStatement": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"totalSalesPrice": {
"$ref": "#/components/schemas/Price"
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"provisionType": {
"$ref": "#/components/schemas/ProvisionType"
},
"orderId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"GroupedBillingStatement": {
"type": "object",
"properties": {
"groupId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"totalSalesPrice": {
"$ref": "#/components/schemas/Price"
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"provisionType": {
"$ref": "#/components/schemas/ProvisionType"
},
"orderId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BlogItem": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"author": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"image": {
"type": "string",
"nullable": true
},
"link": {
"type": "string",
"format": "uri",
"nullable": true
},
"publicationDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"Secret": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"clientId": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"expiration": {
"type": "string",
"format": "date-time",
"nullable": true
},
"timeStamp": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"Flow": {
"enum": [0, 1, 4, 9999],
"type": "integer",
"format": "int32"
},
"Client": {
"type": "object",
"properties": {
"clientId": {
"type": "string",
"nullable": true
},
"clientName": {
"type": "string",
"nullable": true
},
"clientUri": {
"type": "string",
"format": "uri",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"clientSecrets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Secret"
},
"nullable": true
},
"redirectUris": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"nullable": true
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"flow": {
"$ref": "#/components/schemas/Flow"
}
},
"additionalProperties": false
},
"Consumer": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
}
},
"additionalProperties": false
},
"CustomerTenantContact": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CrayonAccount": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
},
"externalPublisherCustomerId": {
"type": "string",
"nullable": true
},
"reference": {
"type": "string",
"nullable": true
},
"customerTenantType": {
"$ref": "#/components/schemas/CustomerTenantType"
},
"entityStatus": {
"$ref": "#/components/schemas/EntityStatus"
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"isActivated": {
"type": "boolean"
},
"contact": {
"$ref": "#/components/schemas/CustomerTenantContact"
},
"program": {
"$ref": "#/components/schemas/ObjectReference"
},
"resellerMarkup": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"AgreementTypeConsent": {
"enum": [0, 1],
"type": "integer",
"format": "int32"
},
"ServiceAccountAgreement": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"dateAgreed": {
"type": "string",
"format": "date-time"
},
"agreementType": {
"$ref": "#/components/schemas/AgreementTypeConsent"
}
},
"additionalProperties": false
},
"SubscriptionPriceType": {
"enum": [1, 2, 3],
"type": "integer",
"format": "int32"
},
"CustomerTenantAgreement": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"sameAsPrimaryContact": {
"type": "boolean"
},
"dateAgreed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"accepted": {
"type": "boolean"
},
"agreementType": {
"$ref": "#/components/schemas/AgreementTypeConsent"
}
},
"additionalProperties": false
},
"CustomerTenant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
},
"program": {
"$ref": "#/components/schemas/ObjectReference"
},
"publisherCustomerId": {
"type": "string",
"nullable": true
},
"externalPublisherCustomerId": {
"type": "string",
"nullable": true
},
"domain": {
"type": "string",
"nullable": true
},
"domainPrefix": {
"type": "string",
"nullable": true
},
"reference": {
"type": "string",
"nullable": true
},
"customerTenantType": {
"$ref": "#/components/schemas/CustomerTenantType"
},
"entityStatus": {
"$ref": "#/components/schemas/EntityStatus"
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"consumer": {
"$ref": "#/components/schemas/ObjectReference"
},
"resellerMarkup": {
"type": "number",
"format": "double"
},
"defaultSubscriptionPriceType": {
"$ref": "#/components/schemas/SubscriptionPriceType"
},
"agreement": {
"$ref": "#/components/schemas/CustomerTenantAgreement"
}
},
"additionalProperties": false
},
"CustomerTenantUser": {
"type": "object",
"properties": {
"userName": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CustomerTenantAddress": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"middleName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"addressLine1": {
"type": "string",
"nullable": true
},
"addressLine2": {
"type": "string",
"nullable": true
},
"addressLine3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"countryName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CustomerTenantProfile": {
"type": "object",
"properties": {
"cultureCode": {
"type": "string",
"nullable": true
},
"languageCode": {
"type": "string",
"nullable": true
},
"contact": {
"$ref": "#/components/schemas/CustomerTenantContact"
},
"address": {
"$ref": "#/components/schemas/CustomerTenantAddress"
},
"agreement": {
"$ref": "#/components/schemas/CustomerTenantAgreement"
}
},
"additionalProperties": false
},
"CustomerTenantCompany": {
"type": "object",
"properties": {
"organizationRegistrationNumber": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CustomerTenantDetailed": {
"type": "object",
"properties": {
"tenant": {
"$ref": "#/components/schemas/CustomerTenant"
},
"user": {
"$ref": "#/components/schemas/CustomerTenantUser"
},
"profile": {
"$ref": "#/components/schemas/CustomerTenantProfile"
},
"company": {
"$ref": "#/components/schemas/CustomerTenantCompany"
}
},
"additionalProperties": false
},
"Token": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"nullable": true
},
"identityToken": {
"type": "string",
"nullable": true
},
"error": {
"type": "string",
"nullable": true
},
"expiresIn": {
"type": "integer",
"format": "int64"
},
"tokenType": {
"type": "string",
"nullable": true
},
"refreshToken": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FacebookOrder": {
"type": "object",
"properties": {
"contactName": {
"type": "string",
"nullable": true
},
"contactEmail": {
"type": "string",
"nullable": true
},
"consumerContactName": {
"type": "string",
"nullable": true
},
"consumerFullLegalName": {
"type": "string",
"nullable": true
},
"consumerContactEmail": {
"type": "string",
"nullable": true
},
"organizationId": {
"type": "integer",
"format": "int32"
},
"invoiceProfileId": {
"type": "integer",
"format": "int32"
},
"subscriptionStartDate": {
"type": "string",
"format": "date-time"
},
"consumerSignupEmail": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"GoogleOrder": {
"type": "object",
"properties": {
"contactName": {
"type": "string",
"nullable": true
},
"contactEmail": {
"type": "string",
"nullable": true
},
"consumerContactName": {
"type": "string",
"nullable": true
},
"consumerFullLegalName": {
"type": "string",
"nullable": true
},
"consumerContactEmail": {
"type": "string",
"nullable": true
},
"organizationId": {
"type": "integer",
"format": "int32"
},
"invoiceProfileId": {
"type": "integer",
"format": "int32"
},
"subscriptionStartDate": {
"type": "string",
"format": "date-time"
},
"domainName": {
"type": "string",
"nullable": true
},
"consumerCountry": {
"type": "string",
"nullable": true
},
"consumerStreetAddress": {
"type": "string",
"nullable": true
},
"consumerCity": {
"type": "string",
"nullable": true
},
"consumerState": {
"type": "string",
"nullable": true
},
"consumerZipCode": {
"type": "string",
"nullable": true
},
"consumerPhoneNumber": {
"type": "string",
"nullable": true
},
"primaryAdminName": {
"type": "string",
"nullable": true
},
"primaryAdminUserName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Grouping": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"isDisabled": {
"type": "boolean"
},
"isRemoved": {
"type": "boolean"
},
"invoiceReference": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AddressData": {
"type": "object",
"properties": {
"axAddressId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"completeAddress": {
"type": "string",
"nullable": true
},
"street": {
"type": "string",
"nullable": true
},
"zipCode": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"county": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"InvoiceProfile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
},
"name": {
"type": "string",
"nullable": true
},
"invoiceReference": {
"type": "string",
"nullable": true
},
"customerReference": {
"type": "string",
"nullable": true
},
"requisitionNumber": {
"type": "string",
"nullable": true
},
"invoiceAddressId": {
"type": "integer",
"format": "int64"
},
"deliveryAddressId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"deliveryAddress": {
"$ref": "#/components/schemas/AddressData"
},
"invoiceAddress": {
"$ref": "#/components/schemas/AddressData"
},
"consumerId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"contactPersonId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"ManagementLink": {
"type": "object",
"properties": {
"link": {
"type": "string",
"nullable": true
},
"resellerCustomer": {
"$ref": "#/components/schemas/ObjectReference"
},
"subscription": {
"$ref": "#/components/schemas/ObjectReference"
},
"text": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ManagementLinkGrouped": {
"type": "object",
"properties": {
"link": {
"type": "string",
"nullable": true
},
"resellerCustomer": {
"$ref": "#/components/schemas/ObjectReference"
},
"text": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Me": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"token": {
"type": "string",
"nullable": true
},
"claims": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"AgreementAccess": {
"type": "object",
"properties": {
"hasAccess": {
"type": "boolean"
},
"agreement": {
"$ref": "#/components/schemas/Agreement"
}
},
"additionalProperties": false
},
"UserProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OrganizationAccessRole": {
"enum": [0, 1, 2, 3, 4, 7],
"type": "integer",
"format": "int32"
},
"OrganizationAccess": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"allAgreements": {
"type": "boolean"
},
"agreements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgreementAccess"
},
"nullable": true
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"user": {
"$ref": "#/components/schemas/UserProfile"
},
"role": {
"$ref": "#/components/schemas/OrganizationAccessRole"
},
"crayonCompanyName": {
"type": "string",
"nullable": true
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OrganizationSalesContact": {
"type": "object",
"properties": {
"fullName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ProductContainerType": {
"enum": [0, 1, 2, 4, 8, 16],
"type": "integer",
"format": "int32"
},
"ProductContainerCategory": {
"enum": [0, 1, 2],
"type": "integer",
"format": "int32"
},
"Program": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"isCommitment": {
"type": "boolean"
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
}
},
"additionalProperties": false
},
"AgreementIdentityReference": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"agreementNumber": {
"type": "string",
"nullable": true
},
"commitmentLevel": {
"type": "number",
"format": "double"
},
"isCustomCommitment": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ProductRowUser": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"crayonEmployee": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ProductContainerIssue": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ProductRow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"productContainerId": {
"type": "integer",
"format": "int32"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"comment": {
"type": "string",
"nullable": true
},
"usageCountryCode": {
"type": "string",
"nullable": true
},
"salesUnitPrice": {
"$ref": "#/components/schemas/Price"
},
"alternativeSalesUnitPrice": {
"$ref": "#/components/schemas/Price"
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
},
"program": {
"$ref": "#/components/schemas/ObjectReference"
},
"agreement": {
"$ref": "#/components/schemas/AgreementIdentityReference"
},
"product": {
"$ref": "#/components/schemas/ProductReference"
},
"user": {
"$ref": "#/components/schemas/ProductRowUser"
},
"productVariant": {
"$ref": "#/components/schemas/ObjectReference"
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"grouping": {
"$ref": "#/components/schemas/Grouping"
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductContainerIssue"
},
"nullable": true
},
"offeringType": {
"type": "string",
"nullable": true
},
"priceCalculation": {
"$ref": "#/components/schemas/PriceCalculationType"
},
"invoiceReference": {
"type": "string",
"nullable": true
},
"customerReference": {
"type": "string",
"nullable": true
},
"salesPricePerAlternativeUnit": {
"type": "number",
"format": "double"
},
"levelValue": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"ProductContainerCommentUser": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"crayonEmployee": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ProductContainerCommentType": {
"enum": [
0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8190
],
"type": "integer",
"format": "int32"
},
"ProductContainerComment": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"productContainerId": {
"type": "integer",
"format": "int32"
},
"user": {
"$ref": "#/components/schemas/ProductContainerCommentUser"
},
"message": {
"type": "string",
"nullable": true
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"modified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"removed": {
"type": "boolean"
},
"productContainerCommentType": {
"$ref": "#/components/schemas/ProductContainerCommentType"
}
},
"additionalProperties": false
},
"ProductContainer": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"orderListId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"usageMonth": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string",
"nullable": true
},
"activeDraft": {
"type": "boolean"
},
"removed": {
"type": "boolean"
},
"createdByUserId": {
"type": "string",
"nullable": true
},
"axContactUserId": {
"type": "string",
"nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"orderStatusChangedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactUser": {
"$ref": "#/components/schemas/UserProfile"
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
},
"program": {
"$ref": "#/components/schemas/Program"
},
"productRows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductRow"
},
"nullable": true
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductContainerComment"
},
"nullable": true
},
"invoiceProfile": {
"$ref": "#/components/schemas/InvoiceProfile"
},
"deliveryAddress": {
"$ref": "#/components/schemas/AddressData"
},
"invoiceAddress": {
"$ref": "#/components/schemas/AddressData"
},
"type": {
"$ref": "#/components/schemas/ProductContainerType"
},
"category": {
"$ref": "#/components/schemas/ProductContainerCategory"
},
"quoteValidToDate": {
"type": "string",
"format": "date-time"
},
"totalSalesPrice": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Price"
},
"nullable": true
},
"totalAlternativeSalesPrice": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Price"
},
"nullable": true
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductContainerIssue"
},
"nullable": true
},
"submittedBy": {
"$ref": "#/components/schemas/ProductContainerCommentUser"
},
"sent": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"invoiceReference": {
"type": "string",
"nullable": true
},
"orderReference": {
"type": "string",
"nullable": true
},
"requisition": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ProductRowPatch": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"quantity": {
"type": "integer",
"format": "int32",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"usageCountryCode": {
"type": "string",
"nullable": true
},
"userId": {
"type": "string",
"nullable": true
},
"agreement": {
"$ref": "#/components/schemas/ObjectReference"
},
"productVariant": {
"$ref": "#/components/schemas/ObjectReference"
},
"grouping": {
"$ref": "#/components/schemas/ObjectReference"
}
},
"additionalProperties": false
},
"ProgramType": {
"enum": [0, 1, 2, 4],
"type": "integer",
"format": "int32"
},
"Publisher": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RegionList": {
"enum": [0, 1, 2],
"type": "integer",
"format": "int32"
},
"Region": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ResellerSalesPriceType": {
"enum": [1, 2, 3],
"type": "integer",
"format": "int32"
},
"ResellerSalesPriceObjectType": {
"enum": [1, 2, 3, 4, 5],
"type": "integer",
"format": "int32"
},
"ResellerSalesPricePriceType": {
"enum": [1, 2, 3],
"type": "integer",
"format": "int32"
},
"ResellerSalesPrice": {
"type": "object",
"properties": {
"objectId": {
"type": "integer",
"format": "int32"
},
"objectType": {
"$ref": "#/components/schemas/ResellerSalesPriceObjectType"
},
"type": {
"$ref": "#/components/schemas/ResellerSalesPriceType"
},
"priceType": {
"$ref": "#/components/schemas/ResellerSalesPricePriceType"
},
"value": {
"type": "number",
"format": "double"
},
"fromDate": {
"type": "string",
"format": "date-time"
},
"changedBy": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ResellerSalesPriceToggle": {
"type": "object",
"properties": {
"toggle": {
"type": "boolean"
},
"objectId": {
"type": "integer",
"format": "int32"
},
"objectType": {
"$ref": "#/components/schemas/ResellerSalesPriceObjectType"
}
},
"additionalProperties": false
},
"SubscriptionSortBy": {
"enum": [0, 1, 2, 3],
"type": "integer",
"format": "int32"
},
"SubscriptionAddOn": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"publisherSubscriptionId": {
"type": "string",
"nullable": true
},
"publisherCustomerId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/SubscriptionStatus"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
},
"orderId": {
"type": "string",
"nullable": true
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductReference"
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
},
"markup": {
"type": "number",
"format": "double"
},
"subscriptionTags": {
"$ref": "#/components/schemas/SubscriptionTags"
},
"termDuration": {
"type": "string",
"nullable": true
},
"autoRenewEnabled": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"Subscription": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"publisherSubscriptionId": {
"type": "string",
"nullable": true
},
"entitlementId": {
"type": "string",
"nullable": true
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
},
"customerTenant": {
"$ref": "#/components/schemas/CustomerTenantReference"
},
"product": {
"$ref": "#/components/schemas/ProductReference"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/SubscriptionStatus"
},
"provisionType": {
"$ref": "#/components/schemas/ProvisionType"
},
"availableAddonsCount": {
"type": "integer",
"format": "int32"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionAddOn"
},
"nullable": true
},
"orderId": {
"type": "string",
"nullable": true
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"billingCycle": {
"$ref": "#/components/schemas/BillingCycleEnum"
},
"markup": {
"type": "number",
"format": "double"
},
"isTrial": {
"type": "boolean"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"priceType": {
"$ref": "#/components/schemas/SubscriptionPriceType"
},
"salesPrice": {
"type": "number",
"format": "double"
},
"registeredForReservedInstance": {
"type": "boolean"
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"subscriptionTags": {
"$ref": "#/components/schemas/SubscriptionTags"
},
"acceptAutoSuspension": {
"type": "boolean",
"nullable": true
},
"autoSuspensionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"partNumber": {
"type": "string",
"nullable": true
},
"termDuration": {
"type": "string",
"nullable": true
},
"autoRenewEnabled": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"SubscriptionPricing": {
"type": "object",
"properties": {
"currencyCode": {
"type": "string",
"nullable": true
},
"purchasePrice": {
"type": "number",
"format": "double"
},
"recommendedRetailPrice": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"SubscriptionDetailed": {
"type": "object",
"properties": {
"effectiveStartDate": {
"type": "string",
"format": "date-time"
},
"commitmentEndDate": {
"type": "string",
"format": "date-time"
},
"suspensionReasons": {
"type": "string",
"nullable": true
},
"originalAgreementId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"pricing": {
"$ref": "#/components/schemas/SubscriptionPricing"
},
"attestationAccepted": {
"type": "boolean",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"publisherSubscriptionId": {
"type": "string",
"nullable": true
},
"entitlementId": {
"type": "string",
"nullable": true
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
},
"organization": {
"$ref": "#/components/schemas/ObjectReference"
},
"customerTenant": {
"$ref": "#/components/schemas/CustomerTenantReference"
},
"product": {
"$ref": "#/components/schemas/ProductReference"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/SubscriptionStatus"
},
"provisionType": {
"$ref": "#/components/schemas/ProvisionType"
},
"availableAddonsCount": {
"type": "integer",
"format": "int32"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionAddOn"
},
"nullable": true
},
"orderId": {
"type": "string",
"nullable": true
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"billingCycle": {
"$ref": "#/components/schemas/BillingCycleEnum"
},
"markup": {
"type": "number",
"format": "double"
},
"isTrial": {
"type": "boolean"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"priceType": {
"$ref": "#/components/schemas/SubscriptionPriceType"
},
"salesPrice": {
"type": "number",
"format": "double"
},
"registeredForReservedInstance": {
"type": "boolean"
},
"invoiceProfile": {
"$ref": "#/components/schemas/ObjectReference"
},
"subscriptionTags": {
"$ref": "#/components/schemas/SubscriptionTags"
},
"acceptAutoSuspension": {
"type": "boolean",
"nullable": true
},
"autoSuspensionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"partNumber": {
"type": "string",
"nullable": true
},
"termDuration": {
"type": "string",
"nullable": true
},
"autoRenewEnabled": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"SubscriptionConversion": {
"type": "object",
"properties": {
"billingCycle": {
"$ref": "#/components/schemas/BillingCycleEnum"
},
"offerId": {
"type": "string",
"nullable": true
},
"orderId": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
},
"targetOfferId": {
"type": "string",
"nullable": true
},
"productName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ActivationLink": {
"type": "object",
"properties": {
"subscriptionId": {
"type": "string",
"nullable": true
},
"uri": {
"type": "string",
"format": "uri",
"nullable": true
}
},
"additionalProperties": false
},
"SubscriptionTransitionError": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SubscriptionTransitionEligibilityDetail": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionTransitionError"
},
"nullable": true
},
"isEligible": {
"type": "boolean"
},
"transitionType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SubscriptionTransitionEligibility": {
"type": "object",
"properties": {
"catalogItemId": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
},
"eligibilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionTransitionEligibilityDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"SubscriptionTransition": {
"type": "object",
"properties": {
"toCatalogItemId": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
},
"transitionType": {
"type": "string",
"nullable": true
},
"billingCycle": {
"$ref": "#/components/schemas/BillingCycleEnum"
},
"term": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SubscriptionTransitionResponse": {
"type": "object",
"properties": {
"fromCatalogItemId": {
"type": "string",
"nullable": true
},
"toCatalogItemId": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
},
"transitionType": {
"type": "string",
"nullable": true
},
"billingCycle": {
"$ref": "#/components/schemas/BillingCycleEnum"
},
"term": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SubscriptionAddOnOffer": {
"type": "object",
"properties": {
"product": {
"$ref": "#/components/schemas/ProductReference"
},
"publisher": {
"$ref": "#/components/schemas/ObjectReference"
}
},
"additionalProperties": false
},
"PostSubscriptionAddOn": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"format": "int32"
},
"offerId": {
"type": "string",
"nullable": true
},
"subscriptionTags": {
"$ref": "#/components/schemas/SubscriptionTags"
}
},
"additionalProperties": false
},
"OrganizationUsageCost": {
"type": "object",
"properties": {
"supplier": {
"type": "string",
"nullable": true
},
"accountId": {
"type": "integer",
"format": "int32"
},
"accountName": {
"type": "string",
"nullable": true
},
"subscriptionName": {
"type": "string",
"nullable": true
},
"subscriptionId": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SubscriptionUsageCostRequest": {
"type": "object",
"properties": {
"resellerCustomerId": {
"type": "integer",
"format": "int32"
},
"subscriptionId": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"SubscriptionUsageCost": {
"type": "object",
"properties": {
"category": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CategoryUsageCostRequest": {
"type": "object",
"properties": {
"resellerCustomerId": {
"type": "integer",
"format": "int32"
},
"subscriptionId": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"CategoryUsageCost": {
"type": "object",
"properties": {
"subcategory": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SubcategoryUsageCostRequest": {
"type": "object",
"properties": {
"resellerCustomerId": {
"type": "integer",
"format": "int32"
},
"subscriptionId": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"subcategory": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"SubcategoryUsageCost": {
"type": "object",
"properties": {
"meter": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SubscriptionResourceGroupUsageCost": {
"type": "object",
"properties": {
"resourceGroup": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ResourceGroupUsageCostRequest": {
"type": "object",
"properties": {
"resellerCustomerId": {
"type": "integer",
"format": "int32"
},
"subscriptionId": {
"type": "string",
"nullable": true
},
"resourceGroup": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"ResourceGroupUsageCost": {
"type": "object",
"properties": {
"category": {
"type": "string",
"nullable": true
},
"subcategory": {
"type": "string",
"nullable": true
},
"meter": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UserRole": {
"enum": [0, 1, 2],
"type": "integer",
"format": "int32"
},
"User": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"emailConfirmed": {
"type": "boolean"
},
"lockoutEnabled": {
"type": "boolean"
},
"lockoutEnd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"phoneNumberConfirmed": {
"type": "boolean"
},
"twoFactorEnabled": {
"type": "boolean"
},
"tenantAdmin": {
"type": "boolean"
}
},
"additionalProperties": false
},
"UserChangePassword": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"nullable": true
},
"oldPassword": {
"type": "string",
"nullable": true
},
"newPassword": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"File": {
"type": "object",
"properties": {
"fileName": {
"type": "string",
"nullable": false
},
"data": {
"type": "string",
"nullable": false
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert \"Bearer {access token}\" below.",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": []
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment