Create and activate a project. To learn more, see Instance Configuration and Projects in the Smart Completions Help.
While you can create and activate a project with the Projects endpoint, you must use the Smart Completions Configuration Wizard in the Smart Completions
application to configure a project. For more information, see Project Configuration.
Supported HTTPS Methods: POST
Request URL:
<HOSTNAME>/sc/datalake/v1/Instances(2)/Projects
Header parameters:
|
Header Parameter |
Description |
|---|---|
|
Authorization |
A token required for authenticating a request. The bearer token is a string, usually generated by the server in response to a login request. You must include this header in every request. |
|
Content-Type |
The request format or the original media type of the resource. |
Sample request payload:
{
"ProjectIdentifier": "00004440"
"ProjectName": "Template Project"
}
Request payload parameters:
|
|
|
Required, Optional, |
|
|---|---|---|---|
|
ProjectIdentifier |
String |
Required |
Unique ID of the project to create. If the project is from an external system, the ID of the project from that system. |
|
ProjectName |
String |
Recommended |
Unique name of the project to create. If the project is from an external system, the name of the project from that system. |
Sample response parameters:
{
"Id": 41,
"WorkBreakdownUp3Id": 41,
"CompanyInstanceId": 1,
"ProjectIdentifier": "0000",
"ProjectName": "Template Project",
"Project": "0000 - Template Project"
}
Response Parameters:
|
|
|
|
|---|---|---|
|
Id |
Integer |
Unique ID assigned to the project by Smart Completions. |
|
WorkBreakdownUp3Id |
Integer |
Same as Id. When traversing the Smart Completions hierarchies, other APIs use the WorkBreakdownUp3Id parameter to specify the project. |
|
CompanyInstanceId |
Integer |
Smart Completions ID for the Instance where the project was created. |
|
ProjectIdentifier |
String |
Unique ID for the project defined in the request payload. |
|
ProjectName |
String |
Unique ID for the project defined in the request payload. |
|
Project |
String |
Unique name for the project. The name concatenates the ProjectName and Project parameters, separated by a hyphen. For example, 0000 - Template Project. |