Index documents

Adds or updates multiple documents in the index. Please refer to the bulk indexing documentation for an explanation of when to use this endpoint.

SecurityBearerAuth
Request
Request Body schema: application/json
required
uploadId
string

Optional id parameter to identify and track a batch of documents.

datasource
required
string

Datasource of the documents

required
Array of objects (DocumentDefinition)

Batch of documents being added/updated

Responses
200

OK

400

Bad Request

401

Not Authorized

409

Conflict

429

Too Many Requests

post/indexdocuments
Request samples
application/json
{
  • "uploadId": "string",
  • "datasource": "string",
  • "documents": [
    • {
      • "title": "string",
      • "filename": "string",
      • "container": "string",
      • "containerDatasourceId": "string",
      • "containerObjectType": "string",
      • "datasource": "string",
      • "objectType": "string",
      • "viewURL": "string",
      • "id": "string",
      • "summary": {
        • "mimeType": "string",
        • "textContent": "string",
        • "binaryContent": "string"
        },
      • "body": {
        • "mimeType": "string",
        • "textContent": "string",
        • "binaryContent": "string"
        },
      • "author": {
        • "email": "string",
        • "datasourceUserId": "string",
        • "name": "string"
        },
      • "owner": {
        • "email": "string",
        • "datasourceUserId": "string",
        • "name": "string"
        },
      • "permissions": {
        • "allowedUsers": [
          • {
            • "email": "string",
            • "datasourceUserId": "string",
            • "name": "string"
            }
          ],
        • "allowedGroups": [
          • "string"
          ],
        • "allowedGroupIntersections": [
          • {
            • "requiredGroups": [
              • "string"
              ]
            }
          ],
        • "allowAnonymousAccess": true,
        • "allowAllDatasourceUsersAccess": true
        },
      • "createdAt": 0,
      • "updatedAt": 0,
      • "updatedBy": {
        • "email": "string",
        • "datasourceUserId": "string",
        • "name": "string"
        },
      • "tags": [
        • "string"
        ],
      • "interactions": {
        • "numViews": 0,
        • "numLikes": 0,
        • "numComments": 0
        },
      • "status": "string",
      • "additionalUrls": [
        • "string"
        ],
      • "comments": [
        • {
          • "id": "string",
          • "author": {
            • "email": "string",
            • "datasourceUserId": "string",
            • "name": "string"
            },
          • "content": {
            • "mimeType": "string",
            • "textContent": "string",
            • "binaryContent": "string"
            },
          • "createdAt": 0,
          • "updatedAt": 0,
          • "updatedBy": {
            • "email": "string",
            • "datasourceUserId": "string",
            • "name": "string"
            }
          }
        ],
      • "customProperties": [
        • {
          • "name": "string",
          • "value": null
          }
        ]
      }
    ]
}