swimlane.core.adapters.helper module¶

class swimlane.core.adapters.helper.HelperAdapter(swimlane)[source]¶

Adapter providing any miscellaneous API calls not better suited for another adapter

add_comment(app_id, record_id, field_id, message, rich_text=False)[source]¶

Directly add a comment to a record without retrieving the app or record first

Warning

Does not perform any app, record, or field ID validation

Parameters:

app_id (str) – Full App ID string
record_id (str) – Full parent Record ID string
field_id (str) – Full field ID to target reference field on parent Record string
message (str) – New comment message body
rich_text (bool) – Declare the message as being rich text, default is False

add_record_references(app_id, record_id, field_id, target_record_ids)[source]¶

Bulk operation to directly add record references without making any additional requests

Warning

Does not perform any app, record, or target app/record validation

Parameters:

app_id (str) – Full App ID string
record_id (str) – Full parent Record ID string
field_id (str) – Full field ID to target reference field on parent Record string
target_record_ids (List(str)) – List of full target reference Record ID strings

check_bulk_job_status(job_id)[source]¶

Check status of bulk_delete or bulk_modify jobs .. versionadded:: 2.17.0 :param job_id: Job ID :type job_id: str

Swimlane Python