Skip to content

Latest commit

 

History

History
441 lines (310 loc) · 11 KB

CamApi.md

File metadata and controls

441 lines (310 loc) · 11 KB
Raw

CamApi

All URIs are relative to https://localhost/api

Method HTTP request Description
getActivityCollection GET /cam/activity/ Returns list of models
getInstance GET /cam/instance/{id} Returns list of matches
getModel GET /cam/model/{id} Returns a complete model
getModelCollection GET /cam/model/ Returns list of ALL models
getModelCollection_0 GET /cam/model/properties/ Returns list of all properties used across all models
getModelCollection_1 GET /cam/model/property_values/ Returns list property-values for all models
getModelCollection_2 GET /cam/model/query/ Returns list of models matching query
getModelContibutors GET /cam/instances/ Returns list of all instances
getModelContibutors_0 GET /cam/model/contributors/ Returns list of all contributors across all models
getPhysicalInteraction GET /cam/physical_interaction/ Returns list of models

getActivityCollection

getActivityCollection(contributor, title)

Returns list of models

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CamApi;


CamApi apiInstance = new CamApi();
String contributor = "contributor_example"; // String | string to search for in contributor of model
String title = "title_example"; // String | string to search for in title of model
try {
    apiInstance.getActivityCollection(contributor, title);
} catch (ApiException e) {
    System.err.println("Exception when calling CamApi#getActivityCollection");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
contributor String string to search for in contributor of model [optional]
title String string to search for in title of model [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getInstance

List<Association> getInstance(id, contributor, title)

Returns list of matches

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CamApi;


CamApi apiInstance = new CamApi();
String id = "id_example"; // String | 
String contributor = "contributor_example"; // String | string to search for in contributor of model
String title = "title_example"; // String | string to search for in title of model
try {
    List<Association> result = apiInstance.getInstance(id, contributor, title);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CamApi#getInstance");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
contributor String string to search for in contributor of model [optional]
title String string to search for in title of model [optional]

Return type

List<Association>

Authorization

No authorization required

HTTP request headers

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

getModel

getModel(id)

Returns a complete model

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CamApi;


CamApi apiInstance = new CamApi();
String id = "id_example"; // String | 
try {
    apiInstance.getModel(id);
} catch (ApiException e) {
    System.err.println("Exception when calling CamApi#getModel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getModelCollection

getModelCollection()

Returns list of ALL models

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CamApi;


CamApi apiInstance = new CamApi();
try {
    apiInstance.getModelCollection();
} catch (ApiException e) {
    System.err.println("Exception when calling CamApi#getModelCollection");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getModelCollection_0

getModelCollection_0(contributor, title)

Returns list of all properties used across all models

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CamApi;


CamApi apiInstance = new CamApi();
String contributor = "contributor_example"; // String | string to search for in contributor of model
String title = "title_example"; // String | string to search for in title of model
try {
    apiInstance.getModelCollection_0(contributor, title);
} catch (ApiException e) {
    System.err.println("Exception when calling CamApi#getModelCollection_0");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
contributor String string to search for in contributor of model [optional]
title String string to search for in title of model [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getModelCollection_1

getModelCollection_1(contributor, title)

Returns list property-values for all models

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CamApi;


CamApi apiInstance = new CamApi();
String contributor = "contributor_example"; // String | string to search for in contributor of model
String title = "title_example"; // String | string to search for in title of model
try {
    apiInstance.getModelCollection_1(contributor, title);
} catch (ApiException e) {
    System.err.println("Exception when calling CamApi#getModelCollection_1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
contributor String string to search for in contributor of model [optional]
title String string to search for in title of model [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getModelCollection_2

getModelCollection_2(contributor, title)

Returns list of models matching query

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CamApi;


CamApi apiInstance = new CamApi();
String contributor = "contributor_example"; // String | string to search for in contributor of model
String title = "title_example"; // String | string to search for in title of model
try {
    apiInstance.getModelCollection_2(contributor, title);
} catch (ApiException e) {
    System.err.println("Exception when calling CamApi#getModelCollection_2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
contributor String string to search for in contributor of model [optional]
title String string to search for in title of model [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getModelContibutors

getModelContibutors()

Returns list of all instances

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CamApi;


CamApi apiInstance = new CamApi();
try {
    apiInstance.getModelContibutors();
} catch (ApiException e) {
    System.err.println("Exception when calling CamApi#getModelContibutors");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getModelContibutors_0

getModelContibutors_0()

Returns list of all contributors across all models

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CamApi;


CamApi apiInstance = new CamApi();
try {
    apiInstance.getModelContibutors_0();
} catch (ApiException e) {
    System.err.println("Exception when calling CamApi#getModelContibutors_0");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getPhysicalInteraction

getPhysicalInteraction(contributor, title)

Returns list of models

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CamApi;


CamApi apiInstance = new CamApi();
String contributor = "contributor_example"; // String | string to search for in contributor of model
String title = "title_example"; // String | string to search for in title of model
try {
    apiInstance.getPhysicalInteraction(contributor, title);
} catch (ApiException e) {
    System.err.println("Exception when calling CamApi#getPhysicalInteraction");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
contributor String string to search for in contributor of model [optional]
title String string to search for in title of model [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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