Skip to content

LibrariesApi

Víctor Cañizares edited this page Dec 14, 2020 · 1 revision

LibrariesApi

All URIs are relative to https://demo.iriusrisk.com/api/v1

Method HTTP request Description
librariesLibraryRefDelete DELETE /libraries/{libraryRef} Deletes a Library
librariesLibraryRefGet GET /libraries/{libraryRef} Gets library details
librariesLibraryRefRiskpatternsPost POST /libraries/{libraryRef}/riskpatterns Creates new Risk Pattern
librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/countermeasures Creates new countermeasure in a risk pattern
librariesLibraryRefRiskpatternsRiskPatternRefDelete DELETE /libraries/{libraryRef}/riskpatterns/{riskPatternRef} Deletes a Risk Pattern
librariesLibraryRefRiskpatternsRiskPatternRefGet GET /libraries/{libraryRef}/riskpatterns/{riskPatternRef} Gets Risk Pattern details
librariesLibraryRefRiskpatternsRiskPatternRefUsecasesPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases Creates new use case in a library.
librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats Creates a new threat in a library.
librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/countermeasures Associates a countermeasure to a threat in a risk pattern.
librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses Associates weakness to a threat in a risk pattern.
librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses/{weaknessRef}/countermeasures Associates a countermeasure to a weakness in a risk pattern.
librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/weaknesses Creates a new weakness in a risk pattern
librariesPost POST /libraries Creates a Library
productsUploadPost POST /products/upload Creates a new product, library or template from a XML file upload.

librariesLibraryRefDelete

librariesLibraryRefDelete(apiToken, libraryRef)

Deletes a Library

