Skip to content

DataAccessTemplateApi.md

Latest commit

 

History

History
198 lines (110 loc) · 6.07 KB

DataAccessTemplateApi.md

File metadata and controls

198 lines (110 loc) · 6.07 KB
Raw

\DataAccessTemplateApi

All URIs are relative to http://localhost

Method HTTP request Description
create_dar_template POST /api/v1/dar/templates DataAccessTemplate@store
delete_dar_template DELETE /api/v1/dar/templates/{id} DataAccessTemplate@destroy
fetch_dar_template GET /api/v1/dar/templates/{id} DataAccessTemplate@show
fetch_dar_templates GET /api/v1/dar/templates DataAccessTemplate@index
patch_dar_template PATCH /api/v1/dar/templates/{id} DataAccessTemplate@update
update_dar_template PUT /api/v1/dar/templates/{id} DataAccessTemplate@update

create_dar_template

models::CreateDarIntegration201Response create_dar_template(create_dar_template_request) DataAccessTemplate@store

Creates a new DAR template

Parameters

Name Type Description Required Notes
create_dar_template_request CreateDarTemplateRequest DataAccessTemplate definition [required]

Return type

models::CreateDarIntegration201Response

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_dar_template

models::DeleteApplications200Response delete_dar_template(id) DataAccessTemplate@destroy

Delete a system DAR template

Parameters

Name Type Description Required Notes
id i32 DAR template 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]

fetch_dar_template

models::FetchDarTemplate200Response fetch_dar_template(id) DataAccessTemplate@show

Return a single DAR template

Parameters

Name Type Description Required Notes
id i32 DAR template id [required]

Return type

models::FetchDarTemplate200Response

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]

fetch_dar_templates

models::FetchDarTemplates200Response fetch_dar_templates(with_questions, published) DataAccessTemplate@index

List of DAR templates

Parameters

Name Type Description Required Notes
with_questions Option<i32> Include questions in response
published Option<String> Template publication status to filter by (true, false)

Return type

models::FetchDarTemplates200Response

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_dar_template

models::PatchDarTemplate200Response patch_dar_template(id, patch_dar_template_request, section_id) DataAccessTemplate@update

Edit a system DAR template

Parameters

Name Type Description Required Notes
id i32 DAR template id [required]
patch_dar_template_request PatchDarTemplateRequest DataAccessTemplate definition [required]
section_id Option<i32> Section id

Return type

models::PatchDarTemplate200Response

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]

update_dar_template

models::FetchDarTemplate200Response update_dar_template(id, update_dar_template_request) DataAccessTemplate@update

Update a system DAR template

Parameters

Name Type Description Required Notes
id i32 DAR template id [required]
update_dar_template_request UpdateDarTemplateRequest DataAccessTemplate definition [required]

Return type

models::FetchDarTemplate200Response

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]