View a WBS by Code
get
/api/restapi/wbs/project/{projectId}/code/{wbsCode}
This endpoint returns WBSs that meet the following requirements:
- The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
- The object has a code that matches the value of the {wbsCode} path parameter.
Request
Path Parameters
-
projectId(required): integer(int64)
The system-generated identifier of a project.
-
wbsCode(required): string
The user-specified identifier of a WBS.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityWBS>
Type:
array
Title:
Show Source
List<ApiEntityWBS>
-
Array of:
object ApiEntityWBS
Title:
ApiEntityWBS
Nested Schema : ApiEntityWBS
Type:
object
Title:
Show Source
ApiEntityWBS
-
codeValues: array
codeValues
The list of code values for a WBS. This entity can only be used to assign codeValues or create codeValues on the fly.
-
configuredFields: array
configuredFields
The list of configured fields for a WBS.
-
description: string
Minimum Length:
0
Maximum Length:4000
A summary of the purpose for the WBS. -
isDelete: boolean
Indicates whether or not the WBS is marked for deletion.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
managerId: integer
(int64)
The system-generated identifier of manager or person responsible for monitoring and providing status on the WBS.
-
parentCode: string
Minimum Length:
1
Maximum Length:60
The user-specified identifier of the parent of a WBS. -
parentId: integer
(int64)
The system-generated identifier of the parent WBS.
-
parentWBSCodes: array
parentWBSCodes
The list of parent WBS codes in the hierarchy of a WBS. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs. If required, the field 'wbsPath' can be referred to get the value for the parent WBS path.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
sequenceNumber: integer
(int32)
The sequence number of a WBS.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
wbsCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for the WBS. -
wbsId: integer
(int64)
Unique identifier of the WBS.
-
wbsName: string
Minimum Length:
1
Maximum Length:255
The name of the WBS. -
wbsPath: string
Maximum Length:
4000
The complete path to the WBS. This is the hierarchy path from the Project Code to the WBS. It is based on the following pattern: <ProjectCode>.<WSBCode>.<WSBCode>...<WBSCode>. For example, for a project with code 'P1' having the WBS hierarchy as 'WBS1', 'WBS2', and 'WBS3', the wbsPath for 'WBS3' will be defined as 'P1.WBS1.WBS2.WBS3'. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : codeValues
Type:
array
The list of code values for a WBS. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
-
Array of:
object ApiEntityCodeValueWBS
Title:
ApiEntityCodeValueWBS
Nested Schema : configuredFields
Type:
array
The list of configured fields for a WBS.
Show Source
-
Array of:
object ApiEntityWBSConfiguredFieldValue
Title:
ApiEntityWBSConfiguredFieldValue
Nested Schema : parentWBSCodes
Type:
array
The list of parent WBS codes in the hierarchy of a WBS. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs. If required, the field 'wbsPath' can be referred to get the value for the parent WBS path.
Show Source
Nested Schema : ApiEntityCodeValueWBS
Type:
object
Title:
Show Source
ApiEntityCodeValueWBS
-
action: string
Allowed Values:
[ "DELETE" ]
Provide a value for this field during object update to delete code value assigned to the object. -
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId(required): integer
(int64)
The unique identifier for the code type.The code type object can also be identified by its unique criteria.
-
codeTypeName: string
Minimum Length:
0
Maximum Length:255
The name of a code or value. -
codeValueCode(required): string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1
Maximum Length:255
The name of the code value. -
codeValueWbsId: integer
(int64)
The unique identifier of a WBS code value.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
parentId: integer
(int64)
The unique identifier of a parent code value.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The code of a Project of a Project CodeType. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
sequenceNumber: integer
(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
wbsId: integer
(int64)
The unique identifier of a WBS.
Nested Schema : ApiEntityWBSConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityWBSConfiguredFieldValue
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
costValue: number
This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
-
costValueWorkspace1: number
(double)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
This holds values for Cost type configured fields in the workspace3 currency conversion.
-
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: string
Maximum Length:
4000
Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Determines if formula calculation hit an error calculating a value for this field.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string
(date-time)
Date when the record was last updated.
-
wbsConfiguredFieldValueId: integer
(int64)
The unique identifier for the WBS Configured Field.
-
wbsId: integer
(int64)
Unique identifier of the WBS.
204 Response
Successful operation with no content.
404 Response
The requested WBS does not exist, or you do not have access to it.