Agent

analyze.agent.add_message(agent_id)

Adds a message to the agent queueu

Parameters

agent_id (str) – Unique agent identifier

Returns

None

analyze.agent.agent(agent_id)

Provides detailed agent information

Parameters

agent_id (str) – Unique agent identifier

Returns

None

analyze.agent.agents(id_filter)

Provides a list of agents within the workspace

Parameters

id_filter (list) – List or tuple of object unique identifiers to which to limit the results

Returns

None

analyze.agent.agents_from_path(path)

Provides list of agents based on a path fragment. Path fragment can be to parent level.

Parameters

path (str) – Object rollup path using unix style forward slashes

Returns

None

analyze.agent.copy(agent_id, rollup_id, after_position)

Copies an agent

Parameters

  • agent_id (str) – Unique agent identifier

  • rollup_id (str) – Unique rollup identifier

  • after_position (int) – Position within the object rollup the object should be placed after

Returns

None

analyze.agent.create(rollup_id, name, memo, enabled)

Creates an agent

Parameters

  • rollup_id (str) – Unique rollup identifier

  • name (str) – Agent name

  • memo (str) – Agent description

  • enabled (bool) – Flag for agent being enabled for use

Returns

None

analyze.agent.create_rollup(rollup_id, position, name)

Creates a folder in the agent hierarchy

Parameters

  • rollup_id (str) – Unique rollup identifier

  • position (int) – The position order of the object within the rollup

  • name (str) – The object name

Returns

None

analyze.agent.delete(agent_id)

Deletes an agent

Parameters

agent_id (str) – Unique agent identifier

Returns

None

analyze.agent.delete_rollup(rollup_id)

Deletes a folder and its contents in the agent hierarchy

Parameters

rollup_id (str) – Unique rollup identifier

Returns

None

analyze.agent.disable(agent_id)

Sets an agent to disabled to prevent usage and access

Parameters

agent_id (str) – Unique agent identifier

Returns

None

analyze.agent.enable(agent_id)

Sets the agent to enabled for use and access

Parameters

agent_id (str) – Unique agent identifier

Returns

None

analyze.agent.id_from_path(path)

Provides the cannonical id for the from a provided path

Parameters

path (str) – Object rollup path using unix style forward slashes

Returns

None

analyze.agent.is_running(agent_id)

Checks if the specified agent is running by checking whether the LastContact field in the database is recent for the specified agent. If never filled in then it is an old version of the agent.

Parameters

agent_id (str) – Unique agent identifier

Returns

True if agent is running else False

Return type

bool

analyze.agent.make_rollups(path)

Creates the path and all intermediate rollup points

Parameters

path (str) – Object rollup path using unix style forward slashes

Returns

None

analyze.agent.move(agent_id, rollup_id, after_position)

Moves an agent in the hierarchy

Parameters

  • agent_id (str) – Unique agent identifier

  • rollup_id (str) – Unique rollup identifier

  • after_position (int) – Position within the object rollup the object should be placed after

Returns

None

analyze.agent.paths_from_id(agent_id)

Provides a list of paths associated with the cannonical id

Parameters

agent_id (str) – Unique agent identifier

Returns

None

analyze.agent.regenerate(agent_id)

Regenerates the agent oAuth2 token

Parameters

agent_id (str) – Unique agent identifier

Returns

None

analyze.agent.restart(agent_id)

Signals the PlaidLink agent to restart on the remote system

Parameters

agent_id (str) – Unique agent identifier

Returns

None

analyze.agent.search_by_name(text, criteria='contains')

Provides a list of tags for agents

Parameters

  • text (str) – The search text to locate

  • criteria (str) – The search criteria (contains, exact, startswith, or endswith)

Returns

None

analyze.agent.update(agent_id, name, memo)

Updates an agent name and memo

Parameters

  • agent_id (str) – Unique agent identifier

  • name (str) – The object name

  • memo (str) – The object description

Returns

None

analyze.agent.update_rollup(rollup_id, position, name)

Updates a folder name in the agent hierarchy

Parameters

  • rollup_id (str) – Unique rollup identifier

  • position (int) – The position order of the object within the rollup

  • name (str) – The object name

Returns

None