gateway_api_sdk.DataUseRegistersApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_dur	POST /api/v1/dur	DurController@store
create_dur_by_team_v2	POST /api/v2/teams/{teamId}/dur	TeamDurController@store
delete_dur	DELETE /api/v1/dur/{id}	Delete a dur
delete_durs_v2_by_team_id	DELETE /api/v2/teams/{teamId}/dur/{id}	TeamDurController@destroy
edit_dur	PATCH /api/v1/dur/{id}	Edit a dur
edit_durs_v2_by_team_id	PATCH /api/v2/teams/{teamId}/dur/{id}	TeamDurController@edit
export_dur_template	GET /api/v1/dur/template	DurController@exportTemplate
export_dur_template_v2	GET /api/v2/dur/template	DurController@exportTemplate
export_dur_v2	GET /api/v2/dur/export	DurController@export
fetch_all_dur	GET /api/v1/dur	DurController@index
fetch_all_dur_v2	GET /api/v2/dur	DurController@indexActive
fetch_dur_by_id	GET /api/v1/dur/{id}	DurController@show
fetch_dur_by_id_v2	GET /api/v2/dur/{id}	DurController@showActive
update_dur	PUT /api/v1/dur/{id}	Update a dur by id
update_dur_v2_by_team_id	PUT /api/v2/teams/{teamId}/dur/{id}	TeamDurController@update
upload_dur	POST /api/v1/dur/upload	DurController@upload

create_dur

CreateDarIntegration201Response create_dur(create_dur_request)

DurController@store

