Retrieving a project
Retrieve a project.
Procedure
- In a REST client platform, add the authentication details of the tenant that is
associated with the project you want to retrieve.
//In case of Instance API key Headers: { "x-instance-api-key": "instance_api_key" } // In case of MCSP or ISV token Headers: { "Authorization": "Bearer mcsp_or_isv_token" } - Make a GET request at the URL of the project.
URL Syntax:
<domain>/apis/v1/rest/projects/:project?=includeCollaborators=trueIn this URL request, /:project is the UID or name of the project you want to retrieve. includeCollaborators lists the users with whom the project is shared. You can set it to either true or false.
Method: GET
If the request is successful, you receive the response code for success.{ output : { name: <project_name>, uid: <project_uid>, tenant_uid: <project_tenant_uid>, workflow_count: <workflow_count>, flowservice_count: <flowservice_count> visibility: <specifies whether a project is accessible to others or restricted> } } "name": "<project_name>", "uid": "<project_uid>", "tenant_uid": "<project_tenant_uid>", "workflow_count": <workflow_count>, "flowservice_count": <flowservice_count>, "created_at": "<date when the project was created>", "updated_at": "<date when the project was last updated>", "visibility": "private", "collaborators": { "<user email id>": { "read": true, "write": false } } } }