Systems
Beta Preview
The facade clients are in beta in istari-digital-client 14.0.0, and their API may change between releases. Facade clients (beta) explains how they work.
Create Systems, work on branches, open and merge change requests, read package dependencies and log workflow runs.
The same domain on the other clients: Client: Systems and Change requests. V3Client: Systems.
istari.systems
| Method | What it does |
|---|---|
istari.systems.list | List Systems |
istari.systems.get | Fetch one System |
istari.systems.create | Create a System (name and description are required) |
istari.systems.update | Change a System's name or description |
istari.systems.archive | Archive a System |
istari.systems.restore | Restore an archived System |
istari.systems.branches
| Method | What it does |
|---|---|
istari.systems.branches.list | List a System's branches |
istari.systems.branches.get | Fetch a branch by name |
istari.systems.branches.create | Create a branch, optionally from another branch |
istari.systems.branches.commit | Add or remove revisions, place them in folders, replace manifests — in one commit |
istari.systems.branches.preview | Plan what a commit would install, without writing |
istari.systems.branches.resources | Tracked Resources on a branch, with their paths |
istari.systems.branches.search | Filter a branch's tracked Resources |
istari.systems.branches.contents | Tracked Resources and their content in one call |
istari.systems.branches.subsystems | Subsystems a branch tracks |
istari.systems.branches.archive | Archive a branch |
istari.systems.branches.restore | Restore an archived branch |
istari.systems.change_requests
| Method | What it does |
|---|---|
istari.systems.change_requests.list | List a System's change requests |
istari.systems.change_requests.get | Fetch one change request |
istari.systems.change_requests.create | Open a change request from a source branch to a target branch |
istari.systems.change_requests.update_status | Set a change request's status |
istari.systems.change_requests.merge | Merge a change request, or check that it can merge |
istari.systems.dependencies
| Method | What it does |
|---|---|
istari.systems.dependencies.requirements | Editable copy of a branch's package requirements |
istari.systems.dependencies.publications | Editable copy of the packages a branch publishes |
istari.systems.dependencies.packages | Package folders the branch's snapshot installs |
istari.systems.dependencies.files | Package files the snapshot puts in the tree |
istari.systems.dependencies.updates | Installed folders whose line has a newer release |
istari.systems.dependencies.lock | Summary of what the snapshot installs |
istari.systems.dependencies.checkout | Download the branch's snapshot to a local folder |
istari.systems.workflows
| Method | What it does |
|---|---|
istari.systems.workflows.list | List a System's workflow log entries |
istari.systems.workflows.get | Fetch one entry with its outputs |
istari.systems.workflows.create | Log a workflow run |
istari.systems.workflows.create_output | Upload a file as a workflow output |
istari.systems.workflows.archive | Archive an entry |
istari.systems.workflows.restore | Restore an archived entry |