Task Attachment

Attachment

GET

/attachmentsbyticket

Returns task attachment(s) by task Id.

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

The jira ticket number.

string

attachmentId

The attachment id.

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

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

The jira ticket number.

attachmentId

The attachment id.

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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

Task Attachment

Attachment

GET

/attachmentsbyticket

Returns task attachment(s) by task Id.

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

The jira ticket number.

string

attachmentId

The attachment id.

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

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

The jira ticket number.

attachmentId

The attachment id.

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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

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

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

This endpoint retrieves a specific attachment for a given ticket key and attachmentId. 

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.

The value for the field "id" obtained from the "workdesk/attachmentmetadata" endpoint response serves as an input value for the attachmentId query param in this endpoint.

Task Attachment

Attachment

GET

/attachmentsbyticket

Returns task attachment(s) by task Id.

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

The jira ticket number.

string

attachmentId

The attachment id.

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

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

The jira ticket number.

attachmentId

The attachment id.

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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X GET \
https://api.seic.com/v1/workdesk/attachmentsbyticket?jiraTicketNo=SB-415&attachmentId=2157266 \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \


REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
RESPONSE HEADER

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


SAMPLE RESPONSE

Attachment in the requested ticket. It can be any of the following excel,jpeg,word or png file etc. 
MODEL
Operations


Task Attachment

Attachment

GET

/attachmentsbyticket

Returns task attachment(s) by task Id.

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

The jira ticket number.

string

attachmentId

The attachment id.

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

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

The jira ticket number.

attachmentId

The attachment id.

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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...