Attachment Metadata

Metadata

GET

/attachmentmetadata

Returns attachment metadata details by task Id.

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

The jira ticket 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

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
key

The jira ticket 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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

Attachment Metadata

Metadata

GET

/attachmentmetadata

Returns attachment metadata details by task Id.

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

The jira ticket 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

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
key

The jira ticket 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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

Test: https://test.api.seic.com/v1/workdesk/attachmentmetadata
TLS*: https://mtls.api.seic.com/v1/workdesk/attachmentmetadata
*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 returns details for all the attachments in a given ticket. The value for the field "key" obtained from the "workdesk/ticketinfo" endpoint response serves as an input value for the key query param in this endpoint.

 

Attachment Metadata

Metadata

GET

/attachmentmetadata

Returns attachment metadata details by task Id.

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

The jira ticket 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

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
key

The jira ticket 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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X GET \

'https://api.seic.com/v1/workdesk/attachmentmetadata?key=SB-415 \

  -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

[
    {
        "Id": "",
        "Name": "",
        "CreatedUserName": "",
        "CreatedBy": "",
        "CreatedDate": "2017-05-23T06:59:29.780-0400",
        "Size": ,
        "MimeType": "",
        "ContentURL": "",
        "Content": null,
        "ErrorMessage": null
    }
]
MODEL
Operations
Name Description Data Type (L)
Id

Project Id.

string
Name

Project Name.

string
Content

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

string
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
ContentURL

The URL for accessing the attachment.

string
ErrorMessage

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

string


Attachment Metadata

Metadata

GET

/attachmentmetadata

Returns attachment metadata details by task Id.

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

The jira ticket 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

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
key

The jira ticket 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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...