apiJobsList
SatNOGS Network Job API view class
/api/jobs/
Usage and SDK Samples
curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"http://localhost/api/jobs/?end=&ground_station=&id=&satellite__norad_cat_id=&start=&status=&transmitter_mode=&transmitter_type=&transmitter_uuid=&vetted_status=&vetted_user=&waterfall_status="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;
import java.io.File;
import java.util.*;
public class ApiApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: tokenAuth
ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
tokenAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.setApiKeyPrefix("Token");
// Create an instance of the API class
ApiApi apiInstance = new ApiApi();
Date end = 2013-10-20T19:20:30+01:00; // Date |
Integer groundStation = 56; // Integer |
Integer id = 56; // Integer |
Integer satelliteNoradCatId = 56; // Integer |
Date start = 2013-10-20T19:20:30+01:00; // Date |
String status = status_example; // String |
String transmitterMode = transmitterMode_example; // String |
String transmitterType = transmitterType_example; // String |
String transmitterUuid = transmitterUuid_example; // String |
String vettedStatus = vettedStatus_example; // String | Vetted status (deprecated: please use Status)
Integer vettedUser = 56; // Integer | Vetted user (deprecated: will be removed in next version)
Boolean waterfallStatus = true; // Boolean |
try {
array[Job] result = apiInstance.apiJobsList(end, groundStation, id, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ApiApi#apiJobsList");
e.printStackTrace();
}
}
}
import org.openapitools.client.api.ApiApi;
public class ApiApiExample {
public static void main(String[] args) {
ApiApi apiInstance = new ApiApi();
Date end = 2013-10-20T19:20:30+01:00; // Date |
Integer groundStation = 56; // Integer |
Integer id = 56; // Integer |
Integer satelliteNoradCatId = 56; // Integer |
Date start = 2013-10-20T19:20:30+01:00; // Date |
String status = status_example; // String |
String transmitterMode = transmitterMode_example; // String |
String transmitterType = transmitterType_example; // String |
String transmitterUuid = transmitterUuid_example; // String |
String vettedStatus = vettedStatus_example; // String | Vetted status (deprecated: please use Status)
Integer vettedUser = 56; // Integer | Vetted user (deprecated: will be removed in next version)
Boolean waterfallStatus = true; // Boolean |
try {
array[Job] result = apiInstance.apiJobsList(end, groundStation, id, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ApiApi#apiJobsList");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
Date *end = 2013-10-20T19:20:30+01:00; // (optional) (default to null)
Integer *groundStation = 56; // (optional) (default to null)
Integer *id = 56; // (optional) (default to null)
Integer *satelliteNoradCatId = 56; // (optional) (default to null)
Date *start = 2013-10-20T19:20:30+01:00; // (optional) (default to null)
String *status = status_example; // (optional) (default to null)
String *transmitterMode = transmitterMode_example; // (optional) (default to null)
String *transmitterType = transmitterType_example; // (optional) (default to null)
String *transmitterUuid = transmitterUuid_example; // (optional) (default to null)
String *vettedStatus = vettedStatus_example; // Vetted status (deprecated: please use Status) (optional) (default to null)
Integer *vettedUser = 56; // Vetted user (deprecated: will be removed in next version) (optional) (default to null)
Boolean *waterfallStatus = true; // (optional) (default to null)
[apiInstance apiJobsListWith:end
groundStation:groundStation
id:id
satelliteNoradCatId:satelliteNoradCatId
start:start
status:status
transmitterMode:transmitterMode
transmitterType:transmitterType
transmitterUuid:transmitterUuid
vettedStatus:vettedStatus
vettedUser:vettedUser
waterfallStatus:waterfallStatus
completionHandler: ^(array[Job] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;
// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";
// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var opts = {
'end': 2013-10-20T19:20:30+01:00, // {Date}
'groundStation': 56, // {Integer}
'id': 56, // {Integer}
'satelliteNoradCatId': 56, // {Integer}
'start': 2013-10-20T19:20:30+01:00, // {Date}
'status': status_example, // {String}
'transmitterMode': transmitterMode_example, // {String}
'transmitterType': transmitterType_example, // {String}
'transmitterUuid': transmitterUuid_example, // {String}
'vettedStatus': vettedStatus_example, // {String} Vetted status (deprecated: please use Status)
'vettedUser': 56, // {Integer} Vetted user (deprecated: will be removed in next version)
'waterfallStatus': true // {Boolean}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.apiJobsList(opts, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;
namespace Example
{
public class apiJobsListExample
{
public void main()
{
// Configure API key authorization: tokenAuth
Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
// Create an instance of the API class
var apiInstance = new ApiApi();
var end = 2013-10-20T19:20:30+01:00; // Date | (optional) (default to null)
var groundStation = 56; // Integer | (optional) (default to null)
var id = 56; // Integer | (optional) (default to null)
var satelliteNoradCatId = 56; // Integer | (optional) (default to null)
var start = 2013-10-20T19:20:30+01:00; // Date | (optional) (default to null)
var status = status_example; // String | (optional) (default to null)
var transmitterMode = transmitterMode_example; // String | (optional) (default to null)
var transmitterType = transmitterType_example; // String | (optional) (default to null)
var transmitterUuid = transmitterUuid_example; // String | (optional) (default to null)
var vettedStatus = vettedStatus_example; // String | Vetted status (deprecated: please use Status) (optional) (default to null)
var vettedUser = 56; // Integer | Vetted user (deprecated: will be removed in next version) (optional) (default to null)
var waterfallStatus = true; // Boolean | (optional) (default to null)
try {
array[Job] result = apiInstance.apiJobsList(end, groundStation, id, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ApiApi.apiJobsList: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$end = 2013-10-20T19:20:30+01:00; // Date |
$groundStation = 56; // Integer |
$id = 56; // Integer |
$satelliteNoradCatId = 56; // Integer |
$start = 2013-10-20T19:20:30+01:00; // Date |
$status = status_example; // String |
$transmitterMode = transmitterMode_example; // String |
$transmitterType = transmitterType_example; // String |
$transmitterUuid = transmitterUuid_example; // String |
$vettedStatus = vettedStatus_example; // String | Vetted status (deprecated: please use Status)
$vettedUser = 56; // Integer | Vetted user (deprecated: will be removed in next version)
$waterfallStatus = true; // Boolean |
try {
$result = $api_instance->apiJobsList($end, $groundStation, $id, $satelliteNoradCatId, $start, $status, $transmitterMode, $transmitterType, $transmitterUuid, $vettedStatus, $vettedUser, $waterfallStatus);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ApiApi->apiJobsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;
# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $end = 2013-10-20T19:20:30+01:00; # Date |
my $groundStation = 56; # Integer |
my $id = 56; # Integer |
my $satelliteNoradCatId = 56; # Integer |
my $start = 2013-10-20T19:20:30+01:00; # Date |
my $status = status_example; # String |
my $transmitterMode = transmitterMode_example; # String |
my $transmitterType = transmitterType_example; # String |
my $transmitterUuid = transmitterUuid_example; # String |
my $vettedStatus = vettedStatus_example; # String | Vetted status (deprecated: please use Status)
my $vettedUser = 56; # Integer | Vetted user (deprecated: will be removed in next version)
my $waterfallStatus = true; # Boolean |
eval {
my $result = $api_instance->apiJobsList(end => $end, groundStation => $groundStation, id => $id, satelliteNoradCatId => $satelliteNoradCatId, start => $start, status => $status, transmitterMode => $transmitterMode, transmitterType => $transmitterType, transmitterUuid => $transmitterUuid, vettedStatus => $vettedStatus, vettedUser => $vettedUser, waterfallStatus => $waterfallStatus);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ApiApi->apiJobsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
# Create an instance of the API class
api_instance = openapi_client.ApiApi()
end = 2013-10-20T19:20:30+01:00 # Date | (optional) (default to null)
groundStation = 56 # Integer | (optional) (default to null)
id = 56 # Integer | (optional) (default to null)
satelliteNoradCatId = 56 # Integer | (optional) (default to null)
start = 2013-10-20T19:20:30+01:00 # Date | (optional) (default to null)
status = status_example # String | (optional) (default to null)
transmitterMode = transmitterMode_example # String | (optional) (default to null)
transmitterType = transmitterType_example # String | (optional) (default to null)
transmitterUuid = transmitterUuid_example # String | (optional) (default to null)
vettedStatus = vettedStatus_example # String | Vetted status (deprecated: please use Status) (optional) (default to null)
vettedUser = 56 # Integer | Vetted user (deprecated: will be removed in next version) (optional) (default to null)
waterfallStatus = true # Boolean | (optional) (default to null)
try:
api_response = api_instance.api_jobs_list(end=end, groundStation=groundStation, id=id, satelliteNoradCatId=satelliteNoradCatId, start=start, status=status, transmitterMode=transmitterMode, transmitterType=transmitterType, transmitterUuid=transmitterUuid, vettedStatus=vettedStatus, vettedUser=vettedUser, waterfallStatus=waterfallStatus)
pprint(api_response)
except ApiException as e:
print("Exception when calling ApiApi->apiJobsList: %s\n" % e)
extern crate ApiApi;
pub fn main() {
let end = 2013-10-20T19:20:30+01:00; // Date
let groundStation = 56; // Integer
let id = 56; // Integer
let satelliteNoradCatId = 56; // Integer
let start = 2013-10-20T19:20:30+01:00; // Date
let status = status_example; // String
let transmitterMode = transmitterMode_example; // String
let transmitterType = transmitterType_example; // String
let transmitterUuid = transmitterUuid_example; // String
let vettedStatus = vettedStatus_example; // String
let vettedUser = 56; // Integer
let waterfallStatus = true; // Boolean
let mut context = ApiApi::Context::default();
let result = client.apiJobsList(end, groundStation, id, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus, &context).wait();
println!("{:?}", result);
}
Scopes
Parameters
Name | Description |
---|---|
end |
Date
(date-time)
|
ground_station |
Integer
|
id |
Integer
|
satellite__norad_cat_id |
Integer
|
start |
Date
(date-time)
|
status |
String
|
transmitter_mode |
String
|
transmitter_type |
String
|
transmitter_uuid |
String
|
vetted_status |
String
Vetted status (deprecated: please use Status)
|
vetted_user |
Integer
Vetted user (deprecated: will be removed in next version)
|
waterfall_status |
Boolean
|