Get all deployments visible to the login user
Optional filtering values can be passed in the
query string. All values passed in the filter
are used as a logical conjunction (&&)
when determining which values to return.
curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/deploy?name[name]=&deployedBy=&projectIdentifier[groupIdentifier]=&projectIdentifier[artifactIdentifier]=&projectIdentifier[name]=&projectVersion[major]=&projectVersion[minor]=&projectVersion[patch]=&projectVersion[label]=&executionStatus=&trace=&executionResourceName[name]=&executionResourceName[type]="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeployApi;
import java.io.File;
import java.util.*;
public class DeployApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiTokenKey
ApiKeyAuth ApiTokenKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiTokenKey");
ApiTokenKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiTokenKey.setApiKeyPrefix("Token");
DeployApi apiInstance = new DeployApi();
String name[name] = name[name]_example; // String |
String projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; // String |
String projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; // String |
Integer projectVersion[major] = 56; // Integer |
Integer projectVersion[minor] = 56; // Integer |
Integer projectVersion[patch] = 56; // Integer |
String executionResourceName[name] = executionResourceName[name]_example; // String |
String executionResourceName[type] = executionResourceName[type]_example; // String |
String deployedBy = deployedBy_example; // String | deployed by user name
String projectIdentifier[name] = projectIdentifier[name]_example; // String |
String projectVersion[label] = projectVersion[label]_example; // String |
ExecutionStatus executionStatus = ; // ExecutionStatus | execution status
Trace trace = ; // Trace | trace status
try {
array[DeployContexts] result = apiInstance.getDeploys(name[name], projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier], projectVersion[major], projectVersion[minor], projectVersion[patch], executionResourceName[name], executionResourceName[type], deployedBy, projectIdentifier[name], projectVersion[label], executionStatus, trace);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeployApi#getDeploys");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DeployApi;
public class DeployApiExample {
public static void main(String[] args) {
DeployApi apiInstance = new DeployApi();
String name[name] = name[name]_example; // String |
String projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; // String |
String projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; // String |
Integer projectVersion[major] = 56; // Integer |
Integer projectVersion[minor] = 56; // Integer |
Integer projectVersion[patch] = 56; // Integer |
String executionResourceName[name] = executionResourceName[name]_example; // String |
String executionResourceName[type] = executionResourceName[type]_example; // String |
String deployedBy = deployedBy_example; // String | deployed by user name
String projectIdentifier[name] = projectIdentifier[name]_example; // String |
String projectVersion[label] = projectVersion[label]_example; // String |
ExecutionStatus executionStatus = ; // ExecutionStatus | execution status
Trace trace = ; // Trace | trace status
try {
array[DeployContexts] result = apiInstance.getDeploys(name[name], projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier], projectVersion[major], projectVersion[minor], projectVersion[patch], executionResourceName[name], executionResourceName[type], deployedBy, projectIdentifier[name], projectVersion[label], executionStatus, trace);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeployApi#getDeploys");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
String *name[name] = name[name]_example; //
String *projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; //
String *projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; //
Integer *projectVersion[major] = 56; //
Integer *projectVersion[minor] = 56; //
Integer *projectVersion[patch] = 56; //
String *executionResourceName[name] = executionResourceName[name]_example; //
String *executionResourceName[type] = executionResourceName[type]_example; //
String *deployedBy = deployedBy_example; // deployed by user name (optional)
String *projectIdentifier[name] = projectIdentifier[name]_example; // (optional)
String *projectVersion[label] = projectVersion[label]_example; // (optional)
ExecutionStatus *executionStatus = ; // execution status (optional)
Trace *trace = ; // trace status (optional)
DeployApi *apiInstance = [[DeployApi alloc] init];
// Get deployments
[apiInstance getDeploysWith:name[name]
projectIdentifier[groupIdentifier]:projectIdentifier[groupIdentifier]
projectIdentifier[artifactIdentifier]:projectIdentifier[artifactIdentifier]
projectVersion[major]:projectVersion[major]
projectVersion[minor]:projectVersion[minor]
projectVersion[patch]:projectVersion[patch]
executionResourceName[name]:executionResourceName[name]
executionResourceName[type]:executionResourceName[type]
deployedBy:deployedBy
projectIdentifier[name]:projectIdentifier[name]
projectVersion[label]:projectVersion[label]
executionStatus:executionStatus
trace:trace
completionHandler: ^(array[DeployContexts] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.ApiClient.instance;
// Configure API key authorization: ApiTokenKey
var ApiTokenKey = defaultClient.authentications['ApiTokenKey'];
ApiTokenKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiTokenKey.apiKeyPrefix['X-Streaming-Web-API-Token'] = "Token"
var api = new TibcoStreamingWebOpenApiSpecification.DeployApi()
var name[name] = name[name]_example; // {{String}}
var projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; // {{String}}
var projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; // {{String}}
var projectVersion[major] = 56; // {{Integer}}
var projectVersion[minor] = 56; // {{Integer}}
var projectVersion[patch] = 56; // {{Integer}}
var executionResourceName[name] = executionResourceName[name]_example; // {{String}}
var executionResourceName[type] = executionResourceName[type]_example; // {{String}}
var opts = {
'deployedBy': deployedBy_example, // {{String}} deployed by user name
'projectIdentifier[name]': projectIdentifier[name]_example, // {{String}}
'projectVersion[label]': projectVersion[label]_example, // {{String}}
'executionStatus': , // {{ExecutionStatus}} execution status
'trace': // {{Trace}} trace status
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getDeploys(name[name], projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier], projectVersion[major], projectVersion[minor], projectVersion[patch], executionResourceName[name], executionResourceName[type], opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getDeploysExample
{
public void main()
{
// Configure API key authorization: ApiTokenKey
Configuration.Default.ApiKey.Add("X-Streaming-Web-API-Token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("X-Streaming-Web-API-Token", "Bearer");
var apiInstance = new DeployApi();
var name[name] = name[name]_example; // String |
var projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; // String |
var projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; // String |
var projectVersion[major] = 56; // Integer |
var projectVersion[minor] = 56; // Integer |
var projectVersion[patch] = 56; // Integer |
var executionResourceName[name] = executionResourceName[name]_example; // String |
var executionResourceName[type] = executionResourceName[type]_example; // String |
var deployedBy = deployedBy_example; // String | deployed by user name (optional)
var projectIdentifier[name] = projectIdentifier[name]_example; // String | (optional)
var projectVersion[label] = projectVersion[label]_example; // String | (optional)
var executionStatus = new ExecutionStatus(); // ExecutionStatus | execution status (optional)
var trace = new Trace(); // Trace | trace status (optional)
try
{
// Get deployments
array[DeployContexts] result = apiInstance.getDeploys(name[name], projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier], projectVersion[major], projectVersion[minor], projectVersion[patch], executionResourceName[name], executionResourceName[type], deployedBy, projectIdentifier[name], projectVersion[label], executionStatus, trace);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeployApi.getDeploys: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Streaming-Web-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Streaming-Web-API-Token', 'Bearer');
$api_instance = new Swagger\Client\ApiDeployApi();
$name[name] = name[name]_example; // String |
$projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; // String |
$projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; // String |
$projectVersion[major] = 56; // Integer |
$projectVersion[minor] = 56; // Integer |
$projectVersion[patch] = 56; // Integer |
$executionResourceName[name] = executionResourceName[name]_example; // String |
$executionResourceName[type] = executionResourceName[type]_example; // String |
$deployedBy = deployedBy_example; // String | deployed by user name
$projectIdentifier[name] = projectIdentifier[name]_example; // String |
$projectVersion[label] = projectVersion[label]_example; // String |
$executionStatus = ; // ExecutionStatus | execution status
$trace = ; // Trace | trace status
try {
$result = $api_instance->getDeploys($name[name], $projectIdentifier[groupIdentifier], $projectIdentifier[artifactIdentifier], $projectVersion[major], $projectVersion[minor], $projectVersion[patch], $executionResourceName[name], $executionResourceName[type], $deployedBy, $projectIdentifier[name], $projectVersion[label], $executionStatus, $trace);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeployApi->getDeploys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeployApi;
# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-API-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Streaming-Web-API-Token'} = "Bearer";
my $api_instance = WWW::SwaggerClient::DeployApi->new();
my $name[name] = name[name]_example; # String |
my $projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; # String |
my $projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; # String |
my $projectVersion[major] = 56; # Integer |
my $projectVersion[minor] = 56; # Integer |
my $projectVersion[patch] = 56; # Integer |
my $executionResourceName[name] = executionResourceName[name]_example; # String |
my $executionResourceName[type] = executionResourceName[type]_example; # String |
my $deployedBy = deployedBy_example; # String | deployed by user name
my $projectIdentifier[name] = projectIdentifier[name]_example; # String |
my $projectVersion[label] = projectVersion[label]_example; # String |
my $executionStatus = ; # ExecutionStatus | execution status
my $trace = ; # Trace | trace status
eval {
my $result = $api_instance->getDeploys(name[name] => $name[name], projectIdentifier[groupIdentifier] => $projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier] => $projectIdentifier[artifactIdentifier], projectVersion[major] => $projectVersion[major], projectVersion[minor] => $projectVersion[minor], projectVersion[patch] => $projectVersion[patch], executionResourceName[name] => $executionResourceName[name], executionResourceName[type] => $executionResourceName[type], deployedBy => $deployedBy, projectIdentifier[name] => $projectIdentifier[name], projectVersion[label] => $projectVersion[label], executionStatus => $executionStatus, trace => $trace);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeployApi->getDeploys: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiTokenKey
swagger_client.configuration.api_key['X-Streaming-Web-API-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Streaming-Web-API-Token'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.DeployApi()
name[name] = name[name]_example # String |
projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example # String |
projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example # String |
projectVersion[major] = 56 # Integer |
projectVersion[minor] = 56 # Integer |
projectVersion[patch] = 56 # Integer |
executionResourceName[name] = executionResourceName[name]_example # String |
executionResourceName[type] = executionResourceName[type]_example # String |
deployedBy = deployedBy_example # String | deployed by user name (optional)
projectIdentifier[name] = projectIdentifier[name]_example # String | (optional)
projectVersion[label] = projectVersion[label]_example # String | (optional)
executionStatus = # ExecutionStatus | execution status (optional)
trace = # Trace | trace status (optional)
try:
# Get deployments
api_response = api_instance.get_deploys(name[name], projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier], projectVersion[major], projectVersion[minor], projectVersion[patch], executionResourceName[name], executionResourceName[type], deployedBy=deployedBy, projectIdentifier[name]=projectIdentifier[name], projectVersion[label]=projectVersion[label], executionStatus=executionStatus, trace=trace)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeployApi->getDeploys: %s\n" % e)