Document Uploader

create

post

Body

application/json

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/egov-document-uploader/egov-du/document/_create

HTTPcURLJavaScriptPython

POST /egov-document-uploader/egov-du/document/_create HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 446

{
  "DocumentEntity": {
    "active": true,
    "auditDetails": {
      "createdBy": "text",
      "createdTime": 1,
      "lastModifiedBy": "text",
      "lastModifiedTime": 1
    },
    "category": "text",
    "description": "text",
    "documentLink": "text",
    "filestoreId": "text",
    "name": "text",
    "postedBy": "text",
    "tenantId": "text",
    "tenantIds": [
      "text"
    ],
    "uuid": "text"
  },
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  }
}

{
  "Documents": [
    {
      "active": true,
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "category": "text",
      "description": "text",
      "documentLink": "text",
      "filestoreId": "text",
      "name": "text",
      "postedBy": "text",
      "tenantId": "text",
      "tenantIds": [
        "text"
      ],
      "uuid": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

delete

post

Body

application/json

Responses

200

OK

*/*

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version

tsinteger · int64Required

response time in epoch

resMsgIdstring · max: 256Optional

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring · max: 256Optional

message id of the request

statusstring · enumRequired

status of request processing - to be enhanced in futuer to include INPROGRESS

Possible values:

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/egov-document-uploader/egov-du/document/_delete

HTTPcURLJavaScriptPython

POST /egov-document-uploader/egov-du/document/_delete HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 446

{
  "DocumentEntity": {
    "active": true,
    "auditDetails": {
      "createdBy": "text",
      "createdTime": 1,
      "lastModifiedBy": "text",
      "lastModifiedTime": 1
    },
    "category": "text",
    "description": "text",
    "documentLink": "text",
    "filestoreId": "text",
    "name": "text",
    "postedBy": "text",
    "tenantId": "text",
    "tenantIds": [
      "text"
    ],
    "uuid": "text"
  },
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  }
}

{
  "apiId": "text",
  "ver": "text",
  "ts": 1,
  "resMsgId": "text",
  "msgId": "text",
  "status": "SUCCESSFUL"
}

search

post

Query parameters

categorystringOptional

namestringOptional

postedBystringOptional

tenantIdsstring[]Optional

uuidstringOptional

Body

application/json

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/egov-document-uploader/egov-du/document/_search

HTTPcURLJavaScriptPython

POST /egov-document-uploader/egov-du/document/_search HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  }
}

{
  "Documents": [
    {
      "active": true,
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "category": "text",
      "description": "text",
      "documentLink": "text",
      "filestoreId": "text",
      "name": "text",
      "postedBy": "text",
      "tenantId": "text",
      "tenantIds": [
        "text"
      ],
      "uuid": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

update

post

Body

application/json

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/egov-document-uploader/egov-du/document/_update

HTTPcURLJavaScriptPython

POST /egov-document-uploader/egov-du/document/_update HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 446

{
  "DocumentEntity": {
    "active": true,
    "auditDetails": {
      "createdBy": "text",
      "createdTime": 1,
      "lastModifiedBy": "text",
      "lastModifiedTime": 1
    },
    "category": "text",
    "description": "text",
    "documentLink": "text",
    "filestoreId": "text",
    "name": "text",
    "postedBy": "text",
    "tenantId": "text",
    "tenantIds": [
      "text"
    ],
    "uuid": "text"
  },
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  }
}

{
  "Documents": [
    {
      "active": true,
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "category": "text",
      "description": "text",
      "documentLink": "text",
      "filestoreId": "text",
      "name": "text",
      "postedBy": "text",
      "tenantId": "text",
      "tenantIds": [
        "text"
      ],
      "uuid": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}