Skip to content

DataAccessSectionApi.md

Latest commit

 

History

History
338 lines (234 loc) · 11 KB

DataAccessSectionApi.md

File metadata and controls

338 lines (234 loc) · 11 KB
Raw

gateway_api_sdk.DataAccessSectionApi

All URIs are relative to http://localhost

Method HTTP request Description
create_dar_section POST /api/v1/dar/sections DataAccessSection@store
delete_dar_section DELETE /api/v1/dar/sections/{id} DataAccessSection@destroy
patch_dar_section PATCH /api/v1/dar/sections/{id} DataAccessSection@update
update_dar_section PUT /api/v1/dar/sections/{id} DataAccessSection@update

create_dar_section

CreateDarIntegration201Response create_dar_section(create_dar_section_request)

DataAccessSection@store

Creates a new DAR section

Example

  • Bearer (JWT) Authentication (bearerAuth):
import gateway_api_sdk
from gateway_api_sdk.models.create_dar_integration201_response import CreateDarIntegration201Response
from gateway_api_sdk.models.create_dar_section_request import CreateDarSectionRequest
from gateway_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gateway_api_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = gateway_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with gateway_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gateway_api_sdk.DataAccessSectionApi(api_client)
    create_dar_section_request = gateway_api_sdk.CreateDarSectionRequest() # CreateDarSectionRequest | DataAccessSection definition

    try:
        # DataAccessSection@store
        api_response = api_instance.create_dar_section(create_dar_section_request)
        print("The response of DataAccessSectionApi->create_dar_section:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataAccessSectionApi->create_dar_section: %s\n" % e)

Parameters

Name Type Description Notes
create_dar_section_request CreateDarSectionRequest DataAccessSection definition

Return type

CreateDarIntegration201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
500 Error -

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

delete_dar_section

DeleteApplications200Response delete_dar_section(id)

DataAccessSection@destroy

Delete a system DAR section

Example

  • Bearer (JWT) Authentication (bearerAuth):
import gateway_api_sdk
from gateway_api_sdk.models.delete_applications200_response import DeleteApplications200Response
from gateway_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gateway_api_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = gateway_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with gateway_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gateway_api_sdk.DataAccessSectionApi(api_client)
    id = 1 # int | DAR section id

    try:
        # DataAccessSection@destroy
        api_response = api_instance.delete_dar_section(id)
        print("The response of DataAccessSectionApi->delete_dar_section:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataAccessSectionApi->delete_dar_section: %s\n" % e)

Parameters

Name Type Description Notes
id int DAR section id

Return type

DeleteApplications200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
404 Not found response -
200 Success -
500 Error -

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

patch_dar_section

UpdateDarSection200Response patch_dar_section(id, patch_dar_section_request)

DataAccessSection@update

Edit a system DAR section

Example

  • Bearer (JWT) Authentication (bearerAuth):
import gateway_api_sdk
from gateway_api_sdk.models.patch_dar_section_request import PatchDarSectionRequest
from gateway_api_sdk.models.update_dar_section200_response import UpdateDarSection200Response
from gateway_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gateway_api_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = gateway_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with gateway_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gateway_api_sdk.DataAccessSectionApi(api_client)
    id = 1 # int | DAR section id
    patch_dar_section_request = gateway_api_sdk.PatchDarSectionRequest() # PatchDarSectionRequest | DataAccessSection definition

    try:
        # DataAccessSection@update
        api_response = api_instance.patch_dar_section(id, patch_dar_section_request)
        print("The response of DataAccessSectionApi->patch_dar_section:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataAccessSectionApi->patch_dar_section: %s\n" % e)

Parameters

Name Type Description Notes
id int DAR section id
patch_dar_section_request PatchDarSectionRequest DataAccessSection definition

Return type

UpdateDarSection200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
404 Not found response -
200 Success -
500 Error -

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

update_dar_section

UpdateDarSection200Response update_dar_section(id, create_dar_section_request)

DataAccessSection@update

Update a system DAR section

Example

  • Bearer (JWT) Authentication (bearerAuth):
import gateway_api_sdk
from gateway_api_sdk.models.create_dar_section_request import CreateDarSectionRequest
from gateway_api_sdk.models.update_dar_section200_response import UpdateDarSection200Response
from gateway_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gateway_api_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = gateway_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with gateway_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gateway_api_sdk.DataAccessSectionApi(api_client)
    id = 1 # int | DAR section id
    create_dar_section_request = gateway_api_sdk.CreateDarSectionRequest() # CreateDarSectionRequest | DataAccessSection definition

    try:
        # DataAccessSection@update
        api_response = api_instance.update_dar_section(id, create_dar_section_request)
        print("The response of DataAccessSectionApi->update_dar_section:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataAccessSectionApi->update_dar_section: %s\n" % e)

Parameters

Name Type Description Notes
id int DAR section id
create_dar_section_request CreateDarSectionRequest DataAccessSection definition

Return type

UpdateDarSection200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
404 Not found response -
200 Success -
500 Error -

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