Scenario Executions

Here are some common scenarios demonstrating how to use the Agentic API Project Overview page to manage your projects effectively.

Possible usage steps within this page:

Scenario 1: Adding a New Agentic API Project

1. On the "Agentic API Project Overview" page, locate and click the "Add new project" button.
2. You will be redirected to a new page or a dialog where you can enter the details for your new project, such as its name, description, and initial configurations.
3. Follow the on-screen prompts to define credentials, assign target devices, and set access permissions.
4. Once all required information is entered, click the "Save" or "Create Project" button to finalize the creation.
5. The new project will now appear in your list of available projects on the overview page.

Scenario 2: Viewing Details of an Existing Project

1. Navigate to the "Agentic API Project Overview" page.
2. From the list of available projects, locate the specific project you wish to inspect.
3. Click on the project's tile to open its detailed view.
4. On the detail page, you can review all configured aspects of the project, including its assigned devices, credentials, and permissions.

Scenario 3: Editing an Existing Project

1. Go to the "Agentic API Project Overview" page.
2. Find the project you want to modify in the list.
3. Click on the "Edit" icon or button associated with that project's tile.
4. You will be taken to an editing interface where you can adjust the project's settings.
5. Make the necessary changes and then click "Save" or "Update Project" to apply them.
6. The updated project details will be reflected on the overview page.

Scenario 4: Deleting an Agentic API Project

1. On the "Agentic API Project Overview" page, identify the project you intend to delete.
2. Click the "Delete" icon or button on the project's tile.
3. A confirmation dialog will appear, asking you to confirm the deletion. This is a critical step to prevent accidental data loss.
4. Confirm your action. The project will be permanently removed from your list, and associated device access will be revoked.

Scenario 5: Hiding the Information Banner

1. When you first access the "Agentic API Project Overview" page, you might see an information banner at the top providing context.
2. If you wish to hide this banner, click the "Close" (X) icon located in the top-right corner of the banner.
3. The banner will disappear and will remain hidden during subsequent visits to the page, remembering your preference.

Possible errors which may occur on this page:

Error: Project not appearing after creation/edit

Why it happens: This might occur if there was a network issue during the save process, or if the system is experiencing a temporary delay in refreshing the project list. Although the page code has logic for refreshing, external factors can interfere.

What to do: Try refreshing the entire page. If the issue persists, verify your internet connection. If the problem continues, contact support with details of your actions.

Error: Unable to delete a project

Why it happens: This could be due to network connectivity issues preventing the deletion request from reaching the server, or if the project has dependencies that prevent its removal (e.g., actively shared devices, which would typically be indicated by the system). Sometimes, insufficient user permissions can also cause this.

What to do: Check your internet connection. Ensure you have the necessary permissions. If there are messages indicating dependencies, you might need to resolve those first. If none of these apply, refresh the page and try again. Contact support if the problem persists.