# ExtensionPointsApi

All URIs are relative to *http://localhost:8889/api*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getAll**](#getall) | **GET** /extensionpoints | Get all extension points|
|[**getProcessDefinitions**](#getprocessdefinitions) | **GET** /extensionpoints/{transactionType} | Get process definitions for extension point phases|
|[**storeProcessDefinitions**](#storeprocessdefinitions) | **PUT** /extensionpoints/{transactionType} | Attach process definitions to extension point phases|

# **getAll**
> Array<ExtensionPointDTO> getAll()

Returns all extension points (profiles) and their available phases

### Example

```typescript
import {
    ExtensionPointsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ExtensionPointsApi(configuration);

const { status, data } = await apiInstance.getAll();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**Array<ExtensionPointDTO>**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | List of extension points with phases |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getProcessDefinitions**
> object getProcessDefinitions()

Returns the process definitions attached to the given extension point phases

### Example

```typescript
import {
    ExtensionPointsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ExtensionPointsApi(configuration);

let transactionType: string; //Transaction type identifier (e.g. type.name) (default to undefined)

const { status, data } = await apiInstance.getProcessDefinitions(
    transactionType
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **transactionType** | [**string**] | Transaction type identifier (e.g. type.name) | defaults to undefined|


### Return type

**object**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Map of phase names to process definition ids |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **storeProcessDefinitions**
> storeProcessDefinitions(body)

Attaches the process definitions to the given extension point phases

### Example

```typescript
import {
    ExtensionPointsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ExtensionPointsApi(configuration);

let transactionType: string; //Transaction type identifier (e.g. type.name) (default to undefined)
let body: object; //Map of phase names to lists of process definition ids (e.g., {\"phase1\": [\"proc1\", \"proc2\"], \"phase2\": [\"proc3\"]})

const { status, data } = await apiInstance.storeProcessDefinitions(
    transactionType,
    body
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **object**| Map of phase names to lists of process definition ids (e.g., {\&quot;phase1\&quot;: [\&quot;proc1\&quot;, \&quot;proc2\&quot;], \&quot;phase2\&quot;: [\&quot;proc3\&quot;]}) | |
| **transactionType** | [**string**] | Transaction type identifier (e.g. type.name) | defaults to undefined|


### Return type

void (empty response body)

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/vnd.mambu.v2+json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | Attached successfully |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

