Generated reference · API

Isis Output Registry API

OpenAPI contract for `@isis/output-registry`.

66endpoints11schemas0.1.0version
Source
On this page

Assets (6)#

GET/api/v1/assets/{assetId}/headGet an asset's head
GET/api/v1/assets/{assetId}/revisionsList an asset's revisions
POST/api/v1/assets/{assetId}/revisionsCreate an asset revision
GET/api/v1/assets/{assetId}/revisions/{revisionId}Get an asset revision
POST/api/v1/assets/{assetId}/revisions/{revisionId}/acceptAccept a revision as the asset's head
POST/api/v1/assets/{assetId}/revisions/{revisionId}/restoreRestore an accepted revision as head

Health (2)#

GET/healthLiveness probe
GET/readyReadiness probe

Library (13)#

GET/api/v1/library/assetsSearch the asset library
GET/api/v1/library/assets/{assetId}Select a library asset
POST/api/v1/library/assets/{assetId}Publish an asset to the library
PATCH/api/v1/library/assets/{assetId}Edit a library asset
POST/api/v1/library/assets/{assetId}/duplicateDuplicate a library asset
PUT/api/v1/library/assets/{assetId}/variantSet or clear an asset variant
POST/api/v1/library/collectionsCreate a collection
GET/api/v1/library/collections/{collectionId}Read a collection
POST/api/v1/library/collections/{collectionId}/itemsAdd an asset to a collection
POST/api/v1/library/projectsCreate a library project
GET/api/v1/library/projects/{projectId}/membersList project members
PUT/api/v1/library/projects/{projectId}/membersGrant a project role
DELETE/api/v1/library/projects/{projectId}/members/{principalId}Revoke a project role

Lineage (5)#

POST/api/v1/outputs/lineageAdd lineage edge
DELETE/api/v1/outputs/lineage/{sourceId}/{targetId}Remove lineage edge
GET/api/v1/outputs/{id}/ancestorsGet ancestor outputs
GET/api/v1/outputs/{id}/descendantsGet descendant outputs
GET/api/v1/outputs/{id}/lineageGet output lineage graph

Outputs (14)#

GET/api/v1/outputsList outputs
POST/api/v1/outputsRegister output
POST/api/v1/outputs/batch-deleteBatch delete outputs
GET/api/v1/outputs/pageList outputs under a scan-wide snapshot
GET/api/v1/outputs/projected-pageList audience-safe output projections under a scan-wide snapshot
GET/api/v1/outputs/statsOutput storage stats
POST/api/v1/outputs/upload-urlGenerate output upload URL
GET/api/v1/outputs/{id}Get output
PATCH/api/v1/outputs/{id}Update output metadata
DELETE/api/v1/outputs/{id}Soft delete output
GET/api/v1/outputs/{id}/downloadGenerate output download URL
POST/api/v1/outputs/{id}/move-tierMove output storage tier
POST/api/v1/outputs/{id}/restoreRestore output
POST/api/v1/outputs/{id}/verifyVerify output integrity

Packages (7)#

POST/api/v1/packagesCommit a multi-part package
POST/api/v1/packages/gcCollect unreferenced package blobs
POST/api/v1/packages/uploadsBegin uploading package parts
GET/api/v1/packages/{id}Get a package
DELETE/api/v1/packages/{id}Delete a package
GET/api/v1/packages/{id}/downloadSigned downloads for every part
POST/api/v1/packages/{id}/verifyVerify every part against the store

Policies (6)#

GET/api/v1/policiesList retention policies
POST/api/v1/policiesCreate retention policy
POST/api/v1/policies/applyApply retention policies
GET/api/v1/policies/{name}Get retention policy
PATCH/api/v1/policies/{name}Patch retention policy
DELETE/api/v1/policies/{name}Delete retention policy

Provenance (4)#

POST/api/v1/outputs/admin/provenance/backfillBackfill missing provenance and enrich consistency metadata
GET/api/v1/outputs/{id}/provenanceGet output provenance
POST/api/v1/outputs/{id}/provenanceRegister output provenance
PATCH/api/v1/provenance/{id}Update provenance record

Scenes (9)#

POST/api/v1/scenesCreate a scene
GET/api/v1/scenes/{sceneId}Get a scene's head
POST/api/v1/scenes/{sceneId}/editsEdit a scene
POST/api/v1/scenes/{sceneId}/locksLock scene nodes or a region
DELETE/api/v1/scenes/{sceneId}/locks/{lockId}Release a scene lock
POST/api/v1/scenes/{sceneId}/redoRedo an undone scene change
POST/api/v1/scenes/{sceneId}/restoreRestore a scene revision as a new head
GET/api/v1/scenes/{sceneId}/revisions/{revision}Get a scene revision
POST/api/v1/scenes/{sceneId}/undoUndo the last scene change

Schemas (11)#

ErrorResponseobjectJsonObjectobjectOutputListPageobjectOutputProjectedPageobjectOutputProjectedRecordobjectOutputProjectionFieldsobjectOutputSnapshotPageobjectPresentProjectionFieldobjectProjectionFieldobjectStaleProjectionFieldobjectValuelessProjectionFieldobject