Index

Get Index

GET [ENADOC_URL] /api/v3/indexes

Pre-requisites from Enadoc: You must have created indexes under any of the accessible libraries.

Headers

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

200 If request proceeds success, you will receive status code 200 with index details. Index details consists of index id, index name, library id, type, length, Is mandatory, Is inherited, order, Is super index, Super index id, default value, Is predictions enabled and search criteria.

{
  "id": 1,
  "name": "Document Type",
  "libraryId": 1,
  "type": 2,
  "length": 100,
  "isMandatory": false,
  "isInherited": false,
  "order": "0,0,0",
  "isSuperIndex": false,
  "superIndexId": 0,
  "defaultValue": "1",
  "isPredictionEnabled": false,
  "searchCriteria": "Equal"
}

Get Indexes of the Specific Library

GET [ENADOC_URL] /api/v3/libraries/{library id}/indexes

Pre-requisites from Enadoc: You must have created indexes under any of the accessible libraries.

Path Parameters

Name	Type	Description
library id	integer	Library Id

Headers

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

200 If request proceeds success, you will receive status code 200 with index details. Index details consists of index id, index name, type, length, Is mandatory, Is inherited, order, Is super index, Super index id, default value, Is predictions enabled and search criteria.

{
  "id": 1,
  "name": "Document Type",
  "type": 2,
  "length": 100,
  "isMandatory": false,
  "isInherited": false,
  "order": "0,0,0",
  "isSuperIndex": false,
  "superIndexId": 0,
  "defaultValue": "1",
  "isPredictionEnabled": false,
  "searchCriteria": "Equal"
}

Get Specific Index

Get Specific Index

GET [ENADOC_URL] /api/v3/indexes/{indexId}

Pre-requisites from Enadoc: You must have created indexes under any of the accessible libraries.

Path Parameters

Name	Type	Description
indexId	integer	Index Id

Headers

Name	Type	Description
Authorization	string	Type - Bearer Access token will be sent in request header

200 If request proceeds success, you will receive status code 200 with index details. Index details consists of index id, index name, library id, type, length, Is mandatory, Is inherited, order, Is super index, Super index id, default value, Is predictions enabled and search criteria.

{
  "id": 1,
  "name": "Document Type",
  "libraryId": 1,
  "type": 2,
  "length": 100,
  "isMandatory": false,
  "isInherited": false,
  "order": "0,0,0",
  "isSuperIndex": false,
  "superIndexId": 0,
  "defaultValue": "1",
  "isPredictionEnabled": false,
  "searchCriteria": "Equal"
}

Index Reference

Pre-requisites from Enadoc: You must have created dropdown indexes and reference values under these drop-down indexes.

Enadoc contains drop-down indexes, here we can consume two types of indexes values, there are parent index & child index. parent index can have reference values without any inheritance, child index will have inherited index reference value, here we have defined all endpoints that you can get these reference values.

Get Index Reference

GET [ENADOC_URL] /api/v3/indexes/{indexId}/references

Get parent index reference values, here we can obtain references where when index has superIndexId:0, other index reference values can be obtained using another end point

Path Parameters

Name	Type	Description
indexId	integer	Index Id

Headers

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

200 If the request proceeds success, you will receive status code 200 with list of index references. The index details consist of index reference id, index reference value and Is default status. Requested index references will be consists in response.

[
  {
    "id": 1,
    "value": "Bills",
    "isDefault": false
  },
  {
    "id": 2,
    "value": "Passport Copy",
    "isDefault": false
  },
  {
    "id": 3,
    "value": "Birth Certificate",
    "isDefault": false
  }
]

Get Index Reference Children

GET [ENADOC_URL] /api/v3/indexes/references/{id}/children

Use this method to get inherited index reference values, if that index is an inherited one

Path Parameters

Name	Type	Description
id	integer	Parent index reference id

Headers

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

200 If the request proceeds success, you will receive status code 200 with the details of requested index references. The details consist of reference id, reference value, Is default status. Requested index references will be consists in response.

[
  {
    "id": 1,
    "value": "PDF",
    "isDefault": false
  }
]

Create a New Index Reference

POST [ENADOC_URL] /api/v3/indexes/{indexId}/references

Here we can create a new index reference for drop down indexes, if index is inherited index server required to send parent index reference id. If index is not inherited, then not required parent index reference id. It can send as 0 value or null.

Path Parameters

Name	Type	Description
indexId	integer	Index Id

Headers

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

Request Body

Name	Type	Description
Reference details	object	Content type - application JSON Request body should contain the index reference details. Follow the format given in the code block below. ⤵️

201 If the request proceeds successfully, you will receive status code 201 with details of newly created index reference. The details consist of reference id, reference value and Is default status.

{
  "id": 1,
  "value": "PDF",
  "isDefault": false
}

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

{
  "parentReferenceId": 0,
  "Value": "ABC",
  "isDefault": false
}

Edit Index Reference

PUT [ENADOC_URL] /api/v3/indexes/references/{id}

Here we can edit index reference of drop-down indexes.

Path Parameters

Name	Type	Description
id	integer	Index reference id

Headers

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

Request Body

Name	Type	Description
Reference details	object	Content type - Application/Json Request body should consists of the new values of index reference details. Follow the format given in the code block below. ⤵️

201 If the request proceed successful, you will receive 201 with the edited details of index reference. The details consists of reference id, reference value and is default status.

{
  "id": 1,
  "value": "PDF",
  "isDefault": false
}

Follow the format given in the code block to send the new values for index reference as the body parameter of the API request.

{
  "id": 1,
  "value": "PDF",
  "isDefault": false
}

Update Default Index Reference

PUT [ENADOC_URL] /api/v3/indexes/references/{ref_id}/$default

Here we can update index reference value as default.

Path Parameters

Name	Type	Description
ref_id	integer	Index Reference Id

Headers

Name	Type	Description
Authorization	string	Type - Bearer Access token will be sent in request header

Request Body

Name	Type	Description
Default status	object	Content type - Application/Json Request body should contain of the index reference status. Follow the format given in the code block below.

200 If request proceed successfully, you will receive status code 200 with updated index default status.

{
  "id": 1,
  "value": "Bills",
  "isDefault": true
}

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

{
 "isDefault":true
}

Delete Index Reference

DELETE [ENADOC_URL] /api/v3/indexes/references/{id}

This method is to delete index reference

Path Parameters

Name	Type	Description
id	string	Index reference id

Headers

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

200 If request proceeds success, you will receive status code 200. No body content received here.