openapi: 3.0.1
info:
title: Workdesk
version: v2
description: |
# Getting Started
For more information on how to start using our APIs, please refer to the Getting
Started guide.
***
# Servers
SEI's API products have various environments available depending on your stage of integration. The server URL should correspond with the environment of your application. Please refer to the Getting Started guide for a list of all environments and URLs.
**Note** For all Client applications, the Two-way TLS URL must be used. This is essential in order for the client server making API calls to establish a successful Two-Way SSL communication with SEI.
***
servers:
- url: 'https://build.api.seic.com'
description: Integration Server with masked data.
- url: 'https://sandbox.api.seic.com'
description: Sandbox Server with masked data.
- url: 'https://test.api.seic.com'
description: Test Server with unmasked data.
- url: 'https://api.seic.com'
description: Production Server with unmasked data.
- url: 'https://test.mtls.api.seic.com'
description: Two-way SSL Test Server.
- url: 'https://mtls.api.seic.com'
description: Two-way SSL Production Server.
paths:
/v2/workdesk/project:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Project
operationId: Project
summary: Project List
description: Returns a list of projects that user can access. Results will include the following values "ID" - Unique internal system ID associated with the project. "Name" - Display name associated with the project. "Key" - Unique end user facing ID associated with the project.
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/project' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Project'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Project'
examples:
Response Example:
$ref: '#/components/examples/ProjectExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/projectissuetype:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Project
operationId: ProjectIssueType
summary: Issue Types in Project
description: Returns a list of issue types present in a specific project based on the Unique internal system ID associated with the project.
parameters:
- name: projectId
in: query
required: true
description: A unique internal system ID associated with the project.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/projectissuetype?projectId=23233' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.IssueTypes'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.IssueTypes'
examples:
Response Example:
$ref: '#/components/examples/ProjectIssueTypeExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/projectissuetypefields:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Project
operationId: ProjectIssueTypeFields
summary: Provides the fields in an issue type for a project
description: Returns all the available fields in an issue type of a project. The value for the field "Id" obtained from the "workdesk/project" endpoint response serves as an input value for the projectId query param in this endpoint.The value for the field "Id" obtained from the "workdesk/projectissuetype" endpoint response serves as an input value for the issueTypeId query param in this endpoint.
parameters:
- name: projectId
in: query
required: true
description: A valid Jira Project Id
schema:
type: string
- name: issueTypeId
in: query
required: true
description: A valid Jira Issue Type Id
schema:
type: string
- name: operation
in: query
required: false
description: Screen operations create 0 edit 1 view 2
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/projectissuetypefields?projectId=23233&issueTypeId=19007' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Field'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Field'
examples:
Response Example:
$ref: '#/components/examples/ProjectIssueTypeFieldsExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/ticket:
post:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Tickets
summary: Ticket
description: Creates a new Task along with sample task attachment for reference. In addition to the request body, additional custom fields may be required in order to create a ticket for your project. Please reach out to SEI for further assistance
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request POST \
'https://api.seic.com/v2/workdesk/ticket' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
--header 'Content-Type: multipart/form-data; boundary=123456789'
--data-raw '--123456789--
Content-Disposition: form-data; name="ticketModel"
{
"fields" :{
"project" : { "id" : "23233" },
"issuetype" : {"name" : "Document Review"},
"summary": "Description Test",
"customfield_23440": "Fund",
"customfield_23450": {"value": "No", "id": "12345"},
"customfield_12450":"2021-8-8"
}}
--123456789--'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.TicketResponse'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.TicketResponse'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.TicketResponse'
required: true
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.TicketResponse'
examples:
Response Example:
$ref: '#/components/examples/CreateTicketExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
x-codegen-request-body-name: ticketModel
/v2/workdesk/transitionfields:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Transitions
operationId: TransitionFields
parameters:
- name: projectId
in: query
required: true
description: A valid Jira project identifier.
schema:
type: string
- name: transitionId
in: query
required: true
description: The system identifier of the transition.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/transitions?jiraTicketNo=SB-5855&transitionId=11' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Field'
examples:
Response Example:
$ref: '#/components/examples/TransitionFieldsExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/filtersearch:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Filter
operationId: filtersearch
summary: Filters
description: This endpoint will return results for a specific filter based on the unique ID of that filter and additional query parameters passed in the call. Results will include all columns that have been configured to be included within the filter. If you're just looking for the base filter results, you can use the "Get Ticket Info" endpoint.
parameters:
- name: filterId
in: query
required: true
description: Filter Id to retrieve tickets.
schema:
type: string
- name: searchText
in: query
required: true
description: This can be any search on text or a Jira ticket number.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/filtersearch?filterId=43678&searchText=updated%3E%20%222019%2F10%2F01%22' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.FilterSearch'
examples:
Response Example:
$ref: '#/components/examples/FilterSearchExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/{projectId}/assignableusers:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- AssignableUsers
operationId: AssignableUsers
parameters:
- name: projectId
in: path
required: true
description: A valid Jira project identifier.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/99912/assignableusers' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/filtercount:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Filter
operationId: Count
summary: List of filters
description: Retrieve the list of filters that have been set up for the applicable user id. Results will show unique IDs of each filter along with the base query of each filter. This information is helpful when trying to pull back a set of tickets using either the "Get Filter" or "Get Ticket" endpoints.
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/filtercount' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Filter'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Filter'
examples:
Request Example:
$ref: '#/components/examples/FilterCountExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/filterinfo:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Filter
operationId: Filter
summary: Filter Info
description: Returns specific information about a particular filterId. Once the count of filters is received from the /filtercount API, the /filterinfo API can be used to return specific information about a particular filterid.
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/filterinfo' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Filter'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Filter'
examples:
Response Example:
$ref: '#/components/examples/FilterInfoExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/ticketinfo:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Tickets
operationId: Info
summary: Ticket Information for provided filter
description: This endpoint will return a specific list of tickets based on the unique ID associated with the "filterId" passed in the call. The results will include all data points that have been configured to return for each ticket. Available fields can be updated by SEI upon request. You can retrieve a list of available options for "filterId" using the "Get List of Filters" endpoint. The "Id" field that is part of those results can be passed in the "filterId" parameter.
parameters:
- name: filterId
in: query
required: true
description: Unique ID associated with the list of tickets you're looking to pull from the system
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/ticketinfo?filterId=43678' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Tickets'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Tickets'
examples:
Response Example:
$ref: '#/components/examples/TicketInfoExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/ticketstatusbyfilterid:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Tickets
operationId: StatusById
summary: Filter results
description: This endpoint will return results for a specific group of tickets (filter) based on the unique ID of that filter. Results will include all data points that have been configured to be included within the filter. The value for "filterId" can be obtained from the "Get filterinfo" endpoint. The "Id" field in that response serves as an input value for the "filterId".
parameters:
- name: filterId
in: query
required: true
description: Unique ID of the filter being retrieved.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/ticketstatusbyfilterid?filterId=43678' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Tickets'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Tickets'
examples:
Response Example:
$ref: '#/components/examples/TicketStatusbyFilterIdExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/ticketsbyfilterstatus:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Tickets
summary: Tickets by filter status
description: Returns task status by filter ID. The /workdesk/ticketstatusbyfilterid returns all of the current status designations for the filterid, along with assigned color and number of issues in each status name. This can be used by applications to review how many issues may be in "Open AML Items Required", "SEI Received", or other statuses within Workdesk. The value for the field "Id" obtained from the "workdesk/filtercount" or "workdesk/filterinfo"endpoint response serves as an input value for the filterId query param in this endpoint.
operationId: TicketsByStatus
parameters:
- name: filterId
in: query
required: true
description: Filter Id to retrieve tickets.
schema:
type: string
- name: statusId
in: query
description: Status ID or status name for which tickets need to be returned.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/ticketsbyfilterstatus?filterId=43678' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.TicketbyFilterstatus'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Tickets'
examples:
Response Example:
$ref: '#/components/examples/TicketsbyFilterStatusExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/viewticket:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Tickets
summary: Ticket Details
description: Returns task details by task Id. The /workdesk/viewticket API can be used to drill into and display specific issue details for a Jira Ticket Number. The value for the field "key" obtained from the "workdesk/ticketinfo" endpoint response serves as an input value for the jiraTicketNo query param in this endpoint.
operationId: ViewTicket
parameters:
- name: jiraTicketNo
in: query
required: true
description: Unique end user facing ID associated with the ticket.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/viewticket?jiraTicketNo=SB-5855' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.FieldCollection'
examples:
Response Example:
$ref: '#/components/examples/ViewTicketExample'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/editticketfields:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Tickets
operationId: EditTicketFields
summary: Editable fields
description: This endpoint retrieves a list of fields associated with the "Edit" screen for a given issue key.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.
parameters:
- name: key
in: query
required: true
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/editticketfields?key=SB-5855' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Field'
examples:
Response Example:
$ref: '#/components/examples/EditTicketFieldsExample'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Field'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/editticket/{issueKey}:
post:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Tickets
operationId: EditTicket
summary: Edit ticket
description: This endpoint will edit the fields for a valid jira ticket for an authorized user .The value for the field "key" obtained from the "workdesk/ticketinfo" or "workdesk/ticket" endpoint response serves as an input value for the path param in this endpoint.
parameters:
- name: issueKey
in: path
required: true
description: Unique end user facing ID associated with the ticket.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request POST \
'https://api.seic.com/v2/workdesk/editticket/SB-5855' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY' \
--header 'Content-type: multipart/form-data; boundary=123456789' \
--data-raw '123456789
Content-Disposition: form-data; name="ticketModel"
{
"fields" : {
"summary" : "test 123",
"issuetype" : {
"id" : "3"
},
"project" : {
"id" : "14371"
},
"description" : "Anuxy"
}
}
--123456789--'
responses:
200:
description: OK- The request has succeeded and the response has been returned. URL to access the edited ticket is returned in the response.
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/userticketpermission:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Tickets
operationId: Ticket Permission
summary: Ticket permission
description: This endpoint retrieves a list of all the permissions available for a user for a ticket. 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.
parameters:
- name: jiraticketno
in: query
required: true
description: The Jira ticket number.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/ticketpermission?jiraTicketNo=SB-5855' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Permission'
examples:
Response Example:
$ref: '#/components/examples/UserTicketPermissionExample'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Permission'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/transitions:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Transitions
operationId: Ticket Transitions
summary: Ticket Transitions
description: This endpoint retrieves a list of available transitions for the given ticket key. 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.
parameters:
- name: key
in: query
required: true
description: The jira ticket number.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/transitions?key=SB-5855' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Transition'
examples:
Response Example:
$ref: '#/components/examples/TransitionsExample'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Transition'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections.
500:
description: 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.
post:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Transitions
summary: Ticket Transitions
description: This endpoint will set the ticket to an appropriate status.The value for the field "key" obtained from the "workdesk/ticketinfo" endpoint response serves as an input value for the jiraTicketNo query param in this endpoint.The value for the field "Id" obtained from the "workdesk/transitions" endpoint response serves as an input value for the transitionId query param in this endpoint.
parameters:
- name: jiraTicketNo
in: query
required: true
description: The Jira ticket number.
schema:
type: string
- name: transitionId
in: query
required: true
description: The system identifier of the transition.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request POST \
'https://api.seic.com/v2/workdesk/transitions?jiraTicketNo=SB-5855&transitionId=11' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
type: string
example: true
text/json:
schema:
type: string
example: true
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/{jiraTicketNo}/transitions:
patch:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Transitions
operationId: TransitionsPatch
summary: Update Transitions
description: Update Transitions
parameters:
- name: jiraTicketNo
in: path
required: true
description: The Jira ticket number.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request PATCH \
'https://api.seic.com/v2/workdesk/AAA-38573/transitions' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
--header 'Content-Type: multipart/form-data; boundary=123456789'
--form 'jsonData-"{
"transition" : {
"id" : "101"
},
"fields" : {
"customfield_13039" : {
"id" : "15756",
"value" : "Perf - Missing\/Incorrect Benchmark"
},
"customfield_13038" : "Test 12f3"
}
}
"'
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.TransitionPatchRequest'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/comments:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Comments
operationId: Comments
summary: Ticket comments
description: Returns comments for a task identified by its id. This endpoint returns the list of all comments for 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.
parameters:
- name: key
in: query
required: true
description: The jira ticket number.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/comments?key=SB-5855' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Comments'
examples:
Response Example:
$ref: '#/components/examples/CommentsExample'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Comments'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
post:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Comments
summary: Ticket comments
description: Adds comments to an existing task identified by its jiraTicketNo. 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.
parameters:
- name: jiraTicketNo
in: query
required: true
description: The Ticket Number.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/comments?jiraTicketNo=SB-5855' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
--header 'Content-type: application/json'
--data-raw '{
"Id: 0",
"Text": "Adding second comment"
}'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.UserComment'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.UserComment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.UserComment'
required: true
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Comments'
examples:
Response Example:
$ref: '#/components/examples/CommentsPostExample'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Comments'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
x-codegen-request-body-name: commentModel
/v2/workdesk/tickets/{key}/attachments:
post:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Attachments
summary: Attachments to a ticket
description: Use this endpoint to add an attachment to a specific ticket.
parameters:
- name: key
in: path
required: true
description: Task number.
schema:
type: string
- name: FileName
in: header
required: true
description: Actual name of the media being uploaded, including the extension such as "test doc.pdf."
schema:
type: string
- name: Content-Type
in: header
required: true
description: Default value of the content type is application/x-www-form-urlencoded.
schema:
type: string
- name: ContentType
in: header
required: true
description: Specific to the media being uploaded such as "application/pdf" or "application/docx".
schema:
type: string
enum: [application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/png]
description: >
Content Type:
* `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` - File type xlsx
* `application/pdf` - File type pdf
* `application/vnd.openxmlformats-officedocument.wordprocessingml.document` - File type docx
* `image/png` - File type png
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request POST \
'https://api.seic.com/v2/workdesk/tickets/SB-5855/attachments' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY' \
--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"
}
requestBody:
content:
form-data:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.AttachmentFile'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.AttachmentFile'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.AttachmentFile'
required: true
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Attachment'
examples:
Response Example:
$ref: '#/components/examples/AttachmentExample'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Attachment'
400:
description: 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.
content:
application/json:
schema:
type: string
text/json:
schema:
type: string
401:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
content:
application/json:
schema:
type: string
text/json:
schema:
type: string
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
content:
application/json:
schema:
type: string
text/json:
schema:
type: string
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
content:
application/json:
schema:
type: string
text/json:
schema:
type: string
500:
description: 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.
content:
application/json:
schema:
type: string
text/json:
schema:
type: string
x-codegen-request-body-name: FileName
/v2/workdesk/attachmentmetadata:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Attachments
operationId: Metadata
summary: Attachments Metadata
description: This endpoint returns a list of metadata associated with each attachment found on the specific "ticketNumber" passed in the call.
parameters:
- name: jiraTicketNo
in: query
required: true
description: Unique end user facing ID associated with the ticket.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/attachmentmetadata?key=SB-5855' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.AttachmentDetail'
examples:
Response Example:
$ref: '#/components/examples/AttachmentMetadataExample'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.AttachmentDetail'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/attachmentsbyticket:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Attachments
operationId: Attachment
summary: Attachments
description: This enpoints pull an attachment from a ticket based on the specific ticket ID and attachment ID passed. The "Id" value returned from the "Attachments Metadata" endpoint corresponds to the attachment ID for each attachment on the ticket.
parameters:
- name: jiraTicketNo
in: query
required: true
description: Unique end user facing ID associated with the ticket.
schema:
type: string
- name: attachmentId
in: query
required: true
description: Unique internal ID associated with an attachment.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/attachmentsbyticket?jiraTicketNo=SB-5855&attachmentId=7890233' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
text/json:
schema:
type: string
example: "Attachment in the requested ticket. It can be any of the following excel, jpeg, word or png file etc."
application/json:
schema:
type: string
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/ticketsearch:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- Tickets
operationId: Search
summary: This endpoint retrieves a list of tickets based on the search text passed in the query parameter.
parameters:
- name: searchText
in: query
required: true
description: Any search text or Jira ticket Key.
schema:
type: string
- name: filterId
in: query
description: Pass if the scope of search needs to be limited based on given filter.
schema:
type: string
- name: getAll
in: query
description: If true will return all tickets that matches search inputs, default is false and will return top 25.
schema:
type: boolean
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/ticketsearch?searchText=SB-5855' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.FilterSearch'
examples:
Response Example:
$ref: '#/components/examples/TicketSearchExample'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.FilterSearch'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
/v2/workdesk/listofusers:
get:
security:
- oauth2: []
bearerAuth: []
ApiKeyAuth: []
tags:
- ListOfUsers
operationId: ListOfUsers
parameters:
- name: jiraticketno
in: query
description: Represents the Jira ticket number.
schema:
type: string
- name: permissionId
in: query
description: Receive this from the GET User Ticket Permission endpoint.
schema:
type: string
x-codeSamples:
- lang: 'cURL'
source: |
curl --location --request GET \
'https://api.seic.com/v2/workdesk/listofusers?jiraticketno=AP-1560&permissionId=COMMENT_EDIT_ALL' \
--header 'Authorization: Bearer ADsgdnnkjnfdIKJN==' \
--header 'AppKey: YOUR_APPKEY'
responses:
200:
description: OK- The request has succeeded and the response has been returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ListOfUsers'
text/json:
schema:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ListOfUsers'
400:
description: 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:
description: Unauthorized - Invalid authentication details have been provided. Also
useful to trigger an authorization pop up if the API is used from a browser.
403:
description: Forbidden-The SEI Server understood the request but refuses
to fulfill it.
404:
description: Not Found- The requested resource or the underlying resource
does not exist. Please resubmit the request after making the required
corrections
500:
description: 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.
components:
securitySchemes:
oauth2:
type: oauth2
description: To access any API, first obtain an OAuth Token. Refer to the Access Token documentation for more information. The token has a 60 minutes active TTL and 30 minutes inactive TTL. An application making SEI API Requests from a Client/Server or Server/Server type of infrastructure will leverage the grant_type client_credentials while minting an OAuth from the Token API.
flows:
clientCredentials:
tokenUrl: /v2/oauthtoken
scopes: {}
bearerAuth:
type: http
scheme: bearer
description: After successfully obtaining an OAuth token, pass the access_token value to the desired API endpoint by including the header parameter 'Authorization' with the value 'Bearer access_token'.
ApiKeyAuth:
type: apiKey
in: header
name: AppKey
description: Pass the header parameter 'AppKey' to the API endpoint to authenticate your application. This value can be found within the 'My Apps' page. This value uniquely identifies the registered application.
schemas:
SEI.IMS.ECM.API.DomainModel.FilterSearch:
type: object
properties:
StartAt:
type: string
description: "Starting record count."
MaxResults:
type: string
description: "Identifies the maximum results returned from a given filter. Default is 50. Maximum is 1,000. If a filter returns more than 1,000 entries you can use the startAt parameter to retrieve results greater than 1,000. Example: A filter returns 1,200 results. To retrieve results 1,001 to 1,200 you should enter a value of 1,000 in the startAt parameter."
Total:
type: string
description: "The toal number of results returned."
Issues:
type: array
description: "This is an array of all Jira issues returned for the filterid passed to the API."
items:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Issues'
project:
type: string
description: "Name of the Jira project."
issuetype:
type: string
description: "The type of issue specific to the Jira ticket."
summary:
type: string
description: "Summary."
SEI.IMS.ECM.API.DomainModel.TicketbyFilterstatus:
type: object
properties:
StartAt:
type: string
description: "Starting record count."
MaxResults:
type: string
description: "Identifies the maximum results returned from a given filter. Default is 50. Maximum is 1,000. If a filter returns more than 1,000 entries you can use the startAt parameter to retrieve results greater than 1,000. Example: A filter returns 1,200 results. To retrieve results 1,001 to 1,200 you should enter a value of 1,000 in the startAt parameter."
Total:
type: string
description: "The toal number of results returned."
Issues:
type: array
description: "This is an array of all Jira issues returned for the filterid passed to the API."
items:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Issues'
project:
type: string
description: "Name of the Jira project."
issuetype:
type: string
description: "The type of issue specific to the Jira ticket."
IssuesFetched:
type: string
description: "Summary."
SEI.IMS.ECM.API.DomainModel.ListOfUsers:
type: object
properties:
Key:
type: string
description: ""
Name:
type: string
description: ""
EmailAddress:
type: string
description: ""
DisplayName:
type: string
description: ""
Active:
type: string
description: ""
SEI.IMS.ECM.API.DomainModel.ServiceDesk.Filter:
type: object
properties:
Id:
type: string
description: "Project Id."
example: 10000
Name:
type: string
description: "Project Name."
example: API Story
Description:
type: string
description: "This field holds additional information about the field, and is provided during setup."
Jql:
type: string
description: "The actual Jira query that generates the filter results."
example: "project = Test"
Total:
type: integer
description: "The total number of results returned."
format: int32
example: 5
StatusBreakDown:
type: array
description: "Assigned Status"
items:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Status'
SEI.IMS.ECM.API.DomainModel.ServiceDesk.Status:
type: object
properties:
Id:
type: string
description: ""
Name:
type: string
description: ""
StatusColor:
type: string
description: ""
Total:
type: integer
description: ""
format: int32
SEI.IMS.ECM.API.DomainModel.ServiceDesk.Tickets:
type: object
properties:
id:
type: string
description: "Unique internal ID of the Filter"
example: "5"
Name:
type: string
description: "Status Name"
example: "Resolved"
StatusColor:
type: string
description: ""
example: "success"
Total:
type: integer
description: "Total number of issues with this status in the provided filter"
example: 42
SEI.IMS.ECM.API.DomainModel.ServiceDesk.Issues:
type: object
properties:
Id:
type: string
description: "SEI Accounting system generated identifier for each transaction in a batch"
example: 348103
Key:
type: string
description: "This value is returned by the POST schedule API in the response as the field jobStatusQueryKey."
example: WWC-4
Values:
type: array
description: "The value that is associated with the Key."
items:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.KeyValuePair'
description: ""
SEI.IMS.ECM.API.DomainModel.ServiceDesk.Project:
type: object
properties:
Id:
type: string
description: "Project Id."
example: 15050
Name:
type: string
description: "Project Name."
example: WRK Test
Key:
type: string
description: "Task Number."
example: WT
SEI.IMS.ECM.API.DomainModel.ServiceDesk.IssueTypes:
type: object
properties:
Id:
type: integer
description: "Project Id."
format: int32
example: 10000
Name:
type: string
description: "Project Name."
example: WRK Test
IsSubTask:
type: boolean
description: "Defines whether the issue is a subtask or not."
example: false
SEI.IMS.ECM.API.DomainModel.ServiceDesk.KeyValuePair:
type: object
properties:
Key:
type: string
description: "This value is returned by the POST schedule API in the response as the field jobStatusQueryKey."
example: Issue Type
Value:
type: string
description: "The value that is associated with the Key."
example: Account Maintenance
SEI.IMS.ECM.API.DomainModel.ServiceDesk.FieldCollection:
type: object
properties:
Standard:
type: array
description: ""
items:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Field'
Custom:
type: array
description: ""
items:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.Field'
description: ""
SEI.IMS.ECM.API.DomainModel.ServiceDesk.Field:
type: object
properties:
Id:
type: string
description: Project Id.
Name:
type: string
description: Project Name.
Value:
type: string
description: The value within the Jira object.
IsRequired:
type: boolean
description: Defines whether the field is required or not for the Task object.
HasDefaultValue:
type: boolean
description: Defines whether the field has a default value when none is provided.
AllowedValues:
type: array
description: The allowable values for the object, if provided.
items:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.KeyValuePairId'
FieldType:
type: string
description: "The data type of the field (i.e., string, boolean, etc.)"
ControlType:
type: string
description: "The field control on the user interface, such as text field, checklist, etc."
SEI.IMS.ECM.API.DomainModel.ServiceDesk.KeyValuePairId:
type: object
properties:
id:
type: string
description: "Project Id."
example: 10000
value:
type: string
description: "The value within the Jira object."
example: 00South
name:
type: string
description: "Project Name."
SEI.IMS.ECM.API.DomainModel.ServiceDesk.Transition:
type: object
properties:
Id:
type: string
description: ""
Name:
type: string
description: ""
StatusName:
type: string
description: ""
StatusColor:
type: string
description: ""
description: ""
SEI.IMS.ECM.API.DomainModel.ServiceDesk.TransitionPatchRequest:
type: object
properties:
transition:
type: array
items:
properties:
id:
type: string
description: The system identifier of the transition.
fields:
type: array
items:
properties:
customfield:
type: string
SEI.IMS.ECM.API.DomainModel.ServiceDesk.Comments:
type: object
properties:
StartAt:
type: integer
description: "Starting record count."
format: int32
MaxResults:
type: integer
description: "The maximum number of results that can be returned in the API call."
format: int32
Total:
type: integer
description: "The total number of results returned."
format: int32
Data:
type: array
description: "The collection of statistics associated with the task."
items:
$ref: '#/components/schemas/SEI.IMS.ECM.API.DomainModel.ServiceDesk.CommentData'
SEI.IMS.ECM.API.DomainModel.ServiceDesk.CommentData:
type: object
properties:
Id:
type: string
description: "Project Id."
example: 111111
CreatedUserName:
type: string
description: "Name of the person who created the comment or uploaded the attachment."
example: Testoff
CreatedBy:
type: string
description: "The initial userid that created the folder."
example: Testing Off
CreatedEmailId:
type: string
description: "Email address of the person who created the comment or uploaded the attachment."
example: testoff@seic.com
UpdatedBy:
type: string
description: "Name of person who modified comment or attachment in Jira."
example: Testing Off
UpdatedEmailId:
type: string
description: "Email address of the person who modified the comment or attachment in Jira."
example: testoff@seic.com
Value:
type: string
description: "The value within the Jira object."
example: AP-1234
RenderBody:
type: string
description: "The comment text."
example: AP-1234
CreatedDate:
type: string
description: "Date on which the attachment or comment was added to Jira."
example: 2018-05-30T15:49:14.847-0400
UpdatedDate:
type: string
description: "Date on which comment or attachment was modified in Jira."
example: 2018-05-30T15:49:14.847-0400
ErrorMessage:
type: string
description: "Descriptive text in a response to further explain the http response code."
SEI.IMS.ECM.API.DomainModel.ServiceDesk.UserComment:
type: object
properties:
Id:
type: integer
description: "Project Id."
format: int32
example: duedate
Text:
type: string
description: "The comment text."
example: abc
SEI.IMS.ECM.API.DomainModel.ServiceDesk.AttachmentDetail:
type: object
properties:
Id:
type: string
description: "Project Id."
Name:
type: string
description: "Project Name."
CreatedUserName:
type: string
description: "Name of the person who created the comment or uploaded the attachment."
CreatedBy:
type: string
description: "The initial userid that created the folder."
example: Testing Off
CreatedDate:
type: string
description: "Date on which the attachment or comment was added to Jira."
Size:
type: integer
description: "The size of the folder."
format: int32
MimeType:
type: string
description: "Type of media file attached like text, Excel, PDF, or Word."
ContentURL:
type: string
description: "The URL for accessing the attachment."
SEI.IMS.ECM.API.DomainModel.ServiceDesk.TicketResponse:
type: object
properties:
fields:
type: object
properties:
project:
type: object
properties:
id:
type: string
issuetype:
type: object
properties:
id:
type: string
summary:
type: string
duedate:
type: string
priority:
type: object
properties:
id:
type: string
value:
type: string
description: ""
SEI.IMS.ECM.API.DomainModel.ServiceDesk.Permission:
type: object
properties:
Id:
type: string
description: ""
Key:
type: string
description: ""
PermissonType:
type: string
description: ""
Name:
type: string
description: ""
Description:
type: string
description: ""
HavePermission:
type: string
description: ""
description: ""
SEI.IMS.ECM.API.DomainModel.ServiceDesk.Attachment:
type: object
properties:
Id:
type: string
description: "Project Id."
Name:
type: string
description: "Project Name."
CreatedUserName:
type: string
description: "Name of the person who created the comment or uploaded the attachment."
CreatedBy:
type: string
description: "The initial userid that created the folder."
CreatedDate:
type: string
description: "Date on which the attachment or comment was added to Jira."
Size:
type: string
description: "The size of the folder."
MimeType:
type: string
description: "Type of media file attached like text, Excel, PDF, or Word."
Content:
type: string
description: "The stream of files that need to be uploaded/downloaded from the Task."
ErrorMessage:
type: string
description: "Descriptive text in a response to further explain the http response code."
SEI.IMS.ECM.API.DomainModel.ServiceDesk.AttachmentFile:
type: object
properties:
FileName:
type: string
description: "Upload File Name."
description: ""
examples:
ProjectExample:
value:
- Id: '23233'
Name: Workdesk Test
Key: WD
- Id: '15167'
Name: JIRA Support
Key: JIRA
- Id: '18876'
Name: WRK TEST
Key: WTT
ProjectIssueTypeExample:
value:
- Id: 10000
Name: Maintenance
IsSubTask: false
- Id: 12003
Name: Test Update
IsSubTask: false
- Id: 13005
Name: Subscription
IsSubTask: false
- Id: 19007
Name: Document Review
IsSubTask: false
ProjectIssueTypeFieldsExample:
value:
- Id: summary
Name: Summary
Value: null
IsRequired: true
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
ControlType: TextBox
CustomId: null
- Id: component
Name: Component
Value: null
IsRequired: false
HasDefaultValue: false
AllowedOperation:
- add
- set
- remove
AllowedValues:
- id: '26580'
value: null
name: Test
disabled: null
- id: '28740'
value: null
name: Workdesk
disabled: null
FieldType: string
ControlType: DropDown
CustomId: null
- Id: customfield_23440
Name: Product Name
Value: null
IsRequired: true
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
ControlType: textfield
CustomId: null
- Id: customfield_23450
Name: Product ID
Value: null
IsRequired: true
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
ControlType: textfield
CustomId: null
- Id: customfield_12450
Name: Report Date
Value: null
IsRequired: true
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: date
ControlType: datepicker
CustomId: null
CreateTicketExample:
value:
id: 1000000
key: TC-12345
FilterSearchExample:
value:
StartAt: 0
MaxResults: 5000
Total: 4
Issues:
- Id: '1234861'
Key: WW-12345
Values:
- Key: Issue Type
Value: Enhancement
- Key: IssueTypeIcon
Value: hTRMEaMEEalNBBBPSUhEUgAAABAAAAAQCAYAAAAf8/7hAAAABGdBWEDAALGPC/ptMQBBBBlwSFlzAAAOwgAADsYTREhKgAAAAK9JREFUOE9joArI2uIpnrHVbV7GFvf/tOD0Le7Lsra46kO1MzCCFdehKyKIN7ufg2oIY4BdEQEM1Y7bgFP3j/z/5uwMMjkQhmrHbQTBOJMDYah2KhsAcjYbrO4dqWIRB158eApVjgk+ppnA2ABkDAPY9EAYqp2GBoC8g+5sZAzVltrAQhiqHWgPRTliU4APp292ewbVzsCQrguinPmOL6z7sCnHgd2mb3NOh2ikBDAwAvzr4V+3H1WcBBCRSUVPTR5CYII=
- Key: Key
Value: WW-12345
- Key: Summary
Value: Mapping
- Key: Component/s
Value:
- AB
- Key: Linked Issues
Value:
- null
- Id: '2345567'
Key: WW-24123
Values:
- Key: Issue Type
Value: Enhancement
- Key: IssueTypeIcon
Value: hTRMEaMEEalNBBBPSUhEUgAAABAAAAAQCAYAAAAf8/7hAAAABGdBWEDAALGPC/ptMQBBBBlwSFlzAAAOwgAADsYTREhKgAAAAK9JREFUOE9joArI2uIpnrHVbV7GFvf/tOD0Le7Lsra46kO1MzCCFdehKyKIN7ufg2oIY4BdEQEM1Y7bgFP3j/z/5uwMMjkQhmrHbQTBOJMDYah2KhsAcjYbrO4dqWIRB158eApVjgk+ppnA2ABkDAPY9EAYqp2GBoC8g+5sZAzVltrAQhiqHWgPRTliU4APp292ewbVzsCQrguinPmOL6z7sCnHgd2mb3NOh2ikBDAwAvzr4V+3H1WcBBCRSUVPTR5CYII=
- Key: Key
Value: WW-24123
- Key: Summary
Value: update
- Key: Component/s
Value:
- BB
- Key: Linked Issues
Value: []
- Id: '2667284'
Key: WW-13344
Values:
- Key: Issue Type
Value: Task
- Key: IssueTypeIcon
Value: hTRMEaMEEalNBBBPSUhEUgAAABAAAAAQCAYAAAAf8/7hAAAABGdBWEDAALGPC/ptMQBBBBlwSFlzAAAOwgAADsYTREhKgAAAAK9JREFUOE9joArI2uIpnrHVbV7GFvf/tOD0Le7Lsra46kO1MzCCFdehKyKIN7ufg2oIY4BdEQEM1Y7bgFP3j/z/5uwMMjkQhmrHbQTBOJMDYah2KhsAcjYbrO4dqWIRB158eApVjgk+ppnA2ABkDAPY9EAYqp2GBoC8g+5sZAzVltrAQhiqHWgPRTliU4APp292ewbVzsCQrguinPmOL6z7sCnHgd2mb3NOh2ikBDAwAvzr4V+3H1WcBBCRSUVPTR5CYII=
- Key: Key
Value: WW-13344
- Key: Summary
Value: Enhance the item
- Key: Component/s
Value:
- AB
- Key: Linked Issues
Value:
- null
- Id: '2668240'
Key: WW-29611
Values:
- Key: Issue Type
Value: Task
- Key: IssueTypeIcon
Value: hTRMEaMEEalNBBBPSUhEUgAAABAAAAAQCAYAAAAf8/7hAAAABGdBWEDAALGPC/ptMQBBBBlwSFlzAAAOwgAADsYTREhKgAAAAK9JREFUOE9joArI2uIpnrHVbV7GFvf/tOD0Le7Lsra46kO1MzCCFdehKyKIN7ufg2oIY4BdEQEM1Y7bgFP3j/z/5uwMMjkQhmrHbQTBOJMDYah2KhsAcjYbrO4dqWIRB158eApVjgk+ppnA2ABkDAPY9EAYqp2GBoC8g+5sZAzVltrAQhiqHWgPRTliU4APp292ewbVzsCQrguinPmOL6z7sCnHgd2mb3NOh2ikBDAwAvzr4V+3H1WcBBCRSUVPTR5CYII=
- Key: Key
Value: WW-29611
- Key: Summary
Value: Need access
- Key: Component/s
Value:
- AB
- Key: Linked Issues
Value: []
project: null
issuetype: null
summary: null
IssuesFetched: 4
FilterInfoExample:
value:
- Id: '43678'
Name: All IS Transactions
Description: ''
Jql: Project = "Capital" AND issuetype in ("New Subscription", "Additional Subscription", "Account Maintenance", "Partial Redemption", "Partial Transfer", "Full Redemption", "Full Transfer") ORDER BY issuetype ASC, status ASC
Total: 0
StatusBreakDown: null
- Id: '24638'
Name: Money Movement Issue
Description: ''
Jql: Project = "Capital" AND issuetype in ("New Subscription") AND status = "AML Items Required for Money Movement" ORDER BY status ASC
Total: 0
StatusBreakDown: null
- Id: '13754'
Name: Open FATCA Items
Description: ''
Jql: issuetype = "Review" AND project = "Worldwide Capital" AND status != "SEI Approved" ORDER BY cf[12464] ASC
Total: 0
StatusBreakDown: null
- Id: '27392'
Name: Outstanding AML Items Required
Description: ''
Jql: Project = "Capital" AND issuetype in ("New Subscription", "Additional Subscription", "Account Maintenance", "Partial Redemption", "Partial Transfer", "Full Redemption", "Full Transfer") AND status = "Open AML Items Required"
Total: 0
StatusBreakDown: null
- Id: '19377'
Name: Accounting Tickets
Description: ''
Jql: project = "Capital" AND issuetype in ("PA Valuation", "FA PE Valuation", "FA Hedge Valuation")
Total: 0
StatusBreakDown: null
- Id: '12762'
Name: Document Review
Description: ''
Jql: Project = WPC AND issuetype = "Document Review"
Total: 0
StatusBreakDown: null
FilterCountExample:
value:
- Id: '43678'
Name: API MY stories
Description: null
Jql: project = Test
Total: 0
StatusBreakDown: null
TicketStatusbyFilterIdExample:
value:
- Id: '15079'
Name: Open AML Items Required
StatusColor: yellow
Total: 11
TicketInfoExample:
value:
StartAt: 0
MaxResults: 154
Total: 154
Issues:
- Id: '3489127'
Key: SB-5855
Values:
- Key: Issue Type
Value: Account Maintenance
- Key: IssueTypeIcon
Value: hTRMEaMEEalNBBBPSUhEUgAAABAAAAAQCAYAAAAf8/7hAAAABGdBWEDAALGPC/ptMQBBBBlwSFlzAAAOwgAADsYTREhKgAAAAK9JREFUOE9joArI2uIpnrHVbV7GFvf/tOD0Le7Lsra46kO1MzCCFdehKyKIN7ufg2oIY4BdEQEM1Y7bgFP3j/z/5uwMMjkQhmrHbQTBOJMDYah2KhsAcjYbrO4dqWIRB158eApVjgk+ppnA2ABkDAPY9EAYqp2GBoC8g+5sZAzVltrAQhiqHWgPRTliU4APp292ewbVzsCQrguinPmOL6z7sCnHgd2mb3NOh2ikBDAwAvzr4V+3H1WcBBCRSUVPTR5CYII=
- Key: Key
Value: SB-5855
- Key: Transaction ID
Value: IS2495784476
- Key: Status
Value: Initial SEI Review
- Key: StatusColor
Value: blue-gray
- Key: Fund
Value: Fund, LP
- Key: Summary
Value: Account Maintenance
- Key: Investor
Value: UNIVERSITY OF STATE
- Key: Investor ID
Value: '65298'
- Key: Description
Value: PLEASE PROVIDE A SIGNED AND DATED DEC 2014 REVISION OF THE W9
- Key: Updated
Value: 04/26/2017 14:07:08
- Id: '123114'
Key: SB-14
Values:
- Key: Issue Type
Value: Account Maintenance
- Key: IssueTypeIcon
Value: hTRMEaMEEalNBBBPSUhEUgAAABAAAAAQCAYAAAAf8/7hAAAABGdBWEDAALGPC/ptMQBBBBlwSFlzAAAOwgAADsYTREhKgAAAAK9JREFUOE9joArI2uIpnrHVbV7GFvf/tOD0Le7Lsra46kO1MzCCFdehKyKIN7ufg2oIY4BdEQEM1Y7bgFP3j/z/5uwMMjkQhmrHbQTBOJMDYah2KhsAcjYbrO4dqWIRB158eApVjgk+ppnA2ABkDAPY9EAYqp2GBoC8g+5sZAzVltrAQhiqHWgPRTliU4APp292ewbVzsCQrguinPmOL6z7sCnHgd2mb3NOh2ikBDAwAvzr4V+3H1WcBBCRSUVPTR5CYII=
- Key: Key
Value: SB-14
- Key: Transaction ID
Value: '2864174505'
- Key: Status
Value: Complete
- Key: StatusColor
Value: green
- Key: Fund
Value: Fund, Ltd
- Key: Summary
Value: Account Maintenance
- Key: Investor
Value: JACK & JUDITH 1975 Trust
- Key: Investor ID
Value: WW104222-123
project: null
issuetype: null
summary: null
ViewTicketExample:
value:
Standard:
- Id: issueid
Name: IssueId
Value: '427534'
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: summary
Name: summary
Value: Account Maintenance
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
- Id: issuetype
Name: issuetype
Value: Account Maintenance
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: issuetypeicon
Name: IssueTypeIcon
Value: hTRMEaMEEalNBBBPSUhEUgAAABAAAAAQCAYAAAAf8/7hAAAABGdBWEDAALGPC/ptMQBBBBlwSFlzAAAOwgAADsYTREhKgAAAAK9JREFUOE9joArI2uIpnrHVbV7GFvf/tOD0Le7Lsra46kO1MzCCFdehKyKIN7ufg2oIY4BdEQEM1Y7bgFP3j/z/5uwMMjkQhmrHbQTBOJMDYah2KhsAcjYbrO4dqWIRB158eApVjgk+ppnA2ABkDAPY9EAYqp2GBoC8g+5sZAzVltrAQhiqHWgPRTliU4APp292ewbVzsCQrguinPmOL6z7sCnHgd2mb3NOh2ikBDAwAvzr4V+3H1WcBBCRSUVPTR5CYII=
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: creator
Name: creator
Value: Smith Sharma
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: subtasks
Name: subtasks
Value: ''
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: created
Name: created
Value: 05/09/2016 15:49:30
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: description
Name: description
Value: PLEASE PROVIDE A SIGNED AND DATED DEC 2014 REVISION OF THE W9
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: reporter
Name: reporter
Value: Rob Mill
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: priority
Name: priority
Value: Critical
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: resolution
Name: resolution
Value: ''
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: labels
Name: labels
Value: ''
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: duedate
Name: duedate
Value: ''
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: assignee
Name: assignee
Value: ''
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: updated
Name: updated
Value: 04/26/2017 14:07:08
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: status
Name: status
Value: Initial SEI Review
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
- Id: statuscolor
Name: statuscolor
Value: blue-gray
IsRequired: false
HasDefaultValue: false
AllowedOperation: null
AllowedValues: null
FieldType: null
ControlType: null
CustomId: null
Custom:
- Id: customfield_12749
Name: Transaction ID
Value: '1233956290'
IsRequired: false
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
ControlType: textfield
CustomId: null
- Id: customfield_12750
Name: Investor
Value: UNIVERSITY OF STATE
IsRequired: false
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
ControlType: textfield
CustomId: null
- Id: customfield_12751
Name: Account Maintenance Type
Value: Address Change
IsRequired: false
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
ControlType: textfield
CustomId: null
- Id: customfield_12475
Name: Investor ID
Value: WWA12334
IsRequired: false
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
ControlType: textfield
CustomId: null
- Id: customfield_17432
Name: Investor Service Peer Review Checklist
Value: Has analyst completed and imported AML review?,Have you reviewed all analyst work?,Has the client sent the executed signature page?
IsRequired: false
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
ControlType: checklist
CustomId: null
- Id: customfield_12843
Name: Investor Service Account Maintenance Checklist
Value: Has the transaction been acknowledged and approved for processing by the client? ,Have you made the appropriate changes in the applicable System?,Does the change require a new Bridger Investor Name scan to be completed? (Investor name change),Does the change require a new Bridger Investor Name/Address scan to be completed? (Investor mailing or legal address change),Does the change require a new Bridger Wire Instructions scan to be completed?,Does the change require a new Bridger Authorized Signature scan to be completed?,Does the change require a new Bridger BO/Partner Name/Addr scan to be completed? (Trustees, Partners, Beneficial Owners)?,Is this a change in an investor's new issue status?
IsRequired: false
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
ControlType: checklist
CustomId: null
- Id: customfield_10543
Name: Fund
Value: Fund, LP
IsRequired: false
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
TicketsbyFilterStatusExample:
value:
StartAt: 0
MaxResults: 2
Total: 1
Issues:
- Id: '1295522'
Key: SB-5855
Values:
- Key: Issue Type
Value: Task
- Key: Key
Value: SB-5855
project: null
issuetype: null
summary: null
IssuesFetched: 1
AttachmentMetadataExample:
value:
- Id: '7890233'
Name: test2.pdf
CreatedUserName: aiyer
CreatedBy: Anuradha Iyer
CreatedDate: 2021-06-10T17:14:19.560-0400
Size: 2425253
MimeType: multipart/form-data; boundary=123456789
Content: null
ErrorMessage: null
DateCreated: '0001-01-01T00:00:00'
- Id: '7904356'
Name: test3 (1).pdf
CreatedUserName: aiyer
CreatedBy: Anuradha Iyer
CreatedDate: 2021-06-15T13:44:30.580-0400
Size: 5668742
MimeType: application/pdf
Content: null
ErrorMessage: null
DateCreated: '0001-01-01T00:00:00'
AttachmentExample:
value:
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'
TransitionsExample:
value:
- Id: '11'
Name: Start Progress
StatusName: In Progress
StatusColor: yellow
- Id: '141'
Name: Cancel
StatusName: Cancelled
StatusColor: green
- Id: '265'
Name: Send back to SEI
StatusName: SEI Review
StatusColor: blue-gray
- Id: '82'
Name: Investor Review Required
StatusName: Item with Investor
StatusColor: yellow
TransitionFieldsExample:
value:
- Id: assignee
Name: Assignee
Value: Anuradha Iyer
IsRequired: false
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
ControlType: Dropdown
CustomId: null
CommentsExample:
value:
StartAt: 0
MaxResults: 1048576
Total: 6
Data:
- Id: '1222333'
CreatedUserName: jjones
CreatedBy: Jane Jones
CreatedEmailId: jjones@seic.com
UpdatedBy: Jane Jones
UpdatedEmailId: jjones@seic.com
Value: "[~qa]- Testing done, doc attached. [^Test_Result.doc]\r\n\r\ncc: [~seitesting] [~test] [~admin]\r\n\r\n "
RenderBody: "QA- Testing done, doc attached. [^Test_Result.doc]\r\n\r\ncc: SEI Testing Test User Admin [X]"
CreatedDate: 2021-07-15T10:20:50.840-0400
UpdatedDate: 2021-07-15T10:20:50.840-0400
ErrorMessage: null
CommentsPostExample:
value:
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
EditTicketFieldsExample:
value:
Id: customfield_12345
Name: ID
Value: IS5428754288
IsRequired: false
HasDefaultValue: false
AllowedOperation:
- set
AllowedValues: null
FieldType: string
ControlType: textfield
CustomId: null
TicketSearchExample:
value:
StartAt: 0
MaxResults: 1
Total: 1
Issues:
- Id: '2853333'
Key: SB-5855
Values:
- Key: issuekey
Value: null
- Key: issuetype
Value: Additional Commitment
- Key: IssueTypeIcon
Value: hTRMEaMEEalNBBBPSUhEUgAAABAAAAAQCAYAAAAf8/7hAAAABGdBWEDAALGPC/ptMQBBBBlwSFlzAAAOwgAADsYTREhKgAAAAK9JREFUOE9joArI2uIpnrHVbV7GFvf/tOD0Le7Lsra46kO1MzCCFdehKyKIN7ufg2oIY4BdEQEM1Y7bgFP3j/z/5uwMMjkQhmrHbQTBOJMDYah2KhsAcjYbrO4dqWIRB158eApVjgk+ppnA2ABkDAPY9EAYqp2GBoC8g+5sZAzVltrAQhiqHWgPRTliU4APp292ewbVzsCQrguinPmOL6z7sCnHgd2mb3NOh2ikBDAwAvzr4V+3H1WcBBCRSUVPTR5CYII=
- Key: summary
Value: Additional Commitment
- Key: priority
Value: High
- Key: status
Value: Cancelled
- Key: StatusColor
Value: green
- Key: created
Value: 2/3/2021 12:07
- Key: updated
Value: 8/16/2021 08:57
- Key: reporter
Value: John Smith
project: null
issuetype: null
summary: null
IssuesFetched: 1
UserTicketPermissionExample:
value:
- PermissonType: ARCHIVE_ISSUES
Id: '-3'
Key: ARCHIVE_ISSUES
Name: Archive Issues
Description: Ability to archive issues for a specific project.
HavePermission: 'False'
- PermissonType: VIEW_WORKFLOW_READONLY
Id: '33'
Key: VIEW_WORKFLOW_READONLY
Name: View Read-Only Workflow
Description: VIEW_WORKFLOW
HavePermission: 'True'
- PermissonType: CREATE_ISSUES
Id: '77'
Key: CREATE_ISSUES
Name: Create Issues
Description: Ability to create issues.
HavePermission: 'True'
- PermissonType: VIEW_DEV_TOOLS
Id: '89'
Key: VIEW_DEV_TOOLS
Name: View Development Tools
Description: 'Allows users in a software project to view development-related information on the issue, such as commits, reviews and build information.'
HavePermission: 'False'
- PermissonType: BULK_CHANGE
Id: '24'
Key: BULK_CHANGE
Name: Bulk Change
Description: 'Ability to modify a collection of issues at once. For example, resolve multiple issues in one step.'
HavePermission: 'True'
- PermissonType: CREATE_ATTACHMENT
Id: '12'
Key: CREATE_ATTACHMENT
Name: Create Attachments
Description: Users with this permission may create attachments.
HavePermission: 'True'
- PermissonType: DELETE_OWN_COMMENTS
Id: '56'
Key: DELETE_OWN_COMMENTS
Name: Delete Own Comments
Description: Ability to delete own comments made on issues.
HavePermission: 'True'
- PermissonType: WORK_ON_ISSUES
Id: '17'
Key: WORK_ON_ISSUES
Name: Work On Issues
Description: Ability to log work done against an issue. Only useful if Time Tracking is turned on.
HavePermission: 'True'
- PermissonType: PROJECT_ADMIN
Id: '34'
Key: PROJECT_ADMIN
Name: Administer Projects
Description: Ability to administer a project in Jira.
HavePermission: 'False'
- PermissonType: COMMENT_EDIT_ALL
Id: '45'
Key: COMMENT_EDIT_ALL
Name: Edit All Comments
Description: Ability to edit all comments made on issues.
HavePermission: 'False'
- PermissonType: ATTACHMENT_DELETE_OWN
Id: '52'
Key: ATTACHMENT_DELETE_OWN
Name: Delete Own Attachments
Description: Users with this permission may delete own attachments.
HavePermission: 'True'
- PermissonType: WORKLOG_DELETE_OWN
Id: '61'
Key: WORKLOG_DELETE_OWN
Name: Delete Own Worklogs
Description: Ability to delete own worklogs made on issues.
HavePermission: 'False'
- PermissonType: CLOSE_ISSUE
Id: '13'
Key: CLOSE_ISSUE
Name: Close Issues
Description: 'Ability to close issues. Often useful where your developers resolve issues, and a QA department closes them.'
HavePermission: 'True'
- PermissonType: MANAGE_WATCHER_LIST
Id: '55'
Key: MANAGE_WATCHER_LIST
Name: Manage Watchers
Description: Ability to manage the watchers of an issue.
HavePermission: 'True'
- PermissonType: VIEW_VOTERS_AND_WATCHERS
Id: '42'
Key: VIEW_VOTERS_AND_WATCHERS
Name: View Voters and Watchers
Description: Ability to view the voters and watchers of an issue.
HavePermission: 'True'
- PermissonType: ADD_COMMENTS
Id: '76'
Key: ADD_COMMENTS
Name: Add Comments
Description: Ability to comment on issues.
HavePermission: 'True'
- PermissonType: COMMENT_DELETE_ALL
Id: '35'
Key: COMMENT_DELETE_ALL
Name: Delete All Comments
Description: Ability to delete all comments made on issues.
HavePermission: 'False'
- PermissonType: CREATE_ISSUE
Id: '11'
Key: CREATE_ISSUE
Name: Create Issues
Description: Ability to create issues.
HavePermission: 'True'
- PermissonType: DELETE_OWN_ATTACHMENTS
Id: '39'
Key: DELETE_OWN_ATTACHMENTS
Name: Delete Own Attachments
Description: Users with this permission may delete own attachments.
HavePermission: 'True'
- PermissonType: LINK_ISSUES
Id: '27'
Key: LINK_ISSUES
Name: Link Issues
Description: Ability to link issues together and create linked issues. Only useful if issue linking is turned on.
HavePermission: 'True'