SDK: views

The views area has 7 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

viewsArchive

Archive a saved view

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/views/{viewId}/archive

viewsArchive(args: { tenantId: string; projectId: string; viewId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<SavedView>

viewsCreate

Save a view: filter, grouping and sort over any issue field

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/views

viewsCreate(args: { tenantId: string; projectId: string; body: CreateViewRequest }, options?: CallOptions): Promise<SavedView>

viewsDelete

Delete a saved view: it is archived and can be restored for 30 days, then removed

• Request: DELETE on /v1/tenants/{tenantId}/projects/{projectId}/views/{viewId}

viewsDelete(args: { tenantId: string; projectId: string; viewId: string }, options?: CallOptions): Promise<SavedView>

viewsList

List saved views; archived=true lists the archived ones that can still be restored

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/views

viewsList(args: { tenantId: string; projectId: string; query?: { archived?: string } }, options?: CallOptions): Promise<ViewList>

viewsRestore

Restore an archived saved view within 30 days

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/views/{viewId}/restore

viewsRestore(args: { tenantId: string; projectId: string; viewId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<SavedView>

viewsRun

Run a saved view with stable ordering

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/views/{viewId}/run

viewsRun(args: { tenantId: string; projectId: string; viewId: string }, options?: CallOptions): Promise<ViewResult>

viewsUpdate

Rename a saved view or change its filter, grouping and sort

• Request: PATCH on /v1/tenants/{tenantId}/projects/{projectId}/views/{viewId}

viewsUpdate(args: { tenantId: string; projectId: string; viewId: string; body: UpdateViewRequest }, options?: CallOptions): Promise<SavedView>