Library

Get All Libraries

GET [ENADOC_URL] /api/v3/libraries

Pre-requisites from Enadoc: You must have created libraries under your Enadoc organization The request headers consist of access token and Request body is not required here.

Headers

Name	Type	Description
Authorization	string	Type : Bearer Access token should be sent in request headers

200 List of accessible libraries

[{
  "id":1,
  "name":"General",
  "color":"ff4366"
 },
 {
  "id":2,
  "name":"HR",
  "color":"7da7d9"
 }]

Get Specific Library

GET [ENADOC_URL]/api/v3/libraries/{libraryId}

Use this API to get the details of a specific library that user can access

Path Parameters

Name	Type	Description
libraryId	integer	ID of the library

Headers

Name	Type	Description
Authorization	string	Type : Bearer Access token should be sent in request headers

200 If the request proceeds successfully, you will receive status code 200 with the details of the requested library. The details consist of library id, library name and library color.

{
  "id": 1,
  "name": "General",
  "color": "ff4366"
}

Errors

Error code	Error	Error description	Reason
003.000	No accessible libraries	User has no accessible libraries	No libraries assigned to requested user or No libraries created
003.001	Invalid library id	Library id is invalid	Sent invalid library id by requester
003.002	Inactive library	Library is inactive	Library status is inactive

Get Tag Profiles from a Library

GET [ENADOC_URL]/api/v3/libraries/{libraryId}/tagprofiles

Tag profiles are required to upload documents from different security levels and document permissions

Path Parameters

Name	Type	Description
libraryId	integer	Library ID

Headers

Name	Type	Description
Authorization	string	Type : Bearer Access token should be sent in request headers

200 If the request proceeds successfully, you will receive status code 200 with the details of tag profiles of the given specific library. The tag profile details consist of tag profile id, tag profile name, library id, library name, tag profile color, is default status (true/false). The tag profile color gets the color of library which it belongs to.

{
  "id": 1,
  "name": "General Tag Profile",
  "libraryId": 1,
  "libraryName": "HR",
  "color": "ff4366",
  "isDefault": true
}

Errors

Error code	Error	Error description	Reason
003.000	No accessible libraries	User has no accessible libraries	No libraries assigned to requested user or No libraries created
003.001	Invalid library id	Library id is invalid	Sent invalid library id by requester
003.002	Inactive library	Library is inactive	Library status is inactive

Get Flags from a Library

GET [ENADOC_URL]/api/v3/libraries/{libraryId}/flags

Pre-requisites from Enadoc: You must have created flag/s under requested library. Flags are used to search documents in Enadoc tag cloud.

Path Parameters

Name	Type	Description
libraryId	integer	Library ID

Headers

Name	Type	Description
Authorization	string	Type : Bearer Access token should be sent in request headers

200 If the request process successfully, you will receive status code 200 with the details of all flags belongs to the given specific library. The flag details consist of flag id and flag.

[
  {
    "id": 1,
    "flag": "Document Should Be Deleted"
  },
  {
    "id": 2,
    "flag": "Do not delete"
  }
]

Get Specific Flag from Library

GET [ENADOC_URL]/api/v3/libraries/{libraryId}/flags/{flagId}

Pre-requisites from Enadoc - You must have created flags under requested library.

Path Parameters

Name	Type	Description
libraryId	integer	Library ID
flagId	integer	Flag ID

Headers

Name	Type	Description
Authorization	string	Type: Bearer Access token should be sent in request headers

200 If the request process successfully, you will receive status code 200 with the details of all flags, belongs to the given specific flag Id. The flag details consists of flag Id and flag.

{
  "id": 1,
  "flag": "Document Should Be Deleted"
}

Create New Flag for Library

POST [ENADOC_URL]/api/v3/libraries/{libraryId}/flags

Pre-requisites from Enadoc - You must have created libraries in your Enadoc organization.

Path Parameters

Name	Type	Description
libraryId	integer	Library Id

Headers

Name	Type	Description
Authorization	string	Type- Bearer Access token should be sent in request headers

Request Body

Name	Type	Description
flag	string	Type - Application JSON Request body should contain the flag. Follow the format given in the code block below.

200 If the request process successfully, you will receive status code 201 with the details of newly created flag to the given specific library. The flag details consist of flag id and flag.

