مرجع API
واجهة Sursa API العامة: 222 من نقاط النهاية في 35 من الأقسام. الإصدار 1.62.0.
واجهة Sursa API العامة للتكاملات التي تُصادَق بمفتاح API. التغييرات داخل /v1 تغييرات بالإضافة: قد تظهر عمليات جديدة ومعاملات اختيارية وحقول استجابة وقيم تعداد جديدة في الاستجابات، ويستمر العملاء الحاليون في العمل. تعامل مع قيم التعداد غير المعروفة في الاستجابات على أنها صالحة.
- عنوان URL الأساسي
- https://api.sursa.com
- المصادقة
- أرسل مفتاح API في الترويسة Authorization: Authorization: Bearer <key>.
الأقسام
حالة الخدمة وإصدارها
تسجيل الدخول، والجلسات، ووضع «View as» (عرض بصفة)، وتغيير كلمة المرور وإعادة تعيينها، وقبول الدعوات
حسابات مستخدمي المؤسسة
مفاتيح API للمؤسسة
تطبيقات OAuth للمؤسسة وتخويلات الموظفين
بروتوكول OAuth 2.0: شاشة الموافقة، وإصدار الرموز وإبطالها، والبيانات الوصفية لخادم التخويل
سجل التدقيق للمؤسسة
المؤسسة وشعارها وتصدير بياناتها
فئات المستندات
مجموعات المعرفة
بطاقات المعرفة: الرفع، والمحتوى، والجداول، والإصدارات، والتوثيق، والتعليقات
قائمة انتظار الفهرسة: مهام المعالجة، ومعاينة قراءة المستند، وتدفق التغييرات (SSE)
المحادثات مع المساعد
البحث وإجابات المساعد، بما في ذلك تدفق SSE
طلبات الوصول إلى مصادر إجابة مخفية
سجل الأسئلة، والاقتراحات، وتصدير الإجابات، والإجابة الحية
ملفات التصدير
تحليلات المعرفة: الملخص، والتكرارات، وثغرات المعرفة، وصحة المعرفة
مهام المستخدم ومهام الفريق
مصادر البيانات، مثل Google Drive وConfluence
نظام الوصول: سجل الصلاحيات، والصلاحيات على المؤسسة والمجموعات والبطاقات والمصادر، الممنوحة مباشرة والموروثة
الأدوار: مجموعات مسمّاة من الصلاحيات، مدمجة ومخصصة
مجموعات المستخدمين: المجموعات العادية، و«All members» (كل الأعضاء)، ومجموعات الأدوار، والمجموعات الشخصية
مجلدات المجموعة: شجرة بعمق يصل إلى ثلاثة مستويات، والترتيب بالنسبة إلى عنصر مجاور، وبطاقة واحدة في عدة مجلدات، والصلاحيات الموروثة
دليل الخدمات الخارجية (خدمات SaaS والموردون) بأسمائها ومواقعها الإلكترونية وفئاتها وأيقوناتها وأوصافها، والروابط بين الأسماء المستخدمة في مؤسستك وعناصر الدليل
المسودات واعتماد النشر
التوثيق: الحالة، ومواعيد المراجعة، والموثِّقون، والسجل، وقائمة «وثّق أولًا»، ومؤشر الثقة، وإخراج المستخدمين من المؤسسة
إعلانات للقراءة الإلزامية: الجمهور، وتأكيد القراءة، والتقارير، والتذكيرات، والتصدير
سلاسل التعليقات على البطاقات، مع مرسى في النص وحالة، والتفاعلات
خطافات الويب للمؤسسة: الخطافات نفسها، والاشتراكات في الأحداث، والتوقيعات، والتسليمات، وإعادة المحاولة
واجهة API العامة للتكاملات: المواصفة المقروءة آليًا لهذه الواجهة
الرفع متعدد الأجزاء للملفات الكبيرة: الجلسة، والأجزاء، والإكمال مع الفحوص، والاستخدام في بطاقة أو أرشيف أو استيراد
تحليلات المنتج: أحداث الاستخدام، والعدادات لكل كائن، ولوحات معلومات الصحة والاستخدام والمساهمات، وتقرير التجديد، والتصدير
جودة الإجابات: الأسئلة التي لم تحصل على إجابة جيدة، وثغرات المعرفة المأخوذة للعمل عليها
المستندات المالية: أسعار الصرف ودليل الأطراف المقابلة
الكائنات
- AccessRequest
- AccessRequestDeny
- AccessRequestGrant
- AccessRequestList
- AccessRequestSource
- AccessRequestUser
- AccessRole
- AccessRoleCreate
- AccessRoleKind
- AccessRoleList
- AccessRoleScope
- AccessRoleUpdate
- Acl
- ActivityItem
- AnalyticsCardStats
- AnalyticsContribution
- AnalyticsHealth
- AnalyticsPeriod
- AnalyticsUsage
- Announcement
- AnnouncementAudience
- AnnouncementCreate
- AnnouncementList
- AnnouncementRecipient
- AnnouncementStats
- AnnouncementStatsSummary
- AnnouncementUsage
- AnswerAltPeriod
- AnswerAssignment
- AnswerBasis
- AnswerBasisCollection
- AnswerBasisCounted
- AnswerBasisExcluded
- AnswerBasisFlagged
- AnswerBasisScope
- AnswerCacheHit
- AnswerDataKind
- AnswerDrilldown
- AnswerEntity
- AnswerOutOfScope
- AnswerPeriod
- AnswerResponse
- AnswerSourceKind
- AnswerVerification
- AnswerVerificationItem
- AnswerWarning
- ApiKeyCreate
- ApiKeyCreated
- ApiKeyRoll
- ApiKeyRolled
- ApiKeyRow
- ApiKeyScope
- ApiKeyUpdate
- ApiLogEntry
- ApiLogList
- ApiUsage
- ApiUsagePoint
- ArchiveDocument
- ArchiveInfo
- ArchiveJob
- ArchiveSkip
- ArchiveSource
- ArchiveUploadForm
- ArchiveUploadFromUpload
- ArchiveUploadResult
- AskRequest
- Attachment
- AttachmentKind
- AuditActionCount
- AuditChainReport
- AuditEntry
- AuditExportRow
- BulkAction
- BulkRequest
- BulkResult
- BulkSkipped
- BulkSkipReason
- Calculation
- CalculationInput
- CallerApp
- CallerDataProfile
- CallerIdentity
- CallerKey
- CallerOrg
- CallerRateLimit
- CallerUser
- Card
- CardBrief
- CardBriefRow
- CardComment
- CardContent
- CardContentFile
- CardContentText
- CardCount
- CardDeleteResult
- CardEnrichmentStatus
- CardEvent
- CardExpanded
- CardExportFile
- CardFile
- CardFileUpsertForm
- CardFolderRef
- CardKind
- CardList
- CardPart
- CardSort
- CardStats
- CardStatsDay
- CardsXlsx
- CardTable
- CardTextContentType
- CardTextUpsert
- CardUpdate
- CardUploadForm
- CardUploadFromUpload
- CardUsage
- CardUsageEvent
- CardUsageItem
- CardUsageRow
- CardVerification
- CardVersion
- CardVersionDiff
- CatalogCategory
- CatalogResolveMatch
- CatalogResolveRequest
- CatalogResolveResponse
- CatalogService
- CategoryCount
- CategoryCreate
- CategoryDeleteResult
- CategoryProgress
- CategoryRef
- CategorySource
- CategoryUpdate
- CellType
- ChartReason
- ChartSpec
- ChartType
- ChatDone
- ChatErrorCode
- ChatEvent
- ChatEventData
- ChatEventError
- ChatEventFollowups
- ChatEventInterrupt
- ChatEventMeta
- ChatEventSources
- ChatEventStage
- ChatEventToken
- ChatEventTool
- ChatMessage
- ChatRequest
- ChatScope
- ChatScopePeriod
- ChatStage
- ChatStageInfo
- Collection
- CollectionDeleteResult
- CollectionExpanded
- CollectionHealth
- CollectionList
- CollectionRef
- CollectionReindex
- CollectionReindexResult
- CollectionRequest
- CollectionStats
- CollectionUpdate
- ColumnMeta
- ColumnRole
- CommentCreate
- CommentRequest
- CommentStatus
- CommentWithMentions
- ConfluenceSource
- ConnectorSource
- ContentJSON
- ContributionDay
- Contributor
- ConversationDetail
- ConversationList
- ConversationPublic
- DataProfileBrief
- Dataset
- DatasetCell
- DatasetColumn
- DatasetGroup
- DatasetRole
- DataSource
- DeletedResponse
- Delivery
- DiffHunk
- DiffLine
- DiffRow
- DocInvoiceExtraction
- DocInvoiceFields
- DocInvoiceLine
- DocInvoiceParty
- DocInvoiceTax
- DocKind
- DocumentCategory
- DocumentCategoryList
- DownloadFile
- Draft
- DraftCollaborator
- DraftCreate
- DraftList
- DraftScope
- DraftUpdate
- DraftWorkflowState
- DriveSource
- EditingLock
- EngineHealth
- EngineHealthLimited
- EngineLicenseSummary
- EntityAction
- EntityKind
- Error
- ErrorDetailObject
- ErrorInfo
- EventAccessRequest
- EventAccessRequestCreated
- EventAccessRequestResolved
- EventAnnouncement
- EventAnnouncementRead
- EventAnnouncementSent
- EventAPIKey
- EventApiKeyCreated
- EventApiKeyExpiring
- EventApiKeyRevoked
- EventAppAuthorized
- EventAppRevoked
- EventCard
- EventCardArchived
- EventCardCreated
- EventCardDeleted
- EventCardIndexed
- EventCardIndexFailed
- EventCardMoved
- EventCardPublished
- EventCardRestored
- EventCardUnverified
- EventCardUpdated
- EventCardVerified
- EventCollection
- EventCollectionCreated
- EventCollectionDeleted
- EventCollectionUpdated
- EventComment
- EventCommentCreated
- EventCommentResolved
- EventCreditsLow
- EventDraft
- EventDraftApproved
- EventDraftCreated
- EventDraftPublishRequested
- EventExportReady
- EventFile
- EventFolder
- EventFolderCreated
- EventFolderDeleted
- EventFolderUpdated
- EventGap
- EventGapDetected
- EventGroup
- EventGroupCreated
- EventGroupDeleted
- EventGroupMemberAdded
- EventGroupMemberRemoved
- EventGroupUpdated
- EventImportDocumentFailed
- EventImportSyncCompleted
- EventInvoice
- EventInvoiceIssued
- EventInvoicePaid
- EventJob
- EventJobCompleted
- EventJobFailed
- EventPlace
- EventQuestion
- EventQuestionAnswered
- EventQuestionFeedbackCreated
- EventQuestionUnanswered
- EventSource
- EventSourceConnectionLost
- EventSourceSyncCompleted
- EventSourceSyncFailed
- EventSubscription
- EventSubscriptionUpdated
- EventSync
- EventUser
- EventUserCreated
- EventUserDeactivated
- EventUserOffboarded
- EventUserUpdated
- EventVerification
- EventVerificationExpired
- EventVerificationRequested
- EventWebhookEndpointDisabled
- EventWebhookPing
- ExpandedUser
- ExportFile
- FeedbackRequest
- FeedItem
- FileAuthor
- FileAuthorList
- FileExpiry
- FileExtend
- FileList
- FileOrigin
- FilePreview
- FileRow
- FinanceCategoryRef
- FinanceCategorySource
- FinanceConversion
- FinanceConverted
- FinanceCurrencyMode
- FinanceDimension
- FinanceFilter
- FinanceInvoicePage
- FinanceInvoiceRow
- FinanceListRequest
- FinanceMeasure
- FinancePartyRef
- FinancePaymentPage
- FinancePaymentRow
- FinanceReport
- FinanceReportRequest
- FinanceReportRow
- FinanceReportTotal
- FinanceUnconverted
- Folder
- FolderCard
- FolderCardList
- FolderColor
- FolderCreate
- FolderDeleteResult
- FolderIcon
- FolderNode
- FolderPathItem
- FolderPosition
- FolderTree
- FolderTreeList
- FolderUpdate
- FolderWithPath
- Followup
- FollowupList
- GapCluster
- GapFollowup
- GapFollowupCreate
- GapFollowupPatch
- GapsResponse
- GrantLevel
- GrantObject
- GrantObjectType
- GrantRole
- GrantSubject
- Group
- GroupActivity
- GroupCreate
- GroupDetail
- GroupKind
- GroupList
- GroupManagedBy
- GroupMember
- GroupUpdate
- GuardrailVerdict
- HealthFull
- HealthLimited
- HealthPublic
- HealthServices
- HealthServiceState
- IndexUpgradeResult
- InvoiceDirection
- Job
- JobActionResult
- JobExpanded
- JobsBatch
- JobsResponse
- JobsSummary
- JobStatus
- JobStreamError
- JobStreamEvent
- JobStreamJob
- JobStreamSnapshot
- JobStreamSummary
- JobWithCard
- LoginChoice
- MePermissions
- Metadata
- MetadataPatch
- Notification
- NotificationKind
- NumberProvenance
- OAuthApp
- OAuthAppCreate
- OAuthAppList
- OAuthAppUpdate
- OAuthAppWithSecret
- OAuthAuthorization
- OAuthAuthorizationList
- OAuthClientType
- OAuthErrorResponse
- OAuthRevokeRequest
- OAuthScope
- OAuthServerMetadata
- OAuthTokenRequest
- OAuthTokenResponse
- ObjectGrant
- ObjectGrantRequest
- ObjectPermissionList
- ObjectPermissions
- OffboardRequest
- OffboardResult
- OrgInfo
- OrgLimits
- OrgLogoInfo
- OrgStatus
- OrgUsage
- OrgUsageView
- PaymentDirection
- PendingAction
- PendingActionResult
- PendingActionStatus
- Permission
- PermissionArea
- PermissionList
- ProvenanceKind
- ProvenanceMatch
- ProvenancePart
- PushDocument
- PushDocumentBatch
- PushDocumentBatchResult
- PushDocumentReason
- PushDocumentResult
- PushDocumentStatus
- PushDocumentStatusExpanded
- PushDocumentStatusList
- PushDocumentStatusValue
- PushPermissions
- PushSourceInfo
- PushSyncClose
- PushSyncOpen
- PushTouch
- PushTouchResult
- PushVerifiers
- QuestionFeedbackFilter
- QuestionFeedbackResult
- QuestionLogList
- QuestionLogRow
- QuestionPayload
- QuestionRow
- QuestionsCsv
- QuestionSource
- QuestionSourceSlim
- QueueStats
- ReactionDetail
- RefreshChange
- RefreshResult
- ReindexCounts
- ReindexPlan
- ReindexResult
- ReindexSkipped
- RestrictedInfo
- ReviewWarning
- Role
- SaveCardRequest
- SaveCardResult
- SearchHit
- SearchRequest
- SearchResponse
- ServiceRef
- SimilarItem
- SimilarResponse
- Source
- SourceCreate
- SourceItemCounts
- SourceKind
- SourceObjectType
- SourcePushKey
- SourcePushKeyCreate
- SourcePushKeyIssued
- SourcePushKeyList
- SourcePushSync
- SourcePushSyncList
- SourceRun
- SourceRunning
- SourceRunStatus
- SourceSettingsUpdate
- SourceStats
- SourceStatus
- SourceTrigger
- SourceUpdate
- SpendCategory
- SpendGroup
- SpendTaxonomy
- StatusOk
- StatusRevoked
- TableDiffItem
- TableProfile
- TableQuery
- TableRow
- TableRows
- TagList
- TaskScope
- TasksDetail
- TasksLegacy
- TextCardRequest
- TextCardResult
- Thread
- ThreadList
- ThreadUpdate
- Timings
- ToolCallInfo
- ToolName
- TrustParts
- TrustPoint
- TrustScore
- TurnVersions
- UnfinishedTurn
- UnverifyRequest
- Upload
- UploadComplete
- UploadCreate
- UploadPart
- UploadPartRef
- UploadPurpose
- UploadResult
- UploadStatus
- UsageDay
- UsageItem
- User
- UserActivityRow
- UserBrief
- UserBriefList
- UserCreate
- UserRowSlim
- UsersImportAction
- UsersImportCounts
- UsersImportInvitation
- UsersImportLimit
- UsersImportRequest
- UsersImportResult
- UsersImportRow
- UsersImportRowError
- UserUpdate
- ValidationError
- Verification
- VerificationEvent
- VerificationIntervalUpdate
- VerificationQueue
- VerificationQueueItem
- VerificationReason
- VerificationState
- VerificationType
- Verifier
- VerifierRef
- VerifierSet
- VerifierType
- VerifyCardRequest
- VerifyRequest
- ViewAs
- ViewAsOrg
- WebhookAttempt
- WebhookAttemptList
- WebhookAuthInput
- WebhookCatalog
- WebhookCatalogItem
- WebhookCreate
- WebhookCreated
- WebhookDelivery
- WebhookDeliveryBody
- WebhookDeliveryDetail
- WebhookDeliveryExpanded
- WebhookDeliveryList
- WebhookDeliveryStatus
- WebhookEndpoint
- WebhookEndpointList
- WebhookEvent
- WebhookEventFilter
- WebhookEventList
- WebhookEventObject
- WebhookEventType
- WebhookHeader
- WebhookHeaderInput
- WebhookHealth
- WebhookPayloadMode
- WebhookRedeliverRange
- WebhookRedeliverResult
- WebhookRole
- WebhookRotateSecret
- WebhookSecret
- WebhookStatus
- WebhookTestRequest
- WebhookUpdate