Accessing and Manipulating Records

Creating Records

Via the User Interface

1. Switch to the record-type in the left hand navigation bar.
2. Press the "new" button.
3. The new record is assigned a random name and opened in the main section.

Via the REST API

Send a POST request to:

https://<your-workspace-name>.cloudomation.com/api/3/<resource-name>

The JSON payload should contain all fields you wish to set.

Via the Cloudomation Flow-API

import flow_api
def handler(system: flow_api.System, this: flow_api.Execution):
    system.<record-type>('name of the new record').save()
    # for example:
    system.setting('my-new-setting').save()
    # you can set fields of the new record:
    system.setting('my-new-setting').save(value=42, description='some number')

Listing records

Via the User Interface

1. Switch to the record-type in the left hand navigation bar.
2. The record list is displayed in the main section.

Via the REST API

Send a GET request to:

https://<your-workspace-name>.cloudomation.com/api/3/<resource-name>

Via the Cloudomation Flow-API

Use the following method:

import flow_api
def handler(system: flow_api.System, this: flow_api.Execution):
    for record in system.<record-type>s():
        # do something with "record"
    # for example:
    for webhook in system.webhooks():
        webhook.save(is_enabled=False)
    # you can use filter expressions
    for webhook in system.webhooks(
            filter={
                'field': 'is_enabled',
                'op': 'eq',
                'value': True,
            }
    ):
        webhook.save(is_enabled=False)

Reading Records

Via the User Interface

1. Switch to the record-type in the left hand navigation bar.
2. The record list is displayed in the main section.
3. Click on the name of a record in the list.
4. The record is opened in the main section.

Via REST API

Send a GET request to

https://<your-workspace-name>.cloudomation.com/api/3/<resource-name>/<record-ID>

You can also access most records by name:

Send a GET request to:

https://<your-workspace-name>.cloudomation.com/api/3/<resource-name>/<record-name>?by=name

You can specify the fields you are interested in:

https://<your-workspace-name>.cloudomation.com/api/3/<resource-name>/<record-ID>?fields=id,name,description

Via Flow API

Use the following method:

import flow_api
def handler(system: flow_api.System, this: flow_api.Execution):
    system.<record-type>('name of the new record').get('name of field(s) to read')
    # for example:
    description = system.flow('my-flow').get('description')
    # you can read several fields at once:
    created_at, modified_at = system.flow('my-flow').get('created_at', 'modified_at')

Updating Content

Via the User Interface

1. Switch to the record-type in the left hand navigation bar.
2. The record list is displayed in the main section.
3. Click on the name of a record in the list.
4. The record is opened in the main section.
5. Change any field in the record.
6. Press the "save" button.

Via REST API

Send a POST request to:

https://<your-workspace-name>.cloudomation.com/api/3/<resource-name>/<record-ID>

The JSON payload should contain all fields you wish to update.

Via Flow API

Use the following method:

import flow_api
def handler(system: flow_api.System, this: flow_api.Execution):
    system.user('myself').save(description='This is me')

Deleting Content

Via the User Interface

1. Switch to the record-type in the left hand navigation bar.
2. The record list is displayed in the main section.
3. Click on the name of a record in the list.
4. The record is opened in the main section.
5. Press the "delete" button.

Via REST API

Send a DELETE request to:

https://<your-workspace-name>.cloudomation.com/api/3/<resource-name>/<record-ID>

Via Flow API

Use the following method:

import flow_api
def handler(system: flow_api.System, this: flow_api.Execution):
    system.file('document.pdf').delete()