Jump to

• Request
• Response

View WBS Notebook Topics

get

/api/restapi/wbs/notebookTopic/project/{projectId}

Send a request to this endpoint to view wbs notebook topics for all wbs under the project matching the path parameter {projectId}.

Request

Path Parameters

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

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<ApiEntityNotebookTopicWBS>

Type: array

Title: List<ApiEntityNotebookTopicWBS>

Show Source

• Array of: object ApiEntityNotebookTopicWBS
  Title: ApiEntityNotebookTopicWBS

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

Nested Schema : ApiEntityNotebookTopicWBS

Type: object

Title: ApiEntityNotebookTopicWBS

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• notebookTopicId: integer (int64)
  The unique identifier for the notebook topic.
• notebookTopicName: string
  Maximum Length: 255

  The name of the notebook topic.
• notes: string
  The notes for the notebook topic in HTML format.
• parentId: integer (int64)
  The system-generated identifier of the parent WBS.
• 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.
• 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.
• wbsNotesId: integer (int64)
  The unique identifier for the notebook topic and its wbs association.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityNotebookTopicWBS",
    "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"
            ]
        },
        "wbsNotesId":{
            "type":"integer",
            "description":"The unique identifier for the notebook topic and its wbs association.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "notebookTopicId":{
            "type":"integer",
            "description":"The unique identifier for the notebook topic.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The system-generated identifier of the parent WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "notes":{
            "type":"string",
            "description":"The notes for the notebook topic in HTML format.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "notebookTopicName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the notebook topic.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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 activity does not exist, or you do not have access to it.

Back to Top