Jump to

• Request
• Response

Create NotebookTopics

post

/notebookTopic

Creates multiple NotebookTopic objects in the database. You can create up to 1000 NotebookTopic objects with a single call.

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

A list of notebookTopic objects.

Root Schema : List<NotebookTopic>

Type: array

Title: List<NotebookTopic>

Show Source

• Array of: object NotebookTopic
  Title: NotebookTopic

  NotebookTopic Entity

{
    "title":"List<NotebookTopic>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NotebookTopic"
    }
}

Nested Schema : NotebookTopic

Type: object

Title: NotebookTopic

NotebookTopic Entity

Show Source

• AvailableForActivity: boolean
  The flag indicating that the topic will be available to assign to activities.
• AvailableForEPS: boolean
  The flag indicating that the topic will be available to assign to EPS.
• AvailableForProject: boolean
  The flag indicating that the topic will be available to assign to projects.
• AvailableForWBS: boolean
  The flag indicating that the topic will be available to assign to WBS.
• CreateDate: string (date-time)
  The date this notebook topic was created.
• CreateUser: string
  The name of the user that created this notebook topic.
• LastUpdateDate: string (date-time)
  The date this notebook topic was last updated.
• LastUpdateUser: string
  The name of the user that last updated this notebook topic.
• Name: string
  The name of the notebook topic.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• SequenceNumber: integer (int32)
  The sequence number for sorting.

{
    "title":"NotebookTopic",
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this notebook topic was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this notebook topic."
        },
        "Name":{
            "type":"string",
            "description":"The name of the notebook topic."
        },
        "AvailableForActivity":{
            "type":"boolean",
            "description":"The flag indicating that the topic will be available to assign to activities."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this notebook topic was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this notebook topic."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for sorting.",
            "format":"int32"
        },
        "AvailableForEPS":{
            "type":"boolean",
            "description":"The flag indicating that the topic will be available to assign to EPS."
        },
        "AvailableForProject":{
            "type":"boolean",
            "description":"The flag indicating that the topic will be available to assign to projects."
        },
        "AvailableForWBS":{
            "type":"boolean",
            "description":"The flag indicating that the topic will be available to assign to WBS."
        }
    },
    "description":"NotebookTopic Entity"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

NotebookTopic Created.

Body ()

Root Schema : String

Type: string

Title: String

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top