Projects API Overview

Learn more about the Projects API.

Use the Projects API to create a project, commit project changes, and publish a project to production. To make changes in a project with Visier APIs, use the ProjectID request header or projectId request body field in other Visier APIs, such as the Users and Permissions APIs. For more information about if the project ID request body field or request header is available, see the API reference for the API you're using.

We support the ProjectID request header in the following API requests:

  • Manage users' security assignments, including permissions and user groups. For more information, see Users API.

    Note:  

    • Creating, updating (display name, employee ID, account enabled, email), and deleting users are not subject to the project lifecycle.
    • Visier doesn't support ProjectID for retrieving the application logs, data security report, profile assignments, and user permissions in XLSX format.
  • Create and manage user groups. For more information, see User Groups V2.
  • Create and manage permissions. For more information, see Permissions API.

Tip: We recommend that you make a collection of API changes in a single project; for example, create a set of new permissions and assign the new permissions to users in one project.

If you submit API requests for changes that are subject to the project lifecycle without a project ID, each request is individually published to production, resulting in hundreds or thousands of production versions. With a large number of production versions, it is more difficult to track related changes.

To specify a project for specific tenants:

  • Use the tenantCode request body field or TargetTenantID request header to specify an analytic tenant to make the API request in. If omitted, the API request is made in the administrating tenant.
  • Use the projectId request body field or ProjectID request header to specify the project in which to make the request. If omitted, any changes are published to production immediately. In APIs that support both projectId and ProjectID, the request uses any project IDs defined in the request body first and then uses the ProjectID header for any definitions that don't have a projectId in the request body.

For more information about which request body fields and request headers are available, see the API reference for the API you're using.