1. Overview

Microservice containing the business logic for managing document-management-service.

1.1. Version information

Version : 2.0

1.2. URI scheme

Host : localhost
BasePath : /

1.3. Tags

  • document-controller : Document Controller

  • document-reference-controller : Document Reference Controller

2. Resources

2.1. Document-controller

Document Controller

2.1.1. Create Metadata / Create revision

POST /v2.0/documents
Parameters
Type Name Description Schema

Query

clientId
required

client identifier

string

Body

documentMetaInfo
required

JSON input for document metadata creation or revision

string
Responses
HTTP Code Description Schema

201

Created

object

404

Not Found

Api error

409

Conflict

Api error

422

Unprocessable Entity

Api error
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.2. Get documents

GET /v2.0/documents
Parameters
Type Name Description Schema Default

Query

clientId
required

client identifier

string

Query

documentId
optional

input can be document id / Couch URL / external URL

string

Query

page
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

404

Not Found

Api error

409

Conflict

Api error

422

Unprocessable Entity

Api error
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.3. Upload document

PUT /v2.0/documents
Parameters
Type Name Description Schema

Query

clientId
required

client identifier

string

Query

docId
required

docId

string

Query

fileName
optional

fileName

string

Query

rev
required

rev

string

FormData

file
required

file

file
Responses
HTTP Code Description Schema

201

Created

object

404

Not Found

Api error

409

Conflict

Api error

422

Unprocessable Entity

Api error
Consumes

  • multipart/form-data

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.4. Get document

GET /v2.0/documents/attachment
Parameters
Type Name Description Schema

Query

attachmentName
optional

attachmentName (required if documentId is not null)

string

Query

clientId
required

client identifier

string

Query

documentId
required

input can be document id / Couch URL

string
Responses
HTTP Code Description Schema

200

OK

ByteArray

404

Not Found

Api error

409

Conflict

Api error

422

Unprocessable Entity

Api error
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.5. Get revisions

GET /v2.0/documents/{initialId}
Parameters
Type Name Description Schema

Path

initialId
required

initial id

string

Query

clientId
required

client identifier

string
Responses
HTTP Code Description Schema

200

OK

< object > array

404

Not Found

Api error

409

Conflict

Api error

422

Unprocessable Entity

Api error
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2. Document-reference-controller

Document Reference Controller

2.2.1. Create document reference

POST /v2.0/references
Parameters
Type Name Description Schema

Query

clientId
required

clientId

string

Body

documentReference
required

Json input for document reference creation

string
Responses
HTTP Code Description Schema

201

Created

object

400

Bad Request

Api error

401

Unauthorized

Api error

422

Unprocessable Entity

Api error
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

3. Definitions

3.1. Api error

Http Error response.

Name Schema

errorCode
optional

string

message
optional

string

requestPath
optional

string

status
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

subErrors
optional

ApiSubError

3.2. ApiSubError

Name Schema

errorCode
optional

string

field
optional

string

message
optional

string

value
optional

object

3.3. ByteArray

Type : object

4. Security

4.1. access_token

Type : oauth2
Flow : accessCode
Token URL : https://10.181.213.234/uaa/oauth/authorize
Token URL : https://10.181.213.234/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

Type : oauth2
Flow : password
Token URL : https://10.181.213.234/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : https://10.181.213.234/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : https://10.181.213.234/uaa/oauth/token

Name Description

default

Default oauth2 scope.