Skip to content

IntegrationCollectionsApi.md

Latest commit

 

History

History
197 lines (109 loc) · 6.44 KB

IntegrationCollectionsApi.md

File metadata and controls

197 lines (109 loc) · 6.44 KB
Raw

\IntegrationCollectionsApi

All URIs are relative to http://localhost

Method HTTP request Description
create_collections_integrations POST /api/v1/integrations/collections IntegrationCollectionController@store
delete_collections_integrations DELETE /api/v1/integrations/collections/{id} Delete a collection
edit_collections_integrations PATCH /api/v1/integrations/collections/{id} Edit a collection
fetch_all_collections_integrations GET /api/v1/integrations/collections IntegrationCollectionController@index
fetch_collections_integrations GET /api/v1/integrations/collections/{id} IntegrationCollectionController@show
update_collections_integrations PUT /api/v1/integrations/collections/{id} Update a collection

create_collections_integrations

models::CreateDarIntegration201Response create_collections_integrations(create_collections_integrations_request) IntegrationCollectionController@store

Create a new collection

Parameters

Name Type Description Required Notes
create_collections_integrations_request CreateCollectionsIntegrationsRequest Pass user credentials [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_collections_integrations

models::DeleteApplications200Response delete_collections_integrations(id) Delete a collection

Delete a collection

Parameters

Name Type Description Required Notes
id i32 collection 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_collections_integrations

models::FetchCollections200Response edit_collections_integrations(id, create_collections_integrations_request) Edit a collection

Edit a collection

Parameters

Name Type Description Required Notes
id i32 collection id [required]
create_collections_integrations_request CreateCollectionsIntegrationsRequest Pass user credentials [required]

Return type

models::FetchCollections200Response

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_collections_integrations

models::FetchAllCollections200Response fetch_all_collections_integrations(name, per_page) IntegrationCollectionController@index

Returns a list of collections

Parameters

Name Type Description Required Notes
name Option<String> Filter collections by name
per_page Option<i32> per page

Return type

models::FetchAllCollections200Response

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_collections_integrations

models::FetchCollections200Response fetch_collections_integrations(id) IntegrationCollectionController@show

Get collection by id

Parameters

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

Return type

models::FetchCollections200Response

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_collections_integrations

models::FetchCollections200Response update_collections_integrations(id, create_collections_integrations_request) Update a collection

Update a collection

Parameters

Name Type Description Required Notes
id i32 collection id [required]
create_collections_integrations_request CreateCollectionsIntegrationsRequest Pass user credentials [required]

Return type

models::FetchCollections200Response

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]