Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • coscine/backend/libraries/apiclient
1 result
Show changes
Commits on Source (4)
Showing
with 567 additions and 70 deletions
...@@ -176,6 +176,7 @@ Class | Method | HTTP request | Description ...@@ -176,6 +176,7 @@ Class | Method | HTTP request | Description
*ProjectMemberApi* | [**UpdateMembership**](docs/ProjectMemberApi.md#updatemembership) | **PUT** /api/v2/projects/{projectId}/members/{membershipId} | Updates a project membership for a specified project. *ProjectMemberApi* | [**UpdateMembership**](docs/ProjectMemberApi.md#updatemembership) | **PUT** /api/v2/projects/{projectId}/members/{membershipId} | Updates a project membership for a specified project.
*ProjectPublicationRequestApi* | [**ApiV2ProjectsProjectIdPublicationsRequestsOptions**](docs/ProjectPublicationRequestApi.md#apiv2projectsprojectidpublicationsrequestsoptions) | **OPTIONS** /api/v2/projects/{projectId}/publications/requests | Responds with the HTTP methods allowed for the endpoint. *ProjectPublicationRequestApi* | [**ApiV2ProjectsProjectIdPublicationsRequestsOptions**](docs/ProjectPublicationRequestApi.md#apiv2projectsprojectidpublicationsrequestsoptions) | **OPTIONS** /api/v2/projects/{projectId}/publications/requests | Responds with the HTTP methods allowed for the endpoint.
*ProjectPublicationRequestApi* | [**CreatePublicationRequest**](docs/ProjectPublicationRequestApi.md#createpublicationrequest) | **POST** /api/v2/projects/{projectId}/publications/requests | Creates a new publication request. *ProjectPublicationRequestApi* | [**CreatePublicationRequest**](docs/ProjectPublicationRequestApi.md#createpublicationrequest) | **POST** /api/v2/projects/{projectId}/publications/requests | Creates a new publication request.
*ProjectPublicationRequestApi* | [**GetPublicationRequest**](docs/ProjectPublicationRequestApi.md#getpublicationrequest) | **GET** /api/v2/projects/{projectId}/publications/requests/{publicationRequestId} | Retrieves a publication request.
*ProjectQuotaApi* | [**ApiV2ProjectsProjectIdQuotasOptions**](docs/ProjectQuotaApi.md#apiv2projectsprojectidquotasoptions) | **OPTIONS** /api/v2/projects/{projectId}/quotas | Responds with the HTTP methods allowed for the endpoint. *ProjectQuotaApi* | [**ApiV2ProjectsProjectIdQuotasOptions**](docs/ProjectQuotaApi.md#apiv2projectsprojectidquotasoptions) | **OPTIONS** /api/v2/projects/{projectId}/quotas | Responds with the HTTP methods allowed for the endpoint.
*ProjectQuotaApi* | [**GetProjectQuota**](docs/ProjectQuotaApi.md#getprojectquota) | **GET** /api/v2/projects/{projectId}/quotas/{resourceTypeId} | Retrieves a project quota for a specified project and resource type. *ProjectQuotaApi* | [**GetProjectQuota**](docs/ProjectQuotaApi.md#getprojectquota) | **GET** /api/v2/projects/{projectId}/quotas/{resourceTypeId} | Retrieves a project quota for a specified project and resource type.
*ProjectQuotaApi* | [**GetProjectQuotas**](docs/ProjectQuotaApi.md#getprojectquotas) | **GET** /api/v2/projects/{projectId}/quotas | Retrieves all project quotas for a specified project. *ProjectQuotaApi* | [**GetProjectQuotas**](docs/ProjectQuotaApi.md#getprojectquotas) | **GET** /api/v2/projects/{projectId}/quotas | Retrieves all project quotas for a specified project.
...@@ -223,9 +224,6 @@ Class | Method | HTTP request | Description ...@@ -223,9 +224,6 @@ Class | Method | HTTP request | Description
*SelfSessionApi* | [**Login**](docs/SelfSessionApi.md#login) | **GET** /api/v2/self/session | Initiate the login workflow with the default (NFDI4Ing AAI) provider. *SelfSessionApi* | [**Login**](docs/SelfSessionApi.md#login) | **GET** /api/v2/self/session | Initiate the login workflow with the default (NFDI4Ing AAI) provider.
*SelfSessionApi* | [**LoginWithProvider**](docs/SelfSessionApi.md#loginwithprovider) | **GET** /api/v2/self/session/{externalAuthenticatorId} | Initiate the login workflow with specific provider. *SelfSessionApi* | [**LoginWithProvider**](docs/SelfSessionApi.md#loginwithprovider) | **GET** /api/v2/self/session/{externalAuthenticatorId} | Initiate the login workflow with specific provider.
*SelfSessionApi* | [**Merge**](docs/SelfSessionApi.md#merge) | **GET** /api/v2/self/session/merge/{externalAuthenticatorId} | Initiate the merge workflow with specific provider. *SelfSessionApi* | [**Merge**](docs/SelfSessionApi.md#merge) | **GET** /api/v2/self/session/merge/{externalAuthenticatorId} | Initiate the merge workflow with specific provider.
*SystemStatusApi* | [**ApiV2SystemStatusOptions**](docs/SystemStatusApi.md#apiv2systemstatusoptions) | **OPTIONS** /api/v2/system/status | Responds with the HTTP methods allowed for the endpoint.
*SystemStatusApi* | [**GetInternalMessages**](docs/SystemStatusApi.md#getinternalmessages) | **GET** /api/v2/system/status/internal | Retrieves the internal messages.
*SystemStatusApi* | [**GetNocMessages**](docs/SystemStatusApi.md#getnocmessages) | **GET** /api/v2/system/status/noc | Retrieves the NOC messages.
*TitleApi* | [**ApiV2TitlesOptions**](docs/TitleApi.md#apiv2titlesoptions) | **OPTIONS** /api/v2/titles | Responds with the HTTP methods allowed for the endpoint. *TitleApi* | [**ApiV2TitlesOptions**](docs/TitleApi.md#apiv2titlesoptions) | **OPTIONS** /api/v2/titles | Responds with the HTTP methods allowed for the endpoint.
*TitleApi* | [**GetTitle**](docs/TitleApi.md#gettitle) | **GET** /api/v2/titles/{titleId} | Retrieves a title by ID. *TitleApi* | [**GetTitle**](docs/TitleApi.md#gettitle) | **GET** /api/v2/titles/{titleId} | Retrieves a title by ID.
*TitleApi* | [**GetTitles**](docs/TitleApi.md#gettitles) | **GET** /api/v2/titles | Retrieves all titles. *TitleApi* | [**GetTitles**](docs/TitleApi.md#gettitles) | **GET** /api/v2/titles | Retrieves all titles.
...@@ -311,9 +309,6 @@ Class | Method | HTTP request | Description ...@@ -311,9 +309,6 @@ Class | Method | HTTP request | Description
- [Model.LicenseForResourceManipulationDto](docs/LicenseForResourceManipulationDto.md) - [Model.LicenseForResourceManipulationDto](docs/LicenseForResourceManipulationDto.md)
- [Model.MaintenanceDto](docs/MaintenanceDto.md) - [Model.MaintenanceDto](docs/MaintenanceDto.md)
- [Model.MaintenanceDtoPagedResponse](docs/MaintenanceDtoPagedResponse.md) - [Model.MaintenanceDtoPagedResponse](docs/MaintenanceDtoPagedResponse.md)
- [Model.MessageDto](docs/MessageDto.md)
- [Model.MessageDtoPagedResponse](docs/MessageDtoPagedResponse.md)
- [Model.MessageType](docs/MessageType.md)
- [Model.MetadataTreeDto](docs/MetadataTreeDto.md) - [Model.MetadataTreeDto](docs/MetadataTreeDto.md)
- [Model.MetadataTreeDtoPagedResponse](docs/MetadataTreeDtoPagedResponse.md) - [Model.MetadataTreeDtoPagedResponse](docs/MetadataTreeDtoPagedResponse.md)
- [Model.MetadataTreeDtoResponse](docs/MetadataTreeDtoResponse.md) - [Model.MetadataTreeDtoResponse](docs/MetadataTreeDtoResponse.md)
...@@ -345,6 +340,8 @@ Class | Method | HTTP request | Description ...@@ -345,6 +340,8 @@ Class | Method | HTTP request | Description
- [Model.ProjectInvitationForProjectManipulationDto](docs/ProjectInvitationForProjectManipulationDto.md) - [Model.ProjectInvitationForProjectManipulationDto](docs/ProjectInvitationForProjectManipulationDto.md)
- [Model.ProjectInvitationResolveDto](docs/ProjectInvitationResolveDto.md) - [Model.ProjectInvitationResolveDto](docs/ProjectInvitationResolveDto.md)
- [Model.ProjectMinimalDto](docs/ProjectMinimalDto.md) - [Model.ProjectMinimalDto](docs/ProjectMinimalDto.md)
- [Model.ProjectPublicationRequestDto](docs/ProjectPublicationRequestDto.md)
- [Model.ProjectPublicationRequestDtoResponse](docs/ProjectPublicationRequestDtoResponse.md)
- [Model.ProjectQuotaDto](docs/ProjectQuotaDto.md) - [Model.ProjectQuotaDto](docs/ProjectQuotaDto.md)
- [Model.ProjectQuotaDtoPagedResponse](docs/ProjectQuotaDtoPagedResponse.md) - [Model.ProjectQuotaDtoPagedResponse](docs/ProjectQuotaDtoPagedResponse.md)
- [Model.ProjectQuotaDtoResponse](docs/ProjectQuotaDtoResponse.md) - [Model.ProjectQuotaDtoResponse](docs/ProjectQuotaDtoResponse.md)
...@@ -364,7 +361,6 @@ Class | Method | HTTP request | Description ...@@ -364,7 +361,6 @@ Class | Method | HTTP request | Description
- [Model.PublicUserDtoIEnumerableResponse](docs/PublicUserDtoIEnumerableResponse.md) - [Model.PublicUserDtoIEnumerableResponse](docs/PublicUserDtoIEnumerableResponse.md)
- [Model.PublicationAdvisoryServiceDto](docs/PublicationAdvisoryServiceDto.md) - [Model.PublicationAdvisoryServiceDto](docs/PublicationAdvisoryServiceDto.md)
- [Model.PublicationRequestForCreationDto](docs/PublicationRequestForCreationDto.md) - [Model.PublicationRequestForCreationDto](docs/PublicationRequestForCreationDto.md)
- [Model.PublicationRequestForCreationDtoResponse](docs/PublicationRequestForCreationDtoResponse.md)
- [Model.QuotaDto](docs/QuotaDto.md) - [Model.QuotaDto](docs/QuotaDto.md)
- [Model.QuotaForManipulationDto](docs/QuotaForManipulationDto.md) - [Model.QuotaForManipulationDto](docs/QuotaForManipulationDto.md)
- [Model.QuotaUnit](docs/QuotaUnit.md) - [Model.QuotaUnit](docs/QuotaUnit.md)
......
...@@ -213,7 +213,7 @@ catch (ApiException e) ...@@ -213,7 +213,7 @@ catch (ApiException e)
<a id="getallprojects"></a> <a id="getallprojects"></a>
# **GetAllProjects** # **GetAllProjects**
> ProjectAdminDtoPagedResponse GetAllProjects (bool? topLevel = null, bool? includeDeleted = null, bool? includeQuotas = null, int? pageSize = null, int? pageNumber = null, string? orderBy = null) > ProjectAdminDtoPagedResponse GetAllProjects (bool? topLevel = null, bool? includeDeleted = null, bool? includeQuotas = null, bool? includePublicationRequests = null, int? pageSize = null, int? pageNumber = null, string? orderBy = null)
Retrieves all projects. Retrieves all projects.
...@@ -244,6 +244,7 @@ namespace Example ...@@ -244,6 +244,7 @@ namespace Example
var topLevel = true; // bool? | Gets or sets a value indicating whether to filter top-level projects. (optional) var topLevel = true; // bool? | Gets or sets a value indicating whether to filter top-level projects. (optional)
var includeDeleted = true; // bool? | Gets or sets a value indicating whether to include deleted projects in the results. (optional) var includeDeleted = true; // bool? | Gets or sets a value indicating whether to include deleted projects in the results. (optional)
var includeQuotas = true; // bool? | Gets or sets a value indicating whether to include quotas in the results. (optional) var includeQuotas = true; // bool? | Gets or sets a value indicating whether to include quotas in the results. (optional)
var includePublicationRequests = true; // bool? | Gets or sets a value indicating whether to include project publication requests in the results. (optional)
var pageSize = 56; // int? | Number of items per page. The maximum number of items per page is `250`. (optional) var pageSize = 56; // int? | Number of items per page. The maximum number of items per page is `250`. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
...@@ -251,7 +252,7 @@ namespace Example ...@@ -251,7 +252,7 @@ namespace Example
try try
{ {
// Retrieves all projects. // Retrieves all projects.
ProjectAdminDtoPagedResponse result = apiInstance.GetAllProjects(topLevel, includeDeleted, includeQuotas, pageSize, pageNumber, orderBy); ProjectAdminDtoPagedResponse result = apiInstance.GetAllProjects(topLevel, includeDeleted, includeQuotas, includePublicationRequests, pageSize, pageNumber, orderBy);
Debug.WriteLine(result); Debug.WriteLine(result);
} }
catch (ApiException e) catch (ApiException e)
...@@ -272,7 +273,7 @@ This returns an ApiResponse object which contains the response data, status code ...@@ -272,7 +273,7 @@ This returns an ApiResponse object which contains the response data, status code
try try
{ {
// Retrieves all projects. // Retrieves all projects.
ApiResponse<ProjectAdminDtoPagedResponse> response = apiInstance.GetAllProjectsWithHttpInfo(topLevel, includeDeleted, includeQuotas, pageSize, pageNumber, orderBy); ApiResponse<ProjectAdminDtoPagedResponse> response = apiInstance.GetAllProjectsWithHttpInfo(topLevel, includeDeleted, includeQuotas, includePublicationRequests, pageSize, pageNumber, orderBy);
Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers); Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data); Debug.Write("Response Body: " + response.Data);
...@@ -292,6 +293,7 @@ catch (ApiException e) ...@@ -292,6 +293,7 @@ catch (ApiException e)
| **topLevel** | **bool?** | Gets or sets a value indicating whether to filter top-level projects. | [optional] | | **topLevel** | **bool?** | Gets or sets a value indicating whether to filter top-level projects. | [optional] |
| **includeDeleted** | **bool?** | Gets or sets a value indicating whether to include deleted projects in the results. | [optional] | | **includeDeleted** | **bool?** | Gets or sets a value indicating whether to include deleted projects in the results. | [optional] |
| **includeQuotas** | **bool?** | Gets or sets a value indicating whether to include quotas in the results. | [optional] | | **includeQuotas** | **bool?** | Gets or sets a value indicating whether to include quotas in the results. | [optional] |
| **includePublicationRequests** | **bool?** | Gets or sets a value indicating whether to include project publication requests in the results. | [optional] |
| **pageSize** | **int?** | Number of items per page. The maximum number of items per page is &#x60;250&#x60;. | [optional] | | **pageSize** | **int?** | Number of items per page. The maximum number of items per page is &#x60;250&#x60;. | [optional] |
| **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [optional] | | **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [optional] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] | | **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
......
...@@ -27,6 +27,7 @@ Name | Type | Description | Notes ...@@ -27,6 +27,7 @@ Name | Type | Description | Notes
**ProjectResources** | [**List&lt;ProjectResourceMinimalDto&gt;**](ProjectResourceMinimalDto.md) | Collection of minimal project resource details associated with the project. | [optional] **ProjectResources** | [**List&lt;ProjectResourceMinimalDto&gt;**](ProjectResourceMinimalDto.md) | Collection of minimal project resource details associated with the project. | [optional]
**ProjectRoles** | [**List&lt;ProjectRoleMinimalDto&gt;**](ProjectRoleMinimalDto.md) | Collection of minimal project role details associated with the project. | [optional] **ProjectRoles** | [**List&lt;ProjectRoleMinimalDto&gt;**](ProjectRoleMinimalDto.md) | Collection of minimal project role details associated with the project. | [optional]
**ProjectQuota** | [**List&lt;ProjectQuotaDto&gt;**](ProjectQuotaDto.md) | Collection of project quotas associated with the project. | [optional] **ProjectQuota** | [**List&lt;ProjectQuotaDto&gt;**](ProjectQuotaDto.md) | Collection of project quotas associated with the project. | [optional]
**PublicationRequests** | [**List&lt;ProjectPublicationRequestDto&gt;**](ProjectPublicationRequestDto.md) | Collection of project publication requests associated with the project. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
...@@ -6,6 +6,7 @@ All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.d ...@@ -6,6 +6,7 @@ All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.d
|--------|--------------|-------------| |--------|--------------|-------------|
| [**ApiV2ProjectsProjectIdPublicationsRequestsOptions**](ProjectPublicationRequestApi.md#apiv2projectsprojectidpublicationsrequestsoptions) | **OPTIONS** /api/v2/projects/{projectId}/publications/requests | Responds with the HTTP methods allowed for the endpoint. | | [**ApiV2ProjectsProjectIdPublicationsRequestsOptions**](ProjectPublicationRequestApi.md#apiv2projectsprojectidpublicationsrequestsoptions) | **OPTIONS** /api/v2/projects/{projectId}/publications/requests | Responds with the HTTP methods allowed for the endpoint. |
| [**CreatePublicationRequest**](ProjectPublicationRequestApi.md#createpublicationrequest) | **POST** /api/v2/projects/{projectId}/publications/requests | Creates a new publication request. | | [**CreatePublicationRequest**](ProjectPublicationRequestApi.md#createpublicationrequest) | **POST** /api/v2/projects/{projectId}/publications/requests | Creates a new publication request. |
| [**GetPublicationRequest**](ProjectPublicationRequestApi.md#getpublicationrequest) | **GET** /api/v2/projects/{projectId}/publications/requests/{publicationRequestId} | Retrieves a publication request. |
<a id="apiv2projectsprojectidpublicationsrequestsoptions"></a> <a id="apiv2projectsprojectidpublicationsrequestsoptions"></a>
# **ApiV2ProjectsProjectIdPublicationsRequestsOptions** # **ApiV2ProjectsProjectIdPublicationsRequestsOptions**
...@@ -99,7 +100,7 @@ void (empty response body) ...@@ -99,7 +100,7 @@ void (empty response body)
<a id="createpublicationrequest"></a> <a id="createpublicationrequest"></a>
# **CreatePublicationRequest** # **CreatePublicationRequest**
> PublicationRequestForCreationDtoResponse CreatePublicationRequest (string projectId, PublicationRequestForCreationDto? publicationRequestForCreationDto = null) > ProjectPublicationRequestDtoResponse CreatePublicationRequest (string projectId, PublicationRequestForCreationDto? publicationRequestForCreationDto = null)
Creates a new publication request. Creates a new publication request.
...@@ -131,7 +132,7 @@ namespace Example ...@@ -131,7 +132,7 @@ namespace Example
try try
{ {
// Creates a new publication request. // Creates a new publication request.
PublicationRequestForCreationDtoResponse result = apiInstance.CreatePublicationRequest(projectId, publicationRequestForCreationDto); ProjectPublicationRequestDtoResponse result = apiInstance.CreatePublicationRequest(projectId, publicationRequestForCreationDto);
Debug.WriteLine(result); Debug.WriteLine(result);
} }
catch (ApiException e) catch (ApiException e)
...@@ -152,7 +153,7 @@ This returns an ApiResponse object which contains the response data, status code ...@@ -152,7 +153,7 @@ This returns an ApiResponse object which contains the response data, status code
try try
{ {
// Creates a new publication request. // Creates a new publication request.
ApiResponse<PublicationRequestForCreationDtoResponse> response = apiInstance.CreatePublicationRequestWithHttpInfo(projectId, publicationRequestForCreationDto); ApiResponse<ProjectPublicationRequestDtoResponse> response = apiInstance.CreatePublicationRequestWithHttpInfo(projectId, publicationRequestForCreationDto);
Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers); Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data); Debug.Write("Response Body: " + response.Data);
...@@ -174,7 +175,7 @@ catch (ApiException e) ...@@ -174,7 +175,7 @@ catch (ApiException e)
### Return type ### Return type
[**PublicationRequestForCreationDtoResponse**](PublicationRequestForCreationDtoResponse.md) [**ProjectPublicationRequestDtoResponse**](ProjectPublicationRequestDtoResponse.md)
### Authorization ### Authorization
...@@ -196,3 +197,102 @@ catch (ApiException e) ...@@ -196,3 +197,102 @@ catch (ApiException e)
[[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) [[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)
<a id="getpublicationrequest"></a>
# **GetPublicationRequest**
> ProjectPublicationRequestDtoResponse GetPublicationRequest (string projectId, Guid publicationRequestId)
Retrieves a publication request.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetPublicationRequestExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new ProjectPublicationRequestApi(config);
var projectId = "projectId_example"; // string | The ID of the project.
var publicationRequestId = "publicationRequestId_example"; // Guid | The ID of the publication request.
try
{
// Retrieves a publication request.
ProjectPublicationRequestDtoResponse result = apiInstance.GetPublicationRequest(projectId, publicationRequestId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ProjectPublicationRequestApi.GetPublicationRequest: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetPublicationRequestWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves a publication request.
ApiResponse<ProjectPublicationRequestDtoResponse> response = apiInstance.GetPublicationRequestWithHttpInfo(projectId, publicationRequestId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ProjectPublicationRequestApi.GetPublicationRequestWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **projectId** | **string** | The ID of the project. | |
| **publicationRequestId** | **Guid** | The ID of the publication request. | |
### Return type
[**ProjectPublicationRequestDtoResponse**](ProjectPublicationRequestDtoResponse.md)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the publication request. | - |
| **403** | User is missing authorization requirements. | - |
| **400** | Provided input has a bad format. | - |
| **404** | Publication request does not exist or has been deleted. | - |
[[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)
# Coscine.ApiClient.Core.Model.ProjectPublicationRequestDto
Represents a data transfer object (DTO) for a project publication request.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **Guid** | Unique identifier for the project publication request. | [optional]
**Project** | [**ProjectMinimalDto**](ProjectMinimalDto.md) | | [optional]
**PublicationServiceRorId** | **string** | Identifier for the publication service used for this request. | [optional]
**Creator** | [**UserMinimalDto**](UserMinimalDto.md) | | [optional]
**DateCreated** | **DateTime** | The date and time when the request was created. | [optional]
**Message** | **string** | Optional message associated with the publication request. | [optional]
**Resources** | [**List&lt;ResourceMinimalDto&gt;**](ResourceMinimalDto.md) | Collection of the resources involved in the publication request. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.PublicationRequestForCreationDtoResponse # Coscine.ApiClient.Core.Model.ProjectPublicationRequestDtoResponse
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**Data** | [**PublicationRequestForCreationDto**](PublicationRequestForCreationDto.md) | | [optional] **Data** | [**ProjectPublicationRequestDto**](ProjectPublicationRequestDto.md) | | [optional]
**IsSuccess** | **bool** | | [optional] [readonly] **IsSuccess** | **bool** | | [optional] [readonly]
**StatusCode** | **int?** | | [optional] **StatusCode** | **int?** | | [optional]
**TraceId** | **string** | | [optional] **TraceId** | **string** | | [optional]
......
...@@ -7,7 +7,7 @@ Name | Type | Description | Notes ...@@ -7,7 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**DisplayName** | **string** | The data publication service&#39;s display name. | **DisplayName** | **string** | The data publication service&#39;s display name. |
**Email** | **string** | The data publication service&#39;s email address. | **Email** | **string** | The data publication service&#39;s email address. |
**Text** | **string** | The data publication service&#39;s info text. | [optional] **Description** | **string** | The data publication service&#39;s description. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
...@@ -5,7 +5,7 @@ Data transfer object (DTO) representing the creation of a publication request. ...@@ -5,7 +5,7 @@ Data transfer object (DTO) representing the creation of a publication request.
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**DataPublicationServiceRorId** | **string** | The data publication service&#39;s ror id. | **PublicationServiceRorId** | **string** | The data publication service&#39;s ror id. |
**ResourceIds** | **List&lt;Guid&gt;** | The resource guids. | **ResourceIds** | **List&lt;Guid&gt;** | The resource guids. |
**Message** | **string** | A message of the requester. | [optional] **Message** | **string** | A message of the requester. | [optional]
......
...@@ -95,10 +95,11 @@ namespace Coscine.ApiClient.Core.Test.Api ...@@ -95,10 +95,11 @@ namespace Coscine.ApiClient.Core.Test.Api
//bool? topLevel = null; //bool? topLevel = null;
//bool? includeDeleted = null; //bool? includeDeleted = null;
//bool? includeQuotas = null; //bool? includeQuotas = null;
//bool? includePublicationRequests = null;
//int? pageSize = null; //int? pageSize = null;
//int? pageNumber = null; //int? pageNumber = null;
//string? orderBy = null; //string? orderBy = null;
//var response = instance.GetAllProjects(topLevel, includeDeleted, includeQuotas, pageSize, pageNumber, orderBy); //var response = instance.GetAllProjects(topLevel, includeDeleted, includeQuotas, includePublicationRequests, pageSize, pageNumber, orderBy);
//Assert.IsType<ProjectAdminDtoPagedResponse>(response); //Assert.IsType<ProjectAdminDtoPagedResponse>(response);
} }
......
...@@ -76,7 +76,20 @@ namespace Coscine.ApiClient.Core.Test.Api ...@@ -76,7 +76,20 @@ namespace Coscine.ApiClient.Core.Test.Api
//string projectId = null; //string projectId = null;
//PublicationRequestForCreationDto? publicationRequestForCreationDto = null; //PublicationRequestForCreationDto? publicationRequestForCreationDto = null;
//var response = instance.CreatePublicationRequest(projectId, publicationRequestForCreationDto); //var response = instance.CreatePublicationRequest(projectId, publicationRequestForCreationDto);
//Assert.IsType<PublicationRequestForCreationDtoResponse>(response); //Assert.IsType<ProjectPublicationRequestDtoResponse>(response);
}
/// <summary>
/// Test GetPublicationRequest
/// </summary>
[Fact]
public void GetPublicationRequestTest()
{
// TODO uncomment below to test the method and replace null with proper value
//string projectId = null;
//Guid publicationRequestId = null;
//var response = instance.GetPublicationRequest(projectId, publicationRequestId);
//Assert.IsType<ProjectPublicationRequestDtoResponse>(response);
} }
} }
} }
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
<TargetFramework>net8.0</TargetFramework> <TargetFramework>net8.0</TargetFramework>
<IsPackable>false</IsPackable> <IsPackable>false</IsPackable>
<Nullable>annotations</Nullable> <Nullable>annotations</Nullable>
<Version>1.9.2</Version></PropertyGroup> <Version>1.9.3</Version></PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
......
...@@ -252,5 +252,14 @@ namespace Coscine.ApiClient.Core.Test.Model ...@@ -252,5 +252,14 @@ namespace Coscine.ApiClient.Core.Test.Model
{ {
// TODO unit test for the property 'ProjectQuota' // TODO unit test for the property 'ProjectQuota'
} }
/// <summary>
/// Test the property 'PublicationRequests'
/// </summary>
[Fact]
public void PublicationRequestsTest()
{
// TODO unit test for the property 'PublicationRequests'
}
} }
} }
...@@ -23,21 +23,21 @@ using Newtonsoft.Json; ...@@ -23,21 +23,21 @@ using Newtonsoft.Json;
namespace Coscine.ApiClient.Core.Test.Model namespace Coscine.ApiClient.Core.Test.Model
{ {
/// <summary> /// <summary>
/// Class for testing PublicationRequestForCreationDtoResponse /// Class for testing ProjectPublicationRequestDtoResponse
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech).
/// Please update the test case below to test the model. /// Please update the test case below to test the model.
/// </remarks> /// </remarks>
public class PublicationRequestForCreationDtoResponseTests : IDisposable public class ProjectPublicationRequestDtoResponseTests : IDisposable
{ {
// TODO uncomment below to declare an instance variable for PublicationRequestForCreationDtoResponse // TODO uncomment below to declare an instance variable for ProjectPublicationRequestDtoResponse
//private PublicationRequestForCreationDtoResponse instance; //private ProjectPublicationRequestDtoResponse instance;
public PublicationRequestForCreationDtoResponseTests() public ProjectPublicationRequestDtoResponseTests()
{ {
// TODO uncomment below to create an instance of PublicationRequestForCreationDtoResponse // TODO uncomment below to create an instance of ProjectPublicationRequestDtoResponse
//instance = new PublicationRequestForCreationDtoResponse(); //instance = new ProjectPublicationRequestDtoResponse();
} }
public void Dispose() public void Dispose()
...@@ -46,13 +46,13 @@ namespace Coscine.ApiClient.Core.Test.Model ...@@ -46,13 +46,13 @@ namespace Coscine.ApiClient.Core.Test.Model
} }
/// <summary> /// <summary>
/// Test an instance of PublicationRequestForCreationDtoResponse /// Test an instance of ProjectPublicationRequestDtoResponse
/// </summary> /// </summary>
[Fact] [Fact]
public void PublicationRequestForCreationDtoResponseInstanceTest() public void ProjectPublicationRequestDtoResponseInstanceTest()
{ {
// TODO uncomment below to test "IsType" PublicationRequestForCreationDtoResponse // TODO uncomment below to test "IsType" ProjectPublicationRequestDtoResponse
//Assert.IsType<PublicationRequestForCreationDtoResponse>(instance); //Assert.IsType<ProjectPublicationRequestDtoResponse>(instance);
} }
/// <summary> /// <summary>
......
/*
* Coscine Web API
*
* Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
*
* The version of the OpenAPI document: 2.0
* Contact: servicedesk@itc.rwth-aachen.de
* Generated by: https://github.com/openapitools/openapi-generator.git
*/
using Xunit;
using System;
using System.Linq;
using System.IO;
using System.Collections.Generic;
using Coscine.ApiClient.Core.Model;
using Coscine.ApiClient.Core.Client;
using System.Reflection;
using Newtonsoft.Json;
namespace Coscine.ApiClient.Core.Test.Model
{
/// <summary>
/// Class for testing ProjectPublicationRequestDto
/// </summary>
/// <remarks>
/// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech).
/// Please update the test case below to test the model.
/// </remarks>
public class ProjectPublicationRequestDtoTests : IDisposable
{
// TODO uncomment below to declare an instance variable for ProjectPublicationRequestDto
//private ProjectPublicationRequestDto instance;
public ProjectPublicationRequestDtoTests()
{
// TODO uncomment below to create an instance of ProjectPublicationRequestDto
//instance = new ProjectPublicationRequestDto();
}
public void Dispose()
{
// Cleanup when everything is done.
}
/// <summary>
/// Test an instance of ProjectPublicationRequestDto
/// </summary>
[Fact]
public void ProjectPublicationRequestDtoInstanceTest()
{
// TODO uncomment below to test "IsType" ProjectPublicationRequestDto
//Assert.IsType<ProjectPublicationRequestDto>(instance);
}
/// <summary>
/// Test the property 'Id'
/// </summary>
[Fact]
public void IdTest()
{
// TODO unit test for the property 'Id'
}
/// <summary>
/// Test the property 'Project'
/// </summary>
[Fact]
public void ProjectTest()
{
// TODO unit test for the property 'Project'
}
/// <summary>
/// Test the property 'PublicationServiceRorId'
/// </summary>
[Fact]
public void PublicationServiceRorIdTest()
{
// TODO unit test for the property 'PublicationServiceRorId'
}
/// <summary>
/// Test the property 'Creator'
/// </summary>
[Fact]
public void CreatorTest()
{
// TODO unit test for the property 'Creator'
}
/// <summary>
/// Test the property 'DateCreated'
/// </summary>
[Fact]
public void DateCreatedTest()
{
// TODO unit test for the property 'DateCreated'
}
/// <summary>
/// Test the property 'Message'
/// </summary>
[Fact]
public void MessageTest()
{
// TODO unit test for the property 'Message'
}
/// <summary>
/// Test the property 'Resources'
/// </summary>
[Fact]
public void ResourcesTest()
{
// TODO unit test for the property 'Resources'
}
}
}
...@@ -74,12 +74,12 @@ namespace Coscine.ApiClient.Core.Test.Model ...@@ -74,12 +74,12 @@ namespace Coscine.ApiClient.Core.Test.Model
} }
/// <summary> /// <summary>
/// Test the property 'Text' /// Test the property 'Description'
/// </summary> /// </summary>
[Fact] [Fact]
public void TextTest() public void DescriptionTest()
{ {
// TODO unit test for the property 'Text' // TODO unit test for the property 'Description'
} }
} }
} }
...@@ -56,12 +56,12 @@ namespace Coscine.ApiClient.Core.Test.Model ...@@ -56,12 +56,12 @@ namespace Coscine.ApiClient.Core.Test.Model
} }
/// <summary> /// <summary>
/// Test the property 'DataPublicationServiceRorId' /// Test the property 'PublicationServiceRorId'
/// </summary> /// </summary>
[Fact] [Fact]
public void DataPublicationServiceRorIdTest() public void PublicationServiceRorIdTest()
{ {
// TODO unit test for the property 'DataPublicationServiceRorId' // TODO unit test for the property 'PublicationServiceRorId'
} }
/// <summary> /// <summary>
......
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<Description>A library generated from a OpenAPI doc</Description> <Description>A library generated from a OpenAPI doc</Description>
<Copyright>No Copyright</Copyright> <Copyright>No Copyright</Copyright>
<RootNamespace>Coscine.ApiClient.Core</RootNamespace> <RootNamespace>Coscine.ApiClient.Core</RootNamespace>
<Version>1.9.2</Version> <Version>1.9.3</Version>
<DocumentationFile>bin\$(Configuration)\$(TargetFramework)\Coscine.ApiClient.Core.xml</DocumentationFile> <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\Coscine.ApiClient.Core.xml</DocumentationFile>
<RepositoryUrl>https://github.com/GIT_USER_ID/GIT_REPO_ID.git</RepositoryUrl> <RepositoryUrl>https://github.com/GIT_USER_ID/GIT_REPO_ID.git</RepositoryUrl>
<RepositoryType>git</RepositoryType> <RepositoryType>git</RepositoryType>
......
...@@ -57,7 +57,8 @@ namespace Coscine.ApiClient.Core.Model ...@@ -57,7 +57,8 @@ namespace Coscine.ApiClient.Core.Model
/// <param name="projectResources">Collection of minimal project resource details associated with the project..</param> /// <param name="projectResources">Collection of minimal project resource details associated with the project..</param>
/// <param name="projectRoles">Collection of minimal project role details associated with the project..</param> /// <param name="projectRoles">Collection of minimal project role details associated with the project..</param>
/// <param name="projectQuota">Collection of project quotas associated with the project..</param> /// <param name="projectQuota">Collection of project quotas associated with the project..</param>
public ProjectAdminDto(Guid id = default(Guid), string pid = default(string), string name = default(string), string description = default(string), DateTime startDate = default(DateTime), DateTime endDate = default(DateTime), List<string> keywords = default(List<string>), string displayName = default(string), string principleInvestigators = default(string), string grantId = default(string), VisibilityDto visibility = default(VisibilityDto), List<DisciplineDto> disciplines = default(List<DisciplineDto>), List<OrganizationDto> organizations = default(List<OrganizationDto>), string slug = default(string), UserMinimalDto creator = default(UserMinimalDto), DateTime? creationDate = default(DateTime?), List<ProjectDto> subProjects = default(List<ProjectDto>), ProjectMinimalDto parent = default(ProjectMinimalDto), bool deleted = default(bool), List<ProjectResourceMinimalDto> projectResources = default(List<ProjectResourceMinimalDto>), List<ProjectRoleMinimalDto> projectRoles = default(List<ProjectRoleMinimalDto>), List<ProjectQuotaDto> projectQuota = default(List<ProjectQuotaDto>)) /// <param name="publicationRequests">Collection of project publication requests associated with the project..</param>
public ProjectAdminDto(Guid id = default(Guid), string pid = default(string), string name = default(string), string description = default(string), DateTime startDate = default(DateTime), DateTime endDate = default(DateTime), List<string> keywords = default(List<string>), string displayName = default(string), string principleInvestigators = default(string), string grantId = default(string), VisibilityDto visibility = default(VisibilityDto), List<DisciplineDto> disciplines = default(List<DisciplineDto>), List<OrganizationDto> organizations = default(List<OrganizationDto>), string slug = default(string), UserMinimalDto creator = default(UserMinimalDto), DateTime? creationDate = default(DateTime?), List<ProjectDto> subProjects = default(List<ProjectDto>), ProjectMinimalDto parent = default(ProjectMinimalDto), bool deleted = default(bool), List<ProjectResourceMinimalDto> projectResources = default(List<ProjectResourceMinimalDto>), List<ProjectRoleMinimalDto> projectRoles = default(List<ProjectRoleMinimalDto>), List<ProjectQuotaDto> projectQuota = default(List<ProjectQuotaDto>), List<ProjectPublicationRequestDto> publicationRequests = default(List<ProjectPublicationRequestDto>))
{ {
this.Id = id; this.Id = id;
this.Pid = pid; this.Pid = pid;
...@@ -81,6 +82,7 @@ namespace Coscine.ApiClient.Core.Model ...@@ -81,6 +82,7 @@ namespace Coscine.ApiClient.Core.Model
this.ProjectResources = projectResources; this.ProjectResources = projectResources;
this.ProjectRoles = projectRoles; this.ProjectRoles = projectRoles;
this.ProjectQuota = projectQuota; this.ProjectQuota = projectQuota;
this.PublicationRequests = publicationRequests;
} }
/// <summary> /// <summary>
...@@ -234,6 +236,13 @@ namespace Coscine.ApiClient.Core.Model ...@@ -234,6 +236,13 @@ namespace Coscine.ApiClient.Core.Model
[DataMember(Name = "projectQuota", EmitDefaultValue = false)] [DataMember(Name = "projectQuota", EmitDefaultValue = false)]
public List<ProjectQuotaDto> ProjectQuota { get; set; } public List<ProjectQuotaDto> ProjectQuota { get; set; }
/// <summary>
/// Collection of project publication requests associated with the project.
/// </summary>
/// <value>Collection of project publication requests associated with the project.</value>
[DataMember(Name = "publicationRequests", EmitDefaultValue = false)]
public List<ProjectPublicationRequestDto> PublicationRequests { get; set; }
/// <summary> /// <summary>
/// Returns the string presentation of the object /// Returns the string presentation of the object
/// </summary> /// </summary>
...@@ -264,6 +273,7 @@ namespace Coscine.ApiClient.Core.Model ...@@ -264,6 +273,7 @@ namespace Coscine.ApiClient.Core.Model
sb.Append(" ProjectResources: ").Append(ProjectResources).Append("\n"); sb.Append(" ProjectResources: ").Append(ProjectResources).Append("\n");
sb.Append(" ProjectRoles: ").Append(ProjectRoles).Append("\n"); sb.Append(" ProjectRoles: ").Append(ProjectRoles).Append("\n");
sb.Append(" ProjectQuota: ").Append(ProjectQuota).Append("\n"); sb.Append(" ProjectQuota: ").Append(ProjectQuota).Append("\n");
sb.Append(" PublicationRequests: ").Append(PublicationRequests).Append("\n");
sb.Append("}\n"); sb.Append("}\n");
return sb.ToString(); return sb.ToString();
} }
......