Create a new dur

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_dur_request import CreateDurRequest
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.DataUseRegistersApi(api_client)
    create_dur_request = gateway_api_sdk.CreateDurRequest() # CreateDurRequest | Pass user credentials

    try:
        # DurController@store
        api_response = api_instance.create_dur(create_dur_request)
        print("The response of DataUseRegistersApi->create_dur:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->create_dur: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_dur_request	CreateDurRequest	Pass user credentials

Return type

CreateDarIntegration201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
401	Unauthorized	-
500	Error	-

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

create_dur_by_team_v2

CreateDarIntegration201Response create_dur_by_team_v2(team_id, create_dur_request)

TeamDurController@store

Create a new dur by team v2

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_dur_request import CreateDurRequest
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.DataUseRegistersApi(api_client)
    team_id = 1 # int | team id
    create_dur_request = gateway_api_sdk.CreateDurRequest() # CreateDurRequest | Pass user credentials

    try:
        # TeamDurController@store
        api_response = api_instance.create_dur_by_team_v2(team_id, create_dur_request)
        print("The response of DataUseRegistersApi->create_dur_by_team_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->create_dur_by_team_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
team_id	int	team id
create_dur_request	CreateDurRequest	Pass user credentials

Return type

CreateDarIntegration201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
401	Unauthorized	-
500	Error	-

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

delete_dur

DeleteApplications200Response delete_dur(id)

Delete a dur

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.DataUseRegistersApi(api_client)
    id = 1 # int | dur id

    try:
        # Delete a dur
        api_response = api_instance.delete_dur(id)
        print("The response of DataUseRegistersApi->delete_dur:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->delete_dur: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	dur 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]

delete_durs_v2_by_team_id

DeleteApplications200Response delete_durs_v2_by_team_id(team_id, id)

TeamDurController@destroy

Delete a dur by team and id v2

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.DataUseRegistersApi(api_client)
    team_id = 1 # int | team id
    id = 1 # int | dur id

    try:
        # TeamDurController@destroy
        api_response = api_instance.delete_durs_v2_by_team_id(team_id, id)
        print("The response of DataUseRegistersApi->delete_durs_v2_by_team_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->delete_durs_v2_by_team_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
team_id	int	team id
id	int	dur 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]

edit_dur

UpdateDur200Response edit_dur(id, create_dur_request, unarchive=unarchive)

Edit a dur

Example

Bearer (JWT) Authentication (bearerAuth):

import gateway_api_sdk
from gateway_api_sdk.models.create_dur_request import CreateDurRequest
from gateway_api_sdk.models.update_dur200_response import UpdateDur200Response
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.DataUseRegistersApi(api_client)
    id = 1 # int | dur id
    create_dur_request = gateway_api_sdk.CreateDurRequest() # CreateDurRequest | Pass user credentials
    unarchive = 'unarchive_example' # str | Unarchive a dur (optional)

    try:
        # Edit a dur
        api_response = api_instance.edit_dur(id, create_dur_request, unarchive=unarchive)
        print("The response of DataUseRegistersApi->edit_dur:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->edit_dur: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	dur id
create_dur_request	CreateDurRequest	Pass user credentials
unarchive	str	Unarchive a dur	[optional]

Return type

UpdateDur200Response

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]

edit_durs_v2_by_team_id

UpdateDur200Response edit_durs_v2_by_team_id(team_id, id, create_dur_request)

TeamDurController@edit

Edit a dur by team v2

Example

Bearer (JWT) Authentication (bearerAuth):

import gateway_api_sdk
from gateway_api_sdk.models.create_dur_request import CreateDurRequest
from gateway_api_sdk.models.update_dur200_response import UpdateDur200Response
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.DataUseRegistersApi(api_client)
    team_id = 1 # int | team id
    id = 1 # int | dur id
    create_dur_request = gateway_api_sdk.CreateDurRequest() # CreateDurRequest | Pass user credentials

    try:
        # TeamDurController@edit
        api_response = api_instance.edit_durs_v2_by_team_id(team_id, id, create_dur_request)
        print("The response of DataUseRegistersApi->edit_durs_v2_by_team_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->edit_durs_v2_by_team_id: %s\n" % e)

Parameters

Name	Type	Description
team_id	int	team id
id	int	dur id
create_dur_request	CreateDurRequest	Pass user credentials

Return type

UpdateDur200Response

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]

export_dur_template

object export_dur_template()

DurController@exportTemplate

Export Dur upload template

Example

Bearer (JWT) Authentication (bearerAuth):

import gateway_api_sdk
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.DataUseRegistersApi(api_client)

    try:
        # DurController@exportTemplate
        api_response = api_instance.export_dur_template()
        print("The response of DataUseRegistersApi->export_dur_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->export_dur_template: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: text/csv, application/json

HTTP response details

Status code	Description	Response headers
200	File download	-
401	Unauthorized	-
404	File Not Found	-

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

export_dur_template_v2

object export_dur_template_v2()

DurController@exportTemplate

Export Dur upload template

Example

Bearer (JWT) Authentication (bearerAuth):

import gateway_api_sdk
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.DataUseRegistersApi(api_client)

    try:
        # DurController@exportTemplate
        api_response = api_instance.export_dur_template_v2()
        print("The response of DataUseRegistersApi->export_dur_template_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->export_dur_template_v2: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: text/csv, application/json

HTTP response details

Status code	Description	Response headers
200	File download	-
401	Unauthorized	-
404	File Not Found	-

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

export_dur_v2

str export_dur_v2(id=id)

DurController@export

Export CSV of one or more DURs

Example

Bearer (JWT) Authentication (bearerAuth):

import gateway_api_sdk
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.DataUseRegistersApi(api_client)
    id = 1 # int | dur id (optional)

    try:
        # DurController@export
        api_response = api_instance.export_dur_v2(id=id)
        print("The response of DataUseRegistersApi->export_dur_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->export_dur_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	dur id	[optional]

Return type

str

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: text/csv, application/json

HTTP response details

Status code	Description	Response headers
200	CSV file	-
401	Unauthorized	-

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

fetch_all_dur

FetchAllDur200Response fetch_all_dur(sort=sort, project_title=project_title, per_page=per_page)

DurController@index

Returns a list of dur

Example

import gateway_api_sdk
from gateway_api_sdk.models.fetch_all_dur200_response import FetchAllDur200Response
from gateway_api_sdk.models.project_title_ascupdated_at_asc import ProjectTitleAscupdatedAtAsc
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"
)


# 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.DataUseRegistersApi(api_client)
    sort = gateway_api_sdk.ProjectTitleAscupdatedAtAsc() # ProjectTitleAscupdatedAtAsc | Sort fields in the format field:direction, e.g., project_title:asc,updated_at:asc (optional)
    project_title = 'project_title_example' # str | Filter tools by project title (optional)
    per_page = 1 # int | per page (optional)

    try:
        # DurController@index
        api_response = api_instance.fetch_all_dur(sort=sort, project_title=project_title, per_page=per_page)
        print("The response of DataUseRegistersApi->fetch_all_dur:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->fetch_all_dur: %s\n" % e)

Parameters

Name	Type	Description	Notes
sort	ProjectTitleAscupdatedAtAsc	Sort fields in the format field:direction, e.g., project_title:asc,updated_at:asc	[optional]
project_title	str	Filter tools by project title	[optional]
per_page	int	per page	[optional]

Return type

FetchAllDur200Response

Authorization

No authorization required

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]

fetch_all_dur_v2

FetchAllDurV2200Response fetch_all_dur_v2(sort=sort, project_title=project_title, per_page=per_page, with_related=with_related)

DurController@indexActive

Returns a list of active dur

Example

import gateway_api_sdk
from gateway_api_sdk.models.fetch_all_dur_v2200_response import FetchAllDurV2200Response
from gateway_api_sdk.models.project_title_ascupdated_at_asc import ProjectTitleAscupdatedAtAsc
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"
)


# 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.DataUseRegistersApi(api_client)
    sort = gateway_api_sdk.ProjectTitleAscupdatedAtAsc() # ProjectTitleAscupdatedAtAsc | Sort fields in the format field:direction, e.g., project_title:asc,updated_at:asc (optional)
    project_title = 'project_title_example' # str | Filter tools by project title (optional)
    per_page = 1 # int | per page (optional)
    with_related = True # bool | Show related entities (optional)

    try:
        # DurController@indexActive
        api_response = api_instance.fetch_all_dur_v2(sort=sort, project_title=project_title, per_page=per_page, with_related=with_related)
        print("The response of DataUseRegistersApi->fetch_all_dur_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->fetch_all_dur_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
sort	ProjectTitleAscupdatedAtAsc	Sort fields in the format field:direction, e.g., project_title:asc,updated_at:asc	[optional]
project_title	str	Filter tools by project title	[optional]
per_page	int	per page	[optional]
with_related	bool	Show related entities	[optional]

Return type

FetchAllDurV2200Response

Authorization

No authorization required

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]

fetch_dur_by_id

FetchDurById200Response fetch_dur_by_id(id)

DurController@show

Get dur by id

Example

Bearer (JWT) Authentication (bearerAuth):

import gateway_api_sdk
from gateway_api_sdk.models.fetch_dur_by_id200_response import FetchDurById200Response
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.DataUseRegistersApi(api_client)
    id = 1 # int | data use register id

    try:
        # DurController@show
        api_response = api_instance.fetch_dur_by_id(id)
        print("The response of DataUseRegistersApi->fetch_dur_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->fetch_dur_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	data use register id

Return type

FetchDurById200Response

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_dur_by_id_v2

UpdateDur200Response fetch_dur_by_id_v2(id)

DurController@showActive

Get dur by id

Example

Bearer (JWT) Authentication (bearerAuth):

import gateway_api_sdk
from gateway_api_sdk.models.update_dur200_response import UpdateDur200Response
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.DataUseRegistersApi(api_client)
    id = 1 # int | data use register id

    try:
        # DurController@showActive
        api_response = api_instance.fetch_dur_by_id_v2(id)
        print("The response of DataUseRegistersApi->fetch_dur_by_id_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->fetch_dur_by_id_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	data use register id

Return type

UpdateDur200Response

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]

update_dur

UpdateDur200Response update_dur(id, create_dur_request)

Update a dur by id

Update a dur

Example

Bearer (JWT) Authentication (bearerAuth):

import gateway_api_sdk
from gateway_api_sdk.models.create_dur_request import CreateDurRequest
from gateway_api_sdk.models.update_dur200_response import UpdateDur200Response
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.DataUseRegistersApi(api_client)
    id = 1 # int | dur id
    create_dur_request = gateway_api_sdk.CreateDurRequest() # CreateDurRequest | Pass user credentials

    try:
        # Update a dur by id
        api_response = api_instance.update_dur(id, create_dur_request)
        print("The response of DataUseRegistersApi->update_dur:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->update_dur: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	dur id
create_dur_request	CreateDurRequest	Pass user credentials

Return type

UpdateDur200Response

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_dur_v2_by_team_id

UpdateDur200Response update_dur_v2_by_team_id(team_id, id, create_dur_request)

TeamDurController@update

Update a dur by team and id v2

Example

Bearer (JWT) Authentication (bearerAuth):

import gateway_api_sdk
from gateway_api_sdk.models.create_dur_request import CreateDurRequest
from gateway_api_sdk.models.update_dur200_response import UpdateDur200Response
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.DataUseRegistersApi(api_client)
    team_id = 1 # int | team id
    id = 1 # int | dur id
    create_dur_request = gateway_api_sdk.CreateDurRequest() # CreateDurRequest | Pass user credentials

    try:
        # TeamDurController@update
        api_response = api_instance.update_dur_v2_by_team_id(team_id, id, create_dur_request)
        print("The response of DataUseRegistersApi->update_dur_v2_by_team_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->update_dur_v2_by_team_id: %s\n" % e)

Parameters

Name	Type	Description
team_id	int	team id
id	int	dur id
create_dur_request	CreateDurRequest	Pass user credentials

Return type

UpdateDur200Response

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]

upload_dur

CreateDarIntegration201Response upload_dur(upload_dur_request)

DurController@upload

Create a new dur with upload data

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.upload_dur_request import UploadDurRequest
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.DataUseRegistersApi(api_client)
    upload_dur_request = gateway_api_sdk.UploadDurRequest() # UploadDurRequest | Pass user credentials

    try:
        # DurController@upload
        api_response = api_instance.upload_dur(upload_dur_request)
        print("The response of DataUseRegistersApi->upload_dur:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataUseRegistersApi->upload_dur: %s\n" % e)

Parameters

Name	Type	Description	Notes
upload_dur_request	UploadDurRequest	Pass user credentials

Return type

CreateDarIntegration201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
401	Unauthorized	-
500	Error	-

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

FilesExpand file tree

DataUseRegistersApi.md

Latest commit

History

DataUseRegistersApi.md

File metadata and controls

gateway_api_sdk.DataUseRegistersApi

create_dur

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_dur_by_team_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_dur

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_durs_v2_by_team_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

edit_dur

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

edit_durs_v2_by_team_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

export_dur_template

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

export_dur_template_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

export_dur_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_all_dur

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_all_dur_v2

Example

Parameters