Generated reference · API

Oshun Study & Deconstruction Workspace API

The generated API reference for Oshun Study & Deconstruction Workspace API.

299endpoints1schema0.16.0version

On this page

general (299)#

GET/api/study/acquisition-capabilitiesacquisitionCapabilities
POST/api/study/alignment-mapsauthorAlignmentMap
POST/api/study/alignment-maps/proposalsproposeAlignmentMap
GET/api/study/analyses/{runIdA}/diff/{runIdB}diffAnalyses
GET/api/study/analyses/{runId}readAnalysis
POST/api/study/analyses/{runId}/cancelcancelAnalysis
POST/api/study/analyses/{runId}/executeexecuteAnalysis
POST/api/study/analysis-baselinesrecordAnalysisBaseline
GET/api/study/analysis-capabilitiesanalysisCapabilities
GET/api/study/analysis-upgradeslistAnalysisServiceRegister
POST/api/study/analysis-upgradesdecideAnalysisUpgrade
GET/api/study/anchors/{anchorId}getAnchor
POST/api/study/anchors/{anchorId}/representationsgenerateRepresentation
POST/api/study/assets/{assetId}/inspectinspectCreatorAsset
POST/api/study/assignmentssetAssignment
GET/api/study/assignments/{assignmentId}readAssignment
POST/api/study/assignments/{assignmentId}/amendamendAssignment
GET/api/study/assignments/{assignmentId}/cohort-reportreadCohortReport
POST/api/study/assignments/{assignmentId}/extensionsgrantAssignmentExtension
POST/api/study/assignments/{assignmentId}/peer-allocationallocateAssignmentPeerReviews
POST/api/study/assignments/{assignmentId}/submissionssubmitToAssignment
POST/api/study/atlas/collectionscreateAtlasCollection
POST/api/study/atlas/collections/{collectionId}/blind-observationrecordAtlasBlindObservation
POST/api/study/atlas/collections/{collectionId}/comparisonreadAtlasComparison
POST/api/study/atlas/collections/{collectionId}/instancesaddAtlasInstance
GET/api/study/atlas/template-recordslistAuthoredAtlasTemplates
POST/api/study/atlas/template-records/{recordId}/reviewreviewAtlasTemplate
GET/api/study/atlas/templateslistAtlasTemplates
POST/api/study/atlas/templatesauthorAtlasTemplate
POST/api/study/claimsrecordInterpretation
GET/api/study/claims/{claimId}getClaim
POST/api/study/claims/{claimId}/dissentsrecordClaimDissent
POST/api/study/claims/{claimId}/revisereviseClaim
POST/api/study/collections/{collectionId}/clipsclipWebSource
POST/api/study/collections/{collectionId}/importsimportInspirationReferences
POST/api/study/collections/{collectionId}/screenshotscaptureDesktopScreenshot
POST/api/study/comparison-matricesauthorComparisonMatrix
GET/api/study/comparison-matrices/{matrixId}readComparisonMatrix
POST/api/study/comparison-matrices/{matrixId}/cellsrecordMatrixCells
POST/api/study/comparisonscreateComparison
GET/api/study/comparisons/{comparisonId}getComparison
POST/api/study/comparisons/{comparisonId}/align-correctionrecordAlignmentCorrection
POST/api/study/comparisons/{comparisonId}/freezefreezeComparison
GET/api/study/comparisons/{comparisonId}/matriceslistComparisonMatrices
POST/api/study/comparisons/{comparisonId}/updateupdateComparison
GET/api/study/connectorslistConnectorRegistries
GET/api/study/connectors/protocolreadConnectorProtocol
POST/api/study/connectors/registrypublishConnectorRegistry
GET/api/study/connectors/{connectorId}/registryreadConnectorRegistry
POST/api/study/craft-hypothesesrecordCraftHypothesis
POST/api/study/creative-decisionscreateCreativeDecision
GET/api/study/creative-decisions/{decisionId}getCreativeDecision
POST/api/study/creative-decisions/{decisionId}/approveapproveCreativeDecision
POST/api/study/creative-decisions/{decisionId}/commitcommitCreativeDecision
POST/api/study/creative-decisions/{decisionId}/impact-reviewflagCreativeDecisionImpactReview
GET/api/study/creative-decisions/{decisionId}/provenancetraceDecisionProvenance
POST/api/study/creative-decisions/{decisionId}/reversereverseCreativeDecision
POST/api/study/creative-decisions/{decisionId}/revisitrevisitCreativeDecision
POST/api/study/creative-decisions/{decisionId}/updateupdateCreativeDecision
POST/api/study/creative-principlesderiveCreativePrinciple
GET/api/study/creative-principles/{principleId}readCreativePrinciple
POST/api/study/creative-principles/{principleId}/reviewreviewCreativePrinciple
POST/api/study/creator-statementsrecordCreatorStatement
POST/api/study/cross-referencescreateCrossReference
POST/api/study/cross-references/{crossReferenceId}/keep-distinctkeepDistinct
GET/api/study/deployment-optionreadDeploymentOption
POST/api/study/deployment-optionadoptDeploymentOption
POST/api/study/deployment-option/local-runsadmitLocalRun
POST/api/study/deployment-option/local-runs/authorizationsauthorizeLocalRun
POST/api/study/editions/{editionId}/analysesrequestAnalysis
POST/api/study/editions/{editionId}/analyses/estimateestimateAnalysis
GET/api/study/editions/{editionId}/anchorslistAnchors
POST/api/study/editions/{editionId}/anchorscreateAnchor
GET/api/study/editions/{editionId}/segment-overlapssegmentOverlaps
GET/api/study/editions/{editionId}/segment-suggestionssuggestSegments
GET/api/study/editions/{editionId}/segmentslistSegments
POST/api/study/editions/{editionId}/segmentscreateSegment
POST/api/study/editions/{editionId}/segments/reorderreorderSegments
GET/api/study/editions/{editionId}/trackslistTracks
POST/api/study/entitiescreateEntity
GET/api/study/entities/{entityId}getEntity
POST/api/study/entities/{entityId}/aliasesaddEntityAlias
GET/api/study/entities/{entityId}/canonicalresolveEntityCanonical
POST/api/study/entities/{entityId}/keep-distinctkeepEntitiesDistinct
POST/api/study/entities/{entityId}/mergemergeEntity
POST/api/study/entities/{entityId}/relationshipsrelateEntities
POST/api/study/entities/{entityId}/updateupdateEntity
POST/api/study/expiry-sweepexpirySweep
GET/api/study/extensions/lens-packageslistLensPackages
POST/api/study/extensions/lens-packagesregisterLensPackage
POST/api/study/feedback-notes/{noteId}/dispositiondispositionFeedbackNote
POST/api/study/feedback-notes/{noteId}/moderationmoderateFeedbackNote
POST/api/study/feedback-notes/{noteId}/visibilitychangeNoteVisibility
GET/api/study/game-study/templateslistGameStudyTemplates
GET/api/study/homeworkspaceHome
POST/api/study/impact-reviews/{reviewTaskId}/resolveresolveImpactReview
POST/api/study/imported-references/{referenceId}/reviewreviewImportedReference
POST/api/study/inspiration-collectionscreateInspirationCollection
GET/api/study/inspiration-collections/{collectionId}getInspirationCollection
POST/api/study/inspiration-collections/{collectionId}/itemsaddInspirationItem
POST/api/study/inspiration-collections/{collectionId}/items/bulkbulkPinInspirationItems
POST/api/study/inspiration-collections/{collectionId}/updateupdateInspirationCollection
POST/api/study/inspiration-items/{itemId}/updateupdateInspirationItem
GET/api/study/institutional-controlsreadInstitutionalControls
POST/api/study/institutional-controlsadoptInstitutionalControls
POST/api/study/institutional-controls/decisionsdecideInstitutionalRequest
POST/api/study/lens-capabilitieslensCapabilities
POST/api/study/live-sessionsstartLiveSession
GET/api/study/live-sessions/{sessionId}readLiveRoom
POST/api/study/live-sessions/{sessionId}/consentsetRoomContributionConsent
POST/api/study/live-sessions/{sessionId}/crystallizecrystallizeLiveDiscussion
POST/api/study/live-sessions/{sessionId}/driftreportRoomDrift
POST/api/study/live-sessions/{sessionId}/joinjoinLiveRoom
POST/api/study/live-sessions/{sessionId}/leaveleaveLiveRoom
POST/api/study/live-sessions/{sessionId}/messagespostRoomMessage
POST/api/study/live-sessions/{sessionId}/moderationmoderateLiveRoom
GET/api/study/live-sessions/{sessionId}/presencereadLiveRoomPresence
POST/api/study/live-sessions/{sessionId}/settingssetOwnRoomSettings
POST/api/study/live-sessions/{sessionId}/transportdriveRoomTransport
POST/api/study/live-sessions/{sessionId}/transport-controlsetRoomTransportControl
POST/api/study/notebooks/{notebookRef}/cardsappendStudyCard
GET/api/study/notebooks/{notebookRef}/exportexportNotebook
POST/api/study/notebooks/{notebookRef}/publicationsetNotebookPublication
POST/api/study/notebooks/{notebookRef}/revisereviseNotebook
POST/api/study/observationsrecordObservation
POST/api/study/observations/batchrecordObservationsBatch
GET/api/study/observations/{observationId}getObservation
POST/api/study/observations/{observationId}/revisereviseObservation
GET/api/study/onboarding/seedseededWorkspace
POST/api/study/original-conceptscreateOriginalConcept
GET/api/study/original-concepts/{conceptId}getOriginalConcept
POST/api/study/original-concepts/{conceptId}/updateupdateOriginalConcept
POST/api/study/outcome-evidencerecordOutcomeEvidence
GET/api/study/portfolioslistPortfolios
POST/api/study/portfoliosstartPortfolio
GET/api/study/portfolios/{portfolioId}readPortfolio
POST/api/study/portfolios/{portfolioId}/downstream-copiesrecordDownstreamCopy
POST/api/study/portfolios/{portfolioId}/downstream-copies/cleanuprecordCopyCleanup
POST/api/study/portfolios/{portfolioId}/publicationpublishPortfolio
DELETE/api/study/portfolios/{portfolioId}/publicationrevokePortfolioPublication
POST/api/study/portfolios/{portfolioId}/versionswritePortfolioVersion
GET/api/study/portfolios/{portfolioId}/versions/{version}/chainreadPortfolioChain
POST/api/study/practice-attempts/{attemptId}/challengechallengePracticeFeedback
POST/api/study/practice-attempts/{attemptId}/feedbackgivePracticeFeedback
GET/api/study/practice-attempts/{attemptId}/notesreadAttemptFeedback
POST/api/study/practice-attempts/{attemptId}/noteswriteFeedbackNote
POST/api/study/practice-attempts/{attemptId}/reflectionaddPracticeReflection
POST/api/study/practice-attempts/{attemptId}/withdraw-sharingwithdrawAttemptSharing
POST/api/study/practice-exercisescreatePracticeExercise
GET/api/study/practice-exercises/{exerciseId}getPracticeExercise
GET/api/study/practice-exercises/{exerciseId}/attemptslistPracticeAttempts
POST/api/study/practice-exercises/{exerciseId}/attemptssubmitPracticeAttempt
POST/api/study/practice-exercises/{exerciseId}/masterycomputePracticeMastery
POST/api/study/practice-exercises/{exerciseId}/mastery-evidencereadMasteryEvidence
GET/api/study/principles/{principleId}/track-recordreadPrincipleTrackRecord
POST/api/study/project-transferscreateProjectTransfer
GET/api/study/project-transfers/{transferId}getProjectTransfer
POST/api/study/project-transfers/{transferId}/impactrecordProjectTransferImpact
POST/api/study/projection-drainprojectionDrain
GET/api/study/projectslistProjects
POST/api/study/projectscreateProject
GET/api/study/projects/{projectId}getProject
DELETE/api/study/projects/{projectId}deleteProject
GET/api/study/projects/{projectId}/alignment-mapslistAlignmentMaps
GET/api/study/projects/{projectId}/analyseslistAnalyses
POST/api/study/projects/{projectId}/annotation-importsimportAnnotations
POST/api/study/projects/{projectId}/annotation-imports/{importId}/undoundoAnnotationImport
POST/api/study/projects/{projectId}/archivearchiveProject
POST/api/study/projects/{projectId}/artifact-readings/{readingId}/reproductionsreproduceProjectArtifactReading
GET/api/study/projects/{projectId}/assignmentslistAssignments
GET/api/study/projects/{projectId}/atlas/collectionslistAtlasCollections
POST/api/study/projects/{projectId}/change-impactreviewChangeImpact
GET/api/study/projects/{projectId}/claimslistClaims
GET/api/study/projects/{projectId}/comparisonslistComparisons
GET/api/study/projects/{projectId}/concept-system-mapconceptSystemMap
GET/api/study/projects/{projectId}/creative-decisionslistCreativeDecisions
GET/api/study/projects/{projectId}/creative-principleslistCreativePrinciples
GET/api/study/projects/{projectId}/cross-referenceslistCrossReferences
POST/api/study/projects/{projectId}/cross-references/impactcrossReferenceImpact
POST/api/study/projects/{projectId}/discoverydiscoverRelated
POST/api/study/projects/{projectId}/edge-endpointssearchEdgeEndpoints
GET/api/study/projects/{projectId}/editions/{editionId}/artifact-readingslistProjectArtifactReadings
POST/api/study/projects/{projectId}/editions/{editionId}/artifact-readingsrecordProjectArtifactReading
GET/api/study/projects/{projectId}/editions/{editionId}/project-linksdescribeProjectLinks
POST/api/study/projects/{projectId}/editions/{editionId}/project-linkslinkProjectArtifacts
GET/api/study/projects/{projectId}/entitieslistEntities
GET/api/study/projects/{projectId}/exportexportTrail
GET/api/study/projects/{projectId}/game-sessions/{editionId}readGameSession
GET/api/study/projects/{projectId}/game-sessions/{editionId}/bookmarkslistSessionBookmarks
POST/api/study/projects/{projectId}/game-sessions/{editionId}/bookmarkssaveSessionBookmark
POST/api/study/projects/{projectId}/game-sessions/{editionId}/encounter-comparisoncompareEncounterBookmarks
POST/api/study/projects/{projectId}/game-sessions/{editionId}/event-windowreadSessionEventWindow
GET/api/study/projects/{projectId}/game-sessions/{editionId}/eventsreadSessionEvents
POST/api/study/projects/{projectId}/game-sessions/{editionId}/eventsingestSessionEvents
POST/api/study/projects/{projectId}/game-sessions/{editionId}/hit-feelbuildHitFeelTimeline
POST/api/study/projects/{projectId}/graph-clustersgraphClusters
POST/api/study/projects/{projectId}/graph-neighborhoodgraphNeighborhood
GET/api/study/projects/{projectId}/graph-viewslistGraphViews
POST/api/study/projects/{projectId}/graph-viewssaveGraphView
POST/api/study/projects/{projectId}/hybrid-searchhybridSearch
GET/api/study/projects/{projectId}/impact-reviewslistProjectImpactReviews
GET/api/study/projects/{projectId}/inspiration-collectionslistInspirationCollections
POST/api/study/projects/{projectId}/linkscreateLink
GET/api/study/projects/{projectId}/live-sessionslistLiveRooms
GET/api/study/projects/{projectId}/local-runslistLocalRunAdmissions
POST/api/study/projects/{projectId}/membersshareProject
POST/api/study/projects/{projectId}/members/{targetUserId}changeMemberRole
DELETE/api/study/projects/{projectId}/members/{targetUserId}removeProjectMember
GET/api/study/projects/{projectId}/notebookslistNotebooks
POST/api/study/projects/{projectId}/notebooksauthorNotebook
GET/api/study/projects/{projectId}/observationslistObservations
GET/api/study/projects/{projectId}/original-conceptslistOriginalConcepts
GET/api/study/projects/{projectId}/outcome-evidencelistOutcomeEvidence
POST/api/study/projects/{projectId}/policysetProjectPolicy
GET/api/study/projects/{projectId}/practice-exerciseslistPracticeExercises
GET/api/study/projects/{projectId}/project-transferslistProjectTransfers
GET/api/study/projects/{projectId}/questionslistQuestions
POST/api/study/projects/{projectId}/rejected-sourcesrejectSource
GET/api/study/projects/{projectId}/reportslistStudyReports
POST/api/study/projects/{projectId}/reportsgenerateReport
GET/api/study/projects/{projectId}/reports/preflightreportPreflight
POST/api/study/projects/{projectId}/restorerestoreProject
GET/api/study/projects/{projectId}/revalidation-taskslistRevalidationTasks
GET/api/study/projects/{projectId}/searchsearchProject
POST/api/study/projects/{projectId}/source-candidatesresolveSourceIdentity
GET/api/study/projects/{projectId}/streamstreamProjectEvents
GET/api/study/projects/{projectId}/study-setslistStudySets
GET/api/study/projects/{projectId}/taxonomyreadTaxonomyCoverage
POST/api/study/projects/{projectId}/taxonomy/assignmentsassignTaxonomyTerm
POST/api/study/projects/{projectId}/taxonomy/assignments/{assignmentId}/withdrawwithdrawTaxonomyAssignment
POST/api/study/projects/{projectId}/taxonomy/passesrecordTaxonomyPass
GET/api/study/projects/{projectId}/trailprojectTrail
POST/api/study/projects/{projectId}/transferrequestTransfer
POST/api/study/projects/{projectId}/updateupdateProject
POST/api/study/projects/{projectId}/vector-searchvectorSearchProject
GET/api/study/projects/{projectId}/video-only-game-recordslistVideoOnlyGameRecords
POST/api/study/projects/{projectId}/video-only-game-recordsrecordVideoOnlyGameStudy
POST/api/study/projects/{projectId}/video-only-game-records/hud-readreadHudValue
POST/api/study/projects/{projectId}/worksregisterWork
POST/api/study/questionsaskQuestion
GET/api/study/questions/{questionId}getQuestion
POST/api/study/questions/{questionId}/evidencelinkQuestionEvidence
POST/api/study/questions/{questionId}/transitiontransitionQuestion
POST/api/study/questions/{questionId}/updateupdateQuestion
GET/api/study/reports/{reportId}readStudyReport
GET/api/study/reports/{reportId}/contentdownloadStudyReport
POST/api/study/revalidation-tasks/{taskId}/resolutionresolveRevalidationTask
POST/api/study/reviewsreviewRecord
POST/api/study/segments/{segmentId}/correctionscorrectSegment
POST/api/study/segments/{segmentId}/mergemergeSegments
POST/api/study/segments/{segmentId}/splitsplitSegment
POST/api/study/segments/{segmentId}/withdrawalwithdrawDraftSegment
GET/api/study/sourcessourcesLibrary
POST/api/study/spaced-review/drillsbuildPerceptualDrill
GET/api/study/spaced-review/duelistDueSpacedReviews
POST/api/study/spaced-review/itemsgenerateSpacedReviewItems
POST/api/study/spaced-review/items/{itemId}/reviewrecordSpacedReviewOutcome
POST/api/study/study-setsauthorStudySet
GET/api/study/study-sets/{setId}/openingopenStudySet
POST/api/study/study-sets/{setId}/openingrecordStudySetRelease
GET/api/study/study-sets/{setId}/releasesreadStudySetReleases
POST/api/study/study-sets/{setId}/teacher-releasereleaseStudySetByTeacher
POST/api/study/study-sets/{setId}/updateupdateStudySet
POST/api/study/taxonomy/extensionsregisterTaxonomyExtension
POST/api/study/taxonomy/termsregisterTaxonomyTerm
GET/api/study/taxonomy/vocabularyreadTaxonomyVocabulary
POST/api/study/uploadsinitiateUpload
POST/api/study/uploads/{id}/cancelcancelUpload
POST/api/study/uploads/{id}/chunksuploadChunk
POST/api/study/uploads/{id}/completecompleteUpload
POST/api/study/uploads/{id}/pausepauseUpload
POST/api/study/uploads/{id}/resumeresumeUpload
POST/api/study/video-only-game-records/{recordId}/revisionreviseVideoOnlyGameStudy
GET/api/study/works/{workId}sourceDetail
DELETE/api/study/works/{workId}deleteWork
GET/api/study/works/{workId}/allowed-actionsallowedActions
GET/api/study/works/{workId}/captionscaptions
POST/api/study/works/{workId}/captionsextractCaptions
GET/api/study/works/{workId}/captions/{trackId}/vttcaptionTrackVtt
POST/api/study/works/{workId}/creator-assetsregisterCreatorAsset
POST/api/study/works/{workId}/grantsgrantRights
POST/api/study/works/{workId}/grants/{grantId}/correctcorrectGrant
POST/api/study/works/{workId}/grants/{grantId}/renewrenewGrant
POST/api/study/works/{workId}/grants/{grantId}/reviewreviewQuarantinedGrant
POST/api/study/works/{workId}/grants/{grantId}/revokerevokeGrant
GET/api/study/works/{workId}/hierarchysourceHierarchy
GET/api/study/works/{workId}/impactsourceImpact
POST/api/study/works/{workId}/ingestingestWork
POST/api/study/works/{workId}/instrumented-sessionsregisterInstrumentedSession
POST/api/study/works/{workId}/legal-holdsetLegalHold
GET/api/study/works/{workId}/playbackplayback
POST/api/study/works/{workId}/provider-sourcesregisterProviderSource
POST/api/study/works/{workId}/provider-sources/{assetId}/playbackresolveProviderPlayback
GET/api/study/works/{workId}/rights/auditrightsAudit
POST/api/study/works/{workId}/rights/resolveresolveRights
POST/api/study/works/{workId}/rights/simulatesimulateRights
GET/healthhealth
GET/metricsmetrics
GET/readyready

Schemas (1)#

StudyErrorobject