Attachment

Attachment

Set Admin Credentials...
tickets-key-attachments-post

POST

/tickets/{key}/attachments

Prod:
https://api.seic.com/v2/workdesk/tickets/{key}/attachments
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

FileName

Upload File Name.

string

ContentType

The content contained in the file or folder.

string

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

string

Path Parameters
Name Description Data Type Required
key

The jira ticket number.

string

Body Parameters
Name Description Data Type Required
FileName

File to be uploaded.

object

HTTP Responses
  • Code
    Description
  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

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

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
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.

FileName

Upload File Name.

ContentType

The content contained in the file or folder.

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

FileName

File to be uploaded.

Request Body

key The jira ticket number. null true

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Attachment

Set Admin Credentials...
tickets-key-attachments-post

POST

/tickets/{key}/attachments

Prod:
https://api.seic.com/v2/workdesk/tickets/{key}/attachments
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

FileName

Upload File Name.

string

ContentType

The content contained in the file or folder.

string

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

string

Path Parameters
Name Description Data Type Required
key

The jira ticket number.

string

Body Parameters
Name Description Data Type Required
FileName

File to be uploaded.

object

HTTP Responses
  • Code
    Description
  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

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

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
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.

FileName

Upload File Name.

ContentType

The content contained in the file or folder.

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

FileName

File to be uploaded.

Request Body

key The jira ticket number. null true

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

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

oAuthToken
POST


STEP 2

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

Attachment

Set Admin Credentials...
tickets-key-attachments-post

POST

/tickets/{key}/attachments

Prod:
https://api.seic.com/v2/workdesk/tickets/{key}/attachments
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

FileName

Upload File Name.

string

ContentType

The content contained in the file or folder.

string

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

string

Path Parameters
Name Description Data Type Required
key

The jira ticket number.

string

Body Parameters
Name Description Data Type Required
FileName

File to be uploaded.

object

HTTP Responses
  • Code
    Description
  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

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

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
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.

FileName

Upload File Name.

ContentType

The content contained in the file or folder.

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

FileName

File to be uploaded.

Request Body

key The jira ticket number. null true

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...
SAMPLE REQUEST

curl -X POST \
  https://api.seic.com/v2/workdesk/tickets/SB-5855/attachments \
--header 'AppKey: gsedgaerhDSHGRSH' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN' \
--header 'Content-Type: multipart/form-data; boundary=123456789' \
--header 'ContentType: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' \
--header 'FileName: file.xlsx' \
--form 'FileName=@"/C:/Users/user/Desktop/file.xlsx"'
{
  "FileName": "file.xlsx"
}


REQUEST HEADER

appkey: gsedgaerhDSHGRSH
authorization: Bearer ADsgdnnkjnfdIKJN
REQUEST PAYLOAD MODEL
Operations
RESPONSE HEADER

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


SAMPLE RESPONSE

{
    "Id": "7235601",
    "Name": "file.xlsx",
    "CreatedUserName": "user",
    "CreatedBy": "John Smith",
    "CreatedDate": "2021-08-13T17:25:07.837-0400",
    "Size": 219,
    "MimeType": "multipart/form-data; boundary=123456789",
    "Content": null,
    "ErrorMessage": null,
    "DateCreated": "0001-01-01T00:00:00"
}
MODEL
Operations
Name Description Data Type (L)
CreatedUserName

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

 string
CreatedBy

The initial userid that created the folder.

 string
CreatedDate

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

 string
Size

The size of the folder.

 string
MimeType

Type of media file attached like text, Excel, PDF or Word.

 string
Content

The stream of files that need to be uploaded/downloaded from Jira.

 string
ErrorMessage

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

 string
name

The first, last, and middle name of the user as available in the SEI application.

 string
id

SEI Accounting system generated identifier for each transaction in a batch

 string


Attachment

Set Admin Credentials...
tickets-key-attachments-post

POST

/tickets/{key}/attachments

Prod:
https://api.seic.com/v2/workdesk/tickets/{key}/attachments
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

FileName

Upload File Name.

string

ContentType

The content contained in the file or folder.

string

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

string

Path Parameters
Name Description Data Type Required
key

The jira ticket number.

string

