ApplicationApi.md

\ApplicationApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_applications	POST /api/v1/applications	ApplicationController@store
delete_applications	DELETE /api/v1/applications/{id}	ApplicationController@delete
edit_applications	PATCH /api/v1/applications/{id}	ApplicationController@edit
fetch_all_applications	GET /api/v1/applications	ApplicationController@index
fetch_all_sitemap	GET /api/v1/sitemap	SiteMapController@index
fetch_applications	GET /api/v1/applications/{id}	ApplicationController@show
patch_applications_client_id	PATCH /api/v1/applications/{id}/clientid	ApplicationController@generateClientIdById
update_applications	PUT /api/v1/applications/{id}	ApplicationController@update

create_applications

models::CreateApplications200Response create_applications(create_applications_request) ApplicationController@store

Creates application

Parameters

Name	Type	Description	Required	Notes
create_applications_request	CreateApplicationsRequest	Application definition	[required]

Return type

models::CreateApplications200Response

Authorization

bearerAuth

HTTP request headers

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

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

delete_applications

models::DeleteApplications200Response delete_applications(id) ApplicationController@delete

Delete application

Parameters

Name	Type	Description	Required	Notes
id	i32	application id	[required]

Return type

models::DeleteApplications200Response

Authorization

bearerAuth

HTTP request headers

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

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

edit_applications

models::UpdateApplications200Response edit_applications(id, edit_applications_request) ApplicationController@edit

Edit application

Parameters

Name	Type	Description	Required	Notes
id	i32	application id	[required]
edit_applications_request	EditApplicationsRequest	ActivityLog definition	[required]

Return type

models::UpdateApplications200Response

Authorization

bearerAuth

HTTP request headers

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

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

fetch_all_applications

models::FetchAllApplications200Response fetch_all_applications(team_id, text, status) ApplicationController@index

Returns a list of applications

Parameters

Name	Type	Description	Required	Notes
team_id	Option<i32>	Filter Apps by the teamId
text	Option<String>	Search term to filter by application name or description.
status	Option<String>	Filter by application status is enabled or not (true or false).

Return type

models::FetchAllApplications200Response

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]

fetch_all_sitemap

models::FetchAllSitemap200Response fetch_all_sitemap() SiteMapController@index

Returns a list of all ids and last updated date for Collections, Data Custodians, Data Custodian Networks, Durs, DataSets, Tools

Parameters

This endpoint does not need any parameter.

Return type

models::FetchAllSitemap200Response

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]

fetch_applications

models::FetchApplications200Response fetch_applications(id) ApplicationController@show

Get application by id

Parameters

Name	Type	Description	Required	Notes
id	i32	application id	[required]

Return type

models::FetchApplications200Response

Authorization

bearerAuth

HTTP request headers

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

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

patch_applications_client_id

models::UpdateApplications200Response patch_applications_client_id(id) ApplicationController@generateClientIdById

Generate Client ID application

Parameters

Name	Type	Description	Required	Notes
id	i32	application id	[required]

Return type

models::UpdateApplications200Response

Authorization

bearerAuth

HTTP request headers

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

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

update_applications

models::UpdateApplications200Response update_applications(id, update_applications_request) ApplicationController@update

Update application

Parameters

Name	Type	Description	Required	Notes
id	i32	application id	[required]
update_applications_request	UpdateApplicationsRequest	ActivityLog definition	[required]

Return type

models::UpdateApplications200Response

Authorization

bearerAuth

HTTP request headers

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

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