You can create, update, and delete projects and folders through REST API calls.
Note: If a project or folder name contains special characters, space characters, or international characters, use URL encoding in the URI so that the server can properly decode the name.
For example, for a project named "My Project," include the following text in the URI:
My%20Project
You can't use the following characters:
# ? ' | { } " ^ & [ ] / \
Creating a project
Create projects to organize your assets.
POST request
To create a project, send a POST request using the following URI:
/public/core/v3/projects
Note: You can create a maximum of 500 projects usingInformatica Intelligent Cloud Services REST API.
Include the following information:
Field
Type
Required
Description
name
String
Yes
Name of the project.
description
String
-
Description of the project.
POST response
If successful, returns the projects object with the following details:
Field
Type
Description
id
String
Project ID.
name
String
Project name.
description
String
Project description.
updatedBy
String
User who created the project.
updateTime
String
Date and time the project was created.
POST example
To create a project, you might send a request similar to the following example:
POST <baseApiUrl>/public/core/v3/projects Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "name":"Orders", "description": "Orders from all regions" }
You might receive a response similar to the following example:
{ "id": "kTKQG4Kv3uhgQleaOoUbWu", "name": "Orders", "description": "Orders from all regions", "updatedBy": "scotty@infa.com", "updateTime": "2022-04-12T23:40:40.395Z" }
Updating a project
You can change a project's name or description if you have update permission for the project.
PATCH request
To update a project, send a PATCH request using one of the following URIs:
/public/core/v3/projects/<project ID>
/public/core/v3/projects/name/<project name>
Include the following information:
Field
Type
Required
Description
name
String
-
Name of the project.
description
String
-
Description of the project.
PATCH response
Returns a success code if successful or an error object if errors occur.
PATCH example
To update a project, you might send a request similar to the following example:
PATCH <baseApiUrl>/public/core/v3/projects/kTKQG4Kv3uhgQleaOoUbWu Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "name":"Requests", "description": "Orders from all regions" }
Deleting a project
You can delete a project from your organization if it doesn't contain any folders or assets and if you have delete permission for the project.
DELETE request
To delete a project, use one of the following URIs:
/public/core/v3/projects/<project ID>
/public/core/v3/projects/name/<project name>
DELETE example
To delete a project named "All Orders," you might send the following request:
Note: You can include project and folder IDs or project and folder names in a URI, but you can't include an ID and a name in a URI. For example, you can't include the project ID and the folder name.
Include the following information:
Field
Type
Required
Description
name
String
-
Name of the folder.
description
String
-
Description of the folder.
PATCH response
Returns a success code if successful or an error object if errors occur.
PATCH example
To change the name and description of the Northeast Orders folder, you might send a request similar to the following example:
PATCH <baseApiUrl>/public/core/v3/projects/name/Orders/folders/name/Northeast%20Orders Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "name":"Northeast Requests", "description": "Requests from the northeast offices" }
Deleting a folder
You can delete a folder if it is empty and you have delete permission for the folder. If the folder contains assets, you must delete or move the assets before you can delete it.
DELETE request
To delete a folder that's in the Default project, use the following URI:
/public/core/v3/projects/<folder ID>
To delete a folder that's in a project other than the Default project, use one of the following URIs:
Note: You can include project and folder IDs or project and folder names in a URI, but you can't include an ID and a name in a URI. For example, you can't include the project ID and the folder name.
DELETE example
To delete a folder named "Orders:West Coast," you might send the following request: