For the complete documentation index, see llms.txt. This page is also available as Markdown.

Share Point Imports

List SharePoint imports for a project.

get

Returns a paginated list of SharePoint imports for the project, sorted by date added (newest first by default).

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
projectIdentifierstring · uuidRequired
Query parameters
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
descbooleanOptionalDefault: true
Responses
200

OK

No content

get/projects/{projectIdentifier}/sharepoint-imports

No content

Submit a SharePoint selection for import.

post

Creates a queued SharePoint import for the project, transfers the user's stored refresh token onto the import, and enqueues the worker message.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
projectIdentifierstring · uuidRequired
Body
ocrEnginestring · enumOptionalPossible values:
ocrStrategystring · enumOptionalPossible values:
coordinateExtractionStrategystring · enumOptionalPossible values:
parentObjectIdentifierstring · uuid · nullableOptional
Responses
201

Created

objectIdentifierstring · uuidOptional
statusstring · enumOptionalPossible values:
failureReasonstring · nullableOptional
failureCodestring · enumOptionalPossible values:
itemsTotalinteger · int32 · nullableOptional
dateAddedstring · date-timeOptional
dateStartedstring · date-time · nullableOptional
dateCompletedstring · date-time · nullableOptional
documentUploadObjectIdentifierstring · uuid · nullableOptional
post/projects/{projectIdentifier}/sharepoint-imports

Get a SharePoint import by identifier.

get

Returns a single SharePoint import scoped to the supplied project. Responds 404 if the import does not exist or belongs to a different project.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
projectIdentifierstring · uuidRequired
importIdentifierstring · uuidRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
statusstring · enumOptionalPossible values:
failureReasonstring · nullableOptional
failureCodestring · enumOptionalPossible values:
itemsTotalinteger · int32 · nullableOptional
dateAddedstring · date-timeOptional
dateStartedstring · date-time · nullableOptional
dateCompletedstring · date-time · nullableOptional
documentUploadObjectIdentifierstring · uuid · nullableOptional
get/projects/{projectIdentifier}/sharepoint-imports/{importIdentifier}

List items for a SharePoint import.

get

Returns a paginated list of the user's selections for the supplied import, in insertion order.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
projectIdentifierstring · uuidRequired
importIdentifierstring · uuidRequired
Query parameters
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
Responses
200

OK

No content

get/projects/{projectIdentifier}/sharepoint-imports/{importIdentifier}/items

No content

Last updated