Skip to content

Latest commit

 

History

History
145 lines (97 loc) · 3.97 KB

OrganizationApi.md

File metadata and controls

145 lines (97 loc) · 3.97 KB

swagger_client.OrganizationApi

All URIs are relative to /

Method HTTP request Description
api_v1_get_organization_by_name_get GET /api/v1/GetOrganizationByName
api_v1_get_organization_get GET /api/v1/GetOrganization
api_v1_get_organizations_get GET /api/v1/GetOrganizations

api_v1_get_organization_by_name_get

OrganizationResult api_v1_get_organization_by_name_get(name=name)

Example

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

# create an instance of the API class
api_instance = swagger_client.OrganizationApi()
name = 'name_example' # str |  (optional)

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

Parameters

Name Type Description Notes
name str [optional]

Return type

OrganizationResult

Authorization

No authorization required

HTTP request headers

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

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

api_v1_get_organization_get

OrganizationResult api_v1_get_organization_get(id=id)

Example

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

# create an instance of the API class
api_instance = swagger_client.OrganizationApi()
id = 'id_example' # str |  (optional)

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

Parameters

Name Type Description Notes
id str [optional]

Return type

OrganizationResult

Authorization

No authorization required

HTTP request headers

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

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

api_v1_get_organizations_get

list[OrganizationResult] api_v1_get_organizations_get(extended=extended)

Example

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

# create an instance of the API class
api_instance = swagger_client.OrganizationApi()
extended = false # bool |  (optional) (default to false)

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

Parameters

Name Type Description Notes
extended bool [optional] [default to false]

Return type

list[OrganizationResult]

Authorization

No authorization required

HTTP request headers

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

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