Skip to content

TeamDataAccessApplicationApi.md

Latest commit

 

History

History
329 lines (225 loc) · 11 KB

TeamDataAccessApplicationApi.md

File metadata and controls

329 lines (225 loc) · 11 KB
Raw

gateway_api_sdk.TeamDataAccessApplicationApi

All URIs are relative to http://localhost

Method HTTP request Description
count_team_dar_applications GET /api/v1/teams/{teamId}/dar/applications/count TeamDataAccessApplicationController@allCounts
count_unique_fields_dar_applications GET /api/v1/teams/{teamId}/dar/applications/count/{field} TeamDataAccessApplicationController@count
fetch_team_dar_application GET /api/v1/teams/{teamId}/dar/applications/{id} TeamDataAccessApplicationController@show
fetch_team_dar_applications GET /api/v1/teams/{teamId}/dar/applications TeamDataAccessApplicationController@index

count_team_dar_applications

CountUniqueFieldsCollections200Response count_team_dar_applications(team_id)

TeamDataAccessApplicationController@allCounts

Get Counts for all status fields in the model

Example

  • Bearer (JWT) Authentication (bearerAuth):
import gateway_api_sdk
from gateway_api_sdk.models.count_unique_fields_collections200_response import CountUniqueFieldsCollections200Response
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.TeamDataAccessApplicationApi(api_client)
    team_id = 1 # int | Team id

    try:
        # TeamDataAccessApplicationController@allCounts
        api_response = api_instance.count_team_dar_applications(team_id)
        print("The response of TeamDataAccessApplicationApi->count_team_dar_applications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TeamDataAccessApplicationApi->count_team_dar_applications: %s\n" % e)

Parameters

Name Type Description Notes
team_id int Team id

Return type

CountUniqueFieldsCollections200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success response -

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

count_unique_fields_dar_applications

CountUniqueFieldsCollections200Response count_unique_fields_dar_applications(team_id, var_field)

TeamDataAccessApplicationController@count

Get Counts for distinct entries of a field in the model

Example

  • Bearer (JWT) Authentication (bearerAuth):
import gateway_api_sdk
from gateway_api_sdk.models.count_unique_fields_collections200_response import CountUniqueFieldsCollections200Response
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.TeamDataAccessApplicationApi(api_client)
    team_id = 1 # int | Team id
    var_field = 'approval_status' # str | name of the field to perform a count on

    try:
        # TeamDataAccessApplicationController@count
        api_response = api_instance.count_unique_fields_dar_applications(team_id, var_field)
        print("The response of TeamDataAccessApplicationApi->count_unique_fields_dar_applications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TeamDataAccessApplicationApi->count_unique_fields_dar_applications: %s\n" % e)

Parameters

Name Type Description Notes
team_id int Team id
var_field str name of the field to perform a count on

Return type

CountUniqueFieldsCollections200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success response -

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

fetch_team_dar_application

FetchTeamDarApplication200Response fetch_team_dar_application(team_id, id)

TeamDataAccessApplicationController@show

Return a single DAR application

Example

  • Bearer (JWT) Authentication (bearerAuth):
import gateway_api_sdk
from gateway_api_sdk.models.fetch_team_dar_application200_response import FetchTeamDarApplication200Response
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.TeamDataAccessApplicationApi(api_client)
    team_id = 1 # int | Team id
    id = 1 # int | DAR application id

    try:
        # TeamDataAccessApplicationController@show
        api_response = api_instance.fetch_team_dar_application(team_id, id)
        print("The response of TeamDataAccessApplicationApi->fetch_team_dar_application:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TeamDataAccessApplicationApi->fetch_team_dar_application: %s\n" % e)

Parameters

Name Type Description Notes
team_id int Team id
id int DAR application id

Return type

FetchTeamDarApplication200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

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

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

fetch_team_dar_applications

FetchTeamDarApplications200Response fetch_team_dar_applications(team_id)

TeamDataAccessApplicationController@index

List of dar applications belonging to a team

Example

  • Bearer (JWT) Authentication (bearerAuth):
import gateway_api_sdk
from gateway_api_sdk.models.fetch_team_dar_applications200_response import FetchTeamDarApplications200Response
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.TeamDataAccessApplicationApi(api_client)
    team_id = 1 # int | Team id

    try:
        # TeamDataAccessApplicationController@index
        api_response = api_instance.fetch_team_dar_applications(team_id)
        print("The response of TeamDataAccessApplicationApi->fetch_team_dar_applications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TeamDataAccessApplicationApi->fetch_team_dar_applications: %s\n" % e)

Parameters

Name Type Description Notes
team_id int Team id

Return type

FetchTeamDarApplications200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -

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