Rocketlane provides API functionality to interact with documents stored in a Space, including retrieving specific documents if you know their projectId and documentId. This guide provides step-by-step instructions for retrieving a document and finding the required documentId using developer tools in your browser.
Steps to Retrieve a Document Using the Rocketlane API
To retrieve a document from a Rocketlane Space using the API, follow these steps:
Make an API Call to Fetch the Document Content: - Use the document-fetch API endpoint. - Include the relevant projectId and documentId in the API request path or parameters. - For example, replace the placeholders in the following GET request structure: GET https://api.rocketlane.com/projects/{projectId}/documents/{documentId} - Submit the request to this endpoint to fetch the document content.
Finding the documentId for a Document
In order to retrieve a document from a Space, you need its unique documentId. Follow these steps to locate it:
Open the Space in Your Web Browser: - Navigate to the Rocketlane Space where your document is stored.
Inspect Network Activity Using Your Browser's Developer Tools: - Open the developer tools in your browser (e.g., F12 for Chrome). - Go to the Network tab.
Refresh the Page and Filter Requests: - Refresh the Space page to load network requests. - Look for API calls related to documents in the network logs.
Extract the documentId: - Find the documentId in the request URL or response payload. - Copy the documentId for use in API calls.
Troubleshooting Tips
Ensure you have the necessary permissions and API keys for accessing Rocketlane API endpoints.
Use tools like Postman or similar API clients to test your API requests for accuracy.
When inspecting browser network activity, use filters to quickly locate relevant API calls.