Body Parameters
Name Description Data Type Required
FileName

File to be uploaded.

object

HTTP Responses
  • Code
    Description
  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

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

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
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.

FileName

Upload File Name.

ContentType

The content contained in the file or folder.

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

FileName

File to be uploaded.

Request Body

key The jira ticket number. null true

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Attachment

Set Admin Credentials...
tickets-key-attachments-post

POST

/tickets/{key}/attachments

Prod:
https://api.seic.com/v2/workdesk/tickets/{key}/attachments
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

FileName

Upload File Name.

string

ContentType

The content contained in the file or folder.

string

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

string

Path Parameters
Name Description Data Type Required
key

The jira ticket number.

string

Body Parameters
Name Description Data Type Required
FileName

File to be uploaded.

object

HTTP Responses
  • Code
    Description
  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

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

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
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.

FileName

Upload File Name.

ContentType

The content contained in the file or folder.

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

FileName

File to be uploaded.

Request Body

key The jira ticket number. null true

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

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

oAuthToken
POST


STEP 2

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

Attachment

Set Admin Credentials...
tickets-key-attachments-post

POST

/tickets/{key}/attachments

Prod:
https://api.seic.com/v2/workdesk/tickets/{key}/attachments
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

FileName

Upload File Name.

string

ContentType

The content contained in the file or folder.

string

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

string

Path Parameters
Name Description Data Type Required
key

The jira ticket number.

string

Body Parameters
Name Description Data Type Required
FileName

File to be uploaded.

object

HTTP Responses
  • Code
    Description
  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

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

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
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.

FileName

Upload File Name.

ContentType

The content contained in the file or folder.

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

FileName

File to be uploaded.

Request Body

key The jira ticket number. null true

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...
SAMPLE REQUEST

curl -X POST \
  https://api.seic.com/v2/workdesk/tickets/SB-5855/attachments \
--header 'AppKey: gsedgaerhDSHGRSH' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN' \
--header 'Content-Type: multipart/form-data; boundary=123456789' \
--header 'ContentType: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' \
--header 'FileName: file.xlsx' \
--form 'FileName=@"/C:/Users/user/Desktop/file.xlsx"'
{
  "FileName": "file.xlsx"
}


REQUEST HEADER

appkey: gsedgaerhDSHGRSH
authorization: Bearer ADsgdnnkjnfdIKJN
REQUEST PAYLOAD MODEL
Operations
RESPONSE HEADER

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


SAMPLE RESPONSE

{
    "Id": "7235601",
    "Name": "file.xlsx",
    "CreatedUserName": "user",
    "CreatedBy": "John Smith",
    "CreatedDate": "2021-08-13T17:25:07.837-0400",
    "Size": 219,
    "MimeType": "multipart/form-data; boundary=123456789",
    "Content": null,
    "ErrorMessage": null,
    "DateCreated": "0001-01-01T00:00:00"
}
MODEL
Operations
Name Description Data Type (L)
CreatedUserName

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

 string
CreatedBy

The initial userid that created the folder.

 string
CreatedDate

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

 string
Size

The size of the folder.

 string
MimeType

Type of media file attached like text, Excel, PDF or Word.

 string
Content

The stream of files that need to be uploaded/downloaded from Jira.

 string
ErrorMessage

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

 string
name

The first, last, and middle name of the user as available in the SEI application.

 string
id

SEI Accounting system generated identifier for each transaction in a batch

 string


Attachment

Set Admin Credentials...
tickets-key-attachments-post

POST

/tickets/{key}/attachments

Prod:
https://api.seic.com/v2/workdesk/tickets/{key}/attachments
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

FileName

Upload File Name.

string

ContentType

The content contained in the file or folder.

string

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

string

Path Parameters
Name Description Data Type Required
key

The jira ticket number.

string

Body Parameters
Name Description Data Type Required
FileName

File to be uploaded.

object

HTTP Responses
  • Code
    Description
  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

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

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
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.

FileName

Upload File Name.

ContentType

The content contained in the file or folder.

Content-Type

Request content type. The valid values are multipart/form-data; boundary=123456789.

FileName

File to be uploaded.

Request Body

key The jira ticket number. null true

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...