Batch Update Notebook Topics
put
/api/restapi/notebookTopic/batch
Send a request to this endpoint to update one or more notebook topic.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityNotebookTopicsInput>
Type:
array
Title:
Show Source
List<ApiEntityNotebookTopicsInput>
-
Array of:
object ApiEntityNotebookTopicsInput
Title:
ApiEntityNotebookTopicsInput
This entity represents a NotebookTopics object, a unique NotebookTopics object can be identified by the following combinations of the fields.- notebookTopicId
- notebookTopicName,workspaceId
- notebookTopicName,workspaceCode
Nested Schema : ApiEntityNotebookTopicsInput
Type:
object
Title:
ApiEntityNotebookTopicsInput
This entity represents a NotebookTopics object, a unique NotebookTopics object can be identified by the following combinations of the fields.
Show Source
- notebookTopicId
- notebookTopicName,workspaceId
- notebookTopicName,workspaceCode
-
appliesTo: array
appliesTo
Business objects to which the notebook topics apply.
-
notebookTopicId: integer
(int64)
The unique identifier for the notebook topic.
-
notebookTopicName(required): 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. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId(required): integer
(int64)
The unique identifier of a workspace.
Nested Schema : appliesTo
Type:
array
Business objects to which the notebook topics apply.
Show Source
-
Array of:
string
Allowed Values:
[ "ACTIVITY", "PROJECT", "WBS" ]
Response
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}
400 Response
Invalid Input.