View a WBS by WBS Code, Parent WBS Code, and Project ID
get
/primeapi/restapi/wbs/wbsCode/{code}/parentWbsCode/{parentCode}/projectId/{projectId}
This endpoint returns WBSs that meet the following requirements:
- The object has a project with an ID value that matches the value of the {projectId} path parameter.
Request
Supported Media Types
- application/json
Path Parameters
-
code: string
The user-specified identifier of a WBS.
-
parentCode: string
The user-specified identifier of the parent object.
-
projectId: integer(int64)
The system-generated identifier of a project.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityWBS
Type:
Show Source
object
-
codeValues(optional):
array codeValues
Unique Items Required:
true
The code values associated with the WBS. -
description:
string
Allowed Values:
[ "Length[0-4000]" ]
A summary of the purpose for the WBS. -
isDelete(optional):
boolean
Indicates whether or not the WBS is marked for deletion.
-
link(optional):
string(url)
Read Only:
true
-
managerId(optional):
integer(int64)
The manager or person responsible for monitoring and providing status on the WBS.
-
parentCode(optional):
string
The user-specified identifier of the parent of a WBS.
-
parentWbsId(optional):
integer(int64)
The name of the parent WBS.
-
projectId(optional):
integer(int64)
-
sequenceNumber:
integer(int32)
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
wbsCode(optional):
string
Allowed Values:
[ "Length[1-60]" ]
The unique identifier for the WBS. -
wbsConfiguredFields(optional):
object ApiEntityWBSConfiguredFields
-
wbsId:
integer(int64)
-
wbsName(optional):
string
Allowed Values:
[ "Length[1-255]" ]
The name of the WBS.
Nested Schema : codeValues
Type:
array
Unique Items Required:
true
The code values associated with the WBS.
Show Source
Nested Schema : ApiEntityWBSConfiguredFields
Type:
Show Source
object
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-cost and non-text fields in the form of key-value pairs.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
uniqueName(optional):
string
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
wbs(optional):
object ApiEntityWBS
-
wbsId(optional):
integer(int64)
The unique identifier for the WBS for which the user defined field table is associated.
Nested Schema : ApiEntityCodeValueWBS
Type:
Show Source
object
-
codeType(optional):
object ApiEntityCodeType
-
codeValue(optional):
object ApiEntityCodeValue
-
codeValueWbsId(optional):
integer(int64)
The unique identifier of a WBS code value.
-
link(optional):
string(url)
Read Only:
true
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
wbsId(optional):
integer(int64)
The unique identifier of a WBS.
Nested Schema : ApiEntityCodeType
Type:
Show Source
object
-
assignments(optional):
array assignments
Unique Items Required:
true
CodeType assignments. -
codeTypeCode:
string
Allowed Values:
[ "Length[1-40]" ]
This field displays the name of a code or value. -
codeTypeId(optional):
integer(int64)
The system-generated identifier of a code type.
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]
The name of a code or value. -
link(optional):
string(url)
Read Only:
true
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace code. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace:
integer(int64)
The ID of the owning workspace.
Nested Schema : ApiEntityCodeValue
Type:
Show Source
object
-
codeTypeId:
integer(int64)
The ID for the code type.
-
codeTypeName:
string
The name of a code or value.
-
codeValueCode:
string
Allowed Values:
[ "LENGTH[1-32]" ]
The unique identifier for the code value. -
codeValueId(optional):
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]
The name of the code value. -
link(optional):
string(url)
Read Only:
true
-
parentCodeValue(optional):
integer(int64)
The parent code value.
-
sequenceNumber:
integer(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : assignments
Type:
array
Unique Items Required:
true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
entityType:
string
Allowed Values:
[ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]
Indicates the type of object the code is associated to. -
link(optional):
string(url)
Read Only:
true
-
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-cost and non-text fields in the form of key-value pairs.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing text fields in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
404 Response
The requested WBS does not exist, or you do not have access to it.