Skip to content

Latest commit

 

History

History
333 lines (226 loc) · 8.78 KB

SdkApi.md

File metadata and controls

333 lines (226 loc) · 8.78 KB
Raw

oort_sdk_client.SdkApi

All URIs are relative to http://localhost:2005/sdk/v1

Method HTTP request Description
command_adcs POST /adcs
get_adcs GET /adcs
get_tfrs GET /tfrs
query_available_files GET /query_available_files/{topic}
retrieve_file POST /retrieve_file
send_file POST /send_file

command_adcs

AdcsCommandResponse command_adcs(adcs_command_request)

request adcs operation

Example

from __future__ import print_function
import time
import oort_sdk_client
from oort_sdk_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with oort_sdk_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = oort_sdk_client.SdkApi(api_client)
    adcs_command_request = oort_sdk_client.AdcsCommandRequest() # AdcsCommandRequest | The file and parameters for sending

    try:
        api_response = api_instance.command_adcs(adcs_command_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SdkApi->command_adcs: %s\n" % e)

Parameters

Name Type Description Notes
adcs_command_request AdcsCommandRequest The file and parameters for sending

Return type

AdcsCommandResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 ERROR -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_adcs

AdcsResponse get_adcs()

query adcs status

Example

from __future__ import print_function
import time
import oort_sdk_client
from oort_sdk_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with oort_sdk_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = oort_sdk_client.SdkApi(api_client)
    
    try:
        api_response = api_instance.get_adcs()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SdkApi->get_adcs: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AdcsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_tfrs

TfrsResponse get_tfrs()

get tfrs values

Example

from __future__ import print_function
import time
import oort_sdk_client
from oort_sdk_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with oort_sdk_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = oort_sdk_client.SdkApi(api_client)
    
    try:
        api_response = api_instance.get_tfrs()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SdkApi->get_tfrs: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

TfrsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

query_available_files

AvailableFilesResponse query_available_files(topic)

Example

from __future__ import print_function
import time
import oort_sdk_client
from oort_sdk_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with oort_sdk_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = oort_sdk_client.SdkApi(api_client)
    topic = 'topic_example' # str | 

    try:
        api_response = api_instance.query_available_files(topic)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SdkApi->query_available_files: %s\n" % e)

Parameters

Name Type Description Notes
topic str

Return type

AvailableFilesResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_file

FileInfo retrieve_file(retrieve_file_request)

Example

from __future__ import print_function
import time
import oort_sdk_client
from oort_sdk_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with oort_sdk_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = oort_sdk_client.SdkApi(api_client)
    retrieve_file_request = oort_sdk_client.RetrieveFileRequest() # RetrieveFileRequest | 

    try:
        api_response = api_instance.retrieve_file(retrieve_file_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SdkApi->retrieve_file: %s\n" % e)

Parameters

Name Type Description Notes
retrieve_file_request RetrieveFileRequest

Return type

FileInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad request -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

send_file

SendFileResponse send_file(send_file_request)

Example

from __future__ import print_function
import time
import oort_sdk_client
from oort_sdk_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with oort_sdk_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = oort_sdk_client.SdkApi(api_client)
    send_file_request = oort_sdk_client.SendFileRequest() # SendFileRequest | The file and parameters for sending

    try:
        api_response = api_instance.send_file(send_file_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SdkApi->send_file: %s\n" % e)

Parameters

Name Type Description Notes
send_file_request SendFileRequest The file and parameters for sending

Return type

SendFileResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad request -

[Back to top] [Back to API list] [Back to Model list] [Back to README]