Releases

All PUT endpoints update only the fields present in the body; see Updating Resources.

GET`/v1/products/{productId}/releases`GET /v1/products/{productId}/releases

Code samples

cURL


# You can also use wget
curl -X GET /v1/products/{productId}/releases \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/products/{productId}/releases";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/products/\{productId\}/releases

Gets the product releases based on the provided request.

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


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


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

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetProductReleasesResponse

Authentication: API key (x-api-key).

POST`/v1/products/{productId}/releases`POST /v1/products/{productId}/releases

Code samples

cURL


# You can also use wget
curl -X POST /v1/products/{productId}/releases \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "release": {
    "id": 0,
    "releaseDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "version": "string",
    "description": "string",
    "public": true,
    "requiresMaintenance": true,
    "releaseNotes": "string",
    "channel": "stable"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/products/{productId}/releases";
      
      string json = @"{
  ""release"": {
    ""id"": 0,
    ""releaseDate"": ""2019-08-24T14:15:22Z"",
    ""name"": ""string"",
    ""version"": ""string"",
    ""description"": ""string"",
    ""public"": true,
    ""requiresMaintenance"": true,
    ""releaseNotes"": ""string"",
    ""channel"": ""stable""
  }
}";
      Management.InsertProductReleaseRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertProductReleaseRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertProductReleaseRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/products/\{productId\}/releases

Inserts a new product release.

When requiresMaintenance is omitted, the release requires active maintenance (true). Set it to false explicitly for a release that must be available without maintenance. For an application product, the service rejects requiresMaintenance=false unless Updates:AllowPublicApplicationReleases is enabled in the service configuration.

Body parameter


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

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
body	body	Management.InsertProductReleaseRequest	false	The request containing the product release to insert.

Example responses

200 Response


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


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

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertProductReleaseResponse

Authentication: API key (x-api-key).

PUT`/v1/products/{productId}/releases`PUT /v1/products/{productId}/releases

Code samples

cURL


# You can also use wget
curl -X PUT /v1/products/{productId}/releases \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "release": {
    "id": 0,
    "releaseDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "version": "string",
    "description": "string",
    "public": true,
    "requiresMaintenance": true,
    "releaseNotes": "string",
    "channel": "stable"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/products/{productId}/releases";
 
      
      string json = @"{
  ""release"": {
    ""id"": 0,
    ""releaseDate"": ""2019-08-24T14:15:22Z"",
    ""name"": ""string"",
    ""version"": ""string"",
    ""description"": ""string"",
    ""public"": true,
    ""requiresMaintenance"": true,
    ""releaseNotes"": ""string"",
    ""channel"": ""stable""
  }
}";
      Management.UpdateProductReleaseRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateProductReleaseRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateProductReleaseRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/products/\{productId\}/releases

Updates an existing product release.

Fields omitted from the body keep their stored values; see Updating Resources.

Body parameter


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

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
body	body	Management.UpdateProductReleaseRequest	false	The request containing the product release to update.

Example responses

200 Response


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


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

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateProductReleaseResponse

Authentication: API key (x-api-key).

DELETE`/v1/products/{productId}/releases/{releaseId}`DELETE /v1/products/{productId}/releases/{releaseId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/products/{productId}/releases/{releaseId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases/{releaseId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/products/{productId}/releases/{releaseId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/products/\{productId\}/releases/\{releaseId\}

Deletes an existing product release.

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
releaseId	path	integer(int32)	true	The release ID.

Example responses

200 Response


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


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

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteProductReleaseResponse

Authentication: API key (x-api-key).

Releases

GET/v1/products/{productId}/releasesGET /v1/products/{productId}/releases

Code samples

cURL

JavaScript

C#

Parameters

Responses

POST/v1/products/{productId}/releasesPOST /v1/products/{productId}/releases

Code samples

cURL

JavaScript

C#

Parameters

Responses

PUT/v1/products/{productId}/releasesPUT /v1/products/{productId}/releases

Code samples

cURL

JavaScript

C#

Parameters

Responses

DELETE/v1/products/{productId}/releases/{releaseId}DELETE /v1/products/{productId}/releases/{releaseId}

Code samples

cURL

JavaScript

C#

Parameters

Responses

GET`/v1/products/{productId}/releases`GET /v1/products/{productId}/releases

POST`/v1/products/{productId}/releases`POST /v1/products/{productId}/releases

PUT`/v1/products/{productId}/releases`PUT /v1/products/{productId}/releases

DELETE`/v1/products/{productId}/releases/{releaseId}`DELETE /v1/products/{productId}/releases/{releaseId}