Get document syncs

GET 
/documents/:documentId/syncs

Retrieve the document syncs with external services status

Request

Path Parameters

documentId stringrequired

Document Identifier

Query Parameters

siteId string

Site Identifier

limit string
Limit Results
Default value: 10
shareKey string

Share Identifier

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

next string

Next page of results token

syncs

object[]

List of document syncs

Array [

service DocumentSyncService (string)

Service of Document Sync

Possible values: [TYPESENSE, OPENSEARCH, EVENTBRIDGE]

status DocumentSyncStatus (string)

Status of Document Sync

Possible values: [COMPLETE, FAILED, FAILED_RETRY, PENDING]

type DocumentSyncType (string)

Type of Document Sync

Possible values: [METADATA, CONTENT, SOFT_DELETE, DELETE]

insertedDate string

Inserted Timestamp

syncDate string

Timestamp of synchronization

userId string

User who added document

message string

Document sync message

]

Example (from schema)

{
  "next": "string",
  "syncs": [
    {
      "service": "TYPESENSE",
      "status": "COMPLETE",
      "type": "METADATA",
      "insertedDate": "string",
      "syncDate": "string",
      "userId": "string",
      "message": "string"
    }
  ]
}

Loading...