Comments

comments-post

POST

/comments

Adds comments to an existing task identified by its jiraTicketNo

Prod:
https://api.seic.com/v2/workdesk/comments
Query Parameters
Name Description Data Type Required
jiraTicketNo

TheTicket Number

string

Header Parameters
Name Description Data Type Required
Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

string

Content-Type

Default value of the content type is application/x-www-form-urlencoded

string

Body Parameters
Name Description Data Type Required
ID

The ID.

string

Text

Comment text

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to something that is perceived to be an error on the client application side.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition.

TEST ENDPOINT
jiraTicketNo

TheTicket Number

Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

Content-Type

Default value of the content type is application/x-www-form-urlencoded

ID

The ID.

Text

Comment text

Request Body

User Comment model

HTTP Basic

OAuth 2.0

API Key

Working...

Comments

comments-post

POST

/comments

Adds comments to an existing task identified by its jiraTicketNo

Prod:
https://api.seic.com/v2/workdesk/comments
Query Parameters
Name Description Data Type Required
jiraTicketNo

TheTicket Number

string

Header Parameters
Name Description Data Type Required
Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

string

Content-Type

Default value of the content type is application/x-www-form-urlencoded

string

Body Parameters
Name Description Data Type Required
ID

The ID.

string

Text

Comment text

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to something that is perceived to be an error on the client application side.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition.

TEST ENDPOINT
jiraTicketNo

TheTicket Number

Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

Content-Type

Default value of the content type is application/x-www-form-urlencoded

ID

The ID.

Text

Comment text

Request Body

User Comment model

HTTP Basic

OAuth 2.0

API Key

Working...

Test: https://test.api.seic.com/v2/workdesk/comments
TLS*: https://mtls.api.seic.com/v2/workdesk/comments
*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.
STEP 2

Pass the oAuth Token and the App key to invoke this endpoint for a particular application.

This endpoint will add a new comment and return the comment details.The value for the field "key" obtained from the "workdesk/ticketinfo" endpoint response serves as an input value for the jiraTicketNumber query param in this endpoint.

Comments

comments-post

POST

/comments

Adds comments to an existing task identified by its jiraTicketNo

Prod:
https://api.seic.com/v2/workdesk/comments
Query Parameters
Name Description Data Type Required
jiraTicketNo

TheTicket Number

string

Header Parameters
Name Description Data Type Required
Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

string

Content-Type

Default value of the content type is application/x-www-form-urlencoded

string

Body Parameters
Name Description Data Type Required
ID

The ID.

string

Text

Comment text

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to something that is perceived to be an error on the client application side.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition.

TEST ENDPOINT
jiraTicketNo

TheTicket Number

Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

Content-Type

Default value of the content type is application/x-www-form-urlencoded

ID

The ID.

Text

Comment text

Request Body

User Comment model

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X POST \
  'https://api.seic.com/v2/workdesk/comments?jiraTicketNo=SB-5855' \
  -H 'Appkey: gsedgaerhDSHGRSH' \
  -H 'Authorization: Bearer ADsgdnnkjnfdIKJ' \
  -H 'content-type: application/json' \
  --data-raw '
 {
  "Id": 0,
  "Text": "Adding 2nd comment"
 }


REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
RESPONSE HEADER

Content-Type: application/json 
Status: 200 OK 
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9


SAMPLE RESPONSE

{
    "StartAt": 0,
    "MaxResults": 0,
    "Total": 0,
    "Data": [
        {
            "Id": "1998144",
            "CreatedUserName": "aiyer",
            "CreatedBy": "Anuradha Iyer",
            "CreatedEmailId": "aiyer@seic.com",
            "UpdatedBy": "Anuradha Iyer",
            "UpdatedEmailId": "aiyer@seic.com",
            "Value": "Adding 2nd comment",
            "RenderBody": "Adding 2nd comment",
            "CreatedDate": "2021-08-16T08:57:14.562-0400",
            "UpdatedDate": "2021-08-16T08:57:14.562-0400",
            "ErrorMessage": null
        }
    ]
}
MODEL
Operations
Name Description Data Type (L)
Id

Project Id.

string
Value

The value within the Jira object.

string
Data

The collection of statistics associated with the Task.

string
UpdatedBy

Name of person who modified comment or attachment in Jira.

string
UpdatedEmail

Email address of the person who modified the comment or attachment in the task.

string
UpdatedDate

Date on which comment or attachment was modified in Jira.

string
startAt

Starting record count.

string
MaxResults

The maximum number of results that can be returned in the API call.

string
total

The total number of results returned.

string
CreatedUserName

Name of the person who created the comment or uploaded the attachment.

string
CreatedBy

The initial userid that created the folder.

string
CreatedEmailId

Email address of the person who created the comment or uploaded the attachment.

string
RenderBody

The comment text.

string
CreatedDate

Date on which the attachment or comment was added to Jira.

string
ErrorMessage

Descriptive text in a response to further explain the http response code.

string


Comments

comments-post

POST

/comments

Adds comments to an existing task identified by its jiraTicketNo

Prod:
https://api.seic.com/v2/workdesk/comments
Query Parameters
Name Description Data Type Required
jiraTicketNo

TheTicket Number

string

Header Parameters
Name Description Data Type Required
Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

string

Content-Type

Default value of the content type is application/x-www-form-urlencoded

string

Body Parameters
Name Description Data Type Required
ID

The ID.

string

Text

Comment text

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to something that is perceived to be an error on the client application side.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition.

