Paths
Organization and Project Resources
The API provides a structured path to access resources related to organizations and their associated projects. The path for accessing these resources is as follows:
/api/v1/org/{org_id}/proj/{proj_id}
This endpoint is designed to interface with specific data tied to both an organization and one of its projects. Below is a detailed explanation of the path parameters:
Path Parameters
org_id (required): This is the unique identifier for the organization. It remains consistent across all projects within the same organization. When you make a request to the API, replace {org_id} with the actual org_id value that corresponds to the organization you are attempting to access.
proj_id (required): This is the unique identifier for a project within the organization. Each project under an organization will have a distinct proj_id. Replace {proj_id} with the actual project ID value for the project you wish to access.
These can be found in the URL of your project:
Usage
To interact with this endpoint, you'll need to make an HTTP request to the API server using the appropriate method:
Example Request
GET /api/v1/org/12345/proj/67890
Host: senslysolutions.com
Authorization: Bearer {your_access_token}
Replace 12345 with the actual org_id, 67890 with the actual proj_id, and {your_access_token} with your access token found on your profile.
HTTP Methods
This API path supports several HTTP methods, each serving a different purpose:
GET: Retrieve details about a specific project within an organization. POST: Create a new resource or perform an action in the context of the specified project. PUT: Update the details or state of a specific project within an organization. DELETE: Remove a project from the organization.
Note that the availability of these methods may depend on the specific business logic and permission levels within your application.
Responses
The API will return JSON-formatted responses containing the relevant data or confirmation of action taken. Error responses will also be in JSON format, providing clear error messages and status codes that conform to standard HTTP response status codes.