Index document

Adds a document to the index or updates an existing document.

SecurityBearerAuth
Request
Request Body schema: application/json
required
version
integer <int64>

Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.

required
object (DocumentDefinition)

Indexable document structure

Responses
200

OK

400

Bad Request

401

Not Authorized

409

Conflict

post/indexdocument
Request samples
application/json
{
  • "version": 0,
  • "document": {
    • "title": "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
        }
      ]
    }
}