Skip to main content

Use Cases Workflow

Manage workflow associated with use cases.

Methods​

get​

Get Use Case Workflow Status Get a use case's current workflow stage and step.

Returns the workflow stage ID, step, and optionally the full stage details.

use_case_id = "use_case_id-123"

response = client.use_case_workflow.get(
    use_case_id=use_case_id,
)

Parameters:

  • use_case_id (str, required) - Resource identifier

Returns: Response object

update​

Update Use Case Workflow Status Update a use case's workflow stage and step.

Moves the use case to the specified workflow stage and optionally sets the step within that stage.

from credoai import UseCaseWorkflowUpdate

use_case_id = "use_case_id-123"

data = UseCaseWorkflowUpdate(
    id="workflow-456"
)

response = client.use_case_workflow.update(
    use_case_id=use_case_id,
    data=data,
)

Parameters:

  • use_case_id (str, required) - Resource identifier
  • data (UseCaseWorkflowUpdate, required) - Request payload

Returns: Response object

advance_step​

Advance Use Case Workflow Step Advance to the next step within the current workflow stage.

Step progression: assessment → evidence_collection → clear

Returns an error if already at a terminal step (clear or rejected).

use_case_id = "use_case_id-123"

response = client.use_case_workflow.advance_step(
    use_case_id=use_case_id,
)

Parameters:

  • use_case_id (str, required) - Resource identifier

Returns: Response object

advance_stage​

Advance Use Case Workflow Stage Advance to the next workflow stage, resetting to assessment step.

Uses the child_id of the current stage to determine the next stage. Returns an error if at the end stage or no next stage is defined.

use_case_id = "use_case_id-123"

response = client.use_case_workflow.advance_stage(
    use_case_id=use_case_id,
)

Parameters:

  • use_case_id (str, required) - Resource identifier

Returns: Response object

reject​

Reject Use Case in Workflow Reject a use case by setting its workflow step to 'rejected'.

The rejected step is a terminal state - the use case cannot progress further in the workflow until it is moved back to an earlier step. Returns an error if the use case is already in the rejected state.

use_case_id = "use_case_id-123"

response = client.use_case_workflow.reject(
    use_case_id=use_case_id,
)

Parameters:

  • use_case_id (str, required) - Resource identifier

Returns: Response object

Example: Working with Use Cases Workflow​

from credoai import CredoAI, RelationshipAdd

client = CredoAI()

# List workflow for a use_case
workflow = client.use_case_workflow.list(use_case_id="use_case-123")
for item in workflow.items:
    print(f"\\{item.id}")

# Add a workflow
client.use_case_workflow.add(
    use_case_id="use_case-123",
    data=RelationshipAdd(id="workflow-456")
)

# Remove a workflow
client.use_case_workflow.remove(
    use_case_id="use_case-123",
    workflow_id="workflow-456"
)