{
  "id": 1,
  "flag": "Document Should Be Deleted"
}

Follow the format given in the code block to send the flag as the body parameter of API request.

"Do not delete"

Get All User Tags from Library

GET [ENADOC_URL]/api/v3/libraries/{libraryId}/usertags

Pre-requisites from Enadoc - You must have created user tags under the given library. User tags used to search documents in Enadoc tag cloud.

Path Parameters

Name	Type	Description
libraryId	integer	Library Id

Headers

Name	Type	Description
Authorization	string	Type: Bearer Access token should be sent in request headers

200 If the request process successfully, you will receive status code 200 with the details of all user tags belongs to the given specific library. The user tags details consist of user tag id, user tag name and user tag color.

[
  {
    "id": 1,
    "tag": "tag1",
    "color": "7da7d9"
  },
  {
    "id": 2,
    "tag": "tag2",
    "color": "7da7d9"
  }
]

Get Specific User Tag from Library

GET [ENADOC_URL]/api/v3/libraries/{libraryId}/usertags/{userTagId}

Pre-requisites from Enadoc - You must have created the requested user tags under given library.

Path Parameters

Name	Type	Description
libraryId	integer	Library Id
userTagId	integer	User Tag Id

Headers

Name	Type	Description
Authorization	string	Type- Bearer Access token should be sent in request headers

200 If the request process successfully, you will receive status code 200 with the details of requested user tag belongs to the given specific library. The flag details consist of user tag id, user tag and user tag color.

{
  "id": 1,
  "tag": "tag1",
  "color": "7da7d9"
}

Create User Tags

POST [ENADOC_URL]api/v3/libraries/{libraryId}/usertags

Pre-requisites from Enadoc - You must have created libraries in your Enadoc organization

Path Parameters

Name	Type	Description
libraryId	integer	Library Id

Headers

Name	Type	Description
Authorization	string	Type - Bearer Access token should be sent in requests headers

Request Body

Name	Type	Description
userTag *	string	Content Type- Application/JSON Request Body should contain user tag. Follow the format given in the code block below Ex: "UserTag_Department"

201 If request proceed successfully, you will receive status code 201. Response consists of the details of newly created user tag. The user tags details consist of user tag id, user tag name and user tag color.

{
  "id": 1,
  "tag": "tag1",
  "color": "7da7d9"
}

Follow the format given in the code block to send the user tag as the body parameter of API request.

"UserTag_Department" 

Index Search

POST [ENADOC_URL]api/v3/libraries/{libraryId}/documents/$search

Pre-requisites from Enadoc - You must have uploaded documents in the given library. Advanced search is functioning here. You can search documents from the specific library by index with values. Each search will have hundred results count. Default 1 to 100 results will be sent this end point.

Path Parameters

Name	Type	Description
libraryId	integer	Library Id

Query Parameters

Name	Type	Description
from	integer	Start point of results
to	integer	End point of results

Headers

Name	Type	Description
Authorization	string	Type - Bearer Access token should be sent in the request headers

Request Body

Name	Type	Description
Search Indexes	object	Content type - Application/JSON, Request body should contain index value filters. Follow the format given in the code block below ⤵️

200 If request proceed successfully, you will receive status code 200. Respond consists of search results as JSON object.

  "count": 1,
  "documents": [
    {
      "documentToken": "GEJCpCBGWLJzUNsx8RHKeJpxdghfdzPTvbGMKA1ADMAMgA1ADMAMwA3ADAAMKPUN",
      "indexData": [
        {
          "name": "Name",
          "value": "api-doc"
        },
        {
          "name": "Type",
          "value": "DPF"
        },
        {
          "name": "Date",
          "value": "12/11/2018"
        }
      ]
    }
  ]
}

Follow the format given in the code block to send the index value filters as the body parameter of API request.

{
  "indexes": [
    {
      "id": 1,
      "referenceId": 0,
      "value": {
        "value1": "apidoc",
        "value2": ""
      }
    },
    {
      "id": 2,
      "referenceId": 10,
      "value": {
        "value1": "HRdoc",
        "value2": ""
      }
    },
    {
      "id": 3,
      "referenceId": 0,
      "value": {
        "value1": "12/10/2018",
        "value2": "12/13/2018"
      }
    }
  ]
}