Skip to content

Latest commit

 

History

History
337 lines (243 loc) · 10.6 KB

ConfigApi.md

File metadata and controls

337 lines (243 loc) · 10.6 KB

ConfigApi

All URIs are relative to https://gw.api.cloud.sphereon.com/pdf/stamp/1.0

Method HTTP request Description
createConfiguration POST /config Create PDF stamper configuration
deleteConfiguration DELETE /config/{configId} Delete PDF stamper configuration
deleteResources DELETE /config/{configId}/streams Delete resources
getConfiguration GET /config/{configId} Get PDF stamper configuration
updateConfiguration PUT /config/{configId} Update PDF stamper configuration
uploadResource POST /config/{configId}/streams/multipart Upload a configuration resource

createConfiguration

StamperConfigResponse createConfiguration(stampConfiguration)

Create PDF stamper configuration

Create / initialize a new PDF stamper configuration.

Example

// Import classes:
//import com.sphereon.sdk.pdf.stamper.handler.ApiClient;
//import com.sphereon.sdk.pdf.stamper.handler.ApiException;
//import com.sphereon.sdk.pdf.stamper.handler.Configuration;
//import com.sphereon.sdk.pdf.stamper.handler.auth.*;
//import com.sphereon.sdk.pdf.stamper.api.ConfigApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2schema
OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

ConfigApi apiInstance = new ConfigApi();
StamperConfig stampConfiguration = new StamperConfig(); // StamperConfig | The PDF stamper configuration
try {
    StamperConfigResponse result = apiInstance.createConfiguration(stampConfiguration);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigApi#createConfiguration");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
stampConfiguration StamperConfig The PDF stamper configuration

Return type

StamperConfigResponse

Authorization

oauth2schema

HTTP request headers

  • Content-Type: application/json;charset=UTF-8
  • Accept: application/json;charset=UTF-8

deleteConfiguration

StamperConfigResponse deleteConfiguration(configId)

Delete PDF stamper configuration

Delete a PDF stamper configuration.

Example

// Import classes:
//import com.sphereon.sdk.pdf.stamper.handler.ApiClient;
//import com.sphereon.sdk.pdf.stamper.handler.ApiException;
//import com.sphereon.sdk.pdf.stamper.handler.Configuration;
//import com.sphereon.sdk.pdf.stamper.handler.auth.*;
//import com.sphereon.sdk.pdf.stamper.api.ConfigApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2schema
OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

ConfigApi apiInstance = new ConfigApi();
String configId = "configId_example"; // String | The PDF stamper configuration id
try {
    StamperConfigResponse result = apiInstance.deleteConfiguration(configId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigApi#deleteConfiguration");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
configId String The PDF stamper configuration id

Return type

StamperConfigResponse

Authorization

oauth2schema

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=UTF-8

deleteResources

deleteResources(configId, streamLocations)

Delete resources

Delete resources referenced by a configuration.

Example

// Import classes:
//import com.sphereon.sdk.pdf.stamper.handler.ApiClient;
//import com.sphereon.sdk.pdf.stamper.handler.ApiException;
//import com.sphereon.sdk.pdf.stamper.handler.Configuration;
//import com.sphereon.sdk.pdf.stamper.handler.auth.*;
//import com.sphereon.sdk.pdf.stamper.api.ConfigApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2schema
OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

ConfigApi apiInstance = new ConfigApi();
String configId = "configId_example"; // String | The PDF stamper configuration id
List<StreamLocation> streamLocations = Arrays.asList(new StreamLocation()); // List<StreamLocation> | The resource locations in storage
try {
    apiInstance.deleteResources(configId, streamLocations);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigApi#deleteResources");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
configId String The PDF stamper configuration id
streamLocations List<StreamLocation> The resource locations in storage

Return type

null (empty response body)

Authorization

oauth2schema

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

getConfiguration

StamperConfigResponse getConfiguration(configId)

Get PDF stamper configuration

Retrieve a PDF stamper configuration.

Example

// Import classes:
//import com.sphereon.sdk.pdf.stamper.handler.ApiClient;
//import com.sphereon.sdk.pdf.stamper.handler.ApiException;
//import com.sphereon.sdk.pdf.stamper.handler.Configuration;
//import com.sphereon.sdk.pdf.stamper.handler.auth.*;
//import com.sphereon.sdk.pdf.stamper.api.ConfigApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2schema
OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

ConfigApi apiInstance = new ConfigApi();
String configId = "configId_example"; // String | The PDF stamper configuration id
try {
    StamperConfigResponse result = apiInstance.getConfiguration(configId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigApi#getConfiguration");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
configId String The PDF stamper configuration id

Return type

StamperConfigResponse

Authorization

oauth2schema

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=UTF-8

updateConfiguration

StamperConfigResponse updateConfiguration(configId, stampConfiguration)

Update PDF stamper configuration

Update an existing PDF stamper configuration.

Example

// Import classes:
//import com.sphereon.sdk.pdf.stamper.handler.ApiClient;
//import com.sphereon.sdk.pdf.stamper.handler.ApiException;
//import com.sphereon.sdk.pdf.stamper.handler.Configuration;
//import com.sphereon.sdk.pdf.stamper.handler.auth.*;
//import com.sphereon.sdk.pdf.stamper.api.ConfigApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2schema
OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

ConfigApi apiInstance = new ConfigApi();
String configId = "configId_example"; // String | The PDF stamper configuration id
StamperConfig stampConfiguration = new StamperConfig(); // StamperConfig | The PDF stamper configuration
try {
    StamperConfigResponse result = apiInstance.updateConfiguration(configId, stampConfiguration);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigApi#updateConfiguration");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
configId String The PDF stamper configuration id
stampConfiguration StamperConfig The PDF stamper configuration

Return type

StamperConfigResponse

Authorization

oauth2schema

HTTP request headers

  • Content-Type: application/json;charset=UTF-8
  • Accept: application/json;charset=UTF-8

uploadResource

StreamLocation uploadResource(configId, stream)

Upload a configuration resource

Upload a resource needed by a configuration.

Example

// Import classes:
//import com.sphereon.sdk.pdf.stamper.handler.ApiClient;
//import com.sphereon.sdk.pdf.stamper.handler.ApiException;
//import com.sphereon.sdk.pdf.stamper.handler.Configuration;
//import com.sphereon.sdk.pdf.stamper.handler.auth.*;
//import com.sphereon.sdk.pdf.stamper.api.ConfigApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2schema
OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

ConfigApi apiInstance = new ConfigApi();
String configId = "configId_example"; // String | configId
File stream = new File("/path/to/file.txt"); // File | The resource data
try {
    StreamLocation result = apiInstance.uploadResource(configId, stream);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigApi#uploadResource");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
configId String configId
stream File The resource data

Return type

StreamLocation

Authorization

oauth2schema

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json;charset=UTF-8