Sharing

apic docs

Home Features Downloads

Search…

About APIC

Installing APIC

Getting started with APIC

Designer

Tester

Test Real User Sessions

APIC Command line interface (apic-cli)

APIC Web Agent (apic-cli)

APIC CI/CD Integration (with Jenkins)

APIC's sharing feature allows yuo to share your API Project design, Requests & folders, Test Case projects & Test Suites and environments with others users. You can share your stuff with a team and once sharing is complete it will be available to all the members of the shared team. If you desire to remove sharing you can do that as well by un-sharing the object.
The Share option is available with each API Design Project, Saved request folders, Test Case projects. On clicking Share a popup will appear to select the team you want to share with. If you don't have a team then go to Dashboard and create one. Select the Team you want to share with and you are done. Your shared object will now appear in the APIC instance of each members of the shared team.
Sharing an API Project Design
You can share an API design project by clicking on the share button in the projects home screen as shown below
​
Once the sharing is complete you can see the option to Un-Share as shown above.
Users who has now access to this shared API Design Project can only modify it. They wont be able to share/un-share it or delete it. They wont be able to publish/re-publish it as well.
Sharing Folders and Saved Requests
You can share a request folder along with all its sub-folders and saved requests under it. Only a parent level folder can be shared. If you wish to share a sub-folder then you will have to share its parent folder as sharing option is only available with parent label folders.
To share a folder open up the folder menu (3 dot menu) beside it and click Share, Select the team and you are done. Now this folder along with all its sub-folders and saved requests under it will appear in the APIC instance of all members of the shared team. Once sharing is complete you will get the option to Un-Share.
​
Users who now have access to this shared Folder can modify it, add/update/delete Requests, add/update/delete sub-folders.
Sharing a Test Project and Test Suite
You can share your Test Project along with all Test Suites under it by clicking on the project menu (3 dot menu) beside it and selecting the team to share. Once sharing is complete you will see the option to Un-Share. Test Suites can't be shared individually, to share a test suite you will have to share its parent Test Project.
Users who now have access to this shared Test Project can add/update/remove Test Suites under it.
Sharing Environments
Environments module allows you to share and unshare multiple environments at once. To share or unshare environments click on the share or unshare button on the top respectively. Select environments and share/unshare.
​
Users who now have access to the shared environments can only use them. They can't modify or delete it as environments will be used more frequently and each team member modifying them for their own need will affect others.

Published Docs

Last modified 2yr ago

Copy link

Outline

Sharing an API Project Design

Sharing Folders and Saved Requests

Sharing a Test Project and Test Suite

Sharing Environments