Clear Work Item

Arguments

Remove all data in the current work item.

Delete Work Item Variables

Arguments

  • *names
  • force=True

Delete variable(s) from the current work item.

param names:names of variables to remove
param force:ignore variables that don't exist in work item

Get Work Item Payload

Arguments

Get the full JSON payload for a work item.

NOTE: Most use cases should prefer higher-level keywords.

Get Work Item Variable

Arguments

  • name
  • default=

    Return a single variable value from the work item, or default value if defined and key does not exist. If key does not exist and default is not defined, raises KeyError.

    param key:Name of variable
    param default:Default value if key does not exist

    Get Work Item Variables

    Arguments

    Read all variables from the current work item and return their names and values as a dictionary.

    List Work Item Variables

    Arguments

    List the variable names for the current work item.

    Load Work Item

    Arguments

    • workspace_id
    • item_id

    Load work item for reading/writing.

    param workspace_id:
     Workspace ID which contains item
    param item_id:Workitem ID to load

    Load Work Item From Environment

    Arguments

    Load current work item defined by the runtime environment.

    The corresponding environment variables are:

    • RC_WORKSPACE_ID
    • RC_WORKITEM_ID

    Save Work Item

    Arguments

    Save the current data in the work item. If not saved, all changes are discarded when the library goes out of scope.

    Set Task Variables From Work Item

    Arguments

    Convert all variables in the current work item to Robot Framework task variables.

    Set Work Item Payload

    Arguments

    • payload

    Set the full JSON payload for a work item.

    NOTE: Most use cases should prefer higher-level keywords.

    param payload:Content of payload, must be JSON-serializable

    Set Work Item Variable

    Arguments

    • name
    • value

    Set a single variable value in the current work item.

    param key:Name of variable
    param value:Value of variable

    Set Work Item Variables

    Arguments

    • **kwargs

    Set multiple variables in the current work item.

    param kwargs:Pairs of variable names and values