Links
The Meltano Cloud API uses link relations to communicate the capabilities of our resources. Where you see a link with one of the following relations, you can expect our API to act accordingly provided nothing has changed in the meantime.
Resource Type Relations
All resource types define an item and collection relation. These appear as or in (alongside actions) link relations throughout the Meltano Cloud API.
| Resource | Item relation | Collection relation |
|---|---|---|
| Profile | profile | profiles |
| Workspace | workspace | workspaces |
| Invitation | invitation | invitations |
| Member | member | members |
| Administrator | administrator | administrators |
| Dataset | dataset | datasets |
| Channel | channel | channels |
| Comment | comment | comments |
| Tag | tag | tags |
| Dataplugin | dataplugin | dataplugins |
| Datastore | datastore | datastores |
| Pipeline | pipeline | pipelines |
| Job | job | jobs |
| Subscription | subscription | subscriptions |
| Notification | notification | notifications |
| API Key | apikey | apikeys |
A link relation formed entirely from an item or collection relation will accept a GET request and return the respective resource. Expect 200 OK to indicate the resource was successfully returned.
Paging, Sizing and Sorting
Collection link relations accept paging, sizing and sorting query parameters, which can be used to modify the dimensions of the response payload.
| Query Parameter | Description | Syntax | Example |
|---|---|---|---|
page | The page of the collection | page={page-number} | ?page=1 |
size | The number of elements to display per page | size={number-of-elements} | ?size=20 |
sort | The property to sort the collection results by, in either ascending - asc - or descending - desc - order | sort={property-name},(asc|desc) | ?sort=name,asc |
Searching and Filtering
A search action indicates the acceptance of the q query parameter, which is used to filter the content returned in the response payload. Filter definitions control the type of filtering applied.
Filter
| Type | Description | Syntax | Example |
|---|---|---|---|
| Free text | The free text to filter by | {free-text} | ?q=data%20insights |
| Channel | The channel to filter by | in:{channel-name} | ?q=in:meltano |
| Tag | The tag to filter by | tag:{tag-name} | ?q=tag:jupyternotebook |
The Meltano Cloud API supports multiple filter definitions, including those of the same type:
?q=data%20insights in:meltano tag:jupyternotebook`
?tag:ai tag:deeplearning tag:machinelearning
Actions
Actions are phrases that define the behaviour of a HTTP transaction. A link relation is formed from an action verb either entirely or in conjunction with a subject resource relation in the format "{action} {resource-relation}".
"self"
"update workspace"
"publish dataset"
"create pipeline"
"new job"
latest
Make a GET request to this link to return the latest resource. Expect 200 OK to indicate the resource was successfully returned.
search
Make a GET request to this link to a return a filtered view of the current respective resource. Expect 200 OK to indicate the resource was successfully returned.
self
Make a GET request to this link to return the current respective resource. Expect 200 OK to indicate the resource was successfully returned.
new
Make a POST request to this link to initialise a new resource. Expect 200 OK to indicate the resource was successfully initialised.
publish
Make a POST request to this link to publish data into a resource. Expect 201 Created or 200 OK to indicate the resource was successfully published.
validate
Make a POST request to this link to validate a resource. Expect 200 OK to indicate the resource was successfully validated.
verify
Make a POST request to this link to verify a resource. Expect 200 OK to indicate the resource was successfully verified.
add
Make a PUT request to this link to add a new resource. Expect 200 OK to indicate the resource was successfully added.
create
Make a PUT request to this link to create a new resource. Expect 201 Created or 202 Accepted to indicate the resource was successfully created.
draft
Make a PUT request to this link to create or update a draft resource. Expect 200 OK or 201 Created to indicate the resource was successfully drafted.
make-default
Make a PUT request to this link to set a particular resource within a collection as default. Expect 200 OK to indicate the resource was successfully set as default.
update
Make a PUT request to this link to update a resource. Expect 200 OK to indicate the resource was successfully updated.
withdraw
Make a PUT request to this link to withdraw a resource. Expect 200 OK to indicate the resource was successfully withdrawn.
edit
Make a PATCH request to this link to edit a resource. Expect 200 OK to indicate the resource was successfully edited.
delete
Make a DELETE request to this link to delete a resource. Expect 204 No Content to indicate the resource was successfully deleted.