Deletes a library. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
try {
    apiInstance.librariesLibraryRefDelete(apiToken, libraryRef);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

librariesLibraryRefGet

Library librariesLibraryRefGet(apiToken, libraryRef)

Gets library details

Gets the library details. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
try {
    Library result = apiInstance.librariesLibraryRefGet(apiToken, libraryRef);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library

Return type

Library

Authorization

No authorization required

HTTP request headers

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

librariesLibraryRefRiskpatternsPost

RiskPattern librariesLibraryRefRiskpatternsPost(apiToken, libraryRef, createRiskPatternRequestBody)

Creates new Risk Pattern

Creates new Risk Pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
CreateRiskPatternRequestBody createRiskPatternRequestBody = new CreateRiskPatternRequestBody(); // CreateRiskPatternRequestBody | JSON data that contains information of the fields
try {
    RiskPattern result = apiInstance.librariesLibraryRefRiskpatternsPost(apiToken, libraryRef, createRiskPatternRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefRiskpatternsPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
createRiskPatternRequestBody CreateRiskPatternRequestBody JSON data that contains information of the fields

Return type

RiskPattern

Authorization

No authorization required

HTTP request headers

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

librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost

LibraryControl librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost(apiToken, libraryRef, riskPatternRef, createCountermeasureLibraryRequestBody)

Creates new countermeasure in a risk pattern

Creates new countermeasure in a risk pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
ControlCommand createCountermeasureLibraryRequestBody = new ControlCommand(); // ControlCommand | JSON data that contains information of the fields
try {
    LibraryControl result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost(apiToken, libraryRef, riskPatternRef, createCountermeasureLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern
createCountermeasureLibraryRequestBody ControlCommand JSON data that contains information of the fields

Return type

LibraryControl

Authorization

No authorization required

HTTP request headers

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

librariesLibraryRefRiskpatternsRiskPatternRefDelete

librariesLibraryRefRiskpatternsRiskPatternRefDelete(apiToken, libraryRef, riskPatternRef)

Deletes a Risk Pattern

Deletes a Risk Pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
try {
    apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefDelete(apiToken, libraryRef, riskPatternRef);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefRiskpatternsRiskPatternRefDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

librariesLibraryRefRiskpatternsRiskPatternRefGet

RiskPattern librariesLibraryRefRiskpatternsRiskPatternRefGet(apiToken, libraryRef, riskPatternRef)

Gets Risk Pattern details

Gets Risk Pattern details. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
try {
    RiskPattern result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefGet(apiToken, libraryRef, riskPatternRef);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefRiskpatternsRiskPatternRefGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern

Return type

RiskPattern

Authorization

No authorization required

HTTP request headers

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

librariesLibraryRefRiskpatternsRiskPatternRefUsecasesPost

LibraryUseCase librariesLibraryRefRiskpatternsRiskPatternRefUsecasesPost(apiToken, libraryRef, riskPatternRef, createUseCaseLibraryRequestBody)

Creates new use case in a library.

Creates new use case in a library. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
CreateUseCaseLibraryRequestBody createUseCaseLibraryRequestBody = new CreateUseCaseLibraryRequestBody(); // CreateUseCaseLibraryRequestBody | JSON data that contains information of the fields
try {
    LibraryUseCase result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefUsecasesPost(apiToken, libraryRef, riskPatternRef, createUseCaseLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefRiskpatternsRiskPatternRefUsecasesPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern
createUseCaseLibraryRequestBody CreateUseCaseLibraryRequestBody JSON data that contains information of the fields

Return type

LibraryUseCase

Authorization

No authorization required

HTTP request headers

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

librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsPost

LibraryThreat librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsPost(apiToken, libraryRef, riskPatternRef, useCaseRef, createThreatLibraryRequestBody)

Creates a new threat in a library.

Creates a new threat in a library. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
String useCaseRef = "useCaseRef_example"; // String | Reference for Use Case
CreateThreatLibraryRequestBody createThreatLibraryRequestBody = new CreateThreatLibraryRequestBody(); // CreateThreatLibraryRequestBody | JSON data that contains information of the fields
try {
    LibraryThreat result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsPost(apiToken, libraryRef, riskPatternRef, useCaseRef, createThreatLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern
useCaseRef String Reference for Use Case
createThreatLibraryRequestBody CreateThreatLibraryRequestBody JSON data that contains information of the fields

Return type

LibraryThreat

Authorization

No authorization required

HTTP request headers

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

librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefCountermeasuresPut

LibraryControl librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefCountermeasuresPut(apiToken, libraryRef, riskPatternRef, useCaseRef, threatRef, associateCountermeasureThreatLibraryRequestBody)

Associates a countermeasure to a threat in a risk pattern.

Associates a countermeasure to a threat in a risk pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
String useCaseRef = "useCaseRef_example"; // String | Reference for Use Case
String threatRef = "threatRef_example"; // String | Reference for Threat
AssociateCountermeasureThreatLibraryRequestBody associateCountermeasureThreatLibraryRequestBody = new AssociateCountermeasureThreatLibraryRequestBody(); // AssociateCountermeasureThreatLibraryRequestBody | JSON data that contains information of the fields
try {
    LibraryControl result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefCountermeasuresPut(apiToken, libraryRef, riskPatternRef, useCaseRef, threatRef, associateCountermeasureThreatLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefCountermeasuresPut");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern
useCaseRef String Reference for Use Case
threatRef String Reference for Threat
associateCountermeasureThreatLibraryRequestBody AssociateCountermeasureThreatLibraryRequestBody JSON data that contains information of the fields

Return type

LibraryControl

Authorization

No authorization required

HTTP request headers

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

librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut

LibraryWeakness librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut(apiToken, libraryRef, riskPatternRef, useCaseRef, threatRef, associateWeaknessThreatLibraryRequestBody)

Associates weakness to a threat in a risk pattern.

Associates weakness to a threat in a risk pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
String useCaseRef = "useCaseRef_example"; // String | Reference for Use Case
String threatRef = "threatRef_example"; // String | Reference for Threat
AssociateWeaknessThreatLibraryRequestBody associateWeaknessThreatLibraryRequestBody = new AssociateWeaknessThreatLibraryRequestBody(); // AssociateWeaknessThreatLibraryRequestBody | JSON data that contains information of the fields
try {
    LibraryWeakness result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut(apiToken, libraryRef, riskPatternRef, useCaseRef, threatRef, associateWeaknessThreatLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern
useCaseRef String Reference for Use Case
threatRef String Reference for Threat
associateWeaknessThreatLibraryRequestBody AssociateWeaknessThreatLibraryRequestBody JSON data that contains information of the fields

Return type

LibraryWeakness

Authorization

No authorization required

HTTP request headers

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

librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut

LibraryControl librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut(apiToken, libraryRef, riskPatternRef, useCaseRef, threatRef, weaknessRef, associateCountermeasureWeaknessLibraryRequestBody)

Associates a countermeasure to a weakness in a risk pattern.

Associates a countermeasure to a weakness in a risk pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
String useCaseRef = "useCaseRef_example"; // String | Reference for Use Case
String threatRef = "threatRef_example"; // String | Reference for Threat
String weaknessRef = "weaknessRef_example"; // String | Reference for Weakness
AssociateCountermeasureWeaknessLibraryRequestBody associateCountermeasureWeaknessLibraryRequestBody = new AssociateCountermeasureWeaknessLibraryRequestBody(); // AssociateCountermeasureWeaknessLibraryRequestBody | JSON data that contains information of the fields
try {
    LibraryControl result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut(apiToken, libraryRef, riskPatternRef, useCaseRef, threatRef, weaknessRef, associateCountermeasureWeaknessLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern
useCaseRef String Reference for Use Case
threatRef String Reference for Threat
weaknessRef String Reference for Weakness
associateCountermeasureWeaknessLibraryRequestBody AssociateCountermeasureWeaknessLibraryRequestBody JSON data that contains information of the fields

Return type

LibraryControl

Authorization

No authorization required

HTTP request headers

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

librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost

LibraryWeakness librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost(apiToken, libraryRef, riskPatternRef, createWeaknessLibraryRequestBody)

Creates a new weakness in a risk pattern

Creates a new Weakness in a risk pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
CreateWeaknessLibraryRequestBody createWeaknessLibraryRequestBody = new CreateWeaknessLibraryRequestBody(); // CreateWeaknessLibraryRequestBody | JSON data that contains information of the fields
try {
    LibraryWeakness result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost(apiToken, libraryRef, riskPatternRef, createWeaknessLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern
createWeaknessLibraryRequestBody CreateWeaknessLibraryRequestBody JSON data that contains information of the fields

Return type

LibraryWeakness

Authorization

No authorization required

HTTP request headers

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

librariesPost

Library librariesPost(apiToken, createLibraryRequestBody)

Creates a Library

Creates a new empty Library. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
CreateLibraryRequestBody createLibraryRequestBody = new CreateLibraryRequestBody(); // CreateLibraryRequestBody | JSON data that contains information of the fields
try {
    Library result = apiInstance.librariesPost(apiToken, createLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#librariesPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
createLibraryRequestBody CreateLibraryRequestBody JSON data that contains information of the fields

Return type

Library

Authorization

No authorization required

HTTP request headers

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

productsUploadPost

ProductShort productsUploadPost(apiToken, ref, name, fileName, type)

Creates a new product, library or template from a XML file upload.

Creates a new product, library or template from a XML file upload. Conditions to be able to perform the action: - To have the permission PRODUCT_CREATE granted allows to create a product. - To have the permission LIBRARY_UPDATE granted allows to create a library. - To have the permission TEMPLATE_UPDATE granted allows to create a template.

Example

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


LibrariesApi apiInstance = new LibrariesApi();
String apiToken = "apiToken_example"; // String | Authentication token
String ref = "ref_example"; // String | Product ref
String name = "name_example"; // String | Product name
File fileName = new File("/path/to/file.txt"); // File | File to upload in XML format
String type = "type_example"; // String | Product type - STANDARD (By default), TEMPLATE or LIBRARY
try {
    ProductShort result = apiInstance.productsUploadPost(apiToken, ref, name, fileName, type);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibrariesApi#productsUploadPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
ref String Product ref
name String Product name
fileName File File to upload in XML format
type String Product type - STANDARD (By default), TEMPLATE or LIBRARY [optional]

Return type

ProductShort

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json
Clone this wiki locally