Jump to

• Request
• Response

View all WBS by Name

get

/api/restapi/wbs/project/{projectId}/name/{wbsName}

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 name that matches the value of the {wbsName} path parameter.

Request

Path Parameters

• projectId(required): integer(int64)
  The system-generated identifier of a project.
• wbsName(required): string
  The name of a WBS.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityWBS>

Type: array

Title: List<ApiEntityWBS>

Show Source

• Array of: object ApiEntityWBS
  Title: ApiEntityWBS

{
    "title":"List<ApiEntityWBS>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWBS",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityWBS

Type: object

Title: ApiEntityWBS

Show Source

• 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.

{
    "title":"ApiEntityWBS",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The sequence number of a WBS.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"A summary of the purpose for the WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsPath":{
            "maxLength":"4000",
            "type":"string",
            "description":"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: &lt;ProjectCode&gt;.&lt;WSBCode&gt;.&lt;WSBCode&gt;...&lt;WBSCode&gt;. 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'.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a WBS.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWBSConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeValues":{
            "type":"array",
            "description":"The list of code values for a WBS. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueWBS",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsId":{
            "type":"integer",
            "description":"Unique identifier of the WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The system-generated identifier of the parent WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified identifier of the parent of a WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "managerId":{
            "type":"integer",
            "description":"The system-generated identifier of manager or person responsible for monitoring and providing status on the WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "isDelete":{
            "type":"boolean",
            "description":"Indicates whether or not the WBS is marked for deletion.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "parentWBSCodes":{
            "type":"array",
            "description":"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.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

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

{
    "type":"array",
    "description":"The list of code values for a WBS. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueWBS",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a WBS.

Show Source

• Array of: object ApiEntityWBSConfiguredFieldValue
  Title: ApiEntityWBSConfiguredFieldValue

{
    "type":"array",
    "description":"The list of configured fields for a WBS.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWBSConfiguredFieldValue",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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

• Array of: string

{
    "type":"array",
    "description":"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.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeValueWBS

Type: object

Title: ApiEntityCodeValueWBS

Show Source

• 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.

{
    "title":"ApiEntityCodeValueWBS",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsId":{
            "type":"integer",
            "description":"The unique identifier of a WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueWbsId":{
            "type":"integer",
            "description":"The unique identifier of a WBS code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityWBSConfiguredFieldValue

Type: object

Title: ApiEntityWBSConfiguredFieldValue

Show Source

• 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.

{
    "title":"ApiEntityWBSConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsId":{
            "type":"integer",
            "description":"Unique identifier of the WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "wbsConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the WBS Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested WBS does not exist, or you do not have access to it.

Back to Top