TEST ENDPOINT
jiraTicketNo

TheTicket Number

Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

Content-Type

Default value of the content type is application/x-www-form-urlencoded

ID

The ID.

Text

Comment text

Request Body

User Comment model

HTTP Basic

OAuth 2.0

API Key

Working...

Comments

comments-post

POST

/comments

Adds comments to an existing task identified by its jiraTicketNo

Prod:
https://api.seic.com/v2/workdesk/comments
Query Parameters
Name Description Data Type Required
jiraTicketNo

TheTicket Number

string

Header Parameters
Name Description Data Type Required
Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

string

Content-Type

Default value of the content type is application/x-www-form-urlencoded

string

Body Parameters
Name Description Data Type Required
ID

The ID.

string

Text

Comment text

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to something that is perceived to be an error on the client application side.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition.

TEST ENDPOINT
jiraTicketNo

TheTicket Number

Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

Content-Type

Default value of the content type is application/x-www-form-urlencoded

ID

The ID.

Text

Comment text

Request Body

User Comment model

HTTP Basic

OAuth 2.0

API Key

Working...

Test: https://test.api.seic.com/v2/workdesk/comments
TLS*: https://mtls.api.seic.com/v2/workdesk/comments
*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.
STEP 1



STEP 2

Pass the oAuth Token and the App key to invoke this endpoint for a particular application.

This endpoint will add a new comment and return the comment details.The value for the field "key" obtained from the "workdesk/ticketinfo" endpoint response serves as an input value for the jiraTicketNumber query param in this endpoint.

Comments

comments-post

POST

/comments

Adds comments to an existing task identified by its jiraTicketNo

Prod:
https://api.seic.com/v2/workdesk/comments
Query Parameters
Name Description Data Type Required
jiraTicketNo

TheTicket Number

string

Header Parameters
Name Description Data Type Required
Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

string

Content-Type

Default value of the content type is application/x-www-form-urlencoded

string

Body Parameters
Name Description Data Type Required
ID

The ID.

string

Text

Comment text

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to something that is perceived to be an error on the client application side.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition.

TEST ENDPOINT
jiraTicketNo

TheTicket Number

Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

Content-Type

Default value of the content type is application/x-www-form-urlencoded

ID

The ID.

Text

Comment text

Request Body

User Comment model

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X POST \
  'https://api.seic.com/v2/workdesk/comments?jiraTicketNo=SB-5855' \
  -H 'Appkey: gsedgaerhDSHGRSH' \
  -H 'Authorization: Bearer ADsgdnnkjnfdIKJ' \
  -H 'content-type: application/json' \
  --data-raw '
 {
  "Id": 0,
  "Text": "Adding 2nd comment"
 }


REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
RESPONSE HEADER

Content-Type: application/json 
Status: 200 OK 
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9


SAMPLE RESPONSE

{
    "StartAt": 0,
    "MaxResults": 0,
    "Total": 0,
    "Data": [
        {
            "Id": "1998144",
            "CreatedUserName": "aiyer",
            "CreatedBy": "Anuradha Iyer",
            "CreatedEmailId": "aiyer@seic.com",
            "UpdatedBy": "Anuradha Iyer",
            "UpdatedEmailId": "aiyer@seic.com",
            "Value": "Adding 2nd comment",
            "RenderBody": "Adding 2nd comment",
            "CreatedDate": "2021-08-16T08:57:14.562-0400",
            "UpdatedDate": "2021-08-16T08:57:14.562-0400",
            "ErrorMessage": null
        }
    ]
}
MODEL
Operations
Name Description Data Type (L)
Id

Project Id.

string
Value

The value within the Jira object.

string
Data

The collection of statistics associated with the Task.

string
UpdatedBy

Name of person who modified comment or attachment in Jira.

string
UpdatedEmail

Email address of the person who modified the comment or attachment in the task.

string
UpdatedDate

Date on which comment or attachment was modified in Jira.

string
startAt

Starting record count.

string
MaxResults

The maximum number of results that can be returned in the API call.

string
total

The total number of results returned.

string
CreatedUserName

Name of the person who created the comment or uploaded the attachment.

string
CreatedBy

The initial userid that created the folder.

string
CreatedEmailId

Email address of the person who created the comment or uploaded the attachment.

string
RenderBody

The comment text.

string
CreatedDate

Date on which the attachment or comment was added to Jira.

string
ErrorMessage

Descriptive text in a response to further explain the http response code.

string


Comments

comments-post

POST

/comments

Adds comments to an existing task identified by its jiraTicketNo

Prod:
https://api.seic.com/v2/workdesk/comments
Query Parameters
Name Description Data Type Required
jiraTicketNo

TheTicket Number

string

Header Parameters
Name Description Data Type Required
Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

string

Content-Type

Default value of the content type is application/x-www-form-urlencoded

string

Body Parameters
Name Description Data Type Required
ID

The ID.

string

Text

Comment text

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to something that is perceived to be an error on the client application side.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition.

TEST ENDPOINT
jiraTicketNo

TheTicket Number

Authorization

The access_token value obtained from the Token endpoint. This is passed as "Bearer access_token".

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user. It is a form of user credential generated and provisioned by the SEI Developer Portal for applications associated with individual developers.

Content-Type

Default value of the content type is application/x-www-form-urlencoded

ID

The ID.

Text

Comment text

Request Body

User Comment model

HTTP Basic

OAuth 2.0

API Key

Working...