Skip to content

Latest commit

 

History

History
432 lines (275 loc) · 10.1 KB

EnvironmentServiceApi.md

File metadata and controls

432 lines (275 loc) · 10.1 KB
Raw

MadanaApiclient.EnvironmentServiceApi

All URIs are relative to http://api.madana.io/rest

Method HTTP request Description
deleteEnvironment DELETE /environments/{uuid}
deleteEnvironmentSubscription DELETE /environments/{uuid}/subscribe
getEnvironment GET /environments/{uuid}
getEnvironments GET /environments Returns UUIDs of existing analyses.
getPublishedEnvironments GET /environments/published
getSubscribedEnvironments GET /environments/subscriptions
publishEnvironment POST /environments
subscribeEnvironment POST /environments/{uuid}/subscribe
updateEnvironment PUT /environments/{uuid}

deleteEnvironment

File deleteEnvironment(uuid)

Example

import MadanaApiclient from 'madana-apiclient';

let apiInstance = new MadanaApiclient.EnvironmentServiceApi();
let uuid = "uuid_example"; // String | 
apiInstance.deleteEnvironment(uuid, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
uuid String

Return type

File

Authorization

No authorization required

HTTP request headers

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

deleteEnvironmentSubscription

File deleteEnvironmentSubscription(uuid)

Example

import MadanaApiclient from 'madana-apiclient';

let apiInstance = new MadanaApiclient.EnvironmentServiceApi();
let uuid = "uuid_example"; // String | 
apiInstance.deleteEnvironmentSubscription(uuid, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
uuid String

Return type

File

Authorization

No authorization required

HTTP request headers

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

getEnvironment

File getEnvironment(uuid)

Example

import MadanaApiclient from 'madana-apiclient';

let apiInstance = new MadanaApiclient.EnvironmentServiceApi();
let uuid = "uuid_example"; // String | 
apiInstance.getEnvironment(uuid, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
uuid String

Return type

File

Authorization

No authorization required

HTTP request headers

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

getEnvironments

File getEnvironments(opts)

Returns UUIDs of existing analyses.

Returns UUIDs of existing analyses.

Example

import MadanaApiclient from 'madana-apiclient';

let apiInstance = new MadanaApiclient.EnvironmentServiceApi();
let opts = {
  'authorization': "authorization_example", // String | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
  'created': "'true'", // String | - if Queryparam \"created=true\" only the UUIDs of own Requests are shown
  'limit': "'30'", // String | Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row
  'name': "name_example", // String | 
  'offset': "'0'" // String | Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row
};
apiInstance.getEnvironments(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
authorization String Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c [optional]
created String - if Queryparam "created=true" only the UUIDs of own Requests are shown [optional] [default to 'true']
limit String Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row [optional] [default to '30']
name String [optional]
offset String Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row [optional] [default to '0']

Return type

File

Authorization

No authorization required

HTTP request headers

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

getPublishedEnvironments

File getPublishedEnvironments(opts)

Example

import MadanaApiclient from 'madana-apiclient';

let apiInstance = new MadanaApiclient.EnvironmentServiceApi();
let opts = {
  'limit': "'30'", // String | 
  'name': "name_example", // String | 
  'offset': "'0'" // String | 
};
apiInstance.getPublishedEnvironments(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
limit String [optional] [default to '30']
name String [optional]
offset String [optional] [default to '0']

Return type

File

Authorization

No authorization required

HTTP request headers

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

getSubscribedEnvironments

File getSubscribedEnvironments(opts)

Example

import MadanaApiclient from 'madana-apiclient';

let apiInstance = new MadanaApiclient.EnvironmentServiceApi();
let opts = {
  'limit': "'30'", // String | 
  'offset': "'0'" // String | 
};
apiInstance.getSubscribedEnvironments(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
limit String [optional] [default to '30']
offset String [optional] [default to '0']

Return type

File

Authorization

No authorization required

HTTP request headers

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

publishEnvironment

File publishEnvironment(opts)

Example

import MadanaApiclient from 'madana-apiclient';

let apiInstance = new MadanaApiclient.EnvironmentServiceApi();
let opts = {
  'body': new MadanaApiclient.JsonEnvironmentPublishingRequest() // JsonEnvironmentPublishingRequest | 
};
apiInstance.publishEnvironment(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
body JsonEnvironmentPublishingRequest [optional]

Return type

File

Authorization

No authorization required

HTTP request headers

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

subscribeEnvironment

File subscribeEnvironment(uuid)

Example

import MadanaApiclient from 'madana-apiclient';

let apiInstance = new MadanaApiclient.EnvironmentServiceApi();
let uuid = "uuid_example"; // String | 
apiInstance.subscribeEnvironment(uuid, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
uuid String

Return type

File

Authorization

No authorization required

HTTP request headers

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

updateEnvironment

File updateEnvironment(uuid, opts)

Example

import MadanaApiclient from 'madana-apiclient';

let apiInstance = new MadanaApiclient.EnvironmentServiceApi();
let uuid = "uuid_example"; // String | 
let opts = {
  'body': new MadanaApiclient.JsonEnvironment() // JsonEnvironment | 
};
apiInstance.updateEnvironment(uuid, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
uuid String
body JsonEnvironment [optional]

Return type

File

Authorization

No authorization required

HTTP request headers

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