sym.sdk.flow.Run¶

class sym.sdk.flow.Run(srn: Union[sym.sdk.resource.SRN, str])¶

Bases: sym.sdk.resource.SymResource

A Run represents an instance of a Flow in progress.

For example, each new access request using the sym:template:approval:1.0 Template would generate a new Run with data pertaining to that specific access request.

Methods

dict()

Represent this resource as a dictionary.

Attributes

`actors`	A dict mapping `Event` names to the `User` that created each `Event`.
`contexts`	A dict mapping `Event` names to the context attached to each `Event`.
`name`	An alias for this resource's slug, derived from its `SRN`.
`source_channel`	A `Channel` object, which contains information about the where the `Run`'s first `Event` came from.
`srn`	A `SRN` object that represents the unique identifier for this resource.

property actors¶

A dict mapping Event names to the User that created each Event. There will be one entry for each Event in the current Run.

For example, with a sym:approval Flow, after the “approve” Event is received, the actors may look like this:

{
    "prompt": <User A>,
    "request": <User A>,
    "approve": <User B>
}

property contexts¶

A dict mapping Event names to the context attached to each Event. There will be one entry for each Event in the current Run.

For example, with a sym:approval Flow, after the “approve” Event is received, the contexts may look like this:

{
    "request": {
        "additional_id": "12345"
    }
}

dict()¶: Represent this resource as a dictionary.

property name¶: An alias for this resource’s slug, derived from its SRN.

property source_channel¶: A Channel object, which contains information about the where the Run’s first Event came from.

property srn¶: A SRN object that represents the unique identifier for this resource.