TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

Blob Attachments Microservice

This is a blob attachments microservice from Pip.Services library. It records all documents that attached to a particilar blob. When last document is disattached, the blob gets removed.

The microservice currently supports the following deployment options:

  • Deployment platforms: Standalone Process, Seneca Plugin
  • External APIs: HTTP/REST, Seneca
  • Persistence: Memory, Flat Files, MongoDB

This microservice has no dependencies on other microservices.

Quick Links:


Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Thrift, Seneca, Lambda, etc.), please, refer to documentation of the specific protocol.

class BlobAttachmentV1 implements IStringIdentifiable {
    public id: string;
    public references: ReferenceV1[];

class ReferenceV1
    public id: string;
    public type: string;
    public name: string;

interface IAttachmentsV1 {
    getAttachmentById(correlationId: string, id: string): Promise<BlobAttachmentV1>;
    addAttachments(correlationId: string, reference: ReferenceV1, ids: string[]): Promise<BlobAttachmentV1[]>;

    updateAttachments(correlationId: string, reference: ReferenceV1, oldIds: string[], newIds: string[]): Promise<BlobAttachmentV1[]>;

    removeAttachments(correlationId: string, reference: ReferenceV1, ids: string[]): Promise<BlobAttachmentV1[]>;

    deleteAttachmentById(correlationId: string, id: string): Promise<BlobAttachmentV1>;


Right now the only way to get the microservice is to check it out directly from github repository

git clone

Pip.Service team is working to implement packaging and make stable releases available for your as zip downloadable archieves.


Add config.json file to the root of the microservice folder and set configuration parameters. As the starting point you can use example configuration from config.example.yml file.

Example of microservice configuration

- descriptor: "pip-services-container:container-info:default:default:1.0"
  name: "service-attachments"
  description: "Attachments microservice"

- descriptor: "pip-services-commons:logger:console:default:1.0"
  level: "trace"

- descriptor: "service-attachments:persistence:file:default:1.0"
  path: "./data/attachments.json"

- descriptor: "service-attachments:controller:default:default:1.0"

- descriptor: "service-attachments:service:http:default:1.0"
    protocol: "http"
    host: ""
    port: 8080

For more information on the microservice configuration see Configuration Guide.

Start the microservice using the command:

node run


The easiest way to work with the microservice is to use client SDK. The complete list of available client SDKs for different languages is listed in the Quick Links

If you use Node.js then you should add dependency to the client SDK into package.json file of your project

    dependencies: {
        "client-attachments-node": "^1.0.*"

Inside your code get the reference to the client SDK

var sdk = new require('client-attachments-node');

Define client configuration parameters that match configuration of the microservice external API

// Client configuration
var config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.AttachmentsHttpClientV1(config);

// Connect to the microservice
try {
    // Work with the microservice
} catch(err) {
    console.error('Connection to the microservice failed');

Now the client is ready to perform operations

// Log system event
let attachments = await client.addAttachments(
        id: '1',
        type: 'document',
        name: 'my_document'
    ['1', '2', '3']
var now = new Date();

// Get the list system events
let attachment = await client.getAttachmentById(


This microservice was created and currently maintained by Sergey Seroukhov.

Package Sidebar


npm i service-attachments-node

Weekly Downloads






Unpacked Size

147 kB

Total Files


Last publish


  • pipdeveloper