# PartnershipManagement.PartnershipSpecificationApi

All URIs are relative to *https://serverRoot/tmf-api/partnershipManagement/v4/*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createPartnershipSpecification**](PartnershipSpecificationApi.md#createPartnershipSpecification) | **POST** /partnershipSpecification | Creates a PartnershipSpecification
[**deletePartnershipSpecification**](PartnershipSpecificationApi.md#deletePartnershipSpecification) | **DELETE** /partnershipSpecification/{id} | Deletes a PartnershipSpecification
[**listPartnershipSpecification**](PartnershipSpecificationApi.md#listPartnershipSpecification) | **GET** /partnershipSpecification | List or find PartnershipSpecification objects
[**patchPartnershipSpecification**](PartnershipSpecificationApi.md#patchPartnershipSpecification) | **PATCH** /partnershipSpecification/{id} | Updates partially a PartnershipSpecification
[**retrievePartnershipSpecification**](PartnershipSpecificationApi.md#retrievePartnershipSpecification) | **GET** /partnershipSpecification/{id} | Retrieves a PartnershipSpecification by ID

<a name="createPartnershipSpecification"></a>
# **createPartnershipSpecification**
> PartnershipSpecification createPartnershipSpecification(body)

Creates a PartnershipSpecification

This operation creates a PartnershipSpecification entity.

### Example
```javascript
import {PartnershipManagement} from 'partnership_management';

let apiInstance = new PartnershipManagement.PartnershipSpecificationApi();
let body = new PartnershipManagement.PartnershipSpecificationCreate(); // PartnershipSpecificationCreate | The PartnershipSpecification to be created

apiInstance.createPartnershipSpecification(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**PartnershipSpecificationCreate**](PartnershipSpecificationCreate.md)| The PartnershipSpecification to be created | 

### Return type

[**PartnershipSpecification**](PartnershipSpecification.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json;charset=utf-8
 - **Accept**: application/json;charset=utf-8

<a name="deletePartnershipSpecification"></a>
# **deletePartnershipSpecification**
> deletePartnershipSpecification(id)

Deletes a PartnershipSpecification

This operation deletes a PartnershipSpecification entity.

### Example
```javascript
import {PartnershipManagement} from 'partnership_management';

let apiInstance = new PartnershipManagement.PartnershipSpecificationApi();
let id = "id_example"; // String | Identifier of the PartnershipSpecification

apiInstance.deletePartnershipSpecification(id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Identifier of the PartnershipSpecification | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json;charset=utf-8

<a name="listPartnershipSpecification"></a>
# **listPartnershipSpecification**
> [PartnershipSpecification] listPartnershipSpecification(opts)

List or find PartnershipSpecification objects

This operation list or find PartnershipSpecification entities

### Example
```javascript
import {PartnershipManagement} from 'partnership_management';

let apiInstance = new PartnershipManagement.PartnershipSpecificationApi();
let opts = { 
  'fields': "fields_example", // String | Comma-separated properties to be provided in response
  'offset': 56, // Number | Requested index for start of resources to be provided in response
  'limit': 56 // Number | Requested number of resources to be provided in response
};
apiInstance.listPartnershipSpecification(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **fields** | **String**| Comma-separated properties to be provided in response | [optional] 
 **offset** | **Number**| Requested index for start of resources to be provided in response | [optional] 
 **limit** | **Number**| Requested number of resources to be provided in response | [optional] 

### Return type

[**[PartnershipSpecification]**](PartnershipSpecification.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json;charset=utf-8

<a name="patchPartnershipSpecification"></a>
# **patchPartnershipSpecification**
> PartnershipSpecification patchPartnershipSpecification(body, id)

Updates partially a PartnershipSpecification

This operation updates partially a PartnershipSpecification entity.

### Example
```javascript
import {PartnershipManagement} from 'partnership_management';

let apiInstance = new PartnershipManagement.PartnershipSpecificationApi();
let body = new PartnershipManagement.PartnershipSpecificationUpdate(); // PartnershipSpecificationUpdate | The PartnershipSpecification to be updated
let id = "id_example"; // String | Identifier of the PartnershipSpecification

apiInstance.patchPartnershipSpecification(body, id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**PartnershipSpecificationUpdate**](PartnershipSpecificationUpdate.md)| The PartnershipSpecification to be updated | 
 **id** | **String**| Identifier of the PartnershipSpecification | 

### Return type

[**PartnershipSpecification**](PartnershipSpecification.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json;charset=utf-8
 - **Accept**: application/json;charset=utf-8

<a name="retrievePartnershipSpecification"></a>
# **retrievePartnershipSpecification**
> PartnershipSpecification retrievePartnershipSpecification(id, opts)

Retrieves a PartnershipSpecification by ID

This operation retrieves a PartnershipSpecification entity. Attribute selection is enabled for all first level attributes.

### Example
```javascript
import {PartnershipManagement} from 'partnership_management';

let apiInstance = new PartnershipManagement.PartnershipSpecificationApi();
let id = "id_example"; // String | Identifier of the PartnershipSpecification
let opts = { 
  'fields': "fields_example" // String | Comma-separated properties to provide in response
};
apiInstance.retrievePartnershipSpecification(id, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Identifier of the PartnershipSpecification | 
 **fields** | **String**| Comma-separated properties to provide in response | [optional] 

### Return type

[**PartnershipSpecification**](PartnershipSpecification.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json;charset=utf-8