Create and update all three tiers of the Smart Completions WBS hierarchy: Phases, Stages, and Activities.
We recommend using this endpoint only in certain scenarios. For guidance, see WBS API usage guidance.
Supported HTTPS Methods: POST, PUT, PATCH
Request URLs:
-
POST - <HOSTNAME>/sc/datalake/v1/Instances(2)/WorkBreakdowns
-
PUT or PATCH - <HOSTNAME>/sc/datalake/v1/Instances(2)/WorkBreakdowns(60827)
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 POST request payload:
{
"Number": "A1000",
"Name": "Test WBS API",
"WorkBreakdownTypeId": 2,
"ParentId": 264,
"WorkBreakdownSequence": 1,
"WorkBreakdownUp3Id": 264,
"CompanyInstanceId": 2,
}
Sample PUT or PATCH request payload:
{
"Number": "A1000",
"Name": "Test WBS API",
"WorkBreakdownType": "Phase",
"WorkBreakdownTypeId": 2,
"WorkBreakdownParentId": 264,
"ParentId": 264,
"WorkBreakdownSequence": 1,
"WorkBreakdownUp3Id": 264,
"CompanyInstanceId": 2,
"Summary": "A1000 - Test WBS API",
"ParentSummary": "PX01 - Project X",
"ParentNumber": "PX01",
"ParentName": "Project X"
}
Request payload parameters:
|
|
|
Required, Optional, |
|
|---|---|---|---|
|
Number |
String |
PUT - Optional PATCH - Optional POST - Required |
Source system ID for the WBS item. |
|
Name |
String |
PUT - Optional PATCH - Optional POST - Required |
Source system name for the WBS item. |
|
WorkBreakdownType |
String |
PUT - Optional PATCH - Optional POST - Unused |
Read only. Description assigned by Smart Completions to the hierarchy tier of the WBS item based on WorkBreakdownTypeId. |
|
WorkBreakdownTypeId |
Integer |
PUT - Optional PATCH - Optional POST - Required |
Smart Completions hierarchy tier for WBS item: 2 - Phase 3 - Stage 4 - Activity
|
|
WorkBreakdownParentId |
Integer |
PUT - Optional PATCH - Optional POST - Unused |
ID assigned by Smart Completions to the parent of the WBS item. Can be used instead of ParentId. For a Phase, this is the ID of the parent Project. |
|
ParentId |
Integer |
PUT - Optional PATCH - Optional POST - Required |
ID assigned by Smart Completions to the parent WBS item based on WorkBreakdownParentId. For a Phase, this is the ID of the parent Project. |
|
WorkBreakdownSequence |
Integer |
PUT - Optional PATCH - Optional POST - Recommended |
The position of the WBS item within the Smart Completions WBS hierarchy, relative to its siblings. If omitted, the items are organized alpha-numerically. |
|
WorkBreakdownUp3Id |
Integer |
PUT - Optional PATCH - Optional POST - Required |
Smart Completions ID for the Project that contains the WBS item. |
|
CompanyInstanceId |
Integer |
PUT - Optional PATCH - Optional POST - Required |
Smart Completions ID for the Instance that contains the Project. |
|
Summary |
String |
PUT - Required PATCH - Required POST - Unused |
Read only. Unique description created by Smart Completions for the WBS item as: Number - Name |
|
ParentSummary |
String |
PUT - Optional PATCH - Optional POST - Unused |
Read only. Unique description created by Smart Completions for the parent WBS item as: ParentNumber - ParentName |
|
ParentNumber |
String |
PUT - Optional PATCH - Optional POST - Unused |
Read only. ID assigned by Smart Completions to the parent WBS item based on WorkBreakdownParentId. |
|
ParentName |
String |
PUT - Optional PATCH - Optional POST - Unused |
Read only. Name assigned by Smart Completions to the WBS item based on WorkBreakdownParentId. |
This API does not support creating Projects, which are treated as level 1 of the
WBS hierarchy for organizational purposes.
Sample POST response:
{
"@odata.context": "https://sc.acme.com/sc/datalake/v1/
$metadata#Instances(1)/WorkBreakdowns/$entity",
"Id": 1207,
"WorkBreakdownId": 1207,
"Number": "1000",
"Name": "C1 Engineering Design (EDAC)",
"WorkBreakdownType": "Phase",
"WorkBreakdownTypeId": 2,
"ParentId": 264,
"WorkBreakdownSequence": null,
"WorkBreakdownUp3Id": 41,
"CompanyInstanceId": 1,
"Summary": "1000 - C1 Engineering Design (EDAC)",
"ParentSummary": "PPM1 - Template Project1",
"ParentNumber": "PPM1",
"ParentName": "Template Project1",
"RecordCreated": "2023-09-26T08:15:09.45Z",
"RecordLastModified": null,
"dtRemoved": null,
"RecordCreatedBy": null,
"RecordLastModifiedBy": null,
"RecordRemovedBy": null
}
Sample PUT or PATCH response:
The API does not return a response to PUT or PATCH requests.
Response Parameters:
|
Response |
Data |
|
|---|---|---|
|
@odata.context |
String |
Request URL. |
|
Id |
Integer |
ID assigned by Smart Completions to the WorkBreakdowns entity upon creation. |
|
WorkBreakdownId |
Integer |
ID assigned by Smart Completions to the WBS tree that the WBS item belongs to. |
|
Number |
String |
Source system ID for the WBS item. |
|
Name |
String |
Source system name for the WBS item. |
|
WorkBreakdownType |
String |
Description assigned by Smart Completions to the hierarchy tier of the WBS item based on WorkBreakdownTypeId. |
|
WorkBreakdownTypeId |
Integer |
Smart Completions hierarchy tier for WBS item: 2 - Phase 3 - Stage 4 - Activity
|
|
ParentId |
Integer |
Read only. ID assigned by Smart Completions to the parent WBS item based on WorkBreakdownParentId. |
|
WorkBreakdownSequence |
Integer |
The position of the WBS item within the Smart Completions WBS hierarchy, relative to its siblings. If omitted, the items are organized alpha-numerically. |
|
WorkBreakdownUp3Id |
Integer |
Smart Completions ID for the Project that contains the WBS item. |
|
CompanyInstanceId |
Integer |
Smart Completions ID for the Instance that contains the Project. |
|
Summary |
String |
Read only. Unique description created by Smart Completions for the WBS item as: Number - Name |
|
ParentSummary |
String |
Read only. Unique description created by Smart Completions for the parent WBS item as: ParentNumber - ParentName |
|
ParentNumber |
String |
Read only. ID assigned by Smart Completions to the parent WBS item based on WorkBreakdownParentId. |
|
ParentName |
String |
Read only. Name assigned by Smart Completions to the WBS item based on WorkBreakdownParentId. |
|
RecordCreated |
String |
Read only. Date when the WBS item was created in Smart Completions. Captured by Smart Completions. |
|
RecordLastModified |
String(date) |
Read only. Date when the WBS item was last updated in Smart Completions. Captured by Smart Completions. If the item has not been updated since creation, this is the date the item was created. |
|
dtRemoved |
String(date) |
Read only. Date when the WBS item was removed from Smart Completions. Captured by Smart Completions. |
|
RecordCreatedBy |
String |
Read only. Smart Completions user who created the WBS item in Smart Completions. Captured by Smart Completions. |
|
RecordLastModifiedBy |
String |
Read only. Smart Completions user who last updated the WBS item in Smart Completions. Captured by Smart Completions. If the item has not been updated since creation, this is the user who created the item. |
|
RecordRemovedBy |
String |
Read only. Smart Completions user who deleted the WBS item from Smart Completions. Captured by Smart Completions. |