SEI Developer Portal | Project Issue Type Fields

Project Issue Type Fields

GET

/projectissuetypefields

Returns all the available fields in an issue type of a project.

Prod:

https://api.seic.com/v2/workdesk/projectissuetypefields

Query Parameters

Name	Description	Data Type
projectId	A valid Jira Project Id	string
issueTypeId	A valid Jira Issue Type Id	string
operation	Screen operations create 0 edit 1 view 2	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

projectId	A valid Jira Project Id
issueTypeId	A valid Jira Issue Type Id
operation	Screen operations create 0 edit 1 view 2

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Project Issue Type Fields

GET

/projectissuetypefields

Returns all the available fields in an issue type of a project.

Prod:

https://api.seic.com/v2/workdesk/projectissuetypefields

Query Parameters

Name	Description	Data Type
projectId	A valid Jira Project Id	string
issueTypeId	A valid Jira Issue Type Id	string
operation	Screen operations create 0 edit 1 view 2	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

projectId	A valid Jira Project Id
issueTypeId	A valid Jira Issue Type Id
operation	Screen operations create 0 edit 1 view 2

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v2/workdesk/projectissuetypefields

TLS*: https://mtls.api.seic.com/v2/workdesk/projectissuetypefields

*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

STEP 2

Pass the oAuth Token and the App key to invoke this endpoint for a particular application. Note: 1 to 5 API endpoints are sequenced and remaining can be randomly invoked.

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.

Project Issue Type Fields

GET

/projectissuetypefields

Returns all the available fields in an issue type of a project.

Prod:

https://api.seic.com/v2/workdesk/projectissuetypefields

Query Parameters

Name	Description	Data Type
projectId	A valid Jira Project Id	string
issueTypeId	A valid Jira Issue Type Id	string
operation	Screen operations create 0 edit 1 view 2	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

projectId	A valid Jira Project Id
issueTypeId	A valid Jira Issue Type Id
operation	Screen operations create 0 edit 1 view 2

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

curl -X GET \
 https://api.seic.com/v2/workdesk/projectissuetypefields?projectId=23233&issueTypeId=19007 \
  -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": "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
    }
]

MODEL

Operations

Name	Description	Data Type (L)
hasDefaultValue	Defines whether the field has a default value when none is provided.	boolean
AllowedOperation	Operations allowed for the specific value in the object.	string
AllowedValues	The allowable values for the object, if provided.	string
Id	Project Id.	string
Name	Project Name.	string
Value	The value within the Jira object.	string
IsRequired	Defines whether the field is required or not for the Task object.	string
FieldType	The data type of the field (i.e., string, boolean, etc.).	string
ControlType	The field control on the user interface, such as text field, checklist, etc.	string

Project Issue Type Fields

GET

/projectissuetypefields

Returns all the available fields in an issue type of a project.

Prod:

https://api.seic.com/v2/workdesk/projectissuetypefields

Query Parameters

Name	Description	Data Type
projectId	A valid Jira Project Id	string
issueTypeId	A valid Jira Issue Type Id	string
operation	Screen operations create 0 edit 1 view 2	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

projectId	A valid Jira Project Id
issueTypeId	A valid Jira Issue Type Id
operation	Screen operations create 0 edit 1 view 2

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Project Issue Type Fields

GET

/projectissuetypefields

Returns all the available fields in an issue type of a project.

Prod:

https://api.seic.com/v2/workdesk/projectissuetypefields

Query Parameters

Name	Description	Data Type
projectId	A valid Jira Project Id	string
issueTypeId	A valid Jira Issue Type Id	string
operation	Screen operations create 0 edit 1 view 2	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

projectId	A valid Jira Project Id
issueTypeId	A valid Jira Issue Type Id
operation	Screen operations create 0 edit 1 view 2

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v2/workdesk/projectissuetypefields

TLS*: https://mtls.api.seic.com/v2/workdesk/projectissuetypefields

*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

STEP 1

oAuthToken

POST

STEP 2

Pass the oAuth Token and the App key to invoke this endpoint for a particular application. Note: 1 to 5 API endpoints are sequenced and remaining can be randomly invoked.

Project Issue Type Fields

GET

/projectissuetypefields

Returns all the available fields in an issue type of a project.

Prod:

https://api.seic.com/v2/workdesk/projectissuetypefields

Query Parameters

Name	Description	Data Type
projectId	A valid Jira Project Id	string
issueTypeId	A valid Jira Issue Type Id	string
operation	Screen operations create 0 edit 1 view 2	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

projectId	A valid Jira Project Id
issueTypeId	A valid Jira Issue Type Id
operation	Screen operations create 0 edit 1 view 2

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

curl -X GET \
 https://api.seic.com/v2/workdesk/projectissuetypefields?projectId=23233&issueTypeId=19007 \
  -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": "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
    }
]

MODEL

Operations

Name	Description	Data Type (L)
hasDefaultValue	Defines whether the field has a default value when none is provided.	boolean
AllowedOperation	Operations allowed for the specific value in the object.	string
AllowedValues	The allowable values for the object, if provided.	string
Id	Project Id.	string
Name	Project Name.	string
Value	The value within the Jira object.	string
IsRequired	Defines whether the field is required or not for the Task object.	string
FieldType	The data type of the field (i.e., string, boolean, etc.).	string
ControlType	The field control on the user interface, such as text field, checklist, etc.	string

Project Issue Type Fields

GET

/projectissuetypefields

Returns all the available fields in an issue type of a project.

Prod:

https://api.seic.com/v2/workdesk/projectissuetypefields

Query Parameters

Name	Description	Data Type
projectId	A valid Jira Project Id	string
issueTypeId	A valid Jira Issue Type Id	string
operation	Screen operations create 0 edit 1 view 2	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

projectId	A valid Jira Project Id
issueTypeId	A valid Jira Issue Type Id
operation	Screen operations create 0 edit 1 view 2

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...