Jump to

• Request
• Response

View a Notebook Topic

get

/api/restapi/notebookTopic/{notebookTopicId}

This endpoint returns notebook topic that the value of the {notebookTopicId} path parameter.

Request

Path Parameters

• notebookTopicId(required): integer(int64)
  The system-generated identifier of a notebook topic.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityNotebookTopics

Type: object

Title: ApiEntityNotebookTopics

Show Source

• appliesTo: array appliesTo
  Business objects to which the notebook topics apply.
• associationType: string
  Allowed Values: [ "OWNED", "INHERITED" ]

  How data is associated to this workspace.
  Owned: Data is created in this workspace.
  Inherited: Data is shared to this workspace from the parent workspace.
• 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
  Minimum Length: 1

  Maximum Length: 255

  The name of the notebook topic.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  How data is shared between parent and child workspaces.
  Manual: Data can be pulled down by child workspaces. This is the default option.
  Automatic: Data is automatically shared with all child workspaces.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityNotebookTopics",
    "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"
            ]
        },
        "notebookTopicId":{
            "type":"integer",
            "description":"The unique identifier for the notebook topic.",
            "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"
            ]
        },
        "appliesTo":{
            "type":"array",
            "description":"Business objects to which the notebook topics apply.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ],
                "enum":[
                    "ACTIVITY",
                    "PROJECT",
                    "WBS"
                ]
            },
            "types":[
                "array"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"How data is shared between parent and child workspaces. <br />Manual: Data can be pulled down by child workspaces. This is the default option. <br />Automatic: Data is automatically shared with all child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"How data is associated to this workspace. <br />Owned: Data is created in this workspace. <br />Inherited: Data is shared to this workspace from the parent workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "notebookTopicName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the notebook topic.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : appliesTo

Type: array

Business objects to which the notebook topics apply.

Show Source

• Array of: string
  Allowed Values: [ "ACTIVITY", "PROJECT", "WBS" ]

{
    "type":"array",
    "description":"Business objects to which the notebook topics apply.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ],
        "enum":[
            "ACTIVITY",
            "PROJECT",
            "WBS"
        ]
    },
    "types":[
        "array"
    ]
}

404 Response

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

Back to Top