Document Uploader

PreviousBoundary NextEncryption

Last updated 6 months ago

Was this helpful?

create

post

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

Body

DocumentEntityDocumentEntity

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/egov-document-uploader/egov-du/document/_create' \
  --header 'Content-Type: application/json' \
  --data '{"DocumentEntity":{"auditDetails":{},"tenantIds":[null]},"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

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

delete

post

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

Body

DocumentEntityDocumentEntity

RequestInfoobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/egov-document-uploader/egov-du/document/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"DocumentEntity":{"auditDetails":{},"tenantIds":[null]},"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

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

search

post

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

Query parameters

categorystring

namestring

postedBystring

tenantIdsstring[]

uuidstring

Body

RequestInfoobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/egov-document-uploader/egov-du/document/_search' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

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

update

post

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

Body

DocumentEntityDocumentEntity

RequestInfoobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/egov-document-uploader/egov-du/document/_update' \
  --header 'Content-Type: application/json' \
  --data '{"DocumentEntity":{"auditDetails":{},"tenantIds":[null]},"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

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