Jump to

• Request
• Response

View all Discussions by Task

get

/api/restapi/discussion/task/{taskId}

This endpoint returns discussions that meet the following requirements:

{workManagerTaskId}

Request

Path Parameters

• taskId(required): integer(int64)
  The system-generated identifier of a task.

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

Type: array

Title: List<ApiEntityTaskDiscussion>

Show Source

• Array of: object ApiEntityTaskDiscussion
  Title: ApiEntityTaskDiscussion

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

Nested Schema : ApiEntityTaskDiscussion

Type: object

Title: ApiEntityTaskDiscussion

Show Source

• applicationUserId(required): integer (int64)
  The user name of the user who submitted the discussion comment.
• applicationUserName: string
  Maximum Length: 255

  The user name of the user who submitted the discussion comment.
• comment(required): string
  Minimum Length: 0

  Maximum Length: 4000

  The initial post that begins a discussion thread.
  Discussions can take place on your projects, portfolios, and other object pages throughout the application.
• commentDecoded: string
  The decoded comment text where user references are replaced with the corresponding email Ids.
• discussionDate: string (date-time)
  The created date of the discussion.
• discussionId: integer (int64)
  The system-generated identifier of a field for the discussion.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• parentDiscussionId: integer (int64)
  The unique identifier of a parent discussion.
• taskId: integer (int64)
  The unique identifier of a task.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityTaskDiscussion",
    "required":[
        "applicationUserId",
        "comment"
    ],
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "commentDecoded":{
            "type":"string",
            "description":"The decoded comment text where user references are replaced with the corresponding email Ids.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "taskId":{
            "type":"integer",
            "description":"The unique identifier of a task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "comment":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"The initial post that begins a discussion thread. <br />Discussions can take place on your projects, portfolios, and other object pages throughout the application.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUserId":{
            "type":"integer",
            "description":"The user name of the user who submitted the discussion comment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "discussionId":{
            "type":"integer",
            "description":"The system-generated identifier of a field for the discussion.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentDiscussionId":{
            "type":"integer",
            "description":"The unique identifier of a parent discussion.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "discussionDate":{
            "type":"string",
            "description":"The created date of the discussion.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "applicationUserName":{
            "maxLength":255,
            "type":"string",
            "description":"The user name of the user who submitted the discussion comment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

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

Back to Top