Jump to

• Request
• Response

Assign Notebook Topics

put

/api/restapi/notebookTopic/assign

Send a request to this endpoint to assign notebook topics to applicable business objects like Activities, Projects etc.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityNotebookTopicsAssignmentInput

Type: object

Title: ApiEntityNotebookTopicsAssignmentInput

Show Source

• activityNotes: array activityNotes
  Activity notes input for assigning notebook topics.
• projectNotes: array projectNotes
  Project notes input for assigning notebook topics.
• wbsNotes: array wbsNotes
  WBS notes input for assigning notebook topics.

{
    "title":"ApiEntityNotebookTopicsAssignmentInput",
    "type":"object",
    "properties":{
        "activityNotes":{
            "type":"array",
            "description":"Activity notes input for assigning notebook topics.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityNotebookTopicActivityInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "wbsNotes":{
            "type":"array",
            "description":"WBS notes input for assigning notebook topics.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityNotebookTopicWBSInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "projectNotes":{
            "type":"array",
            "description":"Project notes input for assigning notebook topics.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityNotebookTopicProjectInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : activityNotes

Type: array

Activity notes input for assigning notebook topics.

Show Source

• Array of: object ApiEntityNotebookTopicActivityInput
  Title: ApiEntityNotebookTopicActivityInput

{
    "type":"array",
    "description":"Activity notes input for assigning notebook topics.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityNotebookTopicActivityInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : projectNotes

Type: array

Project notes input for assigning notebook topics.

Show Source

• Array of: object ApiEntityNotebookTopicProjectInput
  Title: ApiEntityNotebookTopicProjectInput

{
    "type":"array",
    "description":"Project notes input for assigning notebook topics.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityNotebookTopicProjectInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : wbsNotes

Type: array

WBS notes input for assigning notebook topics.

Show Source

• Array of: object ApiEntityNotebookTopicWBSInput
  Title: ApiEntityNotebookTopicWBSInput

{
    "type":"array",
    "description":"WBS notes input for assigning notebook topics.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityNotebookTopicWBSInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityNotebookTopicActivityInput

Type: object

Title: ApiEntityNotebookTopicActivityInput

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• activityIdentifier: activityIdentifier
  Field combinations uniquely identifying activity.
• notebookTopicId: integer (int64)
  The unique identifier for the notebook topic.
• notebookTopicName: string
  Maximum Length: 255

  The name of the notebook topic.
• notes: string
  Notes that provide additional information for the assigned business object.

{
    "title":"ApiEntityNotebookTopicActivityInput",
    "type":"object",
    "properties":{
        "activityIdentifier":{
            "description":"Field combinations uniquely identifying activity.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ActivityIdentifier"
                }
            ]
        },
        "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"
            ]
        },
        "notebookTopicId":{
            "type":"integer",
            "description":"The unique identifier for the notebook topic.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "notes":{
            "type":"string",
            "description":"Notes that provide additional information for the assigned business object.",
            "exampleSetFlag":false
        },
        "notebookTopicName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the notebook topic.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : activityIdentifier

Field combinations uniquely identifying activity.

Match All

Field combinations uniquely identifying activity.

Show Source

• object ActivityIdentifier
  Title: ActivityIdentifier

{
    "description":"Field combinations uniquely identifying activity.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ActivityIdentifier"
        }
    ]
}

Nested Schema : ActivityIdentifier

Type: object

Title: ActivityIdentifier

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The unique identifier for the activity.
• projectCode: string
  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.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ActivityIdentifier",
    "type":"object",
    "properties":{
        "activityId":{
            "type":"integer",
            "description":"The unique identifier for the activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activityCode":{
            "maxLength":60,
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityNotebookTopicProjectInput

Type: object

Title: ApiEntityNotebookTopicProjectInput

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• notebookTopicId: integer (int64)
  The unique identifier for the notebook topic.
• notebookTopicName: string
  Maximum Length: 255

  The name of the notebook topic.
• notes: string
  Notes that provide additional information for the assigned business object.
• projectIdentifier: projectIdentifier
  Field combinations uniquely identifying project.

{
    "title":"ApiEntityNotebookTopicProjectInput",
    "type":"object",
    "properties":{
        "projectIdentifier":{
            "description":"Field combinations uniquely identifying project.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ProjectIdentifier"
                }
            ]
        },
        "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"
            ]
        },
        "notebookTopicId":{
            "type":"integer",
            "description":"The unique identifier for the notebook topic.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "notes":{
            "type":"string",
            "description":"Notes that provide additional information for the assigned business object.",
            "exampleSetFlag":false
        },
        "notebookTopicName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the notebook topic.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : projectIdentifier

Field combinations uniquely identifying project.

Match All

Field combinations uniquely identifying project.

Show Source

• object ProjectIdentifier
  Title: ProjectIdentifier

{
    "description":"Field combinations uniquely identifying project.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ProjectIdentifier"
        }
    ]
}

Nested Schema : ProjectIdentifier

Type: object

Title: ProjectIdentifier

Show Source

• projectCode: string
  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.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProjectIdentifier",
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityNotebookTopicWBSInput

Type: object

Title: ApiEntityNotebookTopicWBSInput

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• notebookTopicId: integer (int64)
  The unique identifier for the notebook topic.
• notebookTopicName: string
  Maximum Length: 255

  The name of the notebook topic.
• notes: string
  Notes that provide additional information for the assigned business object.
• wbsIdentifier: wbsIdentifier
  Field combinations uniquely identifying WBS.

{
    "title":"ApiEntityNotebookTopicWBSInput",
    "type":"object",
    "properties":{
        "wbsIdentifier":{
            "description":"Field combinations uniquely identifying WBS.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/WBSIdentifier"
                }
            ]
        },
        "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"
            ]
        },
        "notebookTopicId":{
            "type":"integer",
            "description":"The unique identifier for the notebook topic.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "notes":{
            "type":"string",
            "description":"Notes that provide additional information for the assigned business object.",
            "exampleSetFlag":false
        },
        "notebookTopicName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the notebook topic.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : wbsIdentifier

Field combinations uniquely identifying WBS.

Match All

Field combinations uniquely identifying WBS.

Show Source

• object WBSIdentifier
  Title: WBSIdentifier

{
    "description":"Field combinations uniquely identifying WBS.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/WBSIdentifier"
        }
    ]
}

Nested Schema : WBSIdentifier

Type: object

Title: WBSIdentifier

Show Source

• 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
  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.
• wbsCode: string
  Maximum Length: 60

  The user-specified unique identifier for the WBS.
• wbsId: integer (int64)
  Unique identifier of the WBS.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"WBSIdentifier",
    "type":"object",
    "properties":{
        "wbsId":{
            "type":"integer",
            "description":"Unique identifier of the WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "wbsCode":{
            "maxLength":60,
            "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"
            ]
        },
        "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"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

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"
    ]
}

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid Input.

Back to Top